Get LoadID

Tools

Description

Gets a load ID from Semarchy xDM and stores it into a variable. This Load ID is either generated or retrieved from a Continuous Load. Such a load ID is required to load data into a Semarchy xDM data location.

The retrieved load ID is stored in an XDM_LOAD_ID variable by default.

Parameters

Name

Mandatory

Description

Load ID Type

true

Type of load ID:

  • new: Creates a new external load and returns its ID. Such a load needs to be explicitly submitted after the data is loaded. You can also cancel this load.

  • continuous: Retrieves the ID of an existing Semarchy xDM Continous Load. Data loaded in continuous loads is automatically processed on the continuous load’s schedule, using an integration job also defined in the continuous load. You do not need to submit such a load, and cannot cancel it.

When using a continuous load, you should preferably load data using a database transaction, to guarantee that all the required data is loaded before the transaction commit and that this transaction can be rolled back should an error occur during data integration.

Continuous Load Name

true

Only applies if the Load ID type is set to continuous.

Name of the continuous load as configured in the Semarchy xDM Management view.

Load Id Session Variable Path

false

Path and name of the variable storing the Load ID. By default, it is set to ~/XDM_LOAD_ID.

User Name

true

Name of the user initializing the action.

The username must be the same across different actions used in the same process.

Repository Schema

true

Name of the database schema hosting the Semarchy xDM repository.

Data Location Name

false

Name of the data location as specified in the Semarchy xDM Management view. If empty, the value of the parameter is retrieved from the metadata.

Data Location Schema

true

Name of the database schema hosting the Semarchy xDM data location.

Session Id

false

Explicit Session Identifier used to retrieve the load ID in the case of multiple parallel loads. It is set to CORE_SESSION_ID if left empty.