The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
snActivatePlugin
: SN: Activate pluginsnApplyChanges
: SN: Apply changessnBatchInstall
: SN: Batch installsnBatchRollback
: SN: Batch rollbacksnInstallApp
: SN: Install applicationsnInstanceScan
: SN: Instance scansnPublishApp
: SN: Publish applicationsnRollbackApp
: SN: Roll back applicationsnRollbackPlugin
: SN: Roll back pluginsnRunTestSuite
: SN: Run test suite with resultssnActivatePlugin
: SN: Activate plugincredentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
snApplyChanges
: SN: Apply changescredentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
String
appSysId
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
String
branchName
(optional)
String
url
(optional)
String
snBatchInstall
: SN: Batch installcredentialsId
(optional)
String
apiVersion
(optional)
String
batchName
(optional)
String
file
(optional)
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json
.
String
notes
(optional)
Default: null
String
packages
(optional)
[{
"id": "String",
"load_demo_data": Boolean,
"notes": "String",
"requested_customized_version": "String",
"requested_version": "String",
"type": "String"
}]
id | Required. Sys_id of the application or identifier of the plugin to install. |
---|---|
load_demo_data | Flag that indicates whether demo data is loaded when installing the package. Valid values: true : Demo data should be loaded. false : Demo data should not be loaded. Default: false |
notes | User specified notes about the package. Default: null |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application. |
requested_version | Required if type is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3. |
type | Required. Type of package. Valid values:
|
String
url
(optional)
String
useFile
(optional)
Default: false
boolean
snBatchRollback
: SN: Batch rollbackcredentialsId
(optional)
String
apiVersion
(optional)
String
rollbackId
(optional)
sys_id
) of the rollback installed before.
String
url
(optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
String
snInstallApp
: SN: Install applicationcredentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
String
appSysId
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
String
appVersion
(optional)
String
baseAppAutoUpgrade
(optional)
boolean
baseAppVersion
(optional)
String
url
(optional)
String
snInstanceScan
: SN: Instance scancredentialsId
(optional)
String
apiVersion
(optional)
String
comboSysId
(optional)
String
requestBody
(optional)
String
scanType
(optional)
String
suiteSysId
(optional)
String
targetRecordSysId
(optional)
String
targetTable
(optional)
String
url
(optional)
String
snPublishApp
: SN: Publish applicationcredentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
String
appSysId
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
String
appVersion
(optional)
String
devNotes
(optional)
String
incrementBy
(optional)
int
isAppCustomization
(optional)
boolean
obtainVersionAutomatically
(optional)
boolean
url
(optional)
String
snRollbackApp
: SN: Roll back applicationcredentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
String
appSysId
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
String
rollbackAppVersion
(optional)
String
url
(optional)
String
snRollbackPlugin
: SN: Roll back plugincredentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
snRunTestSuite
: SN: Run test suite with resultscredentialsId
(optional)
String
apiVersion
(optional)
String
browserName
(optional)
Valid values:
String
browserVersion
(optional)
String
osName
(optional)
String
osVersion
(optional)
String
responseBodyFormat
(optional)
String
testSuiteName
(optional)
String
testSuiteSysId
(optional)
sys_id
of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
String
url
(optional)
String
withResults
(optional)
boolean
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.