Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Activity nodes are used to perform a specified task according to the functionality as defined below:
Human Task is used to assign the task to a user or roles group.
Java Task is used to execute any custom java functions from the uploaded java library.
Database Task is used to execute the SQL commands like SELECT, INSERT, UPDATE and DELETE.
File Read Task is used to read files. There are 4 file types supported - XML, Excel, Fixed width and Delimiter.
Web Service Task is used to call the SOAP Web service or REST API.
Sub Process Task is used to call another process in the same project.
File Write is used to write to a file. File types that are supported are similar as File read node task which is - XML, Excel, Fixed width and Delimiter.
Push Notification Task is used to send notification to mobile application.
Please proceed to next section for detailed explanation of each Activity Node.
Note: This section is in Progress and will be covered in next version of ONEWEB manual.
Use the Sub Process task to call another process. It is represented as rectangular shape box as shown below:
Purpose
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 Properties
Sub Process Node Configuration panel has 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.
Subprocess
All Settings in Subprocess Tab are shown below:
Property
Mandatory
Default
Description
Process Name
Yes
Name of process that you want to use as a sub process in your main process.
In Subprocess tab, "Open Subprocess" button is used to open or edit the sub process. "Open Mapping Parameter" button is used to set mapping parameter 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 SubProcess task.
Note: User must click "Save Panel" to save all configuration changes.
Use the Java Task to call custom java functions.
Purpose
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.
Properties
Java Node Configuration panel has 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.
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 the Human Task to assign a job to an individual human based on work-party, any defined user-role or any custom conditions. It is represented as rectangular shape box as shown below:
Purpose
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 is needed when you need a user to intervene in a process.
Human Node Properties:
Human Task configuration panel has 4 different tabs to define properties.
General
General Tab contains general information such as title name, task id, description etc.
All Settings in General Tab are shown below:
Property
Mandatory
Default
Description
Name
Y
Human
Default named as "Human". User can rename it according to work party or user roles. E.g.: Manager, Workparty Head etc.
ID
Y
System Generated
System Generated Unique Value.
Type
Y
humanTask
Shows the type of task.
Description
N
Desc
User can write here description of this task to state significance of Task.
Note: User must click "Save Panel" to save all configuration changes.
BusinessObject
To configure and map the Business Object for the input and output of any node, user must map the Activity Parameters inside Business Object tab. All mapped activity parameters are available for user to use inside Nodes. It is mandatory to set activity parameters in Business Object tab and map those parameters if user needs to use a value inside the activity.
Note: Activity Parameter mapping is not required if your process is not required to use a value within the activity or pass parameter values between nodes. For More details on Business Object, Process Parameters, Sub business objects and Data Parameter Mapping. Please refer section 6.4.3.4
Assignment Policy
To set the type of assignment policy that is to be used for the human task allocation.
Settings inside Assignment policy Tab are shown below:
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 and Custom.
More details for each Assignment policy method. Please refer Task Allocation & Queuing in section 6.4.3.3.1.1
Note: User must click "Save Panel" to save all configuration changes.
Load Entity:
Load entity settings are used to tag an existing Entity from ONEWEB Platform to your business process human node task. It also provides "Add Mapping Module" feature to add Module key and value for your mapping data. Delete/Trash icon on right side is used to remove any key value mapping.
All Settings in Load Entity Tab are shown below:
Property
Mandatory
Default
Description
Entity
Yes
-
The entity to be loaded from the To-do List when a user is assigned this task.
Key
No
-
The value on the entity to which data is passed.
Value
No
-
The value to be passed to that key.
Note: User must click "Save Panel" to save all configuration changes.
Use the Web Service task to call a Rest API or a Soap Service.
Purpose
Web Service task is used to call external web services using Rest API or Soap Web Service.
Web Service Node Configuration Properties:
Web Service Task Configuration panel have 4 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.
Web Service Parameter
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 environment variables 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.
Use the File Read task to get information from a file. It is represented as rectangular shape box as shown below:
Purpose
The File Read task is used to read information from file. When your process flow requires 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.
File Node Configuration Properties
Configurations property settings panel has 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.
File Read Parameter
All Settings in File Read Parameter Tab are shown below:
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 File Source.
File System
Select File System to read file from computer directory.
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 FIXWIDTH, XLS, DELIMITED or 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 as "on" or "off". If set to "on", then user must also enter information for Non Uniform Rows and Non Uniform Rows is set to "off" when a file has consistent width for all rows.
If Non Uniform Rows is on, user must enter information about Header (HR), Splitter (TR), Data (TD) and Footer (LR). It is used to support data when a file has an irregular row width.
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 has a text file with 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 the file to the set directory once reading success or error.
In FileRead Parameter tab, "Open Mapping Parameter" button is used to set mapping parameter of a File read node task. When click Open Mapping Parameter button, the system will redirect user to Mapping Parameter screen and the user can click Mapping Parameter Input line or Mapping Parameter Output line to mapping parameter for this File ReadTask
On Mapping Parameter screen:
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 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.
Note: User must click "Save Panel" to save all configuration changes.
Use the Push Notification task to send message to mobile application.
Purpose
Push Notification task is used to call push-notification hub to send message to mobile applications using Android or iOS platform.
Push Notification Node Configuration Properties
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
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.
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.
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.
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.
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 to be used.
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 logging in to the ftp host.
Password
Y
The password for logging in to the ftp host.
FTP Repository
Y
The path for keeping the ftp file as back 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 logging in to the ftps host.
Password
Y
The password for logging in to the ftps host.
FTP Repository
Y
The path for keeping the ftps file as back 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
To indicate if the file has varying widths
Property
Mandatory
Default
Description
Number of Header
Y
1
Number of field Header.
Field
Y
The value is the 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 TR 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
1
Footer starts with LR value.
Number of LR
Yes
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 as Delimiter.
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 the field used to determine 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 name for sorting.
ASC
N
Uncheck.
Type of sorting used. To get ascending order data check this field.
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
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.
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.
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.
Use the Database Task to execute database commands.
Purpose
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 Properties:
Database Node Configuration settings panel has 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.
Database Parameter
Property
Mandatory
Default
Description
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.
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.
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.
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.
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.
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.