If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Batch Interface

MDM supports several input and output interfaces. The configured operations are generated into the Files/etc/nme-batch.gen.xml configuration file, which is referenced in the MDM Engine Configuration file (see MDM Engine Configuration File).

For the input interface, you can define the following modes:

direct load
initial load
full load
incremental load

Similarly, for the output interface, you can define the following modes:

full export
incremental export

Input Interfaces

Input interfaces consist of two elements: the data provider (usually a plan file whose Integration Output steps are used as an interface to the entities, see Data Providers) and the actual load operation. There are also some special operations designed to reprocess data already stored in the MDM database without having input data (see Special Interfaces)

Concepts and Settings

Delta Detection Process

When loading data, MDM always performs a Delta detection process to compare all incoming data (columns) with the data (columns) already stored in the database, and then it processes only those which differ. You can omit some columns from the comparison using the Ignore column functionality when defining the load operation.

By default, all attributes with SOURCE origin are used for delta detection. Some of them can be removed from the comparison process using the following construct (applies to all load operations). See the ignoredComparisonColumns element.

<op name="full_load_s1" class="com.ataccama.nme.engine.batch.FullLoadBatchOperation">
  <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />
  <sourceSystem>s1</sourceSystem>
  <importAllEntities>true</importAllEntities>
  <ignoredComparisonColumns>
    <column names="src_system_change_date" entities="*" />
    <column names="src_aud_*" entities="Address,Contact" />
  </ignoredComparisonColumns>
</op>

The <code>names</code> and <code>entities</code> attributes are comma-separated lists of names and name patterns (with * wildcard for matching any number of characters).

Deletion Strategy

There are two strategies available for a load operation to handle deletion: deactivate (default) and delete.

Each strategy has the following effect on the columns eng_active and eng_existing:

deactivate: eng_active=false while eng_existing=true.
delete: eng_active=false and eng_existing=false.

Deactivated records will still be part of processing and matching, and will be visible on the front-end (MDM Web App), but marked as deactivated. Deactivated records are available in export interface (see Export scope setting).

Deleted records are no longer available to any MDM hub processes, and will not be visible in MDM Web App. To remove a deleted record from the repository, run the Process Purge Service immediately (for more information, see Read-write Services, section Process Purge Service).

The strategy is configured by the sourceDeletionStrategy attribute:

<op name="direct_load" class="com.ataccama.nme.engine.batch.DirectLoadBatchOperation" sourceDeletionStrategy="deactivate">
   <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />
</op>

Data Providers

PlanBatchDataSource provider executes a DQC plan and maps its Integration Output steps to entity names. For example, Integration Output step named party receives records and provides them to further processing as records of entity party.

<dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />

Sequential Processing

When several load operations are started sequentially, the first is launched and the rest is enqueued. The same principle applies to both export and reprocess operations (a reprocess operation is a type of load operation, so it is enqueued together with load operations).

Direct Load Operation

The simplest batch load operation. This operation reads the data from the source and upserts all the records it finds. It can be used across multiple systems and is especially useful for performing initial loads. The direct load operation is capable of loading already "deleted" data, which it stores with eng_active = false . These "deleted" instances must have change_type = D when being loaded. However, this operation does Change Detection.

<op name="direct_load" class="com.ataccama.nme.engine.batch.DirectLoadBatchOperation">
   <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />
</op>

Initial Load Operation

Performs an initial load of all entities from a defined system. The only prerequisite is that there must be no records of that system in MDM storage. Appearance of records from other systems in the input will cause the plan to fail.

This operation should be used in the following scenarios:

initial load to an empty solution - use MultiLoad of InitialLoads of all source systems.
after adding new source system to the solution to load its records.
migration - use full instance export to load all data from all source systems - omit sourceSystem attribute (a record from any system can be loaded but storage must be empty and cannot be run in MultiLoad).

<op class="com.ataccama.nme.engine.batch.InitialLoadBatchOperation" name="life_initial" sourceSystem="life">
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../engine/load/life_initial.comp"/>
</op>

Only records of a configured source system can be loaded into the hub using this load operation and thus more of such initial load operations can be executed in a single MultiLoad (and reuse load plans for FullLoad).

This operation has the following features:

performance optimization.
- skips Change Detection (always).
- if there are no records in the MDM storage, optimized MDM processing (no records are read from the persistence) is used.
loads inactive records (input records with change_type = D), stores them with eng_active = false.
possibility to load history collectors.
possibility to load record metadata.

When using the initial load to populate an empty database, be sure to use the default nme.parallel.strategy=NONE.

Resumable Initial Load Checkpoints

Initial Load Checkpoints can be activated so that if the Load Operation fails you can rerun from the last successful consolidation action, rather than from the beginning. To activate this functionality, run the initial load with the parameter checkPointName defined.

MDM will save the first checkpoint at the start of Master Data Consolidation and then after every consolidation action (Clean, Match, Merge and others). The checkpoint is a directory with files containing records - by default the directory is named as a value of checkPointName parameter (passed to the batch load operation), and is in the temporary folder (this can be changed by runtime parameter nme.checkPoint.directory).

If the batch load fails, run it again with same value of checkPointName parameter, MDM will detect it and skip Data Acquisition, Change Detection (or Data Preparation) and any consolidation actions finished in the previous run. It is possible to fail and rerun multiple times, each time moving further to end.

Do not edit data between fails and reruns as Change Detection is skipped and loss of updates can occur.

Optimized MDM Processing

Optimized MDM processing means that the engine does not read any records from the persistence. This feature is used automatically if there are no instance records in the MDM persistence. If there are instance records (obviously of another source system), this optimization is not used.

Automatic decision can be overridden by setting the attribute ignorePersistence (see the example below) to true. This is an expert setting - there is no need to override to false in case of empty persistence and overriding to true might lead to wrongly computed data. Imagine there is already one source system loaded and InitialLoad is used to load a new one - new records will not be joined (CopyColumns) nor matched (Match) with the first source system.

Loading History Collectors

InitialLoad can load historical values - the content of history collector columns. Just provide values in records sent to IntegrationOutput in the column with the same name as history collector. Values will be combined from provided historical values and current value.

Loading Record Metadata

InitialLoad can be configured to load record metadata (eng_last_update_date, eng_creation_tid among others). To do so:

set the value of preserveMetadataColumns to true.
provide metadata in records sent to IntegrationOutput in columns with names as described below:

Input column name	Must be always filled	Must be filled for inactive records
source_timestamp
eng_creation_tid	X
eng_creation_date	X
eng_deletion_tid
eng_deletion_date
eng_last_update_tid	X
eng_last_update_date	X
eng_last_source_update_tid
eng_last_source_update_date
eng_activation_tid	X
eng_activation_date	X
eng_deactivation_tid		X
eng_deactivation_date		X

Input column name

Must be always filled

Must be filled for inactive records

source_timestamp

eng_creation_tid

eng_creation_date

eng_deletion_tid

eng_deletion_date

eng_last_update_tid

eng_last_update_date

eng_last_source_update_tid

eng_last_source_update_date

eng_activation_tid

eng_activation_date

eng_deactivation_tid

eng_deactivation_date

Notes:

record metadata must be set consistently - see second and third columns (inactive records are records with change_type = "D").
when providing *_tid value, be sure to have a safe number, such that will not be reused by the engine later or that has already been used.
source timestamp can be loaded as usual even if preserveMetadataColumns is not enabled.
however you cannot load a <null> source timestamp - if you provide null timestamp, start time of the initial load’s transaction will be used.

Load Record IDs

Initial load can be configured to load records IDs - so records will have given IDs instead of engine generating them automatically. To do so:

set the value of preserveIds to true.
provide an id in records sent to IntegrationOutput in the column named id.

Notes:

IDs must be unique for one entity, ideally across all entities.
For further loads, the engine will generate IDs automatically by a sequence - that sequence must be manually set to be higher than any input record ID.

Load Other Columns

Initial load can be configured to load any other column (not just of origin MATCH). To do so, list those columns in attribute preserveColumns - see the example below.

The values of these columns are available as previous values (old values). In matching, they can be accessed as is because columns of origin MATCH are input&output. Values of columns of other origins can be accessed by configuring oldValueProvider.

master_id column can be loaded as well.

Match Migration Options

There are the following exclusive options to influence the migration of matching IDs:

PRESERVE_AND_MATCH - All provided group IDs to be preserved as they are. New rules are applied and therefore matching ID is only assigned if the group ID is empty on the migration load input. Relationship is defined across more Connected Systems. This is the suggested option for Reference data, dictionaries or manual Matching Exceptions.
RELOAD - All provided group IDs are both re-computed and re-used, that is, previous matching result is preserved only if it is proofed by the new rules.
PRESERVE_AND_ASSIGN - Matching is not performed at all. Records without group IDs are considered as having no key, and a unique group ID is assigned to each record. It is recommended to perform reprocess & rematch right after the migration to correctly match the records without previous result (with unique group ID assigned during the migration process).

If no option is provided, the behavior is the following: all provided IDs are preserved, missing IDs are matched (that is, Preserve and Match mode is used).

Fully Configured Example

<op name="initial" class="com.ataccama.nme.engine.batch.InitialLoadBatchOperation">
  <sourceSystem>life</sourceSystem>
  <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.comp"/>
    <ignorePersistence>true</ignorePersistence>       <!-- default is automatic decision based on presence or records in persistence -->
    <matchingMode>PRESERVE_AND_MATCH</matchingMode> OR <matchingMode>PRESERVE_AND_ASSIGN</matchingMode> OR <matchingMode>RELOAD</matchingMode><!-- matching ids migration - additional options  -->
  <preserveMetadataColumns>true</preserveMetadataColumns> <!-- default is false -->
  <preserveIds>true</preserveIds>             <!-- default is false -->
  <preserveColumns>
    <column entities="*" names="mat_*" /> <!-- Similar concept as in ignoredComparisonColumns -->
  </preserveColumns>
</op>

Full Load Operation

Performs a full load of selected entities from a defined system. Entities not mentioned in the definition will not be imported, even though the corresponding IntegrationOutput is present in the plan. Appearance of records from other systems will cause the plan to fail.

<op name="full_load_s1" class="com.ataccama.nme.engine.batch.FullLoadBatchOperation">
  <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />
    <sourceSystem>s1</sourceSystem>
    <importedEntities>
        <entity name="Party" />
        <entity name="Address" />
    </importedEntities>
</op>

One can either specify the list of imported entities in <importedEntities> element or choose all entities by specifying <importAllEntities>true</importAllEntities>.

Delta Load Operation

Delta load definition consists of a data source and several entity descriptors that define how each imported entity should be dealt with. Entities without descriptors will not be imported regardless if the corresponding IntegrationOutput is present in the plan or not. Each entity type can have a columns element listing only the columns that are loaded and affected by the operation.

<op name="delta_load" class="com.ataccama.nme.engine.batch.DeltaLoadBatchOperation">
  <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/load.plan" />
  <descriptors>
    <descriptor class="com.ataccama.nme.engine.batch.load.AutonomousEntity" name="GenderLookup" />
    <descriptor class="com.ataccama.nme.engine.batch.load.CentralEntity" name="Party" keyColumn="source_id"/>
        <columns>
            <column>src_birth_date</column>
        </columns>
    <descriptor class="com.ataccama.nme.engine.batch.load.CentralEntity" name="Contract" keyColumn="source_id"/>
    <descriptor class="com.ataccama.nme.engine.batch.load.DependentEntity" name="AkaName" keyColumn="party_source_id" centralEntity="Party"/>
    <descriptor class="com.ataccama.nme.engine.batch.load.PartitionedDependentEntity" name="Address" >
      <partitions>
        <partition originId="sys1#PartyAddress" keyColumn="party_source_id" centralEntity="Party" />
        <partition originId="sys1#ContractAddress" keyColumn="contract_source_id" centralEntity="Contract" />
      </partitions>
     </descriptor>
  </descriptors>
</op>

AutonomousEntity

This is the easiest case. The entity is processed independently from the rest of the entities. The change is determined by input column change_type (I,U,D), the data is matched with the hub using (origin, source_id) combination. The only parameter is name, the name of the entity from model.xml.

CentralEntity

Similar to AutonomousEntity, however, it also defines change processing for the corresponding DependentEntity descriptors. The change is again determined by the change_type column, and the data is matched with the hub using (origin, source_id) combination. The corresponding dependent entities are identified by the value of the column whose name is given in keyColumn. The value must be unique for all records in AutonomousEntity. Usually, it will be source_id.

DependentEntity

An entity depending directly on a CentralEntity, that is, it has no change indication on the input, and if a central record entity appears in the load, all its dependent records will be there as well. The change is determined by the change_type on the corresponding central entity and locating all the dependent records in the hub; the two lists are compared using source_id, and the changes are processed accordingly.

The central entity record is obtained using the value of keyColumn column in the entity given in centralEntity. An error will occur (and load will fail) if the load contains a dependent entity record without its central entity record.

A good example of the dependent entity is a subelement in an XML file. For example, the top element of the XML file holds the client data and has the change_type column. A subelement like address or contact is dependent because all occurrences of mentioned entities are involved in the incoming data.

PartitionedDependentEntity

Like dependent entity, but different centralEntity and keyColumn attributes could be prescribed for each origin.

Output Interfaces

Export operations are used to export data from MDM hub.

<op class="com.ataccama.nme.engine.batch.StandardBatchExportOperation" name="batch_export">
  <dataProviders>
    <dataProvider prefix="inst_" class="com.ataccama.nme.engine.batch.InstanceLayerDataSource" scope="ACTIVE"/>
    <dataProvider viewName="dst" prefix="dst_" class="com.ataccama.nme.engine.batch.MasterLayerDataSource" scope="EXISTING"/>
    <dataProvider prefix="instInc_" class="com.ataccama.nme.engine.batch.InstanceLayerDeltaDataSource" scope="EXISTING"/>
  </dataProviders>
  <publisher class="com.ataccama.nme.dqc.batch.PlanBatchExportPublisher" planFileName="../batch/batch_export.plan">
    <pathVariables>
      <pv name="BATCH_OUT" value="/mdc/data/out"/>
    </pathVariables>
  </publisher>
</op>

Parameters:

scope:
- ACTIVE: exports only active records.
- EXISTING (default)
prefix: prefix of integration inputs using this provider.
viewName (master only): name of the master layer from which to provide data.
sourceSystem (instance only, optional): if defined, only data from the specified source system will be exported.

Output Interfaces with Conditions

There are 4 more data providers that allows advanced filtering:

MasterEntityDataSource for master entity
MasterEntityDeltaDataSource for incremental master entity
InstanceEntityDataSource for instance entity
InstanceEntityDeltaDataSource for incremental instance entity

These data providers exports records of only one entity but user can configure record filtering. Apart from parameters defined above:

user must set parameter entity
user can specify conditions (more conditions are evaluated as AND) - there can be only one condition per column:

<conditions>
  <condition column="src_gender" value="M" operator="EQ" />
  ...
</conditions>

Possible values for parameter operator:

Value

IS_NULL

IS_NOT_NULL

Meaning

⇐

IS NULL

IS NOT NULL

The LIKE operator syntax uses wildcard * (meaning any characters). See example below.

If the IS_NULL and IS_NOT_NULL operators are used, value should be empty.

Full example:

<dataProvider prefix="mas_party_" class="com.ataccama.nme.engine.batch.export.MasterEntityDataSource" scope="ACTIVE" entity="party" viewName="mas">
<conditions>
  <condition column="cio_gender" value="M" operator="EQ" />
  <condition column="score_instance" value="1000" operator="LT" />
  <condition column="cio_first_name" value="John*" operator="LIKE" />
  <condition column="cio_last_name" operator="IS_NOT_NULL" />
<conditions>
</dataProvider>

Special Interfaces

Reprocess Operation

Reprocess operation is a special type of a load operation. Its purpose is to reprocess selected records stored in MDM storage - selected records are read from the MDM storage and sent to the MD Consolidation process.

Records of various origins (different entities and records from different source systems) can be reprocessed together in one load operation.

<op name="reprocess" class="com.ataccama.nme.engine.batch.ReprocessBatchOperation">
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/reprocess.plan" />
    <recordIdentification>SOURCE_ID</recordIdentification>
</op>

Parameters:

dataProvider - same as in other load operations, see Data Providers.
recordIdentification: SOURCE_ID (default) or ID. Specifies how the records are identified - whether the (origin, source_id) pair or the id column is used.

The Reprocess Operation reads the record identifiers from the correctly named Integration Outputs and reprocesses the corresponding records that have been found in the MDM storage.

Record identifiers not corresponding to any record will be reported as ", nnn request(s) ignored" in Data loading phase.
Unmodified records will be reported as ", nnn record(s) ignored" during Committing step. Unmodified records will not be written (unless specified otherwise - see Runtime Parameters).

The Reprocess operation can force rematching as well - Integration Output together with record identifier expect rematch_flag (rematchFlagColumns of all matchings of entity corresponding to Integration Output).

Example input with recordIdentification set to SOURCE_ID for Integration Output of entity party having two matchings with rematchFlagColumns rematch_flag and rematch_flag_mkt:

source_id	origin	rematch_flag	rematch_flag_mkt
P854637	crm#party#party	true	false
P216584	crm#party#party	true	false
C68125	crm#party#party	false	false

source_id

origin

rematch_flag

rematch_flag_mkt

P854637

crm#party#party

true

false

P216584

crm#party#party

true

false

C68125

crm#party#party

false

Full Reprocess Operation

Similar to the Reprocess operation but processes all records of the selected entities; useful during migrations. There is no data provider nor plan file for this operation. In this operation, all data from the selected entities are read, so data in the MDM storage and input data are matched. Similar to the Reprocess Operation, unmodified records are reported as ", nnn record(s) ignored" during the Committing phase.

<op name="full_reprocess" class="com.ataccama.nme.engine.batch.FullReprocessBatchOperation">
   <processAllEntities>false</processAllEntities>
   <processedEntities>
      <entity name="Party" />
   </processedEntities>
</op>

Parameters:

Parameter Description

Parameter	Description
processAllEntities	If `true`, all instance layer entities will be reprocessed.
processedEntities	List of selected entities if `processAllEntities` is `false`.
rematchAll	If `true`, all `rematchFlagColumns` will be `true` and therefore all records will be not only reprocessed but rematched as well (if rematchFlagColumns are configured in Matching steps).
preserveMetadataColumns	Expert setting - if `true`, instance record metadata will be preserved, might be useful for FullReprocess used for migration.
ignorePersistence	FullReprocess operation has performance optimization - if `processAllEntities` is `true`, MDM process is optimized to ignore records in the persistence in several phases: in CopyColumn no records are read from persistence. in Match no records are expanded. in Merge, the Prepare phase does not read records from persistence. You can turn off this optimization by setting this to `false`.

processAllEntities

If true, all instance layer entities will be reprocessed.

processedEntities

List of selected entities if processAllEntities is false.

rematchAll

If true, all rematchFlagColumns will be true and therefore all records will be not only reprocessed but rematched as well (if rematchFlagColumns are configured in Matching steps).

preserveMetadataColumns

Expert setting - if true, instance record metadata will be preserved, might be useful for FullReprocess used for migration.

ignorePersistence

FullReprocess operation has performance optimization - if processAllEntities is true, MDM process is optimized to ignore records in the persistence in several phases:

in CopyColumn no records are read from persistence.
in Match no records are expanded.
in Merge, the Prepare phase does not read records from persistence.

You can turn off this optimization by setting this to false.

Manual Match Operation

ManualMatch is a special type of load operation that can load manual match operation requests.

<op name="manual_match" class="com.ataccama.nme.engine.batch.ManualMatchBatchOperation">
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/manual_match.plan" />
</op>

Operation by default expects input for all Matching steps (that is, matchings configured in matchingOperation). That can be optionally limited to only some matchings:

<op name="manual_match" class="com.ataccama.nme.engine.batch.ManualMatchBatchOperation">
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../batch/manual_match.plan" />
  <matchings>
    <matching>sin</matching>  <!-- "sin" is name of matching in matchingOperation in model configuration file -->
    <!-- more -->
  </matchings>
</op>

Expected input columns are:

Column name Type Description

Column name	Type	Description
`operation`	STRING	Possible values are: `MERGE_INSTANCE` `SPLIT` `UN_ISOLATE` `MERGE_MASTER`
`id`	LONG	instance record id to be merged or split (required for `MERGE_INSTANCE`, `SPLIT`)
`isolate_group_id`	LONG	to isolate several instance records together to the same master group, set the same value in this column (optional in `SPLIT`)
`<master_id_column>` *	LONG	master id of instance records to be merged into another master group (required for `MERGE_MASTER`) column name is configured in matchingOperation in model configuration file, default is `master_id`
`target_<master_id_column>` *	LONG	target master id to be set on selected instance records (required for `MERGE_INSTANCE`, `MERGE_MASTER`) column name is prefix "target_" + name configured in matchingOperation in model configuration file, default is `target_master_id`

operation

STRING

Possible values are:

MERGE_INSTANCE
SPLIT
UN_ISOLATE
MERGE_MASTER

id

LONG

instance record id to be merged or split (required for MERGE_INSTANCE, SPLIT)

isolate_group_id

LONG

to isolate several instance records together to the same master group, set the same value in this column (optional in SPLIT)

<master_id_column> *

LONG

master id of instance records to be merged into another master group (required for MERGE_MASTER)
column name is configured in matchingOperation in model configuration file, default is master_id

target_<master_id_column> *

LONG

target master id to be set on selected instance records (required for MERGE_INSTANCE, MERGE_MASTER)
column name is prefix "target_" + name configured in matchingOperation in model configuration file, default is target_master_id

* In case of multiple Matching steps, there is a pair of <master_id_column> , target_<master_id_column> for every Matching step (names are taken from configuration of matching operation in model configuration file).

Task Status Export

Task Status is a special type of export operation. The information about the MDM executor tasks is internally stored as a CLOB in table <prefix>_TASKS. Similar status information is also available for Event Handlers (internally stored as a CLOB in the <prefix>_EH_TASKS table).

In order to get all this status information, you can use the standard batch export with special data providers:

<op name="task_info" class="com.ataccama.nme.engine.batch.StandardBatchExportOperation">
   <dataProviders>
       <dataProvider class="com.ataccama.nme.engine.batch.TaskInfoDataSource" prefix="te_"/>
       <dataProvider class="com.ataccama.nme.engine.batch.TaskEventHandlerInfoDataSource" prefix="eh_" />
   </dataProviders>
   <publisher class="com.ataccama.nme.dqc.batch.PlanBatchExportPublisher" planFileName="../export/task_info.comp"/>
</op>

Parameters:

dataProvider class:
- TaskInfoDataSource for executor task info (batch load, batch export, RW service).
- TaskEventHandlerInfoDataSource for event handler task information.
  - prefix: prefix of integration inputs using this provider.

Both `dataProvider`s provide two inputs in the export plan:

tasks - one record per tasks.
subtasks - detailed information; each task can have 0 or more subtasks.

Because both providers have the same name of entities (see below) for their inputs, it is recommended to prefix event handler inputs with, for example, eh_. Task executor can be prefixed as well.

Input Tasks

Input tasks slightly differ for executor tasks and event handler tasks.

Column name	Column type	Description
id	LONG	Task ID
task_id	LONG	Available only for event handler tasks - task id (batch load execution or RW service call) that triggered the event handler task
name	STRING	Operation name
result	STRING	Not available for event handler tasks
enqueued	DATETIME	Not available for event handler tasks
started	DATETIME	Start timestamp
finished	DATETIME	Finished timestamp
duration	LONG	Duration in milliseconds

Column name

Column type

Description

LONG

Task ID

task_id

LONG

Available only for event handler tasks - task id (batch load execution or RW service call) that triggered the event handler task

name

STRING

Operation name

result

STRING

Not available for event handler tasks

enqueued

DATETIME

Not available for event handler tasks

started

DATETIME

Start timestamp

finished

DATETIME

Finished timestamp

duration

LONG

Duration in milliseconds

Input Subtasks

Input subtasks are the same for executor tasks and event handler tasks.

Column name Column type Description

Column name	Column type	Description
task_id	LONG	Link to to the Task table above
name	STRING	Sub-operation name
started	DATETIME	Start timestamp
finished	DATETIME	Finished timestamp
duration	LONG	Duration in milliseconds
detail	STRING
volume	LONG	Number of records (if it makes sense)
parents	STRING	List of parents' names, concatenated by semi-colon `;`

task_id

LONG

Link to to the Task table above

name

STRING

Sub-operation name

started

DATETIME

Start timestamp

finished

DATETIME

Finished timestamp

duration

LONG

Duration in milliseconds

detail

STRING

volume

LONG

Number of records (if it makes sense)

parents

STRING

List of parents' names, concatenated by semi-colon ;

Task Migration Load Operation

Task migration load operation allows migrating tasks and drafts.

<op class="com.ataccama.nme.internal.engine.tasks.batch.AppendTaskLoadBatchOperation" description="" name="migration_load_task">
    <applyDefaultValues>false</applyDefaultValues>
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../engine/migration/migration_load_task.comp"/>
</op>

Parameters:

<applyDefaultValues>: If set to true, null and empty input values are overridden by task template defaults.
dataProvider: Same as in other load operations, see Data Providers.

The following table shows the columns in the task step, which records the data to the table tasks_tasks.

Column name Column type Description

Column name	Column type	Description
id	LONG	Task identifier (will be regenerated by the database).
type	STRING	Task type. Possible values are: `RECORD_CHANGE`, `MANUAL_MATCH`, `MATCHING_PROPOSAL`, `CREATE`, `GENERIC`.
name	STRING	Name of the task.
description	STRING	Task description.
status	STRING	Task status. Possible values are: `NEW`, `IN_PROGRESS`, `RESOLVING`, `RESOLUTION_FAILED`, `RESOLVED`, `DISCARDED`.
entity_id	STRING	Entity identifier.
workflow_name	STRING	Name of the workflow, for example, `consolidation`.
workflow_step	STRING	Name of the workflow step.
user_assignee	STRING	Name of the user to whom the task is assigned.
group_assignee	STRING	Name of the group to which the task is assigned.
severity	STRING	Severity of the issue. Possible values are: `LOW`, `INTERMEDIATE`, `HIGH`.
comments	STRING	Comments made about the task, in serialized JSON format.
history	STRING	List of operations performed within the task, in serialized JSON format.
created	DATETIME	Date and time when the task was created.
created_by	STRING	Name of the person that created the task.
last_edited	DATETIME	Date and time when the task was last edited.
last_edited_by	STRING	Name of the person that last edited the task.

LONG

Task identifier (will be regenerated by the database).

type

STRING

Task type. Possible values are: RECORD_CHANGE, MANUAL_MATCH, MATCHING_PROPOSAL, CREATE, GENERIC.

name

STRING

Name of the task.

description

STRING

Task description.

status

STRING

Task status. Possible values are: NEW, IN_PROGRESS, RESOLVING, RESOLUTION_FAILED, RESOLVED, DISCARDED.

entity_id

STRING

Entity identifier.

workflow_name

STRING

Name of the workflow, for example, consolidation.

workflow_step

STRING

Name of the workflow step.

user_assignee

STRING

Name of the user to whom the task is assigned.

group_assignee

STRING

Name of the group to which the task is assigned.

severity

STRING

Severity of the issue. Possible values are: LOW, INTERMEDIATE, HIGH.

comments

STRING

Comments made about the task, in serialized JSON format.

history

STRING

List of operations performed within the task, in serialized JSON format.

created

DATETIME

Date and time when the task was created.

created_by

STRING

Name of the person that created the task.

last_edited

DATETIME

Date and time when the task was last edited.

last_edited_by

STRING

Name of the person that last edited the task.

The following table shows the columns in the task_record step, which records the data to the table tasks_tasks_rec_ids.

Column name	Column type	Description
record_id	LONG	Record identifier.
task_id	LONG	Task identifier.
entity_id	STRING	Entity identifier.

Column name

Column type

Description

record_id

LONG

Record identifier.

task_id

LONG

Task identifier.

entity_id

STRING

Entity identifier.

The following table shows the columns in the draft step, which records the data to the table tasks_drafts.

Column name Column type Description

Column name	Column type	Description
id	LONG	Draft identifier.
task_id	LONG	Identifier of the task that the draft belongs to.
status	STRING	Status of the draft. Possible values are: `EMPTY`, `ACTIVE`, `PUBLISHING`, `PUBLISH_FAILED`, `PUBLISHED`, `DISCARDED`.
operations	STRING	Operations that were performed on the draft.
created	DATETIME	Date and time when the draft was created.
created_by	STRING	Name of the person that created the draft.
last_edited	DATETIME	Date and time when the draft was last edited.
last_edited_by	STRING	Name of the person that last edited the draft.
publishId	LONG	Identifier of the publish operation.

LONG

Draft identifier.

task_id

LONG

Identifier of the task that the draft belongs to.

status

STRING

Status of the draft. Possible values are: EMPTY, ACTIVE, PUBLISHING, PUBLISH_FAILED, PUBLISHED, DISCARDED.

operations

STRING

Operations that were performed on the draft.

created

DATETIME

Date and time when the draft was created.

created_by

STRING

Name of the person that created the draft.

last_edited

DATETIME

Date and time when the draft was last edited.

last_edited_by

STRING

Name of the person that last edited the draft.

publishId

LONG

Identifier of the publish operation.

The following table shows the columns in the draft_record step, which records the data to the table tasks_drafts_rec_ids.

Column name	Column type	Description
record_id	LONG	Record identifier.
draft_id	LONG	Draft identifier.
entity_id	STRING	Entity identifier.

Column name

Column type

Description

record_id

LONG

Record identifier.

draft_id

LONG

Draft identifier.

entity_id

STRING

Entity identifier.

Manual Match Decision Load Operation

Manual match migration load operation allows migrating manual match decisions.

<op class="com.ataccama.nme.engine.batch.AppendManualMatchDecisionLoadBatchOperation" description="" name="migration_load_mmd">
    <preserveMetadataColumns>true</preserveMetadataColumns>
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../engine/migration/migration_load_mmd.comp"/>
</op>

Parameters:

<preserveMetadataColumns>: if set to true, the eng_ columns are not overridden.
dataProvider: same as in other load operations, see Data Providers.

Expected input columns are:

Column name Column type Description

Column name	Column type	Description
instance_entity	STRING	Name of the instance entity.
operation_type	STRING	Type of the operation, for example, `MERGE_MASTER`, `SPLIT_INSTANCE`, `MERGE_INSTANCE`.
instance1_id	LONG	Identifier of the first merged or split instance.
instance1_master_id	LONG	Identifier of the master record that was merged or split.
instance1_data	STRING	Definition of the operation in JSON format.
instance2_id	LONG	Identifier of the second merged or split instance.
instance2_master_id	LONG	Identifier of the master record that was merged or split.
instance2_data	STRING	Definition of the operation in JSON format.
eng_creation_date	DATE	Date when the match or split was done.

instance_entity

STRING

Name of the instance entity.

operation_type

STRING

Type of the operation, for example, MERGE_MASTER, SPLIT_INSTANCE, MERGE_INSTANCE.

instance1_id

LONG

Identifier of the first merged or split instance.

instance1_master_id

LONG

Identifier of the master record that was merged or split.

instance1_data

STRING

Definition of the operation in JSON format.

instance2_id

LONG

Identifier of the second merged or split instance.

instance2_master_id

LONG

Identifier of the master record that was merged or split.

instance2_data

STRING

Definition of the operation in JSON format.

eng_creation_date

DATE

Date when the match or split was done.

Advanced Features for Input and Output Interfaces

Path Variables and Additional Parameters

Both load and export operations have the ability to define their path variables. They can be either constant or supplied as a parameter from a workflow. The same applies to additional parameters.

...
<loadOperations>
  <op class="com.ataccama.nme.engine.batch.DeltaLoadBatchOperation" name="crm_delta" sourceSystem="crm" sourceDeletionStrategy="deactivate">
    <dataProvider class="com.ataccama.nme.dqc.batch.PlanBatchDataSource" planFileName="../engine/load/crm_delta.comp">
      <pathVariables>
        <pathVariable name="PATH" value="${PATH|XXXXINSTALL_DIRXXX/cdi_hub/data/ext}"/>
      </pathVariables>
      <additionalParameters>
        <additionalParameter name="in_param_name" value="'CRM'"/>
      </additionalParameters>
    </dataProvider>
    <descriptors>
      <descriptor class="com.ataccama.nme.engine.batch.load.CentralEntity" keyColumn="source_id" name="party"/>
      <descriptor centralEntity="party" class="com.ataccama.nme.engine.batch.load.DependentEntity" keyColumn="party_source_id" name="address"/>
      <descriptor centralEntity="party" class="com.ataccama.nme.engine.batch.load.DependentEntity" keyColumn="party_source_id" name="contact"/>
      <descriptor centralEntity="party" class="com.ataccama.nme.engine.batch.load.DependentEntity" keyColumn="parent_source_id" name="rel_party2party"/>
      <descriptor centralEntity="party" class="com.ataccama.nme.engine.batch.load.DependentEntity" keyColumn="party_source_id" name="id_document"/>
    </descriptors>
  </op>
</loadOperations>
<exportOperations>
  <op class="com.ataccama.nme.engine.batch.StandardBatchExportOperation" name="full_instance_export">
    <dataProviders>
      <dataProvider class="com.ataccama.nme.engine.batch.InstanceLayerDataSource" scope="ACTIVE"/>
    </dataProviders>
    <publisher class="com.ataccama.nme.dqc.batch.PlanBatchExportPublisher" planFileName="../engine/export/full_instance_export.comp">
      <pathVariables>
        <pv name="BATCH_OUT" value="${pathVar_BATCH_OUT|XXXXINSTALL_DIRXXXX/cdi_hub/data/out}"/>
      </pathVariables>
      <additionalParameters>
        <additionalParameter name="fileName" value="'FULL_INSTANCE_'+${v_today}+'.xml'"/>
        <additionalParameter name="fileType" value="56"/>
      </additionalParameters>
    </publisher>
   </op>
</exportOperations>
...

Was this page useful?