Welcome > Data module > Server variables > Create a server variable

Create a server variable

Create server variables in the same manner as process variables. See Create process variables for more information.

  1. On the Home page, click Data > Server Variables.

    TotalAgility provides some server variables. To get the list of server variables, on the Category Filter list, select System Category. You can edit and delete the server variables except Limited_User_Session_ID and SPP_System_Session_ID.

  2. To create a new server variable:
    1. Consume the Category in which to place your server variable. The default is the working category for the current user.
    2. Enter a unique Name for the variable, for example, COMPANY_NAME.

      By default, the name of the variable becomes the ID of the variable; however, you can change the ID if needed.

    3. On the Type list, select the data type for the variable.
    4. Select, enter or configure a Value for the variable.
    5. Click Add Add.
  3. Click Close Close View.

Configuring a secure server variable

You can protect the server variables of type string and nullable string so that values (for example, passwords) are not human readable and can be stored as encrypted values. However, these values can be decrypted as needed within Kofax TotalAgility.

  1. On the Home page, click Data > Server Variables.
  2. To create a secure server variable:
    1. Consume the Category in which to place your server variable. (Default: Working Category)
    2. Enter a unique Name, such as COMPANY_NAME, for the variable.

      By default, the name of the variable becomes the ID of the variable; however, you can change it.

    3. On the Type list, select the data type to be String or Nullable String.
      The Secure option is enabled.
    4. Select a Value.
    5. Click Yes for Secure. (Default: No)
    6. Click Add Add.
      The server variable value is stored in the database as an encrypted value.

      Note the following:

      • When creating or editing an encrypted server variable, the value is initially visible; on reloading the variable, this value is hidden.

      • Toggling a server variable between secure and non-secure clears the value. A message is displayed to inform you the same. To confirm that you wish to proceed, click Yes on the message.

      • When you use an encrypted server variable in an automatic activity, at runtime, the value is decrypted.

      • Do not use a secure server variable as input or output to a manual activity.

  3. Click Close Close View.