Getting started

This quick start provides an outline for installing, configuring, and verifying a 1E system that is suitable for a lab-type environment. After the Prepare and Install sections, the Configure and Use sections provide steps that will verify the following aspects of 1E installation:

1. Configure quick start users: Confirms integration with Active Directory and the basic RBAC capabilities of 1E.

2. Verification instructions: Confirms the basic functionality for importing instruction definitions into 1E as well as confirming that licensing is working appropriately.

3. Viewing connected devices: Confirms that 1E certificates have been correctly configured

4. Asking a question: Confirms that 1E client communications are working

5. Performing an action: Confirms that two-factor authentication, email connections, and the approval workflow are working. The stage 2 verification action also checks that the 1E client download mechanism is working and that the background channel has been correctly configured.

This run-through of basic 1E functionality works as a verification of 1E installation in a lab environment. For production environments, a more formal verification process that uses the same 1E-TachyonPlatform.zip file as used in this quick start guide is provided on the Verifying page.

This quick start assumes a simple design in which you will be installing 1E components on a single web server, with SQL Server installed either locally or remote (split).

A summary of the preparation tasks:

1. Get a suitable license file for 1E, this should cover the 1E applications you want to use.

2. Review your Quick start infrastructure.

3. Prepare the Quick start 1E servers..

4. Create the DNS Names.

5. Install IIS on the 1E server.

6. Get and install the 1E Server's web server certificate - Request a Web Server certificate.

7. Get and install a certificate on the 1E Server with at least Client Authentication Enhanced Key Usage. You might find that your 1E Server web certificate has this already, but that will not usually be the case.

8. Get the 1E files that will be used to complete the quick start.

9. Prepare the Quick start 1E client devices.

10. Create the Quick start user accounts.

The below process assumes your quick start environment has a Microsoft Enterprise CA and you are familiar with how to:

• Configure your CA to use a CRL DP that supports HTTP or HTTPS.

• Publish a Web Server certificate template or issue a PFX.

• Use certlm.msc or the mmc certificates snap-in to request a web server certificate.

• Deploy computer certificates to clients, optionally using auto-enrollment.

Quick start infrastructure

A 1E system consists of:

• 1E Server, which includes the 1E Switch component and website, hosted on an IIS web server.

• SQL Server instance, which hosts the 1E Master and Responses databases, can be local or remote (split).

• 1E clients on supported devices.

• Browsers used by 1E users and administrators to access the Endpoint Troubleshooting and Admin portal.

Your environment also requires:

• A correctly routed network environment where each device is configured with a genuine default gateway.

• The server where your 1E Web Server will be installed also needs internet access so that the licensing will work, specifically to https://license.1e.com.

• AD domain for the 1E Server and user accounts, but 1E client devices can be in workgroups or other domains.

• SMTP email server - See Email and 2FA requirements for more details.

• A PKI which serves the 1E Server and all 1E client devices.

• Your CA(s) are able to issue certificates with a CRL DP that supports HTTP or HTTPS.

Quick start 1E servers

These are the servers required by 1E in addition to Quick start infrastructure.

• Server(s) can be physical or virtual, and joined servers to a supported directory service (Active Directory or Azure ADDS).

• If using any other version of Windows OS or SQL Server, or more detail is required, refer to Windows Server requirements, and Server Provisioning

• If using a firewall on the 1E Server, then ensure the following incoming ports are open:

  • Website HTTPS 443

  • Switch Port 4000

DNS Name

Create the DNS Name for the 1E Server, for example 1E.acme.local, this can be a CNAME or a (A) Host record.

This DNS Name is used in the Web Server certificate that needs to be installed on the 1EServer.

Install IIS

Run the following PowerShell script on the Server. Do this even if IIS is already installed because it will ensure all the required features and roles are installed.

If more detail is required, refer to, Windows Server roles and features.

Import-Module ServerManager

Get-WindowsFeature | Out-file $PSScriptRoot\ServerManager-1.txt -Append
Install-WindowsFeature Web-Server,
Web-Http-Redirect,
Web-Dyn-Compression,
Web-Basic-Auth,
Web-IP-Security,
Web-Windows-Auth,
Web-Asp-Net45,
Web-Mgmt-Console,
Net-Framework-45-Core,
Net-Framework-45-ASPNET

Uninstall-WindowsFeature Web-DAV-Publishing
   
Get-WindowsFeature | Out-file $PSScriptRoot\ServerManager-2.txt -Append

When running the above command, if you receive an error that contains The source files could not be downloaded you will need to supply the source path to your Windows Server OS installation media \Sources\sxs folder. Append -source X:\Sources\sxs or -source \\Server\Path\Source\sxs to the command line, adjusted for your drive letter or UNC path.

PowerShell always uses 45 in the names of .NET Framework features, irrespective of the actual version of .NET Framework 4.X installed on the server, like:

• 4.8 in Windows Server 2022 (from 1E 8.1 onwards, any 1E component that requires .NET Framework, requires version 4.8)

• 4.7.2 in Windows Server 2019

• 4.6.2 in Windows Server 2016

For details of .NET Framework versions, refer to .NET Framework system requirements.

If you prefer to use the Add Roles and Features Wizard to manually enable features then you can use the Display Names listed in the table Windows Server roles and features.

Request a Web Server certificate

You will need to have requested a Web Server certificate from your Certificate Authority. To get the certificate in your organization you will have either:

• Submitted a CSR and received a password protected PFX file.

• Used the Certificate Enrollment wizard to request a suitable Web Server certificate.

Once the Web Server certificate has been provided it must be imported into the 1E Server's local computer Personal Certificates store.

Each server that has 1E Server components installed requires its own Web Server certificate (except for a remote SQL Server). This certificate is also used by the 1E Switch and the 1E Coordinator. Therefore, a single-server installation requires only one Web Server certificate. This certificate must be provided on the server prior to installation of 1E.

The Web Server certificate requires the minimum of the following:

1. Issued by a trusted Certificate Authority (CA)

   • The certificate for the Root CA in the Certification Path must exist in the Trusted Root CA store of the server.

   • If the issuing CA is not the Root CA then the certificate for the issuing CA and any intermediate CA in the Certification Path must exist in the Intermediate CA store of the server.

   • The above CA certificates must exist on the 1E Web Server and Windows client devices.

   • Most organizations have automated distribution of these CA certificates to servers and clients, using Group Policy for example.

2. Has at least the following Key Usage:

   • Digital signature

   • Key encipherment

3. Has at least the following Enhanced Key Usages:

   • Server Authentication

4. Revocation information is included

   • References at least one CRL Distribution point that uses HTTP - see DMZ Server note below.

5. Must have a private key available

The default template Web Server available with a Microsoft PKI is suitable for requesting a 1E Web Server certificate.

Web Server certificates used by a 1E Servers must be issued with their fields set as follows.

See examples of old-style certificates below.

Request a client certificate

You will need to have requested a client certificate from your Certificate Authority. This will be used to authenticate communications between the Background Channel and the ContentDistribution components to support Content Distribution features.

Get the 1E files

You will need to download the following to complete the quick start.

1E Client installers

The 1EClient zip file can be downloaded from the TeamViewer DEX Support Portal. The zip includes the following files used to install the 1E Client on Windows devices:

• 1E.Client-x64.msi

• 1E.Client-x86.msi

1E Server installers

The TachyonPlatform zip file can be downloaded from the TeamViewer DEX Support Portal. Extracting the zip will create a folder structure containing the following, where the files highlighted in bold are required by 1E Setup.

Quick start 1E client devices

The 1E client is supported on the following Windows OS in a quick start environment.

• Windows Server 2022

• Windows Server 2019

• Windows Server 2016

• Windows 11 CB 21H2

• Windows 10 CB 21H2

• Windows 10 CB 21H1

• Windows 10 CB 20H2

If using any other OS then please refer to Supported platforms and 1E client installation pages in the section.

1E users on client devices can connect to the 1E Endpoint Troubleshooting using any of the following browsers:

Latest version of:

• Google Chrome

• Microsoft Edge (Chromium)

• Mozilla Firefox.

PowerShell is used by some 1E Product Packs. If more detail is required, refer to Scripting requirements.

If you have configured 1E Server to require client certificates (Client certificates) then each device requires a certificate with the following properties, so the 1E client can be authenticated by the 1E Switch.

1. Issued by a trusted Certificate Authority (CA)

   • The certificate for the Root CA in the Certification Path must exist in the Trusted Root CA store of the client.

   • If the issuing CA is not the Root CA then the certificate for the issuing CA and any intermediate CA in the Certification Path must exist in the Intermediate CA store of the client.

   • If either of these CA certificates are different to those used by the 1E Web Server, they will need to be exported and imported on the 1E Web Server.

   • Most organizations have automated distribution of these CA certificates to clients and servers, using Group Policy for example.

2. Has at least the following Enhanced Key Usage

   • Client Authentication

3. Has at least the following Key Usage

   • Digital Signature

   • Key encipherment

4. Has a private key

   • For workgroup and non-Windows devices, the private key must be exportable

5. Revocation information is included.

   • References at least one CRL Distribution point that uses HTTP.

6. Has a Subject Name of type Common Name (CN=<computername>) or Subject Alternative Name (DNS Name=<computername>) where <computername> depends on the type of device:

   • On domain-joined Windows PCs this must be the computername FQDN of the computer, for example W701.ACME.LOCAL.

   • On workgroup Windows PCs and non-Windows devices, this must be the computername of the computer - as returned by the hostname command, for example on Windows PC this could be W701, and on a Mac this could be MAC01.local.

Quick start user accounts

For simplicity in the quick start guide, we use just two 1E user accounts, the installation account and another full administrator account.

For the purposes of the quick start, which uses two-factor authentication, each account must have its AD account configured with an email address.

Using just the following accounts we can perform all the installation, administration, verification questions, actions and approval tasks shown in this quick start guide.

Quick start service accounts

The table below describes all the service accounts and where they are used. Where domain accounts are required, you should create separate domain user accounts for each service.

1E Server

After obtaining your Tachyon.lic file from 1E you should store it in a secure location. In our example we've placed the Tachyon.lic file in the installation directory where Tachyon.Setup.exe is located.

1. Logon to the server using the server installation account TCNInstaller01.

2. Install interactively using Tachyon.Setup.exe.

3. Launch the setup wizard by double-clicking on Tachyon.Setup.exe. Then fill out the screens of the wizard using the following information.

For more detail on the setup wizard, read 1E Server setup in .

Uploading with the 1E product pack deployment tool

Continuing from the previous section, we select to run the 1E product pack deployment tool using the following steps:

1. In setup click on the Deploy link next to the Product Packs are available check on the Post-installation checks screen.

2. The 1E product pack deployment tool appears, showing all the Available Product Packs that were found in the ProductPacks folder.

3. There are two types of DEXPack displayed, Classic and Integrated. Classic DEXPacks contain Instruction definitions, and Integrated DEXPacks also include Policies.

4. You can select the Product Packs you want to load by checking the box in the Selected column for each entry. In our example, we'll leave all the Product Packs selected to load them all.

5. To load the DEXPack, click on the Upload selected button.

6. When the upload has completed, the text Done will appear in the Results field.

7. At this point, you can click the Close button to close the 1E product pack deployment tool.

8. Then click the Close button in setup, and click OK in the confirmation dialog to exit the wizard.

Signing in to the 1E Portal to check the Instructions from the uploaded DEXPack:

1. Enter the URL for the 1E Portal into a suitable browser for example https:\\1E portal.acme.local\Tachyon.

2. Sign in using your installation account credentials, for example ACME\TCNInstaller01.

3. When the 1E Portal has finished loading, click on Settings at the bottom of the list of applications.

4. When the Settings application has opened, click on Instructions and then Instruction sets.

5. On the Instructions sets page, you will be able to see Instruction sets that have been created for each DEXPack that was in the ProductPacks folder.

Verification instructions

By following the steps provided in Uploading with the 1E product pack deployment tool you will have loaded the 1E-Tachyon-Platform.zip DEXPack into the 1E Tachyon Platform Instruction set, containing the two verification instructions Tachyon Platform verification stage 1 and Tachyon Platform verification stage 2 (all platforms), along with a number of other instructions that are used to populate data in the Device View. The verification instructions are used later in the quick start guide to perform a quick verification of 1E and demonstrate how to ask questions and run actions.

1E clients

When installing 1E Client (with 1E features enabled) the following installation settings are mandatory and must be supplied. Other client configuration settings are optional and have been assigned default values.

The following properties can be entered manually when installing from the Windows Installer wizard. Alternatively, the properties can be included as part of a Windows msiexec command-line launch.

Example which enables only 1E client

Example Windows 1E Client installer command-line with only the 1E Client features enabled, other client modules are not enabled. 1E uses HTTPS only.

msiexec /i 1E.Client-x64.msi ^
  SWITCH="tachyon.acme.local:4000" ^
  BACKGROUNDCHANNELURL="https://tachyon.acme.local:443/Background/" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only Content Distribution client

Example Windows 1E Client installer command-line with only Content Distribution module enabled, which also requires 1E client features to be enabled. 1E uses HTTPS only.

msiexec /i 1E.Client-x64.msi ^
  SWITCH="tachyon.acme.local:4000" ^
  BACKGROUNDCHANNELURL="https://tachyon.acme.local:443/Background/" ^
  MODULE.NOMAD.ENABLED=true ^
  MODULE.NOMAD.CONTENTREGISTRATION=1 ^
  MODULE.NOMAD.SSDENABLED=1 ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only PXE Everywhere Agent

Example Windows 1E Client installer command-line with only PXE Everywhere Agent client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none). PXE Everywhere uses only HTTP.

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.PXEEVERYWHERE.ENABLED=true ^
  MODULE.PXEEVERYWHERE.CONFIGSERVERURL="http://pxecentral.acme.local/PXELite/PXELiteConfiguration.asmx" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only Shopping client

Example Windows 1E Client installer command-line with only Shopping client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none). Ensure you use HTTP or HTTPS as appropriate.

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.SHOPPING.ENABLED=true ^
  MODULE.SHOPPING.SHOPPINGCENTRALURL="https://appstore.acme.local/shopping" ^
  MODULE.SHOPPING.LOOPBACKEXEMPTIONENABLED=true ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Example which enables only WakeUp client

Example Windows 1E Client installer command-line with only WakeUp client module enabled, and 1E features disabled (by setting SWITCH and BACKGROUNDCHANNELURL to none).

msiexec /i 1E.Client-x64.msi ^
  SWITCH=none ^
  BACKGROUNDCHANNELURL=none ^
  MODULE.WAKEUP.ENABLED=true ^
  MODULE.WAKEUP.REPORTINGSERVER="nwmserver.acme.local" ^
  /qn ^
  /l*vx C:\Windows\temp\1EClient-install.log

Use 1E.Client-x64.msi for 64-bit Windows and 1E.Client-x86.msi for 32-bit Windows. For non-Windows platforms, platform specific packages for Linux, Solaris and Mac are available.

When installing interactively through the Windows installer wizard, logon using an account that has local administrator rights.

• For details of step-by-step interactive and command-line installation, refer to Deploying 1E Client on Windows

• For how to deploy the 1E Client to macOS platforms, refer to Deploying 1E Client on macOS

• For how to deploy the 1E Client to Linux platforms, refer to Deploying 1E Client on Linux

Export all responses feature

This step is optional, only if you require this feature. Please refer to 1E Server post-installation tasks for details.

Set security roles

After installation you will only be able to log onto the 1E Endpoint Troubleshooting using the installation account. This account is purposefully restricted to just allowing the configuration of security roles. So the first step must be to add other users to access the other capabilities of 1E.

• Users for administration: We suggest that you add a user or group to handle the administration tasks for your evaluation environment.

• Users for performing actions: To perform actions you will need at least two other users. One an actioner and the other an approver, otherwise you won't be able to perform actions.

A 1E AD group tutorial

For this quick start guide we use two specific accounts and a security group to assign to the roles we need. You may want to use AD groups to define 1E access and we have provided a complete tutorial on adding users and roles via AD groups, on the page, which you may find useful.

Configure quick start users

At this point we will configure the user accounts, as listed in Quick start user accounts, to their different roles in 1E.

Using these accounts the user roles configuration is done using the following steps:

1. Logon to 1E using the installation account. The 1E Portal website will be available after installation using the 1E DNS Name FQDN, configured during the prepare phase of the quick start. In our quick start environment this is tachyon.acme.local. So the URL for the 1E Portal is https://tachyon.acme.local/Tachyon

The first time you log in the 1E applications will be set up.

2. Initially the installer account has purposefully limited 1E permissions and the permissions for this account cannot be modified directly. This means that the account cannot access any of the applications. To resolve this for the quick start guide, we need to create a new 1E user account for the TCNGAdministrators group and assign global administrator permissions to that user. To do this you need to navigate to the Settings application page using one of the following methods:

   1. If you're on the home page click on the Settings item.

   2. If you've already navigated to another application, click on the Settings item on the Switch app menu.

3. Once you're in the Settings application, to add the TCNGAdministrators group 1E user:

   1. Expand the Permissions node.

   2. Click on Users to display the Users page.

   3. Click the Add button to display the Add user popup.

   4. Enter some text in the Select AD user or security group field (for example, TCNG) that matches the required user or group name. In our example we know we will be adding a security group, so we can uncheck the User option so that the search only returns security groups.

   5. After clicking the search icon, a list of matching users and groups from AD will be displayed. Select TCNGAdministrators and click Add.

4. To set the full administrator role for the new ACME\TCNGAdministrators 1E user:

   1. Click on the new ACME\TCNGAdministrators username link to display its details.

   2. On the Roles tab click the Edit button to display the Edit roles assigned to user popup.

   3. Select Full Administrator from the list of available roles.

   4. Click the Save button to assign the selected roles to the user.

You can check which users belong to the group by clicking on the Group members tab. In our example, you can see that there are two users in the group: TCNAdmin01 and TCNInstaller01. Both of these accounts should now have the Full Administrator role applied.

In our example, to demonstrate this for the logged on TCNInstaller01 account all they need to do is refresh the page in the browser. They now have all the permissions related to the Full Administrator role and will therefore be able to see all the configuration items in the Settings application, and they can also now browse to 1E Endpoint Troubleshooting.

Using 1E

Having configured the users who will access 1E we can now go on to demonstrate the basic functionality of 1E including: viewing connected devices, asking a question and seeing the responses, requesting to perform an action and the associated approval process.

Viewing connected devices

Perhaps one of the first things you should do after installing and configuring role-based access to 1E is to check what devices are connected. This gives you instant feedback on whether the 1E client devices have been installed correctly and are able to communicate back to 1E.

In our quick start example we were previously logged on to 1E as TCNInstaller01, and have already navigated to Endpoint Troubleshooting. In order to view the Devices >Table page expand the Devices node and select Table.

The quick start example

To illustrate the workflow for asking questions, filtering responses and performing follow-up actions we will use a simple example where we ask the Tachyon Platform verification stage 1 question. We'll then run the Tachyon Platform verification stage 2 action to complete the verification.

Asking a question

The first step in the example is to ask the question and view the responses in 1E Endpoint Troubleshooting. The question we want to ask is Tachyon Platform verification stage 1. The following steps show how to select and ask the question then view the responses. Still logged on as the TCNInstaller01 account, the steps are:

1. The usual way to run instructions is from the Endpoint TroubleshootingHome page, click on Home to view the Home page.

2. Type some letters from the name of the stage 1 question into the Endpoint Troubleshooting field, in our example we type the text verif. This will display a list of questions that match the text. You will see the two instructions; the stage 1 question and the stage 2 action.

3. Select the Tachyon Platform verification stage 1 question from the list of matches.

4. The question is added to the Endpoint Troubleshooting window. Depending on the question you may need to set some attributes and for all questions you can set parameters, such as the duration, coverage and question filters. In our example this simple question has no attributes and will be asked of all the devices with no filtering, so we click on the Ask this question button directly.

5. The question gets asked of all 1E client devices. If they are currently connected they will respond immediately. If they are offline they will respond if they connect within the duration of the question.

Performing an action

1. In the edit field of the Home page type verif and select the Tachyon Platform verification stage 2 action from the list displayed.

2. Run this action with default parameters by clicking the Perform this action button. Doing this triggers the action approval workflow.

3. 1E will ask you to confirm your user name and password credentials. This is a safeguard to prevent actions from being run on unlocked devices where you are temporarily absent.

4. By default, if email has been configured, 1E provides two-factor authentication - so after the credentials have been set and the Confirm and send button is clicked, you will see that the instruction requires authentication. You will then need to check your email for the authentication code.

5. After retrieving the authentication code, return to 1E and enter it into the prompt. The instruction will then go into a pending approval state and a notification will be sent to the approver. As a further safeguard, 1E actions cannot be approved by the person requesting the action. In our example this means that TCNInstaller01 cannot approve their own action, approval must be done by the other user TCNAdmin01.

6. The approver will receive an email saying that the action is pending their approval. If the approver logs on to 1E using the link provided in the email, they will be directed to their Notifications page.

7. Scrolling to the bottom of the Notifications page the approver gets an opportunity to provide a comment for their approval or rejection decision. If they want to approve the action they must first check the I understand approving my request impacts my IT environment checkbox and then click the Approve button. In our example TCNAdmin01 enters a suitable comment, checks the box and clicks Approve to approve the service start action.

8. The approver is then immediately notified that their decision has been implemented.

9. At the same time, 1E also enables the action to go ahead. In our example, the results of running the action are displayed, showing that all twelve connected devices responded and were able to run the verification of the background channel.

In this quick start guide we've shown how to configure an example environment, how to implement the 1E Server and 1E clients onto the environment, how to configure the 1E users and import DEXPacks. Finally we've shown those users accessing the Endpoint Troubleshooting to investigate the devices that are currently connected and then asking a question and performing and approving an action.

Using applications that are installed by default

The following applications are always installed by 1E Setup, although you may have limited access to features depending on your license.

• Settings: Refer to Using Settings

• Inventory Insights: Refer to Inventory Insights

• Endpoint Troubleshooting: Refer to Endpoint Troubleshooting

• Endpoint Automation: Refer to Using 1E Endpoint Automation

• Experience Analytics: Refer Using 1E Experience Analytics.

Refer to Using consumer applications for a summary of these and other optional applications.

Use the Connectors page in the Inventory application to configure connectors and populate the inventory repository. describes how to view the normalized inventory data, which can then be used by the following applications that depend on inventory.

• AppClarity

• Application Migration

• Patch Insights

Installing and Using AppClarity

You can use 1E Setup to install AppClarity during or after you install or upgrade 1E using setup. Refer to Implementing AppClarity.

Installing and Using Application Migration

You can install Application Migration during or after you install or upgrade 1E using setup. Refer to .

Installing and Using Patch Insights

Use must use 1E Setup to install and configure Patch Insights when you install or upgrade 1E. Further configuration is then required as described in Patch Insights.

Installing and Using Content Distribution

You can install Content Distribution during or after you install or upgrade 1E using setup. Please refer to Implementing Content Distribution.

Using Configuration Manager Console Extensions

If you have Microsoft System Center Configuration Manager (SCCM, ConfigMgr) then you can install the 1E Toolkit on each computer that has Configuration Manager Console installed, in order to add right-click tools. Refer to The 1E Toolkit.

Creating your own instructions

You will need your own code signing certificate, and have it registered in your 1E license, if you want to develop your own custom 1E instructions, or modify those of other authors. Instructions that are provided in the 1E Platform zip or downloaded from the 1E Exchange have already been code signed using the Platform and Exchange certificates from 1E. Your license controls whether you can use these instructions.

Ideally, all of your 1E instruction developers should share a single code signing certificate between them. Each code signing certificate must be registered in your license and associated with your organization's instruction name prefix. When you have chosen your prefix and have your code signing certificate(s) you then need to send details of these to 1E, who will update your license. This will then automatically activate on your 1E Server (assuming it has a connection to the Internet).

For a getting-started guide to configuring and verifying your 1E system so that you can run customized Instructions, refer to Running instructions for the first time.

The 1E SDK is where you can find comprehensive resources for using TIMS and authoring your instructions.