MDM Web App Enrichments and Autocorrects

A typical nme-enrichments.gen.xml file has the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<enrichmentConfig>
    <autocorrectProviders>
        <autocorrectProvider class="com.ataccama.nme.dqc.enrichments.autocorrect.NmeAutocorrectPlanProvider">
            <autocorrects>
                 ...
            </autocorrects>
        </autocorrectProvider>
        <autocorrectProvider class="com.ataccama.nme.dqc.enrichments.autocorrect.NmeAutocorrectExpressionProvider">
            <autocorrects>
                ...
            </autocorrects>
        </autocorrectProvider>
    </autocorrectProviders>
    <enrichmentProviders>
        <enrichmentProvider class="com.ataccama.nme.dqc.enrichments.enrichment.NmeEnrichmentPlanProvider">
            <enrichments>
                ...
            </enrichments>
        </enrichmentProvider>
    </enrichmentProviders>
    <entities>
        <entity layerName="provider" name="party" type="MASTER">
            <autocorrectColumns>
                ...
            </autocorrectColumns>
            <enrichments>
                <enrichment name="person">
                    ...
                </enrichment>
            </enrichments>
        </entity>
            ...
        </entity>
    </entities>
</enrichmentConfig>

autocorrectProviders

The autocorrectProviders section contains the information about providers used for autocorrection.

<autocorrectProviders>
    <autocorrectProvider class="com.ataccama.nme.dqc.enrichments.autocorrect.NmeAutocorrectPlanProvider">
        <autocorrects>
            <autocorrect columnType="STRING" name="capitalize_or_upper" planFileName="../engine/enrichments/autocorrect/capitalize_or_upper.comp"/>
        </autocorrects>
    </autocorrectProvider>
    <autocorrectProvider class="com.ataccama.nme.dqc.enrichments.autocorrect.NmeAutocorrectExpressionProvider">
        <autocorrects>
            <autocorrect columnType="STRING" expression="lower(input)" name="lower"/>
            <autocorrect columnType="STRING" expression="upper(input)" name="upper"/>
            <autocorrect columnType="STRING" expression="capitalize(input)" name="capitalize"/>
        </autocorrects>
    </autocorrectProvider>
</autocorrectProviders>

autocorrectProvider:
- class: Class of the autocorrect provider. Possible values: NmeAutocorrectPlanProvider NmeAutocorrectExpressionProvider.
  - autocorrect:
    
    columnType: Data type of the autocorrect output.
    
    name: Unique autocorrect name.
    
    planFileName (for plan providers): Path to the file with the plan.
    
    expression (for expression providers): Name of the expression that is used for autocorrection.

enrichmentProviders

The enrichmentProviders section contains the information about providers used for enrichments.

<enrichmentProviders>
    <enrichmentProvider class="com.ataccama.nme.dqc.enrichments.enrichment.NmeEnrichmentPlanProvider">
        <enrichment name="person" planFileName="../engine/enrichments/enrichment/person.comp">
                    <columns>
                        <column name="first_name" output="true" type="STRING"/>
                        <column name="last_name" output="true" type="STRING"/>
                        <column name="birth_date" output="true" type="DAY"/>
                        <column name="type" output="false" type="STRING"/>
                        <column name="pid" output="true" type="STRING"/>
                        <column name="gender" output="true" type="STRING"/>
                    </columns>
                </enrichment>
            </enrichmentProvider>
    </enrichmentProviders>

enrichmentProvider:
- class: Class of enrichment providers. Available value is NmeEnrichmentPlanProvider.
  - enrichments:
    
    name: Unique enrichment name.
    
    planFileName: Path to the file with the plan.
    
    column:
    
    name: Unique column name that is used for mapping to actual database columns.
    
    output: If true, the column is used in the enrichment output and visible in the application.
    
    type: Column data type.

entities

The entities section contains the information about entities and their specific columns that the autocorrects and enrichments are mapped to.

<entities>
    <entity layerName="provider" name="party" type="MASTER">
        <autocorrectColumns>
            <column autocorrect="capitalize" name="cmo_first_name"/>
            <column autocorrect="capitalize" name="cmo_last_name"/>
            <column autocorrect="upper" name="cmo_pid"/>
        </autocorrectColumns>
        <enrichments>
            <enrichment name="person">
                <columns>
                    <column clickable="false" mapping="birth_date" name="cmo_birth_date"/>
                    <column clickable="true" mapping="first_name" name="cmo_first_name"/>
                    <column clickable="false" mapping="gender" name="cmo_gender"/>
                    <column clickable="true" mapping="last_name" name="cmo_last_name"/>
                    <column clickable="true" mapping="pid" name="cmo_pid"/>
                    <column clickable="false" mapping="type" name="cmo_type"/>
                </columns>
            </enrichment>
        </enrichments>
    </entity>
</entities>

entity:
- layerName: Name of the layer with the entity.
- name: Name of the entity.
- type: Type of the level. Possible values are MASTER, INSTANCE.
  - autocorrectColumns: Provides information about the columns to which autocorrects are mapped.
    
    column:
    
    autocorrect: Name of the autocorrect defined in the autocorrectProviders section.
    
    name: Name of the attribute in the database.
  - enrichments: Contains information about the columns to which enrichments are mapped.
    
    enrichment:
    
    name - Name of the enrichment defined in the enrichmentProviders section.
    
    columns:
    
    column:
    
    clickable: If true, the enrichment suggestion for this column can be selected in the MDM Web App.
    
    mapping: Enrichment column name.
    
    name: Column name in the database.

Was this page useful?