Skip to main content

Setting up Data and Integration Designer

Ensure that you perform the required checks and configurations for the one-time setup of the Data and Integration Designer.

Specify a service package

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 generated through the Data and Integration Designer are stored under this service package.

If a service package is not already present in the application, create a new one:

  1. In the navigation pane of Dev Studio, click Records > Integration-Resources > Service package.
  2. Provide the access group, for example TestApp:Admin.
  3. Change the Authentication type to: OAuth 2.0
  4. Click Save to save the Rule.

Optional: Add a test ruleset

Create a test Ruleset if it does not already exist. Having a test Ruleset ensures that the Rules that are needed to enable sample data generation are auto-generated when using the designer tool. If you do not provide a test Ruleset, you should manually create the rules that are required to create sample data. Sample data rules are currently only supported if the entity class is Common-LDM-Entity.

  1. Create a new test Ruleset, for example, UplusINSTest.
  2. Select the Use this Ruleset to store test cases checkbox.
  3. Save and lock the Ruleset.
  4. Add the Ruleset to the application Ruleset stack and save the application Rule.

Include an integration class

Make sure that the Integration class, which is used to generate all the required integration assets, is available. If it is not available, create a class and add it.

  1. In the header of Dev Studio, click Application > Definition.
  2. Click the Cases & data tab.

Add configuration values for the Designer in a new branch

You want to create your configuration values in a separate branch. This segregation ensures that your configuration settings are not lost if you are cleaning up rules created through the Designer.

  1. Create a new branch and enable it so that you can add configuration values for the Data and Integration Designer.
  2. In the navigation pane of App Studio, click Settings > Configurations > Configuration set: Common – Designer Settings, and complete the following values:
    Property Description Example

    Data ruleset  

    Specifies the primary Ruleset of the application. All the core rules that are generated through the Data and Integration Designer are stored in this primary Ruleset.

    TestApp

    Integration ruleset

    Specifies the integration Ruleset of the application. All the integration-layer rules and integration classes rules that are generated through the Data and Integration Designer (which are used for External SOR/Local SOR integrations) are stored in the integration Ruleset.  

    TestAppInt

    Service package

    Specifies the appropriate service package that is present in the application. A service package is a data instance for a collection of REST services. All the REST services that are generated through the Data and Integration Designer are stored under this service package.  

    TestAppService

    Entity class

    Specifies the name of the entity class where the designer tool automatically creates new entities.  

    Common-LDM-Entity

    (Optional) Test ruleset

    Provides the name of the test Ruleset where all the rules for sample data for the entity and relationship are created. This step is optional. Sample data rules are currently only supported if the entity class is Common-LDM-Entity.

    TestAppTest

Create a new branch and enable branch development.

Using a branch allows safe and controlled development by ensuring that you can test and validate changes before going live.

On your application definition, you lock and save all application rulesets and then create a branch.

Application branch and rulesets

In the header of Dev Studio, click the Toggle branch development icon to enable branch development.

Branch development settings

This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice