4.6.2 Customize Data in ER Tables

Entity Resolution can be adapted for additional use cases by configuring the data in the metadata tables.

Note:

Out-of-the-box pipeline definitions should not be edited for customizations. If there are any customizations, create a copy of out-of-the-box pipeline definitions to apply any customizations otherwise the customizations will not persist when upgraded.
List of tables
  • FCC_M_ER_DATASET
  • FCC_M_ER_DATASET_GROUP
  • FCC_M_ER_DATASET_MAP
  • FCC_M_ER_DATASET_TL
  • FCC_STUDIO_ER_QUERIES
  • FCC_ER_INDEX
  • FCC_IDX_M_JSON_MAP
  • FCC_ER_ATTRIBUTES
Steps
Perform the following steps to customize the data using API:
  1. Get the Datasets that exist in the system:
    1. Configure the hostname.
    2. Run the following command:
      curl --location --request GET 'http://<HOSTNAME>:7051/datasurvival/
      getDataSet' \
      --header 'Content-Type: application/json'
      For example,
      curl --location --request GET 'http:// hostname.com:7051/datasurvival/
      getDataSet' \
      --header 'Content-Type: application/json'

      Note:

      To modify the Dataset, you can provide the existing value for datasetName to edit the JSON file and modify the other parameters except for datasetName in the same file according to the requirement.
  2. Enter the details of the Dataset in the Request JSON.
    1. Configure the hostname.
    2. Run the following command:
      curl --location --request POST 'http://<HOSTNAME>:7051/datasurvival/
      createdataset' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "fcc_m_er_dataset": {
      "tableId": "",
      "datasetName": "",
      "mapTable": "",
      "matchTable": "",
      "manualMatchTable": "",
      "manualMapTable": "",
      "viewDataset": "",
      "outputTable": "",
      "pipelineId":"",
      "statusFl": "",
      "productPartFl": "",
      "code": ""
      },
      "fcc_m_er_dataset_tl": {
      "tlTableId": "",
      "locale": "en-US",
      "tlDdatasetName": "Customer811"
      },
      "fcc_m_er_dataset_group": [
      {
      "groupTableId": "",
      "mapTableId": "",
      "groupMapTableJoin": "",
      "outputTable": "",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":"Y"
      },
      {
      "groupTableId": "",
      "mapTableId": "",
      "groupMapTableJoin": "",
      "outputTable": "",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "",
      "mapTableId": "",
      "groupMapTableJoin": "",
      "outputTable": "",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "",
      "mapTableId": "",
      "groupMapTableJoin": "",
      "outputTable": "",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "",
      "mapTableId": "",
      "groupMapTableJoin": "",
      "outputTable": "",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      }
      ],
      "fcc_m_er_dataset_map": [
      {
      "mapTableId": "",
      "datasetMapTableJoin": "",
      "outputTable": "",
      "statusFl": "Y",
      "productPartFl": "Y",
      "code": ""
      }
      ]
      }'
      For example,
      curl --location --request POST 'http:// hostname.com:7051/
      datasurvival/createdataset' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "fcc_m_er_dataset": {
      "tableId": "220",
      "datasetName": "Customer811",
      "mapTable": "FCC_ER_MAPPING_811",
      "matchTable": "FCC_ER_MATCHING_811",
      "manualMatchTable": "FCC_ER_MANUAL_MATCH_811",
      "manualMapTable": "FCC_ER_MANUAL_MAP_811",
      "viewDataset": "FCC_ER_VIEW_811",
      "outputTable": "STG_PARTY_MASTER",
      "pipelineId":"CSA811",
      "statusFl": "",
      "productPartFl": "",
      "code": ""
      },
      "fcc_m_er_dataset_tl": {
      "tlTableId": "220",
      "locale": "en-US",
      "tlDdatasetName": "Customer811"
      },
      "fcc_m_er_dataset_group": [
      {
      "groupTableId": "221",
      "mapTableId": "",
      "groupMapTableJoin": "STG_PARTY_MASTER_PRE.V_PARTY_ID =
      STG_PARTY_DETAILS_PRE.V_PARTY_ID",
      "outputTable": "STG_PARTY_DETAILS",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":"Y"
      },
      {
      "groupTableId": "226",
      "mapTableId": "",
      "groupMapTableJoin": "STG_PARTY_MASTER_PRE.V_PARTY_ID =
      STG_CUSTOMER_IDENTIFCTN_DOC_PRE.V_CUST_REF_CODE",
      "outputTable": "STG_CUSTOMER_IDENTIFCTN_DOC",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "223",
      "mapTableId": "224",
      "groupMapTableJoin": "STG_ADDRESS_MASTER_PRE.V_ADDRESS_ID
      = STG_PARTY_ADDRESS_MAP_PRE.V_ADDRESS_ID",
      "outputTable": "STG_ADDRESS_MASTER",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "225",
      "mapTableId": "",
      "groupMapTableJoin": "STG_PARTY_DETAILS_PRE.V_PARTY_ID =
      STG_PARTY_PHONE_MAP_PRE.V_PARTY_ID",
      "outputTable": "STG_PARTY_PHONE_MAP",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      },
      {
      "groupTableId": "222",
      "mapTableId": "",
      "groupMapTableJoin": "STG_PARTY_DETAILS_PRE.V_PARTY_ID =
      STG_PARTY_EMAIL_MAP_PRE.V_PARTY_ID",
      "outputTable": "STG_PARTY_EMAIL_MAP",
      "statusFl": "",
      "productPartFl": "",
      "code": "",
      "isParent":""
      }
      ],
      "fcc_m_er_dataset_map": [
      {
      "mapTableId": "224",
      "datasetMapTableJoin": "STG_PARTY_DETAILS_PRE.V_PARTY_ID =
      STG_PARTY_ADDRESS_MAP_PRE.V_PARTY_ID",
      "outputTable": "STG_PARTY_ADDRESS_MAP",
      "statusFl": "Y",
      "productPartFl": "Y",
      "code": ""
      }
      ]
      }'
  3. Delete the existing Dataset:
    1. Configure the hostname.
    2. Run the following command:
      curl --location --request POST 'http://<HOSTNAME>:7051/datasurvival/
      deleteDataSet' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId":""
      "datasetName":""
      }'
      For example,
      curl --location --request POST 'http:// hostname.com:7051/
      datasurvival/deleteDataSet' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId":"273"
      "datasetName":"Customer811"
      }'
  4. Get Dataset Hierarchy for table relation summary:
    1. Configure the hostname.
    2. Run the following command:
      curl --location --request POST 'http://<HOSTNAME>:7051/datasurvival/
      getDataSetHierarchySummary' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId": "",
      "datasetName": ""
      }'
      For example,
      curl --location --request POST 'http:// hostname.com:7051/
      datasurvival/getDataSetHierarchySummary' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId": "273",
      "datasetName": "Customer811"
      }'
  5. Get Dataset Hierarchy Tables' Data:
    1. Configure the hostname.
    2. Run the following command:
      curl --location --request POST 'http://<HOSTNAME>:7051/datasurvival/
      getDataSetHierarchy' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId": "",
      "datasetName": ""
      }'
      For example,
      curl --location --request POST 'http:// hostname.com:7051/
      datasurvival/getDataSetHierarchy' \
      --header 'Content-Type: application/json' \
      --data-raw '{
      "dataSetId": "273",
      "datasetName": "Customer811"
      }'
  6. To change any field name in the OpenSearch Index for the ER type:
    1. Modify the value in the QUERY column in the FCC_STUDIO_ER_QUERIES to bring the field name in the ES Index.
    2. Add the QUERY column values to the V_IDX_JSON column in the FCC_STUDIO_ER_QUERIES.

      Note:

      Ensure the value is the same in both columns, QUERY, and V_IDX_JSON.
  7. To populate the Source and target index on Ruleset UI:
    1. Add a new record in the table, FCC_ER_INDEX.
    2. Add Source and target attributes on respective indexes in the table FCC_ER_ATTRIBUTES.
    3. Create a new Ruleset for the customized ER type(s) in tables in the previous step. See the Creating Rulesets section in the OFS Compliance Studio User Guide for creating and configuring rulesets.
    4. Execute the ER jobs with customized ER type(s). For more information on how to execute the jobs, see the Executing the ER Jobs section.