Agent Configuration

Agent.json

The agent.json file allows for configuration of the Liquit Universal Agent.

The path to the agent.json location is:

Below you will find a sample of an agent.json configuration.

{
	"zone": "https://workspace.liquit.com",

	"registration": {
		"type": "Certificate"
	},

	"login": {
		"sso": true
	},

	"log": {
		"level": "Debug"
	}
}

Zone

This should be the URL with the FQDN where the targeted Liquit Workspace Zone is reachable.

{
    "zone": "https://company.liquit.com/"
}

Prompt Zone

This key controls the display of the Zone Prompt dialog box where the user can configure the zone URL. The value entered in the dialog box is saved in the zone key.
This feature works only if there is no URL configured in the zone key.

Available options:

• Disabled: User is NOT prompted to enter the zone URL, even if it is not configured
• Show: User is prompted to enter the zone URL, if none is configured. This is the default value of the key.

{
    "promptZone": "Show"
}

Registration

Registration is the method to create a device in the Liquit Workspace zone. Registration is in general an action that only needs to be performed once per device. After successful registration, the device will get a “Liquit Agent Authentication certificate” that is tight to the device object in the Liquit Workspace. The “Liquit Agent Authentication certificate” is used for the device to log in to the Liquit Workspace.

For a detailed description of Device Registration options within Liquit Workspace UI, see Device Registration.

Below are described the 4 ways in which you can register a device within the Liquit Workspace.
These methods are applicable for devices running the Liquit Universal Agent.

User Account registration type

For this method, the user account can be LOCAL or Microsoft Entra ID (Azure AD).

1. Install the Liquit Universal Agent.
2. Modify the Agent.json file as in the following example:

{ 
    "registration": { 
        "type": "User" 
    } 
} 

3. Log into the Liquit Workspace and navigate to Manage > System > Access policies.
4. Assign the user an access policy that has the Register device privilege. By default, the predefined User access policy is granted this permission.

When the user logs in for the first time into the Liquit Workspace, his device is automatically registered.

Agent Credentials registration type

1. Install the Liquit Universal Agent.
2. Modify the Agent.json file as in the following example:

{ 
    "registration": { 
        "type": "Credentials", 
        "username": "local\\wksimport", 
        "password": "P@ssw0rd" 
    } 
} 

3. Log into the Liquit Workspace and navigate to Manage > Identities > Users.
4. Create a user with the LOCAL identity source. For example, "username": "local\wksimport" and "password": "P@ssw0rd"
5. Assign the user an access policy that has the Register device privilege. By default, the predefined User access policy has this permission granted.

The specified credentials will be used to register the device.

Agent Certificate registration type

1. First choose one of the following three ways in which you want to proceed with the registration:

a. Place the certificate in the certificate repository of the Windows/Mac operating system on the device/user profile, install the Liquit Universal Agent and then modify the Agent.json file as in the following example:

{ 
    "registration": { 
        "type": "Certificate" 
    } 
} 

b. Place the certificate in the device certificate store, install the Liquit Universal Agent and then specify the certificateThumbprint in the Agent.json file as in the following example:

{ 
    "registration": { 
        "type": "Certificate", 
        "certificateThumbprint": "69f4db57b74e13415cd103323331d95022d840c1" 
    } 
} 

c. Place the certificate in the device certificate store, install the Liquit Universal Agent, and then specify the certificateIssuer in the Agent.json file.

2. Log into the Liquit Workspace and navigate to Manage > System > Device registration.
3. Create a Certificate type registration.
4. Create or upload a certificate with a private key

Agent Certificate Enrollment registration type

1. First choose one of the following two ways in which you want to proceed with the registration:

a. Place the enrolled certificate which must have a private key on the device/user profile, install the Liquit Universal Agent and then specify the certificateThumbprint in the Agent.json file.

b. Place the enrolled certificate which must have a private key on the device/user profile, install the Liquit Universal Agent and then specify the certificateIssuer in the Agent.json file as in the following example:

{ 
    "registration": {  
        "type": "CertificateEnrollment", 
        "certificateIssuer": "Sectigo RSA Domain Validation Secure Server CA" 
    } 
}  

2. Log into the Liquit Workspace and navigate to Manage > System > Device registration.
3. Create a Certificate enrollment type registration.
4. Select an intermediate certificate or the root CA in a certificate chain. It does not need a private key.
5. (Optional) You can specify an OID, for example, to limit the number of valid certificates.

Keys

Deployments

{
    "deployment": {
        "enabled": false,
        "start": true,
        "context": "Device",
        "cancel": true,
        "triggers": false,
        "autoStart": {
            "enabled": false,
            "deployment": null,
            "timer": 0
        }
    }
}

Autostart

Log

The Liquit Universal Agent logs events it initiates.

{
    "log": {
        "level": "Debug",
        "agentPath": "Agent.log",
        "userHostPath":"UserHost.log",
        "rotateCount": 5,
        "rotateSize": 1048576
    }
}

Login

This element controls the login behaviour for the Liquit Universal Agent.

{
    "login": {
        "enabled": true,
        "sso": true,
        "identitySource": "LIQUIT",
        "timeout": 4
    }
}

Icon

Controls the behaviour of the system tray icon.

{
    "icon": {
        "enabled": true,
        "exit": true,
        "timeout": 30
    }
}

Cache

This element controls the settings of the cache.

{
    "cache": {
        "enabled": true,
        "offline": true,
        "path": "Cache",
        "tempPath": "Temp",
        "packageTempPath": "${TEMP}",
        "autoClean": true, 
        "expireContent": 90
    }
}

Native Icons

Modify the behaviour of the native icons configured for package entitlements that allow you to display Liquit icons on certain locations within the device's operating system.

{
    "nativeIcons": {
        "enabled": true,
        "primary": true,
        "startMenuPath": "${Programs}\\Liquit"
    }
}

Triggers

Modify the behaviour of the events configured for package entitlements.

{
    "triggers": {
        "enabled": true,
        "primary": true
    }
}

Refresh

Modify the behaviour of the agent refresh process.

{
    "refresh": {
        "manual": true,
        "interval": 3600
    }
}

Launcher

{
    "launcher": {
        "enabled": true,
        "state": "Default",
        "start": "Auto",
        "tiles": false,
        "minimal": false,
        "contextMenu": true,
        "sideMenu": "Tags",
        "close": true
    }
}

Restrict Zones

Define which Liquit Zones are always allowed to communicate with the local Agent.

{
    "restrictZones": false
}

If set to true, only the zones you list will have access to the local Agent. If set to false, a warning will be displayed asking the user if the zone where he wants to navigate is allowed to access the agent. The default value is false.

Trusted Zones

Here you can add additionally trusted zones.

{
    "trustedZones": [
        "zone1.liquit.com",
        "zone2.liquit.com",
        "*.dev.liquit.com"
    ]
}

Events

Configure how event data is uploaded to server when the Agent triggers the event.

{ 
     "events": { 
         "enabled": true, 
         "interval": 30 
     } 
} 

Web Socket

This protocol allows a more efficient way of handling data. This option is mandatory for the push event feature described in the Events section.

{
	"webSocket": {
		"enabled": true
	}
}

Further reading

For a detailed description of Device Registration options within Liquit Workspace UI, see Device Registration.