The tables below provide details about each Business Process task, its purpose, parameters, and usage. Within each task description, bold text indicates mandatory parameters. All parameters are Input unless designated as Output.
Several of the tasks are shown with an older/legacy Studio version label (in parenthesis) followed by a newer naming convention. Either one can be used in the filter section of the Business Process editor to search for an action.
Add
This task adds two numbers.
Parameter | Type | Description |
---|---|---|
Result | Long, Double | Output |
Addend 1 | Long, Double | The first number to be added. |
Addend 2 | Long, Double | The second number to be added. |
(AppendString) String Append
This task appends a string to the end of another string.
Parameter | Type | Description |
---|---|---|
Result | String | Output |
String | String | The string to append to. |
Append | String | The string to be appended. |
(AppendStringMultiple) String Append Multiple
The task appends up to 10 values (String, Long, Double, Storage Node).
Parameter | Type | Description | Required |
---|---|---|---|
Result | String | The result to be stored in a string variable. | Yes |
Separator | String | Accepts string as input. Optional parameter. Any value assigned to it acts as delimiter. | No |
Value 1 - 10 | String, Long, Double, Storage Node |
Accepts string, long, double, and storage node as input. Value 1 and Value 2 are required parameters. The remaining values are optional. When creating this task, only four parameters appear. (Result, Separator, Value1, Value2). Use the available button to add more parameters (limit is 10). Parameters can also be deleted. |
Yes |
Example: Input with separator
For these given inputs the output will be This Is An Example of StringAppendMultiple
.
(Property: Value)
- Result: String Variable
- Separator: " "
- Value1: This
- Value2: Is
- Value3: An
- Value4: Example
- Value5: of StringAppendMultiple
Example: Input without separator
For these given inputs the output will be a24.368bc
.
(Property: Value)
- Result: String Variable
- Separator:
- Value1: a
- Value2: 2
- Value3: 4.368
- Value4: b
- Value5: c
(CompareValues) Compare Values
This task compares two values.
Parameter | Type | Description |
---|---|---|
Value 1 | Object | The first value to be compared. |
Value 2 | Object | The second value to be compared. |
Compare Type | CompareType | The type of comparison. Choices are: Equal, Greater or Equal, Greater Than, Less or Equal, Less Than, and Not Equal. |
Result | Boolean | Output. |
(ContainsString) String - Contains
This task determines if a string contains a value.
Parameter | Type | Description |
---|---|---|
Result | Boolean | Output. |
String | String | The string to be searched. |
Search String | String | The string to search for. |
Case Sensitive | Boolean | Indicates a case sensitive search. Default=true. |
(ConvertDatetoString) Date - Convert to String
This task converts a date to a string using the simple date format.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
Date | Date | The date to be modified. |
Date Format | String | The string format to convert the date to. |
Convert Spreadsheet (ConvertSpreadsheet)
This task converts transformation output to spreadsheet data.
Parameter | Type | Description |
---|---|---|
Template | SpreadsheetTemplate | Provides information on the output format of the spreadsheet data. |
Spreadsheet | StorageNode | The output of the transformation being converted to spreadsheet format. |
Result | StorageNode | Output. |
(ConvertStorageNode) Extended Character Set Converter
This task allows for specifying a character set for use when decoding data. This task is similar to the ConvertStorageNodeWithCharset task, but with additional parameters.
Parameter | Type | Description | Required |
---|---|---|---|
Source Storage Node | StorageNode | The data to decode. | Yes |
Source Character Set | String, Charset | If left blank, Auto Detection is enabled. | No |
Target Storage Node | StorageNode | Output. | |
Target Character Set | String, Charset | Output. If left blank, UTF-8 Is used. | |
Auto Detected Character Set | Charset | Output. Retrieves the name of the character set if Auto Detection is used. | |
Decoder Malformed Action | String, CodingErrorAction | The action to take when the input data doesn’t make sense (example: if the Byte value is outside the range of the character set).
Choices are: IGNORE (drop it from the data), REPLACE (with the replacement value), and REPORT (by throwing an error and failing). Default=REPLACE. |
|
Decoder Unmappable Action | String, CodingErrorAction | The action to take when the input character doesn’t exist in UTF-16 (example: if the § symbol doesn’t exist in the UTF-16 charset).
Choices are: IGNORE (drop it from the data), REPLACE (with the replacement value), and REPORT (by throwing an error and failing). Default=REPLACE. |
|
Decoder Replacement Value | String | If REPLACE is indicated for either the Decoder Malformed Action or Decoder Unmappable Action parameters and the conditions are met, this value is used. | |
Encoder Malformed Action | String, CodingErrorAction | The action to take when the input data doesn’t make sense (example: if the Byte value is outside the range of the character set).
Choices are: IGNORE (drop it from the data), REPLACE (with the replacement value), and REPORT (by throwing an error and failing). Default=REPLACE. |
|
Encoder Unmappable Action | String, CodingErrorAction | The action to take when the input character doesn’t exist in UTF-16 (example: if the § symbol doesn’t exist in the UTF-16 charset).Choices are: IGNORE (drop it from the data), REPLACE (with the replacement value), and REPORT (by throwing an error and failing).Default=REPLACE. | |
Encoder Replacement Value | String | If REPLACE is set for either the Encoder Malformed Action or Encoder Unmappable Action parameters and the conditions are met, this value is used. |
(ConvertStorageNodetoString) Convert Storage Node to String
This task converts the specified object to a string representation.
Parameter | Type | Description |
---|---|---|
Storage Node | StorageNode | The object to be converted. |
Result | String | Output. |
(ConvertStorageNodeWithCharset) Character Set Converter
Parameter | Type | Description |
---|---|---|
Source Storage Node | StorageNode | The data to decode. |
Source Character Set | String, Charset | If left blank, Auto Detection is enabled. |
Target Storage Node | StorageNode | Output. |
Target Character Set | String, Charset | Output. If left blank, UTF-8 Is used. |
Auto Detected Character Set | Charset | Output. Retrieves the name of the character set if Auto Detection is used. |
(ConvertStringToNumber) Convert To Number
This task converts a numeric string value to a Double data type value.
Parameter | Type | Description |
---|---|---|
Result | Double | Output. |
String | String | The string to convert. |
(ConvertStringToStorageNode) Convert String To StorageNode
This task converts a specified string representation to a StorageNode.
Parameter | Type | Description |
---|---|---|
String | String | The string to convert. |
String | StorageNode | Output. |
(ConvertToString) Convert To String
This task converts any value into its string form.
Parameter | Type | Description |
---|---|---|
Object | Object | The value to convert. |
Result | String | Ouput. |
(CreateArray) Array - Create
This task creates a new array for use throughout a Business Process.
Parameter | Type | Description |
---|---|---|
Result | Array | Output. |
Size | Long | The size of the array to be created. |
Iterator Variable (Sets Zero) | Long | Initializes (sets to zero) a counter/index for an array position variable. |
(CreateContextPoint) Context Point - Create
This task creates a Context Point object in the Storage Manager and returns a reference to a StorageNode. This task works in combination with the (GetContextPointValue) Context Point - Get Value and SetContextPointValue tasks. Please see the Context Point task category for details.
(CreateFile) Create File
This task creates a file.
Parameter | Type | Description |
---|---|---|
Filename | String | The name of the file. |
Filepath | String | The fully-qualified location for the file. |
Last Modified Date | Date | The last modified date. |
Result | File | Output. |
(CreateLogOfConnection) Create Log of Connection
Parameter | Type | Description |
---|---|---|
StorageNode | StorageNode | |
Log | Log |
(CreateSortableMessageLogs) Create Sortable Message Logs
Parameter | Type | Description |
---|---|---|
Log of Application Batch Id | Log | |
Log of Work File Id | Log |
(DecrementDateField) Date - Decrement Field
This task subtracts a specified number from a specified date and date field.
Parameter | Type | Description |
---|---|---|
Result | Date | Output. |
Field | DateField | The date field. Choices are: Day, Hour, Millisecond, Minute, Month, Second, Week, and Year. |
Amount | Long | The amount to decrement. |
Date | Date | The date to be modified. |
(EncodeUuid) UUID Encoding Conversion
This task converts to or from an internal UUID specification.
Parameter | Type | Description | Required |
---|---|---|---|
Encoding Specification | UUIDEncodingSpecification | Indicates the type of encoding operation to perform. Choices are: Encoded and Unencoded. | Yes |
UUID Data String | String | The input string on which the operation is performed. | Yes |
String | String | Output. | Yes |
(EnvelopeAssemblyByContextPoint) Envelope Assembly By Context Point
Parameter | Type | Description | Required |
---|---|---|---|
sourceContextStorageNode | StorageNode | Yes |
(EnvelopeAssemblyByLogFilter) Envelope Assembly By Log Filter
Parameter | Type | Description |
---|---|---|
LogofApplicationBatchId | Log |
(ExecuteBasicSyntaxAnalyzer) Execute Basic Syntax Analyzer
Parameter | Type | Description |
---|---|---|
Log | Log | |
Transformation Batch | Log | |
Is New Line Part of Data Stream | Boolean | |
Decoding Character Set |
Execute Connection Router (ExecuteConnectionRouter)
Parameter | Type | Description |
---|---|---|
Log of Connection Batch | Log |
Execute Envelope Creation Router (ExecuteEnvelopeCreationRouter)
Parameter | Type | Description |
---|---|---|
Log of Application Batch | Log | |
Log of Envelope Assembly | String | |
Log of Connection Batch | Log |
(ExecuteEnvelopeRouter) Execute Envelope Router
Parameter | Type | Description |
---|---|---|
Transformation Batch | Log | |
For Reprocessing | Boolean |
(ExecuteTransformation) Execute Transformation
This task executes a transformation that produces a single output.
Parameter | Type | Description |
---|---|---|
Source | StorageNode | The data to be transformed. |
Target | StorageNode | Output. The transformed data. |
Transformation Settings | TransformationSettings | The Transformation Settings to be used. |
Ruleset | Ruleset | The Ruleset to be executed. |
Update | StorageNode | Output. The update data. |
Source Context | StorageNode | Allows a Context Point to be sent to the Ruleset for each entry in the map of name/value pairs. Names not correctly addressed are ignored. |
Target Context | StorageNode | Output. Allows the Business Process to point to the Context Point. All Variables in both the glb and env areas of the Ruleset Editor’s Variables pane are populated. |
(ExtractEdiAcknowledgementErrorData) Extract Edi Acknowledgement Error Data
This task extracts EDI Acknowledgement Error data.
Parameter | Type | Description |
---|---|---|
Ack Error Properties | EdiDataMap | This represents errors reported by your trading partner for a specific outbound group of data. |
Original ICN | String | Output. The original outbound document’s Interchange Control Number. |
Original GCN | String | Output. The original outbound document’s Group Control Number. |
Original TSCN | String | Output. The original outbound document’s Message Control Number. |
Ack Action Code | String | Output. The Acknowledgement Action Code received in the Acknowledgement response. |
Syntax Error Code | String | Output. The Acknowledgement Syntax Error Code received in the Acknowledgement response. |
Error Code 1 | String | Output. The Additional Error Code 1 received in the Acknowledgement response. |
Error Code 2 | String | Output. The Additional Error Code 2 received in the Acknowledgement response. |
Error Code 3 | String | Output. The Additional Error Code 3 received in the Acknowledgement response. |
Error Code 4 | String | Output. The Additional Error Code 4 received in the Acknowledgement response. |
Message Included | String | Output. Received in the Acknowledgement response indicating the number of messages reported as included by the receiver of the original group. |
Message Received | String | Output. Received in the Acknowledgement response indicating the number of messages reported as received by the receiver of the original group. |
Message Accepted | String | Output. Received in the Acknowledgement response indicating the number of messages reported as accepted by the receiver of the original group. |
(ExtractEdiInterchangeData) Extract Edi Interchange Data
This task extracts EDI Interchange Data for a specified interchange.
Parameter | Type | Description |
---|---|---|
Interchange Properties | EdiDataMap | A list of interchange level data from the inbound interchange. |
ICN | String | Output. The Interchange Control Number value contained in the inbound ISA segment. |
Received Id | String | Output. The Receiver Id value contained in the inbound ISA segment. |
Received Id Qual | String | Output. The Receiver Id Qualifier value contained in the inbound ISA segment. |
Sender Id | String | Output. The Sender Id value contained in the inbound ISA segment. |
Sender Id Qual | String | Output. The Sender Id Qualifier value contained in the inbound ISA segment. |
Authorization Info | String | Output. The Authorization Info value contained in the inbound ISA segment. |
Authorization Qual | String | Output. The Authorization Qualifier value contained in the inbound ISA segment. |
Security Info | String | Output. The Security Info value contained in the inbound ISA segment. |
Security Qual | String | Output. The Security Qualifier value contained in the inbound ISA segment. |
Interchange Date | String | Output. The Interchange Date value contained in the inbound ISA segment. |
Interchange Time | String | Output. The Interchange Time value contained in the inbound ISA segment. |
Segment Delimiter | String | Output. The Segment Delimiter value contained in the inbound ISA segment. |
Element Delimiter | String | Output. The Element Delimiter value contained in the inbound ISA segment. |
Sub-Element Delimiter | String | Output. The Sub-Element Delimiter value contained in the inbound ISA segment. |
Repetition Separator | String | Output. The Repetition Separator value contained in the inbound ISA segment. |
Interchange Version ID | String | Output. The Interchange Version ID value contained in the inbound ISA segment. |
Interchange Ack Requested | String | Output. The Interchange Ack Requested value contained in the inbound ISA segment. |
Test Indicator | String | Output. The Test Indicator value contained in the inbound ISA segment. |
(ExtractEdiRouteErrorData) Extract Edi Route Error Data
This task extracts EDI Route Error Data.
Parameter | Type | Description |
---|---|---|
Error Properties | EdiDataMap | A list EDI Route errors reported for the inbound interchange. |
GCN | String | Output. The Group Control Number contained in the group segment of the inbound data. |
Group Code | String | Output. The Group Code number contained in the group segment of the inbound data. |
App Receiver ID | String | Output. The App Receiver ID contained in the group segment of the inbound data. |
App Receiver ID Qual | String | Output. The App Receiver ID Qualifier contained in the group segment of the inbound data. |
App Sender ID | String | Output. The App Sender ID contained in the group segment of the inbound data. |
App Sender ID Qual | String | Output. The App Sender ID Qualifier contained in the group segment of the inbound data. |
Group Date | String | Output. The Group Date contained in the group segment of the inbound data. |
Group Time | String | Output. The Group Time contained in the group segment of the inbound data. |
Controlling Agency | String | Output. The Controlling Agency contained in the group segment of the inbound data. |
Version Release | String | Output. The Version Release contained in the group segment of the inbound data. |
Messages Sent in Group | String | Output. The Messages sent in Group contained in the group segment of the inbound data. |
TSCN | String | Output. The Message Ctrl REF contained in the message segment of the inbound data. |
Message ID | String | Output. The Message ID contained in the message segment of the inbound data. |
Error String | String | Output. The description of the EDI Route error being reported. |
Profile Name | String | Output. The name of the Collaboration Profile for which the error is being reported. |
(ExtractEdiInterchangeData) Extract Edi Interchange Data
This task extracts EDI Interchange Data for a specified interchange.
Parameter | Type | Description |
---|---|---|
Interchange Properties | EdiDataMap | A list of interchange level data from the inbound interchange. |
ICN | String | Output. The Interchange Control Number value contained in the inbound ISA segment. |
Received Id | String | Output. The Receiver Id value contained in the inbound ISA segment. |
Received Id Qual | String | Output. The Receiver Id Qualifier value contained in the inbound ISA segment. |
Sender Id | String | Output. The Sender Id value contained in the inbound ISA segment. |
Sender Id Qual | String | Output. The Sender Id Qualifier value contained in the inbound ISA segment. |
Authorization Info | String | Output. The Authorization Info value contained in the inbound ISA segment. |
Authorization Qual | String | Output. The Authorization Qualifier value contained in the inbound ISA segment. |
Security Info | String | Output. The Security Info value contained in the inbound ISA segment. |
Security Qual | String | Output. The Security Qualifier value contained in the inbound ISA segment. |
Interchange Date | String | Output. The Interchange Date value contained in the inbound ISA segment. |
Interchange Time | String | Output. The Interchange Time value contained in the inbound ISA segment. |
Segment Delimiter | String | Output. The Segment Delimiter value contained in the inbound ISA segment. |
Element Delimiter | String | Output. The Element Delimiter value contained in the inbound ISA segment. |
Sub-Element Delimiter | String | Output. The Sub-Element Delimiter value contained in the inbound ISA segment. |
Repetition Separator | String | Output. The Repetition Separator value contained in the inbound ISA segment. |
Interchange Version ID | String | Output. The Interchange Version ID value contained in the inbound ISA segment. |
Interchange Ack Requested | String | Output. The Interchange Ack Requested value contained in the inbound ISA segment. |
Test Indicator | String | Output. The Test Indicator value contained in the inbound ISA segment. |
(FormatString) String - Format
This task formats a string.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string to be formatted. |
Format | StringFormattingSpecification | The format to use. Choices are: To Lower Case, To Upper Case, and Trim. |
(GenerateUuid) Generate Unique Value
This task generates a Universally Unique Identifier, a 32-character Hexadecimal value.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
(GetContextPointValue) Context Point - Get Value
This task inspects a Context Point to obtain the value (Result) that was previously assigned to a single Variable Name. This task works in combination with the CreateContextPoint and SetContextPointValue tasks. Please see the Context Point task category for details.
(GetCurrentDate) Date - Get Current Date
This task retrieves the current date.
Parameter | Type | Description |
---|---|---|
Result | Date | Output |
(GetCurrentTime) Get Current Time
This task retrieves the current time.
Parameter | Type | Description |
---|---|---|
Result | Time | Output. |
(GetDateField) Date - Get Field
This task retrieves an individual unit of time from a date.
Parameter | Type | Description |
---|---|---|
Result | Long | Output. |
Date Field | DateField | The portion of the date field to retrieve: Day, Hour, Millisecond, Minute, Month, Second, Week, and Year. |
Date | Date | The date from which to retrieve the field. |
(GetNextNumber) Get Next Number
This task retrieves the next sequential number from the Next Number repository.
Parameter | Type | Description |
---|---|---|
Next Number Key | String | The name of the Next Numbers object to retrieve the next number for.
Note: The fully qualified path must be defined as such: <project name>.<package name>.<object name>.<next number key name>.
|
Result | Long | Output. |
(GetProcessNumber) Get Process Number
This task retrieves the current process number within the Auditor.
For example, to update a Data Source with the Process Number of the Collaboration that processed the record last, use the Get Process Number task to populate a variable in a Business Process and then set a value in a Source Context Point for a transformation. Include the Process Number in a "failure" e-mail. You could first get the number of the process with this task, then concatenate or replace a keyword using the string tasks to the e-mail’s Subject or Message parameter values.
Parameter | Type | Description |
---|---|---|
Process Number | String | Retrieves the current process number within the Auditor. |
(GetProperty) Get Property
This task retrieves a value from a properties file.
Parameter | Type | Description |
---|---|---|
Properties | String, File, Properties | The properties file. |
Property Name | String | The name of the property. |
Result | String | Output. |
InboundAcknowledgementErrorHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap | |
acknolwedgementErrorProperties | EdiDataMap |
InboundDuplicateInterchangeHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap |
InboundEdiRouteErrorHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap | |
routeErrorList | Array |
InboundEdiRouteNotFoundHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap | |
routeNotFoundCount | Long |
InboundEdiRouteProcessBindingNotFoundErrorHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap | |
routeProcessBindingsNotFoundCount | Long |
InboundInterchangeProcessedHandler
Parameter | Type | Description |
---|---|---|
storageId | StorageNode | |
interchangeProperties | EdiDataMap |
IncrementDateField
This task adds a specified number to a specified date and date field.
Parameter | Type | Description |
---|---|---|
Result | Date | Output. |
Date Field | DateField | The date field. Choices are: Day, Hour, Millisecond, Minute, Month, Second, Week, and Year. |
Amount | Long | The amount to increment. |
Date | Date | The date to be modified. |
This task returns the location in a string of the first occurrence of another string starting at a specified position.
Parameter | Type | Description | Required |
---|---|---|---|
Result | Long | Output. | Yes |
String | String | The string to search. | Yes |
Search String | String | The string to find. | Yes |
Start Index (default: 1) | Long | Default=1. | Yes |
This task inserts one string into another.
Parameter | Type | Description | Required |
---|---|---|---|
Result | String | Output. | Yes |
String | String | The string to insert the substring into. | Yes |
Insertion String | String | The substring to be inserted. | Yes |
Insertion Index | Long | The position in the string to insert the substring. | Yes |
JSON
For all tasks used with JSON, see the JSON Category of BP tasks.
MakeStoredNodePersistent
This task permanently saves temporary transaction data in the Clarify storage manager.
Parameter | Type | Description |
---|---|---|
Storage Node | StorageNode | A unique identifier representing the transaction data. |
Parameter | Type | Description | Required |
---|---|---|---|
Merged Storage Node | StorageNode | Yes | |
Storage Node 1 | StorageNode | Yes | |
Storage Node 2 | StorageNode | Yes |
(OriginEvent_GetElaspedMilliseconds) Origin Event - Get Elapsed Milliseconds
This task allows you to add certain values under a key earlier in their processes thread and retrieve them later, such as during the Route or Connection Process. Works with two other tasks: Origin Event - Get Info and Origin Event - Get Property.
*Get Elapsed Milliseconds will log and set the return value to milliseconds elapsed since originTime.
*Get Info will log and can return event Name, payload, and/or originTime.
*Get Property will log and return based on the assigned variable type an event property value as String or JSON.
Parameter | Type | Description | Required |
---|---|---|---|
Elapsed Milliseconds | Long, Double | Output | Yes |
(OriginEvent_GetInfo) Origin Event - Get Info
This task allows you to add certain values under a key earlier in their processes thread and retrieve them later, such as during the Route or Connection Process. Works with two other tasks: Origin Event - Get Elapsed Milliseconds and Origin Event - Get Property.
*Get Info will log and can return event Name, payload, and/or originTime.
*Get Elapsed Milliseconds will log and set the return value to milliseconds elapsed since originTime.
*Get Property will log and return based on the assigned variable type an event property value as String or JSON.
Parameter | Type | Description | Required |
---|---|---|---|
Origin Event Name | String | Yes | |
Origin Timestamp | Date | Yes | |
Payload | Storage Node | Yes |
(OriginEvent_GetProperty) Origin Event - Get Property
This task allows you to add certain values under a key earlier in their processes thread and retrieve them later, such as during the Route or Connection Process. Works with two other tasks: Origin Event - Get Info and Origin Event - Get Milliseconds.
*Get Property will log and return based on assigned variable type an event property value as String or JSON.
*Get Info will log and can return event Name, payload, and/or originTime.
*Get Elapsed Milliseconds will log and set the return value to milliseconds elapsed since originTime.
Parameter | Type | Description | Required |
---|---|---|---|
Event Property Name | String | Yes | |
Property Value | String or JSON | No |
ReceiveEdi
Parameter | Type | Description |
---|---|---|
payload | StorageNode | |
decodingCharacterSetName | String |
ReplaceString
This task replaces all matches of a given Regular Expression in a string with a replacement string.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string to do the replacement on. |
Regular Expressions | String | The Regular Expression to match what needs to be replaced. |
Replacement String | String | The value to replace the matches with. |
ResolveGlobalVariables
This task requests that all known Global Variables be "resolved" in a string variable.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string in which to resolve the variable. If the variable is not resolved, this task fails. |
RetrieveConnectionBatchStatus
This task retrieves the status of a group of connections.
Parameter | Type | Description |
---|---|---|
Context | StorageNode | The StorageNode containing the status of the logs to be retrieved. |
Status | LogStatus | Output. The status of the retrieved log. |
RetrieveEdiInterchangeData
Parameter | Type | Description |
---|---|---|
Interchange Log ID | Log | |
Interchange Log Data | StorageNode |
SecureAcknowledgementProcessor
Parameter | Type | Description |
---|---|---|
connectionId | String | |
delivered | String | |
description | String |
SendEmail
This task sends an e-mail. The most common use case is to use this as a notification when something in a process fails.
Parameter | Type | Description |
---|---|---|
To | String | The recipient’s email address(es); separate by a semi-colon if more than one. |
From | String | The sender’s email address. |
CC | String | The carbon copy address(es); separate by a semi-colon if more than one. |
BCC | String | The blind carbon copy email address(es); separate by a semi-colon if more than one. |
Subject | String | The subject. |
Message | String, StorageNode | The message. If a StorageNode, the contents of the StorageNode is read into memory and copied into the message of the email. |
Attachment | File, String, StorageNode | The attachment. If a String, this must be the pathname to an existing file. If a StorageNode, the content of the StorageNode is attached to the email. |
Attachment Name | String | The name for the e-mail attachment. |
SendEventNotification
This task sends an Event to the Event Notification Manager.
Parameter | Type | Description |
---|---|---|
Notification Type | The name of the Event to be triggered. | |
Payload | The data payload. | |
Is Outbound | Boolean | Indicates if external listeners should receive this Event. |
SetConnectionFieldValues
This task sets the values of the parameters according to the mapping in an Inbound EDI Route.
Parameter | Type | Description |
---|---|---|
Endpoint | EDI Enveloper | The Inbound EDI Route to get the values from. |
SetContextPointValue
This task sets a value in a Context Point. This task works in combination with the CreateContextPoint and (GetContextPointValue) Context Point - Get Value tasks. Please see the Context Point task category for details.
SetDateField
This task sets a date field to a value.
Parameter | Type | Description |
---|---|---|
Result | Date | Output. |
Date Field | Date Field | The date field: Day, Hour, Millisecond, Minute, Month, Second, Week, and Year. |
Source | Long | The date to be modified. |
Source | Date | The date to be modified. |
SetExitStatus
The final Pass/Fail status of a Business Process is inherited from the status of the last task that it executes. This task, which explicitly sets the final Pass/Fail status of the entire Business Process, does not deviate from this behavior – therefore, it must be the last task to be executed in the Business Process. This task is useful if you want to execute a series of conditional tasks, but still indicate that the Business Process as a whole is to be considered a failure/success.
Parameter | Type | Description |
---|---|---|
Status | Boolean | Pass=true; Fail=false. |
SetGlobalVariable
This task sets a Global Variable value.
Parameter | Type | Description |
---|---|---|
Key | String | The Variable Name of the Global Variable. The name is specified without the “<” markers. For example, to change the Global Variable <output.path>, the value for this parameter should be specified as “output.path” (no quotes). |
New value | String | The new value of the Global Variable. |
Old value | String | Output. The value of the Global Variable before it was changed. |
Create GSSV if not found | Boolean | Indicates if the Global Variable is to be created if not found. Default=true. |
Note: Strings must be entered as fully qualified names. For example: <package name>.<object name>.<variable name>
SetProperty
This task sets the value of a property in a properties file.
Parameter | Type | Description |
---|---|---|
Properties File | String, File, Properties | The properties file to be edited. Or, the string path to the properties file. |
Property Name | String | The property in the file that is to be set. |
Value | String | The value of the property to be set. |
SetRouteFieldValues
This task sets the values of parameters according to the mapping in an Inbound EDI Route.
Parameter | Type | Description |
---|---|---|
Route | EDIRoute | The Inbound EDI Route to get the values from. |
SetVariable
This task sets the value of a variable.
Parameter | Type | Description |
---|---|---|
Variable | Object | The variable to be set. |
Value | Object | The value to set it to. |
SetVaultEntryAlias
This task sets...
Parameter | Type | Description |
---|---|---|
returnValue | Void | |
arg0 | String |
Sleep
Parameter | Type | Description |
---|---|---|
Unit of Time | Unit of time | |
Duration/Date | Long, Date |
StorageNodeHasData
This task tests if a StorageNode contains at least one non-white space character.
Parameter | Type | Description |
---|---|---|
StorageNode | StorageNode | The storage node to be tested. |
StringLength
This task computes the length of a string.
Parameter | Type | Description |
---|---|---|
String | String | The string to compute the length of. |
Result | Long | Output. |
StringToLowerCase
This task converts all characters in a string to lowercase.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string to convert to lower case. |
StringToUpperCase
This task converts all characters in a string to uppercase.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string to convert to upper case. |
Substring
This task extracts a substring from a string.
Parameter | Type | Description |
---|---|---|
Result | String | Output. |
String | String | The string to take the substring from. |
Start Index | Long | The starting index of the substring to be extracted. |
End Index | Long | When left blank, the end of the string is assumed. |
Subtract
This subtracts one number from another.
Parameter | Type | Description |
---|---|---|
Result | Long, Double | Output. |
Minuend | Long, Double | The number to be subtracted from. |
Subtrahend | Long, Double | The number to subtract from the minuend. |
UpdateAcknowledegmentStatus
Parameter | Type | Description |
---|---|---|
Acknowledgement Validation Data | StorageNode |
UpdateConnectionLogStatus
Parameter | Type | Description |
---|---|---|
Connection Id | String | |
Status | String | |
Description | String | |
Session | String |
UpdateLogStatus
Parameter | Type | Description |
---|---|---|
Log | Log |
XmlDocumentContains
This task searches a StorageNode to see if it contains a specified value. The data (internally) should point to an XML File. The data search is based on a plain-text representation of the object – that is, the Source is searched as if it is a human-readable XML representation of the data. No special parsing is performed to match against element names, attribute names/values, etc. So, you may search for <ELEMENT_NAME> – not just ELEMENT_NAME.
Parameter | Type | Description |
---|---|---|
Document | StorageNode | The StorageNode from which to read the XML data. |
Search String | String | The string (or Regular Expression) to search for. |
Is Regular Expression (default table) | Boolean | Indicates if the Search String should be treated as a Regular Expression; default = false. |
Result | Boolean | Output. This will never be a null value - unless an internal error occurs that would cause the Business Process to fail anyway. |
Comments
0 comments
Please sign in to leave a comment.