Load Xref Options

Owned by Natalie Gesin (Deactivated)
Last updated: Oct 23, 2024 by Kinga Huszno
2 min read

This page describes several settings available thru the EagleML/referenceTransaction/genericSMF/loadXrefOptions element in the incoming file and their global alternatives.

Switch Dynamic Loading Mode for Xrefs

​When you load a record, there are two options:

  • first 10 xrefs are loaded (old logic);

  • all populated xrefs are loaded (dynamic mode).

By default xrefs are loaded in dynamic mode.

You can switch dynamic load mode for xrefs

  • ​by setting the W_USEDYNAMIC_FOR_XREF=N variable in the configuration file (will affect all SMF loadings in region)

  • by adding the EagleML/referenceTransaction/genericSMF/loadXrefOptions element to your incoming file (which has higher priority that global setting W_USEDYNAMIC_FOR_XREF) with one of the following values:

LOAD_ALL to switch ON the dynamic mode for loading xrefs
LOAD_FIRST_10 to switch OFF the dynamic mode for loading xrefs

​Examples of Hybrid Settings

In case the global setting is W_USEDYNAMIC_FOR_XREF=N, but in the incoming record <loadXrefOptions> node is defined as ‘LOAD_ALL’, dynamic mode for loading xrefs will be used.

In case the global setting is W_USEDYNAMIC_FOR_XREF=Y (or omitted), but in the incoming record <loadXrefOptions> node is set to ‘LOAD_FIRST_10’, dynamic mode for loading xrefs will be switched OFF for current record.

Ignore Empty Xrefs

​To ignore identifiers with empty id values specified in the <xrefIdentifiers> section set EagleML/referenceTransaction/genericSMF/loadXrefOptions element to W_IGNORE_EMPTY_SECXREF like this:

<loadXrefOptions>W_IGNORE_EMPTY_SECXREF</loadXrefOptions>

Cancel Xrefs

If loadXrefOptions parameter is not set to W_IGNORE_EMPTY_SECXREF, identifiers with empty id values can be sent to the stored procedure to cancel and delete existing identifiers with the same types from SECURITYDBO.XREFERENCE table. loadXrefOptions can be used to control this process, you can set it to:

  • ALL to update all incoming identifiers in database

    <loadXrefOptions>ALL</loadXrefOptions>

  • A list of certain types to update only identifiers of these types

    <loadXrefOptions>CUSIP,ISIN,SEDOL</loadXrefOptions>

  • ALL excluding several types (types you want to exclude must be defined with the ! character)

    <loadXrefOptions>ALL,!CUSIP</loadXrefOptions>

Use Scopes

You can choose using old xref load logic and other load xref options will be unavailable.

If you keep to default dynamic load logic, there are several scenarios:

1. Default – default value will be used for all smf records if the configured or specific value is not specified. By default the Load Xreference Options are empty, which equals to ALL value. This means that all identifiers can be updated and identifiers with empty id value, specified in the <xrefIdentifiers> section, will be sent to the stored procedure as is and existing identifiers with the same types will be canceled and deleted from SECURITYDBO.XREFERENCE table.

2. Configured – a configured value from the custom configuration file eagle_ml-2-0_custom_cm/w_config_custom.inc will be taken for all smf records.

<CODE>CreateVariable(‘W_LOAD_XREF_OPTIONS’,‘W_IGNORE_EMPTY_SECXREF,CUSIP’);</CODE>

3. Specific – a specific value will be used only for the smf, where it is specified. It should be populated in the incoming message for this record in EagleML/referenceTransaction/genericSMF/loadXrefOptions element.

Load Xreference Options only make sense in Dynamic Xref Load mode (when setting W_USEDYNAMIC_FOR_XREF is set to Y or empty)

Convert to Upper Case Mode

Sometimes you want to force xrefs be loaded in upper case for a record to make them case insensitive. Please set loadXrefOptions to CONVERT_TO_UPPER to do so:

<loadXrefOptions>CONVERT_TO_UPPER</loadXrefOptions>

or use its global version W_LOAD_XREFID_IN_UPPER_CASE with the value Y.