Near Real Time Profile Insert or Update Following a Onekey VR Response Through DCR Process

Feature

This feature is to enhance the process of availability of profiles/changes in Reltio when Onekey approves a DCR. With V1 process, currently the DCR gets approved but the actual profile is received during the daily delta cycle once in a day. This feature is intended to reduce the amount of time for profile availability in case of new profiles and changes in case of existing profile in MDM and hence in downstream systems.

Process

When Onekey VR response includes the following information:

For HCP:

• Validated HCP OK ID (Onekey ID of the profile as it is validated by Onekey)

• Validated HCO OK ID (Onekey ID of the profile as it is validated by Onekey) in case the HCP DCR required a new Organization to be created

• Validated Activity OK ID (Onekey ID of the Activity affiliation as it is validated by Onekey)

For HCO:

• Validated HCO OK ID (Onekey ID of the profile as it is validated by Onekey)

When the process receives an accepted VR from Onekey, it downloads the validated profiles using Onekey API and pushes them into Reltio. This results in immediately updating the existing profiles and/or inserting the new ones.

Technical Assumptions

• Existing Address in the profile are not affected in case a create entity/activity DCR is accepted and the address of the new entity/relation is an existing one, the corresponding location entity cannot be touched by the process.

• In case of a create entity / create Activity DCR, the profiles might still not be present in Onekey, in this case the process keeps searching the profiles on scheduled intervals until they are retrieved. This is because of the delay in synchronization of the profile in OneKey

• By default OK API returns codes in format CODBASE.LIST.CODE (example: WUS.SP.01) while F14 flat file format uses LIST.CODBASE.CODE (ex.: SP.WUS.01). We need to ask Onekey to provide code values in the F14 formats and also ensure that we build the codes in the F14 format when loading data from the OK JSON returned by OKWS

• OneKey connector team must be informed to apply the "Reset" setting to ensure they can always send a record involved in a DCR, whether or not it has been modified and/or the DCR has been accepted. This way, even if we load incomplete data, the Onekey process can always update the profile with the proper values.

• This process can rely on Onekey API to retrieve data in near real time, while IDP process loads data from F14 flat files. To minimize the possible discrepancies between information loaded with the two different methods and to improve the performance, the attributes has been limited to be updated via this API process. The product specified attributes configured, can be extended as well based on the necessary requirements.

Supported Use Cases

Data Mapping

HCP

HCO

Activity

Prerequisites

The following are the prerequisite conditions:

• As per the V2 process, Onekey data load happens via F14 flat files. This feature needs API access to Onekey. Please raise request to Onekey team and ensure the enablement of the Web Service fields as defined in the data mapping section.

• To enable the process, check the Enablement Process section on how to deploy the default configuration through Monitor Stream.

• The process need configuration to be deployed via Postman Collection as shown below. The data is loaded in ODP_CORE_STREAM.DCR_CONFIGURATION table as shown below This is one time configuration deployment which deploys the configuration script, until it need to be changes and redeployed as part of the requirements. Details on how to changes is part the of the below section.

  

  

  

Enablement Process

To Enable the Process:

• The Monitor stream must be deployed with the below configuration.

• If the feature is not required, then it can be stopped with either persistOKProfReltioEnabled = No or leave it as empty.

• There are 2 templates provided as part of the baseline and data mapping. USOKTransformTemplate & GLOBALOKTransformTemplate contains the configurable script to convert Onekey json to Reltio model. Details of how to change and deploy has been provided in the below section.

  Attribute Names	Description
  event-created-before-hours	After the DCR sent to OneKey, the monitor process can start to look trace after 4 hours. Change according to the needs. 4hours is default value.
  run-interval-in-ms	DCR Trace Run Interval
  persistOKProfReltioEnabled	This is the config setting to enable this feature. If No or Blank,
  templateUSOKConversion	Name of the template for Onekey to Reltio conversion for US
  templateGBLOKConversion	Name of the template for Onekey to Reltio conversion for Non - US /Global
  approvedProfileWaitTimeMilis	Time to retry for profile to be available in OneKey after DCR approval. If it is more than a day(24hrs), then it completes the process and move towards approving the DCR.
  persistAdditionalAttributes	Once the traced profile is posted to reltio, this can enable the process to append additional attributes from non OK sources to reltio. This is applicable to create DCRs only.
  additionalAttributes	attributeName: attributes from external sources that should be appended to the profile. sourceName: source that should be considered for persistAdditionalAttributes. When value is 'ALL', all the soucrces is considered.
  waitForOkOvBeforeAccept	when enabled, trace process can complete only when profile exists in reltio

  

• If the DCR is Traced for an Approved DCR from Onekey, it stores the details in ODP_CORE_STREAM.DCR_TRACE table.

• The process creates an entry in the ODP_CORE_STREAM.EVENT_VALIDATION table for the streams to pick up and approve the DCR in Reltio and also updates ODP_CORE_STREAM.DCR_VALIDATION table with status = 'TRACED' if the persist to Reltio is success.

• If the DCR tried over approvedProfileWaitTimeMilis, then it can stop the persisting of the profile and can proceed to trace the DCR assuming that the profile is already present with the Batch Load via F14 file format.

  Columns	Description	Example
  EVENT_ID	Primary Key of the table
  VENDOR	vendor code for dcr	OK
  OBJECT_ID	change request id from mdm	3FHJHbH9
  ENT_REQ_PAYLOAD	request payload to search from vendor	base64 encoded payload. Use base64_decode_string function to see the values
  ENT_RES_PAYLOAD	response payload from vendor	base64 encoded payload. Use base64_decode_string function to see the values
  MDM_TRANSFORM_PAYLOAD	transformed payload in from vendor to mdm format	base64 encoded payload. Use base64_decode_string function to see the values
  OK_CONNECT_ID	connector id for onekey	Onekey Connector Id
  MDM_TENANT	mdm tenant id	MDM Tenant Id
  STATUS	process status	OK-Search:SUCCESS->OK-Transform:SUCCESS→MDM_Post_HCO:SUCCESS, shows the process flow
  STATUS_DESCR	description of status	If error then error is populated here
  MDM_URI	mdm unique keys of entity in the dcr	WORKPLACE:"entities/200i5o0t",INDIVIDUAL:"entities/17if3Bj0",ACTIVITY:"relations/24z2Lcfv"
  MDM_OBJECT_TYPE	entity type for which this dcr was raised	ACTIVITY/WORKPLACE

Data Flow Chart

Below process describes the overall process of the feature:

Onekey payload Conversion to Reltio

The payload conversion from Onekey to Reltio is configurable through a scripting language easier to develop and change:

• Open https://www.base64decode.org/ and decode the CONFIG_OBJECT in the DCR_CONFIGURATION table to see the base code as per the country.

• Use the playground https://datasonnet.ms3-inc.com/ to view and modify the script. Don't delete the product provided script as they are part of baseline.

• The output of the script should create a json having individual,workplace and activity as sample provided below to let the conversion work.

• Input payload: Should contain an array of elements.

  1. The first element in the array contains the search payload return from Reltio. The search is done via POST: <Reltio Api>/entities/_byCrosswalks/?select=uri,attributes.Address&ovOptions=true where the crosswalk value is OK id for HCP (in case of HCP DCR only).Otherwise the first element is empty.

  2. The second element in the array is the search result from OneKey.

     

     

     Product Specified Deployed Templates

     USDataSonnetTemplate.html

     GlobalDataSonnetTemplate.html

     USTemplate.txt

     Global Template.txt

     In case we are moving from V1.0 to V2.0 and want to retain the same Onekey code formats like codebase.lookupCode.sourceattr in Reltio then open the templates provided and change the below ones and redeploy the template with a separate name and use the same in the Monitor Streams.

     Copy

     Code Block

     local lookupAttr(sourceattr, codebase, lookup) = {
           //value: codebase+"."+lookup+"."+sourceattr   -- This is V1 code format
           value: lookup+"."+codebase+"."+sourceattr  -- This is V2 code format
       };

Troubleshooting

OneKey API

Trace:

POST: https://okws.ok.imshealth.com/vr/trace/<connectorId>

Search OK to trace DCR id status

{
    "isoCod2":"CA",
    "withDetails": true,
    "validation.clientRequestIds": ["1K8GBBKJ"]
}

Search:

POST: https://okws.ok.imshealth.com/ok/search/<connectorId>

Search Request to OK with HCP Id

{
    "resultSize": "10",
    "entityType": "Activity",
    "isoCod2" : "DE",
    "fields": [
        {
            "name": "individual.individualEid",
            "method": "EXACT",
            "values": [
                "WDEM01521592"
            ]
        },
        {
            "name": "workplace.workplaceEid",
            "method": "EXACT",
            "values": [
                "WDEH04042283"
            ]
        },
        {
            "name": "activity.activityEid",
            "method": "EXACT",
            "values": [
                "WDEM0152159201"
            ]
        }
          
    ]
}

Search Request to OK with HCO Id

{
    "resultSize": "10",
    "entityType": "Workplace",
    "isoCod2" : "DE",
    "fields": [
        {
            "name": "workplace.workplaceEid",
            "method": "EXACT",
            "values": [
                "WDEH04042283"
            ]
        }
          
    ]
}