Skip to content

integrationArtifactUpload

Upload or Update an integration flow designtime artifact

Description

With this step you can either upload or update a integration flow designtime artifact using the OData API. Learn more about the SAP Cloud Integration remote API for updating an integration flow artifact here.

Usage

We recommend to define values of step parameters via config.yml file. In this case, calling the step is reduced to one simple line.
Calling the step can be done either via the Jenkins library step or on the command line.

Jenkins Pipeline

library('piper-lib-os')

integrationArtifactUpload script: this

Command Line

piper integrationArtifactUpload

Prerequisites

Parameters

Overview

Name Mandatory Additional information
filePath yes
host yes
integrationFlowId yes
integrationFlowName yes
integrationFlowVersion yes
oAuthTokenProviderUrl yes
packageId yes
password yes Secret pass via ENV or Jenkins credentials (cpiCredentialsId)
script yes Jenkins only reference to Jenkins main pipeline script
username yes Secret pass via ENV or Jenkins credentials (cpiCredentialsId)
verbose no activates debug output

Details

filePath

Specifies integration artifact relative file path.

back to overview

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

host

Specifies the protocol and host address, including the port. Please provide in the format <protocol>://<host>:<port>. Supported protocols are http and https.

back to overview

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

integrationFlowId

Specifies the ID of the Integration Flow artifact

back to overview

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

integrationFlowName

Specifies the Name of the Integration Flow artifact

back to overview

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

integrationFlowVersion

Specifies the version of the Integration Flow artifact

back to overview

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

oAuthTokenProviderUrl

Specifies the oAuth Provider protocol and host address, including the port. Please provide in the format <protocol>://<host>:<port>. Supported protocols are http and https.

back to overview

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

packageId

Specifies the ID of the Integration Package

back to overview

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

password

Password to authenticate to the SAP Cloud Platform Integration Service

back to overview

Scope Details
Aliases -
Type string
Mandatory yes
Default $PIPER_password (if set)
Secret yes
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references Jenkins credential id:
  id: cpiCredentialsId
  reference to: password

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

username

User to authenticate to the SAP Cloud Platform Integration Service

back to overview

Scope Details
Aliases -
Type string
Mandatory yes
Default $PIPER_username (if set)
Secret yes
Configuration scope
  • ☒ parameter
  • ☐ general
  • ☒ steps
  • ☒ stages
Resource references Jenkins credential id:
  id: cpiCredentialsId
  reference to: username

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

cpiCredentialsId

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

Jenkins credentials ID containing username and password for authentication to the SAP Cloud Platform Integration API's

back to overview

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

Example

Example configuration for the use in a Jenkinsfile.

integrationArtifactUpload script: this

Example for the use in a YAML configuration file (such as .pipeline/config.yaml).

steps:
  <...>
  integrationArtifactUpload:
    cpiCredentialsId: 'MY_CPI_OAUTH_CREDENTIALSID_IN_JENKINS'
    integrationFlowId: 'MY_INTEGRATION_FLOW_ID'
    integrationFlowVersion: 'MY_INTEGRATION_FLOW_VERSION'
    integrationFlowName: 'MY_INTEGRATION_FLOW_Name'
    packageId: 'MY_INTEGRATION_Package_ID'
    filePath: 'MY_INTEGRATION_FLOW_Artifact_Relative_Path'
    host: https://CPI_HOST_ITSPACES_URL
    oAuthTokenProviderUrl: https://CPI_HOST_OAUTH_URL
    downloadPath: /MY_INTEGRATION_FLOW_DOWNLOAD_PATH