Workflow example

IDM configurations can be managed using either the administration user interface, or by using the REST API. You can use the administration user interface to grant access to the pool for the Integration Gateway app.

Design time:

  1. Fulfill prerequisites - onboard for IDM by filing a ticket and creating a draft package.
  2. Set up configuration resources, including the pools and schemas that will organize the documents to be stored. This can be done through the administration user interface or the IDM REST API:
    1. Upload a JSON schema for the pool. Enable validation of document written to the pool (if required).
      Note: If a JSON schema is not available, a file with an empty schema containing {} can be uploaded.
    2. Grant one or more Integration Gateway apps access to the pool through the administration user interface Pool Detail screen.
  3. If a schema changes then the schema must be updated through the administration user interface or the REST API.

Run-time:

  1. The Integration Gateway app will retrieve documents from the third party source and store a JSON representation of those documents in the pool.
  2. Each document must comply with the schema for the pool. If a document does not comply, the update will result in an error or a warning depending on the pool schema validation setting.
  3. The Integration Gateway app will write documents to the pool. If there are multiple versions of the schema and the document to be written only complies with an older schema version, the schema version must be specified in the post document API call. Otherwise the latest schema version is assumed.
  4. When the document is written to IDM, a document ID is returned, which is required to retrieve the document. You can also search for all document IDs based on a secondary attribute.
  5. Typically the Integration Gateway app will make a call to ClaimCenter or PolicyCenter’s assessment API to provide it with standardized information about the assessment along with the document ID.
  6. xCenter can then retrieve the document using the document ID and the platform client.
  7. This information can then be used in business logic or passed to an embedded Jutro page or PCF page for display.