Configuring Triggerable Service Tasks - NEW! 🚀
The actions of triggerable tasks are performed by STENG peers and are usually related to long-lasting operations - such as transports.
The action performed is just to request the schedule of an operation from a subsystem, persist the exit code obtained in the RC variable (if present). When the service task has completed, the flow will not continue but will be put in a wait state (0 resources required) until the scheduled operation is completed. Only then the process engine will be woken up, the RC variable value will be updated overwriting the schedule exit code with the effective code of the performed action and finally the instance will be re-triggered to proceed to the next step.
All Triggerable Service Tasks are organized with the description of the service task and the variables it contains.
List of Triggerable Service tasks in alphabetical order:
By design, all triggerable service tasks wait for a trigger before proceeding to the next step and that is why they always throw a BpmServiceException when receiving a schedule return code that is not 0 (Return Code OK). Otherwise, they will wait for an event that will never come, since the schedule operation failed.
Bind VirtualBox
Description
Given a FileSet ID it will be bound to the provided VirtualBox name.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| File ID | VariableType.LONG | Y | Fileset ID to operate the BIND operation to |
| Virtual Box | VariableType.VIRTUAL_BOX | Y | Virtual Box name where the given FileSet ID will be bound to |
Data Shaper Processor
Description
The Data Shaper Processor service task is used in worfklow templates to be consumed in Input, Mediation and Output Contracts to invoke Data Shaper graphs.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster hosting a Data Shaper installation that will be used to execute the graph |
| Payload | VariableType.DATASHAPER_PAYLOAD | Y | This variable will be dynamically filled at contract level with the required information to invoke a Data Shaper graph. Follow these steps to configure it: 1. Select a Sandbox. 2. Choose one of the graphs in the selected Sandbox. 3. The variables required by the selected graph to be executed will appear. |
Event Notification
Description
It emits a notification on "Generic local action" event on the notification channel specified in the service task.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| notificationChannelName | VariableType. NOTIFICATION_CHANNEL | Y | Name of the Notification channel that will receive the event. |
| actName | VariableType.STRING | Y | Logical name of the operation, used by DataWatcher when rendering a given actCode. |
| actAttrsPrefix | VariableType.STRING | Y | This attribute is the prefix used in Action attributes; default is "actAttrs_". Action attributes are a list of variables injected at runtime in workflow context. Each attribute is structured as a couple of: - name: string element containing the name of the attribute (starting with the mentioned prefix). - value: string element containing the value of the attribute. Example: actAttrs_MyAttrName= MyAttrValue |
| actOutcome | VariableType.ENUM | Y | Allowed values: - running - success (default) - failure |
| actErrCode | VariableType.STRING | N | This attribute plays a role only when actOutcome is set to failure and indicates the error code associated to the failure. |
| actErrMsg | VariableType.STRING | N | This attribute plays a role only when actOutcome is set to failure and indicates the error code associated to the failure. |
| dcName | VariableType.STRING | Y | Logical name of the data container, typically a filename. |
GUnzip File
Description
It invokes the SpGunzip service on an input file (gzip archive) and Gunzip it, producing a new file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input File | VariableType.STRING | Y | The full pathname (with filename) for the file to be uncompressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where final return code will be written |
GZip File
Description
It invokes the SpGzip compression service on an input file that produces a gzip archive.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input File | VariableType.STRING | Y | The full pathname (with filename) for the file to be compressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Compression strategy | VariableType.COMPRESSION_STRATEGY_LEVEL | Y | The strategy level of compression |
| Compression level | VariableType.STRING | Y | The level of compression |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
ICAP
Description
It performs an antivirus/DLP check on a file inside the filebox using a specific ICAP engine and returns the outcome of the check.
Input Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Icap | VariableType.ICAP | Y | The ID of the ICAP engine that will perform the scan |
| File ID | VariableType.LONG | Y | The ID of the file to be checked (Tip: if the file is in a "FileDetail" variable, its ID can be retrieved with: ${file.getRegistryId()} ) |
| Scan mode | VariableType.ENUM | N | Scan mode (ANTIVIRUS or DLP) |
| Icap method | VariableType.ENUM | N | ICAP method (REQMODE or RESPMODE) |
| Exception If Harmful | VariableType.BOOLEAN | N | Throws an exception in case of scan error (e.g. the scan has been completed successfully and the file is harmful/contains sensitive data) |
| Exception On Failure | VariableType.BOOLEAN | N | Throws an exception in case of scan failure (e.g. the scan failed because of a connectivity error or an unexpected error from ICAP server) |
Output Variables
| Parameter | Type | Description |
|---|---|---|
| icap_rc | VariableType.STRING | Result of scan. For a detailed list of all the possible results, see the table below. |
| icap_rc | Description | Notes |
|---|---|---|
| "0" | Scan performed successfully, the file is safe | |
| "64" | Scan performed successfully, the file is harmful | This result can be returned only if throwExceptionIfHarmful == false |
| "2" | Scan not performed, file not found | This result can be returned only if throwExceptionOnFailure == false |
| "3" | Scan not performed, file too big | This result can be returned only if throwExceptionOnFailure == false |
| "4" | Scan not performed, the ICAP server is unreachable | This result can be returned only if throwExceptionOnFailure == false |
| "5" | Scan not performed, the ICAP server returned an error | This result can be returned only if throwExceptionOnFailure == false |
| "32" | Scan not performed, some other error prevented it | This result can be returned only if throwExceptionOnFailure == false |
List files VirtualBoX
Description
Given a VirtualBox name all files bound to, it will be put as ExternalFile objects in the resulting File List variable.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Virtual Box | VariableType.VIRTUAL_BOX | Y | Virtual Box name where the given FileSet ID will be bound to |
| File List | VariableType.STRING | Y | Variable that will contain the list of files as a result of the current operation. (Tip: You can cycle through elements of a list using the Subprocess object) |
Local Execute Shell Command
Description
It invokes the Execute Shell command service provider.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Executable | VariableType.STRING | Y | The command to be executed in the commandline |
| Arguments | VariableType.STRING | N | List of arguments to be passed to the command execution 🚀 This field handles blanks and special characters. As per the standard Unix protection methods, enclose filenames in single or double quotes. Examples: ls -l "/tmp/max/Dir with blanks" ls -l '/tmp/max/Dir with blanks' touch "/tmp/max/Dir with blanks/$aa%bb&cc()dd=[]dd{};:zz.txt" |
| Std Out | VariableType.STRING | Y | Name of a variable that will be filled with standard output logging |
| Std Err | VariableType.STRING | Y | Name of a variable that will be filled with standard error logging |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
| Return code management | VariableType.BOOLEAN | N | If checked, it will forcefully fail the command if a Return Code that is not 0 is returned. Otherwise, it completes with SUCCESS whatever the RC will be for backward compatibility |
Local FileSystem SpLs
Description
It invokes the "LS" command on filesystem that lists the content of a local file system folder.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Username | VariableType.STRING | N | Username used by this command |
| Password | VariableType.STRING | N | Password for the username used by this command |
| Path | VariableType.STRING | Y | Specify local path where file listing will be performed |
| List | VariableType.STRING | Y | Variable that will contain the list of files as a result of the current operation. (Tip: You can cycle through elements of a list using the Subprocess object) |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Local SpConv
Description
It invokes SPCONV conversion Command Service that converts an input file codepage and EOL, creating a new file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input File | VariableType.STRING | Y | The input file path for conversion |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file to be converted |
| Input Code Page | VariableType.CODE_PAGE | Y | The codepage of the input file |
| Output Code Page | VariableType.CODE_PAGE | Y | The codepage that will be written to the output file |
| Input EOL | VariableType.EOL | N | The EOL used in the input file |
| Output EOL | VariableType.EOL | N | The EOL that will be written in the output file |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Local SpGet
Description
It invokes the SPGet Service that retrieves a file from a Virtual File System folder and saves it to a local folder.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Source | VariableType.VIRTUAL_PATH | Y | Virtual path where the file will be taken |
| File | VariableType.STRING | Y | Filename that will be taken in the previously set virtual path |
| Destination Path | VariableType.STRING | Y | Destination path where the fill will be placed by the task |
| File Name | VariableType.STRING | N | Filename that will be used for the final file |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation |
| Return Code variable | VariableType.STRING | Y | The workflow variable where final return code will be written |
Local SpPut
Description
It invokes the Local SpPut service that retrieves a file from a local folder and uploads to a Virtual File System.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| File | VariableType.STRING | Y | Filename that will be get in the previously set virtual path |
| Source | VariableType.STRING | Y | Source path where the file will be get |
| Destination | VariableType.VIRTUAL_PATH | Y | The destination virtual path were the file will be placed |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation applied to the transport |
| FilesetID created | VariableType.STRING | Y | Name of the variable that will contain the RegistryID (FilesetID) of the created file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Local VirtualPath SpLs
Description
It invokes the VirtualPath SPLS command that lists the content of a Virtual File System folder.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Virtual Path | VariableType.VIRTUAL_PATH | Y | The virtual path to use for file listing in the current operation. (Tip: It's a remote path, so plain String, not a VirtualPath) |
| File List | VariableType.STRING | Y | Variable that will contain the list of files as a result of the current operation. (Tip: You can cycle through elements of a list using the Subprocess object) |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Mail pull
Description
It invokes the SpMailPull command service that retrieves a Mail from a remote file system and writes it to a Virtual file system.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| VFS unverified | VariableType.STRING | Y | The virtual file system where email(s) that are not verified will be placed |
| Remote path | VariableType.STRING | Y | The Remote Path |
| VFS verified | VariableType.STRING | Y | The virtual file system where email(s) that are verified will be placed |
| VFS discarded | VariableType.STRING | Y | The virtual file system where email(s) that are discarded will be placed |
| Raw | VariableType.STRING | Y | The virtual path folder name where the raw mail is stored |
| Attachment Virtual Path | VariableType.STRING | N | The virtual path folder name where the attachment is stored |
| Disposition | VariableType.STRING | N | The email desired disposition behavior |
| Return Code variable | VariableType.STRING | N | The workflow variable where the final return code will be written |
Mail push
Description
It invokes the SpMailPush command service that sends a Mail from a Virtual file system.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| To | VariableType.STRING | Y | The Destination of the email |
| From | VariableType.STRING | Y | The Sender of the email |
| Subject | VariableType.STRING | Y | The Subject of the email |
| Body | VariableType.STRING | Y | The body of the email |
| Raw | VariableType.STRING | Y | The virtual path folder name where the raw mail is stored |
| FileSet Id | VariableType.LONG | N | The referenced FilesSet ID for this email |
| Mail Sign | VariableType.STRING | N | Whether the email sign is required or not |
| Alias Sign | VariableType.STRING | Y | The email sign alias key (mandatory if 'Sign Mail' is required) |
| Return Code variable | VariableType.STRING | N | The workflow variable where the final return code will be written |
Mail push templated
Description
It invokes SpMailPush templated command service.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| To | VariableType.STRING | Y | The Destination of the email |
| From | VariableType.STRING | Y | The Sender of the email |
| Subject | VariableType.STRING | Y | The Subject of the email |
| TemplateId | VariableType.STRING | Y | The identifier to the HTML template to be used for the body |
| Return Code variable | VariableType.STRING | N | The workflow variable where the final return code will be written |
PGP Crypt File
Description
It invokes the PGP Crypt service on an input file that produces a crypted file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input file | VariableType.STRING | Y | The full pathname (with filename) for the file to be crypted |
| Output file | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Operation security | VariableType.SECURITY_ OPERATION | Y | The security operation |
| Recipient | VariableType.STRING | Y | The recipient of the file |
| Alias key | VariableType.STRING | Y | The alias key to use for encryption |
| Hash algorithm | VariableType.SECURITY_ SIGNATURE_HASH_ALGO | Y | The hash algorithm of security signature |
| Cipher algorithm | VariableType.SECURITY_ CHIPER_ALGO | Y | The cipher security algorithm |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
| PGP format | VariableType.STRING | Y | The PGP format in binary or ascii-armor |
PGP Decrypt File
Description
It invokes PGP Decrypt service on an input crypted file and it produces a decrypted file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input file | VariableType.STRING | Y | The full pathname (with filename) for the file to be decrypted |
| Output file | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
| PGP format | VariableType.STRING | Y | The PGP format in binary or ascii-armor |
Remote SpLs
Description
It invokes the Remote SpLs service that lists the content of a remote folder.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Remote path | VariableType.STRING | Y | The remote path to use in the current operation. Tip: It's a remote path, so plain String, not a VirtualPath. |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation |
| List | VariableType.STRING | Y | Variable that will contain the list of files as a result of the current operation. (Tip: You can cycle through elements of a list using the Subprocess object) |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Remote SpMkdir
Description
It invokes the SpMkdir service that creates a new folder on a remote path.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Remote path | VariableType.STRING | Y | The remote path of the folder to create |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Remote SpMv
Description
It invokes the SpMv service that moves a file from a source location to a destination.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Source | VariableType.STRING | Y | The source path to be moved |
| Path | VariableType.STRING | Y | The destination path after the move command has been performed |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation applied to the transport |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Remote SpPull
Description
It invokes the SpPull service that retrieves a file from the file system and writes it to a virtual path.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Remote path and filename | VariableType.STRING | Y | The remote absolute path (path and filename) to pull the file from |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation applied to the transport |
| Destination | VariableType.VIRTUAL_PATH | Y | The destination virtual path where the file will be placed |
| Dest Filename | VariableType.STRING | Y | The name of the file to set once pulled |
| FilesetID created | VariableType.STRING | Y | The name of the variable that will contain the RegistryID (FilesetID) of the created file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Remote SpPush
Description
It invokes the SpPush service that retrieves a file from a virtual path and writes it to a file system path.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| File ID | VariableType.LONG | Y | The ID of the file to be pushed (Tip: if the file is in a "FileDetail" variable, its ID can be retrieved with: ${file.getRegistryId()} ) |
| Remote Path | VariableType.STRING | Y | The remote path to place the file into |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation applied to the transport |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Remote SpRm
Description
It invokes Remote SpRm service that removes a file identified in the remote path.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Remote path | VariableType.STRING | Y | The remote path to use in the current operation. Tip: It's a remote path, so plain String, not a VirtualPath |
| Transfer profile | VariableType.TRANSFER_PROFILE | Y | The transferProfile to use. Tip: It's a configured server where the current task will happen. |
| Resource profile | VariableType.RESOURCE_PROFILE | N | The resourceProfile, if any, to be applied during the operation |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Spjz Sub
Description
Submit JCL in zOS platform.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Dataset | VariableType.STRING | Y | Directory name |
| Member | VariableType.STRING | N | File name |
| JES Reader Class | VariableType.STRING | Y | JES Reader Class |
| FilesetId | VariableType.LONG | Y | The ID of the file to be used in ZOs job (Tip: if the file is in a "FileDetail" variable, its ID can be retrieved with: ${file.getRegistryId()} ) |
| Return code | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Tar File
Description
It invokes the SpTar service on an input file and produces a tar output file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| File | VariableType.STRING | Y | The full pathname (with filename) for the file to be compressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
UnBind VirtualBox
Description
Given a FileSetID, the association between it and the provided VirtualBox name will be deleted.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| File ID | VariableType.LONG | Y | Fileset ID to operate the BIND operation to |
| Virtual Box | VariableType.VIRTUAL_BOX | Y | Virtual Box name where the given FileSet ID will be bound to |
UnTar File
Description
It invokes the SpUnTar service on a tar input file and produces an untar output file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| File | VariableType.STRING | Y | The full pathname (with filename) for the file to be uncompressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
UnZip File
Description
It invokes the SpUnZip service on a zip input file and produces an unzip output file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input File | VariableType.STRING | Y | The full pathname (with filename) for the file to be uncompressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Compression Mode | VariableType.ENUM | N | The compression mode of Compression64Mode (ALWAYS or NEVER) |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Zip File
Description
It invokes the SpZip compression service on an input file and produces a zip output file.
Variables
| Parameter | Type | Required | Description |
|---|---|---|---|
| Cluster | VariableType.CLUSTER | Y | The cluster to be used |
| Input File | VariableType.STRING | Y | The full pathname (with filename) for the file to be compressed |
| Output file Path | VariableType.STRING | Y | The full pathname (with filename) for the output file |
| Compression Strategy | VariableType.COMPRESSION _STRATEGY_LEVEL | Y | The strategy level of compression |
| Compression Level | VariableType.STRING | Y | The level of compression |
| Compression Mode | VariableType.ENUM | N | The compression mode of Compression64Mode (ALWAYS or NEVER) |
| Return Code variable | VariableType.STRING | Y | The workflow variable where the final return code will be written |
Updated 4 months ago