4.1.1 Add Parameters to the Notebooks

An admin user can configure the parameters of the notebook as described in the following table.

Table 4-1 Configure Parameter for Notebook

Type Parameter Description Example Code Snippet to Override
Generic Configuration ENABLE_GRAPH_ANALYS IS It enables graph analysis if the value is set to “true”. The value is either true or false.

NOTE:

Set the value as “false” for the ECM case narrative notebook.

Set the value as “True” for the ECM Integration L1 and Special Investigation notebooks.

 To disable it in the ECM Integration L1 notebook.

ihub.config.ENABLE_GRAPH_ ANALYSIS = false;
Generic Configuration

ENABLE_ENTITY_SEARCH

 It enables additional entity search if the value is set to “true”. The value is either true or false.

By default, it is set to true.

 To disable it in ECM Integration L1 notebook.

ihub.config.ENABLE_ENTITY_SEARCH = false;
Generic Configuration RISK_PROHIBITED_LIST_O F_BUSINESS It indicates the prohibited list of businesses. For example, Bank. To update the list.

ihub.config.RISK_PROHIBITED_LIST_OF_BUSINESS =new ArrayList(); ihub.config.RISK_PROHIBITED_LIST_OF_BUSINESS.add(" BANK"); ihub.config.RISK_PROHIBITED_LIST_OF_BUSINESS.add(" AGRI"); ihub.config.RISK_PROHIBITED_LIST_OF_BUSINESS.add(" GOVT");

Or

ihub.config.RISK_PROHIBITED_LIST_OF_BUSINESS = List.of("BANK","AGRI","GO VT");
Generic Configuration TAX_HAVEN_COUNTRY_LI ST It indicates the list of countries having taxes. For example: CHE, BHS, ANB, US, etc. To update the list.

ihub.config.TAX_HAVEN_COUNTRY_LIST = List.of("CHE", "BHS","ANB", "US");
Generic Configuration DATE_DISPLAY_FORMAT It indicates the date format to display in the narrative/tabular format. The format isYYYY-MMM-DD.

NOTE: For more information on formatting the string, see the DateTimeFormatter.

Set the date format as follows.

ihub.config.DATE_DISPLAY_FORMAT =MM-dd-yyyy;
Generic Configuration ENABLE_LOG It enables logs in to the paragraph output if the value is set to “true”. The value is true or false. It helps to debug the notebook. By default, set it to false. To enable:

ihub.config.ENABLE_LOG = true;
Generic Configuration HIGH_RISK_MIN_SCORE_ BOUNDARY It indicates the risk score. If the values are more than HIGH_RISK_MIN_SCORE_BOUNDARY,it is considered as high risk. The values are 7 - 10. To set the minimum score boundary to 6:

ihub.config.HIGH_RISK_MIN_SCORE_BOUNDARY = 6;
Sub Graph Loading NODE_PROVIDER_EXPAN D_EXCLUSION_LIST It indicates subgraph loading for investigation; neighbors of the node providers mentioned in this list will be excluded from subsequent loading.
The values are:
  • “Derived Entity”
  • “Institution”
  • “ICIJ External Address”
  • “ICIJ External Entity”
 To override the exclusion list:

ihub.config.NODE_PROVIDER_EXPAND_EXCLUSION_LIST =List.of("DerivedEntity","ICIJ External Entity", "ICIJ External Address");

Or

ihub.config.NODE_PROVIDER_EXPAND_EXCLUSION_LIST.remove("Institution");
Sub Graph Loading INITIAL_LOAD_HOPS It indicates the number of hops to load for the initial step while creating the sub graph. The recommended values are between 0 to 2.The default value is 1.

Note:This affects the sub graph loading time.

For example: The value can be set to 0 to load entities without any edges.

 To override the value:

ihub.config.INITIAL_LOAD_HOPS = 0;
Real-time Matching

NOTE: It is applicable for Entity Search only.

SEARCH_TYPE It indicates the search type for matching. The value is fuzzy. To update it to "exact":

ihub.config.SEARCH_TYPE = "exact";
Real-time Matching

NOTE: It is applicable for Entity Search only.

NAME_SEARCH_METHOD It indicates the scoring method for the name search. The values are:
  • mlboostednamematching
  • jaroWinkler

To update the scoring method to “jaroWinkler”:

ihub.config.NAME_SEARCH_METHOD = “jaroWinkler”;
Real-time Matching

NOTE: It is applicable for Entity Search only.

ADDRESS_SEARCH_METHOD It indicates the scoring method for address search. The values are:
  • mlboostednamematching
  • jaroWinkler

To update the scoring method to “jaroWinkler”:

ihub.config.ADDRESS_SEARCH_METHOD = “jaroWinkler”;
Real-time Matching

NOTE: It is applicable for Entity Search only.

CONFIGURABLE_CED CED for address matching, where CED stands for Character Edit Distance.

Comparison is good for matching textual values that may be misspelled and thus have one or two character differences between each other. The value is auto.

For more information, see the OFS Compliance Studio Matching Guide.

 To set the value to 2:

ihub.config.CONFIGURABLE_CED = 2
Real-time Matching

NOTE: It is applicable for Entity Search only.

SLIDER_MIN_THRESHOLD It indicates the match score minimum value on the slider. For example, 50. To set the minimum value to 70%:

ihub.config.SLIDER_MIN_THRESHOLD = 70;
Real-time Matching

NOTE: It is applicable for Entity Search only.

SLIDER_MAX_THRESHOLD It indicates match score maximum value on the slider. For example, 100. To set the maximum value to 90%:

ihub.config.SLIDER_MAX_THRESHOLD = 90;
Real-time Matching

NOTE: It is applicable for Entity Search only.

SLIDER_THRESHOLD_STEP It indicates the slider step size. For example, 5. To set the slider step to 10%:

ihub.config.SLIDER_THRESHOLD_STEP = 10;
Real-time Matching

NOTE: It is applicable for Entity Search only.

SLIDER_THRESHOLD_DEFAULT It indicates the match score default value on the slider. For example, 50. To set the max value to 80%:

ihub.config.SLIDER_THRESHOLD_DEFAULT = 80;
Status Code Mapping STATUS_CODE_MAPPING It indicates the value of the status code. It is used to show Account and Customer status in the narrative paragraph. The status codes are as follows:
  • l A -Active
  • l I -Inactive
  • l N - Not a customer
  • l P -Pending
 To set the more mapping:

ihub.config.STATUS_CODE_MAPPING.put("C","Priority Customer");

To override the mapping:

ihub.config.STATUS_CODE_MAPPING= new HashMap<>; ihub.config.STATUS_CODE_MAPPING.put("A""Active"); ihub.config.STATUS_CODE_MAPPING.put("D","Dormant"); ihub.config.STATUS_CODE_M APPING.put("P","Priority Customer");
Color and Weight for Risk Factor and Red Flags DEFAULT_SCORE_FONT_ COLOUR It indicates the default score font color .For example, seagreen.

For more information, see Color Names for other color code.

To set the default color to blue:

ihub.config.DEFAULT_SCORE_FONT_COLOUR = blue;
Color and Weight for Risk Factor and Red Flags HIGHLIGHTED_SCORE_FO NT_COLOUR It indicates the highlighted score font color. For example, crimson. To set the default color to red:

ihub.config.DEFAULT_SCORE_FONT_COLOUR = red;
Color and Weight for Risk Factor and Red Flags DEFAULT_SCORE_FONT_ WEIGHT It indicates the default score font weight. The supported values are normal and bold. For example, normal. To set the default font to bold:

ihub.config.DEFAULT_SCORE_FONT_WEIGHT = bold;
Color and Weight for Risk Factor and Red Flags HIGHLIGHTED_SCORE_FO NT_WEIGHT It indicates the highlighted score font weight. The supported values are normal and bold. For example, bold. To set the highlighted font to normal:

ihub.config.HIGHLIGHTED_S CORE_FONT_WEIGHT =normal;
Color and Weight for Risk Factor and Red Flags HIGHLIGHTED_SCORE_MI N_VALUE

It indicates the highlighted score minimum value. If the value is less than HIGHLIGHTED_SCORE_MIN_VALUE, it will be displayed with default color and weight.

The minimum value is 6.

 To set the min value to highlight as 3:

ihub.config.HIGHLIGHTED_S CORE_MIN_VALUE = 3;
Disposition Score DISPOSITION_COLOUR_M AP It indicates a color map for disposition.

To set the color depending on score boundaries, add the minimum score as 1 and color in the hashmap. The higher value for the boundary will be less than the next boundary.

For example, the color and its boundary values are:

  • l seagreen[0,25]
  • l gold(25,51]
  • l darkorange(51,76]
  • l crimson(76,100]
  • If mapping is 0, the minimum value is 0 and maximum value is 25 for seagreen color.
  • If mapping is 25, the minimum value is 26 and maximum value is 51 for gold color.
  • If mapping is 51, the minimum value is 52 and maximum value is 76 for dark orange color.
  • If mapping is 76, the minimum value is 77 and maximum value is 100 for crimson color.
 To override the color:
  • Sea Green
    • Mapping: 0
    • Color: seagreen
    • Min Value: 0
    • Max Value: 24
  • Yellow
    • Mapping: 24
    • Color: yellow
    • Min Value: 25
    • Max Value: 39
  • Gold
    • Mapping: 39
    • Color: gold
    • Min Value: 40
    • Max Value: 59
  • Dark Orange
    • Mapping: 59
    • Color: darkorange
    • Min Value: 60
    • Max Value: 74
  • Crimson
    • Mapping: 74
    • Color: crimson
    • Min Value: 75
    • Max Value: 89
  • Brown
    • Mapping: 89
    • Color: brown
    • Min Value: 90
    • Max Value: 100

ihub.config.DISPOSITION_COLOUR_MAP = newHashMap<>; ihub.config.DISPOSITION_COLOUR_MAP .put(0,"seagreen"); ihub.config.DISPOSITION_COLOUR_MAP .put(24,"yellow"); ihub.config.DISPOSITION_COLOUR_MAP .put(39,"gold"); ihub.config.DISPOSITION_COLOUR_MAP .put(59,"darkorange"); ihub.config.DISPOSITION_COLOUR_MAP .put(74,"crimson"); ihub.config.DISPOSITION_COLOUR_MAP .put(89,"brown");
Disposition Score RECOMMENDATION_CLO SE_MESSAGE It indicates the default recommendation message. This is recommended when the disposition score is less than the first declared range.

For example, Close Case (Reason: False Positive)

 To update the recommendation close message:

ihub.config.RECOMMENDATION_CLOSE_MESSAGE = "False Positive, Close Case";
Disposition Score DISPOSITION_RECOMME NDATION_MAP It indicates a recommendation map for disposition.

To set the message depending on score boundaries, add the minimum score as 1 and the message in the hashmap. The higher value for the boundary will be less than the next boundary.

For example, the message and its boundary values are:

  • Close Case (Reason:False Positive) [0,25]
  • l Low Risk Network(25,51]
  • l Medium Risk Network(51,76]
  • Potential High Risk Network (76,100]

If mapping is 0, the minimum value is 0 and maximum value is 25 for Close Case (Reason: False Positive) message.

If mapping is 25, the minimum value is 26 and maximum value is 51 for Low Risk Network message.

If mapping is 51, the minimum value is 52 and maximum value is 76 for Medium Risk Network message.

If mapping is 76, the minimum value is 77 and maximum value is 100 for Potential High Risk Network message.

 To override the recommendation message:
  • If mapping is 0, the minimum and maximum values of the Close Case (Reason: False Positive) message are 0 and 24.
  • If mapping is 24, the minimum and maximum values of the Low Risk Network message are 25 and 39.
  • If mapping is 39, the minimum and maximum values of the Medium Risk Network message are 40 and 59.
  • If mapping is 59, the minimum and maximum values of the Potential High Risk Network message are 60 and 74.
  • If mapping is 74, the minimum and maximum values of the High Risk Network message are 75 and 89.
  • If mapping is 89, the minimum and maximum values of the Very High Risk Network message are 90 and 100.
ihub.config.DISPOSITION_RECOMMENDATION_MAP = new HashMap<>; ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(0,"CloseCase (Reason: FalsePositive)"); ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(24, "Low RiskNetwork"); ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(39, "Medium RiskNetwork"); ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(59, "Potential HighRisk Network"); ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(74, "High Risk Network"); ihub.config.DISPOSITION_RECOMMENDATION_MAP.put(89, "Very High Risk Network");
Disposition Score COUNTRY_SEPARATOR It indicates the delimiter for the attribute "Country". The value is ~ ; -
Advance Configuration

NOTE: The parameters should be updated only when the graph pipeline is customized.

GRAPH_NAME It indicates the PG graph name.

For example, FINANCIAL_CRIME_GLOBAL_GRAPH.

 -
Advance Configuration

NOTE: The parameters should be updated only when the graph pipeline is customized.

GRAPH_PIPELINE_ID It indicates the graph pipeline ID.

For example, 853e4164-XXXX-XXXX- XXXX-XXXXXXXXXXXX

 -
Advance Configuration

NOTE: The parameters should be updated only when the graph pipeline is customized.

RESULT_CASE_GRAPH It indicates the subgraph name. For example, caseGraph. -
Advance Configuration

NOTE: The parameters should be updated only when the graph pipeline is customized.

SEPARATOR It indicates the separator used in the graph pipeline. For example,~ -
Advance Configuration

NOTE: The parameters should be updated only when the graph pipeline is customized.

KEY_COLUMN_ID It indicates the key attribute for the node name. For example, id. -