SAP Datasphere Connector 1.0.0.0

The SAP Datasphere Connector lets you run task chains and replication flows and monitor their execution through completion.

Prerequisites

Contents of the Component

The SAP Datasphere Connector consists of the following objects:

Object Type Name
Application GLOBAL.Redwood.GLOBAL.SAP.REDWOOD.Datasphere
Constraint Definition REDWOOD.Redwood_SAP_DatasphereConnectionConstraint
Extension Point REDWOOD.Redwood_SAP_Datasphere
Process Definition REDWOOD.Redwood_SAP_Datasphere_RunReplicationFlow
Process Definition REDWOOD.Redwood_SAP_Datasphere_RunReplicationFlow_Template
Process Definition REDWOOD.Redwood_SAP_Datasphere_RunTaskChain
Process Definition REDWOOD.Redwood_SAP_Datasphere_RunTaskChain_Template
Process Definition Type REDWOOD.Redwood_SAP_Datasphere
Library REDWOOD.Redwood_SAP_Datasphere

Redwood_SAP_Datasphere_RunReplicationFlow

Lets you run a replication flow in SAP Datasphere.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection This defines the connection for SAP DataSphere String In

Parameters space Space ID The ID of the Space where the Replication Flow is stored String In

Parameters replicationFlowTechnicalName Replication Flow Name The technical name of the Replication Flow that will be run. String In

Parameters logId Log ID The unique identifier of the replication flow run. String Out

Redwood_SAP_Datasphere_RunReplicationFlow_Template

Template to run a replication flow in SAP Datasphere.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection This defines the connection for SAP DataSphere String In

Parameters space Space ID The ID of the Space where the Replication Flow is stored String In

Parameters replicationFlowTechnicalName Replication Flow Name The technical name of the Replication Flow that will be run. String In

Parameters logId Log ID The unique identifier of the replication flow run. String Out

Redwood_SAP_Datasphere_RunTaskChain

Lets you run a task chain in SAP Datasphere.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection This defines the connection for SAP DataSphere String In

Parameters space Space ID The ID of the Space where the Task Chain is stored String In

Parameters taskChainTechnicalName Task Chain Name The technical name of the Task Chain that will be run. String In

Parameters downloadLogs Download Task Logs Download Task Chain logs. String In N

N=None

C=Task Chain Only

F=Task Chain & Failed Tasks

A=All
Parameters logId Log ID The unique identifier of the task chain run. String Out

Parameters taskSummary Task Summary Table of the task chain's child tasks, their final statuses, and execution times (start and end times). Table Out

Redwood_SAP_Datasphere_RunTaskChain_Template

Template to run a task chain in SAP Datasphere.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection This defines the connection for SAP DataSphere String In

Parameters space Space ID The ID of the Space where the Task Chain is stored String In

Parameters taskChainTechnicalName Task Chain Name The technical name of the Task Chain that will be run. String In

Parameters downloadLogs Download Task Logs Download Task Chain logs. String In N

N=None

C=Task Chain Only

F=Task Chain & Failed Tasks

A=All
Parameters logId Log ID The unique identifier of the task chain flow run. String Out

Parameters taskSummary Task Summary Table of the task chain's child tasks, their final statuses, and execution times (start and end times). Table Out

Setup

To install the SAP Datasphere Connector and create a Connection to SAP Datasphere:

  1. Locate the SAP Datasphere Connector component in the Catalog and install it.

  2. Create an SAP Datasphere Connection.

    • The connection timeout defaults to 30 seconds. If you need to change it, create the /configuration/jcs/apps/SAP/Datasphere/ConnectTimeout registry key and set it to the number of seconds you want.

    • The socket timeout defaults to 60 seconds. If you need to change it, create the /configuration/jcs/apps/SAP/Datasphere/SocketTimeout registry key and set it to the number of seconds you want.

Tip: If your SAP Datasphere jobs start failing with 401 errors, go to the Connection in RunMyJobs, log in again to refresh your token, and then re-save the Connection.

Running a Task Chain

A few notes about running task chains from RunMyJobs:

  • You can run only one instance of a task chain at a time. If you try to run more than one, SAP will return an exception indicating that it is already running, and the process will fail in RunMyJobs.

  • Before a task chain can be run, it must be deployed. Otherwise, RunMyJobs will not be able to find it.

  • The Connector currently does not support killing a task chain once it has started.

  • The Download Task Logs parameter lets you decide which logs to fetch once the task chain has completed. All logs are written to the TaskChain.log process file.

  • All of the above also apply to Redwood_SAP_Datasphere_RunTaskChain_Template.

To run an SAP Datasphere task chain:

  1. Navigate to Applications > Redwood > SAP > Datasphere.

  2. Right-click Redwood_SAP_Datasphere_RunTaskChain and choose Submit.

  3. Choose your Connection.

  4. In the Space ID field, enter the ID of the Space that contains the Task Chain.

  5. In the Task Chain Name field, enter the technical name of the task chain you want to execute.

  6. If you want to download task logs, choose an option from the Download Task Logs dropdown list. All logs are written to the TaskChain.log process file.

  7. Click Submit.

Running a Task Chain with a Template

To create a customized Process Definition, optionally with default values, for running an SAP Datasphere task chain:

  1. Right-click the Redwood_SAP_Datasphere_RunTaskChain_Template Process Definition and choose New (from Template) from the context menu. The New Process Definition pop-up window displays.

  2. Choose a Partition.

  3. Enter a Name.

  4. Delete the default Application value (if any) and substitute your own Application name if desired.

  5. In the Parameters tab, enter any Default Expressions you want to use.

    • When specifying the Connection value, use the format EXTCONNECTION:<partition>.<connection name>.

  6. Save and then submit the new Process Definition.

Running a Replication Flow

A few notes about running replication flows from RunMyJobs:

  • RunMyJobs fetches the logs for a replication flow run at the end of the run. After that point, they can be found in the ReplicationFlow.log process file.

  • Sometimes a replication flow can continue running indefinitely, even after all replications have been completed. In such cases, the process in RunMyJobs will also keep running to reflect the status of the replication flow.

  • If any replication fails while the replication flow is still running, an Operator Message is created with the following replies:

    • Complete Job: The RunMyJobs process goes to status Completed. The replication flow is left as-is.

    • Finish Job in Error: The RunMyJobs process goes to status Error. The replication flow is left as-is.

    • Restart Failed Replications: Any failed replications are restarted, and the RunMyJobs process continues running.

    • Terminate Replication Flow: The replication flow is terminated and the RunMyJobs process goes to status Error.

  • The Remote ID of a replication flow run in RunMyJobs consists of the RunMyJobs process ID and the log ID of the replication flow, plus optionally the ID of the last Operator Message that has been raised.

  • You can run only one instance of a replication flow at a time. If you try to run more than one, SAP will return an exception indicating that it is already running, and the process will fail in RunMyJobs.

  • Before a replication flow can be run, it must be deployed. Otherwise, RunMyJobs will not be able to find it.

  • If you kill the Redwood_SAP_Datasphere_RunReplicationFlow process, it will terminate the replication flow in SAP Datasphere.

  • All of the above also apply to Redwood_SAP_Datasphere_RunReplicationFlow_Template.

To run an SAP Datasphere replication flow:

  1. Right-click the Redwood_SAP_Datasphere_RunReplicationFlow and choose Submit.

  2. Choose your Connection.

  3. In the Space ID field, enter the ID of the Space that contains the Task Chain.

  4. Enter the replication flow name in the Replication Flow Name field.

  5. Click Submit.

Running a Replication Flow with a Template

To create a customized Process Definition, optionally with default values, for running an SAP Datasphere replication flow:

  1. Right-click the Redwood_SAP_Datasphere_RunReplicationFlow_Template Process Definition and choose New (from Template) from the context menu. The New Process Definition pop-up window displays.

  2. Choose a Partition.

  3. Enter a Name.

  4. Delete the default Application value (if any) and substitute your own Application name if desired.

  5. In the Parameters tab, enter any Default Expressions you want to use.

    • When specifying the Connection value, use the format EXTCONNECTION:<partition>.<connection name>.

  6. Save and then submit the new Process Definition.