3.3 Graph Matching with OT

Use Financial Crime Graph Refresh to refresh graph data in Compliance Studio and, optionally, perform OT matching. This guide describes installation, execution, and running the batch without matching.

To perform post-installation activity for Graph:

  • Overview

  • Prerequisites

  • Installation Procedure

    1. Import Graph Assets
    2. Initialize the ECM Schema
    3. Initialize the Graph Schema
    4. Initialize the ECM Graph Batch Schedule
    5. Install the OOB Graph Batch
    6. Confirm Database Permissions
    7. Run Graph Service Runtime Setup
    8. Prepare OT Matching
    9. Initialize Graph User Security
    10. Synchronize OOB Graph Metadata
    11. Initialize the Property Graph
    12. Configure Subgraph Loading if Required

Installation Completion Checklist

User Guide

  • Before You Begin

  • Execute the Batch

  • Schedule the Batch

  • Run the Batch Without Matching

  • Monitor Batch Execution

  • Complete Initial Setup

Documentation Placement Instructions

  • Installation Guide Changes

  • User Guide Changes

  • Cross-References and Navigation

Overview

Financial Crime Graph Refresh is recommended over the older OS-based OOB Graph Batch FinancialCrimeGlobalGraph for faster and more efficient graph data refresh. The batch supports graph refresh with or without matching. When matching is enabled, it uses OT. To run only the graph refresh tasks, follow the matching removal or exclusion instructions in the User Guide.

Table 3-2 Matching removal or exclusion instructions

Item Value
Batch display name Financial Crime Graph Refresh
Batch identifier FINANCIAL_CRIME_GRAPH_REFRESH
Matching option Optional; matching uses OT when enabled.
Recommended use Graph data refresh, with optional OT matching
Execution location Orchestration > Schedule Batch

By default, the batch includes graph-data refresh tasks, matching preparation for Customer, ICIJ External Entity, and ICIJ External Address, and a final matching task. Compliance Studio uses the configured dependencies to determine when each task can run. The matching tasks can be removed or excluded when only graph refresh is required.

Prerequisites

Before installing the batch, complete the applicable Graph Use Case setup in the OFS Compliance Studio Installation Guide.

  • Compliance Studio and Graph Service are deployed and available.
  • The Graph and ECM datasources are registered in the workspace. The Studio datasource is available for metadata synchronization.
  • Wallet connections and database permissions are configured. See Setup the Password Stores for Database User Accounts and the Graph schema permissions sections in the Installation Guide.
  • PGX and its keystore configuration are available. See Generate the graph-keystore.p12 File and Configure the PGX Service in the Installation Guide.
  • When matching is required, Entity Resolution is available, OT matching is configured, and the graph pipeline identifier is available.
  • The installation account can run the utilities on the server. The Compliance Studio account can access the workspace and the scheduling functions.

Installation Procedure

Run the following steps in order. If the graph assets, schemas, or ECM schedule have already been initialized for this environment, verify that setup before repeating the corresponding steps.

Replace /OFS_COMPLIANCE_STUDIO with the actual installation directory and replace all values in angle brackets with the environment values. Datasource names are case-sensitive and must match the names registered in the workspace. Wallet aliases and database schema names are supplied separately where indicated.

Initial setup with matching: Synchronize metadata with -p false, execute the batch and matching tasks successfully, and then initialize the Property Graph. For refresh-only execution against an existing graph, retain the existing graph setup. A new graph used without matching requires the applicable Graph Use Case setup for the installed release.

1. Import Graph Assets

Open a shell on the Compliance Studio server and run:

cd /OFS_COMPLIANCE_STUDIO/deployed/ficdb/graph-metadata/bin
./importGraph.sh

2. Initialize the ECM Schema

cd /OFS_COMPLIANCE_STUDIO/deployed/ficdb/graph-metadata/bin
./InitializeECMSchema.sh -w <ECM_SCHEMA_WALLET_ALIAS>

3. Initialize the Graph Schema

cd /OFS_COMPLIANCE_STUDIO/deployed/ficdb/graph-metadata/bin
./InitializeGraphSchema.sh \
-gw <GRAPH_WALLET_ALIAS> \
-es <ECM_SCHEMA> \
-bs <BD_SCHEMA>

4. Initialize the ECM Graph Batch Schedule

Complete the ECM schedule initialization if it has not already been performed as part of Graph Use Case setup. Supply numeric start and end day offsets for the required data period. The Financial Crime Graph Refresh batch is installed separately in the next step.

cd /OFS_COMPLIANCE_STUDIO/deployed/ficdb/graph-metadata/bin
./InitializeOOBGraphBatchScheduleECM.sh \
-ew <ECM_DATASOURCE> \
-sdg <START_DAY_OFFSET> \
-edg <END_DAY_OFFSET> \
-gd <GRAPH_DATASOURCE> \
-u <COMPLIANCE_STUDIO_USERNAME>

5. Install the OOB Graph Batch

Use the deployed OOB Graph Batch directory and the script name shown below. The filename is case-sensitive.

cd /OFS_COMPLIANCE_STUDIO/deployed/ficdb/oob-graph-batch/bin
./InitializeOOBGraphBatch.sh -d <GRAPH_DATASOURCE>

For a Graph datasource named GS, the command is:

./InitializeOOBGraphBatch.sh -d GS

Confirm that the utility reports OOB Graph Batch metadata was updated successfully.

6. Confirm Database Permissions

Verify that the Graph schema has the permissions required by the installed release. See Assign Pre-installation Grants for Graph Schema and Assign Postinstallation Grants for Graph Schema in the OFS Compliance Studio Installation Guide. Complete this prerequisite before runtime setup.

7. Run Graph Service Runtime Setup

cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./ExecuteGraphRunTimeLiquibase.sh -d <GRAPH_DATASOURCE>

8. Prepare OT Matching

Run the OT matching setup utility using the Graph datasource and the graph pipeline identifier configured for the deployment. Confirm that all selected preparation actions complete successfully.

cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./PrepareGraphOTMatching.sh --all \
--graph-datasource <GRAPH_DATASOURCE> \
--pipeline-id <PIPELINE_ID>

This utility is part of OT matching setup. When matching is included in a batch run, the batch runs its scheduled matching-preparation tasks during execution.

9. Initialize Graph User Security

cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./InitializeAtomicSchemaForUserSecurity.sh

10. Synchronize OOB Graph Metadata

Run this step after Graph user security initialization. Use -p false during initial setup. For a run with matching enabled, complete Property Graph initialization after the first successful batch and matching run.

cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./SyncOOBMetadataAndPgGraph.sh \
-c <STUDIO_DATASOURCE> \
-g <GRAPH_DATASOURCE> \
-s <ECM_DATASOURCE> \
-p false

Consider an environment with the following datasource names:

Table 3-3 a

Datasource Example name Command option
Compliance Studio datasource CS -c
Graph datasource GS -g
ECM datasource ECM -s

Using these datasource names, run the following command. Replace the example names with those configured in your environment:

./SyncOOBMetadataAndPgGraph.sh -c CS -g GS -s ECM -p false

11. Initialize the Property Graph

For initial setup with matching, execute Financial Crime Graph Refresh as described in the User Guide and confirm that the batch and matching tasks have completed successfully. Then initialize the Property Graph using the command below. Alternatively, run the synchronization command in step 10 with -p true.

cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./SyncOOBMetadataAndPgGraph.sh -g <GRAPH_DATASOURCE> -o true

For a Graph datasource named GS, run:

./SyncOOBMetadataAndPgGraph.sh -g GS -o true

Confirm that initialization completes successfully. Graph-only mode requires the earlier setup and metadata synchronization to be complete. An existing Property Graph is retained during standard initialization.

12. Configure Subgraph Loading if Required

Complete this step when the deployment includes Investigation Hub subgraph loading.
  1. Install Investigation Hub using the installation instructions for the deployed release.
  2. Run Policy Manager synchronization with the datasource and objective values configured for the environment.
cd /OFS_COMPLIANCE_STUDIO/deployed/mmg-home/mmg-load-to-graph/graph-service/utility/bin
./policy_manager.sh sync \
-s <SRC_DATASOURCE> \
-t <TGT_DATASOURCE> \
-o <OBJECTIVE_ID>

Installation Completion Checklist

  • All required installation utilities have completed successfully.
  • The Graph and ECM datasources are available in the intended Compliance Studio workspace. OT matching is configured if it will be used.
  • PGX starts successfully with the configured keystore and Studio keys.
  • Financial Crime Graph Refresh is available under Orchestration > Schedule Batch.
  • The first batch run and all included tasks have completed successfully. This includes the matching tasks when matching is enabled.
  • The Property Graph is initialized or the existing graph is available for use.
  • Investigation Hub and Policy Manager synchronization are complete if subgraph loading is required.

Parent topic: Post-Installation Steps