integrationArtifactTransport¶

Integration Package transport using the SAP Content Agent Service

Description¶

With this step you can trigger an Integration Package transport from SAP Integration Suite using SAP Content Agent Service and SAP Cloud Transport Management Service. For more information about doing an Integration Package transport using SAP Content Agent Service see the documentation here.

Usage¶

We recommend to define values of step parameters via .pipeline/config.yml file.
In this case, calling the step is essentially reduced to defining the step name.
Calling the step can be done either in an orchestrator specific way (e.g. via a Jenkins library step) or on the command line.

JenkinsCommand Line

library('piper-lib-os')

integrationArtifactTransport script: this

piper integrationArtifactTransport

With this step, you can transport Integration Packages from SAP Integration Suite across various landscapes using SAP Content Agent Service.

SAP Integration Suite provides the ability to transport its content to other services. SAP Content Agent service enables you to assemble the content from various content providers (including SAP Integration Suite) in MTAR format. Later, this content is either available for download or can be exported to a configured transport queue, such as SAP Cloud Transport Management. This step, integrationArtifactTransport, only supports transporting Integration Packages from SAP Integration Suite. For more information on configurations required for SAP Integration Suite, see Content Assembly for SAP Integration Suite

To use the integrationArtifactTransport step, proceed as follows:

Create SAP Content Agent Service Destination.
Create Cloud Integration Destination.
Create SAP Cloud Transport Management Destination.
Transport Cloud Integration Content with SAP Content Agent Service as explained in the blog TMS – Transport SAP Cloud Integration (CI/CPI) Content with Transport Management Service (TMS) and Content Agent Service (CAS)
integrationArtifactTransport step only supports Integration Package transport

Prerequisites¶

Parameters¶

Overview - Step¶

Name	Mandatory	Additional information
casServiceKey	(yes)	pass via ENV or Jenkins credentials (`casApiServiceKeyCredentialsId`)
integrationPackageId	yes
name	yes
resourceID	yes
script	(yes)	reference to Jenkins main pipeline script
version	yes
verbose	no	activates debug output

Overview - Execution Environment¶

Orchestrator-specific only

These parameters are relevant for orchestrator usage and not considered when using the command line option.

Name	Mandatory	Additional information

Details¶

casServiceKey¶

Service key JSON string to access the CAS service instance

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_casServiceKey` (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☐ steps ☐ stages
Resource references	Jenkins credential id: id: `casApiServiceKeyCredentialsId` reference to: `casServiceKey`

integrationPackageId¶

Specifies the ID of the integration package artifact.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_integrationPackageId` (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

name¶

Specifies the name of the integration package artifact.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_name` (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

resourceID¶

Specifies the technical ID of the integration package artifact.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_resourceID` (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

script¶

Jenkins-specific: Used for proper environment setup.

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope	Details
Aliases	-
Type	`Jenkins Script`
Mandatory	yes
Default
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

verbose¶

verbose output

back to overview

Scope	Details
Aliases	-
Type	`bool`
Mandatory	no
Default	`false`
Possible values	- `true` - `false`
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

version¶

Specifies the version of the Integration Package artifact.

back to overview

Scope	Details
Aliases	-
Type	`string`
Mandatory	yes
Default	`$PIPER_version` (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

casApiServiceKeyCredentialsId¶

Jenkins-specific: Used for proper environment setup. See using credentials for details.

Jenkins secret text credential ID containing the service key to the CAS service instance

back to overview

Scope	Details
Aliases	-
Type	`string`
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages

Example¶

Configuration example for a Jenkinsfile:

integrationArtifactTransport script: this

Configuration example for a YAML file (for example .pipeline/config.yaml):

steps:
  <...>
  integrationArtifactTransport:
    casApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
    integrationPackageId: MY_INTEGRATION_PACKAGE_ID
    resourceID: MY_INTEGRATION_RESOURCE_ID
    name: MY_INTEGRATION_PACKAGE_NAME
    version: MY_INTEGRATION_PACKAGE_VERSION