Agent Configuration

26 Sep 2023
9 Minutes to read

Print
Share
Dark
Light
PDF

Agent Configuration

Updated on 26 Sep 2023
9 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Agent.xml

The agent.xml file allows for configuration of the Liquit agent. Below you will find a complete agent.xml configuration.

The agent.xml is normally found at: C:\Program Files (x86)\Liquit Workspace\Agent\Agent.xml

Custom Server

    <Server>https://company.liquit.com/</Server>
    <CustomServer>False</CustomServer>

Element/Attribute	Description	Default
Server	This should be the FQDN on which the targeted Liquit Workspace Zone
CustomServer	When set to true at server side, the FQDN of the Liquit Workspace Server won't be automatically inserted into the agent.exe generated by the Server.	False

Register

These settings will allow the device to register itself with Liquit Workspace without requiring a user login. This allows you to manage the device without a user signed in. The user account used to register the agent only requires "Register device" privileges. When using this option, the user doesn't need the "Register device" privilege, while they can still use the agent when installed with this option.

    <Register>
        <Type>1</Type>
        <Username><![CDATA[LOCAL\wksimport]]></Username>
        <Password><![CDATA[P@ssw0rd]]></Password>
    </Register>

Element/Attribute	Description	Default
Type	0 User based registration, currently logged on user will be used to register the device with the server. 1 Use specified credentials to register this device with the server.	0
Username	When Type is set to 1, this username is used to register the device.
Password	When Type is set to 1, this password is used to register the device.

Deployments

These settings allow you to utilize deployments. Device Register settings needs to be configured with type 1 for the Deployment configuration to work.

    <Deployment>
        <Enabled>True</Enabled>
        <Start>True</Start>
        <Cancel>True</Cancel>
        <Events>False</Events>
        <Context>User</Context>
        <AutoStart>
            <Enabled>True</Enabled>
            <Timer>30</Timer>
            <Deployment>test</Deployment>
        </AutoStart>
    </Deployment>

Element/Attribute	Description	Default
Enabled	This element can be either true or false, when set to true Liquit will enable the deployment process on this machine.	False
Start	If this element is true the process of deployments is automatically started, meaning that the process will be run the first time userhost is run. When set to false, this process can be manually started by starting: shellapi.exe deployment run	True
Cancel	If this element is true the deployment process can be cancelled.	True
Events	If this element is true, the Liquit events (refresh/ login) can still be executed	False
Context	Determine the context in which the deployment should run. User: Required to login before the deployment wizard is shown, a selection can be made before starting deployment. Device: No user login is required and the deployment will automatically begin. Auto start should be enabled. The auto start timer will be ignored, the specified deployment under autostart should match a single deployment.	User

Autostart

Element/Attribute	Description	Default
Enabled	This element can be either true or false, when set to true Liquit will automatically start the deployment process; when a corresponding deployment is found as configured in the Deployment element or when only 1 deployment is available for this device	False
Timer	This element accepts an integer and represents the number of seconds Liquit will wait before automatically starting the deployment.	0
Deployment	Provide the targeted deployment in this element. This can either be the name of the deployment or the ID of the deployment

Log

The Liquit agent logs events initiated by the Liquit agent.

    <Log Id="agent">
        <Level>Debug</Level>
        <Path>Agent.log</Path>
        <RotateCount>5</RotateCount>
        <RotateSize>1048576</RotateSize>
    </Log>

Element/Attribute	Description	Default
Log/Id	The Id attribute in the Log element can be either set to agent or userhost and both should be set.
Level	This element is used to define the level of logging. Liquit distinguishes between two logging levels: None Nothing will be logged to the log file Critical only critical errors will be logged to the log file. Error Only error and critical errors will be logged to the log file. Warning Only warning, error and critical errors will be logged to the log file. Info Basic information and warning, error and critical errors will be logged to the log file. Debug Detailed information will be logged to the log file about all actions. This can assist in troubleshooting problems.	Info
Path	An alternate path for the log files can be defined by entering it in the Path value. The agent log can typically be found at the following location: %ProgramData%\Liquit Workspace\Agent\Agent.log. The userhost log can be found at the following location: %LOCALAPPDATA%\Liquit\UserHost.log.	UserHost.log / Agent.log
RotateCount	Defines the number of logfiles that will be kept on archive.	5
RotateSize	Defines the limit of logfile size in bytes, when this limit is reached a new logfile will be created and the old file will be archived.	1048576

Content

This element contains configuration for the way Liquit handles files form the content store

    <Content>
        <Hash>True</Hash>
    </Content>

Element/Attribute	Description	Default
Hash	If this element is set to true Liquit will use a hash to check if files in the content store have been changed in comparison to the local content. Unchanged files will not be downloaded.	True

This element controls the login behaviour for the Liquit agent.

    <Login>
        <Enabled>True</Enabled>
        <SSO>True</SSO>
        <IdentitySource>LIQUIT</IdentitySource>
        <Timeout>4</Timeout>
    </Login>

Element/Attribute	Description	Default
Enabled	This controls whether the user should be prompted for login	True
SSO	Accepts either True or False, when this is set to True the Liquit Agent will use the configured Identity Source to facilitate SSO.	False
IdentitySource	Defines the default identity source used to log in the user. Use the name of the identity Source as you defined it within Liquit.
Timeout	Timeout in seconds after which the Liquit login prompt will be displayed if SSO could not be performed within the timeout.	4

Icon

Controls the behaviour of the tray icon.

    <Icon>
        <Enabled>True</Enabled>
        <Exit>True</Exit>
    </Icon>

Element/Attribute	Description	Default
Enabled	Can be either true or false. If this element is set to False than the tray icon will be hidden from the user.	True
Exit	Can be either true or false. If this element is set to False the exit option on the tray icon menu will be disabled. The exit option will always be disabled if the launcher is enabled and is not allowed to close.	True

Cache

This element controls settings for Cache.

    <Cache>
        <Enabled>True</Enabled>
        <Offline>True</Offline>
        <Path>Cache</Path>
        <TempPath>Temp</TempPath>
    </Cache>

Element/Attribute	Description	Default
Enabled	When this element is set to True the local cache will persist even after the session ended.	True
Offline	When this element is set to True, offline mode will be available for the local device. When this option is disabled, packages marked offline will not be automatically downloaded and the Launcher won't switch to offline mode.	True
Path	The location on the local device where all content used by the agent is cached. Note that this path must be relative to the Liquit directory. By default, this path is configured to: %ProgramData%\Liquit Workspace\Agent\Cache	Cache
TempPath	Temp directory on the local device, used for uploading folders to the Liquit Workspace backend. On default this path is configured to: %ProgramData%\Liquit Workspace\Agent\Temp.	Temp

Native Icons

Control whether or not Liquit is allowed to influence windows icons (Start Menu/Desktop).

    <NativeIcons>
        <Enabled>True</Enabled>
        <Primary>True</Primary>
        <ProgramsPath>${Programs}\Liquit</ProgramsPath>
    </NativeIcons>

Element/Attribute	Description	Default
Enabled	Allow Liquit to push native icons to the operating system that are configured on package entitlements.	True
Primary	If this value is true only icons from the zone defined in the Server element within the agent.xml will be pushed.	True
ProgramsPath	The location where the Start Menu items will be displayed; it allows you to specify a different directory than Liquit.	`${Programs}\\Liquit`

Events

    <Events>
        <Enabled>True</Enabled>
        <Primary>False</Primary>
    </Events>

Element/Attribute	Description	Default
Enabled	Allow Liquit to execute events (refresh, login etc.)	True
Primary	If this value is true only events will be triggered in the agent (launcher).	False

Refresh

    <Refresh>
        <Manual>True</Manual>
        <Interval>3600</Interval>
    </Refresh>

Element/Attribute	Description	Default
Manual	Can be set to either true or false, this controls whether the user can refresh the workspace by manual action.	True
Interval	This value represents the time in (seconds) which the workspace will be refreshed (i.e. the latest packages are downloaded).	3600

Launcher

    <Launcher>
        <Enabled>True</Enabled>
        <State>0</State>
        <Close>True</Close>
        <Start>True</Start>
        <Minimal>False</Minimal>
        <Tiles>False</Tiles>
        <StartConnected>False</StartConnected>
        <ContextMenu>True</ContextMenu>
        <SideMenu>tags</SideMenu>
    </Launcher>

Element/Attribute	Description	Default
Enabled	If the launcher should be enabled.	True
State	Defines how the launcher will be shown on startup: 0 Default sized window 1 Minimized window 2 Maximized window	0
Close	Can be set to either True or False. Defines whether or not the launcher window can be closed.	True
Start	Launcher will automatically be started with the agent.	True
Minimal	Can be set to either True or False. When set to true Liquit Workspace will be run in minimal mode (icons only).	False
Tiles	Can be set to either True or False. When set to True Liquit will use the tile-themed skin.	False
StartConnected	When this option is enabled, Launcher or login process will be started when the Liquit Workspace server becomes available on the network after startup. Launcher will be used when Enabled and Start is set to True, Login (only) process will be started when Login\Enabled is set to True, and Launcher\Enabled is set to False. When this option is set to False (Default), Launcher and/or login process will be started at startup even when the server is possibly unavailable.	False
ContextMenu	Can be set to either True or False. When set to True the context menu will be available in Liquit.	True
SideMenu	This element controls the default selected Side Menu. The following options are available and note that they are case sensitive: filters tags teams

ResolveDNS

    <ResolveDNS>True</ResolveDNS>

If this value of this element is set to true, Liquit will use the locally configured DNS servers to resolve servers before sending out the requests.
This allows for DNS load balancing to be performed by the agent, if the local device is configured with a proxy server, requests will be seen going to an IP address instead of the DNS name.
Setting this element to false, will disable the agent from resolving DNS itself and instead let Windows or the configured Proxy server resolve the DNS. Default value is false.

ServerValidation

    <ServerValidation>True</ServerValidation>

If this value of this element is set to true, Liquit will validate the zone certificate to ensure its trusted by the local certificate store. By setting this option to false, self-signed certificates which are not trusted by the local certificate store will be accepted as well, this causes a security issue for production environments. Therefore we recommend leaving this option on its default value: true.

RestrictServers

    <RestrictServers>True</RestrictServers>

If this value of this element is set to true, this will restrict which zones are allowed to access the local agent. The zone that is specified within the Server option is always allowed to communicate with the agent. If this option is set to False, a warning will be displayed asking the user if the zone where the user navigated to is allowed to access the agent. Default value is false.

TrustedServers

    <TrustedServers>
        <Server>zone1.liquit.com</Server>
        <Server>zone2.liquit.com</Server>
        <Server>*.dev.liquit.com</Server>
    </TrustedServers>

This element allows you to add additionally trusted zones. Each zone DNS entry needs to be added within a separate Server element. Wildcards can be used within the name to trust/match multiple zones within a single domain. This option is used in combination with RestrictServers.

Was this article helpful?

What's Next

Anti-Virus recommendations

Table of contents

Agent.xml
Custom Server
Register
Deployments
Log
Content
Login
Icon
Cache
Native Icons
Events
Refresh
Launcher
ResolveDNS
ServerValidation
RestrictServers
TrustedServers