1E 23.11 (SaaS)

(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:

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

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.

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.

(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:

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

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.

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).

840 (14 minutes)

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.

900 (15 minutes)

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.

soft

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

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

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

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.

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.

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.

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.

Info

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

%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

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

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

/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:

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

The following are not configurable in this version:

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

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.

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).

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.

100000 (10⁵)

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 (10⁹). The default value is 100000 (10⁵).

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:

(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:

<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.

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.

true

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

Must be set to true or false.

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.

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.

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.

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.

false

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

false

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

This feature also requires the following:

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)

(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)

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.

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.

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.

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.

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:

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.

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.

7766

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

Port is configurable between 100 and 65535.

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.

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.

(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.

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.

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.

(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.