› Capture › Extraction groups › Fields › Macros for devices

Macros for devices

If you are using devices with TotalAgility, the following macros are available for retrieving information from jobs and inserting them as values.

Macro values should be passed to the MFP client as the default value for fields in the device form. This can be an initialized process variable, folder, or document field. When an MFP client detects a field with a macro, it replaces it with the actual value.

Macro

Description

{Current Date}

Gets the current date depending on the TimeZone setting:

  • If the TimeZone is set to 0, use UTC.

  • If the TimeZone is set to 1, use the local time on the server.

Also, configure the setting in Devices by changing datetimemacro.timezone in the kfs.properties namespace.

{Current Time}

Gets the current time depending on the TimeZone setting:

  • If the TimeZone is set to 0, use UTC.

  • If the TimeZone is set to 1, use the local time on the server.

Also, configure the setting in Devices by changing datetimemacro.timezone in the kfs.properties namespace.

{Current User Name}

Gets the name of the user logged on to the current session. If this information is not available, the name is obtained from the user session record in the database.

{Current User Email}

Gets the e-mail address of the user logged on to the current session. If this information is not available, the e-mail address is obtained from the user session record in the database.

{DeviceProfile:<fieldname>}

<Fieldname> is the name of the Custom Metadata field. This macro populates the field with the value defined in the Device Profile Custom Metadata tab.

{Scan Time}

Gets the time the scan job was generated. If the scan job was created from a shortcut, it indicates the time the shortcut was opened. Otherwise, it indicates the time when the scan job was manually created.

{Scan Operator ID}

Gets the ID of the user logged on to the current session. If this information is not available, the ID is obtained from the user session record in the database.

{Scan Station ID}

Gets the fully qualified domain name of the remote client.

{Scan Station Language}

Gets the name of the language of the remote client: English, French, German, Italian, Brazilian Portuguese, or Spanish.