Common Data and Integration Designer
Common Data and Integration Designer
Overview
The Data and Integration Designer, also called Designer case, uses a case-based approach
for extending the data model, automating workflows for adding new entities and properties,
adding relationships, and integrating with external sources. The Designer case has the
following stages:
When you create a new entity using the Designer case, the following rules are automatically
created:
CONNECT REST: Connect rest rule with the name of the entity is generated for the
new entity
DATA PAGES: Two Data Pages are generated for the entity: one page mode and one
list mode
SECTION: Different types of sections such as the entity header, content, and other
display-related sections are generated
ACTIVITY: Activity for the processing of each type method of connector such as GET,
POST, and PUT
DATA TRANSFORM: All the request and response Data transforms for different
connector methods are generated. Search-related Data transforms are also
generated
PROPERTY: Entity class ID and class name properties are generated
WHEN rule: When rules for different profiles of Data Page conditions are created
SERVICE REST: Service rest rules for the entity are created
LOCALIZATION: rules
VIEW: rules
Using a Designer case, Connect Rest rules can be created for external integration, thereby
allowing you to add new connectors to Data Pages and test the entity within the Designer
case. You can map these connectors to existing Data Pages and select the appropriate
profile for mapping.
If you are on a version earlier than release 25 or wish to use the latest updates of the
Common Data and Integration Designer case, follow these steps:
6. In the Status column, next to the Common Data and Integration Designer
component, click Enabled, then click OK.
7. Click Close.
8. Save the application rule to apply the changes.
Prerequisites for using the Designer case:
Before getting started using the Designer case, the following checks and configurations
must be performed. Note that this is a one-time configuration and need not be performed
every time the designer is run.
1. Create the entity class that the Designer case will automatically create new entities
into. By default, the entity class will be shipped as “Common-LDM-Entity”. If you
wish to create the entities within this class, this step can be skipped. If an org-
specific class is to be used, then create a new class having the directed inheritance
to Common-LDM-Entity. For example, if the entity class is “TFL-UplusINS-Entity”, it
should be inherited from Common-LDM-Entity.
2. A service package is a data instance for a collection of REST services. Specify the
appropriate service package that is present in the application. All the REST services
the Designer case generates are stored under this service package. If a service
package is not already present in the application, create a new one.
3. Optional: Create a test ruleset if it doesn’t already exist. Having a test ruleset
ensures that the rules needed to enable sample data generation are autogenerated
using the Designer case. If a test ruleset is not provided, the rules required to create
sample data should be manually created by the user. Sample data rules are
currently only supported if the entity class is “Common-LDM-Entity”.
a. Create a new test ruleset “UplusINSTest” and ensure that the check box
to store test cases is enabled and saved (verify this under category tab of
the ruleset). Lock the ruleset.
b. Add the ruleset to the application ruleset stack and save the app rule.
4. Ensure that all the rulesets are locked in the application.
5. Ensure that the integration class in application rule is not empty, this class will be
used to generate all the required integration assets. Click the Cases & data tab on
the application rule to check this.
6. Add configuration values for the Designer case. In the navigation pane of App
Studio, click Settings → Configurations →Configuration set: Common – Designer
Settings.
NOTE – The configuration values for this application will be saved as an instance
under Data-Configuration-Setting
a. Data ruleset – Specify the primary Ruleset of the application. All the core
rules that are generated through the Designer case are stored in this
primary Ruleset.
d. Entity class – Provide the name of the entity class that the Designer case
will automatically create new entities into.
e. (Optional) Test ruleset – Provide the name of the test ruleset where all the
rules for sample data for the entity and relationship will be created. This
step is optional. Sample data rules are currently only supported if the
entity class is “Common-LDM-Entity”.
8. Log off and log in to the application to pick up the configuration changes.
9. Enable branch development, click on the toggle for enabling branch development
and create a new branch.
This feature allows users to explore existing entities by viewing their properties and related
information. Users can also test an entity’s data pages and integrations.
Designer worklist (DID worklist)
This is a list of all Designer cases, which you can open and resume from where you previously
left off.
Using the Designer case:
Note – before beginning, ensure that branch development is enabled.
Navigate to App studio→ Tools→ Data & Integration Designer → Launch Designer Tool.
Create stage
After launching the Designer case, choose from one of the 3 options:
1. Create a new entity – used for creating new entities in the application
2. Inherit from existing entity - used for creating entities that inherit from available
entity classes in the application.
3. Reuse from existing entity – used for selecting existing entities and performing other
actions like adding fields, managing integrations, creating relationships, etc.
Create a new entity
When a new entity is created using the Designer case, all the essential rules will be
automatically created. The class rule, List and savable data pages, connector rules, service
REST rules, data transforms, default views, database table, etc.
Steps:
4. Click on Submit to proceed to the next steps which are creating the properties,
editing views, managing integrations and relations, etc.
To verify the rules generated, open the branch in Dev Studio and check for the details.
When an entity is inherited from an existing entity using the same name, all the capabilities
of the parent entity can be leveraged.
A new entity class is created and the data pages and other essential rules from the parent
class are saved into the new entity class. However, the integrations and services will not
be newly created, rather the parent entity’s rules are reused.
Steps:
Once all the rules have been generated, it displays a success modal listing the types
of rules generated.
Note: All the properties from the parent class will be included in the new entity and
they can be reused.
5. Click on Submit to proceed to the next steps which are creating the properties,
editing views, managing integrations and relations, etc.
To verify the rules generated, open the branch in Dev Studio and check for the details.
For example, if creating a new Contact entity that inherits from Common’s Contact entity
using the same name results in: TFL-UplusINS-Entity-Vehicle inherits Common-LDM-
Entity-Asset
When an entity is inherited from an existing entity using a different name, the capabilities of
the parent entity can be leveraged.
A new entity class is created, and new rules are created for that entity like data pages,
integration rules, views, etc. that inherit from the parent entity class.
Steps:
Once all the rules have been generated, it displays a success modal listing the types
of rules generated.
Note: All the properties from the parent class will be included in the new entity and
they can be reused.
5. Click on Submit to proceed to the next steps which are creating the properties,
editing views, managing integrations and relations, etc.
To verify the rules generated, open the branch in Dev Studio and check for the details.
For example, if creating a new Vehicle entity that inherits from Common’s Asset entity using
a different name results in: TFL-UplusINS-Entity-Vehicle inherits Common-LDM-Entity-
Asset
Steps:
The Extend the model portion of the page lists the entity’s properties.
1. Click Add property, fill in the required details in the dialog box, and click
Submit.
For more information, refer to Fields and Field Types | Pega Academy.
2. Verify that the new property appears in the Entity properties table.
You can configure views within an entity, deciding which template to use and what kind of
content to display in your View.
1. Select Create a new relationship. By default, the source entity will be the selected
entity (e.g., Contact).
2. Select the target entity to establish the relationship with.
3. Click Create to establish the relationship between the source and target entities.
4. Upon successful creation, a relationship creation summary will be displayed with
relevant details.
1. Choose the Select an existing relationship option, which lists all relationships for
the selected entity.
6. Click Submit.
For more information, refer to Fields and Field Types | Pega Academy.
7. Verify that the new property appears in the Entity properties table.
• Update the sample data template which tells the sample data upload logic the
properties to map from the sample data spreadsheet to the entity’s properties
• Download the sample data spreadsheet which contains each entity and
relationship’s sample data.
Note: If a test ruleset is not provided in the prerequisites or if the entity class is not
“Common-LDM-Entity”, the rules required to create sample data should be manually
created by the user. Sample data rules are currently only supported if the entity class is
“Common-LDM-Entity”.
Adding new fields to the Sample Data Template
To add new fields (properties) in the sample data template, follow these steps:
➢ Set the label as EyeColor and provide the value in the following format:
{.pxResults().EyeColor input}
Note: To add sample data for new entity or new relationship, add a new sheet and follow
the same steps mentioned above to add the fields.
By streamlining these configurations, the Manage Integration stage reduces manual effort,
ensures consistency, and accelerates the integration setup - enhancing overall
development efficiency.
1. Select the Data Page and one of its associated Profiles you want to configure the
external integration.
2. click Next.
For the selected profile, a Profile Viewer is displayed, visually illustrating the flow of
calling rules. These elements are clickable and open the respective rule forms for
easy access.
• Select Connector
• Modification Type
➢ Select the REST method (GET, POST, PUT, etc.) for the new source.
b. Connection details
• System Name - Enter the name of the source system. This field represents the
name of the system that hosts the external REST service.
• Resource Name - Enter the name of the resource that you want to access by
using the external REST service.
➢ For example, if the REST service is an eCommerce API such as Best Buy
and you want to use this API to access the product categories, you can
enter Product categories in this field.
• Endpoint URL - Enter the endpoint URL of the external REST service.
➢ Enter the endpoint URL from the service REST rule that you already have
set up or that you created in Creating a Service REST rule . The system
analyzes this URL and suggests the elements of the URL that represent
resource path parameters and query string parameters.
• Resource path - To update the suggested resource path names, in the Resource
path section, click Add component, and then select the Parameter check box
next to each resource path name that is a parameter.
➢ The resource parameters identified by the system are static and not going
to change. If there is a component that might change, select the check
box next to it to consider it a parameter. The system updates the endpoint
URL accordingly. The parameter is displayed in curly braces in the
endpoint URL. If you mark a resource path name as a parameter, the
system generates a property as part of the request data model and
substitutes the property's value for the value of the parameter at run
time.
• Query string parameters – Update the suggested query string parameters and
add more by clicking. The system considers query string parameters as part of
the request and creates properties for them.
• Headers - Add custom headers for the external REST service by clicking Add
header.
➢ The system adds each request header to the REST connector rule that is
generated for the method that you selected on the Source details (step
a) page. The value for each header is the value that you specify in the first
sample that you collect on the Data model page of the wizard.
➢ The Revoke access tokens button is not visible on this page. Instead, you
can use the Disconnect button as explained below.
➢ If you select Authorization code in the Grant type list, click Connect to
generate an access token. This action authenticates and authorizes your
connection with the OAuth 2.0 service provider and allows you to access
protected content. Click Disconnect to revoke the access token.
• Test service - After entering details, test the integration by invoking the service.
c. Upload request response – In this step, you can define the external data model for
your REST integration by adding a REST response or uploading a file. The system
parses sample requests and responses to determine the data model and populate
in the next step to Map Request Response.
• Add a REST response
➢ For POST and PUT methods, select the content type for the request and
configure the body of the request.
➢ The parameter and header values are applicable only for the current
instance of test execution for the method that you selected in step a.
➢ If you are using OAuth 2.0 with the authorization grant type to
authenticate your REST data source and if you did not connect to the
OAuth 2.0 service provider on the Connection page of the wizard,
click Connect to generate an access token. This action authenticates
and authorizes your connection with the provider and allows you to
access protected content.
➢ Once you are connected to the OAuth 2.0 service provider, click Run to
view the response. The header information is displayed on
the Headers tab.
➢ Click on submit to save the response.
• Add a file
➢ For POST and PUT methods, select the type of data that you want to
upload.
➢ Click Choose File to browse for a file of sample request or response data
and click Open to upload the file.
• Request
➢ In the Integration class field, update the name for the base class of your
REST integration.
➢ In the Parent class field, use the autocomplete control to update the
parent class for the integration. Choosing the correct integration layer is a
critical decision that affects whether a connector can be reused across
different applications.
➢ On the other hand, if the connector is intended for use across multiple
systems or business units, it should be placed in the Organization
Integration layer or
➢ In the Connector Name field, update the name of the REST connector.
The default name is the name that you entered on the Resource
methods page of the wizard. Click the Edit icon next to the ID field for the
REST connector to update the identifier for the connector.
➢ Click Create.
Click on Update data transform mappings to view the current request/response mappings
10. Test the Integration
Switch to the Test Entity stage and run the data page to validate the integration
results.
Test entity stage
In the Test Entity stage of the Designer case, users can test an entity for any selected profile
and run a data page to verify the results directly within the designer, without needing to
switch to Dev Studio.
For example, after adding a new property to an existing entity or setting up an external data
source integration, users can immediately verify the entity’s functionality.
Testing an Entity
2. For a GET method profile, provide the input parameters on the data page to populate
the data.
5. Modify the downloaded sample request file with the appropriate request body or
create a new one
6. Upload the updated or newly created request file and click "Submit" to invoke the
source.
7. Once submitted, the results will be displayed on the screen.
NOTE - The Test Entity feature can also be accessed directly from the Understand the
Data Model section of the Data and Integration Designer landing page, without needing to
initiate a Designer case.
Known Limitations
Generic limitations
• When creating multiple entities using different branches, ensure that all branch
conflicts are resolved for rules such as the ClassSettings data transform,
Determine API Source decision table, etc.
Workaround: Use the same branch for both entities, or merge the first entity's
branch before starting to work on the second entity.
• Within the Common Data portal, understand that the Data Model landing page will
not be functional.
Workaround: In App Studio, Understand the Data Model landing page is available
on the Designer landing page.
• If a class exists in Branch A, but the branch preference is set to Branch B when
creating a property in that class, it will result in errors.
Workaround: Use the same branch for creating properties as the one in which the
class is defined.
[Link]
[Link]
• By default, PEGA does not automatically create BLOB (pzpvstream) columns for link
tables (new relation class’s table). In a scenario where a relationship includes
unoptimized properties that require BLOB storage, users may need to manually
create the corresponding BLOB column in the corresponding relation table.
Manage Integration stage
• In the Map Request/Response step within the Manage Integration stage, you
cannot directly map a top-level property to a nested element without first defining
the top-level page or page list.
Workaround: Use the Review Configuration stage to configure advanced
mappings.
• In Manage Sample Data, a template can be saved only once per Designer case.
Workaround: Upload the template as a binary file from Dev Studio.