Verifying

TeamViewer DEX Platform 26.3 Red X | 1E Platform 23.11 Red X | 1E Platform on-premises 9.x Green Checkmark

Follow this guide to verify your 1E Platform installation. Learn how to check services, logs, and configurations to ensure a successful and stable deployment.

This guide includes basic verification tests that cover a single-server installation of the 1E Server. These tests only cover 1E and do not verify the configuration of 1E client modules with other 1E products. These tests should be run in series. They start with basic server checks, then testing 1E Clients, and finally, use the verification instructions from the 1E-Tachyon-Platform DEX Pack to do end-to-end tests that confirm all components are working. Depending on the decisions you have made during the design phase of your implementation you may need additional tests to verify your implementation.

Ensure you complete all verification tests. They not only confirm your system is operational, but they also introduce you to concepts and tasks that you will use later when using 1E.

To run these tests you need:

  1. 1E Server installed.

  2. Remote workstation with a supported platform, refer to Supported platforms.

  3. The name and password for the server installation account.

    1. The AD account must be enabled

    2. The AAD account must be enabled

    3. The account may already be assigned to other 1E roles either directly or via membership of an AD group role.

  4. Two AD User accounts, Test User 1 and 2.

    1. Must not be existing 1E users because they will be assigned specific roles for the purpose of these tests

    2. Must have email addresses and be able to read emails

  5. Two AAD User accounts, Test User 1 and 2.

    1. Must not be existing 1E users because they will be assigned specific roles for the purpose of these tests

    2. Must have email addresses and be able to read emails

  6. The 1E-Tachyon-Platform DEX Pack with two verification instructions.

    1. The verification steps describe how to create this instruction set by uploading the 1E-Tachyon-Platform DEX Pack

    2. You may have already uploaded this DEX Pack using the 1E product pack deployment tool, either during setup or after

    3. The 1E-Tachyon-Platform DEX Pack is included in the 1E Platform zip, downloadable from the TeamViewer DEX Support Portal.

  7. At least one test device on which the 1E Client will be installed.

  8. 1E Client installation source files and configuration details required by your implementation.

To run the following tests you need:

  1. 1E Server installed.

  2. The name and password for the server installation account, account must also be enabled.

Ref

Test

Expected

Remediation

TCNI01

  1. Log on to the 1E Server using the server installation account

  2. Confirm 1E Server is listed in Apps/Programs and Features

  3. Confirm Windows services are running.

Programs and Features appwiz.cpl displays 1E Server with the correct version number.

If an MSP update has been installed, the Installed Updates displays 1E Tachyon Server Update (Qnnnnn).

The following Windows services exist and are running:

  • 1E Catalog Update Service: (Automatic) (Network Service)

  • 1E SLA Platform Engine: (Automatic Delayed start) (Network Service)

  • 1E SLA Platform Integrate Agent: (Automatic Delayed start) (Network Service)

  • 1E SLA Platform Integrate Manager: (Automatic Delayed start) (Network Service)

  • 1E Tachyon Coordinator: (Automatic Delayed start) (Network Service)

  • 1E Tachyon Switch Host: (Automatic Delayed start) (Local System)

If any of the services are not running, then check the corresponding log(s).

The Switch Host service will stop after several seconds if it is unable to start any Switches.

The ConsumerAPI log is not created until a user (the server installation account) successfully connects to the 1E portal.

The BackgroundAPI log is not created until a 1E Client attempts to download content. The 1E-Tachyon-Platform DEX Pack can be used to trigger this.

The Coordinator service will stop after several seconds if it is unable to activate the license.

TCNI02

  1. Check the 1E Server logs.

The default location for all logs is the folder %ALLUSERSPROFILE%\1E Refer to Subsystem and components. Refer to Services and NTFS Security if changing the location of log files.

In this version of 1E Server, some installers do not support the LOGPATH property and the logs folder is not configurable during installation.

Each component has a configuration file in the 1E Server installation folder structure, which contains log configuration details. Defaults are:

  • Filepath %ALLUSERSPROFILE%\1E\<product>\ where product is Tachyon, SLA Platform, and Catalog

  • Filename as shown in Subsystem and components.

  • Maximum size 10MB (2MB for Switch logs)

  • 2 rollover files numbered 1 to 2 with the rollover number included as n.log (5 rollover files for Switch logs)

  • Date and timestamps are UTC to help troubleshooters synchronize logs on systems in different time zones

Switch logs have the following names:

  • The first Switch installed will typically have a log filename Tachyon.Switch.4000.SW1.log (where 4000 is the port it is listening on and SW1 is the config name in the SwitchConfiguration table in the TachyonMaster database).

  • Other Switches on the same server will have different config names appended.

  • The log filename will be unique on a server, but there may be the same named log on a different server.

  • A Switch will continue to use the same log unless the SwitchConfiguration table is modified so that a different ID is used.

  • If you see a Tachyon.Switch.log without a config name appended, this is a special case where a Switch cannot find its correct configuration and has fallen back to using the template * row which has ID=1. In which case you will need to troubleshoot how that happened.

  • Rollover logs have numbers appended, for example, Tachyon.Switch_A.1.log, up to a default maximum of 5.

1E server components use the log4net RollingFileAppender class. Details can be found in Apache log4net.

Subsystem and components

Subsystem

Component

 

1E Master

1E Portal UI and applications.

1E\Tachyon\

Tachyon.Portal.log

Consumer API

1E\Tachyon\

Tachyon.ConsumerAPI.log

Coordinator service

1E\Tachyon\

Tachyon.Coordinator.log

Tachyon.Instrumentation.log

Experience Analytics web application

1E\Tachyon\

Tachyon.Experience.log

Catalog

Catalog UI (CatalogWeb - Admin sync)

1E\Catalog\

Catalog.Integration.UI.log

Catalog API

Catalog Update Service

1E\Catalog\

Catalog.UpdateService.log

Content Distribution

Content Distribution web application

1E\ContentDistribution

ContentDistribution.log

SLA

SLA/Platform APIs (Admin, Core External)

1E\Tachyon\

Tachyon.AdminAPI.log

SLA Platform UI (Platform)

1E\SLA Platform\

Web.log

SLA Engine

1E\SLA Platform\

Engine.log

SLA Integrate Services (Connector Manager)

1E\SLA Platform\

1E.SLAPlatformIntegrateAgent.log

1E.SLAPlatformIntegrateManager.log

1E.SLAConnector.<type>_sync.log

SLA Inventory

n/a

n/a

SLA Operations Provider (not currently used)

1E\Platform Consumer\

n/a

SLA databases (Data, Integrate, Shared)

n/a

n/a

BI

MDX API

SQL database

[SLA-BI].[BI].[Event Log]

1E Response

Core

1E\Tachyon\

Tachyon.CoreAPI.log

Background Channel (Background)

1E\Tachyon\

Tachyon.BackgroundAPI.log

Switch(es) (also includes a single Switch Host service)

1E\Tachyon\

Tachyon.Switch.4000.SW1.log

Tachyon.Switch.Host.log

The following are basic verification tests. To run the following tests, you need:

  1. 1E Server installed.

  2. The name and password for the server installation account, account must also be enabled.

  3. Remote workstation with a supported platform using a remote workstation is important because you will get different results if using a local browser.

Ref

Test

Expected

Remediation

TCNI03

  • Start a on a supported platform workstation (not the 1E Server) refer to Supported platforms.

  • Connect to the portal using:

    • server installation account

    • URL for example https://tachyon.acme.local/Tachyon

Successful connection to the 1E portal showing the following applications, if licensed:

  • AppClarity

  • Application Migration

  • Experience Analytics

  • Endpoint Troubleshooting (included with all licenses)

  • Endpoint Automation

  • Inventory Insights (included with all licenses)

  • Content Distribution

  • Patch Insights

  • Settings (included with all licenses)

The ability to open applications and navigate around them will depend on which roles have been assigned to the logged-on account.

For a new installation, the server installation accountis only able to open the Settings application and view the following pages, because it is only assigned to the Installer role and Setup user:

  • Configuration

    • Custom properties

      • Device Tags (view)

      • Software Tags (view)

    • Consumers (view, add)

    • License information (view, reactivate)

    • System information (view, export telemetry)

    • Branding (view, edit, reset)

  • Monitoring

    • Infrastructure log (view)

    • Audit information log (view)

    • System health (view)

    • Audit information log (view)

  • Permissions

    • Users and Groups (view, add)

    • Roles (view all roles - add, edit, and delete custom roles)

    • Management groups (view)

    • Assignments (view, edit

  • Instructions

    • Instruction sets (view, add, move, delete, upload, download)

Ensure the server installation account is enabled to do this test. It has the necessary rights to access 1E, as well as NTFS rights on the 1E Server.

401 'Unauthorized':

Typically, the website also prompts you to provide an account and password. This may occur if you are using invalid credentials or an account in a domain that is not trusted by the 1E Server.

403 'Access denied':

When you use a browser to open an application in the 1E portal, you will see Server Error 403 - Forbidden: 'Access denied' if the internal account used by the Application Pool does not have read access to the 1E web application folders. This can happen if 1E is installed in a non-default location and the NTFS permissions on the installation folder are not correct. To remedy the issue, you should review and correct NTFS permissions as described in Services and NTFS Security.

404 'File or directory not found':

Is the URL you entered correct, and have the correct spelling? Is the corresponding web application installed? For example, the Consumer application may not be installed.

Contact system administrator to get access:

When you use a browser to open an application in the 1E portal and you see the message Unauthorized access, it means your AD account is not a 1E user.

  • Try using an AD account that you know is a 1E user that is assigned to a 1E system role or custom role. For example, use the server installation account which is automatically installed as a 1E user.

  • For a new installation, the server installation account must be used to add other users before their AD accounts can be used to access 1E applications. This process is described in the Users and Groups and the Roles page. It is used in the following TCNU verification tests, refer to Verify user rights assignment.

TCNI04

  • Change the web browser URL from /Tachyon to /Consumer

The web browser will respond with the version number of the 1E Platform (IE will download as a JSON file, and other browsers will display a response in XML format).

Confirm the Version number is as expected.

TCNI05

  • Change the web browser URL from /Tachyon to /Admin

The web browser will respond with the version number of the SLA Platform (IE will download as a JSON file, and other browsers will display a response in XML format).

Confirm the Version number is as expected.

 

TCNI06

  • Change the web browser URL from /Tachyon to /Background

The web browser will respond with You have reached Tachyon background API. (IE will download as a JSON file, other browsers will display a response in XML format).

TCNI07

  • Change the web browser URL from /Tachyon to /Core

The expected response is Server Error 403 - Forbidden: Access is denied.

For security reasons, access to these web applications is allowed for local users and services only and denied to remote devices.

If the response is You have reached Tachyon Core API then there is an issue with IIS configuration. Or, you are using a browser on the actual 1E Server, and should do the test on a remote workstation.

Access Allowed:

It should not be possible for a remote web browser to have access to the Core web application.

If access is possible, then it is probable that the IIS role feature IP Address and Domain Restrictions is not installed on the 1E Server. You must ensure this IIS feature is installed. The setup installer verifies this prerequisite and optionally deploys the feature if it is missing.

TCNI08

Deleted test

 

TCNI09

  • Change the web browser URL from /Tachyon to /Platform

The web browser will take you to the SLA Inventory web application.

TCNI10

  • Change the web browser URL from /Tachyon to /CatalogWeb

  • Change the web browser URL from https to http and also change the server name so that it matches the value that you specified during installation for the HTTP host header. For example: http://ACME-TCN01.acme.local/CatalogWeb

In both cases, the web browser will take you to the 1E Catalog website.

If you use http while leaving the same server address used for https, the expected response is HTTP Error 404 - Not Found.

The 1E Catalog can use both http and https provided that you specify the correct server name for each protocol. For interactive use, you are recommended to use https. Http is provided for internal compatibility with existing consumers.

An HTTP connection will fail if the HTTP binding has been deliberately removed. Refer to1E Server post-installation tasks.

To access the Admins tab in the CatalogWeb, you must manually add one or more administrator accounts or groups to the website configuration. Refer to Rebuilding the Catalog.

To run the following tests, you need:

  1. 1E Server installed and above TCNI verification tests passed, refer to Verify 1E Client installation.

  2. The name and password for the server installation account, account must also be enabled.

  3. Two AD User accounts, Test User 1 and 2.

    1. Must not be existing 1E users because they will be assigned specific roles for the purpose of these tests.

    2. Must have email addresses and be able to read emails.

  4. The 1E-Tachyon-Platform DEX Pack, if not already installed.

1E is often asked why the 1E-Tachyon-Platform DEX Pack is not built into the product. The reason is that uploading a known DEX Pack is part of the verification process and ensures the user is able to upload at least one pack and carry out all the other necessary tasks at least once before exploring other aspects of 1E.

Ref

Test

Expected Response

Remediation

TCNU01

  • Download the 1eplatform.v9.x.zip file from the TeamViewer DEX Support Portal

  • Extract the 1E-Tachyon-Platform.zip from the ProductPacks\Classic folder

  • Start a Supported platforms on a workstation

  • Connect to the 1E portal as the server installation account

  • Open the Settings application and go to the Settings > Instructions > Instruction sets

  • Click on Upload

  • In the Open dialog navigate to the location of 1eplatform.v9.x.zip

  • Select the 1E-Tachyon-Platform.zip file and click Open

All the instructions contained in the zip will initially be added to the default Unassigned instruction set. Instructions in the Unassigned instruction set cannot be used, so you will need to add the instructions to a new instruction set:

  • Select the 2 verification instructions to the new set, by clicking the checkbox at the start of each instruction row in the list

  • Click the Add new set button in the button panel to the right of the page

  • In the Add new instruction set popup subsequently displayed, and type 1E Tachyon Platform as the name

  • Ensure that the Include 2 selected instructions checkbox is checked

  • Click Add to add the new instruction set, with the selected instructions

You will upload the 1E Tachyon Platform DEX Pack and assign them to a new instruction set called 1E Tachyon Platform.

For a new installation, the Instruction sets page will not contain any instruction definitions.

After uploading the 1E Tachyon Platform DEX Pack, the two instructions contained in the pack will be displayed on the page.

After creating the 1E Tachyon Platform instruction set, this will appear in the Instruction sets list.

After moving the verification instructions from Unassigned to the 1E Tachyon Platform instruction set, the instruction count for the 1E Tachyon Platform instruction set will go up by 2.

Unlike some earlier versions of 1E, this version does not support the drag and drop method of uploading DEX Packs.

You can use the 1E product pack deployment tool instead.

If the server installation account is not able to add instructions from a DEX Pack, then the installation account is not assigned to the Full Administrator role.

You can confirm if this is the case by viewing the rights of the server installation account in Settings > Permissions > Users. You may have upgraded from a previous version where the server installation account was not automatically assigned to this role.

Contact 1E for advice on how to fix this.

TCNU02

  • Connect to the 1E portal as the server installation account

  • Open the Settings application and go to Settings > Permissions > Users and Groups

  • Click Add and search for an AD Universal security group

  • Select one of the AD security groups and click Add

  • Click on the name of the AD group just added

  • In Group: details, view the group members

  • Navigate back to Users and Groups

  • Select the checkbox for the group just added and click Remove and then click Yes, remove group

Entering one or more characters and clicking the search icon returns a list of matching user accounts and security groups.

Selecting a group and viewing its members shows the Name and Email of each member.

The purpose of this step is to confirm the system is capable of searching Active Directory. You do not need to add the group; you will add users in the next step.

The ability to search and find different types of AD security groups depends on the search method selected during the installation of the 1E Server. Refer to Directory requirements.

TCNU03

  • Connect to the 1E portal as the server installation account

  • Open the Settings application and go to Permissions > Users and Groups

  • In Users and Groups click on Add

  • In the Add User prompt under Select AD user or security group type in the search box Test User 1 and click on the search icon

  • Select Test User 1 from the search results and click on Add

  • Repeat the same steps to add Test User 2

  • Go to Permissions > Roles

  • Add a custom role named 1E Tachyon Platform

  • Click on the name of the role that you just added. This will take you to the Permissions tab. Add permission with the following properties:

    • Type: Instruction Set

    • Name (of the Instruction Set): 1ETachyonPlatform

    • Permissions: Actioner, Approver, Questioner, Viewer

  • Click on Add

  • Assign Management Group: All Devices

  • Go to the Members tab and add Test User 1

  • Role: 1E Tachyon Platform

  • Repeat for Test User 2

The following custom role exists:

  • 1E Tachyon Platform

The following users are included in the list of Users.

  • Server installation account assigned to the Installer role

  • Test User 1 assigned to roles:

    • 1E Platform

  • Test User 2 assigned to roles:

    • 1E Platform

You will also see some system and machine accounts in the list of users. These are used internally for interaction with other components and should not concern you at this time.

 

TCNU04

  • Connect to the 1E portal as Test User 1 and confirm access to Endpoint Troubleshooting pages

  • Repeat for Test User 2

Each Test User is able to view the following menu pages in the Endpoint Troubleshooting application:

  • Home

  • Instructions

    • History

    • Tasks

    • Scheduled

  • Devices

    • Table

    • Dashboard

  • Notifications

Contact system administrator to get access:

When you use a browser to open an application in the 1E portal and you see the message Unauthorized access, it means your AD account is not a 1E user.

Try using an AD account that you know is a 1E user that is assigned to a 1E system role or custom role. For example, use the server installation account which is automatically installed as a 1E user.

For a new installation, the server installation account must be used to add other 1E users before their AD accounts can be used to access Endpoint Troubleshooting. This process is described on the Refer to Users and Groups and the Roles page.

403 'Access denied':

When you use a browser to open an application in the 1E portal, you will see Server Error 403 - Forbidden: 'Access denied' if the internal account used by the Application Pool does not have read access to the 1E web application folders. This can happen if 1E is installed in a non-default location and the NTFS permissions on the installation folder are not correct. To remedy the issue, review and correct NTFS permissions as described in Services and NTFS Security.

To run the following tests you need:

  1. 1E Server installed and TCNI verification tests passed, refer to Verify 1E Server installation.

  2. Two user accounts, Test User 1 and 2, and above TCNU verification tests passed, refer to Verify user rights assignment.

  3. At least one test device on which the 1E Client will be installed.

  4. 1E Client installation source files and configuration details required by your 1E implementation.

Ref

Test

Expected Response

Remediation

TCNA01

  • Install the 1E Client on the test device using the configuration settings required for your implementation

    • DNS Alias of 1E Server

    • Port used by the 1E Switch

    • Port used by the 1E Background Channel

  • Include optional MSP update

  • Confirm Programs and Features

1E Client installed.

Programs and Features display 1E Client.

  • Correct platform x86 or x64

  • Correct version number

If an MSP update has been installed, the Installed Updates displays 1E Client Update (Qnnnnn).

The first clients can be installed manually or using a script.

You should repeat this set of tests when you have deployed a few clients using your organization's preferred deployment method.

You may need to edit the 1E Client configuration file after installation, to suit the requirements of your implementation, and restart the 1E Client service.

TCNA02

  • Confirm Windows services are running

The following Windows services exist and are running.

  • 1E Client

  • 1E Nomad Branch: Only if Module.Nomad.Enabled=true

If the 1E Client service is not running, then check the Client log.

TCNA03

  • Check the 1E Client log

No errors.

1E Client logs on Windows:

  • %ALLUSERSPROFILE%\1E\Client\1E.Client.log (used by 1E Client and Platform features, and Shopping client)

  • %ALLUSERSPROFILE%\1E\Client\NomadBranchUninstall-YYYY_MM_HHTMM_HH_SS_000Z.log

1E Client logs on macOS:

  • /Library/Logs/1E.Client.Daemon.log (shows any service start errors)

  • /Library/Logs/1E.Client.log (shows the current operation of the 1E Client)

1E Client logs on other non-Windows platforms:

  • /var/log/1E/Client/1E.Client.log

Check the Switch setting in the Client configuration file is using the correct DNS Alias for the 1E Server, and the correct port for the Switch.

If errors in the Client log relate to certificates, then refer to the TeamViewer DEX Support Portal.

TCNA04

  • Start a supported browser on a workstation, refer to Supported platforms

  • Connect to the 1E portal as Test User 1

  • Open Endpoint Troubleshooting and go to Devices > Table

  • For each Test Device that has had the 1E Client installed, confirm the device is listed in the Table page

  • Click on each device and view the device properties

Each Test Device is listed on the Devices Table.

The device details show information about the device's system, activity, certificate, and configuration settings.

If you cannot use the Test User 1 or 2 accounts, then use another 1E user account. All 1E users are able to view the Devices Table page.

Check the configuration of the client and review the 1E Client settings in the 1E Client configuration file.

The 1E Client is controlled via the 1E Client configuration file 1E.Client.conf which resides in the installation folder along with the 1E Client executable.

The default installation location used for the different OS supported by the 1E Client:

  • Windows: %ProgramFiles%\1E\Client

  • Linux and Solaris: /etc/1E/Client

  • Mac: '/Library/Application Support/1E/Client'

The configuration file uses ASCII encoding. A comment line starts with the # symbol.

To run the following tests you need:

For test details, refer to 1E Client Verifying - 1E Client

To run the following tests you need:

  • All the above tests completed.

  • To log on to a workstation with a user account that is assigned to at least one of the 1E administration roles that allows you to run some instructions, which can include a Verification instruction already used above.

Ref

Test

Expected Response

Remediation

TCNX01

Export All feature:

  • To confirm the Export All share is accessible, use Windows Explorer to browse to the share name specified when the Export all feature was configured

  • Connect to the 1E portal, open Endpoint Troubleshooting and ask a question

  • After at least one device has responded with content, stop the question and keep the responses

  • In the Content or Status tab on the Responses page, click on Export all results

  • Enter the share name and click Save

  • Use Windows Explorer to browse to the share name and observe a TSV file has been created

  • Use Microsoft Excel or Notepad to view the contents of the TSV file

This test verifies BCP has been installed on the 1E Server, and an Export share is correctly configured, refer to 1E Server post-installation tasks.

When you stop the question or wait for the question to complete its gather duration, then Export All results will be enabled. TSV is a tab-delimited text file.

If you see an error initiating an export operation after clicking on Export All results, then:

  • Ensure you specify the hostname or hostname FQDN of the Windows computer where the share has been created; do not use a DNS Alias

  • Check the share permissions

  • Check the share NTFS security

Instruction text (ReadablePayload)

Type

Description

Instruction file name

Version

Tachyon Platform verification stage 1

Question

Stage 1 of the verification will return all software installed on each 1E Client endpoint.

Verification stage 1 is a simple question-type instruction used to verify the:

  • Authenticated user is able to access and use 1E Endpoint Troubleshooting

  • End-to-end communication between the 1E system, the Switch and the platform client.

1E-TachyonPlatform-VerificationStage1

19

Tachyon Platform verification stage 2 (all platforms)

Action

Stage 2 of the verification will run a PowerShell script to return a subset of the current configuration of the platform client features of 1E Client.

Verification Stage 2 is normally expected to be run as a follow-up action for Verification Stage 1.

Verification stage 2 is a simple action-type instruction used to verify:

  • Two-factor authentication (if enabled) and approval workflow, which tests email (if enabled) - necessary for action-type instructions

  • End-to-end communication between the 1E system, the Background Channel and platform client

  • The client is able to run PowerShell scripts on Windows OS - many 1E instructions and 1E Endpoint Automation rules use PowerShell version 3.0 and later

  • The client is able to run Bash script on non-Windows OS

Refer to Scripting requirements.

The rate at which Responses are returned to the 1E system via the Switch is affected by the 1E Client setting DefaultStaggerRangeSeconds. This setting governs a random delay before the instruction downloads the script from the Background Channel. This stagger setting is ignored on Windows OS if Content Distribution client is enabled - instead only one client per subnet (or site if Content Distribution SSD is used) will act as master and download the script from the Background Channel, and peer clients will download the script from the master.

1E-TachyonPlatform-VerificationStage2

21