Built-In Macros (E-mail Macros)

These are the macros you can use as process data variable. These macros are mainly used in message templates.

Examples

Fields

NameDescription

$CONVERTDATETIME()
Description:
Changes the current date-time value to a specified time zone.
Syntax:
$CONVERTDATETIME(ConvertDateTimeInAgilePoint)
Allowed Values:
The input for the (ConvertDateTimeInAgilePoint) parameter can be one of these:
Example:
  • $CONVERTDATETIME(06/16/2017 11:30:42 AM,Eastern Standard Time (North America) changes the value to 06/16/2017 03:00:42 AM
  • $CONVERTDATETIME(${/pd:AP/pd:formFields/pd:DateTime1},Japan Standard Time (Tokyo)) changes the stored current date and time value to 6/13/2017 3:02:06 PM

$FORMATDATETIME()
Description:
Converts a date-time value to a specified date-time format.
Syntax:
$FORMATDATETIME(ValidDateTimeInAgilePoint)
Allowed Values:
The input for the (ValidDateTimeInAgilePoint) parameter can be one of these:
This macro supports these date and time formats:
  • M/d/yyyy
  • M/d/yy
  • yyyy-MM-dd
  • d-MMM-yy
  • M.d.yyyy
  • d MMMM yyyy
  • MMMM yy
  • MMM-yy
  • M/d/yyyy h:mm
  • M/d/yyyy h:mm:ss
  • h:mm
  • h:mm:ss
  • HH:mm
  • HH:mm:ss
Example:
  • $FORMATDATETIME(06/08/2017 01:30:42,yyyy/M/d hh:mm) changes the value to 2017/6/8 01:30
  • $FORMATDATETIME(${/pd:AP/pd:formFields/pd:DateTime},M/d/yyyy h:mm) changes the stored value 31/07/20017 11:00:12 to 07/31/2017 11:00

$GROUP()
Description:
Gets the members of a group.
  • When used in the To, CC, and BCC fields of an email template, this macro gets the email addresses for all the members in the group.
  • When used in the the email body of an email template, this macro shows the names of all the members of the group.
Syntax:
$GROUP(ValidGroupNameInAgilePoint)
Allowed Values:
The input for the (ValidGroupNameInAgilePoint) parameter can be one of these:
Example:
  • $GROUP(Administrators)
  • $GROUP(${/my:myFields/my:groupname)

Also refer to:

$ROLE()
Description:
Gets the users who are assigned a role.
  • When used in the To, CC, and BCC fields of an email template, this macro gets the email addresses of all the users who are assigned the role. This includes the users who are members of a group that is assigned the role.
  • When used in the the email body of an email template, this macro shows the names of all the users who are assigned the role. This includes users who are members of a group who is assigned the role.
Syntax:
$ROLE(ValidRoleNameInAgilePoint)
Allowed Values:
The input for the (ValidRoleNameInAgilePoint) parameter can be one of these:
Example:
  • $ROLE(Manager)
  • $ROLE(${/my:myFields/my:rolename})

$MANAGER()
Description:
Gets the manager for the specified user name. In other words, UserName is the subordinate.
Syntax:
$MANAGER(UserName)
Allowed Values:
The input for the subordinate UserName parameter can be one of these:
Example:
  • $MANAGER(DOMAIN\john)
  • $MANAGER(${/my:myFields/my:username})

$URLSHORTNER()
Description:
Gets the short form of a URL.

To use this macro, you must have a Bitly access token.

For more information, refer to Access tokens for Bitly.

Syntax:
$URLSHORTNER(URL)
Allowed Values:
The input for the URL parameter can be one of these:
Example:
  • $URLSHORTNER(https://myportal.com/ApplicationBuilder/eFormRender.html?Process=MyDemo)
  • $URLSHORTNER(${/pd:AP/pd:formFields})
Limitations:

$XMLREPEATING2HTML()
Description:
When used in an email template, this macro returns an HTML table that contains the repeating data from the form in the generated email notification.
Syntax:
$XMLREPEATING2HTML(XpathRepeatingSchemaElement)
Allowed Values:
The input for the (XpathRepeatingSchemaElement) parameter is an Xpath to a repeating schema element from your AgilePoint NX app. To refer to a literal XML string from an Xpath, add a tilde (~) at the end of the path.
Example:
$XMLREPEATING2HTML(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~})

Also refer to:

Common Usage:
In the body of an email template to show data from a subform.

$XMLREPEATING2HTMLWITHFILTER()
Description:
This macro formats the output in an HTML table with the specified filter criteria.

These are the filter criteria:

  • Delete specified values.
  • Change the date format.
  • Change the order of the values.
  • Change the display name of specified values.
Syntax:
$XMLREPEATING2HTMLWITHFILTER(XpathRepeatingSchemaElementWithFilter)
Allowed Values:
The input for the (XpathRepeatingSchemaElementWithFilter) parameter is an Xpath to a repeating schema element from your AgilePoint NX app.

In the input value for the (XpathRepeatingSchemaElementWithFilter) parameter, the filter criteria must be in this order:

{Delete specific values},{Change the date format},{Change the order of the values},{Change the display name of the values}

Example:
  • Delete values: $XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{TextBox3;TextBox4})
  • Change the date format: $XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{},{DateTime2,M/d/yyyyh:mm})
  • Change the order of values: $XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{},{},{TextBox2,0;TextBox1,1})
  • Change the display name of values: $XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{},{},{},{TextBox2,First Name;TextBox1,Last Name})
  • Change the date format and display name of values: $XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{},{DateTime2,M/d/yyyyh:mm},{},{TextBox2,First Name;TextBox1,Last Name})
Common Usage:
In the body of an email template to show data from a subform.
Limitations:

Support for changing the display name, order, and date format for the output value is available in these releases: