Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Use exclusive gateways to direct your process flows to one or more paths based on condition.
Gateway Nodes are used to branch a process flow based on conditions and is represented with a diamond shaped box.
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.
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 is only 1 Gateway available to choose for Microflow: Exclusive.
When link paths are created from Exclusive gateways, user must specify the condition on the links coming out of the Gateway Parameter panel.
Property
Mandatory
Default
Description
Name
N
User can give name to the link for easy reference. E.g. Approve, Reject etc.
Type
Y
Exclusive
To define the type of Gateway.
Description
N
To describe the gateway condition.
Condition button on Gateway Parameter Tab redirects user to the Formula Editor panel where user can write new conditions or can edit existing conditions.
Use the Sub Flow node to call another microflow.
The Sub Flow node is used to call other microflows from within the main flow. If there is a section of the main flow that can stand alone, it is good practice to implement it as a separate microflow. Now you can call this flow from the main flow using the Sub Flow node. This improves clarity and reusability.
Sub Flow 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 Flow
In Sub Flow tab, "Open Sub flow" button is used to open or edit the sub flow. "Open Mapping Parameter" button is used to map parameters to the sub flow. 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.
Property
Mandatory
Default
Description
Flow Name
Yes
Choose the flow that you want to use as a sub flow in your main flow.
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 microflow. To accomplish this user can create the Java method, export the Java class to a Jar file and then upload this Jar file to the Java Node Task for executing Java method during the flow. 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.
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.
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.
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.
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.
Properties of Task Activity
The first property of every activity node 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
Use the Database Task to execute database commands.
The Database Task is used to execute database commands. Most Microflows rely on some information from database to execute jobs or complete the flows. They may often require to Select, Insert, Update or Delete data from database, and pass such values to other nodes to complete the flow. Microflow 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.
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 flow to perform some action.
For Example, let's say a flow is calling an external web service, 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 system admin/ responsible person to check on the service.
Timer Configuration panel has only one tab to define properties:
Timer
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 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
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
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.
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
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
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.
Property
Mandatory
Default
Description
Exception
Yes
The type of exception to be handled.
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.
Notation
Notation name
Notation Definition
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.
Web Service Task
Web Service Task is used to call the SOAP Web service or REST API.
Sub Flow Task
Sub Flow Task is used to call another flow in the same project.
Push Notification
Push Notification Task is used to send notification to mobile application.
Notation
Notation name
Notation Definition
Exclusive
Exclusive Gateway is used to create alternative paths within the flow, 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.
Notation
Notation name
Notation Definition
Start event
Start Event is used to start the flow.
End event
End Event is used to indicate end of the flow.
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.
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 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.
