Local Operations service tasks
Local Execute Shell Command
Description: This service task executes the shell commands configured in the Executable parameter of the service task.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used.
Executable
String
Y
Command to be executed in the service task. For example, this parameter can contain the full path of a script that will be executed when the service task is executed:
/home/doc/executeShellScript.shThe STENG must have permissions to execute the script.
Arguments
String
N
List of arguments to be passed to the command execution.
Arguments must be separated by blanks.
🚀 Blanks and special characters are managed as per the standard Unix protection methods and must be enclosed in single or double quotes.
For example, given a script expecting 3 parameters, the Arguments field will contain:
Jane Smith "Oxford street 125 London UK"
Std Out
String
Y
Name of the variable that will be filled with the standard output logging.
Std Err
String
Y
Name of the variable that will be filled with the standard error logging.
Return code
String
Y
Workflow variable where the final return code will be written.
Return code management
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 VirtualPath SpLs
Description: This service task retrieves the list of contents from the Virtual Path specified in the Virtual Path parameter. The resulting list is stored in the variable defined in the File List parameter.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used.
File List
String
Y
Specify the variable that contains the list of files found in the virtual path configured in the Virtual Path parameter below.
The default value is filelist, but you can change it as needed.
Tip: You can cycle through the items in this list using the Subprocess object.
Return code
String
Y
Workflow variable where the final return code will be written.
Virtual Path
Virtual_path
Y
Specify the Virtual Path whose contents you want to retrieve.
It is suggested to define a variable and specify the Virtual Path value in the contract.
If you want to enter the full Virtual Path, use the following format:
<vfs-name>:/<virtual-path>
Local FileSystem SpLs
Description: It invokes the LS command on the filesystem that lists the content of a local file system folder.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used
Username
String
N
Username used by this command
Password
String
N
Password for the username used by this command
Path
String
Y
Local path where file listing will be performed
List
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
String
Y
Workflow variable where the final return code will be written
Local VirtualPath SpRm
Description: It invokes SpRm on the VirtualPath service, it uses File ID or VFS Name+VFS Path and it removes a file from a Virtual File System.
Triggerable: No
Variables:
Cluster
Cluster
Y
The cluster to be used
FileSet ID
Long
Y
ID of the file to be removed. Use this or VFS Name+VFS Path. (Tip: if the file is in a "FileDetail" variable, its ID can be retrieved with: ${file.getRegistryId()} )
VFS Name
String
Y
VfsName of the file to be deleted. It MUST exist along with the VFS Path if the File ID is not selected
VFS Path
String
Y
VfsPath of the file to be deleted. It MUST exist along with the VFS Name if the File ID is not selected
Return Code Variable
String
Y
Workflow variable where the final return code will be written. If the file to be removed does not exist, the return code will be 0
Local SpConv
Description: It invokes SPCONV conversion Command Service that converts an input file codepage and EOL, creating a new file.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used
Input File
String
Y
Input file path for conversion
Output file Path
String
Y
Full pathname (with filename) for the output file to be converted
Input Code Page
Code_page
Y
Codepage of the input file
Output Code Page
Code_page
Y
Codepage that will be written to the output file
Input EOL
Eol
N
EOL used in the input file
Output EOL
Eol
N
EOL that will be written in the output file
Return code
String
Y
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.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used
Source
Virtual_path
Y
Virtual path where the file will be taken
File
String
Y
Filename that will be taken in the previously set virtual path
Destination Path
String
Y
Destination path where the fill will be placed by the task
File Name
String
N
Filename that will be used for the final file
Resource profile
Resource_profile
N
ResourceProfile, if any, to be applied during the operation
Return Code variable
String
Y
Workflow variable where final return code will be written
Local SpProp
Description: It invokes the SpProp service to load a local property file.
Triggerable: No
Variables:
Cluster
Cluster
Y
The cluster to be used
Path
String
Y
The path where the property file will be read
Variable
String
Y
A process variable that will be filled with all the properties from the file
Return Code Variable
String
Y
The workflow variable where the 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 it to a Virtual File System.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster to be used
File
String
Y
Filename that will be get in the previously set virtual path
Source
String
Y
Source path where the file will be get
Destination
Virtual_path
Y
Destination virtual path were the file will be placed
Resource profile
Resource_profile
N
ResourceProfile, if any, to be applied during the operation applied to the transport
FilesetID created
String
Y
Name of the variable that will contain the RegistryID (FilesetID) of the created file
Return Code variable
String
Y
Workflow variable where the final return code will be written
Data Shaper Processor
Description: The Data Shaper Processor service task is used in workflow templates to be consumed in Input, Mediation, and Output Contracts to invoke Data Shaper graphs.
Triggerable: Yes
Variables:
Cluster
Cluster
Y
Cluster hosting a Data Shaper installation that will be used to execute the graph
Payload
Datashaper_payload
Y
Variable 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.
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.
Triggerable: Yes
Input Variables:
Cluster
Cluster
Y
Cluster to be used
Icap
Icap
Y
ID of the ICAP engine that will perform the scan
File ID
Long
Y
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
Enum
N
Scan mode (ANTIVIRUS or DLP)
Icap method
Enum
N
ICAP method (REQMODE or RESPMODE)
Exception If Harmful
Boolean
N
It 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
Boolean
N
It 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
icap_rc
String
Result of scan. For a detailed list of all the possible results, see the table below.
"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
🚀 Raise Business Error
Description: This service task requires a specific license. It enables users to create customized messages and error codes for the workflow template, in the event of a specific condition. For instance, it can be used when an unexpected file name or size is received. With this configuration, when a file with an unexpected name or size is received and the Raise Business Error service task is configured, a 
business error will be displayed in the Dataflow Inquiry section of Data Watcher.
A notification can be generated when a file reporting this error arrives.
Triggerable: No
Variables:
errorMsg
String
N
User-defined message appearing when a specific error occurs.
errorCode
String
N
User-defined code appearing when a specific error occurs.
fileId
Long
Y
Id of the file issuing the error.
fileName
String
Y
Name of the file issuing the error.
Last updated