...
File Level Variables With Example
Variable name | Description | Value if File Name (with path) is /XXHR/publisher/APXSOBLX_1.rtf |
|---|---|---|
| File path of the package deploy file. (File Name (with path)) on the package deployment screen. | /XXHR/publisher/APXSOBLX_1.rtf |
| File name of the package deploy file. | APXSOBLX_1 |
| File path, excluding the file name and extension. | /XXHR/publisher |
| File extension on the package deploy file. | rtf |
| Fully qualified location of the file on the endpoint. | Fully qualified path to file being processed. This can be different locations for build and deploy workflow execution as there might be some checkout folder specified for build. See examples below for build and deploy workflow where FILE_PATH is in bold text.
|
| The Hash of the file as generated recorded by FlexDeploy. | |
| The SCM Revision of the package deploy file. |
All file attributes defined on Project Files tab are included as well.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Stop On Deployment Error |
| No | Stop deploying package files if any error occurs. If unchecked all files will be deployed even if one or more files fails. This is for package operations only. True by default. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
File Path |
| Yes | File path of the file to run. |
Artifacts
This operation delegates the consume/produce artifacts decision to the workflow developer.
...
This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the environment instanceTarget. Selecting a specific resource will result in selection of endpoints associated to the environment instance Target which have that resource defined.
...
FlexDeploy will pass in any Properties normally available in workflows via System Environment Variables.
Example
Property Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
import os
​
TEST_INP = ​os.getenv('TEST_INP') |
...
User defined outputs – an output must be defined in the workflow editor to be accessible. Within your script use the setOutputs(key, Value) function to set any outputs.
Example
Output Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
setOutputs("MY_STRING_OUTPUT","Output result") # output will be "Output result" |
...
The status of the File can be set in your script using several functions available, see the example below. If an exception occurs in your script, the status will be set to Failed. Statuses will only be set when deploying.
Setting the status examples
| Code Block | ||||
|---|---|---|---|---|
| ||||
setObjectResultStatusSuccess() # Status will be Success setObjectResultStatusFailed() # Status will be Failed setObjectResultStatusSkipped() # Status will be Skipped setObjectResultStatusNotAttempted() # Status will be Not Attempted setObjectResultStatusIgnore() # Status will be Unknown |
...