Local Operations service tasks

Local Execute Shell Command

Description: It invokes the Execute Shell command service provider.

Triggerable: Yes

Variables:

Parameter
Type
Required
Description

Cluster

Cluster

Y

Cluster to be used

Executable

String

Y

Command to be executed in the command line

Arguments

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

String

Y

Name of a variable that will be filled with standard output logging

Std Err

String

Y

Name of a variable that will be filled with 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: It invokes the VirtualPath SpLs command that lists the content of a Virtual File System folder.

Triggerable: Yes

Variables:

Parameter
Type
Required
Description

Cluster

Cluster

Y

Cluster to be used

Virtual Path

Virtual_path

Y

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

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

String

Y

Workflow variable where the final return code will be written

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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:

Parameter
Type
Required
Description

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

Parameter
Type
Description

icap_rc

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

🚀 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:

Parameter
Type
Required
Description

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