Skip to main content

Challenge

Adding an entity

Adding an entity

3 Tasks

20 mins

Visible to: All users Applies to: Pega Customer Service '25
Advanced
English

Scenario

After reviewing the Common Data Model, you concluded that you must extend it with an entity for contract data. Based on the requirements of your organization, you decide to add an entity called Contract, which has two fields, Active on and Expire on, which both are dates. The new Contract entity should be associated with the Customer Account entity.

Use the following credentials to log in to the exercise system:

Role User name Password
TestApp administrator testappadmin password123!

Your assignment consists of the following tasks:

Task 1: Create the Contract entity

Use the Data and Integration Designer to add a new entity named Contract, then add properties and update the views for the entity.

Task 2: Add properties

Add the ActiveOn and ExpireOn properties to the new entity.

Task 3: Review the entity and resolve the case

Review your changes and resolve the case.

Confirm your work: Add a Contract record

In the Data Portal, add a Contract and confirm the entity is working.

 

You must initiate your own Pega instance to complete this Challenge.

Initialization may take up to 5 minutes so please be patient.

Challenge Walkthrough

Detailed Tasks

1 Create the Contract entity

  1. On the exercise system landing page, enter the following credentials:
    1. In the User name field, enter testappadmin
    2. In the Password field, enter password123!
  2. In the navigation pane of App Studio, open the designer tool.
    1. Click Tools > Data and Integration Designer.
    2. Click Launch Designer Tool.
  3. In the Choose entity section:
    1. Select Create a new entity, then in the Entity name field enter Contract,
    2. In the Description field, enter Sets default values for creating a Contract.
    3. In the Entity abbreviation, field, enter: ctrt

    4. Click Create.

      The Data and Integration Designer creates the new entity including the Contract Case Type and the associated rules – database table, list and savable Data Pages, Data Transforms, Profiles, Views, and REST connectors. You can view the rules in the activated branch.

      Note: It may take a few minutes to create these rules.

      The Designer then displays a Summary page.

  4. Click Submit. The Designer displays the Extend the model stage.

2 Add properties

Add the ActiveOn and ExpireOn properties to the new entity.

  1. In the Extend the Model stage, add properties to the Contract entity:
    1. Expand the Entity properties, then click Add property.
    2. In the Field name, enter Active On.
    3. In the Type list, select Date only, and then click Submit and add another.
    4. In the Field name, enter Expire On.
    5. In the Type list, select Date only, and then click Submit.
  2. In the Extend the Model stage, click Configure Views, then expand the Views section.
  3. Select the Create view.
  4. In the Fields section, click Add > Fields, and then select the following checkboxes:
    • Active on
    • Expire on
  5. Click Add.

    The Preview shows the two new fields.

  6. Close the view.

3 Review the entity and resolve the case

Review your changes and resolve the case.

  1. Click the Manage integration stage.

    The Designer created a local database for the new entity and the rules needed to connect to the database. In our scenario, we use these default components. In your own scenarios, if you want to change the connector or the data source, you can complete these tasks using the Manage Integration stage.

    In our scenario, you are not going to change the integration, but in the next step, you review the components of the integration that the designer created for the new entity.

  2. On the Select profile page (in the Manage Integration section), select the Contract data page, then select the CONTRACT_DETAIL profile.

    The Designer shows a diagram of the selected Data Page and Profile and shows the Connector and Data Transforms created for the Profile. You can click each component to show the associated rules.

  3. At top of the page, select the Test entity stage.

    The Designer shows the Run Entity page, which tests the connector and data source by running the data page.

  4. Click Next. The Designer displays the Case summary.
  5. Click Resolve. The Designer completes the Add new entity case.


Available in the following mission:

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