You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Content
Search Results
Loading, please wait ...
Getting started for
experienced
development teams
Creating applications
Setting your application password
Application types
Application rules
Configuring applications for reuse
Switching between applications
Implementation methodologies
Configuring advanced settings for new applications
Setting up your environment
Creating a team
Adding a secondary manager to a team
Defining areas of expertise for a team
Deleting a team
Setting your work availability
Changing your password
Configuring your dashboard
Changing your dashboard layout
Adding a widget to your dashboard
Dashboard widgets
Sharing a dashboard with your team
Enabling dashboard personalization for a portal
Setting your user preferences
Integrating Agile Workbench with Pega Agile Studio
Changing your workspace
Workspaces
Adding the My Applications gadget
Setting the default landing page to My Applications
Switching between work pools
Sizing an application development project
Project sizing
Developing an application
Low-code application development
Getting started with low-code application development
Exploring application
App Studio
overview
Dev Studio
overview
Admin Studio
overview
Changing your workspace
Exploring application-editing mode
Building your first application
Creating applications
Inviting collaborators to your application
Setting your application password
Configuring applications for reuse
Configuring advanced settings for new applications
Switching between applications
Adding built-on applications
Improving your compliance score
Analyzing a compliance score
Resolving an application warning
Justifying an application warning
Reviewing user interface components
Sharing your compliance score with stakeholders
Exporting compliance data
Scheduling a compliance report
Monitoring project compliance
Compliance score logic
Basic requirements for deploying public-facing applications
Restricting access to operator information in Pega 8.5
Restricting access to operator information in public-facing applications in Pega Platform 8.4 and earlier
Understanding project roles and personas
Operators (users)
Creating an operator ID
Defining operator contact information and application access
Defining operator work groups, work queues, and schedules
Defining security information for an operator
Deleting operators
Learning about access groups
Viewing access groups and operators
Creating an access group
Assigning work pools to an access group
Work pools and access groups
Granting portal access to an access group
Configuring tools access
Viewing tools authorizations in all access groups
Viewing tools authorization for a single access group
Editing tools authorization for a single access group
Creating a team
Adding a secondary manager to a team
Defining areas of expertise for a team
Deleting a team
Adding work queues to a team
Collaborating on cases
Collaborating with users by using Pulse
Adding the Pulse gadget to your application
Enabling users to post messages in the activity feed
Creating feed sources for activity feeds
Adding feed sources to activity feeds
Determining default feed sources
Configuring Pulse for case types
Configuring display of Pulse messages
Choosing a context for Pulse messages
Posting a message in Pulse
Replying to a message in Pulse
Configuring Pulse email notifications
Configuring an email account for Pulse notifications
Enabling users to respond to Pulse email notifications
Configuring Pulse notifications on additional email accounts
Enhancing a message in Pulse
Formatting a message in Pulse
Uploading an attachment in Pulse
Adding links to a message in Pulse
Adding a reference in Pulse
Restricting case references in Pulse
Differentiating case references in Pulse
Tagging an existing message in Pulse
Tagging a new message in Pulse
Managing Pulse messages
Viewing your activity feed
Bookmarking a message in Pulse
Removing a bookmark in Pulse
Following messages from a specific user
Unfollowing messages from a specific user
Deleting a message in Pulse
Creating a task in Pulse
Collaborating with users by using spaces
Creating a space
Joining a space
Communicating with members of a space
Pinning content to a space
Editing a pin in a space
Deleting a pin from a space
Managing a space
Updating details of a space
Managing members of a space
Updating the owner of a space
Adding content to a space
Discussing content in a space by using Pulse
Creating a subspace
Monitoring and tracking tasks
Granting Super Admin privileges to users
Searching for Pulse messages in spaces
Collaborating on shared content by using documents
Creating a document in an application
Discussing a document
Creating a
Microjourney
for customer success
Application update scenarios for the
Pega Express methodology
Adding case types to organize work
Creating a top-level case type
Creating a primary stage
Adding a sequential process to a stage
Adding single steps to processes
Adding personas to organize users
Creating personas
Associating personas with case types
Associating personas with channels
Granting personas access to channels and pages
Inviting collaborators to your application
Creating personas with developer portal access
Adding data objects to organize data
Associating data objects with case types
Implementing draft data objects
Associating attachment categories with case types
Managing application inventory
Adding features to application inventory
The
Microjourney
in the
Pega Express methodology
- frequently asked questions
Designing applications for reuse and extension
Rules in
Pega Platform
applications
Creating a rule
Copying a rule or data instance
Organizing rules
Organizing rules into rulesets
Creating rulesets
Creating a ruleset and a ruleset version
Configuring ruleset version settings
Copying rulesets
Creating branch rulesets
About the Ruleset Maintenance wizard
RuleSet Maintenance wizard step 1
RuleSet Maintenance wizard step 2
RuleSet Maintenance wizard step 3
RuleSet Maintenance — Locked Rules
RuleSet Maintenance — Checked-Out Rules
Defining the security of a ruleset
Categorizing a ruleset
Deleting a ruleset
Organizing rules into classes
Understanding class layers
Understanding class hierarchy and inheritance
Understanding external classes
Creating classes
Class keys
General tab on the Class form
Locking tab on the Class form
Advanced tab on the Class form
External Mapping tab on the Class form
About the Rename a Class wizard
About the Delete a Class wizard
Using the Delete a Class wizard - Step 1: Select Class to Delete
Using the Delete a Class wizard - Step 2: Display Classes to Delete
Using the Delete a Class wizard - Step 3: Display Results
Using the Delete a Class wizard - Step 4: Display References
Using the Delete a Class wizard - Step 5: Display References
Deleting a rule
Restrictions on deleting rules
Recovering a deleted rule
Rule resolution
Ruleset list layers
Ruleset list usage during rule resolution
Viewing your application ruleset list
Using pattern inheritance for rule resolution
Changing the scope of rules
Moving rules
Setting rule status and availability
Troubleshooting final rules
Troubleshooting blocked rules
Extension points
Creating a specialized or circumstance rule
Creating a circumstance template
Circumstance templates
Creating a circumstance definition
Circumstance rule examples
Circumstance definitions
Creating a redirected rule
Redirected rule
Base rules
Finding rules by circumstance
Specializing a case type
Defining the input parameters of a rule
Prompting users for parameter values
Defining the pages and classes of a rule
Page names and reserved pages
Skim to create a higher version
Adding a custom field
Checking out a rule
Standard rule checkout
Private checkout
Performing a private edit
Checking out a rule to a branch
Viewing your checkouts and accessing bulk actions
Discarding checked out rules in bulk
Opening checkouts in bulk
Rule checkout notes
Rule checkout tips
Personal ruleset
Checking in a rule
Configuring the rule check-in approval process
Rule check-in process
Checking in rules in bulk
Restoring the earlier state of a rule
Rule restoration
Finding deprecated rules in sections
Exploring rules in your application
Finding rules by type
Finding rules by class
Finding rules by name
Finding rules by dependency
Finding rules by custom field
Selecting a rule in the Find Rules by Custom Field wizard
Find Rules by Custom Field Wizard - Step 2
Find Rules by Custom Field Wizard - Step 3
Find Rules by Custom Field Wizard - Step 4
Comparing rules by version
Comparing rules by system
Using the Rulebase Compare wizard — Step 1: Enter System Info
Using the Rulebase Compare wizard — Step 2: Select Instances
Using the Rulebase Compare wizard - Step 3: Display Summary
Using the Rulebase Compare wizard — Step 4: Display Report
Bookmarking a rule
Searching for a rule
Reporting on rules
Viewing the heat map
Viewing and running inventory reports
Reviewing exposed properties
Viewing rule history
Viewing rule versions
Viewing the generated Java of a rule
Viewing the XML of a rule
Delegating a rule or data type
Delegating a data type
Rule and data type delegation
Prerequisites for delegating a rule or data type
Best practices for delegating a rule or data type
Modifying a delegated record or data type
Configuring ruleset update behavior
Importing the legacy ruleset from the Resource Kit
Referencing properties
Configuring page, page group, and page list properties
Branches and branch rulesets
Configuring an application to use branches and branch rulesets
Adding branches to your application
Creating branches
Rule development in branches
Developing branches with libraries and functions
Adding system branches
Branch operations
Setting branch development preferences
Viewing branch quality and branch contents
Understanding branch quality metrics
Reordering branches
Locking a branch
Packaging a branch
Removing a branch from an application
Deleting a branch from the system
Branch reviews
Creating a branch review
Modifying a branch review
Deleting a branch review
Closing a branch review
Reopening a branch review
Reviewing branches
Merging branches into target rulesets
Conflicts and warnings in the Merge Branches wizard
Conflicts in the Merge Branches wizard
Resolving conflicts in the Merge Branches wizard
Addressing warnings in the Merge Branches wizard
Merge branches customization
Unit testing individual rules
Unit testing UI rules
Unit testing a harness
Unit testing a section
Unit testing data model rules
Unit testing a data page
Data page testing
Unit testing a data transform
Viewing test cases for a data type
Unit testing decision rules
Unit testing a decision table
Debugging decision tables with the Tracer
Unit testing a decision tree
Debugging decision trees with the Tracer
Unit testing a when rule
Debugging when rules with the Tracer
Unit testing a map value
Unit testing a collection
Unit testing a declare expression
Unit testing event strategies
Unit testing process rules
Unit testing a flow action
Unit testing a flow
Unit testing report rules
Unit testing a report definition
Unit testing technical rules
Unit testing an activity
Clipboard contents created from activity unit tests
Testing an activity in context
Unit testing parse rules
Unit testing a Parse Delimited rule
Unit testing a Parse XML rule
Unit testing a Parse Structured rule
Unit testing service rules
Unit testing a Service EJB rule
Unit testing a Service Email rule
Unit testing a Service File rule
Unit testing a Service HTTP rule
Unit testing a Service Java rule
Unit testing a Service JMS rule
Unit testing a Service JSR 94 rule
Unit testing a Service dotNet rule
Unit testing a Service MQ rule
Unit testing a Service SAP Rule
Unit testing a Service SAPJCo rule
Unit testing a Service SOAP rule
Viewing clipboard pages created by unit testing a rule
Understanding continuous integration and delivery pipelines
Adding a branch from a repository
Publishing a branch to a repository
Understanding rule rebasing
Configuring settings for rebasing
Adding a Pega repository
Enabling the Pega repository type
Enabling ruleset versions for Pega repositories for rebasing
Rebasing rules to obtain latest versions
Managing relevant records and components
Adding a relevant record to your application
Managing relevant records
Marking records as relevant records
Securing relevant records
Understanding relevant records
Installing components
Components
Enabling components
Creating a component
Documenting a component
Packaging a component
Shared ruleset
Disabling components
Calculating values and making decisions
Data transforms
Data Transforms - Completing the Create, Save As, or Specialization form
Configuring a data transform
Data transform actions for Clipboard
Data transform actions for JSON
Data Transform form - Append and Map to action
Data Transform form - Append to action
Data Transform form - Apply Data Transform action
Data Transform form - Auto-map action
Data Transform form - For Each Page In and Exit For Each actions
Data Transform form - Remove action
Data Transform form - Set action
Data Transform form - Sort action
Data Transform form - Update Page action
Data Transform form - When, Otherwise, and Otherwise When actions
Configuring the JSON data transforms settings column on the Data Transform form
Data Transform form - Completing the Pages & Classes tab
Adding data transform to a process
Standard Data Transforms
More about data transforms
Unit testing a data transform
About Decision tables
Creating decision tables
Completing the Pages & Classes tab
Completing the Results tab
Completing the Table tab
More about Decision Tables
About Decision Trees
Creating decision trees
Completing the Decision tab (Advanced format)
Completing the Decision tab (Basic format)
Completing the Pages & Classes tab
Completing the Configuration tab
More about Decision Trees
Configuring property evaluation in a decision tree
About Map Values
Map Values
Completing the Matrix tab
Completing the Configuration tab
Completing the Pages & Classes tab
More about Map Values
Configuring rows and columns in a map value
Unit testing a map value
When Condition rules
Creating a When rule
Defining conditions for a When rule
Editing a When rule in the legacy mode
Configuring advanced options of a When rule
Specifying pages and classes of a When rule
More about When Condition rules
Calculating or validating values automatically
About Constraints rules
Constraints rules -
Constraints form - Completing the Constraints tab
Constraints form - Completing the Pages & Classes tab
More about Constraints rules
About Declare Expression rules
Declare Expression form - Completing the Change Tracking tab
Supported and unsupported configurations in simplified declare expressions
Declare Expressions form - Completing the Expressions tab
Declare Expression rules - Completing the New or Save As form
Declare Expression form - Completing the Pages & Classes tab
More about Declare Expression rules
Viewing the declarative network
Testing rules in the Declarative Network Viewer
About Declare OnChange rules
Declare OnChange rules -
Declare OnChange form - Completing the OnChange Properties tab
Declare OnChange form - Completing the Pages & Classes tab
More about Declare OnChange rules
How to implement business exception processing with policy overrides
Declare Trigger rules
Creating Declare Trigger rules
Declare Trigger form - Completing the Pages & Classes tab
More about Declare Trigger rules
Defining conditions in the condition builder
Creating an activity
Steps tab on the Activity form
Activity form - Completing the Steps tab - Entering Method parameters
Activity form - Completing the Steps tab - Entering preconditions
Defining step transitions in an activity
Repeating steps in an activity
Calling an automation from an activity
Best practices for writing activities for background jobs
Security tab on the Activity form
Defining the local variables for an activity
Activity form - how to create activities for flows
Intelligent routing
Creating a toggle
Reviewing and editing toggles
Optimizing application load time
Rerunning a preflight optimization
Checking results and JavaScript file dependencies
Improve application loading time with preflight optimization
Engaging with stakeholders to define a
Microjourney
Adopting feature-driven development
Feature order
Creating features
Creating subfeatures
Managing application features
Reviewing application features
Changing feature levels
Requesting feature enhancements
Creating bugs to report feature defects
Triaging a feedback item
Associating rules with features
Associating a feature with a work item
Skimming features to the latest version
Deleting a feature
Estimating application development
Tracking feature-driven development
Implementation methodologies
Integrating Agile Workbench with Pega Agile Studio
Creating stories
Creating stories in bulk
Populating story templates
Importing story templates
Finding a feature ID
Troubleshooting errors with a story template
Exporting stories
Setting your current work item
Changing statuses of work items
Collaborating with development teams
Integrating Agile Workbench with Jira in
Pega Platform
from 8.3.x
Integrating Agile Workbench with Jira in
Pega Platform
8.1.x to 8.2.x
Integrating Agile Workbench with Jira in
Pega Platform
7.3.x to 7.4.x
Documenting your application
Contents of application overview and data model documents
Creating project documents for stakeholders
Changing the style of a project document
Changing the structure of a project document
Creating a guide for end users
Adding a chapter to an application guide
Adding a task to a chapter in an application guide
Adding supporting information to an application guide
Linking a URL to an application guide
Linking a rule or data instance to an application guide
Calling a guided tour from an application guide
Calling a wizard from an application guide
Linking a help topic to an application guide
Linking a landing page to an application guide
Linking a custom section to an application guide
Adding an application guide to a portal
Describing features to end users
Creating content for a guided tour
Associating content with a feature in a guided tour
Integrating a guided tour with your application
Creating guidance for developers
Adding usage information to a rule
Adding historical information to a rule
Troubleshooting tools and techniques
Troubleshooting newly created rules
Troubleshooting long-lived clipboard pages
Finding the class of a rule
Application debugging using the Tracer tool
Tracer best practices
Duplicate trace error
Configuring trace conditions
Configuring Tracer settings
Tracer events to trace
Tracer event types to trace
Rulesets to trace
Reducing Tracer event output
Setting the number of lines to display in Tracer
Adjusting the buffer size of the Tracer header
Tracer event queue overflows
Sending Tracer output to a file
Setting breakpoints in the Tracer tool
Setting watch variables in the Tracer tool
Selecting a session to trace
Tracing and capturing events
Tracing services
Cluster-wide tracing of service rules
Viewing Tracer results in the Tracer window
Tracer results window
Clipboard tool
Using the Clipboard tool
Setting property values with the clipboard
Adding a user page to the Clipboard
Measuring clipboard size
Indirect pages
Log files tool
Viewing logs
Downloading log files
Viewing log files in an external log viewer
Log levels for log categories
Creating log categories
Renaming Pega logs
Rolling a log file
Log file appenders
Displaying node type in the log
My Alerts display
Parsing the alert log
Suppressing sensitive data in alerts
Summarizing the alert log
Alerts
Alert format
Viewing and resolving errors
Viewing in-progress and completed wizards
Creating connector simulators
Testing regular expressions
The DateTime parse tester tool
About the bulk Revalidate and Save tool
Validation tool
Using the Revalidate and Save tool
Application Structure landing page
RuleSet Stack tab
RuleSet Prerequisites tab
Referencing Applications tab
Access Groups & Users tab
Other Applications tab
Testing applications in the DevOps pipeline
Analyzing application quality metrics
Viewing application quality metrics
Application quality metrics
Changing application quality metrics settings
Estimating test coverage
Generating a user-level test coverage report
Generating an application-level test coverage report
Participating in an application-level test coverage session
Generating a merged coverage report
Viewing test coverage reports
Setting up for test automation
Creating a test ruleset to store test cases
PegaUnit testing
Understanding unit test cases
Creating unit test cases for rules
Creating unit test cases for flows and case types
Creating unit test cases for rules
Configuring activity status assertions
Configuring assigned to assertions
Configuring attachment exists assertions
Attachment exists assertions
Configuring case instance count assertions
Configuring case status assertions
Configuring decision result assertions
Configuring expected run-time assertions
Configuring list assertions
Configuring page assertions
Page assertions
Configuring property assertions
Configuring result count assertions
Opening a unit test case
Viewing test case results
Running a unit test case
Exporting a list of test cases
Grouping test cases into suites
Creating unit test suites
Opening a unit test suite
Running a unit test suite
Viewing unit test suite run results
Adding cases to a test suite
Viewing unit test suite run results
Setting up and cleaning the context for a test case or test suite
Setting up your test environment
Copying and creating clipboard pages in setup
Adding additional clipboard data
Simulating data pages and third-party connections
Cleaning up your test environment
Test environment cleanup
Viewing unit test reports
Viewing unit tests without rules
Managing unit tests and test suites
Running test cases and suites with the Execute Tests service
Request parameters
Response
Configuring your default access group
Configuring your build environment
Running tests and verifying results
Test failures
Understanding Pega Platform 7.2.2 and later behavior when switching between Pega unit testing and Automated Unit Testing features
Working with the deprecated AUT tool
Creating test cases with AUT
AUT test cases
AUT test cases
Creating unit test suites with AUT
AUT test suite – Create or Save as form
AUT test suite – Contents form
UI testing
Testing with Selenium starter kit for CRM
Creating UI-based tests with scenario testing
Creating scenario tests
Opening a scenario test case
Delaying scenario test execution
Automatically rerunning failed scenario tests
Viewing scenario test results
Grouping scenario tests into suites
Creating scenario test suites
Running scenario test suites
Viewing scenario test suite results
Application: Scenario testing landing page
Case management
Introduction to case management
Identifying case types elements
Understanding case hierarchy
Identifying people involved in case types
Building case types
Providing data for cases
Understanding and complying with case management best practices
Automating work by creating case types
Case types
Creating a top-level case type
Creating a child case type
Case life cycle elements
Stages in a case life cycle
The Create stage
Adding the Create stage to existing case types
Technical considerations for the Create stage in existing case types
Creating a primary stage
Creating an alternate stage
Defining the entrance criteria for a stage
Reviewing required attachments for stage entry
Validating field values for stage entry
Configuring a case resolution
Defining conditions for skipping a stage
Removing a stage
Processes in a case life cycle
Adding a sequential process to a stage
Adding a parallel process to a stage
Adding a multistep form to a stage
Defining conditions for starting a process
Conditionally starting a process in complex scenarios
Conditionally starting a process by using a
when
condition
Conditionally starting a process by using an expression
Removing a process from a stage
Draft mode of case processes
Steps in a case life cycle
Learning about step types
Adding single steps to processes
Collecting information from a user
Adding instructions to assignments
Requesting approval from users
Learning about approval by email
Requesting approval by email and push notification
Configuring cascading approvals
Configuring approvals with an authority matrix
Adding a preconfigured step to a process
Attaching content to a case
Attaching screen captures to a case
Creating contextual cases
Collecting digital signatures in a case
Finding duplicate cases
Searching duplicate cases
Defining basic conditions for case types
Defining a threshold with weighted conditions for a case type
Restrictions on properties used in duplicate tracking
Generating case documents
Case documents tags
Case documents specifications
Case documents error messages
Activities for integrating cases with Excel documents
Tags for generating .docx documents through APIs
Moving a case to a different stage
Pausing and resuming processes in cases
Persisting temporary cases
Posting messages to a case
Preloading a data page
Running a background process
Running a survey in a case
Sending event notifications from cases
Sending automatic emails from cases
Sending push notifications from cases
Saving data in a data page as part of a flow
Updating case information
Configuring a data model for a case
Validating case data
Views for cases
Configuring dynamic views
Skipping forms to collect information before case processing
Building forms for case types
Adding single-value fields to forms
Adding data relationships to forms and data models
Adding tables to forms
Reusing fields on forms
Reusing forms
Validating field values on a form
Configuring case type settings
Configuring general case type settings
Customizing the case icon
Changing the case ID format
Tracking case workers based on geolocation data
Disabling geolocation tracking
Enabling search by third-party search engines
Sharing data between parent and child cases
Aggregating data in a parent case
Propagating data to a child case
Configuring case creation
Enabling automatic creation of child cases
Enabling automatic conditional creation of child cases
Enabling creation by email of top-level cases
Creating a case by using an API
Defining case participants
Notifying participants about events
Sending email notifications from cases
Sending push notifications about case events
Sending confirmations of completed assignments
Sending custom notifications about new assignments
Disabling assignment notifications
Enabling field-level auditing
Packaging rules and data that contain field-level auditing information
Managing concurrent access to a case
Overriding the locking strategy of a child case
Enabling offline support for case types
Enabling offline packaging optimization during synchronization
Disabling server-side postprocessing in offline cases
Enabling offline case attachments support
Creating temporary cases
Configuring Pulse for case types
Configuring external storage options for attachments
Configuring complex processes
Creating a stand-alone process
Flow shapes
Types of processes (flows)
Shape icons in a flow
Assignment shapes in flows
Annotating a flow
Keyboard shortcuts for flows
Changing the path of a process
Adding decisions to processes
Types of decision logic
Changing the decision logic in a flow
Adding a conditional path to a flow
Adding a conditional path to an assignment
Adding a results-based path to a flow
Adding asynchronous processing to a flow
Responding to business exceptions in a flow
Policy overrides and suspended work items
Subprocesses
Changing the context of a subprocess
Calling one process from another process
Managing case types
Importing a case type
Renaming case types
Deleting case types
Customizing the Get Next Work logic
Changing case statuses
Defining a custom case status
Standard rules and extension points for case status
Creating work
Creating cases
Transferring an assignment
Reopening a resolved case
Bulk processing
Creating cases in bulk
Updating cases in bulk
Running flow actions in bulk
Troubleshooting errors in bulk processing
Tagging a case
Enabling case tags
Creating suggested tags for cases
Completing work on time
Learning about service-level agreements
Urgency
Setting goals and deadlines for case resolution
Setting goals and deadlines for stages, processes, and steps
Setting goals and deadlines on the Service-level agreement form
Creating a service-level agreement rule
Defining an escalation action for a case
Defining an escalation action for a stage and a process
Defining an escalation action for an incomplete assignment
Managing work across your team
Configuring teams
Creating a team
Creating a work queue
Adding a secondary manager to a team
Defining areas of expertise for a team
Deleting a team
Inviting collaborators to your application
Configuring your dashboard
Changing your dashboard layout
Adding a widget to your dashboard
Sharing a dashboard with your team
Assigning tasks to users
Assigning users automatically at run time
Configuring business logic-based routing APIs
Adding custom routing options in business logic-based routing
Modifying lists of operators and work queues for business logic-based routing assignments
Configuring custom routing logic for assignments
Following a case
Managing case followers
Configuring intelligent email routing
Selecting the routing processing mode
Adding a routing condition based on email header content
Adding a routing condition based on NLP text analysis
Adding a routing condition based on a when rule
Testing email routing conditions
Switching between applications
Adding the My Applications gadget
Setting the default landing page to My Applications
Engaging and notifying stakeholders
Creating a notification
Defining a notification message
Adding recipients for a notification
Notification channels
Configuring a web gadget notification channel
Configuring an email notification channel
Configuring a mobile notification channel
Configuring additional parameters for notification channels
Setting notification preferences
Empowering knowledge workers
Configuring and working with optional actions in case types
Adding optional actions to cases
Adding optional actions to stages
Displaying optional actions conditionally
Adding supporting processes to cases
Adding supporting processes to stages
Displaying supporting processes conditionally
Creating ad hoc cases
Enriching cases with external data
Integrating a case with an external resource
Assigning a task to a robotic work queue
Assigning a task to an external application
Setting a service-level agreement for the Assignment Service shape
Connecting a flow to an external application
Running a decision strategy from a flow
Calling an activity or an automation from a flow
Creating cases from a web mashup
Enabling cases for creation through web and chat channels
Designing surveys
Best practices for creating a survey
Creating a survey
Adding a question page to a survey
Adding a question to a question page
Formatting text boxes in a survey
Formatting a picklist in a survey
Dynamically sourcing the choices in a picklist
Formatting a checklist in a survey
Formatting a slider in a survey
Formatting a radio button matrix in a survey
Creating a stand-alone question
Configuring advanced options for a question page
Reusing answers in survey questions
Creating questions in bulk
Populating a question template
Importing a question template
Troubleshooting question-template errors
Asking a question in a case
Asking a group of related questions in a case
Fine-tuning your survey
Making a question required in a survey
Conditionally displaying a question in a survey
Conditionally displaying a question page in a survey
Validating answers in a survey
Displaying a warning in a survey
Changing the run-time order of questions in a survey
Maximizing screen space in a survey
Adding supporting information to a survey
Adding hover text to a question
Attaching a file or URL link to a question
Displaying a block of text in a question page
Survey APIs
Securing case access
Configuring case type access
Viewing authorizations for case type items in a single access group
Editing authorizations for case type items in a single access group
Viewing authorizations for case type items in all access groups
Viewing authorizations for case type flows and flow actions in a single access group
Editing authorizations for case type flows and flow actions in a single access group
Controlling access to case attachments
Categorizing case attachments
Restricting user actions for case attachments
Decision management
Getting started with decision management
Exploring key decision management features with DMSample
Initializing DMSample data
Initializing predictive model monitoring
Enabling decision management services
Configuring the Decision Data Store service
Configuring an internal Cassandra database
Connecting to an external Cassandra database
Configuring the Adaptive Decision Manager service
Configuring the Data Flow service
Configuring the Real Time Data Grid service
Deploying and operating the Stream service
Configuring the Stream service
Monitoring the Stream service
Operating the Stream service
Understanding pr_data_stream_* tables
Configuration settings for nodes
Configuring logger settings
Monitoring decision management services
Storing customer and analytical data
Managing decision management nodes
Status of decision management nodes
Status parameters of Decision Data Store nodes
Status parameters of Adaptive Decision Manager nodes
Status parameters of Stream nodes
Managing Cassandra as the source of decision management data
Cassandra overview
Configuring the Cassandra cluster
Sizing a Cassandra cluster
Configuring the consistency level
Configuring the replication factor
Impact of failing nodes on system stability
Defining
Pega Platform
access to an external Cassandra database
Creating Cassandra user roles with full database access
Creating Cassandra user roles with limited database access
Configuring a Cassandra cluster for internal encryption
Prconfig properties for Cassandra cluster encryption
Creating Java keystores and truststores for Cassandra encryption
Configuring a Cassandra cluster for external encryption
Prconfig properties for Cassandra cluster encryption
Creating Java keystores and truststores for Cassandra encryption
Configuring compaction settings for SSTables
Best practices for disk space management
Configuring Cassandra compression
Configuring client-to-server compression
Configuring node-to-node compression
Configuring key cache settings
Configuring the retry policy
Configuring multiple data centers
Configuring the primary data center nodes
Configuring the secondary data center nodes
Modifying Cassandra node routing policies
Monitoring Cassandra cluster health
Performing regular monitoring activities on a Cassandra cluster
Pega alerts for Cassandra
Nodetool commands for monitoring Cassandra clusters
Capturing Cassandra metrics
Operating system metrics on Cassandra nodes
Key Cassandra metrics
Repairing and cleaning Cassandra nodes for data consistency
Troubleshooting Cassandra
Monitoring Cassandra errors and warnings
Verifying the available disk space
Checking the node status
Investigating compaction issues
Verifying the keyspace replication factor
Verifying the status of ports
Recovering a node
Getting the count of Cassandra table records
Addressing common issues
Input/output blockages in the Cassandra cluster
Increasingly slower read operations
Unable to connect to Cassandra cluster
Unable to add a node to the Decision Data Store service
Authentication error in the Decision Data Store landing page
Cassandra user does not have the required permissions
Cassandra error: Too many open files
Cassandra error: Too large commit log size
Cassandra warning: Couldn't find cfId
Clock skew across a Cassandra cluster
Cassandra terminates on startup
Configuring data sources
About Data Set rules
Data Set rules - Completing the Create, Save As, or Specialization form
Types of Data Set rules
HDFS and HBase client and server versions supported by
Pega Platform
Database Management
Database tables
Creating an HBase data set record
Configuring Hadoop settings for an HBase connection
About Hadoop host configuration (Data-Admin-Hadoop)
Connection tab
Creating a Decision Data Store data set
Migrating data between Decision Data Store data sets
Tracing Decision Data Store operations
Simulation and Reporting
Creating an interaction history summary data set
Applying sample scripts for archiving and purging
Applying interaction history scripts in Oracle databases
Moving the FACT table records
Merging the dimension records
Deleting the records from the FACT table
Applying interaction history scripts in Microsoft SQL Server
Moving the FACT table records in Microsoft SQL Server databases
Merging the dimension records in Microsoft SQL Server databases
Deleting the records from the FACT table in Microsoft SQL Server databases
Applying interaction history scripts in Db2 Database Software
Moving the FACT table records in Db2 Database Software
Merging the dimension records in Db2 Database Software
Deleting the records from the FACT table in Db2 Database Software
Interaction methods
Running interactions
Interaction History methods
Adding an association with a customer ID
Deleting an association between interactions and customer IDs
Monitoring interaction results
Creating a Monte Carlo data set record
Creating a Visual Business Director data set record
Aggregation on the Visual Business Director data set
Synchronizing the Actuals data set
Social media
Creating a Facebook data set
Customizing the metadata retrieval from Facebook data sets
Creating a YouTube data set record
File storage
Creating an HDFS data set record
Configuring Hadoop settings for an HDFS connection
About Hadoop host configuration (Data-Admin-Hadoop)
Connection tab
Creating a File data set record for embedded files
Creating a File data set record for files on repositories
Requirements for custom stream processing in File data sets
Run-time data
Creating a Stream data set
Partition keys for Stream data sets
Creating a Kafka data set
Creating a Kafka configuration instance
Creating a Kinesis data set
Data transfer
Exporting data into a data set
Importing data into a data set
Setting a size limit for data import into a data set
DataSet-Execute method
Configuring the DataSet-Execute method for Adaptive Decision Manager
Configuring the DataSet-Execute method for Database Table
Configuring the DataSet-Execute method for Decision Data Store
Configuring the DataSet-Execute method for Event store
Configuring the DataSet-Execute method for File
Configuring the DataSet-Execute method for HBase
Configuring the DataSet-Execute method for HDFS
Configuring the DataSet-Execute method for Interaction History
Configuring the DataSet-Execute method for Monte Carlo
Configuring the DataSet-Execute method for Kinesis
Configuring the DataSet-Execute method for a social media data set
Configuring the DataSet-Execute method for Stream
Configuring the DataSet-Execute method for Visual Business Director
Processing data with data flows
Creating a data flow
Filtering incoming data
Combining data from two sources
Converting the class of the incoming data pages
Merging data
Applying complex data transformations
Applying complex event processing
Adding strategies to data flows
Applying text analysis on the data records
Branching a data flow
Configuring a data flow to update a single property only
Types of data flows
Changing the number of retries for SAVE operations in batch and real-time data flow runs
Adding pre- and post- activities to data flows
Recording scorecard explanations through data flows
Making decisions in data flow runs
Creating a batch run for data flows
Reprocessing failed records in batch data flow runs
Creating a real-time run for data flows
Monitoring single case data flow runs
Managing data flow runs
Data flow run limits
Limiting active data flow runs
Data flow methods
Running a data flow
Running a data flow in single mode
Specializing activities
Managing data flows
Monitoring data flows
DataFlow-Execute method
Configuring the DataFlow-Execute method for a data flow with abstract input and output (single-case execution)
Configuring the DataFlow-Execute method for a data flow with abstract input
Configuring the DataFlow-Execute method for a data flow with abstract output
Configuring the DataFlow-Execute method for a data flow with stream input
Configuring the DataFlow-Execute method for data flows with non-stream input
Decision data methods
Running decision data instances
Deprecated: External data flows
Deprecated: Creating external data flows
Deprecated: External Data Flow rules – Completing the Create, Save As, or Specialization form
Deprecated: Data flow tab on the External Data Flow form
Deprecated: Configuring YARN settings
Deprecated: Configuring run-time settings
Deprecated: Creating an external data flow run
Deprecated: Managing external data flow runs
Deprecated: External Data Flow Run window
Deprecated: External data flow methods
Deprecated: Creating and starting an external data flow run
Deprecated: Starting an external data flow run
Deprecated: Stopping an external data flow run
Deprecated: Deleting an external data flow run
Deprecated: Restarting an external data flow run
Deprecated: Retrieving the status of an external data flow run
Reacting to real-time events
About Event strategy rule
Event Strategy rule form - Completing the Event Strategy tab
Event Strategy rule - Completing the Create, Save As, or Specialization form
Adding aggregations in event strategies
Aggregation options in event strategies
Approximate median calculation
Adding local variables in event strategies
Adding join conditions in event strategies
Adding filter conditions in event strategies
Dynamic window size behavior
Unit testing event strategies
Creating test cases for event strategies
Creating an event type in the Event Catalog
Clearing an event type in the Event Catalog
Deleting an event in the Event Catalog
Adding an events feed to your user interface
Browsing events for a customer or a group of customers
Accessing the Customer Movie landing page
Improving customer experience by creating next-best-actions
Propositions
Defining propositions
Reusing existing business issues and groups
Creating a business issue
Configuring the model transparency policy for predictive models
Creating a group
Defining versioned propositions
Importing versioned propositions from a .csv file
Adding a versioned proposition
Editing a versioned proposition
Defining the validity period for versioned propositions
Defining unversioned propositions
Adding an unversioned proposition
Duplicating an unversioned proposition
Editing an unversioned proposition
Editing unversioned propositions in bulk
Defining the validity period for unversioned propositions
Converting groups with unversioned propositions
Creating a property
Modifying a proposition hierarchy
Deleting unversioned propositions
Deleting versioned propositions
Deleting a business issue or a group
Accessing the Proposition Management landing page
About Strategy rules
Completing the Strategy rule form
Strategy rule form - Completing the Strategy tab
Decision strategy components
Sub Strategy
Embedded strategy
Configuring audiences for multiline decision strategies
Enabling multiple audiences in decision strategies through the Embedded strategy shape
Defining a Prediction shape
Import component
Decision analytics & business rules
Enrichment
Arbitration
Selection
Aggregation
External input
Strategy results
Strategy rule form - Using the Strategy Properties tab
Strategy rule form - Completing the Auto-Run Results tab
Strategy rule form - Completing the Pages & Classes tab
Globally optimized strategy
Creating a globally optimized strategy
Strategy canvas accelerators and keyboard shortcuts
Strategy methods
Returning a list of propositions
Returning a list of properties
Computing segment logic
Configuring business rules
About Decision Data rules
Completing the Decision Data rule form
Completing the Data tab
Completing the Form tab
Customizing the Decision Data rule form
Configuring Decision Data rule form fields
About Decision tables
Creating decision tables
Completing the Pages & Classes tab
Completing the Results tab
Completing the Table tab
About Decision Trees
Creating decision trees
Completing the Decision tab (Advanced format)
Completing the Decision tab (Basic format)
Completing the Pages & Classes tab
Completing the Configuration tab
Configuring property evaluation in a decision tree
About Map Values
Map Values
Completing the Matrix tab
Completing the Configuration tab
Completing the Pages & Classes tab
Configuring rows and columns in a map value
Unit testing a map value
About Proposition Filter rules
Proposition Filters
Configuring the specific criteria for the Proposition Filter rule
Configuring the default criteria for the Proposition Filter rule
Testing Proposition Filter rules with audience simulations
Pages & Classes tab on the Predictive Model form
About Adaptive Model rules
Adaptive Model rules - Completing the Create, Save As, or Specialization form
Outcomes tab on the Adaptive Model form
Parameters tab on the Adaptive Model form
Pages & Classes tab on the Adaptive Model form
Adaptive model tab on the Adaptive Model form
Model context
Adding model identifiers
Adding adaptive model predictors
Adding a predictor to an adaptive model
Adding multiple predictors to an adaptive model
Parameterized predictors
Adding parameterized predictors
About Predictive Model rules
Predictive Model rules - Completing the Create, Save As, or Specialization form
Predictive model tab on the Predictive Model form
Reclassifying score distribution
XSD validation and PMML error messages
Model source tab on the Predictive Model form
Parameters tab on the Predictive Model form
Adding parameterized predictors
Configurations tab on the Predictive Model form
Configuring custom functions of a PMML model
Input mapping tab on the Predictive Model form
Pages & Classes tab on the Predictive Model form
Scorecard rules
Creating a Scorecard rule
Defining predictors for scorecards
Mapping score ranges to decision results
Testing the scorecard logic
Scorecard rule form - Pages & Classes tab
Understanding business rules
More about Decision Trees
More about Decision Tables
More about Map Values
Test run labels
Unit testing strategy rules
Configuring batch case runs
Decision statistics
Performance statistics
Predicting customer behavior
Getting started with Prediction Studio
Prediction Studio overview
Setting up your environment
Setting access to Prediction Studio
Changing your workspace
Specifying a repository for Prediction Studio models
Specifying a database for Prediction Studio records
Configuring the default rule context
Enabling outcome inferencing
Analyzing example projects and models in Prediction Studio
Clearing deleted models in Prediction Studio
Predicting customer behavior and business events
Creating predictions
Creating predictions without historical data
Creating predictions with historical data
Customizing predictions
Developing and managing models
Adaptive analytics
Defining an adaptive model
Creating an adaptive model
Adding adaptive model predictors
Adding a predictor to an adaptive model
Adding multiple predictors to an adaptive model
Adding parameterized predictors
Enabling predefined Interaction History predictors for existing adaptive models
Defining outcome values in an adaptive model
Configuring advanced settings for adaptive models
Extracting historical responses from adaptive models
JSON file structure for historical data
Adaptive models monitoring
Viewing summarized adaptive model reports
Generating and downloading a model report
Viewing a model report
Model report details
Predictor report details
Viewing the predictors overview
Predictor performance information
Adaptive model methods
Obtaining predictor information
Training adaptive models
Deleting adaptive models
Predictive analytics
Creating a predictive model
Creating a Pega predictive model
Template categories for creating predictive models
Importing a predictive model
Specifying the H2O Driverless AI license key
Importing the H2O implementation library
Editing an imported model
Configuring custom functions of a PMML model
XSD validation and PMML error messages
Supported models for import
Connecting to external predictive models
Metadata file specification for predictive models
Supported Amazon SageMaker models
Configuring a predictive model
Editing settings for a predictive model
Outcome definition settings
Sample construction settings
Data analysis settings
Predictor grouping settings
Genetic algorithm settings
Score distribution settings
Reclassifying score distribution
Preparing data
Selecting a data source
Constructing a sample
Defining an outcome
Defining the outcome field for scoring and extended scoring models
Defining a previous decision
Defining the outcome field for spectrum models
Analyzing data
Defining the predictor role
Analyzing and configuring predictors
Raw distribution
Binning predictors
Binning numeric predictors
Binning symbolic predictors
Grouping options for predictors
Auto grouping option for predictors
Managing grouping options for numeric predictors manually
Managing grouping options for symbolic predictors manually
Outcome inferencing
Checking distribution of accepts
Constructing an inference sample
Checking similarity based inference
Checking inference tuning
Comparing inference results
Performing final data analysis
Virtual fields
Adding virtual fields
Modifying a virtual field
Deleting a virtual field
Generating data analysis reports
Developing models
Grouping predictors
Creating models
Creating a regression model
Creating a decision tree model
Creating a bivariate model
Creating a genetic algorithm model
Computation models
Benchmark models
Sensitivity of models
Analyzing models
Comparing scores generated by models
Checking score distribution
Comparing the classification of scores generated by models
Selecting a model for deployment
Predictive models monitoring
Metrics for measuring predictive performance
Monitoring a predictive model
Viewing a predictive model report
Predictive models management
Creating a custom template for creating a predictive model
Exporting a project
Importing a project
Types of predictive models
Managing data
Creating data sets
Creating summaries
Accessing text analytics resources
Model management
Viewing recent responses for adaptive and predictive models
Clearing models
Deleting adaptive models
Updating adaptive models
Adaptive model details
Migrating adaptive model schema
Accessing the Adaptive Model Schema Migration landing page
Adaptive Models Schema Migration
Viewing Prediction Studio notifications
Analyzing natural language
Labeling text with categories
Detecting the topics of text fragments
Comparing keyword-based and machine learning topic detection
Creating keyword-based topic detection models
Setting up a keyword-based topic detection model
Creating a taxonomy for keyword-based topic detection
Importing a taxonomy for keyword-based topic detection
Creating machine learning topic detection models
Setting up a machine learning topic detection model
Uploading data for training and testing of the topic detection model
Defining the training and testing samples for topic detection
Reviewing the taxonomy for machine learning topic detection
Training and testing the topic detection model
Reviewing the topic detection model
Saving the topic detection model
Connecting to topic detection models in Cloud AutoML
Configuring a machine learning service connection
Creating a text categorization model to run topic detection models in Cloud AutoML
Connecting to topic detection models through an API
Configuring sample containers to use Python models for topic detection
Configuring a machine learning service connection for topic detection models using REST API
Configuring a data transform for a JSON output mapping
Creating a text categorization model to run topic detection models through an API
Frequently asked questions about integrating topic detection models
Recognizing user intent
Setting up an intent detection model
Preparing data for intent detection
Uploading data for training and testing of the intent detection model
Defining training and testing samples, and building the intent detection model
Accessing intent analysis model evaluation reports
Saving the intent detection model
Determining the emotional tone of text
Setting up a sentiment analysis model
Preparing data for sentiment analysis
Uploading data for training and testing of the sentiment analysis model
Defining the training set and training the sentiment analysis model
Reviewing the sentiment analysis model
Saving the sentiment analysis model
Extracting keywords and phrases
Creating entity models
Building machine learning text extraction models
Preparing data for text extraction
Defining the training set and training the text extraction model
Accessing text extraction model evaluation reports
Saving the text extraction model
Building text analyzers
Topic detection
Configuring topic detection
Sentiment analysis
Configuring sentiment analysis
Text extraction analysis
Configuring text extraction analysis
Intent analysis
Configuring intent analysis
Default intent model
Configuring advanced text analytics settings
Configuring language detection preferences
Configuring sentiment score range
Configuring spelling checker settings
Configuring categorization settings
Testing Text Analyzer rules
Managing text analytics models
Managing incomplete text analytics models
Managing complete text analytics models
Testing text analytics models
Migrating text analytics models
Exporting text analytics models
Importing text analytics models
Updating training data for text analytics models
Sentiment lexicons
Text analytics accuracy measures
Simulating next-best-action changes
Comparing decision results in the Visual Business Director planner
Accessing Visual Business Director (VBD) planner
Customizing Visual Business Director (VBD) planner
The Data Sources tab
The Key Performance Indicators tab
Adding a key performance indicator
Editing a key performance indicator
Visual Business Director planner
Simulation testing
Creating simulation tests in
Pega Customer Decision Hub
Running simulation tests
Running simulation tests from the strategy form
Complying with policies or regulations by detecting unwanted bias
Bias measurement
Customer Decision Hub
Managing simulation tests in
Pega Customer Decision Hub
Filtering simulation tests
Viewing additional simulation test details
Configuring reports assigned to simulation test outputs
Duplicating simulation tests
Comparing simulation tests
Assigning custom reports to simulation tests
Scheduling simulation tests
Simulation methods
Creating a simulation run
Starting a simulation run
Managing the business-as-usual changes
Understanding business change management, revision management, and pipeline automation
Understanding the relationship between Pega 1:1 Operations Manager and revision management
Application overlays
Creating application overlays
Editing application overlays
Deleting application overlays
Launching a revision change request
Completing change requests
Resolving revisions
Launching fast-track change requests
Deploying revisions with Deployment Manager
Optional: Managing revisions manually
Importing revisions
Activating revisions
Discarding revisions
Rolling back revisions
Supported rule types for revision management
Stages of the Revision case type
Stages of the Change Request case type
Managing application data
Data modeling
Best practices for data modeling
Troubleshooting errors in your data model
Exploring the data model
Viewing the data model for a case
Viewing the data model for a data object
Managing data objects
Storage and display of fields
Adding a data type to your application
Creating a data type in Dev Studio
Configuring the context for rules related to a data type
Deleting a data object
External Data Entities landing page
Adding a data page to a data type
Connecting a data object to a system of record
Viewing pages and properties that use a data type
Reusing data
Reusing CRM data types
Simulating data
Replacing a simulated data source
Updating your data model
Defining the fields in a data object
Changing the type of a field
Troubleshooting field errors
Reusing data records
Referencing data from another data object
Adding data relationships to forms and data models
Managing application data
Bringing data into your application
Integrating data from a REST service when creating a data object
Creating a data object and connecting it to a system of record using REST
Providing authentication details
Authenticating with basic or NTLM authentication
Authenticating with OAuth 2.0
Mapping fields
Mapping fields for the GET method when creating a data object
Mapping fields for the POST method when creating a data object
Integrating data from a REST service for an existing data object
Connecting existing data objects to a system of record using REST
Providing authentication details
Authenticating with basic or NTLM authentication
Authenticating with OAuth 2.0
Mapping fields
Mapping fields for the GET method for existing data objects
Mapping fields for the POST method for existing data objects
Importing external data
Using the Data Import wizard
Importing data from a file
Applying business logic when importing data
Troubleshooting import errors
Customizing the import process
Adding a custom import purpose
Removing a custom import purpose
Preventing users from selecting a data import purpose
Skipping key validation
Adding post processing to import
Processing records and data before and after import
Importing data by using an API
Adding data import functionality to your application
Updating data records
Updating a data record
Updating data records in bulk
Exporting data records
Importing updates from a file
Deleting a data record
Deleting data records in bulk
Data mapping limitations
Updating connection details and mapping for a data object
Preparing your data for production
Creating local data storage
Fixing database table generation
Data Tables landing page
Database tables
Migrating application data
Creating a migration configuration template
Managing UI Views
Creating a view for a data object
Troubleshooting data in UI elements
Reporting
Learning about report categories
Learning about report types
Learning about Report Browser
Creating a report
Creating a report category in Report Browser
Adding columns to reports
Sorting and grouping columns in list reports
Duplicating existing reports
Running a report
Learning about Report Viewer
Learning about scheduling reports
Scheduling reports
Managing report subscriptions
Subscribing to reports
Testing scheduled reporting tasks
Updating scheduled reporting tasks
Removing scheduled reporting tasks
Editing a report
Learning about Report Editor
Learning about Data Explorer
Modifying list reports
Modifying summarized reports
Adding filter conditions
Editing filter conditions
Editing filter logic
Adding or editing charts in the Report Editor
Removing charts in the Report Editor
Converting a list report to a summarized report
Converting a summarized report to a list report
Creating advanced reports
Learning about report definitions
The Calculation Builder
More about report definition rules
Learning about charts
Adding charts in the Report Definition rule form
Removing charts in the Report Definition rule form
Showing chart data
Data settings form in the Chart Editor
Styling charts in the application skin
Defining associations for map charts
Adding maps to reports
Learning about the Reporting landing page
Setting resource limits for reporting
Disabling the creation of an Info sheet in Excel output
Associations
Creating simple associations between classes
Creating advanced associations between classes
Viewing associations that are available for reporting
Removing standard reports and categories from the Report Browser
Creating an advanced report category
Managing report categories
Creating a report shortcut
Managing reports shortcuts
Managing filter options in Report Viewer
Reviewing usage report statistics
Creating usage reports
Customizing usage reports
Creating a dedicated ruleset version for manager reports
Case types available from the Report Browser
Setting up reports database
Disabling usage of a reports database
Conversational channels
Pega Email Bot overview
Pega Email Bot features
Pega Intelligent Virtual Assistant overview
Unified Messaging
channel overview
Pega Intelligent Virtual Assistant features
Conversational channel user roles
Understanding text analysis
Exploring text analyzers
Implementing an email bot for an Email channel
Building an Email channel
Creating an Email channel
Adding email accounts for email handling
Enabling rich HTML text in emails
Selecting a reference operator for an Email channel
Selecting languages for an Email channel
Overriding the default language for an Email channel
Defining Email channel behavior
Adding suggested cases for an Email channel
Setting up text analysis for a suggested case
Setting up entity property mapping
Defining suggested responses for an Email channel
Configuring email analysis
Adding a text analyzer for an email bot
Defining topics for text analysis for an email bot
Enabling subject analysis in email
Enabling email attachments analysis during email triage
Enabling automatic language detection for text analysis
Configuring intelligent email routing
Selecting the routing processing mode
Adding a routing condition based on email header content
Adding a routing condition based on NLP text analysis
Adding a routing condition based on a when rule
Testing email routing conditions
Using the Email channel
Training the model for the Email channel
Enabling the training data recording for an email bot
Creating training data manually for an email bot
Correcting training data in an email bot
Editing data records
Correcting identified topics
Correcting identified languages
Creating entities for an email bot
Correcting existing entities
Transferring training data to another email bot
Exporting training data for an email bot
Importing training data for an email bot
Applying changes to a text analytics model for an email bot
Triaging incoming emails
Understanding the email triage process
Replying to customers by email for an email bot
Sending Pulse messages for an email bot
Transferring triage cases
Spinning off business cases for an email bot
Detecting duplicate or related cases for an email bot
Mapping to duplicate or related cases for an email bot
Linking related cases for an email bot
Resolving triage cases
Setting up work queues for email processing
Viewing reports for the Email channel
Built-in reports for the email bot
Managing the Email channel
Troubleshooting the email bot
Troubleshooting email accounts in the Email channel
Troubleshooting email routing conditions
Upgrading the email bot to the 8.5 version
Migrating triage cases to new tables
Archiving resolved emails for an email bot (Pega Cloud Services)
Database schema for email bot tables
Enabling reports for the email bot
Adding the email bot reports dashboard to other portals
Implementing an Intelligent Virtual Assistant for a conversational channel
Building a conversational channel
Creating a conversational channel
Creating a
Unified Messaging
channel
Configuring
Unified Messaging
channel security
Setting up the IVA for Apple Business Chat
Setting up the IVA for Facebook
Setting up the IVA for SMS/MMS (Twilio)
Setting up a Twilio account for a mobile number
Setting up the IVA for Twitter
Setting up the IVA for WhatsApp
Adding a WhatsApp number to your Twilio account
Optional WhatsApp configuration for your Twilio account
Best practices when using an IVA for WhatsApp
Creating a Web Chatbot channel
Embedding a chat window for the Web Chatbot channel
Customizing the Web Chatbot channel
Changing the default text for action prompt in the IVA for Web Chatbot
Creating custom controls for the IVA for Web Chatbot
Working with custom controls in the IVA for Web Chatbot
Knowledge Management article API for the Web Chatbot channel
Creating an Alexa channel
Installing the Alexa Channel component
Creating an Alexa skill definition
Setting up an Alexa channel
Updating the Alexa skill configuration
Testing the Alexa skill definition
Updating the access group for an IVA channel
Template operator for IVA channel
Installing the Dialogflow component
Adding the Dialogflow component from Pega Marketplace
Creating a Dialogflow agent
Defining conversational channel behavior
Adding a conversation to a case type
Adding a conversational channel to a case type process
Adding questions to a conversation
Adding case commands for a conversational channel
Defining response commands for a conversational channel
Configuring text analyzer settings
Adding a text analyzer for an IVA
Defining topics for text analysis for an IVA
Defining advanced text analyzer configuration
Configuring the Dialogflow text analyzer for a channel
Mapping Dialogflow intents and entities to a case type
Guidelines for sharing text analytics models across channels
Configuring system responses for a conversational channel
Simulating a conversation and building a chatbot
Verifying chatbot responses
Correcting and accepting a detected topic
Validating detected entities
Modifying chatbot response questions
Extracting data from a conversation
Creating entities for an IVA
Mapping entities in conversation text
Applying simulation changes to a text analytics model
Use case: Building an IVA for Web Chatbot in the preview console
Before you begin
Associating topics with user input
Configuring and mapping entities to case type properties
Testing changes in the chatbot
Conclusion
Using the conversational channel
Training the model for the IVA channel
Enabling training data recording for an IVA
Creating training data manually for an IVA
Correcting training data in an IVA
Transferring training data to another IVA
Exporting training data for an IVA
Importing training data for an IVA
Applying changes to a text analytics model for an IVA
Guidelines for training the model for the IVA channel
Best practices when training model-based entities in an IVA
Best practices when building rule-based entities in an IVA
Best practices for cleaning up training data in an IVA
Use case: Training and building the model in an IVA for Web Chatbot
Before you begin
Creating training records
Mapping entities in the training data
Adding training data to the model
Building the model
Testing model changes in the chatbot
Conclusion
User experience
Designing your user interface
Client-side templates
Out-of-the-box user interface capabilities
Design templates
Best practices for design templates
Designing a future-proof UI
Designing a persona-based UI
Personas
Portals for personas
Pages
Building portals
Creating a portal
Adding the Pulse gadget to your application
Enabling users to post messages in the activity feed
Creating feed sources for activity feeds
Determining default feed sources
Providing persona-based access to a portal
Defining a custom header for a portal
Organizing the contents of a portal
Creating and managing pages for applications
Default pages
Creating a landing page for an application
Editing a custom page in a portal
Configuring tables on landing pages
Removing a landing page from an application
Configuring page access settings in bulk
Organizing the main menu for a portal
Adding a widget to your dashboard
Containers in portals
Adding a dynamic container to a portal
Adding an AJAX container to a portal
Defining a theme and a logo for a portal
Previewing a portal
Adding, editing, and deleting a preview device
Building forms for case types
Forms and views
Case and workflow views
Configuring dynamic views
Customizing a user portal in the phone preview
Customizing the case details section
Adding tabs to the case details section
Adding action buttons to a case header
Adding buttons to the case action header
Adding UI elements to forms
Controls
Adding controls
Configuring controls
Copying, moving, or deleting a control
Defining the behavior of a control
Managing editing options for controls
Selecting the property reference for a control
Automating source synchronization in controls
Adding text to controls
Adding actions to a control
Available actions and conditions
Adding icons to controls
Styling controls at run time
Adding custom attributes for version 1 DX API to auto-generated controls
Data capture controls
Text controls
Configuring a Text input control
Configuring a Text area control
Configuring a Rich text editor control
Adding a custom plug-in to the Rich text editor
Configuring a Date Time control
Selecting the date and time format
Specifying calendar navigation options
Restricting the years displayed
Specifying minute intervals
Specifying week display
Disabling the selection of weekend days
Specifying time zones for Date Time controls
Setting a date range
Understanding the Date, TimeofDay, and DateTime property types
Java date pattern
Evaluation of symbolic dates
Adding a Currency control
Purpose-Specific Control— General tab
Currency Properties – Presentation tab
Using the Currency Control
Adding an Integer Control
Integer Properties — Presentation tab
Adding a Signature capture control
Customizing a Signature capture control
Picker controls
Configuring an Autocomplete control
Multi-select list controls
Adding and configuring a Multi-select list control
Adding a Multi-select list control
Selecting the property for a Multi-select list control
Specifying the list source for a Multi-select list control
Specifying presentation options for a Multi-select list control
Adding a Checkbox control
Adding a Drop-down control
Dropdown control Properties — General tab
Dropdown control Properties — Presentation tab
Adding a Radio Button control
Radio Buttons control Properties — General tab
Radio Buttons control Properties — Presentation tab
Radio Button Properties - Behavior tab
Configuring an Anypicker control
Action controls
Configuring a Button control
Specifying presentation options for a Button control
Link controls
Styling options for Link controls
Adding and configuring a Link control
Adding a Link control to a layout
Specifying the caption for a Link control
Specifying the image source and tooltip for a Link control
Specifying presentation options for a Link control
Configuring the Attach content control
Configuring file size options for the Attach content control
Customizing the display options for the Attach content control
Data display controls
Adding a Text control
Configuration options for the Text control
Configuring a text label in a layout cell or header
Adding paragraphs to place rich text in a layout cell or header
Configuring icon controls
Standard icons
Adding a chart
Chart control - Axis tab for a line chart
Chart control - Axis tab for an area chart
Chart control - Axis tab for a bar chart
Chart control - Axis tab for a column chart
Chart control - Needle tab for a gauge chart
Chart control - Wedges tab for a pie chart
Adding and configuring an Advanced data visualization control
Adding an Advanced data visualization control
Specifying the data source for an Advanced data visualization control
Specifying the visual properties of an Advanced data visualization control
Geographic reference
Configuring dynamic system settings for geographic reference
Configuring the Map control
Adding a location field
Timeline controls
Adding and configuring a Timeline control
Adding a Timeline control
Specifying the data source for a Timeline control
Specifying the date range for a Timeline control
Specifying presentation options for a Timeline control
Creating a custom Timeline control
Adding a video to a section
Adding a Tooltip
Tooltip Properties — Presentation tab
Creating custom controls by using third-party JavaScript libraries
Custom control JSP reference
Creating auto-generated custom controls
Custom controls
Fields
Adding single-value fields to forms
Adding data relationships to forms and data models
Adding tables to forms
Reusing fields on forms
Reusing forms
Restricting user input in a field
Creating a picklist
Creating a calculated field
Validating field values on a form
Validating field input in complex scenarios
Adding a validation rule to a flow action
Validating character patterns
Adding a multistep form to a stage
Creating custom forms
Portal structure
Harnesses
Harness form -
Harness form — Adding a screen layout
Configuring a screen layout
Screen layout properties
Screen layout - Region properties - General tab
Upgrading panel sets to screen layouts
Harness form - Adding a container
Harness forms - How to support work item copying
Harness forms - Supporting work item printing
Harness and Section forms: Help — Client Event Editor
Harness and Section forms — Using the Condition Builder to configure dynamic UI actions
Harnesses form - Completing the Design tab
Harness form - Completing the Display Options tab
Harness form - Completing the Scripts and Styles tab
Harness form - Completing the Pages & Classes tab
Harness form - Completing the Advanced tab
Harness form - Presenting flow actions
Harness forms - Placing a button in a harness
More about Harnesses
Best practices for sections and layouts
Sections
Creating sections
Adding an action to an included section
Converting sections to full section editor
Harness and section forms - Adding a section
Displaying a list of recent items in your application
Customizing the list of recent items in your application
Customizing the content of the list of recent items
Modifying the number of items in the recent items list
Changing the style of the recent items list
Selecting another grid style from the skin
Modifying the existing grid style in the skin
Defining and applying an additional grid format
Customizing the data and label that are displayed on the recent items list
Disabling the list of recent items
About HTML Fragment rules
HTML Fragment rules - Completing the New or Save As form
HTML Fragment form - Completing the HTML tab
HTML Fragment form - Completing the Pages & Classes tab
More about HTML Fragment rules
About HTML rules
HTML rules -
HTML form - Completing the HTML tab
HTML form - Completing the Pages & Classes tab
More about HTML rules
Unit testing a section
Layouts
Organizing your form
Working with dynamic layouts
Configuration options for layouts
Creating a dynamic layout
Modifying the presentation options of the dynamic layout
Layout Groups
Creating a layout group
Modifying the presentation options of the Layout group
Creating a templated region based on a layout group
Adding a when rule to a layout group
Creating a columns layout
Modifying the presentation options of the Columns layout
Creating a repeating dynamic layout
Repeating dynamic layout - Operations tab
Configuring drag-and-drop functionality for list items
Configuring swipe actions for a mobile app
Creating a dynamic layout group
Creating a table layout
Table layout structure
Table layout - Presentation tab
Table layout - Operations tab
Arranging column visibility by importance
Prioritizing information in tables
Configuring table activities
Configuring drag-and-drop functionality for tables
Optimizing table code
Enabling table personalization
Configuring the table toolbar
Enabling grouping by fields
Enabling the table columns visibility toggle
Enabling row height adjustment for a table
Enabling the refresh view button for a table
Enabling search in a table
Adding custom actions to the table toolbar
Creating a hierarchical table layout
Enabling additional hierarchical table settings
Creating a navigational tree layout
Creating an External web component
Harness and Section forms - Configuring an External web component section
Referencing data
Data objects in UI
Enabling run-time data object editing
Modal dialog box
Configuring a modal dialog box for a button
Configuring a modal dialog box for a grid layout
Modal dialog box templates
Creating custom modal dialog box templates
About Navigation rules
Hierarchy rules
Navigation rules -
Navigation form - Completing the Editor tab
Navigation form - Completing the Pages & Classes tab
Navigation rule — Completing the Node Details Action tab
Reusing UI Gallery examples in an application
Configuring a form at run time
Configuring a work area at run time
Configuring a region at run time
Configuring a table at run time
Configuring a case at run time
Supported display modes by field type
Enabling spell checking in user forms
Extending the spell checker to other languages
Legacy forms
Styling your application with design systems
Skins
Best practices for styling your application
Creating skins
Configuring skin base settings manually
Optimizing skins
Specifying a skin for your application
Specifying a skin for a portal
Component style formats
Creating style formats
Styling a layout
Styling a control
Removing style formats
Finding sections that use a specific format
General components styles
Skin form — Components tab — General — Action area
Skin form — Components tab — General — Action area
Skin form — Components tab — General — Button area
Skin form — Components tab — General — Custom styles
Skin form — Components tab — General — Errors
Skin form — Components tab — General — Errors
Skin form — Components tab — General — Errors
Skin form — Components tab — General — Modal dialogs
Creating a custom modal dialog format
Applying a custom modal dialog format
Skin form — Components tab — General — Modal dialogs
Skin form — Components tab — General — Modal dialogs
Skin form — Components tab — General — Overlays
Creating a custom overlay format
Applying a custom overlay format
Skin form — Components tab — General — Page
Skin form — Components tab — General — Panel Set
Skin form — Components tab — General — Panel Set
Skin form — Components tab — Layouts — Screen layouts
Skin form — Components tab — General — Wizard
Skin form — Components tab — General — Wizards
Component styles for layouts
Configuring a responsive user interface
Skin form — Components tab — Layouts — Accordions — Header tab
Skin form — Components tab — Layouts — Accordions — Body tab
Skin form — Components tab — Layouts — Containers
Creating a custom container format
Applying a custom container format
Skin form — Components tab — Layouts — Containers
Skin form — Components tab — Layouts — Containers
Skin form: column layouts
Skin form — Components tab — Layouts — Dynamic layouts
Creating a custom dynamic layout format
Skin form — Components tab — Layouts — Layout Groups
Creating a custom layout group format
Skin form — Components tab — Repeat-row/columns
Creating a custom Row or Column Repeat format
Applying a custom Row or Column Repeat format
Skin form — Components tab — Repeat-row/columns
Skin form — Components tab — Layouts — Tabs
Creating a custom tab format
Applying a custom tab format
Skin form — Components tab — Layouts — Tabs
Skin form — Components tab — Layouts — Trees and tables - General tab
Creating custom table and tree table formats
Skin form — Components tab — Layouts — Trees and tables - Rows tab
Skin form — Components tab — Layouts — Trees and tables - General tab
Skin form — Components tab — Layouts — Trees and tables — Borders tab
Creating a custom grid format
Applying a custom grid format
Skin form — Components tab — Layouts — Trees and tables - Behaviors tab
Skin form — Components tab — Layouts — Trees and tables - Actions Layout tab
Skin form — Components tab — Layouts — Legacy layouts
Component styles for controls
Skin form — Components tab — Controls — Autocomplete
Skin form — Components tab — Controls — Autocomplete
Skin form — Components tab — Controls — Buttons
Creating a custom button format
Applying a custom button format
Skin form — Components tab — Controls — Charts
Skin form — Components tab — Controls — Check boxes
Creating a custom check box format
Applying a custom check box format
Skin form — Components tab — Controls — Dropdowns
Creating a custom dropdown format
Applying a custom dropdown format
Skin form — Components tab — Controls — Labels
Creating a custom label format
Applying a custom label format
Skin form — Components tab — Controls — Links
Creating a custom link format
Applying a custom link format
Skin form — Components tab — Controls — Menus
Creating a custom menu format
Applying a custom menu format
Skin form — Components tab — Controls — Menus
Skin form — Components tab — Controls — Menus
Skin form — Components tab — Controls — Radio buttons
Creating a custom radio button format
Applying a custom radio button format
Skin form — Components tab — Controls — Rich Text Editor
Creating a custom rich text editor format
Applying a custom rich text editor format
Skin form — Controls — Tooltip
Skin form — Components tab — Controls — Smart tip and Smart info
Skin form — Components tab — Controls — Smart tip and Smart info
Creating a custom smart tip and smart info format
Applying a custom smart tip and smart info format
Skin form — Components tab — Controls — Smart tip and Smart info
Skin form — Components tab — Controls — Split/menu button
Skin form — Components tab — Controls — Split/menu button
Skin form — Components tab — Controls — Text inputs & Formatted text
Creating a custom text input and formatted text format
Applying a custom text input and formatted text format
Skin form — Components tab — Controls — Multi Select
Component styles for reports
Skin form — Components tab — Reports — Column filter
Skin form — Components tab — Reports — Column Filter
Skin form — Components tab — Reports — List view
Skin form — Components tab — Reports — List view
Skin form — Components tab — Reports — Paging bar
Mixins
Creating mixins
Modifying existing mixins
Deleting a mixin
Determining where a mixin is referenced
Mixins tab of the Skin rules form
Skin rules - Renaming a mixin
Color Picker
Included styles
Skin form - Included Styles tab
Creating a custom style
Attaching a CSS to the skin
Skin inheritance
Creating a new dependent skin
Adding a parent skin
Overriding an inherited format
Reverting an inherited format
Viewing the skin inheritance stack
Inheritance
Base Settings
Overall font
Base tag heading styles
Background
Layout
More about Skin rules
Updating the UI Kit in your application
Managing Cosmos UI settings in case designer
CSS helper classes
Adjusting layout styling by using CSS helper classes
Adjusting cell styling by using CSS helper classes
Reviewing CSS helper class definitions
Adding CSS helper classes
Overriding disabled inherited screen layout formats
Skins, Interfaces, & Templates landing page
Customizing fonts for your Pega application
Customizing login screens for your Pega application
Configuring a Browser requestor
Editing the source HTML of your login screen
Editing the text rules containing the source CSS for login screens
Adding a new background image to your login screen
Icon fonts
Previewing and selecting predefined icons with the icon class picker
Reviewing available icons
Adding the icon font set
Debugging your UI
The Live UI tool
Editing with Live UI
Editing dynamic layouts with Live UI
Localizing your application
Internationalization and localization
Localization wizard
Preparing your application for translation
Localized properties
Localized rule types
Creating a translation package
Selecting languages
Selecting application rulesets
Enabling records
Downloading the translation package
Preparing a translation package for a translator
Importing translations
Selecting the translation package and rulesets
Importing the translation file
Testing the translation package
Checking the translated values in the application
Localizing forms by using the Localization inspector
Building an accessible UI
Accessibility and Pega Platform
Enabling accessibility
Adding WAI-ARIA roles to a Dynamic Layout
Adding a main content link to a dynamic layout
Accessibility features
Page load status
WAI-ARIA Roles
WAI-ARIA roles in a screen layout
Accessibility Inspector
Setting PDF file versions
Building custom UI capabilities
Generating PDFs from your UI
Creating PDF files by using a compact style sheet
Pega web mashups for embedding Pega UI in external web pages
Creating cases from a web mashup
Pega Digital Experience (DX) API
Accessing and testing Pega DX API Version 1
Accessing and testing Pega DX API Version 2
DX API request and response elements
Layouts in DX API
Controls in DX API
Previewing Cosmos React UI
Implementing Cosmos React UI in Pega Platform
Installing Cosmos React UI by using Docker
Installing Cosmos React UI by using Helm for Kubernetes
Configuring Pega Platform for Cosmos React UI
Adding an application URL alias
Enabling Cosmos React UI for an application
Enabling Cosmos React UI for landing pages
Editing views in a case type
Adding fields to a form
Integrating your application with external resources
Pega APIs and services
Pega API services
Using the Pega API
Pega API system management privileges
Securing the Pega API
Pega API best practices
Retrieve a flat list of fields from Pega APIs
Page-related operation queuing with page instructions in Pega APIs
Page instructions for embedded pages
Page instructions for page lists
Page instructions for page groups
Append or insert rows in page lists and page groups by using newRow
Pega API example use cases
City services example mobile app
Pega API time and expenses sample mobile app (manager)
Pega API time and expenses example mobile app (employee)
Adding a custom API or service
Viewing application-specific REST APIs
Generating OpenAPI Specification documentation for application-specific REST APIs
Best practices for generating OpenAPI Specification documentation
Pega API HTTP status codes and errors
Integrating with file and content management systems
File and content storage
Viewing file storage destinations
Adding a file repository
Creating a repository
Adding an S3 repository
Adding a Microsoft Azure repository
Adding a JFrog repository
Adding a file system
Adding a Pega repository
Enabling the Pega repository type
Creating a custom repository type
Repository APIs
Create folder API
Create file API
Get file API
List files API
Exists API
Delete API
Is authenticated API
Using file repositories
Configuring external storage options for attachments
Adding a case or Pulse attachment from external content locations
Adding a case attachment from a CMIS system
Managing a case attachment stored in a CMIS system
Storing case attachments using external storage
Requirements and restrictions for case attachments in a file storage repository
Migrating case attachments to a repository
Creating connector simulators
Data mapping in services and connectors
Data mapping for SOAP and dotNet connectors
Data mapping for SOAP and dotNet services
Email servers
Email servers – Completing the Environment tab
Example of authenticated user's access group
Example of unathenticated user's service package access group
About the Connector and Metadata wizard
Connector and Metadata wizard – Completing the Choose Purpose form
Connector and Metadata wizard – The JNDI Server and Bindings form
Connector and Metadata wizard – The Home Methods form (EJB connector)
Connector and Metadata wizard – The Remote Methods form (EJB connector)
Connector and Metadata wizard – Completing the Initial Parameters form
Connector and Metadata wizard – Completing the Select Fields form (importing a JavaBean)
Connector and Metadata wizard – Completing the Select Constructors form
Connector and Metadata wizard – Completing the Select Methods form
Connector and Metadata wizard – Completing the Initial Parameters form (SQL)
Connector and Metadata wizard - Define Intended Operations form (SQL)
Connector and Metadata wizard - Completing the Select Table Columns form (SQL)
Connector and Metadata wizard – Completing the Select Columns for List Query form (SQL)
Connector and Metadata wizard – Completing the Map Parameters form (SQL)
Connector and Metadata wizard - Choose Service Details form
Connector and Metadata wizard - Choose Methods Form (.NET and SOAP)
Connector and Metadata wizard – Completing the Previous Runs form
Connector and Metadata wizard - Completing the Previous Runs form
Connector and Metadata wizard - Completing the Previous Runs form
Connector and Metadata wizard - Completing the Add Substitute Rules form
Connector and Metadata wizard - Completing the Map Parameters form
Connector and Metadata wizard – Completing the Class Conflicts form
Connector and Metadata wizard - Completing the Other Conflicts form
Connector and Metadata wizard – Completing the Preview Duplicates form
Connector and Metadata wizard – Completing the Review form
Connector and Metadata wizard - Completing the Class Duplicates form
Connector and Metadata wizard - Completing the Other Duplicates form
How to call a Windows DLL library
Requestor pooling for services
Tools for integration development tasks
About generating connector rules
Connected apps landing page
Connecting an app to a service provider
Disconnecting an app from a service provider
Integration Connectors landing page
Creating SOAP integration
Providing a WSDL document for SOAP integration
Selecting operations for SOAP integration
Configuring the authentication for data sources in SOAP integration
Testing operations in SOAP integration
Generating records for SOAP integration
Reviewing the record generation summary
Creating a REST integration
Configuring a REST connection
Selecting methods for REST integration
Defining a data model for REST integration
Configuring the request and response in REST integration by adding a REST response
Configuring the request and response in REST integration by adding a file
Updating and generating records for REST integration
Updating the integration layer for REST integration
Updating the data layer for REST integration
Reviewing the record generation summary
Creating SAP integration
Providing an input document for SAP integration
Configuring an SAP connection
Selecting operations for SAP integration
Configuring the authentication for data sources in SAP integration
Testing operations in SAP integration
Generating records for SAP integration
Updating the integration layer for SAP integration
Updating the data layer for SAP integration
Reviewing the record generation summary
About the eForm Rules accelerator
eForm accelerator Help: Completing the Select eForm Properties form
eForm accelerator Help: Completing the Upload File form
eForm accelerator Help: Completing the Select eForm Fields form
eForm accelerator Help: Completing the Map eForm Fields form
eForm accelerator Help: Completing the Review and Save form
Deleting an email account
About importing XSD files
Connector and Metadata wizard - Completing the Select Elements form (XSD and DTD)
Connector and Metadata wizard – Completing the Select Rule Types form (XSD)
Connector and Metadata wizard – Completing the Add Substitute Rules form
Viewing JavaBean properties
About importing JavaBeans with the Connector and Metadata wizard
Pega Document Scanning
Using the Image Viewer
Integration Services landing page
Service Wizard
Service Wizard: Select Service Purpose
Service Wizard: Provide Service Details — Select Work Properties
Service Wizard: Provide Service Details — Select Flow Actions
Service Wizard: Provide Service Details — Select Activity Class
Service Wizard: Provide Service Details — Select Service Activities
Service Wizard: Provide Service Details — Select Service Parameters
Service Wizard: Provide Service Details — Select Data Class
Service Wizard: Customize Service Data
Service Wizard: Select Service Resources
Service Wizard: Configure Data Records
Service Wizard: Resolve Duplicates
Service Wizard: Review and Save
Viewing in-progress and completed integration wizards
Robotic automation
Automation configuration
Configuring robotic desktop automation
Robotic desktop automation error processing
Robotic desktop automation
Adding an automation to a flow
Configuring robotic process automation
Configuring the heartbeat interval
Virtual machine registration
Configuring Pega Platform to register virtual machines
Obtaining information from robotic automations
Robotic process automation error handling
Robotic process automation
Supporting rules
Integration-Connectors category
About Connect BPEL rules
Connect BPEL rules – Completing the Create, Save As, or Specialization form
Connect BPEL form - Completing the Deployment tab
Connect BPEL form – Completing the Methods tab
About Connect Cassandra rules
Connect Cassandra rules - Completing the Create, Save As, or Specialization form
Connect Cassandra form - Completing the Service tab
Connect Cassandra form - Completing the Mappings tab
About Connect CMIS rules
Creating a Connect CMIS rule
Configuring the connection for a Connect CMIS rule
Atom Servers
About SOAP Server data instances
About Connect dotNet rules
Connect dotNet rules – Completing the Create, Save As, or Specialization form
Connect dotNet rules – Completing the Faults tab
Connect dotNet form – Completing the Request tab
Connect dotNet form – Completing the Response tab
Connect dotNet form – Completing the Service tab
dotNet Connector Form – Completing the Advanced tab
dotNET Connector rules – Understanding the WSDL tab
About EJB connector rules
Connect EJB rules - Completing the New or Save As form
Connect EJB form – Completing the Create tab
Connect EJB form – Completing the Remote tab
Connect EJB form - Completing the Service tab
More about Connect EJB rules
About Connect File rules
Connect File rules - Completing the Create, Save As, or Specialization form
Connect File rules - Completing the Service tab
More about Connect File rules
About Connect HBase rules
Connect HBase rules - Completing the Create, Save As, or Specialization form
Connect HBase form - Completing the Service tab
Connect HBase form - Completing the Mappings tab
About Connect HTTP rules
Connect HTTP Rules – Completing the Create, Save As, or Specialization form
Connect HTTP form – Completing the Request tab
Connect HTTP form – Completing the Response tab
Connect HTTP form – Completing the Service tab
More about Connect HTTP rules
About Connect Java rules
Connect Java rules - Completing the Create, Save As, or Specialization form
Connect Java form – Completing the Constructor tab
Connect Java form – Completing the Method tab
Connect Java form – Completing the Service tab
More about Connect Java rules
About Connect JCA rules
Connect JCA rules - Completing the Create, Save As, or Specialization form
Connect JCA rules - Completing the Input tab
Connect JCA rules - Completing the Output tab
Connect JCA rules – Completing the Service tab
More about Connect JCA rules
About Connect JMS rules
Connect JMS rules – Completing the Create, Save As, or Specialization form
Connect JMS form – Completing the Request tab
Connect JMS form – Completing the Response tab
Connect JMS form – Completing the Service tab
More about Connect JMS rules
About Connect MQ rules
Connect MQ Rules – Completing the Create, Save As, or Specialization form
Connect MQ form - Completing the Service tab
Connect MQ form – Completing the Request tab
Connect MQ form – Completing the Response tab
More about Connect MQ rules
Connect REST rules
Creating Connect REST rules
Identifying the external system for a Connect REST rule
Mapping the request and response data for Connect REST rules
Mapping the data for a GET request for a Connect REST rule
Mapping the data for a GET response for a Connect REST rule
Mapping data for a PATCH request for a Connect REST rule
Mapping data for a PATCH response for a Connect REST rule
Mapping the data for a POST request for a Connect REST rule
Mapping the data for a POST response for a Connect REST rule
Mapping the data for a PUT request for a Connect REST rule
Mapping the data for a PUT response for a Connect REST rule
Mapping the data for a DELETE request for a Connect REST rule
Mapping the data for a DELETE response for a Connect REST rule
Connect REST calling activity
Asynchronous execution by the Pega-IntScvs agents
Working with SSL-enabled endpoints
JSON mapping for special characters
About Connect SAP rules
Connect SAP rules - Completing the Create, Save As, or Specialization form
SAP Connector rules – Completing the Faults tab
SAP Connector form – Completing the Request tab
SAP Connector Form – Completing the Response tab
Connect SAP form – Completing the Service tab
SAP Connector Form – Completing the Advanced tab
SAP Connector rules – Understanding the WSDL tab
More about SAP connector rules
About Connect SAPJCo rules
Connect SAPJCo rules - Completing the Create, Save As, or Specialization form
Connect SAPJCo form – Completing the Constructor tab
Connect SAPJCo form – Completing the Method tab
Connect SAPJCo form – Completing the Service tab
More about Connect SAPJCo rules
About Connect SOAP rules
Connect SOAP rules – Completing the Create, Save As, or Specialization form
SOAP Connector rules – Completing the Faults tab
SOAP Connector form – Completing the Request tab
Connect SOAP form - Completing the Response tab
Connect SOAP form – Completing the Service tab
SOAP Connector form – Completing the Advanced tab
SOAP Connector rules – Understanding the WSDL tab
More about SOAP connector rules
About Connect SQL rules
Connect SQL rules - Completing the Create, Save As, or Specialization form
Connect SQL form - Completing the Browse tab
Connect SQL form - Completing the Delete tab
Connect SQL form - Completing the Open tab
Connect SQL form - Completing the Save tab
Connect SQL form - Data Mapping
More about Connect SQL rules
RDB SQL rules (Rule-RDB-SQL)
Using attachments with REST, SOAP, SAP, dotNet, and HTTP connectors and services
Handling connector exceptions
About Connect Robot rules
Integration Mapping category
About eForm file rules
eForm File rules - Completing the Create or Save As form
eForm File rules - Completing the Main tab
More about eForm File rules
Map eForm rules
Map eForm rules - Completing the Create, Save As, or Specialization form
Map eForm Rules - Completing the Mapping tab
Map eForm rules - Completing the Pages & Classes tab
More about Map eForm rules
Map Structured rules
Map Structured rules - Completing the Create, Save As, or Specialization form
Map Structured rules - Completing the Mapping tab
Map Structured rules - Completing the Pages & Classes tab
More about Map Structured rules
Parse Delimited rules
Parse Delimited rules - Completing the Create, Save As, or Specialization form
Parse Delimited form - Completing the Parse Rules tab
More about Parse Delimited rules
Unit testing a Parse Delimited rule
About Parse Normalize rules
Parse Normalize rules - Completing the Create, Save As, or Specialization form
Parse Normalize form - Completing the Parse tab
Parse structured rules
Creating a parse structured rule
Security tab on the Parse Structured form
Steps tab on the Parse Structured form
Unit testing a Parse Structured rule
Parse XML rules
Parse XML rules - Completing the Create, Save As, or Specialization form
Parse XML form - Completing the Mapping tab
Parse XML rules - Completing the Pages & Classes tab
Parse XML form - Completing the XML tab
More about Parse XML rules
Unit testing a Parse XML rule
Parse XML form - Completing the Mapping tab (Version 5.4 fields)
Parse XML form - Completing the Validate tab
XML Stream rules
XML rules - Completing the Create, Save As, or Specialization form
XML Stream form - Completing the Mapping tab
XML Stream form - Completing the Pages & Classes tab
XML Stream form - Completing the XML tab
More about XML Stream rules
Integration Resources category
Connect Request Processor data instances
Connect Request Processor – Completing the New or Save As form
Connect Request Processor form - Dequeuing Options tab
Connect Request Processor form - Queuing Options tab
Integrating with an email provider
Exploring email configurations
Viewing email accounts
Viewing email listeners
Viewing service email rules
Creating an email integration
Creating an email account
Creating an email account in Dev Studio
Creating an email listener
Configuring email listener routing
Configuring email listener processing
Creating a Service Email rule
Configuring service processing for Service Email rules
Configuring the request for Service Email rules
Configuring the response for Service Email rules
More about Service Email rules
Unit testing a Service Email rule
Using email integrations
Managing email integrations
Autoreply message filtering
Specifying additional patterns for filtering out autoreply messages
Best practices for optimizing email listener performance
Restarting the email listener
Throttling during email processing
Troubleshooting email listeners
Deleting an email account
Email conversations
Email-based work processing
Sending encrypted email
Sending digitally signed email
Automatic resends
Working with SSL-enabled endpoints
Initial Email Account instances (Data-EmailAccount)
Correspondence rules and email
Integrating with an email provider
Using file listeners
Creating a file listener
Where, when, and whether file listeners start
Configuring file listener processing
Configuring file listener error processing
Associating listeners with node types
Best practices for processing files using the file listener
Troubleshooting file listeners
About FTP Server data instances
FTP Servers – Completing the New or Save As form
FTP Server form – Completing the Environment tab
More about FTP server data instances
Integration systems
Creating an integration system
Changing an integration system icon
Deleting an integration system
About Interface Generator data instances
Interface Generator form - About the Name
Interface Generator form – Understanding the Definition tab
About JCA Resource Adapter data instances
JCA Resource Adapter form – Completing the New or Save As form
JCA Resource Adapter form – Completing the Connection tab
JCA Resource Adapter form - Completing the ConnectionSpec tab
JCA Resource Adapter form – Completing the MetaData tab
About JMS Listener data instances
JMS Listener data instances – Completing the New or Save As form
JMS Listener form – Completing the Listener Properties tab
JMS Listener form – Completing the JMS Properties tab
More about JMS Listener data instances
About JMS MDB Listener data instances (Data-Admin-Connect-JMSMDBListener)
JMS MDB Listener data instances – Completing the New or Save As form
JMS MDB Listener form – Completing the Listener Properties tab
JMS MDB Listener form – Completing the JMS Properties tab
More about JMS MDB Listener data instances
About JMS Producer Model data instances
JMS Producer Model data instances – Completing the New or Save As form
JMS Producer Model form – Completing the Model tab
About JMS Transport data instances
JMS Transport data instances – Completing the New or Save As form
JMS Transport form – Completing the JMS tab
JMS Transport form – Completing the Request tab
About JNDI Server data instances
JNDI Server data instances – Completing the New or Save As form
JNDI Server form – Completing the Environment tab
JNDI Server form – Completing the Custom Properties tab
More about JNDI Server data instances
About MQ Listener data instances
MQ Listeners – Completing the New or Save As form
MQ Listener form – Completing the Listener Properties tab
MQ Listener form - Completing the Properties tab
More about MQ Listener data instances
About MQ Server data instances
MQ Servers – Completing the New or Save As form
MQ Server form – Completing the Environment tab
Service Request Processor data instances
Service Request Processor – Completing the New or Save As form
Service Request Processor form – Queuing Options tab
Service Request Processor form – Dequeuing Options tab
About Service Package data instances
Creating a service package
Service Package form – Completing the Context tab
Service Package form – Completing the Pooling tab
More about Service Package data instances
Integration-Services category
About Service BPEL rules
Service BPEL rules - Completing the Create, Save As, or Specialization form
Service BPEL form - Completing the Methods tab
Service BPEL form - Completing the Deployment Tab
More about Service BPEL rules
About Service COM rules
Service COM rules - Completing the Create, Save As, or Specialization form
Service COM form - Completing the Service tab
Service COM form - Completing the Parameters tab
Service COM form - Completing the Exceptions tab
More about Service COM rules
Service dotNet rules
Service dotNet rules - Completing the Create, Save As, or Specialization form
Service dotNet form - Completing the Service tab
Service dotNet form - Completing the Request tab
Service dotNet form - Completing the Response tab
Service dotNet form - Completing the Faults tab
Service dotNet form - Completing the XML Page tab
More about Service dotNet rules
Unit testing a Service dotNet rule
About Service EJB rules
Service EJB rules - Completing the New or Save As form
Service EJB form - Completing the Service tab
Service EJB form - Completing the Parameters tab
Service EJB form - Completing the Exceptions tab
More about Service EJB rules
Unit testing a Service EJB rule
Service File rules
Service File rules - Completing the Create, Save As, or Specialization form
Service File form - Completing the Service tab
Service File form - Completing the Method tab
Service File form - Completing the Request tab
More about Service File rules
Unit testing a Service File rule
Service HTTP rules
Service HTTP rules - Completing the Create, Save As, or Specialization form
Service HTTP form - Completing the Service tab
Service HTTP form - Completing the Request tab
Service HTTP form - Completing the Response tab
More about Service HTTP rules
Service Java rules
Service Java rules - Completing the Create, Save As, or Specialization form
Service Java form - Completing the Service tab
Service Java form - Completing the Parameters tab
Service Java form - Completing the Exceptions tab
More about Service Java rules
Service JMS rules
Service JMS rules - Completing the Create, Save As, or Specialization form
Service JMS form - Completing the Service tab
Service JMS form - Completing the Request tab
Service JMS form - Completing the Response tab
More about Service JMS rules
Unit testing a Service JMS rule
Service JSR94 rules
Service JSR94 rules - Completing the Create, Save As, or Specialization form
Service JSR94 form - Completing the Service tab
Service JSR94 form - Completing the Request tab
Service JSR94 form - Completing the Response tab
Service JSR94 form - Completing the Exceptions tab
More about Service JSR94 rules
Unit testing a Service JSR 94 rule
Service MQ rules
Service MQ rules - Completing the Create, Save As, or Specialization form
Service MQ form - Completing the Service tab
Service MQ form - Completing the Request tab
Service MQ form - Completing the Response tab
More about Service MQ rules
Unit testing a Service MQ rule
Service Portlet rules
Service Portlet rules - Completing the Create, Save As, or Specialization form
Service Portlet form - Completing the Portlet tab
Service Portlet form - Completing the Portlet 2.0 JSR-286 tab
More about Service Portlet rules
Service REST rules
Creating a Service REST rule
Defining resource and processing details for a Service REST rule
Defining resource and processing details for a Service REST rule created prior to
Pega Platform
8.4
Service REST methods
Creating a request for GET and DELETE methods by using an activity implementation
Creating a request for GET and DELETE methods by using an automation implementation
Creating a request for POST, PUT, and PATCH methods by using an activity implementation
Creating a request for POST, PUT, and PATCH methods by using an automation implementation
Creating a response for Service REST methods by using an activity implementation
Creating a response for Service REST methods by using an automation implementation
OpenAPI tab
More about Service REST rules
Endpoint configuration upgrade
Upgrading REST connectors with URLs not sourced from a Global Resource Setting
Upgrading REST connectors sourced from a Global Resource Setting
Upgrading REST connectors with URLs that only contain parameters
Distinct URI specification for service REST rules
URI template component requirements
Service REST monitoring
Configuring Service REST rule monitoring
Viewing Service REST monitoring results
Immediately purging Service REST invocation history
Automatically purging invocation history
Service SAP rules
Service SAP rules - Completing the Create, Save As, or Specialization form
Service SAP form - Completing the Service tab
Service SAP form — Completing the Request tab
Service SAP form - Completing the Response tab
Service SAP form - Completing the Faults tab
Service SAP form - Completing the XML Page tab
Service SAP form - Completing the Advanced tab
Service SAP form - Working with the Test Cases tab
More about Service SAP rules
Unit testing a Service SAP Rule
Service SAPJCo rules
Service SAPJCo rules - Completing the Create, Save As, or Specialization form
Service SAPJCo form - Completing the Service tab
Service SAPJCo form - Completing the Parameters tab
Service SAPJCo form - Completing the Exceptions tab
More about Service SAPJCo rules
Service SOAP rules
Service SOAP rules - Completing the Create, Save As, or Specialization form
Service SOAP form - Completing the Service tab
Service SOAP form — Completing the Request tab
Service SOAP form - Completing the Response tab
Service SOAP form - Completing the Faults tab
Service SOAP form - Completing the XML Page tab
Service SOAP form - Completing the Advanced tab
Service SOAP form - Working with the Test Cases tab
More about Service SOAP rules
About Service Type data instances
Service Type data instances – Completing the Save As form
Service Type form - Completing the Deployment tab
Service Type form - Completing the Listener tab
How to call through Java-based services
How to provide test data when unit testing service rules
About Class Generator data instances
About Connect Generator data instances
About Metadata Converter data instances
Metadata Converter – Completing the New or Save As form
Metadata Converter form - Completing the Definition tab
Endpoint security for CORS policies
Cross Origin Resource Sharing (CORS)
Cross Origin Resource Sharing - Completing the Create or Save As form
About Registry Java Property Transform data instances
Registry Java Property Transform data instances - Completing the Save As form
Registry Java Property Transform form – Completing the Entry tab
Kafka data instances
Creating a Kafka configuration instance
SMS accounts
Creating an SMS account
Configuring dynamic references to external systems by using the Global Resource Settings feature
Fields that support the Global Resource Settings syntax
Mobile solutions
Mobile features overview
Designing applications for mobile use
Learning about user interface design guidelines for mobile apps
Developing mobile apps
Setting up mobile apps
Adding content to mobile apps
Designing a new mobile list page
Adding a search gadget
Adding a floating action button
Adding items to the menu bar
Previewing mobile apps
Enhancing mobile apps
Applying a custom theme to mobile apps
Customizing the icon and launch screen of mobile apps
Customizing the image assets of mobile apps
Customizing the theme of mobile apps
Engaging mobile users with push notifications
Configuring push notifications for Android apps
Configuring push notifications for iOS apps
Sending push notifications with the push console
Tracking mobile users based on geolocation data
Generating native mobile apps
Preparing mobile apps for signing
Understanding certificate sets for Android
Obtaining a signing certificate for Android apps
Creating an Android certificate set
Understanding certificate sets for iOS
Obtaining an App ID for iOS apps
Obtaining a signing certificate for iOS apps
Obtaining a mobile provisioning profile for iOS apps
Creating an iOS certificate set
Creating an unsigned iOS certificate set
Signing iOS apps locally
Generating installation packages
Troubleshooting mobile apps
Troubleshooting an iOS mobile app
Device logs
Retrieving device logs
Viewing device logs
Working with offline-enabled mobile apps
Designing apps for offline mode
Learning about guidelines for designing offline-enabled mobile apps
Learning about guidelines for designing user interface for offline-enabled apps
Enabling case processing in offline-enabled mobile apps
Understanding offline features
Data synchronization in offline mode
Customizing synchronization indicators
Configuring time-outs for synchronization indicators
Data synchronization JavaScript API
Offline case packaging optimization during synchronization
Propagating application model changes to offline-enabled mobile apps
Flow processing in offline mode
Offline-supported flow processing features
Actions in offline mode
Local actions in offline mode
Offline-supported actions
Controls in offline mode
Offline-supported controls
Attach content support in offline mode
Packaging a signature after the work object is resolved
When rules in offline mode
Decision tables in offline mode
Decision trees in offline mode
Validate rules in offline mode
Offline validation API
Function rules in offline mode
Offline-supported function rule libraries
Accessing a list of supported JavaScript functions for a utility library
Data transforms in offline mode
Offline data transform API
Enabling online-only features in offline mode
JavaScript API for running any activity in offline mode
JavaScript API for scheduling any activity in offline mode
Securing mobile apps
Selecting an authentication service
Increasing mobile app security with time-outs and native locks
Making mobile apps available to users
Distributing mobile apps
Adding a banner for mobile app download
Downloading a mobile app in a binary file
Publishing the QR code
Performing advanced mobile app development tasks
Mobile app branding and layout
Configuring a layout for the reuse of a web portal
Configuring the bottom bar
Customizing fonts for the native mobile app components
Uploading custom font files
Modifying the fonts settings file for font customization
Modifying the application skin for font customization
Replacing the icon font in imported applications
Converting the icon font for imported applications
Uploading custom font files
Creating the font settings file for imported applications
Modifying the font settings file for imported applications
Configuring search in mobile apps
Native search capability in mobile apps
Configuring categories for mobile search
Configuring a search action in a mobile app
Configuring direct authentication against an external OIDC server for Pega Infinity Mobile Client
Custom parameters for direct authentication against an external OIDC server
Configuring the client registration for
Pega Mobile Client
authentication against an external OIDC server
Enabling the mobile authentication service for
Pega Mobile Client
authentication against an external OIDC server
Custom modules
Preparing custom modules for upload
Configuring application package-based mobile app
Pega Mobile SDK
Setting up application package options for Android
Setting up application package options for iOS
Uploading binary files for an iOS application package
Uploading an icon for an application package
Mobile certificates page
Selecting a specific client version
Setting up an alternative host
Supporting rules
UI Gallery landing page
Reusing UI Gallery examples in an application
Notification channels landing page
About Binary File rules
Binary File rules - Completing the Create, Save As, or Specialization form
Binary File rules - Completing the Main tab
More about Binary File rules
About Broadcast data instances
Broadcast data instances - Completing the New or Save As form
Broadcast form - Completing the Message tab
About Calendar data instances
Calendars – Completing the Create New or Save As form
Calendar form – Completing the Schedule tab
More about Calendar data instances
About Image Content data instances
Image Library landing page
Image Content form - Completing the New or Save As form
Image Content data instances - Completing the Main tab
More about Image Content data instances
About SpellChecker Properties data instances
Initial Spellchecker Properties data instances (Data-SpellChecker-Properties)
Spellchecker Property data instances - Completing the New or Save As form
Spellchecker Properties form – Completing the Dictionaries tab
Spellchecker Properties form - Completing the Properties tab
More about Spellchecker Properties data instances
About Static Content Bundle rules
Static Content Bundle rules - Completing the New or Save As form
Static Content Bundle rules - Completing the Definition tab
More about Static Content Bundle rules
HTTP compression and timeout settings
Stream processing of JSP tags
JavaServer Pages tags
Introducing JavaServer Page tags
acDataSource JavaServer Page tag
assert JavaServer Page tag
autoComplete JavaServer Page tag
binaryfile JavaServer Page tag
Converting from directives to JavaServer Page tags
JSP tag — chart
choose JavaServer Page tag
contentURL JavaServer Page tag
dataGrid JavaServer Page tag
dsField JavaServer Page tag
dsFields JavaServer Page tag
file JavaServer Page tag
forEach JavaServer Page tag
include JavaServer Page tag
listView JavaServer Pages tag
lookup JavaServer Page tag — lookup
onlyonce JavaServer Page tag
p:r JavaServer Page tag
reference JavaServer Page tag
save JavaServer Page tag
static JavaServer Page tag
URL JavaServer Page tag
when JavaServer Page tag
withEmbedded JavaServer Page tag
withPage JavaServer Page tag
withReference JavaServer Page tag
withTarget JavaServer Page tag
More about JavaServer Page tags
Reference properties indirectly in JSP tags
Converting from directives to JavaServer Pages tags
Text File rules
Text File rules - Completing the Create, Save As, or Specialization form
Text File rules - Completing the Main tab
Text File rules - JavaScript and CSS validation
More about Text File rules
Security
Assessing your application using the
Security Checklist
Implementing security guidelines for test environments
Authentication
Creating an authentication service
Authentication services
Configuring login authentication with basic credentials
Mapping operator information for a basic authentication service
Specifying preauthentication and postauthentication activities for a basic authentication service
Requiring reauthentication for new and expired sessions for a basic authentication service
Configuring operator provisioning for a basic authentication service
Enforcing policies from the Security Policies landing page
Activating your basic authentication service
Configuring SSO login authentication with a SAML identity provider
Configuring the identity provider for a SAML SSO authentication service
Mapping operator information for a SAML SSO authentication service
Specifying preauthentication and postauthentication activities for a SAML SSO authentication service
Requiring reauthentication for new and expired sessions for a SAML SSO authentication service
Configuring operator provisioning for a SAML SSO authentication service
Overriding the service provider settings for a SAML SSO authentication service
Enforcing policies from the Security Policies landing page
Activating your SAML SSO authentication service
Configuring custom or Kerberos login authentication
Specifying the binding parameters for a custom authentication service
Identifying the operator for custom authentication services
Specifying the binding parameters for a Kerberos authentication service
Identifying the operator for Kerberos authentication services
Configuring the challenge behavior for custom or Kerberos authentication services
Configuring the time-out behavior for custom or Kerberos authentication services
Mapping additional operator information for custom or Kerberos authentication services
Configuring SSO login authentication with an OpenID Connect identity provider
Configuring the identity provider for an OpenID Connect SSO authentication service
Configuring advanced features for an OpenID Connect SSO authentication service
Mapping operator information for an OpenID Connect SSO authentication service
Specifying preauthentication and postauthentication activities for an OpenID Connect SSO authentication service
Requiring reauthentication for new and expired sessions for an OpenID Connect SSO authentication service
Configuring operator provisioning for an OpenID Connect SSO authentication service
Enforcing policies from the Security Policies landing page
Activating your OpenID Connect SSO authentication service
Configuring login authentication for an anonymous operator
Configuring the anonymous operator for an anonymous authentication service
Specifying preauthentication and postauthentication activities for an anonymous authentication service
Mapping operator information for an anonymous authentication service
Activating your anonymous authentication service
Configuring an application to use an anonymous authentication service
Configuring a token credentials authentication service
Mapping operator information for a token credentials authentication service
Specifying preauthentication and postauthentication activities for a token credentials authentication service
Requiring reauthentication for new and expired sessions for a token credentials authentication service
Activating your token credentials authentication service
More about authentication services
Testing login authentication services
Authentication services and rule availability
Authentication services and security policies
Application URL patterns for various authentication service types
Application URL alias
Adding an application URL alias
Configuring login policies such as multi-factor authentication, CAPTCHA, and attestation
Using the login policies settings
Security policies settings
Security policies
Enabling, disabling and deleting operators
Viewing locked and disabled operators
Disabling an operator
Enabling operators
Unlocking an operator
Deleting operators
Authenticating requests in services
Creating an authentication profile
Authentication profiles
Configuring a Basic authentication profile
Configuring an NTLM authentication profile
Configuring an OAuth 1.0a authentication profile
Configuring an OAuth 2.0 authentication profile
Configuring an Amazon Web Services authentication profile
Configuring a Microsoft Azure authentication profile
Setting up an OAuth 2.0 client registration
OAuth 2.0 client registrations
Creating and configuring an OAuth 2.0 client registration
Setting up an OAuth 2.0 provider
OAuth 2.0 providers
Creating and configuring an OAuth 2.0 provider
Setting up an OAuth 1.0 client
OAuth 1.0 clients
Creating and configuring an OAuth 1.0 client
Creating a WS-Security profile data instance
Web Service Security profile
Defining outbound SOAP messages for WS-Security profile data instances
Defining inbound SOAP messages for WS-Security profile data instances
Defining keystores for WS-Security profile data instances
Creating a web service policy data instance
Web service policy data instances
Creating an identity mapping data instance
Identity mapping
Securing your application for mashup communication
Authorization
Role-based access control
Operators (users)
Creating an operator ID
Adding an operator by using the organizational chart
Defining operator contact information and application access
Fields for operator contact information and application access
Defining operator work groups, work queues, and schedules
Fields for operator teams, work queues, and schedules
Defining security information for an operator
Learning about access groups
Viewing access groups and operators
Creating an access group
Assigning work pools to an access group
Work pools and access groups
Granting portal access to an access group
Configuring case type access
Viewing authorizations for case type items in a single access group
Editing authorizations for case type items in a single access group
Viewing authorizations for case type items in all access groups
Viewing authorizations for case type flows and flow actions in a single access group
Editing authorizations for case type flows and flow actions in a single access group
Access Manager
Configuring tools access
Application tools
Viewing tools authorization for a single access group
Viewing tools authorizations in all access groups
Editing tools authorization for a single access group
Configuring advanced settings for access groups
Configuring security settings for an access group
Defining a run-time configuration for an access group
Defining advanced offline configuration for an access group
Defining a design-time configuration for an access group
Creating an application ID data instance
Application ID data instances
Completing the Security tab of the application ID form
Granting portal access to an access group
Updating access groups by submitting a request to an active instance
Managing access roles
Viewing access roles
Creating an access role by using the rule form
Creating an access role by using the access role dialog box
Adding a role to an access group
Configuring an access role
Standard access roles
Controlling role evaluation for access groups
Viewing operations available to access role assignees
Viewing activities available to access role assignees
Using advanced settings for access roles
Understanding Access of Role to Object rules
Creating an Access of Role to Object rule
Defining permissions by using Access of Role to Object rules
Specifying privileges for an Access of Role to Object rule
Defining access settings for an Access of Role to Object rule
Listing Access of Role to Object rules
Standard Access of Role to Object rules
Understanding Access Deny rules
Completing the New or Save As form for Access Deny rules
Completing the Security tab for Access Deny rules
More About Access Deny rules
Understanding Access When rules
Completing the New or Save As form for Access When rules
Completing the Conditions tab for Access When rules
Implementing advanced settings for Access Deny rules
Viewing generated Java code of Access When rules
Using setting rules
Creating a setting
Configuring a setting
Understanding role permissions and privileges in Access Manager
Creating a privilege
Granting privileges to an access role
Standard privileges
Granting privileges by using Access Manager
Reviewing user privileges for a role by using Access Manager
Customizing the Access Manager privileges tab
Turning on privilege inheritance for access roles
Privilege inheritance for access roles
Requiring a privilege for a rule
Viewing the roles that have a privilege
Creating a property security rule
Property security rules
Configuring a property security rule
Attribute-based access control
Creating an access control policy
Access Control Policy rule
Masking property visibility for users
Creating an access control policy condition
Access Control Policy Condition rule
Using security attributes markings
Storing of operator security attributes
Using One Of and All Of conditions
Managing access control policy condition performance
Managing hierarchical attributes
Reviewing access control policies
Verifying access control policies
Understanding Discovery features for access control policies
Customizing of Discovery gadgets
Enabling discovery features for access control policies
Adding a Discovery gadget to a customized user interface
Enabling attribute-based access control
Client-based access control
Defining client-based access control rules
Creating a client-based access control rule
Configuring a client-based access control rule
Configuring client-based access control for a non-Pega data source
Specifying a client-based access control rule on an abstract class
Auditing
Tracking and auditing changes to data
Enabling security auditing for a data class or rule type
Customizing the memo text for an audited rule
Auditing changes to aggregate properties
Tracking and auditing actions by developers and users
Selecting a security event to monitor
Adding a custom security event
Displaying the Security Audit Log
Tracking login failures by using a report
Monitoring and responding to security alerts
Security operations
Searching for security vulnerabilities in rules
Analyzing security vulnerability search results
Security guidelines for custom HTML
Regular Expression rules
Creating a regular expression rule
Testing regular expressions
Encrypting application data
Configuring the platform cipher
Viewing keystore usage history in the platform cipher
Forcing data key rotation in the platform cipher
Encrypting application data by using a custom key management service
Encrypting system data by using a custom key management service
Configuring a custom cipher
Encrypting the storage stream (BLOB)
Storage stream encryption of selected classes
Creating a keystore for application data encryption
Keystores
Importing an X.509 certificate
Configuring an Amazon Key Management Service (KMS) key rotation
Configuring a Microsoft Azure Key Vault keystore
Configuring a HashiCorp Vault keystore
Configuring a Google Cloud KMS keystore
Configuring a keystore by uploading a file
Configuring a keystore by using a file reference
Configuring a keystore by using a URL reference
Configuring a keystore by using a data page reference
Creating a data page for a keystore
Creating a data page activity for a keystore
Changing the default keystore caching settings
Creating a token profile
Token profile data instance
Creating a generation JSON Web Token profile
Configuring activities to generate a JSON Web Token
Previewing the JSON Web Token profile
Creating a processing JSON Web Token profile
Configuring an activity to process a JSON Web Token
Mitigating common (OWASP Top 10) security vulnerabilities
Enabling and configuring Cross-Site Request Forgery settings
Enabling cross-site request forgery support
Using HTTP response headers
Creating a custom HTTP response header
Testing a custom HTTP response header
Defining cross-origin resource sharing (CORS) policies
Creating a cross-origin resource sharing (CORS) policy
Mapping an endpoint to a cross-origin resource sharing (CORS) policy
Securing your application with a content security policy
Content security policies
Creating a content security policy
Content security policy directives
Allowing a website as an exception to a content security policy directive
Configuring the deserialization filter
Java deserialization
Configuring the Java injection check
Managing your system
System administration
Keeping Pega Platform current
Performing application validation after upgrades
Running the Update Existing Applications utility
Identifying rule conflicts
Identifying missing database tables
Revalidating rules after an upgrade
Upgrading cases and followers
Upgrading cloned tables after an upgrade
Updating cloned tables from Dev Studio
Updating cloned tables from the command line
Upgrading Get Next Work performance
Finding deprecated rules in sections
Applying hotfixes to an on-premises system
Obtaining a hotfix catalog
Obtaining hotfixes
Scanning the system for hotfixes
Scanning the system from the user interface
Scanning the system by submitting a request to an active instance
Scanning the system by using a direct connection to the database
Obtaining hotfix packages
Preparing to install hotfixes
Reviewing hotfixes
Applying database schema changes
Creating an SQL script from the user interface
Creating an SQL script by submitting a request to an active instance
Creating an SQL script by using a direct connection to the database
Installing hotfix packages
Installing hotfixes from the user interface
Installing hotfixes by submitting a request to an active instance
Installing hotfixes by using a direct connection to the database
Rolling back hotfixes
Rolling back hotfixes from the user interface
Rolling back hotfixes by submitting a request to an active instance
Rolling back hotfixes by using a direct connection to the database
Committing hotfixes
Committing hotfixes from the user interface
Committing hotfixes by submitting a request to an active instance
Committing hotfixes by using a direct connection to the database
Verifying hotfix installation results
Moving applications between systems
Preparing to package and move applications
Packaging your application in a product rule
Creating a product rule that does not include associated data by using the Application Packaging wizard
Creating a product rule of test case data by using the Package Work wizard
Creating a product rule that includes associated data by using the Create menu
Editing a product rule
Specifying the content of a product rule
Listing product dependencies
Specifying product rule deployment options
Adding historical information to a product rule
Previewing and creating the archive file for a product rule
Packaging an application from
App Studio
Exporting an application, product rule, or ruleset to an archive or repository by using the Export wizard
Importing rules and data by using the Import wizard
Ensuring that users migrate applications with a pipeline by restricting the Import wizard
Pre-import and post-import collections
Creating pre-import steps
Creating post-import steps
Pre-import action properties
Post-import action properties
Selecting a file to import
Setting advanced mode and reviewing the archive contents
Updating dependent applications
Viewing and applying schema changes
Inserting new instances by importing an archive
Addressing older instances in an import archive
Automatically populating new columns in existing tables
Scheduling indexes for population
Resolving pre-existing rule conflicts
Changing the built-on version of an application to the current version
Updating dependent applications with the latest versions of built-on applications
Using restore points to enable error recovery
Creating a restore point
Listing restore points
Getting detailed information about a restore point
Rolling back to a restore point
Deleting a restore point
Distributing product rules to multiple systems by using the Product Migration wizard
Creating a system security data instance
System security data instances
Creating a system target data instance
Starting the Product Migration wizard
Selecting the product and target systems
Reviewing command-line migration logs and work item status
Distributing an application from command line
Using service-enabled scripting and the prpcServiceUtils tool
Service-enabled system management log files
Retrieving service-enabled job status
Using scripting with direct connection to the database and the prpcUtils tool
Exporting rules and data from the command line
Exporting rules and data by submitting a request to an active instance
Exporting rules and data by using a direct connection to the database
Importing rules and data from the command line
Importing rules and data by submitting a request to an active instance
Importing rules and data by using a direct connection to the database
Generating a DDL file of schema changes that are referenced from an archive file
Migrating products and applications from the command line
Installing the command-line tool
Configuring the source and target systems
Migrating an application or product by using the productMigration command-line tool
Resolving conflicts when importing an archive by using the productMigration command-line tool
IBM Db2 for z/OS: Preparing to import an application with schema changes and a separate DB-Admin-DB-Name
Reviewing migration results
Configuring your system
Classifying nodes
Node types for on-premises environments
Node types for
Pega Cloud Services
environments
Node types for client-managed cloud environments
Assigning node types to nodes for on-premises environments
Clustered deployment
Balancing HTTP traffic across multiple server nodes
Setting the outbound port for cluster communication
Changing node settings by modifying the prconfig.xml file
Downloading and viewing the prconfig.xml file for a specific node
Changing a prconfig setting value for a subset of nodes
System node data instances in on-premses systems
System Node descriptions in on-premises systems
Updating the system node description in on-premises systems
Identifying active nodes
Configure system settings from Dev Studio
System general landing page
Setting application-specific configuration settings with configuration definitions and configuration bundles
Creating a configuration definition
Editing a configuration definition
Temporarily overriding a configuration definition value
Reverting to a default configuration definition value
Creating a configuration bundle
Editing a configuration bundle
Exporting a Configuration Bundle to a JSON file
Loading a configuration bundle onto an application
Configuring production-level-specific run-time settings by using application settings rules
Creating an application setting
Reference application settings in rules
Categorizing application settings
Defining production-level application setting values
Using dynamic system settings
Creating a dynamic system setting
Editing a dynamic system setting
Java methods for dynamic system settings and application settings
Dynamic system settings data instances
Updating dynamic system settings by submitting a request to an active instance
Updating dynamic system settings by using a direct connection to the database
Downloading the system state by using a REST API
Downloading the system state for a cluster or node
Configuring the online help URL
Configuring the path to an external log viewer
Configuring the public link URL
Configuring Java compiler access to information
Configuring the system name
Changing the system name from the user interface
Changing the system name by using a direct connection to the database
Specifying system-wide security parameters by using system data instances
Specifying the production level
Specifying the environment name
Specifying the lock time-out
Specifying the number of concurrent sessions
Project Management Framework (PMF)
Database data instances
System settings in Admin Studio
Viewing system settings in on-premsises systems for troubleshooting
Changing the storage destination for the import data wizard, BIX, and file listeners
Managing rules
Importing the legacy ruleset from the Resource Kit
Comparing versions of a rule
Comparing rule versions on the History tab
Comparing rule versions with the rule compare utility
Renaming classes or rulesets during an archive import
Replacing a string in rulesets
Temporary files
Metrics and system health
Performance
System Performance landing page
Identifying rules not using lightweight lists
Viewing the JVM in use on your server
Verbose logging of garbage collection operations
Garbage collection and memory management
Improving performance by archiving cases
Creating an archival policy
Scheduling the case archival process
Reviewing archived case data
Managing your case archival process
Monitoring the progress of your case archival process
Configuring archive settings
Configuring purge cycle settings
Improving response time by caching rules with the Static Assembler
Static content
Deploying static content to an edge server
Caching
Static content cache
RuleFileServlet servlet
HTTP compression of static files
Tools
Tracking system utilization for a requestor session with Performance Analyzer
Using the summary display of Performance Analyzer
Tracking rule utilization for a requestor session with Performance Profiler
Profiling your requestor session
Interpreting Performance Profiler results
Profiling all processing on a node
Profiling another requestor
Interpreting the summary chart in Performance Analyzer
Viewing statistics for services in the SERVICES-PAL log
Using the full details display of Performance Analyzer
Adjusting CPU statistics tracking
Reporting on rule usage snapshots
Rule usage snapshots
Creating an interim rule usage snapshot
Updating the rule usage snapshot parameters
Lengthy service operations
Changing the parameters for monitoring lengthy services
Verifying that an instance is running
System-wide usage and the Log-Usage class
Generating requestor reports for system-wide usage from the Log-Usage class
Trimming the pr_perf_stats table
Licenses
Creating a license
Classifying rules for license compliance
License compliance
Identifying loaded module versions
Predictive Diagnostic Cloud
Background processing
Best practices for writing background processing work
Avoiding race conditions for advanced agents
Queue Processor rules
Replacing an agent with a Queue Processor rule for real-time messages
Replacing an agent with a Queue Processor rule for delayed messages
Creating a Queue Processor rule
Node classification for Queue Processor rules
Stream node configurations for a Queue Processor rule
Job Scheduler rules
Node and cluster default job schedulers
Replacing an agent with a Job Scheduler rule
Creating a Job Scheduler rule
Configuring the Job Scheduler rule thread pool
Configuring the Performance tool for Job Scheduler rules
Automating the runtime context management of background processes
Agents
Associating agents with node types
Agents rules
Completing the Create, Save As, or Specialization form
Completing the Security tab
Completing the Schedule tab
Completing the Nodes tab
More about agents rules
Pega-AutoTest agents
Pega-DecisionEngine agents
Pega-EndUserUI agent
Pega-ImportExport agent
Pega-IntSvcs agents
Pega-ProcessEngine agent
Pega-ProCom agents
Pega-RuleRefactoring agent
Pega-RULES agents
Pega-RulesEngine agents
Agent schedule data instances
Agent schedule data instances – Key parts
Completing the Schedule tab
Completing the Security tab
Agent schedule data instances
Initial Agent Schedule data instances
Master agents
Managing agents
Understanding agent queues
Managing listeners
Associating listeners with node types
Debugging listeners by using remote logging
Managing your Pega Platform database
Understanding the unique features of the Pega Platform database
Configuring a split database architecture
Split schema database architecture
Replicated and split databases
Viewing database tables and Pega Platform metadata by using the Clipboard tool
Database foundation classes
Hybrid data storage model (pzPVStream BLOB)
Database table primary key (handle)
Using handles
Determining if a handle exists
Finding the handle of an object
Required columns for tables
How database tables are identified at run time
Stored procedures
Understanding the default database tables
Database naming conventions
Database views
Working with class groups
Automatically creating class groups
Copying a class structure
Clone Class Group tab
Creating a separate table for a child class
Segregating cases into a dedicated table
Creating a class group manually
Keys tab on the Class Group form
Locks tab on the Class Group form
Planning for property optimization
Planning for property optimization
Optimizing properties from the user interface
Exposing properties and populating database columns
Viewing column population jobs
Canceling column population jobs
Modifying a schema by using the Modify Schema wizard
Exposing properties using the Modify Schema wizard
Exposing embedded properties
Populating properties by using the Column Populator tool
Populating properties by submitting a request to an active instance
Populating properties by using a direct connection to the database
Example column populator configurations
Optimizing properties by using the Select values gadget
Using declarative indexes
Setting up a declarative index
About Declare Index rules
Declare Index rules - Completing the New or Save As form
Declare Index form - Completing the Indexes tab
Declare Index form - Completing the Pages & Indexes tab
More about Declare Index rules
Full-text search overview
Checking search index status
Search indexes
Enabling classes for search indexing
Excluding properties with access control policies from search results
Specifying custom search properties
Custom search properties
Configuring search to allow filtering on embedded properties
Limitation on page-correlated filters
Creating dedicated indexes
Dedicated search indexes
Deleting dedicated indexes
Resolving data type conflicts in dedicated indexes
Configuring a report definition to run against an Elasticsearch index
Configuring index host nodes
Viewing index host node status
Enabling and disabling encryption for communication among search nodes
Viewing search agent information
Configuring automated search notifications
Configuring index host nodes from the user interface
Removing index host nodes by using a direct connection to the database
Viewing the status of an external search service
Rebuilding search indexes
Configuring fuzzy search
Configuring dynamic system settings for search
Rebuilding search indexes from the user interface
Stopping or pausing search reindexing
Rebuilding search indexes by using a direct connection to the database
Reindexing a node in a cluster
Integrating with Apache UIMA
Administering your database
Viewing and modifying schema information
Viewing platform generated schema changes
Viewing database schema information using Schema Tools
Viewing the database schema using the Modify Schema wizard
Viewing the initial database schema
Viewing schema changes
Separate logging for schema operations
Viewing the history of Schema Tools actions
Viewing the property tree
Viewing database class mappings
Identifying a schema within a database instance
Managing database performance
Adding and deleting database indexes
Database indexes
Optimizing a schema
Optimizing a schema
Schema Tools
Viewing column BLOB size
Increasing column length
Defragmenting tables
Updating statistics
Scheduling schema updates
Updating PegaRULES after external schema changes
Managing table growth
Trimming, purging, and archiving tables
Improving performance by archiving cases
Creating an archival policy
Scheduling the case archival process
Reviewing archived case data
Managing your case archival process
Monitoring the progress of your case archival process
Configuring archive settings
Configuring purge cycle settings
Purging and archiving old work items
Selecting a work pool
Selecting work types
Choosing filter criteria
Confirming the work types
Scheduling archival process
Creating work pools
Selecting archive settings
Reviewing process statistics and work object history
Confirming and starting the schedule
Viewing summary of agents and statistics
Rescheduling archives
Starting the archival process
Trimming the pr_perf_stats table
Planning tablespace
Managing table turnover rates
Counting the rows in a database table
Troubleshooting database requests
Starting a database trace
Viewing database trace results in Excel
Generating a system-wide database trace
Preventing truncated property values
Debugging database schemas
Running SQL queries on Pega Cloud
Exporting previously run query results
Viewing previously run queries
Query Inspector
Using Query Inspector to improve SQL queries
Improving database batch processing performance
Creating database data instances
Database data instances
Defining the database driver
Configuring connectivity to an external Pega Platform database
Configuring read-only database access for Query Runner
Configuring connection pools for external databases by using the prconfig file
Creating database instances for prconfig references
Creating database instances for JDBC URLs
Creating database instances for JDBC connection pools
Creating Couchbase database instances
Creating Cassandra database instances
Creating database instances by inheriting from an existing connection
Understanding Requestor Type data instances
Creating a requestor type
Requestor Type form – Definition tab
Requestor Type form – Activities tab
More about Requestor Type data instances
AsyncProcessor requestor type
Understanding high availability deployments
Configuring your system for passivation and activation
Setting passivation and requestor time-outs
Passivation time-out settings
Defining passivation storage
Implementing a custom passivation storage mechanism
Reporting on passivated requestors
Configuring nodes for high availability
Architecting a high availability system
Setting up the components of highly available environments
Setting up load balancers
Configuring session affinity for slow drain
Understanding high availability for Pega Platform
Configuring application tier architecture for redundancy
Single sign-on
Shared filesystem storage
Server redundancy
High availability developer environments
High availability settings management
Defining highly available integration services
Listeners
Service packages
Service request processors
Service rules
Cluster management
Privileges and roles for high availability management
Managing your high availability cluster
HA cluster settings
Managing the cluster using the Pega API
Recovering from a high availability system crash
Recovering from a server crash
Recovering from a browser crash
Enabling crash notification
Enabling periodic work recording
Performing a rolling upgrade
Quiesce behavior during high availability upgrades
Quiescing a high availability node
Quiescing a node with immediate drain
Immediate drain quiesce
On-premises immediate drain quiesce flow
Quiescing a node with slow drain
Slow drain quiesce
On-premises slow drain quiesce flow
Performing application validation after upgrades
Applying hotfixes to an on-premises system
Obtaining a hotfix catalog
Obtaining hotfixes
Scanning the system for hotfixes
Scanning the system from the user interface
Scanning the system by submitting a request to an active instance
Scanning the system by using a direct connection to the database
Obtaining hotfix packages
Preparing to install hotfixes
Reviewing hotfixes
IBM Db2 for z/OS: Preparing to import an application with schema changes and a separate DB-Admin-DB-Name
Applying database schema changes
Creating an SQL script from the user interface
Creating an SQL script by submitting a request to an active instance
Creating an SQL script by using a direct connection to the database
Installing hotfix packages
Installing hotfixes from the user interface
Installing hotfixes by submitting a request to an active instance
Installing hotfixes by using a direct connection to the database
Verifying hotfix installation results
Rolling back hotfixes
Rolling back hotfixes from the user interface
Rolling back hotfixes by submitting a request to an active instance
Rolling back hotfixes by using a direct connection to the database
Committing hotfixes
Committing hotfixes from the user interface
Committing hotfixes by submitting a request to an active instance
Committing hotfixes by using a direct connection to the database
Using restore points to enable error recovery
Listing restore points
Creating a restore point
Deleting a restore point
Getting detailed information about a restore point
Rolling back to a restore point
Upgrading cloned tables after an upgrade
Updating cloned tables from Dev Studio
Updating cloned tables from the command line
Upgrading Get Next Work performance
Upgrading cases and followers
Toggling features on and off
Supporting rules
Packaging your application in a product rule
Creating a product rule that includes associated data by using the Create menu
Editing a product rule
Specifying the content of a product rule
Listing product dependencies
Specifying product rule deployment options
Adding historical information to a product rule
Previewing and creating the archive file for a product rule
System target data instances
Creating a system target data instance
Running the Update Existing Applications utility
Identifying rule conflicts
Identifying missing database tables
Running other upgrade utilities
Revalidating rules after an upgrade
System limits and maximums
System Operations
Reference
PublicAPI
Rules by name
Developer utilities
Activities
Creating an activity
Steps tab on the Activity form
Activity form - Completing the Steps tab - Entering Method parameters
Activity form - Completing the Steps tab - Entering preconditions
Defining step transitions in an activity
Repeating steps in an activity
Calling an automation from an activity
Best practices for writing activities for background jobs
Security tab on the Activity form
Defining the local variables for an activity
Activity form - how to create activities for flows
Intelligent routing
Activities and Data Transforms - Reserved names for parameters and local variables
Saving data in a data page when running an activity
Methods and instructions
method
Methods and instructions by function
Methods and instructions by name
Activity-Clear-Status method
Activity-End method
Activity-List-Add method
Setting the status of an activity using the Activity-Set-Status method
Understanding the Activity-Set-Status method
Apply-DataTransform method
Apply-Model method
Apply-Parse-Delimited method
Apply-Parse-Structured method
Apply-Parse-XML method
Assert-No-Invocation method
Assign-EstablishContext method
Branching to another activity
Calling another activity
Call instruction parameters
Passing Page Name parameters
Decision Management methods
Adaptive model methods
Obtaining predictor information
Training adaptive models
Deleting adaptive models
Data flow methods
Running a data flow
Running a data flow in single mode
Specializing activities
Managing data flows
Monitoring data flows
Decision data methods
Running decision data instances
Interaction methods
Running interactions
Interaction History methods
Adding an association with a customer ID
Deleting an association between interactions and customer IDs
Simulation methods
Creating a simulation run
Starting a simulation run
Strategy methods
Returning a list of propositions
Returning a list of properties
Computing segment logic
Deprecated: External data flow methods
Deprecated: Creating and starting an external data flow run
Deprecated: Starting an external data flow run
Deprecated: Stopping an external data flow run
Deprecated: Deleting an external data flow run
Deprecated: Restarting an external data flow run
Deprecated: Retrieving the status of an external data flow run
Call-Async-Activity method
Call-Automation method
Call-Function
Using the Collect instruction
Commit method
Object locking
Connect-Atom method
Connect-Cassandra method
Connect-CMIS method
Connect-dotNet method
Connect-EJB method
Connect-File method
Connect-FTP method
Connect-HBase method
Connect-HTTP method
Connect-Java method
Connect-JCA method
Connect-JMS method
Connect-MQ method
Connect-REST method
Connect-SOAP method
Connect-Wait method
DataFlow-Execute method
Configuring the DataFlow-Execute method for a data flow with abstract input
Configuring the DataFlow-Execute method for a data flow with abstract output
Configuring the DataFlow-Execute method for a data flow with abstract input and output (single-case execution)
Configuring the DataFlow-Execute method for a data flow with stream input
Configuring the DataFlow-Execute method for data flows with non-stream input
DataSet-Execute method
Configuring the DataSet-Execute method for Adaptive Decision Manager
Configuring the DataSet-Execute method for Database Table
Configuring the DataSet-Execute method for Decision Data Store
Configuring the DataSet-Execute method for Event store
Configuring the DataSet-Execute method for File
Configuring the DataSet-Execute method for HBase
Configuring the DataSet-Execute method for HDFS
Configuring the DataSet-Execute method for Interaction History
Configuring the DataSet-Execute method for Kinesis
Configuring the DataSet-Execute method for Monte Carlo
Configuring the DataSet-Execute method for a social media data set
Configuring the DataSet-Execute method for Stream
Configuring the DataSet-Execute method for Visual Business Director
End-Validate method
Exit-Activity method
Flow-End method
Flow-New method
History-Add method
History-List method
Index-Finish method
Use of Java in an activity step
Link-Objects method
Using the Load-DataPage method
Log-Message method
Map-Structured method
Obj-Browse method
Obj-Delete method
Obj-Delete-By-Handle method
Obj-Filter method
Obj-List-View method
Obj-Open method
Obj-Open-By-Handle method
Obj-Refresh-and-Lock method
Obj-Save method
Obj-Save-Cancel method
Obj-Sort method
Obj-Validate method
Page-Change-Class method
Changing the class of a page
Page-Clear-Errorlist method
Page-Clear-Messages method
Page-Copy method
Page-Merge-Into method
Page-New method
Page-Remove method
Page-Rename method
Page-Set-Messages method
Page-Unlock method
Page-Validate method
Parse-Byte-Pos method
Parse-Char-Pos method
Parse-Fixed-Binary method
Parse-Packed-Decimal method
Privilege-Check method
Property-Map-DecisionTable method
Property-Map-DecisionTree method
Property-Map-Value method
Property-Map-ValuePair method
Property-Ref method
Property-Remove method
Property-Seek-Value method
Property-Set method
Property-Set-Corr method
Property-Set-HTML method
Property-Set-Messages method
Property-Set-Special method
Property-Set-Stream method
Property-Set-XML method
Property-Validate method
Publish-Notifications
Queue-For-Agent method
Queue-For-Processing method
Queue instruction—run an activity asynchronously
Parameters for the Queue instruction
RDB-Delete method
RDB-List method
RDB-Open method
RDB-Save method
Requestor-Stop method
Rollback method
Using the Rule instruction to support a custom rule type
Show-Applet method
Show-Applet-Data method
Show-HTML method
Show-Page method
Show-Property method
Show-Stream method
Start-Validate method
StringBuffer-Append method
StringBuffer-Insert method
StringBuffer-Reset method
TaskStatus-Set method
Text-Normalize method
Thread-Clear method
Thread-Stop method
Update-Button-Link-Formats
Wait method
Wait-For-Requestor method
Testing method results using a transition
Activities and page messages
How to customize the success and exception windows
How to prevent the display of traceback details
Activities, libraries, and functions
AJAX functionality
Standard activities — Extension points
About Collection rules
Collection rules -
Collection form - Completing the Basic / Advanced Collection tab
Collection form - Completing the Preamble and Stop tab
Collection form - Completing the Specifications tab
Using conditions in a collection
Setting the context of a collection step
Using response actions in a collection
Rule type
Deprecated Collection form
Deprecated Collection form - Completing the Basic / Advanced Collection tab
Deprecated Collection form - Completing the Preamble and Stop tab
Deprecated collection functionality
List rules
List rules -
List form - Completing the Fields tab
More about List rules
Activities that set application preferences for users
Application Development landing page
Automations
Pega-supplied automations
Viewing automations
Automation troubleshooting
Building expressions with the Expression Builder
Expression Builder
Displaying all functions in the Expression Builder
Data type conversions (casting) in expressions and property assignments
Expressions
Working with the Deprecated Expression Builder
Expressions — Examples
Expressions — Operators and precedence
Mathematical operators
Constants in expressions
Utility function instance management
Replacing a function signature with a different signature
Replacing a function signature with a new signature
Replacing a function signature when using branches
Functions in expressions
Methods for calling a function
Built-in and When() functions
Arithmetic functions
DateTime functions
Calling an activity in an expression
Calling an overloaded function
Expression evaluation
Order of evaluation
Add and subtract operations
Multiply, divide, and remainder operations
Comparison operators
Property references in expressions
Clipboard page and property references
Page list expressions in a decision tree
Parts of aggregate property references
Parts of a Page property reference
Parts of lists and groups reference
Symbolic indexes — APPEND, CURRENT, INSERT, LAST, and PREPEND
Obtaining the current index of a page list or page group property
About Constraints rules
Constraints rules -
Constraints form - Completing the Constraints tab
Constraints form - Completing the Pages & Classes tab
More about Constraints rules
About 03-02 Declare Constraint rules (Rule-Declare-Constraint)
About Correspondence Fragment rules
Creating Correspondence Fragment rules
Correspondence Fragment form - Completing the Stream tab
More about Correspondence Fragment rules
Correspondence rules
Correspondence
Creating email correspondence by using a template
Correspondence rules - Completing the New or Save As form
Correspondence form - Completing the Corr tab
Correspondence form - Completing the Security tab
Correspondence form - Completing the Prompts tab
More about Correspondence rules
About Correspondence Type rules
Correspondence Types rules -
Correspondence Types form - Completing the Correspondence tab
Data pages
Data page reference
Creating a data page
Configuring parameters for loading data pages
Managing data page instances on the clipboard
Configuring the refresh strategy for data pages
Defining data page access
Defining the requestor for loading a data page
Data page rules - Using the Pages & Classes tab
Data page rules - Using the Usage tab
More about data page rules
Savable data pages
Creating a data page save plan
Adding a Save data page step
Robotic automation as a data page source
Using a robotic automation to populate a data page
Configuring the Robot Manager host server and authentication profile
Configuring a data page for sourcing from robotic automation
Robotic automation status and error handling
Robotic desktop automation as a data page source
Configuring a data page for sourcing from robotic desktop automation
Unit testing a data page
Read-only data page instance limit management
Loading data pages asynchronously
Data pages and parameters
Passing parameters to data pages from UI elements
Passing parameters to data pages from sections
Passing parameters to data pages from non-UI rules
Passing parameters to data pages from autopopulated properties
Removing a data page
Viewing declarative processing with the Tracer tool
Assessing the effect of data page processing on performance
Overriding the default load activity for a data page rule
Data transforms
Data Transforms - Completing the Create, Save As, or Specialization form
Configuring a data transform
Data transform actions for Clipboard
Data transform actions for JSON
Data Transform form - Append and Map to action
Data Transform form - Append to action
Data Transform form - Apply Data Transform action
Data Transform form - Auto-map action
Data Transform form - For Each Page In and Exit For Each actions
Data Transform form - Remove action
Data Transform form - Set action
Data Transform form - Sort action
Data Transform form - Update Page action
Data Transform form - When, Otherwise, and Otherwise When actions
Configuring the JSON data transforms settings column on the Data Transform form
Data Transform form - Completing the Pages & Classes tab
Adding data transform to a process
Standard Data Transforms
More about data transforms
Unit testing a data transform
About Decision tables
Creating decision tables
Completing the Pages & Classes tab
Completing the Results tab
Completing the Table tab
More about Decision Tables
About Decision Trees
Creating decision trees
Completing the Decision tab (Advanced format)
Completing the Decision tab (Basic format)
Completing the Pages & Classes tab
Completing the Configuration tab
More about Decision Trees
Configuring property evaluation in a decision tree
About Declare Expression rules
Declare Expression form - Completing the Change Tracking tab
Supported and unsupported configurations in simplified declare expressions
Declare Expressions form - Completing the Expressions tab
Declare Expression rules - Completing the New or Save As form
Declare Expression form - Completing the Pages & Classes tab
More about Declare Expression rules
Declarative processing - Concepts and terms
Unit testing a declare expression
Declarative network
Testing rules in the Declarative Network Viewer
Viewing the declarative network
About Declare OnChange rules
Declare OnChange rules -
Declare OnChange form - Completing the OnChange Properties tab
Declare OnChange form - Completing the Pages & Classes tab
More about Declare OnChange rules
How to implement business exception processing with policy overrides
Declare Trigger rules
Creating Declare Trigger rules
Declare Trigger form - Completing the Pages & Classes tab
Declare Trigger form - Completing the Triggers tab
More about Declare Trigger rules
About Edit Validate rules
Edit Validate rules- Completing the New or Save As form
Edit Validate form - Completing the Java tab
More about Edit Validate rules
Find Rules landing page
Field values
Creating a field value
Example field values
Function Alias rules
Function Alias rules — Completing the Create, Save As, or Specialization form
Function Alias form – Completing the Reference tab
Function Alias rules — Overview of the Generated Output tab
More about Function Alias rules
How to use parameter pages with a function alias
Function rule
Creating a function
Writing Java code for a function
Listing aliases for a function
Making a function traceable
Deleting a function
Overriding a standard function
Library rules
Library rules
Library form – Completing the Packages tab
Library form - Completing the Static Variables tab
More about Library rules
About Map Values
Map Values
Completing the Matrix tab
Completing the Configuration tab
Completing the Pages & Classes tab
More about Map Values
Configuring rows and columns in a map value
Unit testing a map value
Messages
Finding messages in your application
Creating a message
Standard categories of messages
Creating a custom message category
Displaying a warning message in a rule
Standard functions for messages
Updating legacy messages and related rules
Paragraphs
Creating a paragraph
Formatting a paragraph
Configuring a pop-up SmartInfo section
More about Paragraph rules
Properties
Properties - Completing the Create, Save As, or Specialization form
Property form - Completing the General tab
Property form: General tab — Configuring validation
Property form - Completing the General tab for Java Object modes
Property form - Completing the General tab for Page modes
Property form: Completing the General tab - Value modes
Property form - Completing the Advanced tab
Standard property rules
More about Properties
Page properties
Properties - Working with the Explore Window
Property aliases
Working with properties
Standard Controls
Properties — Concepts and terms
Property references in expressions
Property Qualifier rules
Property Qualifier rules - Completing the New or Save As form
Property Qualifier form - Completing the Definition tab
Property Qualifier form - Completing the Table Edit tab
More about Property Qualifier rules
About Edit Input rules
Edit Input rules - Completing the Create, Save As, or Specialization form
Edit Input form - Completing the Java tab
More about Edit Input rules
Specifications and requirements
Importing specifications and requirements
Tips for resolving conflicts when importing specifications and requirements
Tips for editing spreadsheets of specifications and requirements
Creating a specification
Specifications
Configuring advanced options for editing specifications
Microsoft Object Linking and Embedding (OLE)
Associating a specification with a rule
Associating a specification with a flow
Associating a specification with a shape in a flow
Enabling specification count and implementation history
Viewing specification summary metrics
Viewing specifications by complexity, impact, and business objective
Viewing specifications
Viewing the implementation rules for specifications
Fields and controls in the Add/Edit Specification dialog box
Fields and controls on the Specification form
Creating a requirement
Application requirements
Tracking a requirement from an external system
Setting the requirement status
Assigning a requirement to a target release
Exporting specifications and requirements
Creating custom values for specifications and requirements
Viewing additional requirements and specifications
Associating a requirement with a flow
Removing a specification from an item
Application Profile landing page
Application Profile Requirements tab
Application Profile Specifications tab
Application Profile Analysis tab
About Validate rules
Validate rules - Completing the New or Save As form
Validate form - Completing the Validate tab
Validate form Completing the Input tab
Validate form - Completing the Pages & Classes tab
More about Validate rules
When Condition rules
Creating a When rule
Defining conditions for a When rule
Editing a When rule in the legacy mode
Configuring advanced options of a When rule
Specifying pages and classes of a When rule
More about When Condition rules
Glossary
Trademarks and copyright
Your browser does not support iframes.