The Pega Platform contains more than 400 standard functions you can call, defined through the Function rule form. The table below lists a few often-used functions that appear in other help system topics.
Standard functions are different than the PublicAPI Java methods.
Use the Records Explorer to see a complete list of the standard and custom functions available to you.
For a list of available SQL function alias rules, see Standard SQL Function rules.
Function |
Ruleset:Library |
Purpose |
| addTime(DateTime, calendar) | Pega-RULES: DateTime |
Add an amount of business or calendar time to a DateTime |
| Base64Encode()
Base64Decode() |
Pega-RULES: Default |
Convert a value to the Base64 equivalent, or decode a Base64 value. |
| compareWorkIDs(ID1, ID2) | Pega-RULES: Sort |
Sort work item IDs including the prefix and suffix. |
|
differenceBetweenDates |
Pega-RULES: BusinessCalendar |
Calculates the integer number of calendar or business days between a first and a second DateTime value, optionally based on a calendar data instance. This is positive if the first date is later than the second date. (A day is defined as 60*60*24 seconds in this calculation.) |
| divisionExchange() | Pega-RULES: Math |
Converts a Number property representing one currency value to another Number property representing another currency using division. |
| Equals(s1, s2) | Pega-RULES: String |
Tests equality of two strings. |
| FormatDateTime() | Pega-RULES: DateTime |
Format a DateTime value based on a Java date pattern. |
| getPublicLinkURL() | Pega-ProCom: Pega-ProCom Utilities |
Obtain portions of a URL when preparing a directed Web access email. |
| getSubstitute(oper, tools) | Pega-ProCom: Routing |
Identify a substitute operator for the operator. |
| HaveRole(aTools, rolename) | Pega-RULES: Default |
True if the current operator holds the access role identified in the second parameter. |
| isBusinessDay(date, calendar) |
Pega-RULES: BusinessDate |
True if the date is a business day in the calendar identified by the second parameter. |
| isBusinessTime(datetime, calendar) |
Pega-RULES: BusinessDate |
True if the DateTime is a date and time during the workday hours of operation recorded in a calendar instance. |
| IsInPageList(LookFor, LookAt, LookIn) | Pega-RULES: Utilities |
Searches through the values in a Page List property for a match. |
| IsInPropertyList(LookFor, LookIn) | Pega-RULES: Utilities |
Search through the values in a Value List property for a match. |
| multiplyExchange() | Pega-RULES: Math |
Converts a Number property representing one currency value to another Number property representing another currency using multiplication. |
| ObtainValuePair(Myactivity, MyStepPage, Mapvaluename, Rowinputval, ColumnInputVal) | Pega-RULES: Map |
Evaluate a two-dimensional map value. |
| PageExists(pagename, activityname) | Pega-RULES: Default |
Check whether a page of a specific name already exists, in the context of an activity. |
| pickLoadBalancedWorkGroup() | Pega-ProCom: Routing |
Supports routing of assignments based on skills and workload. |
| pxAddGuardrailMessage(addToProperty, ruleMessageName, messageParameters) | Pega-WB:Default | Adds a warning to the specified rule. |