Getting case data from an external data source

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
Case data is stored in Content Platform Engine. However, you can use an external data service with a solution to access data from a different repository or other data source. This data is then incorporated into the case and stored with the rest of the case data in Content Platform Engine.

About this task

For example, you might have a database that contains detailed customer records. When a case worker enters a customer’s serial number, the external data service can get the name and address of the customer from that database. These values are then incorporated into the case data and stored in Content Platform Engine.

In addition to getting property values, you can use an external data source to modify property attributes such as minimum value or maximum value. The external data service must work within any constraints placed on the property attributes in Content Platform Engine. For example, if a minimum value is specified for the property in Content Platform Engine, the external data service cannot make the setting less restrictive. That is, the service can set the minimum only to a larger value. It cannot decrease the minimum value.

You can also use the external data service to define dependencies between properties. By using this feature, you can implement dynamic behavior in your solution. For example, you might specify a dependency between a state property and a city property. When a case worker selects a state, the choice list that is associated with the city property contains only cities that are in that state.
Note: External data service does not work with case Business Object properties.

Procedure

To get data from an external data source:

  1. Use the workflow APIs to implement a service to extract case data from the external data source.
  2. Use the Case configuration tool to register the external data service for use with your solution.
    Restriction: You can register only one external data service for a solution.
  3. Import the certificate of the External Data Services (EDS) server.
  4. Deploy or redeploy the solution and run it.
  5. Optional: If the EDS application is configured with a secured login, in the WebSphere® Application Server, under Security role to user/group for the EDS application, map the All Authenticated role to the special subject All Authenticated in Application's Realm.

Results

After you register the external data service, Case Client communicates with the service to get case data whenever case workers create cases or modify cases. This communication is handled automatically through the workflow APIs.

For properties that are associated with an external data service choice list, only the value, not the display name, is persisted. The Search widget, which generates a result set for the Case List widget, does not call the external data service to retrieve the display names for these properties. However, selecting the case from the Case List widget does cause the external data service to retrieve the property display names.

Important: You use the external data service only for retrieving data from an external source. For example, when a case worker creates or modifies a case, Case Client saves the data that was received from the external data source in Content Platform Engine. If the case worker modifies this data, Case Client does not update the corresponding data in the external data source.