System Macros

Alloy Navigator provides a number of pre-defined system macros that can be used as standard building blocks for e-mail notifications, pop-up messages, workflow items, and user macros. For the list of system macros, see the table below.

System macros are available in the System Macros and Job Settings categories of the Select Placeholder dialog.

INFO: For details, see Inserting Placeholders.

System macro Inserted dynamic value
Action ID

The ID of the current Action or Trigger.

When the current Action or Trigger was triggered by another Action or On Condition Trigger, the macro inserts the ID of that initial Action or On Condition Trigger (compare with WF Item ID).

This auto-generated ID uniquely identifies each workflow item. When you open its details window, you can see this value on the General tab, in the ID field. In addition, the ID column is available in the grid view for workflow items (for example, in Workflow and Business Logic > Service Desk > Incidents > Workflow > Actions > Create).

Action Name

The name of the current Action or Trigger.

When the current Action or Trigger was triggered by another Action or On Condition Trigger, the macro inserts the name of that initial Action or On Condition Trigger (compare with WF Item Name).

API Link

The URL address of Alloy Navigator API. This macro inserts the value specified on the "Workflow Integration" page of the Web Configuration tool for the API module.

Use this macro to build direct link to objects in E-mail Notifications.

For details, see Installation Guide: Customizing the API Link Macro.

Current User The Full Name of the current person or Service Name of the current service (e.g. Automation Server, Mail Connector).
Current User > Field

The specified field from the current user’s Person record. For example:

%[SYS Current User.Full_Name]%

Initiator

The Alloy Navigator module the workflow Action/Trigger is initiated from.

Valid values include:

  • Active Directory Import
  • Settings
  • Alloy Discovery Connector
  • API
  • Data Archiving
  • Mail Connector
  • Desktop App
  • Mobile App
  • Recurrent Ticket Agent
  • Reporting Service
  • Scheduled Trigger Agent
  • Self Service Portal
  • Web App
Initiator > Client IP Address

The IP address of the computer the workflow Action/Trigger is initiated from.

  • When initiated from a portal (the Web App, Mobile App, or Self Service Portal) or API module, the placeholder inserts the IP address of the client computer accessing the web server.

  • When initiated from any other Alloy Navigator module, the placeholder inserts the same value as Initiator > Host IP Address.

Initiator > Client Locale

The locale used by the person identified by Initiator > Name.

  • For Self Service Portal customers, the placeholder inserts the interface language specified on the “Profile” page.

  • For any other Alloy Navigator module, where users cannot change their interface language, the placeholder always inserts English (United States).

Initiator > Client Workstation

The name of the computer the workflow Action/Trigger is initiated from.

Initiator > Database The name of the Alloy Navigator database.
Initiator > Host IP Address

The IP address of the computer hosting the Alloy Navigator module the workflow Action/Trigger is initiated from.

  • When initiated from a portal (the Web App, Mobile App, or Self Service Portal) or API module, the placeholder inserts the IP address of the web server.

  • When initiated from any other Alloy Navigator module, the placeholder inserts the same value as
    Initiator > Client IP Address.

Initiator > Host Name

The name of the computer hosting the Alloy Navigator module the workflow Action/Trigger is initiated from.

  • When initiated from a portal (the Web App, Mobile App, Self Service Portal) or the API Module, the placeholder inserts the name of the web server.

  • When initiated from any other Alloy Navigator module, the placeholder inserts the same value as Initiator > Client Workstation.

Initiator > Host Site

The URL of the portal.

  • When initiated from a portal (the Web App, Mobile App, Self Service Portal) or the API Module, the placeholder inserts the URL of the portal.

  • When initiated from any other Alloy Navigator module, the placeholder does not insert any value.

Initiator > Interactive
  • TRUE when the workflow Action/Trigger is initiated by a user (interactively)

  • FALSE when the workflow Action/Trigger is initiated by a service (non-interactively)

Initiator -> Login The user name (login) of the Alloy Navigator account under which a person or a service initiated the workflow Action/Trigger.
Initiator > Name The Full Name of the person or Service Name of the service that initiated the workflow Action/Trigger.
Initiator > SQL Server The name or network address of the SQL Server instance hosting the Alloy Navigator database.
Initiator > Type

The Alloy Navigator module the workflow Action/Trigger is initiated from. (Same as Initiator.)

Initiator > Use Windows Authentication

The authentication type for the Alloy Navigator account under which a person or a service initiated the workflow Action/Trigger:

  • TRUE when the user uses Windows authentication

  • FALSE when the user uses SQL Server authentication

NOTE: If you use this macro for accessing the Alloy Navigator database, FALSE value requires specifying the user name (login) and password, when TRUE value uses the current user's Windows account credentials.

License

Information about the product license.

License > Serial Number

The product serial number.

License > Language

The product language.

License > Expiration Date

The license expiration date.

License > User

The user name.

License > Organization

The organization name.

License > Audit Nodes

The maximum number of audit nodes.

License > Named Users

The maximum number of named technician accounts.

License > Concurrent Users

The maximum number of concurrent connected technicians.

License > SQL Server

The SQL Server instance name.

Notification ID

The ID of the current E-mail Notification.

This auto-generated ID uniquely identifies each E-mail Notification. When you open the notification details window, you can see this value on the General tab, in the ID field. In addition, the ID column is available in the grid view for E-mail Notifications (for example, in Workflow and Business Logic > Service Desk > Incidents > Workflow > Components > E-mail Notifications).

MessageID Tag

The identification tag, which is used to extract the object ID from threaded messages.

In contrast to other system macros, you can customize this macro. For details, see Customizing the MessageID Tag.

Now

The current date and time. Depending on usage context, the value of this system macro may vary:

  • When used in SQL expressions, this macro inserts the current date and time on the computer hosting the SQL Server where your Alloy Navigator database resides.

  • When used in text (e.g. in E-mail Notifications), this macro inserts the current date and time on the computer where the corresponding workflow Action/Trigger is initiated (i.e. the computer running the Desktop App, Automation Server, Web App, or Self Service Portal).

Object Changes All

The list of object fields that were modified when the object was updated. Each line in the generated list describes the changes of a single field and contains the field name, old value, and the new value.

Inserted text usually consists of several lines.

When the modified field is a memo or HTML field (for example, the Description Ticket's field) and its length exceeds 256 symbols, the macro will return a 256-symbol-long snippet of the field containing the modified fragment.

Object Changes End User

The list of all Incident’s fields available in the Self Service Portal that were modified when the Incident was updated and the corresponding workflow Action/Trigger was executed. The list contains field names with their original and new values.

Inserted text usually consists of several lines.

When the modified field is a memo or HTML field (for example, the Description Ticket's field) and its length exceeds 256 symbols, the macro will return a 256-symbol-long snippet of the field containing the modified fragment.

Self Service Portal Link

The URL of the Self Service Portal. This macro inserts the value specified on the "Workflow Integration" page of the Web Configuration tool for the Self Service Portal.

Use this macro to build direct link to objects in E-mail Notifications.

For details, see Installation Guide: Customizing the Self Service Portal Link Macro.

System Settings > Plain Text Email

Indicates whether the e-mail notification is sent in plain text format.

  • TRUE when the check box is selected.

  • FALSE when the check box is clear.

If TRUE, the e-mail notification is sent in plain text.

This macro is the attribute of the notifications settings. You select the check box Send all e-mail messages in plain text format when configuring outgoing e-mail notifications. For details, see Configuring the Notifications Settings.

Use this macro in conditional workflow operations. For details, see Building Conditional Statements.

Today

The current date. Depending on usage context, the value of this system macro may vary:

  • When used in SQL expressions, this macro inserts the current date on the computer hosting the SQL Server where your Alloy Navigator database resides.

  • When used in text (e.g. in E-mail Notifications), this macro inserts the current date on the computer where the corresponding workflow Action/Trigger is initiated (i.e. the computer running the Desktop App, Automation Server, Web App, Mobile App, or Self Service Portal).

WF Item ID

The ID of the current Action or Trigger.

This value differs from Action ID when the current Action or Trigger was triggered by another Action or On Condition Trigger: Action ID inserts the ID of the initial Action or Trigger, while WF Item ID inserts the ID of the actual workflow Action or Trigger.

This auto-generated ID uniquely identifies each workflow item. When you open its details window, you can see this value on the General tab, in the ID field. In addition, the ID column is available in the grid view for workflow items (for example, in Workflow and Business Logic > Service Desk > Incidents > Workflow > Components > Functions).

WF Item Name

The name of the current Action or Trigger.

This value differs from Action Name when the current Action or Trigger was triggered by another Action or On Condition Trigger: Action Name inserts the name of the initial Action or Trigger, while WF Item Name inserts the name of the actual workflow Action or Trigger.

Web Portal Link

The URL of the portal. This macro inserts the value specified on the "Workflow Integration" page of the Web Configuration tool for the Web App.

Use this macro to build direct link to objects in E-mail Notifications.

For details, see Installation Guide: Customizing the Web App Link Macro.

System macros from the Job Settings category of the Select Placeholder dialog are the attributes of the Active Directory and Alloy Discovery synchronization jobs. You select the attributes when configuring the job. For details, see Configuring Active Directory Synchronization Jobs and Configuring Alloy Discovery Synchronization.

  • TRUE when the check box is selected.
  • FALSE when the check box is clear.

These macros are used in conditional workflow operations of the Service Actions that the job employs. If TRUE, the Service Action performs a corresponding workflow Function to create the items for new or updated Person records. You can also use these macros in custom-built conditional statements for Active Directory and Alloy Discovery synchronization jobs. For details, see Building Conditional Statements.

System macro Inserted dynamic value
Job Settings.Create SSP Accounts Indicates whether the Active Directory Synchronization job can create SSP Customer Accounts.
Job Settings.Create Locations Indicates whether the Active Directory or Alloy Discovery synchronization job can create Locations.
Job Settings.Create Organizations Indicates whether the Active Directory or Alloy Discovery synchronization job can create Organizations.