Skip to main content
This content has been archived and is no longer being updated. Links may not function; however, this content may be relevant to outdated versions of the product.
LinkedIn
Copied!

Table of Contents

Data Type wizard artifacts, error messages, and other processing

The Data Type wizard in the Integration Designer automatically generates artifacts, displays error messages, and performs additional processing that is useful to understand when you are developing and troubleshooting your application. 

Created artifacts

When you create a data type that uses Pega as the system of record, the following artifacts are created:

  • Data type class
  • Data type is added to the application
  • Object, list, and savable data pages
  • Report definition to get the list of data objects
  • New table for the data type

When you create a data type that uses REST to connect to the system of record, the following artifacts are created:

  • Data layer:
    • Data class for the new data type
    • Data type properties
    • Data type is added to the application
  • Integration layer:
    • Integration class
    • Connect REST rule
    • A new application setting is created for the authentication profile
    • A new application setting is created for the base URL
    • Response data transform
    • Response JSON data transform
    • Data page

When you replace a data source, the following artifacts are created or versioned:

  • Integration class, if it does not exist
  • Connect REST rule
  • A new application setting is created for the authentication profile
  • A new application setting is created for the base URL
  • Response data transform
  • Response JSON data page
  • The existing data page is versioned with the new source information

When you update a data source:

  • A new authentication profile is created if authentication is configured.
  • The REST connector and JSON data transform are versioned.
  • The response data transform (non-JSON) and integration class are not modified.
  • The data page is versioned if you add a new parameter to it on the Request tab of the visual mapper; otherwise, the data page is not modified.

The Data Type wizard creates all artifacts when you finish the wizard, except when you add a property in the Data Mapping page. The new property is created immediately. If you cancel or close the wizard, the property persists; it is not deleted.

When you replace or update a data type, previously generated artifacts are not deleted. New artifacts are created.

All artifacts can be viewed in Dev Studio.

    Conditions when a data source cannot be updated in App Studio

    In general, only data sources created in App Studio can be updated in App Studio; however, there are conditions when a data source created in App Studio cannot be updated. In these cases, only the replace option is available. The update option is not available for data sources created in App Studio when:

    • The JSON data transform or connector is opened and saved in Dev Studio.
    • The normal response data transform is modified in Dev Studio so that it no longer references only one updatable JSON data transform.
    • The data page is modified in Dev Studio in any of the following ways:
      • The data page no longer references a normal data transform as the response data transform.
      • The data page references a request data transform.
      • The connector parameters for the data source are obtained from the current parameter page (Pass current parameter page is set to true).

    Data and integration layers

    You can select the data layer in the Reuse assets from field on the first page of the Data Type wizard.

    Thumbnail

    Data layer selection

    The integration layer is set when you generate your application. You can modify the integration layer on the Cases & Data tab of the application rule form.

    Thumbnail

    Integration layer selection

    Relationship between the response structure and the data page

    When you create a data type, if the JSON response has a top-level list structure, then the data page is a list data page. If the JSON response is not a top-level list structure, then the data page is a single-object data page.

    When you replace or update a data source, you can replace any list or single object with any response, but you always have to match cardinality when mapping fields.

    Error messages 

    Error messages are displayed for invalid user inputs, invalid system-generated inputs, and environment issues. The following conditions might cause an error to be displayed:

    • The class name or field name is longer than 56 characters.
    • No rulesets are in the application.
    • All rulesets are locked.
    • Authentication fails.
    • There is a connection problem; for example, the host is not reachable.
    • The response format is not JSON.
    • The response JSON structure is invalid.

    To help with troubleshooting, you can view the actual JSON request and response by clicking the Information icon on the Data Mapping page.

    Thumbnail

    Call information

    Locked ruleset processing

    You cannot add a data type to a locked ruleset because the Data Type wizard cannot generate the rules. The Data Type wizard searches for the first unlocked ruleset. If the first ruleset that is selected is locked, the Data Type wizard searches for the next best ruleset. If all rulesets are locked, the Data Type wizard displays an error message. Rulesets are selected in the following order:

    1. Branch of the same ruleset as the record
    2. Current ruleset 
    3. User's record management preferences (application, branch, ruleset)
    4. Ruleset that defines the applies to class, if the object has an applies to class
    5. Ruleset in the same application as the class definition's ruleset, if the object has an applies to class
    6. Ruleset in the user's profile

    Supported authentication types

    The following authentication formats are supported for REST connections to the system of record:

    • Basic
    • NTLM

     

    Did you find this content helpful?

    Have a question? Get answers now.

    Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

    Ready to crush complexity?

    Experience the benefits of Pega Community when you log in.

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

    Pega Community 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
    Contact us