Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      


Updated on August 10, 2022

This book contains reference topics for rules in Pega Platform.

  • About Connect BPEL rules
  • About Connect Robot rules

    Connect Robot is a Pega-supplied rule that you can use to import automation packages from Pega Robotic Studio into your Pega Platform development environment. When you use the Connect Robot rule, you can use robotic desktop automations as data sources for data pages.

  • About Calendar data instances

    Use this data class to define the business days and holidays for an organization. Calendar data instances can be referenced in organization, work queue, and Operator ID data instances, and in service-level agreements.

  • Divisions

    A division is the second-level element of your organization. You can identify rulesets and versions that all members of that division are allowed to access.

  • Organization data instances

    Complete an organization data instance for each organization that uses your system. Use the Organization form to specify an access group available to all members of an organization, a calendar of work days and holidays, a top-level class, and other aspects of the organization.

  • Organization Unit data instances

    A three-level organization structure is supported. The top level is known as the organization; the middle level as divisions, and the lowest level as units. Each user (Operator ID instance) is associated with an organization, division, and unit. Use this form to specify the organizational units that report to the divisions previously defined.

  • Summary views

    Use the Summary View rule form to define a custom or personal query. This rule generates HTML that provides an interactive display or chart.

  • OAuth 1.0 clients

    The OAuth standard framework enables secure, delegated access to services over HTTPS. OAuth provides tokens (sometimes called "valet keys") that provide access to your data that is hosted by a specific service provider. Each token grants access to a specific site for specific resources, for a defined period of time. A later version of this protocol, OAuth 2.0, uses a different data instance type.

  • Web Service Security profile

    Use a Web Service Security profile (WS-Security) to determine how to authenticate a web service message.

  • Flow markers

    A flow marker saves test data and decisions that advance a flow execution to a specific point (mark). It allows you to jump directly to a specific point in the flow rule without having to input the same information every time to reach that point. In automated unit testing runs, the flow markers are used to advance the execution of a flow to that point.

  • About SpellChecker Properties data instances

    Use the SpellChecker Properties form to control operation of the spelling checker features of the Pega Platform, for a specific locale (language variant).

  • Word templates

    A Word template incorporates Microsoft Word documents (of .doc or .docx file format) into your application, for use during correspondence generation and Word merge with Microsoft Silverlight. The DOC files can incorporate Word features such as images, styles, macros, and formulas.

  • Service Java rules

    Using the Java Business Delegate pattern and the Java Session Facade pattern, the Java service interface makes service rules available to external, Java-based applications as if the service rules were public methods of a Java class.

  • Service JSR94 rules

    Java Specification Request 94 (JSR 94) describes an Application Programming Interface (API) for rules engines defined by the Java Community Process (JCP). The JSR 94 integration interface makes Pega Platform processing available to external Java applications through JSR 94 invocations to JSR94 service rules.

  • Service MQ rules

    Use a package of Service MQ rules to let external systems and users access the Pega Platform data and processing using the IBM WebSphere MQ middleware messaging standard. Each Service MQ rule identifies an activity providing the service. The external system passes an MQ message to the Pega Platform, which runs the activity and then may return an output MQ message.

  • Creating an SMS account

    You can use short message service (SMS) accounts for sending a one-time password for multifactor authentication.

  • Creating a web service policy data instance

    Create a web service policy (WS-Policy) data instance to allow a SOAP connector to securely communicate with an annotated web service.

  • How to call through Java-based services

    How to call Pega Platform through Java-based services

  • Registry Java Property Transform data instances - Completing the Save As form

    A Registry Java Property Transform has a single key part, the Java class name.

  • About Broadcast data instances

    Create a broadcast data instance to define the text of short messages, also known as welcome messages, news messages, or messages-of-the-day. These messages appear in the navigation panel of User portals when the Dashboard is open.

  • Circumstance definitions

    A circumstance is an optional qualification available for supported rule types and is built upon the base rule.

  • Circumstance templates

    Use a circumstance template rule to identify properties for multivariate circumstanced rules. A circumstance template rule contains an array of properties such as .State, .Channel, and .ClaimAmount that reference property values in one or more circumstance definition rules. These rules define the value combinations for each of the properties defined in the circumstance template rule.

  • Function rule

    A Function rule defines a Java method that is accessed through rule resolution. By using rule resolution at run time, a function can express different behavior depending on the application ruleset list. You can invoke functions from expressions, from activities, and from Java.

  • Function Alias rules

    A function alias rule has one of two types: Java function or SQL expression.

  • Library rules

    A library rule is a container for a set of related function rules (the Rule-Utility-Function rule type). Create a library rule to hold custom functions for your application, which can supplant and extend standard functions.

  • Messages

    A message is dynamic text that communicates errors, warnings, or other types of information to users. By using messages instead of static text in your user interface, you can provide contextual assistance to users that supports localization.

  • Property aliases

    A property alias provides an alternative name for a property in a function alias that is more meaningful to business users.

  • Property Qualifier rules

    A property qualifier rule can supplement information in a property with additional capabilities or restrictions. Property qualifier rules are referenced in a property in the Property Qualifiers section of the property's Advanced tab.

  • About Static Content Bundle rules

    Static content bundle rules define a group of JavaScript files or Cascading Style Sheet (CSS) files, identified as text file rules, that the server transmits to workstation browsers as a single unit or "bundle". Used appropriately, static content bundles can reduce HTTP network traffic and reduce user response times.

  • Text File rules

    Use a text file rule to hold and identify static HTML, XML, Cascading Style Sheet, DHTML, and JavaScript script files used in an application. This rule provides the security, inheritance versioning, and deployment benefits of rule resolution to the file. (A static file in this context is one that does not change each time it is served. The contents of static files may differ from RuleSet version to RuleSet version, and may be updated after a Rule-File- rule is updated.)

  • Defining URL patterns for work items

    Share your work items with users of the same application by defining URL patterns for the work items in your application, for example, cases, reports, landing pages, or other work items, such as sitemap.xml. Simple, meaningful URLs make collaboration more efficient for users. For example, they can bookmark a case for quick access, and then send a direct link to the case to other users.

  • Creating a function

    You can create a function to run Java code that you define. By putting your logic in a reusable function, you can reduce the amount of custom code in your application.

  • Function Alias rules — Completing the Create, Save As, or Specialization form

    Records can be created in various ways. You can add a new record to your application or copy an existing one. You can specialize existing rules by creating a copy in a specific ruleset, against a different class or (in some cases) with a set of circumstance definitions. You can copy data instances but they do not support specialization because they are not versioned.

  • About Image Content data instances

    Image Content instances provide an alternative to binary file rules, to store images that:

  • Integration Connectors landing page

    Access the Integration Connectors landing page by clicking Configure Integration Connectors .

  • Integration Services landing page

    The Integration Services landing page helps you create and review services in your application. Access it by selecting the Configure Integration Services menu item. Click the Service Wizard button to launch the Service Wizard.

  • Connected apps landing page

    You can establish a connection between your application and a service provider for automated cases processing using the Connected apps landing page. For example, you can use Box to store attachments for inbound and outbound automated email processing. The applications listed on the Connected apps landing page use OAuth 2.0 and have a grant type of authorization code.

  • About Collection rules

    Use a collection to model business logic and implement common rule engine patterns. Collections define an ordered sequence of rules, the conditions under which they execute, and postprocessing steps known as response actions. The business-friendly options on this form help you to quickly develop flexible solutions that are easily understood by various audiences.

  • About Connect Cassandra rules

    Connect Cassandra rules support interactions between Pega Platform and Apache Cassandra data stores by performing reading and writing operations on a single row identified by the unique row ID.

  • About Connect CMIS rules

    Use a Connect CMIS rule to define a connection to an enterprise content management (ECM) system repository that supports the OASIS CMIS standard.

  • About EJB connector rules

    Use Connect EJB rules to define and configure a connector to an Enterprise JavaBean on a local or remote system. The services are deployed as Enterprise JavaBeans (EJBs) within a Java Enterprise Edition (Java EE) application server, such as IBM's WebSphere or Oracle WebLogic.

  • About Connect HBase rules

    Connect HBase rules support interactions between Pega Platform and Apache HBase data stores by performing reading and writing operations on a single row identified by the unique row ID.

  • About Connect Java rules

    Use a Connect Java rule to define a connector interface between your application and an external Java application or a Java class.

  • About Connect SQL rules

    Use Connect SQL rules when your application needs to run complex Structured Query Language statements such as joins or stored procedures to update or extract information from an external database.

  • Atom Servers
  • Connect Request Processor data instances

    Define a Connect Request Processor data instance to support an asynchronous HTTP connector or SOAP connector. This data instance defines the queuing and dequeing options for the connector.

  • SMS accounts

    You can use short message service (SMS) accounts for sending a one-time password for multifactor authentication.

  • About SOAP Server data instances
  • Web service policy data instances

    SOAP connectors can use web service policy data instances to securely communicate with a web service policy (WS-Policy) annotated web service. A WS-Policy annotated web service exposes its security policy by embedding a WS-Policy element in the WSDL. The WS-Policy contains a set of assertions that represent the capabilities and requirements of a web service. The SOAP connector can understand these assertions and apply necessary security to the payload accordingly.

  • Map eForm rules

    The SmartForms capability enables your applications to work with PDF files. Your application can extract field data from incoming PDF forms and can generate PDF forms and documents.

  • About Parse Normalize rules

    Parse normalize rules operate on a text string and perform string substitutions, to produce a normalized output text string. Normalization can replace multiple variants of a word or other text with a uniform, normalized value. Such normalization can make later operations on the normalized string simpler or faster.

  • Converting from directives to JavaServer Pages tags

    Pega Platform provides automated conversion facilities that translate most directives into equivalent JavaServer Pages (JSP) tags. Use of JSP tags rather than directives is recommended for new applications and upgraded older applications. Use of JSP tags is required for applications which are to be localized.

  • Toggling features on and off

    To enable or disable features for testing or to control which users have access to a feature, use feature toggles. You can also migrate a toggle to other applications by changing the associated ruleset.

  • Class Management landing page

    On the Class Management landing page, you can generate the module version report for a single node (current or remote) or for the whole cluster. The report lists the classes in the system with the module version. You can use this report to debug discrepancies in the system.

  • List rules

    A list rule identifies a set of properties that are to be included in a clipboard page assembled by the Obj-List method. This rule also supports simple tabular reporting (involving no calculations or sorting) and the Data Table editor.

  • About Edit Validate rules

    Use the Edit Validate form to define a Java routine that tests the validity of an input value in an activity that processes user input. The activity calls the Property-Validate method, which applies the test defined in an Edit Validate rule.

  • Properties

    A property provides a name and characteristics for data in an object. Because a property definition is a rule, it shares the benefits of versioning, inheritance, and access control that the Pega Platform provides to all rules.

  • JavaServer Pages tags

    JavaServer Pages tags can appear in all rule types derived from the Rule-Stream class.

  • Fields that support the Global Resource Settings syntax

    The following table lists fields that support the Global Resource Settings syntax (= PageName.PropertyName ) for references to external systems, and the default properties that are associated with those fields. You can refer to properties that you have created rather than the default properties.

  • Integration-Connectors category

    The rule types in the Integration Connectors category support connector interfaces between Pega Platform and external systems.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us