Entitlement Scripts

Prev Next

Entitlement scripts are used to define the app shortcuts and related actions in an Entitlement. The three types are:

  • App Shortcut. Defines the name, description, URL and icon color for the app shortcut that will be displayed in the Client.

  • Host. Defines a resolvable name or IP address. If resource names are returned, then later the name resolver will resolve these to IP addresses.

  • Port or Type. Defines one or more port numbers or ICMP types.

Before you start

Background reading:

  • See the Use of Scripts section for more considerations and information.

  • If using Host scripts, ensure the Site is configured to resolve the syntax that the script will generate.

  • Get a better understanding of defining hosts, including how and why you would use these scripts.

Configuring Entitlement Scripts

To configure a script, in the Entitlement Scripts page, select +Add and select the type of script. Then complete the following fields:

  • Name. Enter a name with only lowercase alphanumeric characters with underscore or dash. When creating Actions in Entitlements, the script(s) for Host and Port will be referred to with the syntax script://<name>.

NOTE

If you are editing an existing script, changing the name may break existing Entitlements.

  • Expression. An example expression is provided - typically the script should return same information used when creating an Entitlement manually.

Entitlement Script Actions

While in the Add or Edit Entitlement Script page, use the Actions button to perform the following actions:

  • Clone. Clone the Entitlement script.

  • Test. Tests the script. Opens the Test Expression window. From here you can enter values to simulate claims or switch to active session mode and use an active session to test the claims.