github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/transportRequestCreate.md (about) 1 # ${docGenStepName} 2 3 ## ${docGenDescription} 4 5 ## Prerequisites 6 7 * Solution Manager version `ST720 SP08` or newer. 8 9 ## ${docGenParameters} 10 11 ## ${docGenConfiguration} 12 13 ## ${docJenkinsPluginDependencies} 14 15 The step is configured using a customer configuration file provided as 16 resource in an custom shared library. 17 18 ```groovy 19 @Library('piper-lib-os@master') _ 20 21 // the shared lib containing the additional configuration 22 // needs to be configured in Jenkins 23 @Library('foo@master') __ 24 25 // inside the shared lib denoted by 'foo' the additional configuration file 26 // needs to be located under 'resources' ('resoures/myConfig.yml') 27 prepareDefaultValues script: this, customDefaults: 'myConfig.yml' 28 ``` 29 30 Example content of `'resources/myConfig.yml'` in branch `'master'` of the repository denoted by 31 `'foo'`: 32 33 ```yaml 34 general: 35 changeManagement: 36 changeDocumentLabel: 'ChangeDocument\s?:' 37 cmClientOpts: '-Djavax.net.ssl.trustStore=<path to truststore>' 38 credentialsId: 'CM' 39 type: 'SOLMAN' 40 endpoint: 'https://example.org/cm' 41 git: 42 from: 'HEAD~1' 43 to: 'HEAD' 44 format: '%b' 45 ``` 46 47 The properties configured in section `'general/changeManagement'` are shared between 48 all change management related steps. 49 50 The properties can also be configured on a per-step basis: 51 52 ```yaml 53 [...] 54 steps: 55 transportRequestCreate: 56 changeManagement: 57 type: 'SOLMAN' 58 endpoint: 'https://example.org/cm' 59 [...] 60 ``` 61 62 The parameters can also be provided when the step is invoked. For examples see below. 63 64 ## Return value 65 66 none 67 68 ## Exceptions 69 70 * `AbortException`: 71 * If the creation of the transport request fails. 72 * `IllegalStateException`: 73 * If the change id is not provided. 74 75 ## Example 76 77 ```groovy 78 // SOLMAN 79 def transportRequestId = transportRequestCreate script:this, 80 changeDocumentId: '001,' 81 changeManagement: [ 82 type: 'SOLMAN' 83 endpoint: 'https://example.org/cm' 84 ] 85 // CTS 86 def transportRequestId = transportRequestCreate script:this, 87 transportType: 'W', 88 targetSystem: 'XYZ', 89 description: 'the description', 90 changeManagement: [ 91 type: 'CTS' 92 endpoint: 'https://example.org/cm' 93 ] 94 ```