Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Updating connections and field mappings for a data object

Updated on April 6, 2022

To keep connection details current, reconnect data pages to a data source when connection details have changed. You can update existing connection details and field mappings, for example, if the authentication method has changed, or the schema of the data being sent has changed.

In general, only data sources created in App Studio can be updated in App Studio; however, a REST data source created in App Studio cannot be updated under the following conditions:
  • 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).
    Note: These limitations do not apply if you are connecting an existing data object that has no sources to a system of record, or if you are replacing a Pega source with a REST source.

Data sources created in Dev Studio can only be updated in Dev Studio.

  1. In the navigation pane of App Studio, click Data.
  2. In the Data pages column of a data object, click a data page.
  3. On the Data pages tab, in the row of the data page that you want to configure, and choose from the following options:
    Your data object is not connected to a system of record
    1. Click Connect to system of record.
    2. Optional: If you want to create a data model by using a spreadsheet, in the Configure source options dialog box, click Create data model using spreadsheet.
      For more information, see Creating a data model from a spreadsheet.
    Your data object is connected to Pega database storage or an external source, such as REST, and you want to update the sourceIn the row of the data page with the source that you want to replace, click MoreConfigure source.
    Note: If you are replacing an aggregate source, the new source replaces the entire aggregate source. You cannot replace the individual sources within the aggregate source.
  4. In the Connection details window, in the System field, select a system of record.
    • Create new - Create a new system to connect to an external database by using a REST connection. Then, enter a name and a description for the new system.
    • Use an existing system - Select the name of an existing system to connect to an external database by using a REST connection.
  5. In the Connection section, choose whether to connect to an endpoint URL or an OpenAPI specification.
    Enter endpoint URL
    1. In the Method field, choose the connection method, GET or POST.
    2. In the Endpoint URL field, enter the enter the endpoint URL of the data.
    3. In the Parameters section, choose which parts of the URL are dynamic and need to be parameterized for future calls.
      1. Select the URL part that you want to parameterize.
      2. In the Parameter name field, enter the name.
    4. In the Headers section, click Add header to specify a request header and its value. Some services require extra information, for example, API version.
    5. In the Authentication section, select the type of authentication to use to connect to the system of record.
      1. For more information about basic and NTLM authentication, see Authenticating with basic or NTLM authentication.
      2. For more information about OAuth 2.0 authentication, see Authenticating with OAuth 2.0.
    6. Optional: Update the data mapping as needed.
      For information, see Mapping fields for data pages.
    Use openAPI
    1. For more information about connecting to an OpenAPI Specification, see Integrating with a REST API by using OpenAPI Specification.
    2. Click Next to advance to the Data mapping page. For more information, see Mapping fields for data pages.
  6. Optional: On the Environment settings page, update the settings details for your production environment.
    For more information, see Preparing your data for production.
  7. Click Submit.

When you update a data source:

  • Previously generated artifacts are not deleted. New artifacts are created.
  • 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 make any changes to parameters on the Request tab of the visual mapper; otherwise, the data page is not modified.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us