You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Contents
Search Results
Loading, please wait ...
Getting started for development teams
Setting up your environment
Exploring application-editing mode
Creating a team
Inviting a collaborator
Adding a secondary manager to a team
Defining areas of expertise for a team
Deleting a team
Removing a team member
Setting your work availability
Configuring your dashboard
Changing your dashboard layout
Adding a widget to your dashboard
Dashboard widgets
Sharing a dashboard with your team
Changing your theme
Switching between applications
Changing your workspace
Workspaces
Setting branch development preferences
Design-time limitations in App Studio
Developing an application
Best practices for application development
Reusing built-on capabilities
Installing components
Components
Enabling components
Creating a component
Documenting a component
Packaging a component
Shared ruleset
Disabling components
Interacting with an application guide
Adopting feature-driven development
Creating a feature
Creating a subfeature
Tracking feature-driven development
Creating a story
Creating stories in bulk
Populating a story template
Importing a story template
Troubleshooting errors with a story template
Exporting stories
Changing the status of a work item
Requesting a feature enhancement
Reporting a feature defect
Triaging a feedback item
Managing application features
Reviewing application features
Changing the level of a feature
Associating a feature with a work item
Deleting a feature
Communicating with users by using Pulse
Pulse
Choosing a context for Pulse messages
Posting a message in Pulse
Replying to a message in Pulse
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
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
Enabling users to post messages in the activity feed
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 pins
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
Granting Super Admin privileges to users
Monitoring and tracking tasks
Collaborating on shared content by using documents
Creating a document in an application
Discussing a document
Documenting your application
Creating project documents for stakeholders
Exporting a data model into a document
Designing a case
Creating a case type
Configuring a data model for a case
Creating a top-level case type
Creating a child case type
Renaming a case type
Reclassifying a case type
Deleting a case type
Defining the case life cycle
Creating a stage in the case life cycle
Creating a primary stage
Creating an alternate stage
Removing a stage
Adding a process to a stage
Adding a multistep form to a stage
Adding a sequential process to a stage
Adding a parallel process to a stage
Conditionally starting a process
Conditionally starting a process by using a condition
Supported comparators for conditions on a process
Changing the path of a process
Adding a decision to a flow
Removing a process from a stage
Adding a step to a process
Step types
Collecting information from a user
Assignments
Choosing an assignee at run time
Assigning a task to a user
Requesting approval from a user
Enabling email approval
Email approval
Troubleshooting errors in unresolved cases
Adding a preconfigured step to a process
Asking a question in a case
Survey APIs
Asking a group of related questions in a case
Attaching content to a case
Attaching screen captures to a case
Creating a contextual case
Collecting digital signatures in a case
Finding duplicate cases
Defining basic conditions for a case type
Defining a threshold with weighted conditions for a case type
Moving a case to a different stage
Pausing a process in a case
Transforming a temporary case into a permanent object
Posting messages to a case
Preloading a data page
Running a background process
Running a survey in a case
Sending event notifications from a case
Sending email from a case
Sending push notifications from a case
Saving data in a data page as part of a flow
Updating case information
Calling one process from another process
Subprocesses
Configuring case resolution
Improving case findability
Customizing the case icon
Changing the case ID format
Case ID format
Including indexed data during case search
Enabling search by third-party search engines
Adding meaningful data to a case
Managing case history
Disabling geolocation tracking
Geolocation tracking
Guiding case workers to successful case resolution
Enabling case notifications
Defining case participants
Changing the status of a case
Providing relevant optional actions to case workers
Adding an optional action to a case
Adding an optional action to a stage
Conditionally displaying an optional task
Adding a supporting process to a case
Adding a supporting process to a stage
Conditionally displaying a supporting process
Defining the entrance criteria for a stage
Requiring property values for stage entry
Defining conditions for skipping a stage
Controlling access to case attachments
Categorizing case attachments
Overriding the Create view of a case type
Defining conditions in the condition builder
Enforcing service-level agreements
Setting goals and deadlines for case resolution
Setting goals and deadlines for assignment completion
Defining an escalation action for an incomplete assignment
Enabling offline support for case types
Enabling offline packaging optimization during synchronization
Disabling server-side postprocessing in offline cases
Enabling offline case attachments support
Optimizing large file support performance
Dynamic system settings for optimizing large file support
Offline attachments support
Managing concurrent access to a case
Overriding the locking strategy of a child case
Case processing
Creating a case
Reopening a resolved case
Finding work assigned to a team
Following a case
Notifications
Setting notification preferences
Referencing a document from a case
Managing application data
Viewing application integration and data connections
Managing data and integrations with the Integration Designer
System of record display in the Integration Designer
Viewing the integration landscape
Data modeling
Creating a model for your data
Creating a data type
Defining the fields in a data type
Creating a data type using a JSON file
Best practices for data modeling
Troubleshooting errors in your data model
Exploring the data model
Viewing an application data model
Viewing the data model for a case
Viewing the data model for a data type
Managing data types
Storage and display of fields
Renaming a data type
Deleting a data type
Reusing data
Managing your data model
Defining the fields in a data type
Changing the type of a field
Troubleshooting field errors
Reusing data records
Referencing data from another data type
Adding a data reference to a form
Managing application data
Bringing data into your application
Integrating data from a REST service when creating a data type
Creating a data type 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 type
Mapping fields for the POST method when creating a data type
Integrating data from a REST service for an existing data type
Connecting existing data types 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 types
Mapping fields for the POST method for existing data types
Importing data into your application from an external system
Importing data from a file
Troubleshooting import errors
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 type
Preparing your data for production
Data views
Reviewing the data views for a data type
Updating connections and field mappings for a data source
Simulating data
Turning on data source simulation
Turning off data source simulation
Adding data to embedded structures when simulating data
Preparing your data for production
Upgrading REST connectors in
App Studio
Managing UI Views
Creating a view for a data type
Troubleshooting data in UI elements
Reporting
Report types
Creating reports
Creating a copy of an existing report
Creating a report
Organizing report shortcuts
Creating report categories in Case Manager
Editing reports
Adding columns to reports
Modifying column settings
Sorting and grouping columns in list reports
Data Explorer
Editing filter conditions
Adding filter conditions
Editing the logic for filter conditions
Adding or editing charts
Removing charts by using the Report Editor
Converting a list report to a summarized report
Converting a summarized report to a list report
Report Editor
Running reports
Report results
Actions menu options for reporting
Standard reports by category
Report List features
Creating the user experience
Channels and interfaces
Configuring the Mashup channel
Conversational channels
Email Bot
Email channel behavior
Configuring the Email channel
Defining suggested cases for the Email channel
Defining suggested replies for the Email channel
Configuring text analyzer definitions for the Email channel
Defining Email text analyzer topics
Enabling rich HTML text in emails
Tracking configuration changes in Email channels
Example case discussion in email and Pulse
Limitations on email discussions
Intelligent email routing
Configuring routing conditions for automatic email handling
Defining topics for intelligent routing
Defining a routing condition
Testing email routing conditions
Email channel NLP model
Updating the NLP model for an Email channel
Updating entities for an Email channel
Enabling the NLP model training for the Email channel
Copying training data to another environment
Machine learning and case processing
Email triage
Email triage cases
Enabling subject analysis of content during email triage
Enabling the analysis of attached files during email triage
Spinning off a regular case
Email Manager portal
IVA for Facebook
Facebook channel behavior
Configuring the Facebook channel
Adding cases for the Facebook channel
Adding custom responses for the Facebook channel
Configuring text analyzer definitions for the Facebook channel
Defining Facebook text analyzer topics
Configuring system responses for the Facebook channel
Configuring time-out options for the Facebook channel
Enabling synchronous mode for debugging
Facebook channel content
Configuring Facebook Get Started button
Setting up a Facebook operator ID
Adding a conversation to a case type
Facebook chatbot preview console
Simulating a conversation and building a Facebook chatbot
Configuring a topic in the Facebook chatbot preview console
Configuring a question in the Facebook chatbot preview console
Configuring a response in the Facebook chatbot preview console
Configuring a case and entity extraction in the Facebook chatbot preview console
Facebook channel NLP model
Updating the NLP model for a Facebook channel
Enabling the NLP model training for the Facebook channel
Copying training data to another environment
IVA for Web Chatbot
Web Chatbot channel behavior
Configuring the Web Chatbot channel
Adding cases for the Web Chatbot channel
Adding custom responses for the Web Chatbot channel
Configuring text analyzer definitions for the Web Chatbot channel
Defining Web Chatbot text analyzer topics
Configuring system responses for the Web Chatbot channel
Configuring time-out options for the Web Chatbot channel
Web Chatbot channel content
Generating the Web Chatbot channel mashup code
Web Chatbot preview console
Simulating a conversation and building a Web Chatbot
Configuring a topic in the Web Chatbot preview console
Configuring a question in the Web Chatbot preview console
Configuring a response in the Web Chatbot preview console
Configuring a case and entity extraction in the Web Chatbot preview console
Web Chatbot channel NLP model
Updating the NLP model for a Web Chatbot channel
Enabling the NLP model training for the Web Chatbot channel
Copying training data to another environment
Adding a conversation to a case type
Previewing an application
Adding, editing, and deleting a preview device
Forms and fields
Design templates
Controls
Standard controls
Specifying visibility and privilege options for a control
Adding actions to a control
Copying, moving, or deleting a control
Button controls
Styling options for Button controls
Adding and configuring a Button control
Adding a Button control to a layout
Adding a Button control to a harness
Specifying the caption for a Button control
Specifying the image source and tooltip for a Button control
Specifying presentation options for a Button control
Date time (calendar) control
Understanding the Date, TimeofDay, and DateTime property types
Evaluation of symbolic dates
Java date pattern
Adding a Date time control to a layout
Configuring the basic settings for a Date time control - a date or time
Specifying read-only and edit options for a Date time control
Selecting the date and time format and display mode
Selecting spinners or drop-down fields for navigation
Restricting the years displayed
Setting intervals of minutes
Displaying week numbers in calendar widgets
Disabling the selection of weekend days
Specifying presentation options for a Date time control
Specifying a time zone for a Date time control
Configuring the basic settings for a Date time control - date range
Configuring presentation options for a date range calendar control
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
Image controls
Adding and configuring an Image control
Adding an Image control to a layout
Specifying the icon source and tooltip for an Icon control
Specifying presentation options for an Icon control
Standard icons
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
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
Rich text editor controls
Adding and configuring a Rich text editor control
Adding a Rich text editor control
Selecting the property for a Rich text editor control
Specifying presentation options for a Rich text editor control
Skin formats for Rich text editor controls
Creating a new Rich text editor format
Applying a custom rich text editor format
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
Advanced controls
Selecting the property reference for a control
Specifying presentation options for a control
Adding an Address Map control
Using an Address Map control
Troubleshooting Show User Location feature in browsers
Enabling attaching files to an application
Configuring file size options for the Attach content control
Customizing how the Attach content control is displayed
Adding an Autocomplete control
Autocomplete Properties — General tab
Autocomplete Properties – Presentation tab
Source of autocomplete field values
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 a Checkbox control
Adding a Currency control
Purpose-Specific Control— General tab
Currency Properties – Presentation tab
Using the Currency Control
Adding a Data Field for a composite application
Adding a Drop-down control
Dropdown control Properties — General tab
Dropdown control Properties — Presentation tab
Adding a Text control
Configuration options for the Text control
Adding an Integer Control
Integer Properties — Presentation tab
Adding the Map control
Obtaining the Google API key
Configuring a dynamic system setting for the Map control
Configuring a Map control
Map control properties
Configuring a text label in a layout cell or header
Displaying location as static map image
Displaying location as static map image
Adding paragraphs to place rich text in a layout cell or header
Adding a Purpose-Specific control
Adding a Radio Button control
Radio Buttons control Properties — General tab
Radio Buttons control Properties — Presentation tab
Radio Button Properties - Behavior tab
Adding a Signature capture control
Customizing a Signature capture control
Adding a Tooltip
Tooltip Properties — Presentation tab
Adding a Text area control
Text area control - General tab
Text area control - Presentation tab
Adding a Text input control
Text input control - General tab
Text input control - Presentation tab
Adding a video to a section
Control form - Actions tab
Creating an action set
Available actions and conditions
Design templates for sections
Dynamic views
Configuring a dynamic view
Building a form for a case type
Reusing a field on a form
Restrictions on field and form reuse
Reusing a form
Adding a single-value field to a form
Configuring a user reference on a form
Adding a field group to a form
Adding a field group to your data model
Adding a field group list to your data model
Adding a data reference to a form
Configuring a data reference on a form
Adding a field group list to a form
Validating input in forms
Restricting user input in a field
Adding choices to a picklist
Converting plain text to rich text
Securing an attachment field
Calculating the value of a field
Configuring a form at run time
Configuring a work area at run time
Configuring a region at run time
Styling controls at run time
Configuring a table at run time
Configuring a case at run time
Supported display modes by field type
Creating and managing pages for applications
Creating a page for an application
Configuring the navigation menu for a portal
Editing a page of an application
Modifying the name and icon of a page
Removing a page from your application
Configuring role-based page access
Offline capability
Offline configuration page
Enabling access group data prepackaging during build
Offline packaging optimization during synchronization
Server-side postprocessing in offline mode
Configuring offline support for a mobile app
Enabling offline support for access groups
Offline capability for case types
Guidelines for creating an offline-enabled application
Guidelines for building the user interface for offline mode
Offline-enabled mobile apps and Pega Infinity Mobile Client
Flow processing in offline mode
Screen flows in offline mode
Enabling offline support for an optional process
Creating a section with an
Add work
button
Configuring the RunScript action on the button
Creating a section which lists the optional processes
Requirements for surveys in offline mode
Supported controls when working offline
Attach content support in offline mode
Configuring maximum offline attachment size
Supported actions when working offline
Offline (OSCO) mode breakout API
When rule support in offline mode
Decision table support in offline mode
Validate rule support in offline mode
Adding validate rules to a whitelist for offline use
Offline validation API
Function rule support in offline mode
How to use a function rule in offline mode
Offline function rule API
How to call a JavaScript function directly
Finding a function list for a utility library
Data transform support in offline mode
Adding data transform rules to a whitelist for offline use
Offline data transform API
Packaging a signature after the work object is resolved
Error and warning handling in offline mode
Error and warning handling API in offline mode
Data synchronization JavaScript API
callActivity action as an extension
Pega Mobile
Pega Mobile and mobile clients
Configuring a mobile app
Mobile app
Navigating to the mobile channel
Configuring security options
Selecting an authentication service
Configuring direct authentication against an external OIDC server for Pega Infinity Mobile Client
Custom parameters for direct authentication against an external OIDC server
Configuring additional mobile app security for Pega Infinity Mobile Client
Configuring additional mobile app security for Pega Mobile Client
Mobile app branding and layout
Configuring mobile app layout
Configuring a layout for the reuse of a web portal
Configuring a layout with advanced mobile features
Advanced layout options
Configuring the bottom bar
Customizing fonts for the native mobile app components
Converting the icons font for imported applications
Customizing the paused Android app notification
Preparing custom branding assets
Uploading branding assets and custom modules
Contents of the branding assets package
Configuring search in mobile apps
Native search capability in mobile apps
Configuring categories for mobile search
Configuring a search action in a mobile app
Building mobile apps
Building an Android app
Building an iOS app
Configuring a Today widget on iOS
Exporting an unsigned iOS app
Android certificate set
Opening a certificate set
Creating an Android certificate set
Uploading a signing certificate
Selecting an Android certificate set
iOS certificate set
Opening an existing iOS certificate set
Creating an iOS certificate set
Creating an unsigned iOS certificate set
Uploading a provisioning profile
Uploading a signing certificate
Uploading a push notifications certificate
Uploading a widget provisioning profile
Selecting an iOS certificate set
Expiration of iOS certificates
Mobile certificates page
Setting up push notifications in mobile apps
Adding the push notifications shape to a workflow
Enabling push notifications
Requirements for replying to a push notification from Pulse
Configuring push notifications on Android
Push notifications in a mobile app for Android
Configuring push notifications on iOS
Push notifications in a mobile app for iOS
Auto-incrementing app version
Setting the app build version
Selecting a specific client version
Setting up an alternative host
Distributing mobile apps
Downloading a mobile app in a binary file
Publishing the QR code
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
Push notifications from app administrators
Accessing the push notifications console
Testing push notifications
Sending push notifications
Reviewing push notification history
Tracking mobile users with the Map control
Configuring the Map control to display user tracks
Pega Mobile Express and Pega Mobile Preview
Accessing a single mobile channel in Pega Mobile Express
Accessing multiple mobile channels in Pega Mobile Preview
Localizing an 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
Optimizing application load time
Rerunning a preflight optimization
Checking results and JavaScript file dependencies
Improve application loading time with preflight optimization
Security
Preparing your application for secure deployment
Security guidelines for test environments
Authentication
Creating an authentication service
Authentication services
Configuring a basic authentication service
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 a SAML SSO authentication service
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 a custom or Kerberos authentication service
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 an OpenID Connect SSO authentication service
Configuring the identity provider for an OpenID Connect SSO authentication service
Configuring the identity provider for an OpenID Connect SSO authentication service – Advanced Configuration
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 an anonymous authentication service
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 an authentication service
Authentication services and rule availability
Authentication services and security policies
Application URL patterns for various authentication service types
Configuring login and disablement policies
Managing security policies
Security policies settings
Security policies
Enabling and disabling operators
Viewing locked and disabled operators
Disabling an operator
Enabling operators
Unlocking an operator
Deleting an operator
Controlling access to and from external applications
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 data instance
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 access
Creating a SAML SSO authentication service
Creating an OIDC SSO authentication service
Creating a Google authentication service
Authorization
Role-based access control
Operators
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 work groups, work queues, and schedules
Defining security information for an operator
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
Application ID form – Completing the Security tab
Granting portal access to an access group
Updating access groups by submitting a request to an active instance
Defining a user role for access control
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
Advanced settings for access roles
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
Access Deny rules
Access Deny rules - Completing the New or Save As form
Access Deny form – Completing the Security tab
More About Access Deny rules
Access When rules
Access When rules – Completing the New or Save As form
Access When form — Completing the Conditions tab
Access When form — Advanced tab
Viewing generated Java code of Access When rules
Setting rules
Creating a setting
Configuring a setting
Privileges
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
Security attributes markings
Storage of operator security attributes
One Of and All Of conditions
Access control policy condition performance
Hierarchical attributes
Reviewing access control policies
Verifying access control policies
Discovery features for access control policies
Customization 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
Rule and data change auditing
Enabling security auditing for a data class or rule type
Customizing the memo text for an audited rule
Auditing changes to aggregate properties
Security event configuration
Selecting a security event to monitor
Adding a custom security event
Displaying the Security Audit Log
Tracking login failures by using a report
Security alerts
Security assets and the environment
Searching for security vulnerabilities in rules
Rule Security Analyzer
Security guidelines for custom HTML
Regular Expression rules
Creating a Regular Expression rule
The Regular Expression tester tool
Encryption ciphers
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
Keystores
Importing an X.509 certificate
Configuring an Amazon Key Management Service (KMS) keystore
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 JSON Web Token from a token profile
Configuring activities to generate a JSON Web Token
Previewing the JSON Web Token profile
Processing a JSON Web Token
Configuring an activity to process a JSON Web Token
Mitigating common security vulnerabilities
Enabling and configuring Cross-Site Request Forgery settings
Enabling cross-site request forgery support
Using HTTP response headers
Creating a custom application header
Testing a custom application 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
Configuring a content security policy
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
Managing your system
Keeping Pega Platform current
Applying hotfixes
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
Configuring system-wide parameters
Configure system settings from Dev Portal
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
Viewing application settings
Categorizing application settings
Defining application setting values for different production levels
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 external log URL
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)
Configuration settings in
Admin Studio
Viewing configuration settings for troubleshooting
Changing the storage destination for the import data wizard, BIX, and file listeners
Utilities
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
System Operations
Reference
PublicAPI
Glossary
Trademarks and copyright