Batch job definitions

Each batch job is defined in a task business object (TaskBObj).

The TaskBObj is included in each InfoSphere® MDM addTask and updateTask transaction request and response XML, and the getTask transaction’s response XML.

  • addTask transactions create new batch jobs.
  • updateTask transactions modify an existing batch job definition.
  • getTask transactions retrieve details of an existing batch job definition.

The following sample TaskBObj shows a task business object:

<TaskBObj>
  <TaskId>852732725624914035</TaskId>
  <TaskDefinitionId>90</TaskDefinitionId>
  <TaskName>Persistify Entities</TaskName>
  <TaskCatType>8</TaskCatType>
  <TaskCatValue>Bulk Processing</TaskCatValue>
  <PriorityType>100</PriorityType>
  <TaskOwnerRole>Batch Processing</TaskOwnerRole>
  <TaskDueDate>2012-02-22 11:00:00.000</TaskDueDate>
  <ProcessId>100005</ProcessId>
  <Creator>cusadmin</Creator>
  <CreationDate>2012-02-21 13:17:22.125</CreationDate>
  <TaskActionType>5</TaskActionType>
  <TaskActionValue>Save</TaskActionValue>
  <TaskStatusType>3</TaskStatusType>
  <TaskStatusValue>In Progress</TaskStatusValue>
  <TaskLastUpdateDate>2012-01-23 23:24:33.468</TaskLastUpdateDate>
  <TaskLastUpdateUser>cusadmin</TaskLastUpdateUser>
  <TaskLastUpdateTxId>264232737806554669</TaskLastUpdateTxId>
  <TaskCommentBObj>
    <CommentText>
      <![CDATA[
        <SQLOverride>SELECT DISTINCT CURENTRECNO AS ENTITY_ID FROM MPI_ENTLINK_MDMORG WHERE CURENTRECNO NOT IN (SELECT ENTITY_ID FROM CONTACT WHERE PERSON_ORG_CODE = 'O' AND ENTITYLINK_ST_TP_CD = 2)</SQLOverride>
        <VariableParameter>ENTITY_TYPE=mdmorg</VariableParameter>
        <RuntimeOverride>Submitter.number=4</RuntimeOverride>
      ]]&gt;
    </CommentText>
  </TaskCommentBObj>
  <TaskCommentBObj>
    <CommentText>
      <![CDATA[
        <Total>-1</Total><BatchInstance>batch01</BatchInstance>
      ]]&gt;
    </CommentText>
  </TaskCommentBObj>
  <WorkbasketBObj>
    <WorkbasketId>764632725624904670</WorkbasketId>
    <Name>Persist Entities</Name>
    <Creator>cusadmin</Creator>
  </WorkbasketBObj>
</TaskBObj>
  • The task category type code will always be 8 to indicate a batch task:
    <TaskCatType>8</TaskCatType>
  • The batch task category value (<TaskCatValue>Bulk Processing</TaskCatValue>) is a reserved keyword. This value is identical for all batch jobs.
  • The batch processor generates the task ID when a new batch job is created.
  • The batch processor uses the process ID to link a number of batch jobs into a job chain. Chained jobs will be processed as a group.
  • The following table lists task definition IDs and task names that the batch processor supports. These task definition IDs are loaded as gold data in the physical InfoSphere MDM database and are used in the batch job definition samples that are provided in the batch processor package.
    Task Definition ID Task Name METADATA_INFO_TP_CD
    10 Standardize Person Names 2
    20 Standardize Organization Names 3
    30 Standardize Addresses 4
    40 Standardize Contact Methods 5
    42 Synchronize Person Records 6
    43 Synchronize Organization Records 6
    50 Create Suspects 6
    60 Collapse Suspects 6
    80 Persist Entities (multiple entity types) 7
    90 Persist Entities (single entity type) 8
    100 Pure Batch 9
  • The task action type and task action status are described in Batch job life cycle overview.
  • The TaskBObj contains two Task Comments that contain XML snippets:
    • One Task Comment section contains the batch job definition parameters and must define what actions the batch job will perform.
    • The other Task Comment contains the batch job runtime statistics. This can be created when the batch job is defined or it will be created by the batch processor as the batch job is being processed.
  • The TaskBObj contains a WorkBasket that contains the name of the batch job.
Note: Although it is not strictly validated, the WorkBasket name and due date should be kept the same for all tasks in the same job chain.