Skip to content

integrationArtifactUpdateConfiguration

Update integration flow Configuration parameter

Description

With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter 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')

integrationArtifactUpdateConfiguration script: this

Command Line

piper integrationArtifactUpdateConfiguration

Prerequisites

Parameters

Overview

Name Mandatory Additional information
host yes
integrationFlowId yes
integrationFlowVersion yes
oAuthTokenProviderUrl yes
parameterKey yes
parameterValue 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)
platform no
verbose no activates debug output

Details

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

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

parameterKey

Specifies the externalized parameter name.

back to overview

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

parameterValue

Specifies the externalized parameter value.

back to overview

Scope Details
Aliases -
Type string
Mandatory yes
Default $PIPER_parameterValue (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

platform

Specifies the running platform of the SAP Cloud platform integraion service

back to overview

Scope Details
Aliases -
Type string
Mandatory no
Default $PIPER_platform (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

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.

integrationArtifactUpdateConfiguration script: this

Example of a YAML configuration file (such as .pipeline/config.yaml).

steps:
  <...>
  integrationArtifactUpdateConfiguration:
    cpiCredentialsId: 'MY_CPI_OAUTH_CREDENTIALSID_IN_JENKINS'
    integrationFlowId: 'MY_INTEGRATION_FLOW_NAME'
    integrationFlowVersion: 'MY_INTEGRATION_FLOW_VERSION'
    platform: 'cf'
    host: 'https://CPI_HOST_ITSPACES_URL'
    oAuthTokenProviderUrl: 'https://CPI_HOST_OAUTH_URL'
    parameterKey: 'MY_INTEGRATION_FLOW_CONFIG_PARAMETER_NAME'
    parameterValue: 'MY_INTEGRATION_FLOW_CONFIG_PARAMETER_VALUE'