Agent.json File Configuration

Agent.json file location

By default, the Agent.json file is placed in the Agent folder after an installation:

Sample of an agent.json configuration

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

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

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

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

Configure a Zone

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

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

For instructions on moving an agent from one zone to another, see Migrate an Application Workspace Agent to a Different Zone.

For steps to configure a custom domain, see Set Up a Custom Domain for a Zone.

Prompt Zone

This key controls the display of the Zone Prompt window 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"
}

Register a Device in a Zone

Registration creates a device in the Application Workspace zone. Typically, you will only need to complete the registration once per device. After successful registration, the device will get a Liquit Agent Authentication certificate that is tied to the device object in the Application Workspace. The device will then log into the Workspace using the certificate.

For a detailed description of registration options within Application Workspace, see Device Registration.

There are four methods to register a device within the Application Workspace. All methods apply to devices running the Application Workspace Agent.

User Account registration

For this registration method, the user account can be LOCAL or Microsoft Entra ID.

To register the device using the user account:

1. Install the Application Workspace Agent.

2. Modify the Agent.json file as in the following example:

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

3. Log into the Application 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 grants this permission.

When the user logs in for the first time to the Application Workspace, the device is automatically registered.

Agent Credentials registration

To register the device using agent credentials:

1. Install the Application Workspace 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 Application 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 grants this permission.

The specified credentials will be used to register the device.

Agent Certificate registration

1. Choose one of three ways to complete the registration:

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

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

• Place the certificate in the device certificate store, install the Application Workspace Agent and then specify the certificateThumbprint in the Agent.json file as in the following example:

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

• Place the certificate in the device certificate store, install the Application Workspace Agent,  and then specify the certificateIssuer in the Agent.json file.

2. Log into the Application 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

1. Choose one of two ways to complete the registration:

• Place the enrolled certificate which must have a private key on the device/user profile, install the Application Workspace Agent and then specify the certificateThumbprint in the Agent.json file.
• Place the enrolled certificate which must have a private key on the device/user profile, install the Application Workspace 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 Application 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) Specify an OID, for example, to limit the number of valid certificates.

Keys

Define which Zones are always allowed to communicate with the local Agent. By default, the value is set to 'false' and communication to the local Agent is not restricted to defined zones.

{
    "restrictZones": false
}

If set to 'true', only the zones you list will have access to the local Agent. 

If set to 'false', an alert asks the user to confirm that the zone is allowed to access the local Agent.

You can add additional trusted zones.

Example

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

Options for configuring deployments for Application Workspace Agent.

{
   "deployment": {
            "zoneTimeout": 60,
            "enabled": false,
            "start": true,
            "context": "User",
            "cancel": false,
            "triggers": true,
            "autoStart": {
                  "enabled": true,
                  "deployment": "RRO Retry deployment",
                  "timer": 10
        }
    }
}

Autostart

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

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

The Application Workspace Agent logs events it initiates.

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

This element controls the login behaviour for the Application Workspace Agent.

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

These options control system tray icon behaviour.

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

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"
    }
}

Options that control Application Workspace Launcher behaviour.

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

These options control cache settings.

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

Settings that control agent refresh process behaviour.

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

Choose a startup mode based on whether and how the Application Workspace Launcher should be visible when it's started by the ShellAPI at device startup or user login.

Example

{
  "launcher": {
    "enabled": true,
    "start": "Disabled",
    "close": true
  },
  "userHostStartupOperatingMode": "Hidden",
  "zone": "https://company.liquit.com/"
}

Options for modifying the behaviour of events configured for package entitlements.

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

This protocol allows a more efficient way of handling data. This option is mandatory for the push event feature described in the Events section. By default, web sockets are enabled, with the value set to 'true'.

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