Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Use the Human Task to assign a job to a human based on a work-party, user-role or any custom condition.
Human Task is used to support the allocation of a job to a human entity based on work party assignments, user-roles or any custom conditions. It has the mapping parameter screen to define the input and output parameters of the task. Human Task will be executed when you manually submit a form. It is represented as in rectangular shape box as shown below:
Human Task configuration panel has four different tabs to define properties.
General
General Tab contains general information such as title, task id, description etc.
Business Object
It is used to configure and map the Business Object for the input and output of any node. In case you need a value from the process to be used in your node (input) or pass the value from your node to other nodes in the process (output) you should map the input and output Activity parameters to the process Business Object. But it is not mandatory to map the parameter as you can use the node without parameters as well.
Assignment Policy
To set the type of assignment policy to be used for the task allocation
Property
Mandatory
Default
Description
Setting
Y
Lane
To choose the type of assignment method to be used. System provides 6 types as follows: Lane, Pull, Round Robin, Load Balance, Routing Policy, Multi Instance and Custom.
More details for each Assignment policy method are discussed in Task Allocation & Queuing chapter
Load Entity
Load entity tab is used to map an Entity on your ONEWEB Platform to the human task. User can configure the properties and Values inside Load Entity Tab. Delete/Trash icon is provided on right side to remove any key value mapping.
For more information on each tab and Configuration settings of Human node Task, please refer to Human Activity Node in Process Designer Reference Chapter
Use the Sub Process task to call another process.
The Sub Process task is used to call other processes from within the main process. If there is a section of the main process that can stand alone, it is good practice to implement it as a separate process. Now you can call this process from the main process using the Sub Process task. This improves clarity and reusability.
Sub Process Node Configuration panel has 3 tabs to define properties.
General
General Tab contains general information such as title, task id etc.
Business Object
Used to configure and map the Business Object for input and output for the node.
Sub process
Property
Mandatory
Default
Description
Process Name
Yes
Name of process that you want to use as a sub process in your main process.
In Sub process tab, "Open Sub process" button is used to open or edit the sub process. "Open Mapping Parameter" button is used to map parameters to the sub process. When click on Open Mapping Parameter button, the system will redirect user to Mapping Parameter screen and then user can click Mapping Parameter Input line or Mapping Parameter Output line to map parameters for this task.
Process activity is the core of a Process Template Diagram. It consists of all notations that is used to represent any business activity. In Process Designer, Process activity is also called a Node task. The node task panel is divided into 4 main node task groups as described below:
Activity Tasks: This notation is used to perform a specified task according to the functionality as defined below.
Notation
Notation name
Notation Definition
Human Task
Human Task is used to assign the task to a user or roles group.
Java Task
Java Task is used to execute any custom java functions from the uploaded java library.
Database Task
Database Task is used to execute the SQL commands like SELECT, INSERT, UPDATE and DELETE.
File Read Task
File Read Task is used to read files. There are 4 file types supported - XML, Excel, Fixed width and Delimiter.
Web Service Task
Web Service Task is used to call the SOAP Web service or REST API.
Sub Process Task
Sub Process Task is used to call another process in the same project.
File Write
File Write is used to write to a file. File types that are supported are same as the File read task - XML, Excel, Fixed width and Delimiter.
Push Notification
Push Notification Task is used to send notification to mobile application.
Gateway Tasks: Gateway Tasks are used to make decisions to control the Process Path flow. User can specify a condition to determine the path the process needs to follow. The Gateway Tasks help users to fork the process flow into divergent paths.
Notation
Notation name
Notation Definition
Exclusive
Exclusive Gateway is used to create alternative paths within the process, depending on condition, where only one of the several paths can be followed. The user can enter a condition into each path. If there is more than one path that can be fired or taken, only the first of the valid paths will be fired.
Inclusive
Inclusive Gateway is a diverging gateway where all the valid paths are taken, based on conditions. It is similar to Exclusive Gateway except that if there is more than one path that can be fired or taken, all those paths will be fired.
Parallel
Parallel Gateway is used when you want the process to take all available paths without any condition. Parallel Gateway is generally used to create concurrent flows. You can use a parallel gateway to diverge the flow into multiple paths and then use another parallel gateway to converge all the paths to form a single path process flow.
Event notation: Event notation is suitable for events that are triggered. For example, the incoming message from an external system. They can be used to start or finish a process. There are several event types supported by Process Designer.
Notation
Notation name
Notation Definition
Start event
Start Event is used to start the process.
End event
End Event is used to stop the process.
File Input
File Input Event is similar with File Read Task but this event can be the starter of the process.
Web Service Provider
Web Service Provider is used to provide the web service that is accessed by other web service clients.
Boundary event notation: This notation is used as a listener event on the Activity task notation.
For more details of these groups are explained in table below.
Notation
Notation name
Notation Definition
Timer
Timer boundary event is used as a trigger to execute another node task based on the defined maximum time duration.
Error
Error event is a trigger event to execute another node task based on the defined error or exception.
Properties of Process Activity
The first property of every process activity is by default the General Tab as shown in figure below. The General Tab is used to show the generic information of each node task and it is displayed when user double clicks on any node task.
All property settings available inside general tab are described in table below
Property
Mandatory
Default
Description
Name
Y
N
The name of node task
ID
Y
Y
The unique id of node task is generated by system
Type
Y
Y
The type of node task
Description
N
N
The description of node task
Use gateways to direct your process flow to one or more paths on basis of condition.
Gateway Nodes are used to branch a process flow based on conditions and is represented with a diamond shaped box. There are 3 gateway decision types on Process Designer as shown below:
Parallel gateway is the type of gateway where the process follows each link path without executing any conditions. Parallel gateways are used to branch the process into more than one concurrent task in a business flow.
Exclusive gateway is the type of gateway where the process will follow only the one path where the condition is evaluated to be true. Exclusive gateway is used to create the condition flows in a business process.
Inclusive gateway is the type of gateway where the process will follow all the paths where the condition is evaluated to be true. Inclusive gateway is also used to create condition flows in a process. The main difference is that the inclusive gateway can have one or more output path for process flow based on how many conditions are evaluated to be true.
The link paths are used to connect the gateway to the other node tasks based on the conditions set on each link path. The process will follow the link path where condition passes and execute successfully. Note: In Parallel Gateways all link paths are executed without any conditions.
Gateway Configuration panel has two tabs to define properties:
General Tab contains general information such as title, task id etc.
Property
Mandatory
Default
Description
Gateway Type
Y
There are 3 Gateway available types to choose from list: Exclusive, Inclusive and Parallel.
When link paths are created from Exclusive or Inclusive gateways, user must also specify the condition information of links in Gateway Parameter panel.
Property
Mandatory
Default
Description
Otherwise
N
Uncheck
To define the default path to be executed when other conditions are not matching.
Label
N
User can give name to the link for easy reference. E.g. Approve, Reject etc.
Condition
Y
Write gateway condition to direct process flow.
Condition button on Gateway Parameter Tab redirects user to the Formula Editor panel where user can write new conditions or can edit existing conditions.
For more information on each tab and Configuration settings of Gateway decisions, please refer to Gateway section in Process Designer Reference Chapter 8.2.
Use the File Input Task to start a process based on information from a file.
Purpose
The File Input Node is used to read file and is similar to the File Read Node Task except that a File Input Node can be used to start a process whenever a file appears in the specified repository.
File Input Node Properties
As mentioned before, the File Input Node is similar to the File Read Node. Therefore the properties of "File Input Node" task are same as "File Read Node" Task described in
Generally, the "Start" event node task is used to start the process by triggering the event manually. However, PD also provides other event triggers that can be used to automatically trigger another activity or event, those event triggers as explained below.
File Input Node is used to start the process when there is any file in the specified repository. There are 4 file types that are supported by this node task - Excel, Fixed Width file, XML file and delimited file. Four repositories are supported by this node task which includes File system, FTP, FTPs and Secured FTP. For the details please refer File Input Task.
Timer Event is used to trigger another node task when the time expires for the current task associated with Timer event. It can be attached to any Node task where user would like to monitor the time taken for processing and to trigger next node in case it takes more time than scheduled. For more details on timer event please refer Timer Event section.
Error Event is used to execute another node task when an exception occurs in the Process. It can be attached to any Activity node task where user would like to trigger next node in case of errors. For more details on Error Events please refer Error Event section.
Use the Java Task to call custom java functions.
The Java Task is used to call and execute Java code defined by user. The Java node task is needed when user wants to use Java code inside their business process. To accomplish this user can create the Java method, export corresponding Java class to a Jar file and then upload this Jar file to the Java Node Task for executing Java method during the business process. You can upload any jar file and call a function from that jar file using the Java Task.
Java Node Configuration panel has 3 tabs to define properties.
General
General Tab contains general information such as title, task id etc.
Business Object
Used to configure and map the Business Object for input and output for the node.
Java Parameter
Property
Mandatory
Default
Description
Jar Name
Y
The jar file. The value can be set by clicking on the Choose Jar button and choosing the jar file using the folder browser. Alternately the user can select from the list of existing jar files as well.
Class Name
Y
The fully qualified class name. The system will display all the available classes from jar on clicking the "Get Class Name" button. User can then choose the value from the list.
Method Name
Y
The method to be called from the class. System will display all the eligible methods from the chosen class. User can select the method from the list
In Java Parameter tab, "Choose Jar" button is used to upload Jar file and "Get Class Name" button is used to get class name from Jar file.
Use Timer Events to determine the maximum time allowed for processing a task.
Timer events are used to specify the upper time limit for processing a task. It can be used as a start event, intermediate event or boundary event. When a timer attached task goes over time, it allows the process to perform some action.
For Example, let's say a process is submitted to a Human Node Task, which is being monitored by Timer event. If the task is not taken care of or completed as per scheduled, then Timer event can be used to send an email to Manager/ Responsible Work Party head of such halted human node.
Timer Configuration panel has only one tab to define properties:
Timer
Property
Mandatory
Default
Description
Time Duration
Y
0
To specify the maximum time duration for a task.
Time Unit
Y
Type of time unit.
Terminate
N
Uncheck
Select checkbox if you want that task to terminate on exceeding time.
Use Error Events to handle exceptions or errors in a process by doing some action.
Error Events are used to handle the occurrence of errors during the execution of a certain task in the process flow. For example, let's say if a Java Task is executed with errors, user can use Error Event to send an error message.
Error Configuration panel settings has one tab to define properties.
Error
Property
Mandatory
Default
Description
Exception
Yes
The type of exception to be handled.
In Error tab, "Add Exception Row" button to add more exceptions, "Delete" button to remove an existing exception. "Open Mapping Parameter" button is used to map parameters of exception node task. When click Open Mapping Parameter button, then the system will redirect user to Mapping Parameter screen and the user can click Mapping Parameter Input line or Mapping Parameter Output line to set mapping parameter for this Error Event Task.
Use the Push Notification task to send message to mobile application.
Push Notification task is used to call push-notification hub to send message to mobile applications using Android or iOS platform.
Push Notification Task Configuration panel have 3 tabs to define properties.
General
General Tab contains general information such as title name, task id, description etc.
BusinessObject
Used to configure and map the Business Object for input and output for the node.
Push Notification
Property
Mandatory
Default
Description
Application Name
Y
The name of the mobile application that is to be send message.
use environment
N
Unchecked
If user chooses use environment checkbox, then system will display the list of environment variables for user to choose. User can set the Node URL in the environment variable setup screen and choose the variable in the configuration panel.
Node Url
Y
URL for calling the push-notification hub. If user chooses use environment then select the environment variable corresponding to Node URL.
Android Platform
Y, when use Android platform.
Off
To use the android platform. There are 2 options: On and Off.
iOS Platform
Y, when use iOS platform.
Off
To use the iOS platform. There are 2 options: On and Off.
You can use both platform in a single Push Notification Node.
The values for Settings are as follows.
Android Platform
When Android Platform is selected as the Platform Type, user must enter the information for calling the push notification for android in the Android Platform panel.
Property
Mandatory
Default
Description
Collapse Key
N
To provide collapse key to mark a message as collapsible. A collapsible message is a message that may be replaced by a new message if it has yet to be delivered to the device. It is used in apps where only the most recent message is relevant.
Package Name
Y
To define package name of mobile application.
Priority
Y
To define the priority of push-notification. There are 2 options -High and Normal.
High is used to wake a sleeping device when necessary and to run some limited processing.
Normal is set. When the device is in Doze, delivery may be delayed.
Server Key
Y
A server key that authorizes the mobile application to access Google services.You can get the server key when you create your Firebase project and register your mobile application.
iOS Platform
When iOS Platform is selected as the Platform Type, user must enter information for calling the push-notification for iOS in the iOS Platform panel.
Property
Mandatory
Default
Description
Package Name
Y
To define package name of mobile application.
Production Cert File
Y
Production Certificate file for an iOS application.
Production Key File
Y
Production Private Key file for an iOS application.
Password for Production
Y
Password for Authentication of production-cert file and production-key file.
Dev Cert File
Y
Develop Certificate file for an iOS application.
Dev Key File
Y
Develop Private key file for an iOS application.
Password for Dev
Y
Password for Authentication of dev-cert file and dev-key file.
Is Production?
Y
Yes
To define if use production values of push-notification. There are 2 options: Yes and No.
Upload button is used to upload certificate file and private key for production or development environment.
Both Android and iOS tabs contain an "Open Mapping Parameter" button. Clicking on "Open Mapping parameter" button redirects user to Mapping Parameter screen where user can click on Mapping Parameter Input line or Mapping Parameter Output line to map parameters for this Push Notification task.
Use the File Read task to get information from a file.
The File Read task is used to read information from file. When your process flow require to access information from a file, user can use File Read Task to read the data. The "File Read" Node Task supports files from many sources and different formats.
Configurations property settings panel has 3 tabs to define properties.
General
General Tab contains general information such as title, task id etc.
Business Object
Used to configure and map the Business Object for input and output for the node.
File Read Parameter
The values for File Source can be as following: File System, FTP, Secured FTP (SFTP) and FTPS. When value for File Source is selected, user must enter information for that File Source.
File System
Select File System to read file from directory in computer.
File Transfer Protocol (FTP)
FTP is the standard network protocol used to transfer of computer files between a client and server on a computer network.
Secured File Transfer Protocol (SFTP)
SFTP is the standard data transmission protocol for use with the SSH2 protocol. It assures that information is securely transferred using safe information stream.
File Transfer Protocol Secured (FTPS)
FTPS is an extension to the commonly used File Transfer Protocol (FTP) that support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols.
The values for File Type can be as following: FIXWIDTH, XLS, DELIMITED and XML. When value on File Type is selected, user must also enter information about that File Type.
FIXWIDTH
This format support data where every field has a fixed width and for width those fields is less than the value.
When FIXWIDTH is selected on File Type, user can choose Non Uniform Rows in "on" or "off" mode. If set to "on", then user must also enter information for Non Uniform Rows. Non Uniform Rows is set to "off" to support data when a file has consistent rows.
When Non Uniform Rows is on, user must enter information about Header (HR), Splitter (TR), Data (TD) and Footer (LR). It is used to support situations where a file has an irregular row.
HR
TR
TD
LR
XLS
Use XLS to support file format for getting information from Microsoft Excel documents.
DELIMITED
Use Delimited to support file format that has text file with a delimiter character.
XML
Use XML to support file format for getting information from Extensible Markup Language (XML) format.
When Remove Duplicate Records is on, system will remove duplicate records.
When Apply Filter is on, system will filter the data.
When Apply Sort is on, system will sort data.
When Transform Fields is on, system will convert data to a desired type.
When Move File after Completion is on, system will move file to a set directory once the reading is success or error.
In FileRead Parameter tab, "Open Mapping Parameter" button is used to map parameters of a File Read node. When click Open Mapping Parameter button, the system will redirect user to Mapping Parameter screen and then user can click Mapping Parameter Input line or Mapping Parameter Output line to mapping parameter for this File ReadTask
For Parameter Mapping
When FIXWIDTH is selected as File Type, system will show a parameter for Non Uniform Rows to be set to on or off for a file. When XLS is selected as File Type, system will show a parameters to support the excel sheets. User must create an output parameter to support the columns of an excel file. When DELIMITED is selected as File Type, system will show a parameter for Delimited type. When XML is selected as File Type, system will display the parameters to define the XML structure.
Use the Database Task to execute database commands.
The Database Task is used to execute database commands. Most processes rely on some information from database to execute jobs or complete process flows. Business processes may often require to Select, Insert, Update or Delete data from database, and pass such values to other nodes to complete process flows. Process Designer provides this functionality using Database Node tasks.
Database Node Configuration settings panel has 3 tabs to define properties.
General
General Tab contains general information such as title, task id etc.
Business Object
Used to configure and map the Business Object for input and output for the node.
Database Parameter
Java Naming and Directory Interface (JNDI) is a directory service that allows Java software clients to connect database via a name. When "Connection type" is selected as "JNDI", user must enter JNDI Name.
Java Database Connectivity (JDBC) is standard application programming interface, which defines how a client may access a database. It is Java based data access technology and used for Java database connectivity. When "JDBC" is selected as "Connection type". User must also enter value for JDBC.
In Database Parameter tab, "Open Mapping Parameter" button is used to map parameters of Database Node task. When click Open Mapping Parameter button, the system will redirect user to Mapping Parameter screen and then user can click Mapping Parameter Input line or Mapping Parameter Output line to mapping parameter for this Database Task.
There are mainly 7 types of task allocation methods supported by Process Designer.
Lane is the type of allocation where a job is assigned to the work-party name that matches the lane name of the human task. When user chooses Lane as Setting property, user must also choose value on Assignment Method property. There are 3 available Assignment Methods to choose from: Pull, Round Robin and Load Balance.
Pull is the type of allocation used where the authorized users can select and claim the job present in the pool.
Round Robin is the type of allocation used to assign a work to another work party other than of the current lane; the system will respectively assign the task to users in a round pattern.
Load Balance is the type of allocation used to assign a job to another work party other than of current lane, the system will assign job to user with less number of jobs assigned.
Note: When user chooses Pull, Round Robin or Load Balance, user must choose value for the work party correctly.
Routing Policy is the type of allocation where a system assign work to user based on some assignment condition.
When user choose Routing Policy on Setting, system will show Policy tab and Sorting tab for setting the condition and sorting value.
Policy Tab
Add Row Policy button is used to add condition setting when user wants to use multiple conditions for assignments. Delete Row Policy button is used to remove condition settings that are not required. Formula Editor is used to customize a condition using customizable condition panel.
Assignment Type can be set to "User", "Work-party" or Advance. When Advance is selected, an advance condition setting will be shown. Advance condition option should be used only when user wants to execute a system special condition along with main user- defined conditions.
Sorting Tab
Multi Instance is the type of allocation where a system assign work to multiple users based on some assignment condition. When user choose Multi Instance on Setting, system will show Multi Instance tab for setting the user and condition.
Multi Instance Tab
Custom Allocation is the type of allocation to assign a job by using the custom logic from a java class. The user must develop a java class and then upload it to the process. When user chooses Custom Policy, the human task will assign the work to user as per the logic in java class.
When user chooses Custom on Setting, user must specify Class Name property for Java class Tab.
Advance condition has Trash icon . User can click this icon on right side to remove any existing special conditions.
User can click Add Row Sorting button when user wants to sort based on multiple fields. Sorting Tab also has Trash icon . User can click this icon to remove any existing sorting.
Property
Mandatory
Default
Description
File Source
Y
-
The format type for the file transfer, like File system, FTP, Secured FTP (SFTP) and FTPS.
File Type
Y
-
The format type of the metadata files, namely FIXWIDTH, XLS, DELIMITED, and XML.
Skip 1st Row
N
Off
The value is used to skip first row of a file.
Remove Duplicate Records
N
Off
The value is used to remove duplicate records in a file.
Apply Filter
N
Off
The value is used to filter the data.
Apply Sort
N
Off
The value is used to sort data in file.
Transform Fields
N
Off
The value is used to convert data to desired type.
Move File After Compilation
N
Off
The value is used to move the file to do something when reading is success or failure.
Property
Mandatory
Default
Description
Path Directory
Y
The path or the directory that keeps the file.
File Name
Y
The name of the file that is to be read.
Property
Mandatory
Default
Description
IP Host
Y
The value of the ftp host address for transferring files.
Port
Y
The value of the ftp location for transferring files.
Passive Mode
N
Uncheck
To connect the protocol ftp with passive mode.
Username
Y
The username for login to the ftp host.
Password
Y
The password for login to the ftp host.
FTP Repository
Y
The path for keeping the ftp file was backed up.
Expression
Y
The value that was defined is the condition for showing the data.
Suffix
N
The value is the extension of the ftp.
Property
Mandatory
Default
Description
IP Host
Y
The value of the sftp host address for transferring files.
Port
Y
The value of the sftp location for transferring files.
Username
Y
The username for login to the sftp host.
Password
Y
The password for login to the sftp host.
FTP Repository
Y
The path for keeping the sftp file was backed up.
Expression
Y
The value that was defined is the condition for showing the data.
Suffix
N
The value is the extension of the sftp.
Property
Mandatory
Default
Description
IP Host
Y
The value of the ftps host address for transferring files.
Port
Y
The value of the ftps location for transferring files.
Implicit SSL
N
Uncheck
To connect the protocol ftps with Implicit SSL mode.
Username
Y
The username for login to the ftps host.
Password
Y
The password for login to the ftps host.
FTP Repository
Y
The path for keeping the ftps file was backed up.
Expression
Y
The value that was defined is the condition for showing the data.
Suffix
N
The value is the extension of the ftps.
Property
Mandatory
Default
Description
Non Uniform Rows
Y
Off
Property
Mandatory
Default
Description
Number of Header
Y
1
Number of field Header.
Field
Y
The value is a field name.
Length
N
0
Size of field to be used.
Property
Mandatory
Default
Description
HR Start
Y
Header starts with HR value.
Number of HR
Y
1
Number of header.
Ignore
N
Uncheck
To be ignored when number of line over than length value.
Field
Y
The value is a field name.
Length
Yes
0
Size of field to be used.
Property
Mandatory
Default
Description
TR Start
Y
Splitter starts with HR value.
Number of TR
Y
1
Number of Splitter.
Ignore
N
Uncheck
To be ignored when number of line over than length value.
Field
Y
The value is a field name.
Length
Y
0
Size of field to be used.
Property
Mandatory
Default
Description
TD Start
Y
Data starts with TD value.
Number of TD
Y
1
Number of data.
Ignore
N
Uncheck
To be ignored when number of line over than length value.
Field
Y
The value is a field name.
Length
Y
0
Size of field to be used.
Property
Mandatory
Default
Description
LR Start
Yes
Footer starts with LR value.
Number of TD
Yes
1
Number of footer.
Ignore
No
Uncheck
To be ignored when number of line over than length value.
Field
Yes
The value is a field name.
Length
Yes
0
Size of field to be used.
Property
Mandatory
Default
Description
Sheet Name
Y
The document name of the XLS type that want to read.
Property
Mandatory
Default
Description
Delimited
Y
The character used for Delimiting.
Property
Mandatory
Default
Description
Number of Rules
Y
1
The Number of Required Field Name.
Required Field Name
Y
The value is a file name.
Element Type
Y
The value is a type of element, there 2 types as following: element and attribute.
Path in XML File
Y
XML path to that element or attribute.
End TagName
Y
The name of element used to stop reading of a field.
Type Field Name
Y
String
Type of a field name.
Property
Mandatory
Default
Description
Number of Remove Duplicate Records
Y
1
Number of Duplicate Records.
Remove Field Name
Y
The value is a field name that is used to find duplicate.
Property
Mandatory
Default
Description
Filter Expression
Yes
The value which is used to filter.
Property
Mandatory
Default
Description
Number of Apply Sort
Y
1
Number of sort.
Sort Field Name
Y
The value is a field used for sorting.
ASC
N
Uncheck.
Type of sorting used. To get ascending order data check this.
Property
Mandatory
Default
Description
Number of Transform Fields
Y
1
Number of a transform.
Field Name
Y
The value is field name for converting.
Type to transform
Y
Type result for converting.
Property
Mandatory
Default
Description
Success Directory
Y
Path of directory to move when reading success.
Append Datetime after Move of Success
N
Uncheck
The value is used to append datetime after move of success.
Error Directory
Y
Path of directory to move when reading error.
Append Datetime after Move of Error
N
Uncheck
The value is used to append datetime after move of error.
Property
Mandatory
Default
Description
Configured by
Y
To define configured. There are 2 types: Process Designer this config is mean user need to config by self and Data designer is mean user use config from sql-builder
Connection type
Y
To define the type of database connection. There are 2 types: JNDI and JDBC.
Command Type
Y
To define the type of database command used. There are 4 options as following: Select, Insert, Update and Delete.
Command
Y
To define the SQL command to be executed in database.
Property
Mandatory
Default
Description
use environment
N
Unchecked
If user chooses use environment checkbox, then system will display the list of environment variables for user to choose. User can set the JNDI Name in the environment variable setup screen and choose the variable in the configuration panel.
JNDI Name
Y
Name of JNDI for database connection. If user chooses use environment then select the environment variable corresponding to JNDI Name.
Property
Mandatory
Default
Description
JDBC Database Driver
Y
The class name of the database driver for database connection.
use environment
N
Unchecked
If user chooses use environment checkbox, then system will display the list of environment variables for user to choose. User can set the JDBC URL in the environment variable setup screen and choose the variable in the configuration panel
JDBC URL
Y
To set the address of database for connecting database. If user chooses use environment then select the environment variable corresponding to JDBC URL.
JDBC Username
Y
Username for Authentication. If user chooses use environment then select the environment variable corresponding to JDBC UserName.
JDBC Password
Y
Password for Authentication. If user chooses use environment then select the environment variable corresponding to JDBC Password.
Property
Mandatory
Default
Description
Setting
Y
Pull
Select Lane for Lane Policy.
Assignment Method
Y
-
Type of assignment policy to use. It has 3 available choices - Pull, Round Robin and Load Balance.
Property
Mandatory
Default
Description
Work Party Name
Y
Name of work-party to assign the job.
Property
Mandatory
Default
Description
Condition
Y
To specify work assignment condition.
Match Type
Y
To define how to select matches when multiple users match that condition. You can choose to assign work to one or all users. It has 2 available options: All and Any.
Assignment Type
Y
To define an Assignment type. It has 3 available options: User, Work party and Advance.
Username
Y
This option would only be available when Assignment Type above is selected as "User. An application User can then Select any user based on available User List.
Work party
Y
This option would only be available when Assignment Type above is selected as "Work party". An application User can then Select any work party name based on available "work party" List.
Property
Mandatory
Default
Description
Number Advance Rows
Y
1
The number of advance conditions.
Filter Type
Y
The value of user to be used in special condition. It has "jobInbox" is number of jobs in user inbox, and has "userattribute" to choose any attribute of the user.
Filter Value
Y
To choose a user attribute that is to be used in special condition. This property will show when "userattribute" is selected on Filter Type.
Attribute Name
Y
To choose parameter from current process.
Operation
Y
Select Operator to use in special condition.
Property
Mandatory
Default
Description
Field
N
The field to be used for sorting.
Type
Y, when Field is used.
Type of sorting, It has asc and desc.
Special Sort
N
-
Property
Mandatory
Default
Description
Cardinality
Y
To specify the number of users to assign the job to.
Ordering
Y
To define the order in which to assign the job. It has 2 available options: Sequential or Parallel.
Assign By
Y
To define how to assign jobs. It has 2 available options: User or Work party. And give the value in the text box by the side.
Assign Method
N
This option would only be available when Assign By above is selected as "Work-Party". An application User can then select the type of assignment to be followed Available options include Pull, Round Robin, Load Balance or Custom.
Class Name
N
This option would only be available when Assign Method above is selected as "Custom". An application User can then enter the java class for custom allocation.
Flow Condition
Y
An application User can then select any of the following conditions -
(i) Wait for all to finish (All)
(ii) Wait for all to approve (All)
(iii) Wait for how many to finish
(iv) Wait for how many to approve
(v) Advance
For (iii) & (iv) there is a text box to enter the number of users needed to fulfil this level.
Condition Loop
N
If user selects (ii) or (iv), user also has to provide the condition for approval.
Cancel Remaining Instance
N
If user selects (ii) or (iv), user also has to provide what to do if a person rejects
Advance Condition
N
If user selects (v) Advance, then user has to give the advance condition hereCustom Policy
Property
Mandatory
Default
Description
Class Name
Y
The fully qualified identifier for the java class to be executed to assign work to user.
Use the Web Service task to call a Rest API or a Soap Service.
Web Service task is used to call external web services using Rest API or Soap Web Service.
Web Service Task Configuration panel have 4 tabs to define properties.
General Tab contains general information such as title, task id, description etc.
Used to configure and map the Business Object for input and output for the node.
Property
Mandatory
Default
Description
Web Service Type
Yes
SOAP
To choose the type of web service. There are 2 types as following: SOAP and REST.
The values for Setting are as follows.
SOAP
When SOAP is selected as Web Service Type, user must enter the information about calling the Soap Service in the SOAP panel.
Property
Mandatory
Default
Description
Source Type
Y
Url
User can choose to get WSDL definition from URL or File
use environment
N
Unchecked
If user chooses use environment checkbox, then system will display the list of environment variables for user to choose. User can set the WSDL URL in the environment variable setup screen and choose the variable in the configuration panel.
WSDL URL
Y, when SOAP using URL.
If user chooses Url as Source Type, WSDL URL is the URL to the WSDL File location. If user chooses use environment then select the environment variable corresponding to WSDL URL.
WSDL File
Y, SOAP using WSDL File
If user chooses File as Source Type, WSDL File for Web Service to be called.
XSD File
N
If user chooses File as Source Type, Subject of WSDL file.
Operation
Y
The operation is method to be called of that service.
End Point
Y
The endpoint is the URL where that service can be accessed by a client application.
Authentication
N
Authentication credentials for HTTP authentication.
Username
N
Username for Authentication. If user chooses use environment then select the environment variable corresponding to username.
Password
N
Password for Authentication. If user chooses use environment then select the environment variable corresponding to password.
SOAP panel has a "Choose WSDL" button to upload WSDL file or a "Choose XSD" button to upload XSD file. Once the user chooses a WSDL or XSD, user can click the Get Operation button to get all possible operations from the SOAP service. Get Endpoint button is to get End Point from SOAP Service.
REST
When REST is selected as the Web Service Type, user must enter information about calling the Rest API on REST panel.
Property
Mandatory
Default
Description
use environment
N
Unchecked
If user chooses use environment checkbox, then system will display the list of for user to choose. User can set the REST URL in the environment variable setup screen and choose the variable in the configuration panel.
REST URL
Y
URL for calling Rest API. If user chooses use environment then select the environment variable corresponding to REST URL.
Http Type
Y
Operations to HTTP requests.
Accept Header
Y
Type of text that the Rest API accepts.
Content Type
Y
A Content Type is a set of text response when calling Rest API.
Authentication
N
Authentication credentials for HTTP authentication. User can choose between Basic & IAM2
Username
N
If user chooses Authentication as Basic, Username for Authentication.
Password
N
If user chooses Authentication as Basic, Password for Authentication.
Header - Key
N
Additional header information key.If user chooses use environment then select the environment variable corresponding to KEY.
Header - Value
N
Additional header information value. If user chooses use environment then select the environment variable corresponding to Value.
Both SOAP and REST tabs contain an "Open Mapping Parameter" button. Clicking on "Open Mapping parameter" button redirects user to Mapping Parameter screen where user can click on Mapping Parameter Input line or Mapping Parameter Output line to map parameters for this Web Service task.
You can map the input parameter and output parameter of SOAP service using XPath mapping. Please refer below example of sample wsdl.
Now to map the xpath for each input parameter.
For field name "title" you have to create xpath for mapping parameter as follows.
Method 1:
Parameter Name : title
XPath : /Operation_in/book/title
Parameter Type : String
Method 2:
Parameter Name : title
XPath : //book/title
Parameter Type : String
Method 3:
Parameter Name : title
XPath : //title
Parameter Type : String
XPath Syntax expression
Expression
Description
nodename
Selects all nodes with the name “nodename“.
/
Selects from the root node.
//
Selects nodes in the document from the current node that match the selection no matter where they are.
.
Selects the current node.
..
Selects the parent of the current node.
@
Selects attributes.
nodename[index]
Selects the index of element.
Add Row button is used to add more header key value to the REST service. Trash icon on right side is to remove any existing header rows.
