Pega Platform design patterns

From PegaWiki
Portal:Platform Design Patterns /
Revision as of 14:26, 3 August 2021 by BEAUM (talk | contribs) (updated to add decision management as featured capability)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


thumb text-top Pega Platform™ model-driven, unified approach delivers enterprise-grade, agile applications with a no-code authoring experience. Pega Platform design patterns share best practices to successfully deliver Pega projects using all the capabilities of Pega Platform..

Overview
Featured Patterns
Knowledgebase Links
Featured Capabilities
Design Patterns
Platform PatternsCapability/Industry AreaDescription
Access reference data at real timeData IntegrationAccess reference data at real time
Accessibility - Accessible navigation patterns with RDLsUser ExperienceDescribes navigation patterns for creating accessible Repeating Dynamic Layouts.
Accessibility - Configuring semantic heading levelsUser ExperienceA guide to creating and using semantic heading levels in the User Interface
Accessing website data when using Pega Intelligent Virtual Assistant (IVA) for Web MessagingConversational ChannelsLearn how to access website data such as general information, tags, and cookies, when using Pega Intelligent Virtual Assistant (IVA) for Web Messaging
Application modularization, encapsulation, and naming for better reuse and maintenanceEnterprise Application DevelopmentBest practices for creating modular applications that are easy to maintain
Apply validations to ensure data integrityLow-Code App DevelopmentApplying various types of validations in an application
Authentication in Web ChatbotConversational ChannelsAuthentication in Intelligent Virtual Assistant for Web Chatbot
Best practices for configuring case types - workflow, data model, and UILow-Code App DevelopmentThis document describes best practices for defining and configuring case types of your application so that they are configured to take full advantage of the Pega Cosmos design system.
Best practices for defining case views specific to case typesCase ManagementBest practices for defining case views specific to case types
Best practices for developing personasLow-Code App DevelopmentDeveloping personas
Best practices for non-functional aspects of the end-user experienceEnterprise Application DevelopmentBest practices for non-functional aspects of the end-user experience
Best practices for using pyAgeFromDateCase ManagementDefining the correct value for the pyAgeFromDate property
Build for change using App StudioCase ManagementBuilding applications using App Studio using configuration rather than customization
Building APIsData IntegrationGuidelines on building Service REST APIs
Building great dashboardsReportingThis document describes best practices for creating dashboards.
Calling Deployment Manager APIs from a REST clientDevOpsInvoking Deployment Manager APIs
Capacity planning for sending and receiving emailData IntegrationConsiderations when planning to send and receive email on a large scale
Case attachmentsCase ManagementSetup and use of attachments in a case
Chatbot Engine extensionsConversational ChannelsA list of Pega Chatbot engine extension points which you can use to customize the conversational channels behavior.
Choosing between a Pega API and a custom APIData IntegrationFactors to weigh in while choosing between Pega API and strongly typed custom API before building a new REST API
Clipboard management in Pega InfinitySystem AdministrationClipboard management in Pega Infinity
Co-existenceCase ManagementPublishing case types from an older version of Pega Platform to an application on the newer version of Pega Platform
Configuration setsLow-Code App DevelopmentLeveraging configuration sets for easy, upgradable application configuration
Configuring Asynchronous ProcessingSystem AdministrationOptions available for implementing parallel processing for better user-experience and increased throughput
Configuring Dynamic System SettingsSystem AdministrationGuidelines for configuring dynamic system settings
Configuring and Managing logsSystem AdministrationAn overview of logging tools in Pega Platform
Configuring external authentication for a mobile appMobileConfiguring authentication for a mobile app by using different protocols and external identity providers.
Configuring lists with local and external dataData IntegrationConfiguring lists with local and external data
Controlling public peering access to Pega Cloud with BGPPega CloudGuidance and best practices on using Border Gateway Protocol (BGP) to optimize public peering access to Pega Cloud.
Creating authentication registration for external usersSecurityBest practices for creating authentication registration for external users
Creating case stagesCase ManagementWhen to create case stages
Custom guardrail warningsEnterprise Application DevelopmentCustom guardrail warning configuration, explanation and examples
Data Access Security Event MonitoringSecurityAdvice for monitoring and interpreting data access security events
Data Integrity - Patterns & Anti-PatternsEnterprise Application DevelopmentSalient Do's & Don'ts for maintaining data integrity
Debugging and validating offline-enabled apps with the JavaScript consoleMobileDebugging and validations for offline-enabled apps with the JavaScript console. Using validation tools helps you to detect of usage unsupported components in Offline.
Define Authorization ModelSecurityDefining the authorization model.
Defining Pega scenario testsDevOpsBest practices for defining scenario tests
Defining and applying case statusesCase ManagementDefining case statuses
Defining case dependencies at run timeCase ManagementGuidelines for successful definition of case dependencies at run time
Design pattern for integration data mappingData IntegrationThis article explains a unique design pattern for data mapping by comparing it with traditional approach
Design patterns for Integration Designer using App StudioData IntegrationDesign patterns for Integration Designer using App Studio
Designing Pega unit testsLow-Code App DevelopmentBest practices for designing Pega unit tests
Detecting duplicate casesCase ManagementConfiguring the Search Duplicate Cases tool in Pega Platform
Documents and attachments - Ingesting docs, extracting data, and populating casesData IntegrationLearn more about how to handle documents and attachments, and how to extract their data into your cases
Edit Queue processors and Agents to set up a systemLow-Code App DevelopmentEditing queue processors and agents to optimize setting up a system
Editing file listener vs queuingData IntegrationBest practices for modifying the external system data intake process by editing the file listener and queuing
Ensuring compliance and upgradability by using best practices for application developmentLow-Code App DevelopmentEnsuring compliance and upgradability by using best practices for application development
Establish parent-child relationships on case types at run timeCase ManagementUse case for establishing parent-child relationships on case types at run time
Establishing a prescriptive Route to LiveCloud ServicesEstablish a prescriptive Route to Live for your Pega applications deployed in Pega Cloud Services that are efficient, easily upgradable and that allow for continuous improvement.
Extensibility patternsEnterprise Application DevelopmentPatterns to designing an application for reuse and extension
External Data ValidationData IntegrationUsing external data in a Pega application
Handling external assignments in PegaCase ManagementConfiguring Directed Web Access and the anonymous user authentication as two methods for handling external assignments in Pega
High-throughput file processingLow-Code App DevelopmentDescribes how to use file listeners to optimize high-volume data processing
Identify Case TypesCase ManagementIdentifying the case types for an application.
Importing external certificates into a Pega KeystoreSecurityhow to import external certificates into a Pega Keystore
Improving the user experience of chatbotsConversational ChannelsAdvanced Configuration for Intelligent Virtual Assistants
Integrating Google Cloud VisionData IntegrationIntegrating Google Cloud Vision into Pega using native Data Pages, Connect-REST, and declarative properties
Integrating unit tests into build tools and JenkinsDevOpsGuidelines on integrating Pega unit tests and scenario tests into build tools and Jenkins
Interfacing with OData from the Pega Infinity PlatformCloud ServicesInterfacing with OData from the Pega Infinity Platform
Large-scale batch processingSystem AdministrationGuidelines for successful batch processing
Managing priority or urgencyCase ManagementUse urgency to standardize how case workers resolve cases.
Measuring customer satisfaction with questionnairesCase ManagementHow to use questionnaires to measure and track customer satisfaction
Microjourneys, personas, and dataLow-Code App DevelopmentDefining Microjourneys, personas, and data in terms of best practices for successful case design
OAuth 2.0 Security Event MonitoringSecurityAdvice for monitoring and interpreting OAuth 2.0 security events
Offline validation tools - client store contentMobileDescribed tools give apps developer possibility to see the offline apps database content on the device.
Optimize an application's performanceLow-Code App DevelopmentTesting and tuning an application during its application lifecycle to optimize performance.
Optimizing performance tuning data processing through retrieval and indexingSystem AdministrationGuidelines on retrieving and indexing application data for faster processing
PDF document generation patternsCase ManagementMethods of creating PDF files in Pega Platform
Pega Infinity Development Best PracticesEnterprise Application DevelopmentGuidelines for Pega Platform developers to create efficient, sustainable, and guardrail-compliant applications
Pega Infinity deployment guidanceDevOpsBest practices for Pega Infinity deployments
Pega and Salesforce IntegrationData IntegrationThis guide is intended as a starting point or help if you need to use or update data from a Salesforce environment, focused mainly on Salesforce REST API.
Performance checklistSystem AdministrationA performance checklist to make performant solutions by using Pega Platform
Performing search on an embedded page listReportingLearn how to effectively search on an embedded page lists.
Preventing circular dependency references in a hierarchical treeDecision ManagementPerforming validation to optimize hierarchical tree set up
Process AI example applicationDecision ManagementProcess AI example application
Propagating schema changes to child tablesSystem AdministrationSchema changes in the base tables can be propagated to cloned tables in implementation layers to leverage the enhancements done in the Industry/CRM/framework applications. This article covers different options available in Pega Platform to propagate schema changes from parent tables to child tables. Also, it provides some insights on when to use which option.
Reopening a caseCase ManagementReopening a case after it has been marked as Resolved
Seamless experience across Digital Messaging channelsConversational ChannelsAchieve a seamless experience across Digital Messaging channels by following guidelines and performing several configuration steps in your system.
Securing a public facing applicationSecuritySecuring a public facing application
Securing persona-based accessSecurityBest practices to follow when setting up an application and allowing certain personas to access certain information.
Security Administration Security Event MonitoringSecurityAdvice for monitoring and interpreting security administration events
Strategies for integrating Deployment Manager with Jenkins pipelinesDevOpsStrategies for integrating Deployment Manager with Jenkins
Surfacing Dev Studio in App StudioLow-Code App DevelopmentUsing Dev Studio to develop application functionality in App Studio
Theme Cosmos - Building UI with DX API complianceUser ExperienceBest practices for developing an application interface
Theme Cosmos - Customizing login and error screensUser ExperienceUpdating login and error screens to match the context of your application
Theme Cosmos - Customizing section-based portals in App StudioUser ExperiencePatterns for configuring Theme Cosmos portals in a section-based application.
Theme Cosmos - Design templates: customization and optimization with helper classesUser ExperienceCustomization guidelines for design templates with the use of CSS helper classes
Theme Cosmos - Handling spacing in sections created using design templatesUser ExperienceLimiting unnecessary empty space in sections that are based on design templates
Theme Cosmos - Integrating PowerBI and QlikView reportsUser ExperienceEmbedding external web-based BI/analytic tools such as PowerBI and QlikView into a user's dashboard
Theme Cosmos - Minimizing a modal window built on the OOTB templateUser ExperienceAdd an option to minimize a modal window
Theme Cosmos - Persona-specific portal configurationUser ExperienceConfigure portal access by personas and permissions
Theme Cosmos - The Utility PanelUser ExperienceA description and customization of utilities in Theme Cosmos applications
Theme Cosmos - Using the Pega API (DX API)User ExperienceGuidelines for developing an application interface
Theme UI-Kit - Configuring advanced settings for hierarchical tablesUser ExperienceGuidelines for setting up advanced capabilities for hierarchical tables
Theme UI-Kit - Customizing an application with App StudioUser ExperienceHow to customize an application using low code tools App Studio
Theme UI-Kit - Skin: overview and best practicesUser ExperienceDescription of the skin rule and related best practices
Theme UI-Kit-Styling a Search boxUser ExperienceStyle a search box to look like standard search boxes
Troubleshooting NLPConversational ChannelsTroubleshooting NLP issues - so that customers can self service NLP issues before reaching GCS.
Unifying ID across all case typesCase ManagementUnifying ID across all case types
Using AWS Privatelink to connect enterprise resources to Pega CloudPega CloudGuidance and best practices on using AWS Privatelink to connect your enterprise resources to Pega Cloud
Using a Google AI model in PegaDecision ManagementUsing a model built in Google AI platform in Pega
Using email bots for natural language processing and machine learningConversational ChannelsUsing natural language processing and machine learning to optimize email bots
Using participants in casesCase ManagementHow to use participants (parties) in cases effectively in Pega Platform from 8.x
Using reporting efficientlyReportingInstructions on using reporting efficiently
Using special operators in ABAC READ policy conditionsDevOpsPerformance remediation options for ABAC READ policy conditions that use special operators.
Using third-party testing tools with your Pega applicationDevOpsAn overview of the testing tools that can be used with your Pega application
When to use a dynamic caseCase ManagementDeciding when to use a dynamic case
When to use a sub-caseCase ManagementWhen to use a sub-case to assist with processing work
When to use sub-processesCase ManagementDeciding when to use a sub-process
Case Management
Design PatternsDescription
Best practices for defining case views specific to case typesBest practices for defining case views specific to case types
Best practices for using pyAgeFromDateDefining the correct value for the pyAgeFromDate property
Build for change using App StudioBuilding applications using App Studio using configuration rather than customization
Case attachmentsSetup and use of attachments in a case
Co-existencePublishing case types from an older version of Pega Platform to an application on the newer version of Pega Platform
Creating case stagesWhen to create case stages
Defining and applying case statusesDefining case statuses
Defining case dependencies at run timeGuidelines for successful definition of case dependencies at run time
Detecting duplicate casesConfiguring the Search Duplicate Cases tool in Pega Platform
Establish parent-child relationships on case types at run timeUse case for establishing parent-child relationships on case types at run time
Handling external assignments in PegaConfiguring Directed Web Access and the anonymous user authentication as two methods for handling external assignments in Pega
Identify Case TypesIdentifying the case types for an application.
Managing priority or urgencyUse urgency to standardize how case workers resolve cases.
Measuring customer satisfaction with questionnairesHow to use questionnaires to measure and track customer satisfaction
PDF document generation patternsMethods of creating PDF files in Pega Platform
Reopening a caseReopening a case after it has been marked as Resolved
Unifying ID across all case typesUnifying ID across all case types
Using participants in casesHow to use participants (parties) in cases effectively in Pega Platform from 8.x
When to use a dynamic caseDeciding when to use a dynamic case
When to use a sub-caseWhen to use a sub-case to assist with processing work
When to use sub-processesDeciding when to use a sub-process
Low-Code App Development
Design PatternsDescription
Apply validations to ensure data integrityApplying various types of validations in an application
Best practices for configuring case types - workflow, data model, and UIThis document describes best practices for defining and configuring case types of your application so that they are configured to take full advantage of the Pega Cosmos design system.
Best practices for developing personasDeveloping personas
Configuration setsLeveraging configuration sets for easy, upgradable application configuration
Designing Pega unit testsBest practices for designing Pega unit tests
Edit Queue processors and Agents to set up a systemEditing queue processors and agents to optimize setting up a system
Ensuring compliance and upgradability by using best practices for application developmentEnsuring compliance and upgradability by using best practices for application development
High-throughput file processingDescribes how to use file listeners to optimize high-volume data processing
Microjourneys, personas, and dataDefining Microjourneys, personas, and data in terms of best practices for successful case design
Optimize an application's performanceTesting and tuning an application during its application lifecycle to optimize performance.
Surfacing Dev Studio in App StudioUsing Dev Studio to develop application functionality in App Studio
Data Integration
Design PatternsDescription
Access reference data at real timeAccess reference data at real time
Building APIsGuidelines on building Service REST APIs
Capacity planning for sending and receiving emailConsiderations when planning to send and receive email on a large scale
Choosing between a Pega API and a custom APIFactors to weigh in while choosing between Pega API and strongly typed custom API before building a new REST API
Configuring lists with local and external dataConfiguring lists with local and external data
Design pattern for integration data mappingThis article explains a unique design pattern for data mapping by comparing it with traditional approach
Design patterns for Integration Designer using App StudioDesign patterns for Integration Designer using App Studio
Documents and attachments - Ingesting docs, extracting data, and populating casesLearn more about how to handle documents and attachments, and how to extract their data into your cases
Editing file listener vs queuingBest practices for modifying the external system data intake process by editing the file listener and queuing
External Data ValidationUsing external data in a Pega application
Integrating Google Cloud VisionIntegrating Google Cloud Vision into Pega using native Data Pages, Connect-REST, and declarative properties
Pega and Salesforce IntegrationThis guide is intended as a starting point or help if you need to use or update data from a Salesforce environment, focused mainly on Salesforce REST API.
User Experience
Design PatternsDescription
Accessibility - Accessible navigation patterns with RDLsDescribes navigation patterns for creating accessible Repeating Dynamic Layouts.
Accessibility - Configuring semantic heading levelsA guide to creating and using semantic heading levels in the User Interface
Theme Cosmos - Building UI with DX API complianceBest practices for developing an application interface
Theme Cosmos - Customizing login and error screensUpdating login and error screens to match the context of your application
Theme Cosmos - Customizing section-based portals in App StudioPatterns for configuring Theme Cosmos portals in a section-based application.
Theme Cosmos - Design templates: customization and optimization with helper classesCustomization guidelines for design templates with the use of CSS helper classes
Theme Cosmos - Handling spacing in sections created using design templatesLimiting unnecessary empty space in sections that are based on design templates
Theme Cosmos - Integrating PowerBI and QlikView reportsEmbedding external web-based BI/analytic tools such as PowerBI and QlikView into a user's dashboard
Theme Cosmos - Minimizing a modal window built on the OOTB templateAdd an option to minimize a modal window
Theme Cosmos - Persona-specific portal configurationConfigure portal access by personas and permissions
Theme Cosmos - The Utility PanelA description and customization of utilities in Theme Cosmos applications
Theme Cosmos - Using the Pega API (DX API)Guidelines for developing an application interface
Theme UI-Kit - Configuring advanced settings for hierarchical tablesGuidelines for setting up advanced capabilities for hierarchical tables
Theme UI-Kit - Customizing an application with App StudioHow to customize an application using low code tools App Studio
Theme UI-Kit - Skin: overview and best practicesDescription of the skin rule and related best practices
Theme UI-Kit-Styling a Search boxStyle a search box to look like standard search boxes
DevOps
Design PatternsDescription
Calling Deployment Manager APIs from a REST clientInvoking Deployment Manager APIs
Defining Pega scenario testsBest practices for defining scenario tests
Integrating unit tests into build tools and JenkinsGuidelines on integrating Pega unit tests and scenario tests into build tools and Jenkins
Pega Infinity deployment guidanceBest practices for Pega Infinity deployments
Strategies for integrating Deployment Manager with Jenkins pipelinesStrategies for integrating Deployment Manager with Jenkins
Using special operators in ABAC READ policy conditionsPerformance remediation options for ABAC READ policy conditions that use special operators.
Using third-party testing tools with your Pega applicationAn overview of the testing tools that can be used with your Pega application
Security
Design PatternsDescription
Creating authentication registration for external usersBest practices for creating authentication registration for external users
Data Access Security Event MonitoringAdvice for monitoring and interpreting data access security events
Define Authorization ModelDefining the authorization model.
Importing external certificates into a Pega Keystorehow to import external certificates into a Pega Keystore
OAuth 2.0 Security Event MonitoringAdvice for monitoring and interpreting OAuth 2.0 security events
Securing a public facing applicationSecuring a public facing application
Securing persona-based accessBest practices to follow when setting up an application and allowing certain personas to access certain information.
Security Administration Security Event MonitoringAdvice for monitoring and interpreting security administration events
Conversational Channels
Design PatternsDescription
Accessing website data when using Pega Intelligent Virtual Assistant (IVA) for Web MessagingLearn how to access website data such as general information, tags, and cookies, when using Pega Intelligent Virtual Assistant (IVA) for Web Messaging
Authentication in Web ChatbotAuthentication in Intelligent Virtual Assistant for Web Chatbot
Chatbot Engine extensionsA list of Pega Chatbot engine extension points which you can use to customize the conversational channels behavior.
Improving the user experience of chatbotsAdvanced Configuration for Intelligent Virtual Assistants
Seamless experience across Digital Messaging channelsAchieve a seamless experience across Digital Messaging channels by following guidelines and performing several configuration steps in your system.
Troubleshooting NLPTroubleshooting NLP issues - so that customers can self service NLP issues before reaching GCS.
Using email bots for natural language processing and machine learningUsing natural language processing and machine learning to optimize email bots
Mobile
Design PatternsDescription
Configuring external authentication for a mobile appConfiguring authentication for a mobile app by using different protocols and external identity providers.
Debugging and validating offline-enabled apps with the JavaScript consoleDebugging and validations for offline-enabled apps with the JavaScript console. Using validation tools helps you to detect of usage unsupported components in Offline.
Offline validation tools - client store contentDescribed tools give apps developer possibility to see the offline apps database content on the device.
Reporting
Design PatternsDescription
Building great dashboardsThis document describes best practices for creating dashboards.
Performing search on an embedded page listLearn how to effectively search on an embedded page lists.
Using reporting efficientlyInstructions on using reporting efficiently
Decision Management
Design PatternsDescription
Preventing circular dependency references in a hierarchical treePerforming validation to optimize hierarchical tree set up
Process AI example applicationProcess AI example application
Using a Google AI model in PegaUsing a model built in Google AI platform in Pega