Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
As mentioned above, Create Blank Project can be used to create only project Skeleton. User should take this approach to create and build process flow when either Business objects or Work parties are not yet defined or stated. This approach may also be used when user wants to begin with only process flow diagram and have yet to decide to add other important process components.
Note: Create Blank Project is a not a step by step guide for user to create a Business Process. User can build partial process components with Create Blank Project. So, it is always a good practice for new users to use "Create Project Wizard" to create your business processes, if user already has all 3 important components - Business Object (BO), Work parties/User Roles and Process diagram.
In this section we will learn how to create a process from scratch. From version 4.0.19.10 and higher user can create an Application only from AppSpace. User can then create a Process inside the Application. Once the process is created, AppSpace will redirect you to Process Designer to design the process.
In this section we will show how to Create the App and create a process in the App and also how to deploy this process to a real environment.
Process is a group of activities that interact to accomplish a specific goal.
In ONEWEB we have Process Designer (PD) which is based on BPMN notations to design & implement business processes. It is used for representing and configuring Business Process by using the graphical interface and is designed in such a way as to easily configure the business process using a drag and drop user interface.
User can still choose to create an application directly within Process Designer. This feature may be deprecated in future. There are 2 ways to create your application within Process Designer.
Create Blank Application - It creates only the application and process skeleton. The user can create additional information as and when needed.
Create Application Wizard - This is a wizard-based creation. It guides the user to create the application, the process and the information used in the process flow.
Create Application Wizard has 5 steps for creating the process.
Application Name step. User can enter application name and description. Once user enters the value and click Next button, system will direct to the next step.
Property
Mandatory
Default
Description
Application Name
Y
Name of Application.
Application ID
Y
System generated.
ID of Application.
Description
N
Description of Application.
Define Business Object step. User can create the input and output parameters of the process.
User can add further details to the BO by clicking on the Add Parameter icon on the BO and add the parameters inside the BO.
After creating business object, user can click Next button to go to next step or click on Previous button to go to previous step.
NOTE: At any step during the wizard, user can click on the Save Wizard button at the top to save the steps and come back to create the rest of the steps later by clicking on View All Wizard menu.
Create Work Party step. User can define the Work Party to be used in the process. This step has Add button to add a row of Work Party and Remove button to remove Work Party. After entering the value for Work Party, user can move to the next step.
Property
Mandatory
Default
Description
Work Party Name
Y
Name of Work Party.
Type
Y
User Role
Type of Work Party, there is only 1 type as of now: User Role.
Work Party Lead
N
Lead of Work Party.
Create User/ Member step. User can create the members of Work Party. This step has Add button to add a row of member, Lookup existing member button can be used to select existing member from the system and Remove button to remove a member.
Property
Mandatory
Default
Description
Member ID
Y
ID of member.
Member Name
Y
Name of member.
Member Type
Y
USER
Type of member, there 2 types as following: USER and ROLE.
Work Party
Y
Work Party of member.
Create Process step is last step for creating an application. This step has an Activity property to create the Human Task in the flow, Work party Responsible property to select Work Party of that Human Task and a Description property to create description of that the Human Task. There is an Add button to add more Human Task to the process. After entering the values, user can click Finish button to start creating your process template diagram.
Property
Mandatory
Default
Description
Process Name
Y
Name of the process.
Process Type
Y
Private
Type of the process, there 2 types as following: Private and Shareable.
Activity
N
Name of the Human Task.
Wok party Responsible
N
Name of Work Party.
Description
N
Description of the Human Task.
The system will now display the Create Flow page for creating the Process Template Diagram. The system will automatically generate a process stub depending on the information in the Create Process step. User can also choose not to give the Activity, Work party Responsible and Description information in the Process step and start with an empty process diagram.
User can choose from an existing BO in the system by clicking on Add existing business object icon or user can create a new BO by clicking on the Add parameter icon . Enter the details for the new BO on the Parameter dialog
To create an application on AppSpace first login to AppSpace and click on the Create new app button.
When creating an application, user can create it as a Web Application or a Mobile App. Choose the right platform for your application and enter the details.
Click on Start Develop button to start creating components in your application. System will redirect user to the components page.
Click on Create Process icon.
On the Create Process dialog, enter the process details. User can click on Create button to simply create an empty process and can choose to start designing later. Alternately, user can click on Start Design button to create the process and to start designing now itself.
If user clicks on the Start Design button, system will create process and redirect user to the Page Designer. The system will now display the Create Flow page for creating the Process Template Diagram.
If the user can is creating an application for the first time, the user will be redirected to a wizard.
Define Business Object step. User can create the input and output parameters of the process.
User can add further details to the BO by clicking on the Add Parameter icon on the BO and add the parameters inside the BO.
After creating business object, user can click Next button to go to next step or click on Previous button to go to previous step.
NOTE: At any step during the wizard, user can click on the Save Wizard button at the top to save the steps and come back to create the rest of the steps later by clicking on View All Wizard menu.
Create Work Party step. User can define the Work Party to be used in the process. This step has Add button to add a row of Work Party and Remove button to remove Work Party. After entering the value for Work Party, user can move to the next step.
Property
Mandatory
Default
Description
Work Party Name
Y
Name of Work Party.
Type
Y
User Role
Type of Work Party, there is only 1 type as of now: User Role.
Work Party Lead
N
Lead of Work Party.
Create User/ Member step. User can create the members of Work Party. This step has Add button to add a row of member, Lookup existing member button can be used to select existing member from the system and Remove button to remove a member.
Property
Mandatory
Default
Description
Member ID
Y
ID of member.
Member Name
Y
Name of member.
Member Type
Y
USER
Type of member, there 2 types as following: USER and ROLE.
Work Party
Y
Work Party of member.
Create Process step is last step for creating an application. The system will now display the Create Flow page for creating the Process Template Diagram.
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.
Process Template Diagram is used to draw and implement the business process based on simple drag and drop GUI. Process Template Diagram uses BPMN Notations to depict the business activities. This can help in interpretation and collaboration, either with an internal team or between business and technical users. The Process Template Diagram is divided into 3 panel as shown in picture below.
The details of each panel are described below.
Node task panel
This panel contains the process activity or node task notations. Each node task is suitable for a particular business objective. For example, Human node is suitable for task that is related to work party Assignments. The details of the node tasks are described in Activity Nodes section.
Diagram panel
This panel is used to draw the business process by dragging the notation from a node task panel and drop into diagram panel. Furthermore, on the diagram panel the user can also use the right click mouse button on any specific node to open node configuration, add boundary events or delete node as required.
The Action panel
This panel contains the command icons. Each icon has one command associated with it as given below.
Notation
Notation name
Action
Undo
To undo the last action.
Redo
To restore the previous action.
Delete
To delete the selected object.
Cut
To cut the selected object.
Copy
To copy the selected object.
Paste
To paste the object that is cut or copied.
Zoom In
To increase the diagram size.
Zoom Out
To decrease the diagram size.
Create Process Template Diagram Guideline
Process Template Diagram can be created by dragging each item from Node task panel to the diagram panel. User can double click on each node task to configure the data needed for execution. Shown below is an example to create a sample flow.
First, user must drag a Horizontal lane and drop to the diagram panel.
2. To start the flow user must drag the Start event and End event. Let's say for our example we need the Exclusive gateway, Human task and Database task as well. Drag these node tasks to the diagram panel.
Note: For more information on Horizontal Lane. Please refer section Pool/ Lane.
3. Now the user must create the links between the node tasks. Move the mouse over at the source node task, click on any one of the circle ports that are highlighted and drag the port to the target node task and create the links as given below in the process design.
4. Double click on Database Tasks to change name to "Get User Information from DB" and "Save User Status to DB" as shown in the diagram below. Change name of Human Task to "Approve Inbox". Change name of Exclusive to be "Check Approve".
User can double click on the link out of gateway to set the values. Double click on link out of Exclusive gateway and change name to "Approve". Change the other lane to "Reject". For Gateways, user can configure condition at the Gateway tab. To modify the condition of link, click on the Condition button.
5. Configure the business object on each the node task,
Double click on node task to show Configuration Panel and open the Business Object tab.
Click to check both Input and Output checkbox to set input parameter and out parameter of that node task.
Click Open Mapping Parameter button, the mapping parameter page is shown for mapping input parameter and output parameter of the process to the node task.
Click the line between Input box and Mapping box.
Click on the Object in Process Input Parameter on the left hand side and drag into the text containing in Activity Parameter on the right hand side. Note: If Input and Output Parameters are same then system will automatically map from input to output. But user can change this mapping to suit his needs.
Click on line between Mapping box and Output box.
Click the text that containing in Activity Parameter on the left hand side and drag into the text in Process Input Parameter on the right hand side.
Note: Again system will automatically map from input to output. But user can change this mapping to suit his needs.
Click Done button on the top right hand side to save the changes and go back to the process diagram.
6. Configure the Database Parameter for Database node.
Double on Database node task to show the Configuration Panel and open third tab. Note: Before doing this step user must set input and output parameter in step 5.
Enter the data regarding the database parameters.E.g. Enter Connection Type as "JNDI", JNDI Name is "jdbc/application", Command Type is "Select" and Command
If the business object is configured as per Step 5 in the BusinessObject tab, user can click Open Mapping Parameter button on Database Parameter tab and map parameter to the database query following the same step 5.
7. Configure the Assignment Policy for Human Task.
Double click on Human task to show Configuration Panel and open Assignment Policy tab. Enter value of Setting is "Pull" and value of Work party Name is "Approver".
8. Configured the value of Load Entity of the Human Task.
Double click on node task to show Configuration Panel and open Load Entity tab. Enter value of Entity as "Leave Form" (This is the name of the entity from App Designer that will be used as the UI for the user to work on, when the human task is assigned to a user). Enter value of Key and Value as "LEAVE_ID" (Key of the entity from AD) and "${LeaveBO.leaveID}" (PD BusinessObject parameter) to map data from this process flow to entity which forms the UI.
9. Finally, when each item on the process diagram is completely configured, user can save the process, validate and deploy it to the target environment to be integrated with other systems. For more information on Save, Validate and Deploy please refer section Validate & Deploy
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:
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.
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:
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:
Note: User must click "Save Panel" to save all configuration changes.
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:
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.
If user chooses to click on Create. System will create the process and display the list of components to the user. User can later click on the edit icon to start working on the process.
User can choose from an existing BO in the system by clicking on Add existing business object icon or user can create a new BO by clicking on the Add parameter icon . Enter the details for the new BO on the Parameter dialog
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
More details for each Assignment policy method. Please refer Task Allocation & Queuing
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.
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.
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.
Property
Mandatory
Default
Description
Process Name
Yes
Name of process that you want to use as a sub process in your main process.
Note: This section is in Progress and will be covered in next version of ONEWEB manual.
Process Design inside Process template Diagram can consist of list of Activity Nodes, Start and End Events, Gateway conditions, Boundary events and lanes. The detail explanation of each Node in Activity Panel and its purposes are described below.
Generally, the "Start" event node task is used to start the process by triggering the event manually. However, Process Designer also provides other event triggers that can be used to automatically trigger another activity or event, those event triggers as explained in next section.
Event section contains Nodes that can be used to initiate and terminate the Process flow.
End node task is generally used to terminate or end your business process manually.
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 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.
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
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 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
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.
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.
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
Use the File Input Task to start a process based on information from a file. It is represented as rectangular shape box as shown below:
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. 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
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 gateways to direct your process flow into one or more paths. It is represented as Diamond Shaped Box as shown below:
Purpose
Gateway Nodes are used to branch a process flow based on conditions. There are 3 available gateway decision types on Process Designer - Exclusive, Parallel and Inclusive.
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.
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. For more details please refer .
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.
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.
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.
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.
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.
Inclusive gateway is also used to create the condition flows in your business process. Inclusive gateway is the type of gateway where the process will follow all the paths where the mentioned conditions are evaluated to be true. The link paths represented as arrows "->" are used to connect an Inclusive gateway to the other node tasks. User can set conditions on each link coming out from Inclusive gateways. The process will follow all link paths where condition passes.
Note: Inclusive gateway is similar to Exclusive gateway and the only difference between them is an Exclusive allows business process to follow just one single path while in inclusive gateway, user can direct process flow to more than one path based on condition evaluation.
Inclusive Gateway Properties are similar as Exclusive Gateways. Please refer Exclusive Gateway Configuration Properties for more details.
Parallel gateways are used to branch the process flow into one or more concurrent tasks in a business process. Unlike Exclusive Gateways which restrict process flow to follow only one path, Parallel gateway is the type of gateway where the process follows each connected link paths without executing any conditions.
Boundary Events on Process Template Diagram can be used as a Triggering Events. It consists of 2 types - Timer and Error
The first step to design any process inside process template diagram is to drag a Lane inside the Diagram panel. This section contains Horizontal lane to drag and drop.
With version 4.0.19.10 ONEWEB provides a very powerful feature to create custom activity nodes and use these custom nodes in your workflow or share with other users. These custom nodes are called extensions. These extensions can be a simple node to query your internal database, or a complicated proprietary node to connect to a block chain server as well. Users can create the extension once and then use it in every application by installing the extension to the application. Users can also share their extension with other ONEWEB users. Once the ONEWEB Market Place is up, users can even sell their extensions in the Market Place.
The following section explains how to build a workspace to create your extension, how to build the extension in your workspace and finally how to install the custom extension on an application to use it in the workflow.
Please Note: The same extension jar file can be used in both Process Designer as well as Microflow Designer.
Use Timer Events to determine the maximum time allowed for processing a task. It is represented as a small Timer watch icon as below.
Purpose
Timer events are used to specify the processing time limits for any Node 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 Properties
Timer Configuration panel has one tab to define property:
Timer
All Settings inside Timer tab are described as below:
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.
Note: User must click "Save Panel" to save all configuration changes.
Use Error Events to handle exceptions or errors in a process by doing some action. It is represented as an Icon shown below:
Purpose
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 Event can also be used as a boundary event to trigger another event. Error event can 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 be notified of exceptions occurring there.
Error Event Configuration Properties:
Error Configuration panel has one tab to define property.
Error
Setting inside Error Tab is described as below:
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, 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 eventTask.
Note: User must click "Save Panel" to save all configuration changes.
Exclusive gateway is used to create the condition flows in your business process. Exclusive gateway is type of gateway which is used to direct the process flow into alternate paths based on the condition evaluated to be true. The link paths, represented as arrows "->", are used to connect an Exclusive gateway to the other node tasks. User can set conditions on each link coming out from Exclusive gateways. The process will only follow the link path where the condition passes.
Gateway Configuration panel has two tabs to define property:
General Tab contains general information such as title, task id etc.
Property
Mandatory
Default
Description
When link paths are created from Exclusive or Inclusive gateways, user must also specify the condition information on each link. To do so, user can double click on each link coming out from an Exclusive gateway. The Gateway Parameter Panel will open as shown below:
All settings inside Gateway parameter are described below:
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
-
Shows the gateway condition designed to direct process flow. (Note: Click on Condition button to design condition)
Click on "Condition" button on Gateway Parameter tab to redirect user to the "Formula Editor" panel where user can write new condition statements or can customize any existing conditions. For more information on Formula Panel, please refer to section Formula Editor
Note: User must click "Save Panel" to save all configuration changes.
Copy and unzip the workspace downloaded from the Process Designer to a suitable folder. Use any Eclipse based IDE with maven installed to open the java project and create your implementation. There are three classes that needs to be implemented.
1. NodeExtentionExecute - Override the execute method to include the custom implementation.
2. InputModel - Define the input Business Object for your custom node.
3. OutputModel - Define the output Business Object for your custom node.
4. Supporting classes - You can create other supporting classes as you wish as in any regular java project. But do not change the name or package of the above three classes.
Once complete you can maven build your project to generate the jar file. When the Build is successful, the jar is generated in the target folder.
The business processes may include database nodes or web service nodes to interact with database or other services. But these database configurations and web service URLs may be different for different environments. For e.g. the JDBC URL for the dev database will be different from the value for the Test Environment and will again be different for production database.
So from version 4.0.0.19 ONEWEB provides option to configure the environment parameters as variables for the different environments. User can then use these variables while configuring the flow. This makes it easier to deploy the process to different environments without modifying the process diagram every time.
How to create Environment variables in Process
To set up environment parameters for an application, go to the environment setup screen inside the application. Click on the Add Environment icon.
You can create the different environments for your app here.
User can also create multiple profiles for each environment on the profile tab.
Finally, user can create the environment variables for each parameter
Then user can create them for other environments too
How to use these Environment variables in Process
You can use these variables in your node configurations. For e.g., in the database node configuration. For configurations which allow environment variables you can see a check box use environment. Use can select it to use value from environment configuration.
In the process flow the user might need to upload jar files for the Java node or WSDL files for the Webservice node. Instead of uploading the file at the nodes user can upload them to the application using the upload files facility and then select the required file at the nodes. This makes it easier to manage the files or update them without affecting the nodes.
To upload files to an application, go to the upload files menu and upload the required files.
Once the files are uploaded, user can choose these files from the Java node task or Web services node task and use them in the process flow.
In Process Designer we have a new Menu to deal with Extensions. Click on the Build Workspace menu under Extensions icon .
Enter the details for your extension
User can also design the look and feel of the custom node while creating the workspace. Drag and drop the custom icon to the 'Browse File' panel to create your custom node icon. And you can change the node background color by clicking on the Node color field. User can preview the look and feel of the nodes under the Node Extension heading.
User can also create the data need to be displayed on the Extension tab as a Json, by clicking on the SET button at Json Generate Form field.
User can also view the different sample configurations in the Example tab.
Once the configurations are entered, user can preview all the details under the Node Extension heading. Once everything is verified, user can click on Build Workspace button to build and download the workspace.The workspace will be downloaded to the user machine as a zip file.
The Work Party is used for assigning the job to a role or specific user when the process reaches a Human Task. One Work Party can be comprised of list of users or different role groups.
Process designer uses Work Party assignments to assign jobs, when the process flow reaches a human node task. A Work Party is like department and members are same as workers in that department. User can create different Work Party as well as members in each Work Party, and then user can bring that Work Party to create lanes in the process.
In Process Designer, user can specify different lanes to mark the activities owned by different sections. So, user must create lanes before dragging the nodes to develop a process. Each node in a process needs to belong to a specific lane. User must also set name of that lane. When any Lane has a Human Task, the Human Task by default will be assigned to the Work Party associated with that lane. User can also configure it to assign human node task to specific work party or specific user in another work party.
Property
Mandatory
Default
Description
Work Party Name
Y
Name of work party.
Work Party Type
Y
Type of work party, there is only one types as of now: User Role.
Work Party Lead
N
Lead of work party, user can set the supervisor or manager role for the work party using this field.
When a Work-Party is created, user must also set the Members for the Work Party.
Property
Mandatory
Default
Description
Member ID
Y
ID of member.
Member Name
Y
Name of member.
Member Type
Y
Type of member, there 2 types as following: USER and ROLE.
"Lookup exiting member" button can be found on both "Create Work Party" page and "Update Work Party" page, to choose user from existing user list.
There is also a Store to manage your extensions in an application. Open the Store Extension menu under the Extensions icon .
In the Store user can enable / disable the different extensions and also delete unwanted ones. Click on the Save button to save the changes to the application.
To install the extension go to the Extensions menu in Process Designer. Click on the Install Extension menu under Extensions icon .
On the Install Extension page, browse for the jar file you build from the workspace. Click on the Get Class Name button to retrieve the execution class name. Verify the other details retrieved too.
User can preview the input and output Business Object also by clicking on the View button. User can see the look and feel of the node also under the Node Extension Heading
Once verified everything, click on the Install Extension button to install the extension. User will get confirmation message to save the installation is successful.
Once an extension is enabled, it becomes available for the users to use under the Activity tab. Users can simply drag and drop the activity node to the canvas just like any other activity node and configure the properties.