Skip to main content

1E 23.11 (SaaS)

Platform features of the 1E Client

Configuration file settings, and their installer properties, for the platform features of the 1E Client.

Note

Configuration file settings and installer properties:

Note

Some configuration file settings do not have equivalent installer properties. These are indicated in the tables below.

Note

Additional Windows installer properties that are not available in the Configuration file: TAGS

1E Client installers include a template configuration file that contains the more important settings with default values that match hard-coded default values. The configuration file is updated during installation and named 1E.Client.conf in the installation folder along with the 1E Client executable.

After installation, configuration file settings can be managed using 1E Client command-line parameters, Tachyon Explorer configuration instructions, Endpoint Automation policies, Configuration Manager baselines or other means. Registry settings can also be managed by Windows Group Policy.1E Client command-line parameters

Windows installer properties

Note

You must use UPPERCASE when specifying the name of any installer property in a mst transform file, and preferably when including them in a msiexec command-line.

Names of settings stored in the configuration file are not case-sensitive. Setting names stored in the registry may be case-sensitive and should be specified as shown.

Settings that have numeric values must be set using decimal integers, unless otherwise specified.

The following table shows Windows installer properties for the 1E client, that are not available in the client configuration file. They can be set only during installation, by specifying on the command line or in a mst transform file.

Installer property

Default

Description

TAGS

(empty)

Configures one or more device and freeform tags, either on the msiexec command-line in or in a mst transform file. For more information about transform files please refer to Advanced configuration.

The format of the installer property is: [*]<Tag1>=<Value1>|[*]<Tag2>=<Value2>|…|[*]<Tagn>=<Valuen>

Where:

  • <Tag> is the name of a tag. The name must be prefixed with an asterisk * if it is a device tag

  • <Value> is the value for that tag.

Use the pipe | delimiter when specifying more than one tag.

For example, the following would be added to the command-line to set a device tag Department=Finance and a freeform tag Persona=Clerk

  • TAGS="*Department=Finance|Persona=Clerk"

Double-quotes - these are recommended when using a command line, as shown in the above example, and required if any tag values have spaces. Double quotes are not required in a mst transform.

This optional installer property is only available during installation or upgrade of 1E Client on Windows OS. It is not available in the client configuration file. To configure device and freeform tags after installation, you must use 1E instructions, as described in Tagging client devices.

Note

You can only use the device tags in the coverage feature of Endpoint Troubleshooting, if you have also added the tag in the Device Tags page in 1E Platform Settings.

Settings for platform features of the 1E Client

The following table shows 1E Client settings for 1E platform features; all are included in the template configuration file except where indicated.

Note

1E client must be enabled to use platform or Content Distribution features of the 1E Platform.

If neither 1E platform or Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a mst transform file.

When doing an interactive install then you must uncheck the Enable 1E checkbox. Platform features are not required if the 1E Client is being installed only to support basic Content Distribution, PXE Everywhere, Shopping, or WakeUp.

Core setting

Installation default

Description

AuthenticationPolicy

Required

Determines whether the 1E client presents a certificate when authenticating with a Switch. A Switch will reject a connection if configured to require certificates from clients and a client does not present a valid certificate.

The value must be set to one of the following. The default value is set to Required.

Note

The default applies to new installations of the 1E Client. Upgrades from a previous version always retain the existing setting as defined in 1E.Client.conf.

Value

Description

none

Do not present a certificate. This option is not visible when installing the 1E Client interactively, but can be configured using a command-line installer property.

optional

Present a certificate if a suitable one exists. If none exists continue with the connection anyway. This is the default value.

This option is useful if you are deploying the 1E Client before you have deployed certificates. Switches can be configured so they do not require client certificates, but if you did not select that option during installation then you can change the server setting.

required

Present a certificate if a suitable one exists, otherwise fail the connection.

BackgroundChannelUrl

(none)

If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox.

1E client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform.

To connect to the 1E platform then BackgroundChannelUrl will have one or more entries in the format:

BackgroundChannelUrl=https://<BackgroundChannelServer>:<BackgroundChannelPort>/Background/

<BackgroundChannelServer> is the DNS Name FQDN of the server, which is the same as:

  • the HTTPS Host Header specified on the Website Configuration screen of 1E Setup, which is the HTTPS binding for the Tachyon website

  • the same as <SwitchName>

  • the DNS Name specified in the 1E Server's Web Certificate

<BackgroundChannelPort> is the Port number, which is the same as:

  • the HTTPS Port specified on the Website Configuration screen of 1E Setup, which is the HTTPS binding for the Tachyon website

  • if using the default HTTPS port 443, the port can be omitted from the URL

In systems with multiple server and multiple DNS Names, there will be multiple entries on one line using a semi-colon (;) as the delimiter between entries. For example:

BackgroundChannelUrl=https://tachyon.acme.local:443/Background/;https://tachyon.acme.com:443/Background/

Multiple DNS Names may exist in complex systems where there are multiple servers, Switches, and devices on different networks, such as the Internet as well as the corporate network.

Each time 1E needs to download content, it will try each entry in turn, starting at the first, until it is able to download or stops trying and reports an error.

ConnectionKeepaliveTimeInSecondsMin

600 (10 minutes)

Determines the time in seconds for the 1E client to wait between sending a keep-alive messages to the Switch.

1E client will wait a random amount of time between the two values set as minimum and maximum. Range is 0 to 900 seconds (No keepalive to 15 minutes).

ConnectionKeepaliveTimeInSecondsMax

840 (14 minutes)

ConnectionRetryTimeInSecondsMin

30 (seconds)

Determines the time in seconds the 1E client waits before trying to reconnect to a Switch after a connection failure.

The 1E client tries once for each Switch in the list of Switches, and if it fails to connect then it waits before trying again. The wait is a random amount of time between the two values set as minimum and maximum. Range is 5 to 86400 (5 seconds to 24 hours).

See also FastReconnectTimeInSeconds.

ConnectionRetryTimeInSecondsMax

900 (15 minutes)

ConnectionTimeout

30 (seconds)

The maximum time in seconds that can elapse between the 1E client initialising the connection with a Switch and having a fully established websocket.

Range is 1 to 60.

CRLChecks

soft

Determines whether 1E client does Certificate Revocation List (CRL) checking for:

  • the certificate it presents to the Switch when requesting a connection (see also AuthenticationPolicy, which determines whether 1E clients present a certificate or not)

  • the certificate received from the Switch when requesting a connection

  • the certificate received from the Background Channel server before attempting to download content

  • the certificate received from any other HTTPS-based endpoint from which 1E client downloads content

  • the certificates used for digital signing of 1E Client executables (typically the certificate is found in the Trusted Publishers Store)

The value must be set to one of the following. The default value is set to soft.

Value

Description

off

No CRL checking is performed by the 1E Client.

soft

This is the default.

Full CRL checking is performed by the 1E Client for each certificate in the list above. However if a CRL Distribution Point (CDP) is unreachable then only a warning will be reported.

A certificate error occurs if a CDP is available and the CRL cannot be retrieved or refreshed, or the certificate is revoked.

hard

Full CRL checking is performed by the 1E Client for each certificate in the list above. If a certificate error occurs then 1E client stops processing the request.

A certificate error occurs if a CDP is not available, or the CRL cannot be retrieved or refreshed, or the certificate is revoked.

If a certificate error occurs then 1E client will not proceed, or will not start in the case of a digital signing certificate error.

Note

By default, the Switch will reject the connection if it cannot check a certificate presented by 1E client. Please contact your 1E Account Team if you need help with configuring Switches if you are unable to use CRL checking.

CRLTimeoutInSeconds

Note

This setting does not have an equivalent Windows Installer property and is not in the template configuration file.

3 (seconds)

The maximum time in seconds that is allowed to elapse whilst the 1E client attempts to download a Certificate Revocation List (CRL) from a CRL Distribution Point.

The range is 1 to 10 seconds.

DefaultStaggerRangeSeconds

300 (5 minutes)

Some operations (including HTTPS downloads from the BackgroundChannel) are randomly time-staggered across clients. This property dictates the upper-limit on the default randomization period in seconds.

Range is 0 to 3600. Default is 300.

Use 0 to instruct 1E client not stagger operations by default.

Note

Do not change this value unless advised by 1E. Only use 0 or a low value in systems that support less than 500 clients.

Note

This setting is not used for HTTPS downloads from the BackgroundChannel if NomadContentDownloadEnabled is true, because Nomad does the bandwidth management.

EnablePayloadCompression

true

Determines whether the client should attempt to compress payloads when responding to instructions, if it looks like compression would be beneficial.

Must be set to true or false.

FastReconnectTimeInSeconds

Note

This setting does not have an equivalent Windows Installer property and is not in the template configuration file.

15 (seconds)

During machine wakeup, following a machine sleep or hibernation, the first reconnect attempt to the Switch will occur in <FastReconnectTimeInSeconds> seconds.

This value is configurable between 5 and 60 seconds.

For the majority of Windows devices the default value of 15 seconds is more than adequate for the Windows network stack to stabilise on wakeup.

On non-Windows platforms this property is currently ignored.

See also ConnectionRetryTimeInSecondsMin/Max.

LoggingLevel

Info

Determines how much logging information is generated. This may be set to one of the following values. The default value is info.

Value

Description

Error

Only outputs errors. An error is a serious problem, typically requiring operator intervention of some sort to restore full functionality.

Warn

Outputs errors and warnings. A warning indicates a potential problem, where the system can nonetheless function without intervention.

Info

Outputs general information in addition to the errors and warnings. This is the default.

Debug

Outputs debugging information in addition to all the previous levels.

Trace

Outputs the maximum information available. Used only in exceptional circumstances as it will generate huge amounts of logging output.

Warning

Logging levels should only be changed from info only if requested by 1E Support and reset to info after investigation is complete.

LogPath

Note

This setting is shared with the 1E Client.

1E Client logs on Windows

%ALLUSERSPROFILE%\1E\Client\1E.Client.log (used by 1E Client and Tachyon 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

The LogPath setting is stored in the 1E.Client.Conf file and determines the full path and filename of the 1E Client log file.

The 1E Client log is shared by:

  • 1E Client

  • 1E client features

  • Shopping client module (only available on Windows OS)

To change the logging level, please refer to LoggingLevel in the 1E.Client.CONF file.

The following are not configurable in this version:

  • Maximum size of 5MB

  • 5 rollover files numbered 1 (newest) to 5 (oldest) with the rollover number included as n.log

Note

By default, Windows resolves %ALLUSERSPROFILE% as C:\ProgramData\

See Log files for more details about 1E Client logs.

NomadContentDownloadEnabled

true

The Content Distribution integration feature is for Windows clients only. The feature is enabled if this value is set to true and Content Distribution is running on the device. There is no dependency on Configuration Manager which Content Distribution also integrates with.

Value

Description

false

  • 1E client waits a randomized stagger period defined by its DefaultStaggerRangeSeconds setting, and then downloads content from the specified Background Channel.

  • 1E client retains modules and extensibles that it has downloaded, but does not retain instruction scripts after they have been run. Any instruction that requires a script or other file will download the latest version each time the instruction is run.

true

  • 1E client immediately requests Content Distribution to download content from the specified HTTP source, such as the Background Channel. Content Distribution behaves in the same way as it does with Configuration Manager by ensuring the latest version of content is obtained and electing a master to perform the actual download.

  • Content Distribution maintains its own cache of downloaded content which avoids the need for repeat downloads over the WAN, and provides content to peers that require the same resources which avoids peer devices having to download over the WAN.

NomadContentDownloadTimeoutSecs

600 (10 minutes)

The Content Distribution integration feature is only for Windows computers. If this feature is enabled, and requested content is not provided within the timeout period, The 1E client will fall back to downloading directly from the Background Channel

The most likely reason for a timeout is if Content Distribution is busy downloading other content.

The range is 10 to 3600 (1 hour).

Note

On all non-Windows platforms this property defaults to 0 and is ignored.

PolicyEnabled

true

Determines if the Policy feature of the 1E client is enabled (true) or not (false). The Policy feature is responsible for downloading, evaluating and reporting on policy rules defined in the Endpoint Automation application on the 1E platform.

If set to true then you must also configure settings for Switch and Background Channel.

Must be set to true or false.

SelectRowsLimit

Note

This setting does not have an equivalent Windows Installer property, but is in the template configuration file.

100000 (105)

Limits the number of rows returned by a SELECT expression. The principle is that if there is more than this number of rows then something has gone wrong. This limit prevents an unexpectedly excessive amount of both data and CPU usage.

The range is 1 to 1000000000 (109). The default value is 100000 (105).

Note

It is not considered an execution error if the limit is reached, although a warning will be written to the 1E Client log.

SSL

TLSv1.2

Determines which security protocol the 1E client uses when connecting to Switches and Background Channel.

SSL must be set to one of the following values:

Value

Description

TLSv1.2

TLS version 1.2 is a cryptographic protocol aimed at securing the network transport layer, and has recently been adopted by all the major browsers. It is considered to be more secure than SSLv3. This is the default.

Warning

Always use the default TLSv1.2 unless advised by 1E.

Switch

(none)

If 1E and Content Distribution client features are not required then the connection to 1E Platform is not required, and both Switch and BackgroundChannelUrl settings must be set to none when doing a non-interactive (silent/quiet) install using installer properties on a command-line or in a MST transform file. When doing an interactive install then you must uncheck the Enable 1E checkbox.

1E client features are not required if the 1E Client is being installed only to support PXE Everwhere, Shopping, or WakeUp. They are only required for Content Distribution if using Content Distribution features of the 1E Platform.

To connect to the 1E platform then Switch will have one or more entries in the format:

Switch=<SwitchName>:<SwitchPort>

<SwitchName> is the DNS Name FQDN for one or more Switches. This is the same as the following except in a custom configuration where the Switch is installed on its own:

  • the HTTPS Host Header specified on the Website Configuration screen of the Tachyon Server installer, which is the HTTPS binding for the Tachyon Web Site

  • the same as <BackgroundChannelServer>

  • the DNS Name specified in the 1E Server's Web Certificate.

<SwitchPort> is the Port number, which has default value of 4000. Any other port number is used only in a complex configuration if advised by 1E.

In systems where there are multiple DNS Names, there will be multiple entries using a semi-colon (;) as the delimiter between entries. For example:

Switch=tachyon.acme.local:4000;tachyon.acme.com:4000

Multiple DNS Names may exist in complex systems where there are multiple servers, Switches, and devices on different networks, such as the Internet as well as the corporate network.

When the 1E client attempts to find a Switch, it will try each entry in turn, starting at the first. If all attempts fail 1E restarts the connection process after a period determined by ConnectionRetryTimeInSecondsMin/Max.

WorkerThreads

2

Determines the number of threads that will execute instructions concurrently. This property enables instructions to be run simultaneously and prevents long running instructions from blocking others.

Range is 1 to 8. 1 means all instructions are run sequentially on the same thread.

Interaction module settings

This section describes configuration settings for the Real-Time Control Center and 1E Client UI (User Interaction) features provided by the Interaction module.

1E Client, while running, continuously captures details of certain user activity, such as which window is in the foreground on the user’s desktop, and when the user is interacting (keyboard and mouse activity) with that window. Data is regularly written into a local, compressed and encrypted persistent storage tables, that are accessible using Interaction methods. The whole process is designed to minimize impact on device performance, storage and security.

The Interaction module is supported only on Windows OS (not Windows XP, Vista or other legacy OS). The 1E Client UI, which is launched by the Interaction module, requires Microsoft .NET Framework.

Configuration setting

Installation default

Description

Module.Interaction.Enabled

Note

This interaction setting is in the template configuration file.

true

Set this setting to true to enable the Interaction module. Default value is true.

Must be set to true or false.

Module.Interaction.ActiveSessionThresholdSeconds

2

This setting is used to ensure that if the user is currently busy interacting, then focus will not be stolen from the user to display a notification.

Notification display will only be considered if the user stopped interaction at least Active Session Threshold Seconds before.

Active Session Threshold Seconds is configurable between 0 and 30.

Module.Interaction.CompanyName

1E Ltd.

The organization name that is displayed in the header of the Real-Time Control Center and other 1E Client UI dialogs. Can be set by the installer.

Module.Interaction.DoNotDisturb

Note

This interaction setting is in the template configuration file.

false

Set true to enable Do not disturb, and stop notifications after startup. Surveys sent to this device will respond as Timed out.

Set false to disable Do not disturb, and show notifications after startup.

In each case, if the Module.Interaction.NotificationIcon setting is true, the user can still use the notification area icon to enable or disable notifications. However, each time the user signs in, the Do not disturb mode will be reset.

Module.Interaction.IdleSessionThresholdMinutes

30

To ensure that notifications only appear when the user is present, this threshold specifies that notifications should not be displayed if more than the configured number of idle minutes has elapsed.

Idle Session Threshold Minutes is configurable between 1 and 1440.

Module.Interaction.ITSM.ServiceNow.CreateIncidents

false

If set to true, and ServiceNow integration is enabled, then users can create new incident tickets. (New in 8.0)

Module.Interaction.ITSM.ServiceNow.Enabled

false

Enable ServiceNow integration. This feature shows ServiceNow ticket information in the Real-Time Control Center.

This feature also requires the following:

Module.Interaction.ITSM.ServiceNow.GoBackDays

30

Sets how far back to look for tickets that changed state to inactive (closed, resolved or cancelled).

By default, the Real-Time Control Center shows all active tickets for the user. The user can also choose to view inactive tickets that have changed state during this period.

The range is 1 to 365.

Only used if Module.Interaction.ITSM.ServiceNow.Enabled is true. Can be set by the installer. (New in 8.0)

Module.Interaction.ITSM.ServiceNow.Url

(none)

The URL to a ServiceNow instance, for example https://acme12345.service-now.com.

Only used, and required, if Module.Interaction.ITSM.ServiceNow.Enabled is true. Can be set by the installer. (New in 8.0)

Module.Interaction.LogSessionNotificationReadiness

false

If set to true, the 1E Client will log an INFO message to indicate that a given user session is ready for notifications.

If set to false, this information will be logged only at TRACE level. Intended for troubleshooting purposes only.

Module.Interaction.MinimumMinutesAfterLogonBeforePrompt

60

To ensure that notifications don't appear too soon after logon, this setting specifies the minimum time in minutes that must elapse after the user has been logged onto a session before notifications can appear.

Minimum Minutes After Logon Before Prompt is configurable between 1 and 1440.

Module.Interaction.MinimumMinutesAfterSessionActivationBeforePrompt

15

To ensure that notifications don't appear immediately after session unlock or reconnect, this setting specifies the minimum time in minutes that must elapse since the user session has been reactivated before notifications can appear.

Minimum Minutes after Session Activation Before Prompt is configurable between 1 and 1440.

Module.Interaction.MinimumMinutesBetweenPrompts

60

To ensure that notifications don't appear too frequently, this setting specifies the minimum time in minutes since a notification was displayed before another notification will appear.

Minimum Minutes Between Prompts is configurable between 1 and 1440.

Module.Interaction.NotificationIcon

Note

This interaction setting is in the template configuration file.

true

If set to true, a notification area icon will appear when the Client UI is running.

If set to false, the icon will not be visible. Users may see notification popups, but will not be able to:

  • select User Sentiment surveys from the menu

  • use the Do not disturb option

Module.Interaction.PeriodsBeforeUiLaunch

2

Specifies how many time periods to wait before launching the 1E Client UI, typically a launch time period is 5 seconds.

Periods Before UI Launch is configurable between 1 and 120.

Module.Interaction.PeriodsBeforeUiLaunchTimeout

12

Specifies how many time periods may elapse before it is considered that the 1E Client UI has failed to launch, typically a launch time period is 5 seconds.

Periods Before UI Launch Timeout is configurable between 1 and 24.

Module.Interaction.Port

Note

This interaction setting is in the template configuration file.

7766

The port number used for communication between the 1E Client service and 1E Client UI.

Port is configurable between 100 and 65535.

Module.Interaction.ResponseAuditsBeforeTidy

100

This setting defines how frequently responses should be pruned to retain only the most recent responses.

A response audit typically occurs each time a user responds to a notification, where a response includes dismissing or snoozing a notification.

Response Audits Before Tidy is configurable between 10 and 1000.

Module.Interaction.ResponseRetentionRows

5000

This setting ensures that the 1E Client only retains the most recent responses, with this value indicating how many responses should be retained.

Response Retention rows is configurable between 100 and 50000.

Module.Interaction.SampleExclusionList

(none)

A comma-separated list of process names that are excluded from User Interaction sampling. Case is not significant. Only used if Module.Interaction.SampleUserInteraction is true.

When User Interaction sampling is enabled, the Interaction module uses regular sampling to determine the responsiveness of application windows on the user's desktop. If the foreground window's process name has any of these values as a substring then it is excluded from the interactivity test.

Module.Interaction.SampleUserInteraction

Note

This interaction setting is in the template configuration file.

true

Set to true, to enable User Interaction sampling.

The Interaction module uses regular sampling to determine the responsiveness of application windows on the user's desktop, and will also track user keyboard and mouse input to determine the level of activity.

Module.Interaction.SnoozeTimeMinutes

15

This setting specifies the time in minutes that must elapse before a notification can be considered for re-display, after the user clicked on the Later button, or it had timed out.

Snooze Time Minutes is configurable between 1 and 1440.

Module.Interaction.Theme

(none)

Specifies a theme that should be applied to the notifications.

Can be one of: Light, Dark or HighContrast.

If a value is not provided, the 1E Client UI will automatically determine the most appropriate theme based on the user's Windows desktop settings.

Real-Time Control Center integration with ServiceNow

The Real-Time Control Center is an enhancement to grant the 1E Client access to a ServiceNow instance.

The feature supports user-driven self-service ticket management, allowing end users to get insights into the progress of a ticket over its lifetime. In addition, this feature uses OAuth, a token-based authorization, instead of basic authentication.

Prerequisites
  • The URL of the ServiceNow instance

  • An OAuth access token (not username and password) suitable for accessing the instance which may include the ability to create incident tickets.

Users in ServiceNow and 1E platform

In 1E platform there are two types of users in a ServiceNow instance:

  • Single service account user whose access token grants access to the ServiceNow instance. This account is shared by all Real-Time Control Center users.

  • End users defined in the ServiceNow instance.

If a 1E platform user is not defined in your ServiceNow instance, they are automatically created when the Real-Time Control Center user clicks on the Open an Incident Ticket button. The name used will be the user's Windows "principal name" which is of the form "fred.bloggs@mightycorp.com".

Company name

This is displayed in the header of the Real-Time Control Center . It is the Module.Interaction.CompanyName value in the 1E.Client.conf file. Refer to Interaction module settings for more details.

Enable ServiceNow integration

Set the following In the 1E.Client.conf file, using the URL of the ServiceNow instance:

Module.Interaction.ITSM.ServiceNow.Enabled=true
Module.Interaction.ITSM.ServiceNow.Url=https://dev131036.service-now.com

Configure the instance access token as follows. This is relevant if you have enabled ServiceNow integration.

The access token must be added to the GlobalSettings table of the 1EMaster database. The Name is ServiceNowAccessToken.

The Usage value must be 2 (corresponding to Core access), and CacheAgeMinutes should be something like 60. The Value, the token text itself, will be in the following format:

1C8cu5m3Be1u3xfdMatqZC42hiJxFizzyF2BhwPqNDadOxyGFwRxTqo9iyuhtgGTwqfMkfIGz6o-F6u_NHiUzw

Note

  • All users share a single access token.

  • There is no UI to create the setting. The DB table must currently be manually edited.

Also refer to The process when the Access Token is updated.

Enabling incident ticket creation

By default, end users cannot create new incident tickets from the Real-Time Control Center . To allow ticket creation, set the following in the 1E.Client.conf file:

Module.Interaction.ITSM.ServiceNow.CreateIncidents=true
Showing inactive tickets

There is a checkbox to allow inactive tickets (closed, resolved, or cancelled) to be shown, but only those whose state has recently changed.

To control how many days to search for a change of state, set the following value in the 1E.Client.conf file:

Module.Interaction.ITSM.ServiceNow.GoBackDays=30

The default value is 30. Refer to Interaction module settings for more details.

The process when the Access Token is updated

The first thing to do is update the ServiceNowAccessToken value in the GlobalSettings table of the 1EMaster DB.

By default, the Switch caches the token for 60 minutes, so it will not immediately register the change. To force the change, and make the Switch recognize the new token, you can restart the 1E platform Switch.

The update process follows these steps:

  1. On the 1E Client host, when an end user logs in, the 1E Client starts up an instance of the Real-Time Control Center .

  2. Real-Time Control Center requests the access token using the 1E Client , which asks the Switch each time as the value is not cached in the 1E Client itself. The Switch gets it from the GlobalSettingstable via the 1E Core API.

  3. Real-Time Control Center instance never attempts a refresh, so the only way for a new token to take effect on an end-user device is if they log out and back in again, resulting in a new Real-Time Control Center instance.

Note

An instruction could be used to kill all instances of 1E.Client.Interaction.exe (the Real-Time Control Center executable). The 1E Client will detect this and will launch a new Real-Time Control Center for each user session. Doing this will result in the Real-Time Control Center not being available to end users for a few seconds.

Inventory module settings

This section describes configuration settings for the Client Activity Record feature provided by the Inventory module.

The 1E client, while running, continuously captures details of certain activities and events as they happen, similar to Windows Task Manager or Perfmon. During startup, the 1E client is able to detect some events that occurred when it was not running. Data is regularly written into a local, compressed and encrypted persistent storage tables, that are accessible to DEXCode as SQL tables. The 1E client periodically aggregates data in order to minimize the amount of storage required, so that each capture source has a live, hourly, daily and monthly table. The whole process is designed to minimize impact on device performance, storage and security. Please refer to Client Activity Record for details of what data is captured and how to query these tables.

Other than Module.Inventory.Enabled, these Inventory module settings are not included in the template configuration file, and therefore use default values. To set any other value for these the setting must be added to the configuration file.

There are no DEXCode methods available in the inventory module for creating instructions.

Capture sources

The table below lists the capture sources supported by the Client Activity Record feature (also known as the Inventory module) and on which OS they are supported. The source name is used in each of the Capture source settings.

Source Name

Description

Windows

macOS

Linux

Solaris

ARP

ARP cache entries - the Inventory module captures the results of cached IP address to physical address resolutions

3.2

n/a

n/a

n/a

BootPerformance

Windows boot performance metrics.

8.0

n/a

n/a

n/a

DeviceInteraction

User session input metrics (keyboard and mouse activity).

5.1

n/a

n/a

n/a

DevicePerformance

Device performance metrics for device performance by interrogating Windows Performance Counters. These metrics cover disk, memory, network and processor performance.

This capture source is required by the Experience Analytics application.

5.0

n/a

n/a

n/a

DeviceResourceDemand

Disk, network, memory, and processor performance metrics.

5.1

n/a

n/a

n/a

DNS

DNS resolution queries - the Inventory module captures whenever a DNS address is resolved

2.1

2.1

n/a

n/a

OperatingSystemPerformance

Performance metrics for OS - the metrics executable runs every 4 hours by default

This capture source is required by the Experience Analytics application.

5.0

n/a

n/a

n/a

PerformanceEvent

Distinct events which may be of relevance when diagnosing performance or end-user experience issues.

5.0

n/a

n/a

n/a

Process

Process execution - the Inventory module captures whenever a process starts on the device

2.1

2.1

2.1

2.1

ProcessStabilization

The time taken for a process execution to be considered stable whenever a monitored process starts on the device

3.2

n/a

n/a

n/a

ProcessUsage

A daily summary of the launches and terminations of processes.

The Process Usage capture source is required by the 1E Powered Inventory feature (1E connector).

Note

Process Usage capture can generate high disk I/O while capturing process usage on virtual machine hosts with guests starting at the same time.

3.2

n/a

n/a

n/a

SensitiveProcess

Performance metrics for sensitive processes - the metrics executable runs every 4 hours by default

This capture source is required by the Experience Analytics application.

5.0

n/a

n/a

n/a

Software

Software installs/uninstalls/presence - the Inventory module captures whenever software is installed/uninstalled, and also captures which software is present on a device

2.1

2.1

2.1

2.1

SoftwareInteraction

Software process responsiveness and duration of active interaction.

5.1

n/a

n/a

n/a

SoftwarePerformance

Performance metrics for software - Software performance polling is every 10 seconds by default

This capture source is required by the Experience Analytics application.

Aggregated with SoftwarePerformance data:

  • SoftwarePerformance.DiskUsage - Disk related metrics for each running process

  • SoftwarePerformance.ProcessNetworkUsage - Network related metrics for each running process.

5.0

n/a

n/a

n/a

TCP

Outbound TCP connections - the Inventory module captures whenever an outbound TCP connection is made

2.1

2.1

2.1

n/a

UserUsage

A daily summary of all the logons and logoffs of users.

This capture source is required by the 1E Powered Inventory feature (1E connector).

3.2

n/a

n/a

n/a

Global capture settings

The table below lists configuration properties that affect all capture sources.

Inventory module setting

Installation default

Description

Module.Inventory.Enabled

Note

This is the only inventory setting in the template configuration file.

true

Determines whether the Client Activity Record feature is enabled or disabled.

Must be set to true or false.

Must be set to true if using the 1E Powered Inventory feature (1E connector).

If set to true, individual capture sources can be enabled or disabled by setting Module.Inventory.<source>.Enabled to true or false.

If set to false , this setting takes precedence over individual capture source settings with all being disabled.

Module.Inventory.NoEventTracing

Note

This setting does not have an equivalent Windows Installer property and is not in the template configuration file.

false

Controls whether the Inventory module will, on Windows, use a polling-based mechanism to capture data instead of event-based.

The Inventory module will use Windows operating system events to capture data, if the host operating system supports it. If this setting is true, the Inventory module will instead use a polling-based approach to capture data.

This setting is ignored on other operating systems.

Module.Inventory.AggregationIntervalSeconds

Note

This setting does not have an equivalent Windows Installer property and is not in the template configuration file.

60 (seconds)

Determines the frequency, in seconds, at which the Inventory module will write the capture buffers to the live and aggregated tables.

More frequent aggregations will make captured data available for querying sooner, at the cost of more processing on the device.

Range is 30 to 600 (10 minutes).

Capture source settings

The table below lists the 8 settings used to configure each capture source. The relevant <source> name needs to be included in each of the setting names (not case-sensitive):

ARP | BootPerformance | DeviceInteraction | DevicePerformance | DeviceResourceDemand | DNS | OperatingSystemPerformance | PerformanceEvent | Process | ProcessStabilization | ProcessUsage | SensitiveProcess | Software | SoftwareInteraction | SoftwarePerformance | TCP | UserUsage

Note

The following settings do not have an equivalent Windows Installer property and are not in the template configuration file.

Capture source setting

Installation default

Description

Module.Inventory.<source>.Enabled

Not available for capture source:

  • SoftwareInteraction

true (all sources)

Controls whether this capture source is active (true) and will capture data. To disable capture of this data, use false.

Note

Disabling the Client Activity Record feature by setting Module.Inventory.Enabled to false, takes precedence over individual capture source settings.

The Process Usage capture source is required by the 1E Powered Inventory feature (1E connector).

Note

Process Usage capture can generate high disk I/O while capturing process usage on virtual machine hosts with guests starting at the same time.

Module.Inventory.<source>.BufferSize

Not available for capture sources:

  • DevicePerformance

  • DeviceResourceDemand

  • SoftwarePerformance

1000 (all sources)

Determines the maximum number of capture entries held in memory during an aggregation period.

The Inventory module will store data in memory prior to writing it to disk (as determined by the Module.Inventory.AggregationIntervalSeconds setting described above). This setting controls the size of the capture buffer available for this data.

If this capture buffer is exceeded, older entries will be discarded to make room for newer ones.

For example, based on the default values, if more than 1000 DNS lookups occur within 60 seconds.

A higher value will allow the Inventory module can capture higher volumes of events at the cost of additional memory use.

Range is 100 to 10000.

Module.Inventory.<source>.PollIntervalSeconds

Not available for capture sources:

  • DNS

  • Process

  • ProcessStabilization

  • ProcessUsage

  • TCP

  • UserUsage

30 (all sources except Software and OperatingSystemPerformance)

120 (2 minutes for Software)

300 (5 minutes for OperatingSystemPerformance)

Determines the frequency, in seconds, at which the capture source will poll for data. This setting is ignored if the Inventory module is using an event-based mechanism to capture data.

A lower value (more frequent polls) is likely to capture more data at the cost of additional processing overhead on the device.

Range is 5 to 600 (10 minutes) for all sources except for OperatingSystemPerformance which can go up to 86400 (1 day).

Module.Inventory.<source>.AggregationsBeforeGroom

3 (all sources)

Determines the number of aggregation cycles that should occur before old data is removed (groomed) from the Inventory module’s live disk-based store. See the three Retention settings below.

The Inventory module will store captured data for a limited time before removing it. This setting determines how frequently the grooming operation will be performed. The clean-up operation happens every N aggregation cycles.

A lower value (more frequent deletion) will remove old data more quickly at the cost of additional processing overhead on the device.

Range is 1 to 50.

Module.Inventory.<source>.LiveRetention

5000 (all sources)

Determines the maximum number of capture entries that will be stored in the Inventory module’s live disk-based storage.

The Inventory module stores detailed (non-aggregate, live) capture entries on disk, as well as aggregated capture entries per hour, day and month (see below). This setting determines the limit of the detailed entries. When the limit is reached, older entries are deleted to make room for newer ones.

A higher value allows storage of a longer period of detailed entries at the cost of additional disk space on the device. Storing more data will also cause queries on that data to take longer.

Range is 100 to 50000.

Module.Inventory.<source>.HourlyRetention

24 (all sources)

Determines the maximum number of hours/days/months for which aggregated data will be kept in the Inventory module’s disk-based storage.

The Inventory module will discard data from its hourly/daily/monthly store to make room for newer data.

A higher value allows a longer record of data to kept at the cost of additional disk space on the device. Storing more data will also cause queries on that data to take longer.

Note that these settings are independent of one another – for example, it is not necessary to specify an “hourly” value of 24 or greater to be able to capture “daily” values.

A value of zero means “disable data aggregation at this resolution”. Again, since the settings are independent, it is valid to disable hourly data aggregation yet keep daily and monthly aggregation active.

Range is 0 (disabled) to 100.

Module.Inventory.<source>.DailyRetention

31 (90 days for ProcessUsage and UserUsage for 5.1 and later)

Module.Inventory.<source>.MonthlyRetention

12 (all sources)

Settings unique to specific capture sources

Note

The following settings do not have an equivalent Windows Installer property and are not in the template configuration file.

Capture source setting

Installation default

Description

Module.Inventory.ProcessStabilization.Fuzziness

5

Modifies the margins within which a process is considered stable. The default is 5, and the range is 1 to 66 inclusive. This setting should be left unchanged.

Module.Inventory.ProcessStabilization.MonitoredProcesses

This is a comma separated, case insensitive list of executable names (with extensions) of any processes that require stabilization monitoring. By default, this is not set and therefore process stabilization monitoring is disabled. The list should not exceed 15 executables.

Module.Inventory.ProcessUsage.VerboseLogging

false

Enables or disables Process Usage log messages, which typically appear for each data capture refresh. ProcessUsage is used by the 1E Powered Inventory feature.

Module.Inventory.UserUsage.VerboseLogging

false

Enables or disables User Usage log messages, which typically appear for each data capture refresh. UserUsage is used by the 1E Powered Inventory feature.