FSR service tasks

Get Files

Description: It invokes the GetFiles Service.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to get the file list from

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)

Single Value

String

N

If set, you will only get the value for this attribute if present

Get Metadata

Description

It invokes the GetMetadata Service.

The GetMetadata service task can be used to request metadata from different classes:

  • Generic Metadata

  • eMail Metadata

  • Spazio2 file

Generic Metadata class

When selecting the Generic Metadata class, the GetMetadata service task returns custom metadata and 3 system metadata: ID_FILESET, ID_ROW, and ID_FILE. In the example below, the GenericMetalist variable will return the list of custom metadata plus the 3 system metadata, i.e.: {ID_FILESET=30378, ID_ROW=178, ID_FILE=0, genericMetadata1=value1}, {ID_FILESET=30378, ID_ROW=179, ID_FILE=0, genericMetadata2=value2}

A single metadata item can be requested by specifying the name of the requested metadata and the metadata class to which it belongs. For example, to obtain the value of the custom metadata item genericMetadata1 belonging to the Generic Metadata class, fill in the variables as follows:

The genericMetadata variable will contain the value of the genericMetadata1 custom metadata. The GenericMetadata variable will contain the 3 system metadata and the genericMetadata (custom metadata) of the file, i.e.: {ID_FILESET=30378, ID_ROW=178, ID_FILE=0, genericMetadata1=value1}.

Note that to get the value of a specific metadata item, you need to know its name. This is because it is custom metadata and both its name and value have been entered by a user.

eMail Metadata class

When selecting the eMail Metadata class, the GetMetadata service task returns eMail metadata:

The eMailMetalist variable contains the list of email metadata associated with the file. This list includes both set and empty metadata (whose value is set to null):

{ID_FILESET=37601, MAIL_RECEIVED_DATE=2025-09-08T05:52:55.000Z, MAIL_SIGN_CERT=null, MAIL_SUBJECT=Order 174382238 shipped, MAIL_BCC=, MAIL_CERT_LABEL=null, [email protected], ID_ROW=10740, ID_FILE=0, MAIL_SENT_DATE=2025-09-08T05:52:55.000Z, [email protected], MAIL_SIGN_DN=null, MAIL_SIGN_DATE=null, MAIL_BODY_BLOB=null, MAIL_RAW_SIZE=null, MAIL_CC=, MAIL_SIGN_STATE_MSG=ATTACHMENT NOT FOUND, MAIL_SIGN_STATE=2}

Each metadata name returned in this list can be used in the same service task to obtain the value of a single metadata. For example, to obtain the value of the MAIL_TO metadata, fill in the variables as follows:

The eMailMetalist variable contains the MAIL_TO metadata value of the file. In our case, the value is [email protected], as you can see in the list of metadata above.

Spazio2 file class

When selecting the Spazio2 file class, the GetMetadata service task returns all Spazio2 metadata:

The Sp2Metalist variable contains a list of Spazio2 metadata associated with the file. This list includes both set and empty metadata (whose value is set to null):

{Z_COMPRESS=null, FILE_LENGTH=null, FORMAT=null, ORIGIN_MESSAGE_FILE_ID=null, EOR_EOF=0, USER_ID=null, CODEPAGE=null, PRIORITY=5, ORIGIN_QUEUE=null, PUT_APPLICATION_TYPE=null, ORIGIN_INTERNAL_NUMBER=null, LOCALLY_EXTERNAL=null, ORIGIN_ACK_LEVEL=null, ORIGIN_CODED_CHARSET_ID=null, APPLICATION_IDENTITY_DATA=null, USER_CLASS=CLA1, APPLICATION_ORIGIN_DATA=null, DESTINATION_PATHNAME=null, REPLY_TO_QUEUE_MANAGER_NAME=null, START_PUT_DATE=null, ORIGIN_USER_CLASS=SYSP, BINARY_FILE=0, CORRELATION_ID=correlationID, ACCOUNTING_TOKEN=null, ACK_LEVEL=null, ID_FILESET=4648, ORIGIN_CODEPAGE=null, QUEUE_MANAGER_NAME=QMgr, SENDER=sender1, ID_FILE=null, QUEUE_NAME=Queue1, DESTINATION_EXTERNAL=1, INTERNAL_NUMBER=null, NODE_NAME=nodeName, DESTINATION_FILENAME=null, LAST_READ_DATE=null, PUT_APPLICATION_NAME=null, FIRST_READ_DATE=null, MESSAGE_FILE_ID=null, EXPIRY_DATE=null, ORIGIN_ENCODING=null, DESCRIPTION=null, ARRIVAL_DATE=null, ORIGINAL_FILENAME=testAcademy1.txt, REPLY_TO_QUEUE_WRITE_PASSWORD=null, DSTK=null, ADDRESS_TYPE=0, ID_ROW=2, REPLY_TO_QUEUE_NAME=null, ORIGIN_QUEUE_MANAGER=null, CODED_CHARSET_ID=null, REPLY_TO_QUEUE_ADDRESS_TYPE=0, ENCODING=null, SESSION_ID=null, ORIGINAL_FILESIZE=null}

Each metadata name returned in this list can be used in the same service task to obtain the value of a single metadata. For example, to obtain the value of the CORRELATION_ID metadata belonging to the Spazio2File metadata class, fill in the variables as follows:

The sp2metadata variable contains the CORRELATION_ID metadata value of the file. In our case, the value is correlationID, as you can see in the list of all Spazio metadata above. To retrieve a specific metadata value, the input in the Single Value variable must match the value in the Spazio2 metadata list.

Triggerable: No

Variables: These parameters are common to all metadata classes:

Parameter
Type
Required
Description

File ID

Long

Y

ID of the file from which metadata will be extracted.

Single Value

String

N

Use this variable to get a single metadata item. Enter the name of the metadata and the metadata class to which it belongs.

MetaData Class

Enum

Y

Metadata class to filter metadata types: - Generic Metadata - eMail Metadata - Ghibli System (do not use) - Spazio2 file

List

String

Y

List of metadata returned.

Get Spazio2 Selector

Description: It invokes the Sp2GetSelector Service. This service task will be initialized with a FilesetID. Since Sp2 selectors are not key/value pairs, the user must also provide the desired Selector Code to obtain its value in the desired output variable. The Selector Code is a mandatory field; the service task will not provide a list of all the selectors set on the Fileset in the output variable, only the value if it exists; otherwise, it will be null.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to get its Spazio2 selector

Output

String

Y

The output variable name

Code

String

Y

The code selector to be retrieved

Insert Spazio2 SYSTEM Selector

Description: It invokes the Sp2InsertSelector Service for area type SYSTEM.

This service task will be initialized with a FilesetID like the Set Generic Metadata and then with all the required fields to create a new selector. All the data must be filled in according to Sp2 standards for SEL_CODE possible known values (4100 - 500 - 2010) and so on.

  1. AREA_TYPE

  2. SEL_CODE

  3. SEL_TYPE

  4. SEL_LENGTH

  5. SEL_NAME

  6. SEL_VALUE

Refer to Sp2 official documentation for the possible values on real case scenarios.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to set its Spazio2 selector

Code

String

Y

The selector code to insert

Type

Enum

Y

The selector type to insert

Length

String

Y

The selector length to insert

Name

String

N

The selector name to insert

Value

String

Y

The selector value to insert

Insert Spazio2 USER Selector

Description: It invokes the Sp2InsertSelector Service for areatype USER.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to set its Spazio2 selector

Code

String

Y

The selector code to insert

Type

Enum

Y

The selector type to insert

Length

String

Y

The selector length to insert

Name

String

N

The selector name to insert

Value

String

Y

The selector value to insert

Rename File

Description: It invokes the RenameFile Service that renames a file.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to rename

New File Name

String

Y

The new file name to use

Republish File

Description: It invokes the RepublishFile Service (in bold what changed from DataOne-1.0.0-TF001) that republishes a file in another virtual path.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File

File

N (from DataOne-1.0.0-TF001)

The file to be republished, File or FilesetID are mandatory

FilesetID

Long

N (from DataOne-1.0.0-TF001)

The fileset ID to be republished, File or FilesetID are mandatory

Destination

Virtual_path

Y

The virtual path destination

FilesetID created

String

Y

Name of the variable that will contain the RegistryID (FilesetID) of the created file

Set File External Destination

Description: Set or override existing file external destination flag.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Boolean

Y

The ID of the file to associate insert selector in

Set external

Boolean

Y

Set the file to be treated for external destination

Force override

Boolean

Y

If the file already has a destination set, this flag overrides its existing setting with the desired "Set external" value

Set Generic Metadata

Description: It invokes the SetGenericMetadata service task that sets metadata on a file. This service task stores a Metadata Name and its specified value on a fileset ONLY for the Generic Metadata Class [SPFB_FILE_GENERIC_MD].

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to set its new metadata

Name

String

Y

The metadata name

Value

String

Y

The metadata value

Set Spazio2 Metadata

Description: It invokes the Spazio2Metadata Service.

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

String

Y

The ID of the file to set its new Spazio2 type metadata

Node Name

String

N

The node name of metadata

Manager Name

String

N

The manager name of metadata

Queue Name

String

N

The queue name of metadata

AdressType

String

N

The AdressType of metadata

Internal Number

String

N

The internal number of metadata

Message FileId

String

N

The file id message of metadata

CorrelationId

String

N

The correlation id of metadata

Sender

String

N

The sender of metadata

User Class

String

N

The user class metadata

File Size

String

N

The size of the file

Priority

String

N

The priority of metadata

UserId

String

N

The userId of metadata

SessionId

String

N

The sessionId of metadata

Origin Queue Manager

String

N

The origin queue manager of metadata

Origin Queue

String

N

The origin queue of metadata

Origin User Class

String

N

The Origin User Class of metadata

Origin Message FileId

String

N

The origin message fileId of metadata

Origin Internal Number

String

N

The origin internal number of metadata

Accounting Token

String

N

The accounting token of metadata

AckLevel

String

N

The ackLevel of metadata

Identity Data

String

N

The identity data of metadata

Origin Data

String

N

The origin data of metadata

Format

String

N

The format of metadata

Origin AckLevel [

String

N

The origin ackLevel of metadata

Origin Code Page

String

N

The origin code page of metadata

Origin Encoding

Enum

N

The origin encoding of metadata

Put Application Name

String

N

The put application name of metadata

Reply To Queue Address Type

Enum

N

The reply to queue address type of metadata

Reply To Queue Manager Name

String

N

The reply to queue address type of metadata

Reply To Queue Name

String

N

The reply to queue name of metadata

Reply To Queue Write Password

String

N

The reply to queue write password of metadata

Destination External File

Boolean

N

Destination external file

Update Spazio2 Selector

Description: It invokes the Sp2UpdateSelector Service.

This service task will be initialized with a FilesetID and selector code, as the Get Spazio2 Selector. Next, the Selector Value that needs to be updated is required.

This service task updates values; it will not insert anything if there are no selectors on the fileset with the specified selector code. Therefore, if no selector exists, use the "Insert Selector" instead of the "Update."

Triggerable: No

Variables:

Parameter
Type
Required
Description

File ID

Long

Y

The ID of the file to set its Spazio2 selector

Code

String

Y

The selector code to update

Value

String

Y

The selector value to update

Return code

String

Y

The workflow variable where final return code will be written into

Last updated