Skip to main content
Mitratech Success Center

User System Variables

System variables that return information about a user or users will have the following options:
  • AuthType: returns the method by which the user authenticates. This returns a number, 0 through 4. The numbers represent the following authentication methods:
  • 0: BuiltIn
  • 1: Windows
  • 2: LDAP
  • 3: External
  • 4: SAML
  • ShowManager: if set to 1 or True, this system variable returns the user’s manager

User system variables also have formatting options, which change the format of the data being returned. The format parameter can be set to the following:

Example

{CURR_USER,format=Name}

Format Options

  • Name: formats the system variable into a string of a user’s name
  • Userid: formats the system variable into a string of the user’s ID
  • Id: the system variable will return the ID of an object or user.
  • Guid: the system variable will return the global unique ID of an object
  • Email: formats the system variable to return a string of a user’s email
  • Domain: returns the domain a user is in
  • Picture: returns an image of a user
  • Signature: returns an image of the user’s signature
  • Custom_String: returns the custom string stored in the User’s table entry
  • Custom_Number: returns the custom number stored in the User’s table entry
  • Custom_Date: returns the custom date stored in the User’s table entry
  • Culture: returns the user’s culture
  • Culture_String: returns the user’s culture string
  • BusinessUnit: Returns the Business Unit specified in Active Directory.
  • LegalEntity: Returns the Legal Entity specified in Active Directory.
  • NUM_LOGINS: Returns the number of times the given user has logged in.
  • LAST_LOGIN: Returns the data and time of the specified user's last login.

When comparing User system variables, it is important to make sure that you are comparing the same kinds of values. Ensure that the format options for all the User system variables in a comparison are the same, or else you may end up with an unexpected result.

Active Directory Fields

If users are created on Process Director through synchronization with active directory, certain Active Directory data can be received by Process Director using the following formatting options:

  • Phone: returns the user’s phone number
  • Office: returns the value of the user’s Office active directory field
  • Title: returns the user’s title
  • Department: returns the name of the user’s department
  • Description: returns the Active Directory description of the User
  • Company: returns the name of the company to which the user belongs

The following example demonstrates how a user system variable tag can be formatted to return the User ID:

{CURR_USER, format=Userid}

Current User

image

Returns - This system variable returns information about the user currently viewing the eForm.

SysVar Tag -{CURR_USER}

Optional Parameters

The result of this system variable can be formatted using the standard user variable format options.

Group

image

Returns - This system variable allows the user to specify a group to be used in comparisons. Information about a group can be gathered via SysVar tags by referencing a group picker form field.

SysVar Tag -{FORM:someGroupPicker}

Optional Parameters

The result of a group picker reference can be formatted according to the options available to form field system variables.

Group Users

Returns - This system variable returns a comma-separated list of users that belong to a specified group. If no optional formatting paramaters are used, the default return format will be the actual name of the user.

SysVar Tag -{GROUP_USERS:someGroupName | somGID, format=userid | guid | id | name}

Example:

{GROUP_USERS:admin, format=userid}

Parameters

GroupName: The group name for the group from which the users should be returned. OR

GID: The Group ID for the group from which the users should be returned.

Optional Parameters

Format: Specifies the type of return value to be received. Possible options are:

  • ID: The unique identifier for the users in the group.
  • UID: The unique identified for the users in the group.
  • userid: The Process Director usernames for the users in the group.
  • name: The actual names of the users in the group.

User

image

Returns - This option allows the user to specify a user to be used for comparisons. This is technically not a system variable, but information about a user can be gathered via SysVar tags by referencing a user picker.

SysVar Tag -{FORM:someUserPicker}

Optional Parameters

The result of this SysVar tag can be formatted according to what options are available to form field system variables.

  • Was this article helpful?