mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-01-18 05:18:24 +02:00
41 lines
1.9 KiB
Markdown
41 lines
1.9 KiB
Markdown
|
# transportRequestCreate
|
||
|
|
|
||
|
|
## Description
|
||
|
|
Creates a Transport Request for a Change Document on the Solution Manager.
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
| parameter | mandatory | default | possible values |
|
||
|
|
| -----------------|-----------|--------------------------------------------------------|--------------------|
|
||
|
|
| `script` | yes | | |
|
||
|
|
| `changeId` | 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`](commonPipelineEnvironment.md) for retrieving, for example, configuration parameters.
|
||
|
|
* `changeId` - The id of the change document to transport.
|
||
|
|
* `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
|
||
|
|
The id of the Transport Request that has been created.
|
||
|
|
|
||
|
|
## Exceptions
|
||
|
|
* `AbortException`:
|
||
|
|
* If the change id is not provided.
|
||
|
|
* If the creation of the transport request fails.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
```groovy
|
||
|
|
def transportRequestId = transportRequestCreate script:this, changeId: '001'
|
||
|
|
```
|
||
|
|
|