Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Summary

Excerpt

Installer and configuration settings for 1E Client which affect all client features and modules.


Info

Installer properties:

Multiexcerpt
MultiExcerptNameInstaller properties

Table of Contents
maxLevel5
minLevel4
absoluteUrltrue
exclude1E Client log.*
typeflat
separatorpipe



Info

Configuration file settings:

Multiexcerpt
MultiExcerptNameConfigurationFileSettings
Table of Contents
maxLevel5
minLevel5
absoluteUrltrue
exclude1E Client log
typeflat
separatorpipe


Please refer to the following pages when deploying 1E Client.

Children Display
depth1
pageInstalling 1e client

Multiexcerpt include
MultiExcerptNameManageSettings
PageWithExcerpt1E Client configuration settings and installer properties


Advanced Panelboxes for Confluence
id1
titleOn this page:

Table of Contents
maxLevel3
minLevel2
indent20px
excludeSummary|On this page|In this section...
separatornewline


1E Client settings

Multiexcerpt
MultiExcerptNameCase-AnySettings


Note


Multiexcerpt
MultiExcerptNameCase-InstallerProperties

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.


Multiexcerpt
MultiExcerptNameCase-FileRegistry

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.


Multiexcerpt
MultiExcerptNameNumericValues

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




SettingDefaultDescription
DataRoot
%ALLUSERSPROFILE%\1E\Client

Sets the root directory under which the Client will create the DBs and Persist subfolders and hence the locations of the databases and persistent storage within the local file system. If the specified directory doesn't exist it will be created. Local System (SYSTEM) requires at least modify rights on the directory. If the specified directory is invalid, or cannot be used, the 1E Client will log an error and refuse to start. For example if the directory name is a file, non-existent volume, or SYSTEM does not have permission .

If not specified, the default is the %ALLUSERSPROFILE%\1E\Client directory. This is also the default location of client log files, which are not affected by this setting. The location and name of the 1E Client log file is determined by the LogPath setting. Please refer to Log files for details of other client log files.

Multiexcerpt include
MultiExcerptNameNotesWindowsLocation
PageWithExcerptLog files

Note

This setting is for Windows only. It is ignored on non-Windows platforms, without warnings or errors logged.

Do not use this setting unless required, for example if security software unavoidably conflicts with 1E Client.


INSTALLDIR

%ProgramFiles%\1E\Client


Multiexcerpt
MultiExcerptNameINSTALLDIR

Sets the installation folder.

This value is not stored in the 1E Client configuration file.

This value is stored as InstallationDirectory in the Windows registry under HKLM\SOFTWARE\1E\Client\ and must not be changed.

Some client modules that run on Windows store their registry settings under their own keys in HKLM\SOFTWARE\1E.

Note

This installer property is for Windows only.



LogPath

1E Client logs on Windows

%ALLUSERSPROFILE%\1E\Client\1E.Client.log

Multiexcerpt include
MultiExcerptName1EClientNonWindowsLogFiles
PageWithExcerptLog files

Multiexcerpt include
MultiExcerptName1EClientLogPath
PageWithExcerptLog files

Multiexcerpt include
MultiExcerptNameNotes1EClientLogConfig
PageWithExcerptLog files

Multiexcerpt include
MultiExcerptNameNotesWindowsLocation
PageWithExcerptLog files

The LogPath setting is not used by Nomad, PXE Everywhere, and WakeUp client modules. For a fresh install they use their defaults, and for upgrades they re-use what is in their registry. In each case these can be over-ridden by installer properties described in Nomad client settingsPXE Everywhere Agent settings, and WakeUp client settings. Shopping WSA also has its own configuration file. Please refer to Log files for more details.

TemporaryDirectory
(none)


Multiexcerpt
MultiExcerptNameTemporaryDirectory

The TemporaryDirectory setting is stored in the 1E.Client.Conf file specifying the directory path below which the 1E Client and its subprocesses will create temporary files and subdirectories.

Panel
borderColor#EEEEBB
bgColor#FFFFFB
borderWidth1
borderStylesolid

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@932beffb
MultiExcerptNameDefaultsTemporaryDirectory
PageWithExcerptTCNSDK:HttpGetFile


Tip

Using this setting to specify a non-default value is only necessary if the OS default location is not suitable. For example, some security software forbids scripts being run from certain locations. Or you want to simplify configuration of Windows anti-virus and malware software to the same location as 1E logfiles.

The specified directory:

  • Must be an absolute path appropriate for the OS
  • Must already exist - it will not be created
  • Must be writable by the 1E Client (SYSTEM on Windows, root on Linux)

If any of these criteria is not satisfied then the 1E Client and subprocess falls back to using the default temporary directory.

If the value is validated successfully then environment variables are set so that subprocesses inherit the same temporary directory.

Warning
The path can only contain ASCII characters but that is not validated. Unicode characters are not supported.


Info

The 1E Client itself creates a subdirectory under the specified path called 1e.client  which it uses for its own temporary files and directories.

Subprocesses invoked by the 1E Client, such as commands, PowerShell scripts, etc. create their temporary files directly under the specified path.


Info
This setting was introduced in a v5.0 hotfix.