Contents
Search Results
Loading, please wait ...

Loading

  • 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
      • Changing your workspace
        • Workspaces
      • 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
      • Preparing your application for secure deployment
      • 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 cases
      • Collaborating on shared content by using documents
        • Creating a document in an application
        • Discussing a document
      • Documenting your application
        • Creating project documents for stakeholders
    • Designing a case
      • Case types
      • Creating a case type
        • 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 information 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 options in a case
          • Adding an optional task to a case
            • Adding an optional task 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 with a 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 cases
          • 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
      • Managing data types
        • Data types
        • Storage and display of fields
      • Managing the data model
        • Defining the fields in a data type
        • Data Visualizer
          • Viewing data relationships
        • Data visualization
          • Viewing data relationships
        • Reusing data records
        • Referencing data from another data type
        • Adding a data reference to a form
      • Managing application data
        • Importing data from a file
      • Data views
        • Reviewing the data views for a data type
        • Data mapping limitations
      • Preparing your data for production
      • Managing UI Views
        • Creating a view for a data type
      • 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 channel
            • Email channel behavior
              • Configuring the Email channel
                • Defining suggested cases for the Email channel
                • Defining suggested replies for the Email channel
              • 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
              • 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
          • Facebook channel
            • Facebook channel behavior
              • Configuring the Facebook channel
                • Configuring system responses for 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
                • 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
          • Web Chatbot channel
            • Web Chatbot channel behavior
              • Configuring the Web Chatbot channel
                • Configuring system responses for 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
                • 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
          • 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
            • DateTime (calendar) controls
              • Understanding the Date, TimeofDay, and DateTime property types
              • Evaluation of symbolic dates
              • Java date pattern
              • Adding a DateTime control to a layout
                • Configuring the basic settings for a DateTime control - a date or time
                  • Specifying read-only and edit options for a DateTime 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 DateTime control
                • Configuring the basic settings for a DateTime control - date range
                  • Configuring presentation options for a date range calendar control
            • Adding and configuring a Data Visualization control
              • Adding a Data Visualization control
              • Specifying the data source for a Data Visualization control
              • Specifying the visual properties of a Data Visualization control
            • Icon controls
              • Adding and configuring an Icon control
                • Adding an Icon 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
            • Harness and Section forms - Adding an Address Map control
              • Harness and Section forms - Using an Address Map control
              • Troubleshooting Show User Location feature in browsers
            • Harness and Section forms - Adding an Attach Content control
              • Configuring file size options for the Attach Content control
              • Customizing how the Attach Content control is displayed
            • Harness and Section forms - Adding an autocomplete control
              • Autocomplete Properties — General tab
              • Autocomplete Properties – Presentation tab
              • Source of autocomplete field values
            • Harness and section forms - 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
            • Harness and Section forms - Adding a Check Box control
            • Harness and section forms - Adding a Currency Control
              • Purpose-Specific Control— General tab
              • Currency Properties – Presentation tab
              • Using the Currency Control
            • Harness and Section forms: Fields — Adding a Data Field for a composite application
            • Harness and Section forms - Adding a drop-down control
              • Dropdown control Properties — General tab
              • Dropdown control Properties — Presentation tab
            • Harness and Section forms - Adding formatted text
            • Harness and section forms - Adding an Integer Control
              • Integer Properties — Presentation tab
            • Harness and Section forms - Adding the Map control
              • Obtaining the Google API key
              • Configuring a dynamic system setting for the Map control
              • Harness and Section forms - Configuring a Map control
              • Map control properties
            • Harness and Section forms - Placing a text label in a layout cell or header
            • Harness and Section forms - Displaying location as static map image
              • Harness and Section forms - Displaying location as static map image
            • Harness and Section forms - Adding paragraphs to place rich text in a layout cell or header
            • Harness and section forms - Adding a Purpose-Specific control
            • Harness and Section forms - Adding a Rich Text Editor control
              • Rich Text Editor control Properties — General tab
              • Rich Text Editor control Properties — Presentation tab
            • Harness and Section forms - Adding a Radio Button control
              • Radio Buttons control Properties — General tab
              • Radio Buttons control Properties — Presentation tab
              • Radio Button Properties - Behavior tab
            • Harness and Section forms - Adding a Signature Capture control
              • Harness and Section forms - Customizing a Signature Capture control
            • Harness, section and flow action forms - Adding a Smart Label
              • Smart Label Properties — Presentation tab
            • Harness and Section forms - Adding a Text Area control
              • Text Area control - General tab
              • Text Area control - Presentation tab
            • Harness and Section forms - 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
      • Adding validation to fields on a form
        • Supported comparators for validation of fields on a form
      • 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 landing pages for applications
      • Creating a page for an application
      • Adding a page to an application menu
      • Editing a landing page of an application
      • Removing a page from an application menu
      • Removing a page from your application
    • Offline capability
      • Offline configuration page
      • Offline packaging optimization during synchronization
      • Server-side postprocessing in offline mode
      • Enabling offline support for cases
      • 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
      • 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
      • callActivity action as an extension
    • Pega Mobility
      • Pega Mobility and mobile clients
      • Configuring a custom mobile app
        • Custom mobile app
        • Navigating to the mobile channel
        • Configuring security options
          • Selecting an authentication service
          • Configuring additional custom mobile app security for Pega Infinity Mobile Client
          • Configuring additional custom mobile app security for Pega Mobile Client
        • Custom mobile app branding and layout
          • Configuring custom mobile app layout
            • Configuring a single webview layout
            • Configuring a multiple webview layout
            • Configuring the bottom bar
          • 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 custom mobile apps
          • Native search capability in custom mobile apps
          • Configuring categories for mobile search
          • Configuring a search action in a custom mobile app
        • Building custom 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 custom 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 custom mobile app for Android
          • Configuring push notifications on iOS
            • Push notifications in a custom mobile app for iOS
          • Auto-incrementing app version
          • Setting the app build version
          • Selecting a specific client version
          • Setting up an alternative host
        • Distributing custom 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
    • Integrating your application with external resources
      • Creating an email account
        • Deleting an email account
      • Creating a SAML SSO authentication service
      • Creating an OIDC SSO authentication service
      • Creating a Google authentication service
  • Managing your system
    • Managing your system
    • Packaging an application
  • Reference
    • Pega API
      • Pega API system management privileges
      • Pega API HTTP status codes and errors
    • PublicAPI
  • Glossary
  • Trademarks and copyright
2019-07-07