jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-16 11:09:33 +02:00
Code Issues Releases Activity
d8dca885bb
sap-jenkins-library/documentation/docs/steps/transportRequestUploadFile.md
Marcus Holl d8dca885bb Change parameter name 'changeId' to 'changeDocumentId' 
the official term in SAP-SolutionManager is 'change document'.

The term 'change' as reflected in 'changeId' is ambigous and could also be understand in the
sense of a change in a revision control system.

Choosing appropriate terms for parameters here deceases the amount of documentation
required for explaining what is really denoted by the parameter.
2018-06-28 13:46:00 +02:00

2.6 KiB
Raw Blame History

transportRequestUploadFile

Description

Uploads a file to a Transport Request for a Change Document on the Solution Manager.

Prerequisites

Parameters

parameter mandatory default possible values
script yes
changeDocumentId yes
transportRequestId yes
applicationId yes
filePath yes
cmCredentialsId yes
cmEndpoint yes
  • script - 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, for example, configuration parameters.
  • changeDocumentId - The id of the change document related to the transport request to release.
  • transportRequestId - The id of the transport request to release.
  • applicationId - The id of the application.
  • filePath - The path of the file to upload.
  • cmCredentialsId - The credentials to connect to the Solution Manager.
  • cmEndpoint - The address of the Solution Manager.

Step configuration

The following parameters can also be specified as step parameters using the global configuration file:

  • cmCredentialsId
  • cmEndpoint

Return value

None.

Exceptions

  • AbortException:
    • If the change id is not provided.
    • If the transport request id is not provided.
    • If the application id is not provided.
    • If the file path is not provided.
    • If the upload fails.

Example

transportRequestUploadFile script:this, changeDocumentId: '001', transportRequestId: '001', applicationId: '001', filePath: '/path'