Configuring Service Tasks

Suggest Edits

This section contains the list of all Service Tasks used in Primeur DATA ONE.

Service Tasks perform actions that are achieved and completed when the Service task code has been executed and the flow continues its path.

These are organized with the description of the service task and the variables it contains.

List of Service tasks in alphabetical order:

Generate Uuid

Description

It invokes the Uuid Service that generates a Universally Unique Identifier.

Variables

ParameterTypeRequiredDescription
Result variableVariableType.STRING

Y

The workflow variable where the final result will be written

Get Files

Description

It invokes the GetFiles Service.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to get the file list from
ListVariableType.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 ValueVariableType.STRING

N

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

Get Metadata

Description

It invokes the GetMetadata Service.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to get the metadata list from
ListVariableType.STRING

Y

Variable that will contain the list of metadata as a result of the current operation. (Tip: You can cycle through elements of a list using the Subprocess object)
Single ValueVariableType.STRING

N

If set, you will only get the value for this attribute if present
MetaData ClassVariableType.ENUM

N

The metadata class to use to filter the various metadata types

Get Spazio2 Selector

Description

It invokes the Sp2GetSelector Service.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to get its Spazio2 selector
OutputVariableType.STRING

Y

The output variable name
CodeVariableType.STRING

Y

The code selector to be retrieved

Insert Spazio2 SYSTEM Selector

Description

It invokes the Sp2InsertSelector Service for area type SYSTEM.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to set its Spazio2 selector
CodeVariableType.STRING

Y

The selector code to insert
TypeVariableType.ENUM

Y

The selector type to insert
LengthVariableType.STRING

Y

The selector length to insert
NameVariableType.STRING

N

The selector name to insert
ValueVariableType.STRING

Y

The selector value to insert

Insert Spazio2 USER Selector

Description

It invokes the Sp2InsertSelector Service for areatype USER.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to set its Spazio2 selector
CodeVariableType.STRING

Y

The selector code to insert
TypeVariableType.ENUM

Y

The selector type to insert
LengthVariableType.STRING

Y

The selector length to insert
NameVariableType.STRING

N

The selector name to insert
ValueVariableType.STRING

Y

The selector value to insert

Local SpProp

Description

It invokes the Spprop service to load a local property file.

Variables

ParameterTypeRequiredDescription
ClusterVariableType.CLUSTER

Y

The cluster to be used
PathVariableType.STRING

Y

The path where the property file will be read
VariableVariableType.STRING

Y

A process variable that will be filled with all the properties from the file
Return Code VariableVariableType.STRING

Y

The 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.

Variables

ParameterTypeRequiredDescription
ClusterVariableType.CLUSTER

Y

The cluster to be used
FileSet IDVariableType.LONG

Y

The 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 NameVariableType.STRING

Y

VfsName relative to the file to delete. MUST exist along with VFS Path if no File ID is selected
VFS PathVariableType.STRING

Y

VfsPath relative to the file to delete. MUST exist along with VFS Name if no File ID is selected
Return Code VariableVariableType.STRING

Y

The 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.

Logging (file or syslog)

Description

Logging service to write on an external file or to system output by the desired logging level.

Variables

ParameterTypeRequiredDescription
Message contentVariableType.STRING

Y

The message to be logged
Date format to useVariableType.STRING

N

The date format to be used for logging
FilepathVariableType.STRING

N

The full pathname (with filename) to write into
Log levelVariableType.ENUM

N

Log level to use to write to server log in case no Filepath was provided

Now

Description

It invokes the Current DateTime Service that gets a formatted string containing current date and time.

Variables

ParameterTypeRequiredDescription
PatternVariableType.STRING

N

The date pattern to use (Tip: it uses java format. "dd-MM-yyyy" -> "02-01-2018" or "E, dd MMMM yyyy HH:mm:ss z" -> "Tue, 02 January 2018 18:07:59 IST")
TimeZoneVariableType.STRING

N

The timezone to use
Result VariableVariableType.STRING

N

The workflow variable where the final return code will be written

Rename File

Description

It invokes the RenameFile Service that renames a file.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to rename
New File NameVariableType.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.

Variables

ParameterTypeRequiredDescription
FileVariableType.FILE

N (from DataOne-1.0.0-TF001)

The file to be republished, File or FilesetID are mandatory
FilesetIDVariableType.LONG

N (from DataOne-1.0.0-TF001)

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

Y

The virtual path destination
FilesetID createdVariableType.STRING

Y

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

REST Invoker

Description

HTTP TASK - REST Invoker.

Variables

ParameterTypeRequiredDescription
Request methodVariableType.LONG

Y

Request method to be used in the HTTP call: GET, POST, PUT or DELETE
Request URLVariableType.STRING

Y

Request URL of the HTTP call.
Can contain expressions, e.g. 'http://your-system.example.com/your-endpoint/${someVariable}'
Request headersVariableType.STRING

N

Line separated HTTP request headers
Request bodyVariableType.STRING

N

Request body to be sent, e.g. a JSON file. You can use expressions, e.g. {'clientId': ${clientId}, 'name': ${name}}
Request body encodingVariableType.STRING

N

HttpRequest body encoding expression, for example UTF-8
Request timeoutVariableType.INTEGER

N

Request timeout in milliseconds
Disallow redirectsVariableType.BOOLEAN

N

Determines whether HTTP redirects are allowed
Handle status codesVariableType.STRING

N

List of status codes for which the task throws a BpmnError which can be caught by a boundary error event. Code ranges can be set with an X: Example: 400, 404, 5XX. Status codes in handleStatusCodes override those in failStatusCodes when they are set in both
Save request variablesVariableType.BOOLEAN

N

Determines whether all request variables are stored. By default, only response related variables are stored as variables
Save response parametersVariableType.BOOLEAN

N

Determines whether response variables including HTTP status, headers, etc. are stored. By default, only the response body is stored as a variable
Response variable nameVariableType.STRING

Y

The variable name in which the HTTP response is stored
Save response variable as JsonVariableType.BOOLEAN

N

Determines whether the response variable is stored as a JSON variable instead of a String
Result variable prefixVariableType.STRING

N

A prefix that is added to the result variable name for easier grouping. The following variables are affected: responseProtocol, responseReason, responseStatusCode, responseHeaders, responseBody, errorMessage

Send Email

Description

Send Email Service.

Variables

ParameterTypeRequiredDescription
RecipientsVariableType.STRING

Y

The email recipients
SubjectVariableType.STRING

Y

The email subject
BodyVariableType.STRING

Y

The email body
Template IDVariableType.EMAIL_TEMPLATE

N

The identifier to the HTML template to be used for the body
File nameVariableType.STRING

N

Name of the file to be used to fill in the HTML email template
File sizeVariableType.LONG

N

Size of the file to be used to fill in the HTML email template
File pathVariableType.STRING

N

Path of the file to be used to fill in the HTML email template
File dateVariableType.STRING

N

Date of the file to be used to fill in the HTML email template

Set File External Destination

Description

Set or override existing file external destination flag.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LEAN

Y

The ID of the file to associate insert selector in
Set externalVariableType.BOOLEAN

Y

Set the file to be treated for external destination
Force overrideVariableType.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 that sets metadata on a file.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to set its new metadata
NameVariableType.STRING

Y

The metadata name
ValueVariableType.STRING

Y

The metadata value

Set Spazio2 Metadata

Description

It invokes the Spazio2Metadata Service.

Variables

ParameterTypeRequiredDescription
File IDVariableType.STRING

Y

The ID of the file to set its new Spazio2 type metadata
Node NameVariableType.STRING

N

The node name of metadata
Manager NameVariableType.STRING

N

The manager name of metadata
Queue NameVariableType.STRING

N

The queue name of metadata
AdressTypeVariableType.STRING

N

The AdressType of metadata
Internal NumberVariableType.STRING

N

The internal number of metadata
Message FileIdVariableType.STRING

N

The file id message of metadata
CorrelationIdVariableType.STRING

N

The correlation id of metadata
SenderVariableType.STRING

N

The sender of metadata
User ClassVariableType.STRING

N

The user class metadata
File SizeVariableType.STRING

N

The size of the file
PriorityVariableType.STRING

N

The priority of metadata
UserIdVariableType.STRING

N

The userId of metadata
SessionIdVariableType.STRING

N

The sessionId of metadata
Origin Queue ManagerVariableType.STRING

N

The origin queue manager of metadata
Origin QueueVariableType.STRING

N

The origin queue of metadata
Origin User ClassVariableType.STRING

N

The Origin User Class of metadata
Origin Message FileIdVariableType.STRING

N

The origin message fileId of metadata
Origin Internal NumberVariableType.STRING

N

The origin internal number of metadata
Accounting TokenVariableType.STRING

N

The accounting token of metadata
AckLevelVariableType.STRING

N

The ackLevel of metadata
Identity DataVariableType.STRING

N

The identity data of metadata
Origin DataVariableType.STRING

N

The origin data of metadata
FormatVariableType.STRING

N

The format of metadata
Origin AckLevel [VariableType.STRING

N

The origin ackLevel of metadata
Origin Code PageVariableType.STRING

N

The origin code page of metadata
Origin EncodingVariableType.ENUM

N

The origin encoding of metadata
Put Application NameVariableType.STRING

N

The put application name of metadata
Reply To Queue Address TypeVariableType.ENUM

N

The reply to queue address type of metadata
Reply To Queue Manager NameVariableType.STRING

N

The reply to queue address type of metadata
Reply To Queue NameVariableType.STRING

N

The reply to queue name of metadata
Reply To Queue Write PasswordVariableType.STRING

N

The reply to queue write password of metadata
Destination External FileVariableType.BOOLEAN

N

Destination external file

SOAP

Description

It invokes the SOAP Service.

Variables

ParameterTypeRequiredDescription
URLVariableType.STRING

Y

The url of the soap service
EnvelopeVariableType.STRING

Y

The envelope for the SOA service
ResponseVariableType.STRING

Y

The response of the SOA service
Connection TimeoutVariableType.INTEGER

Y

Maximum time, in milliseconds, to await when opening a communication link to the resource
Response CodeVariableType.STRING

Y

The HTTP response code of the SOAP service invocation will be saved in the declared variable

SubString

Description

It invokes the SubString Service that extracts a SubString from a source string.

Variables

ParameterTypeRequiredDescription
StringVariableType.STRING

N

The String
Begin IndexVariableType.INTEGER

N

The begin index of substring
End IndexVariableType.INTEGER

N

The end index of substring
Result variableVariableType.STRING

N

The workflow variable where the final result will be written

Today

Description

It invokes the Today Service that gets a formatted string containing the current date.

Variables

ParameterTypeRequiredDescription
PatternVariableType.STRING

N

The date pattern to use (Tip: it uses java format. "dd-MM-yyyy" -> "02-01-2018")
TimeZoneVariableType.STRING

N

The timezone to use
Result variableVariableType.STRING

N

The workflow variable where the final return code will be written

Update Spazio2 Selector

Description

It invokes the Sp2UpdateSelector Service.

Variables

ParameterTypeRequiredDescription
File IDVariableType.LONG

Y

The ID of the file to set its Spazio2 selector
CodeVariableType.STRING

Y

The selector code to update
ValueVariableType.STRING

Y

The selector value to update
Return codeVariableType.STRING

Y

The workflow variable where final return code will be written into

Virtual Path from String

Description

It makes a virtual path from the string Service.

Variables

ParameterTypeRequiredDescription
Virtual Path StringVariableType.STRING

Y

The string virtual path
Result variableVariableType.STRING

Y

The workflow variable where the final result will be written

Virtual Path To String

Description

It makes a virtual path to the string Service.

Variables

ParameterTypeRequiredDescription
Virtual PathVariableType.VIRTUAL_PATH

Y

The virtual path
Result variableVariableType.STRING

Y

The workflow variable where the final result will be written

Updated 4 months ago