Built-In Macros (E-mail Macros)

$CONVERTDATETIME()

Function:

Changes the current date-time value to a specified time zone.

Syntax:

$CONVERTDATETIME(ConvertDateTimeInAgilePoint)

Accepted Values:

The input for the (ConvertDateTimeInAgilePoint) parameter can be one of these:

• A literal date-time value.
• An Xpath to a process data variable from your app.

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()

Function:

Converts a date-time value to a specified date-time format.

Syntax:

$FORMATDATETIME(ValidDateTimeInAgilePoint)

Accepted Values:

The input for the (ValidDateTimeInAgilePoint) parameter can be one of these:

• A literal date-time value.
• An Xpath to a process data variable from your app.

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()

Function:

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)

Accepted Values:

The input for the (ValidGroupNameInAgilePoint) parameter can be one of these:

• A literal group name.
• An Xpath to a process data variable from your app.

Example:

• $GROUP(Administrators)
• $GROUP(${/my:myFields/my:groupname)

Also refer to:

• (Example) Create Zoom Meeting

$ROLE()

Function:

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)

Accepted Values:

The input for the (ValidRoleNameInAgilePoint) parameter can be one of these:

• A literal role name.
• An Xpath to a process data variable from your app.

Example:

• $ROLE(Manager)
• $ROLE(${/my:myFields/my:rolename})

$MANAGER()

Function:

Gets the manager for the specified user name. In other words, UserName is the subordinate.

Syntax:

$MANAGER(UserName)

Accepted Values:

The input for the subordinate UserName parameter can be one of these:

• A literal AgilePoint NX user name.
• An Xpath to a process data variable from your app.

Example:

• $MANAGER(DOMAIN\john)
• $MANAGER(${/my:myFields/my:username})

$URLSHORTNER()

Function:

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)

Accepted Values:

The input for the URL parameter can be one of these:

• A literal URL address.
• An Xpath to a process data variable from your app.

Example:

• $URLSHORTNER(https://myportal.com/ApplicationBuilder/eFormRender.html?Process=MyDemo)
• $URLSHORTNER(${/pd:AP/pd:formFields})

Limitations:

• AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 or higher.

$XMLREPEATING2HTML()

Function:

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)

Accepted 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:

• (Example) Show a Subform in an E-mail Notification

Common Usage:

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

$XMLREPEATING2HTMLWITHFILTER()

Function:

This macro formats the output in an HTML table, with the specified values removed.

Syntax:

$XMLREPEATING2HTMLWITHFILTER(XpathRepeatingSchemaElementWithFilter)

Accepted Values:

This macro accepts as a parameter an Xpath expression for the location of a schema element from your app.

Example:

$XMLREPEATING2HTMLWITHFILTER(${/pd:AP/pd:formFields/pd:SubForm1_SubForm~},{TextBox3;TextBox4},{DateTime2,M/d/yyyy h:mm})

Common Usage:

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