Overview

Semarchy Convergence for Data Integration allows orchestrating Convergence for MDM Workflows to load data in the context of data entry workflows. This document provides installation and usage information for these MDM Workflow Orchestration processes.

The templates provided with this version are compatible with Semarchy Convergence for MDM Client API version 2.2 and above. Templates compatible with previous Semarchy Convergence for MDM versions are available in the template.semarchy.2.0.zip file.

Installation

Installing the Client API

Convergence for Data Integration communicates with Convergence for MDM and orchestrates the workflows through the client API available for each release of Convergence for MDM. You must add the Convergence for MDM Client API libraries to your Convergence for Data Integration instance prior to using the workflow orchestration processes.

To install the client API:

  1. Download the Convergence Client API from the Semarchy Website

  2. Uncompress the Client API file.

  3. Copy the following files from the Client API /lib sub-folder into the /runtime/lib sub-folder your the Convergence for DI installation:

    • com.semarchy.commons.util_xxx.jar

    • com.semarchy.commons.validation_xxx.jar

    • com.semarchy.mdm.client_xxx.jar

    • com.semarchy.mdm.runtime_xxx.jar

    • com.semarchy.platform.language_xxx.jar

    • com.springsource.antlr_xxx.jar

    • groovy-templates_xxx.jar

    • groovy_xxx.jar

    • org.antlr.runtime_xxx.jar

    • org.apache.commons.beanutils_xxx.jar

    • org.objectweb.asm.all_xxx.jar

    • slf4j-api-xxx.jar

Configuring Convergence for MDM

Convergence for MDM must be configured to support the queries made via the Client API.

The Platform WebService, the Metadata WebService and the Data Service corresponding to your data edition must all be started in the Convergence for MDM server. To configure and start these services, please refer to the Semarchy Convergence for MDM Administrator Guide.

Using the Workflow Orchestration Processes

There are two processes for workflow orchestration, which can be parameterized.

  • The SemarchyStartActivity process starts an activity (a workflow instance). It stores the LoadID related to this activity in the SEM_LOAD_ID variable.

  • The SemarchyCompleteTask completes a task in an existing activity. It can also be used to complete an activity.

To use these processes:

  1. Create a new process in your Convergence for Data Integration project.

  2. Drag and drop the SemarchyStartActivity in this process. This creates a process reference to SemarchyStartActivity in the main process.

  3. Configure this process' parameters (see below).

  4. Add to the main process the mappings to load the SD_ tables. Loading these tables adds data in to the activity’s transaction.
    Note that:

    • These mappings can be added in a sub-process if needed.

    • They can use the INTEGRATION Semarchy Convergence for MDM template.

    • They must include the SEM_LOAD_ID variable from global > templates.semarchy > Semarchy Convergence for MDM Integration > Global Variables.variable.md > Semarchy Variables. This variable must be mapped to the B_LOADID column in the target SD_ table.

    • Make sure to load the SD_ tables corresponding to the entities taken into account in your workflow.

  5. Drag and drop the SemarchyCompleteTask in this process. This creates a process reference to SemarchyCompleteTask in the main process.

  6. Configure this process' parameters (see below).

SemarchyStartActivity Parameters

This process takes the parameters listed in the table below.

Name

Mandatory

Description

Semarchy URL

Yes

URL of the Semarchy Convergence for MDM Server.

Semarchy Usename

Yes

User name connecting to the Convergence for MDM server.
This user must have a role that allows her/him to start the workflow and claim the first task.

Semarchy Password

Yes

Password for the user connecting to Convergence for MDM.

Data Location Name

Yes

Name of the Data Location to connect to.

Data Edition ID

Yes

ID of the Data Edition (data version) to connect to.

Application Name

Yes

Name of the Application the in Data Edition containing the workflow to start.

Workflow Name

Yes

Name of the workflow to start.

Start Task Name

Yes

Name of the task to start in the workflow. It must be provided even if the workflow has only one starting task.

Activity Label

Yes

Label of the activity as it will appear in the data stewardship workbench.

Activity Comment

Yes

Comments for this activity.

Priority

Yes

Priority of this task - It can be either NORMAL, HIGH or LOW.

Data Branch ID

Yes

Data branch ID to connect to (usually 0).

SemarchyCompleteTask Parameters

This process takes the parameters listed in the table below.

Name

Mandatory

Description

Semarchy URL

Yes

URL of the Semarchy Convergence for MDM Server.

Semarchy Usename

Yes

User name connecting to the Convergence for MDM server.<br/>This user must have a role that allows her/him to process this task.

Semarchy Password

Yes

Password for the user connecting to Convergence for MDM.

Data Location Name

Yes

Name of the Data Location to connect to.

Data Edition ID

Yes

ID of the Data Edition (data version) to connect to.

Transition Name

Yes

Name of the transition to which this task should transition to as specified in your workflow.

Completion Comment

Yes

Comments for completing this task.

Data Branch ID

Yes

Data branch ID to connect to (usually 0).

Notify Assignee

No

Select this option if you want the assignee role to be automatically notified by email.

Claim Task

No

Select this option to claim the next task automatically.