Start

This feature works for simulation requests that will be received by the workflow.

Component of Workflow

Process flow in the 3Dolphins system, consists of eight (8) components of workflow, i.e :

1. Webhook
2. Execute Command
3. HTTP Request
4. MVEL Function
5. Execute Workflow
6. Timer Interval
7. Send Message
8. Send Email

MVEL Function

MVEL has largely been inspired by Java syntax, but has some fundamental differences aimed at making it more efficient as an expression language, such as operators that directly support collection, array and string matching, as well as regular expressions. MVEL is used to evaluate expressions written using Java syntax.

In addition to the expression language, MVEL serves as a templating language for configuration and string construction. To view example of MVEL expression language please refer to : http://mvel.documentnode.com/

Field component explanation :

MVEL Script Name	The node_id of the workflow component.
MVEL Script	This section for develop script from a series of process flow.
MVEL Output	Output from MVEL script.
Evaluate	To run the node.
Edit	To save the node.

MVEL Sript

For example, type the script to get information about a national calendar of all 2020 holidays, such as images below.

A detailed description of the script, can be seen in the table below :

Name	Description
Size	To get the number of public holiday objects from “response”: {     “holidays”: [ which is on the response of node ‘HttpHoliday‘.
import java.text.ParseException;	To Import class of java parse exception
import java.text.SimpleDateFormat;	To Import class of java simple date format
import java.util.Date;	To Import class of java simple date format date
import java.time.LocalDateTime;	To Import class of java local date time
SimpleDateFormat sdf = new SimpleDateFormat(“yyyy-MM-dd”);	To declare sdf variable as ‘simple date format’ with yyyy-MM-dd format
def getHoliday()	To declare a function (get holiday)
result = “”;	Declare a result variable with an empty value (“”).
Date now = new Date();	To declare a variable now as a date, the value is the variable date in the declaration.
for (int i=0;i<size;i++)	looping formula
Date date = sdf.parse(response.response.holidays[i].date.iso);	To declare a variable now as a date, the value is a public holiday date.
if (date.after(now) && response.response.holidays[i].date.iso.length < 12)	The formula for knowing whether the date of the public holiday is past from the date of the variable now in the declaration, and the ISO date must be under 12 letters.
result += response.response.holidays[i].date.iso + ” : ” + response.response.holidays[i].name +”\n”;	If the formula = true, will display response (date.iso and name of public holiday)
return result;	Returns the result of the getHoliday function
return getHoliday();	Return the result of the MVEL function has been made.

MVEL Output

Output from MVEL script (display information about a national calendar of all 2020 holidays).

Http Request

You can send requests in process flow to connect to APIs you are working with or integrating with a third-party API.

Http Header

If you have a request you want to run, you will need to know the method, URL and other optional key and values.

Field component explanation :

Http Request Name	The node_id in the workflow component.
Method	In currently, Method of HTTP Request is supported ‘GET’ and ‘POST’.
URL	The API you want to hit (the link you want to access). The URL is dynamic, URL can use parameters, depending on the variable to be displayed.
Key	Variable name (can use parameters that don’t have to be static).
Value	Value of the variable (can use parameters that don’t have to be static).
+ Http Header	Button to add header (keys and values).
Play	To execute the node_id that was made.
Add	To save the node_id in a workflow.

Request Methods

Currently, you can use the GET and POST method for retrieving data from an API in process flow.

Setting Request URLs

Each request you send in process flow requires a URL representing the API endpoint you are working with. Each operation you can perform using an API is typically associated with an endpoint. Each endpoint in an API is available at a particular URL, this is what you enter into process flow to access the API.

• If you’re building an API, the URL will typically be the base location plus path. For example :

Description of URL :

1. {URL}   : Used to pass information to the destination.
2. {Path}  : Location of data on the server.

• If you’re using a third-party API, your API provider will supply the URLs you need, for example within their developer documentation.
• You can optionally type query parameters into the URL field. Any word after the question mark (?) in a URL is considered to be a parameter which can hold values. The value for the corresponding parameter is given after the symbol “equals” (=). Multiple parameters can be passed through the URL by separating them with multiple “&”. For example :

• URL provides dynamic variables that you can use in your requests. Each variable name represents its key, so referencing the variable name allows you to access its value. The variable name typically taken from the previous process.

Consider the workflow example below.

In the image above (Images 9. Local Currency Workflow), we take the example of the ‘askCurrency’ process. This process is to provide a feedback response to requests sent.

This ${mvNow.response} variable is to contain the response of the ‘mvNow’ process. Or, you can add ${mvNow.response} using the response (output) from the ‘mvNow’ process, such as images below.

Consider the workflow example below.

In the image above (Images 10. Add Gitlab Issue Workflow), we take the example of the ‘addGitlabIssue’ process. This process is to provide a feedback response to requests sent, this response is in the form of an ‘title’ object whose value is ${response.title}. This ${response.title} variable is to contain the response title of the ‘transformIssue’ process.

The ${response.title} variable will not be able to process on ‘getChatlink’. Because, before the ‘getChatLink’ process there were 2 processes i.e ‘addGitlabIssue’ process and ‘getToken’, when you input the variable ${response.title} in ‘getChatlink’ the system will be confused to determine the title variable to be accommodated, whether the variable to be accommodated is a response from the ‘addGitlabIssue’ process or a response from the ‘getToken’ process.

Setting Request Header

Some APIs require you to send particular headers along with requests, typically to provide additional metadata about the operation you are performing. You can set these up in the Headers tables. Enter any key-value pairs you need and process flow will send them along with your request. Variables allow you to store and reuse values in your requests. Using variables increases your ability to work efficiently and minimizes the likelihood of error.

For example, to include a authorization in the request headers, you can set header in the request node id ‘getToken’, This request serves to retrieve the token variable from the API contained in the URL and will hold the variable as a response.

To get a token from the 3Dolphins application, a request body in the form of a 3Dolphins account is required. This 3Dolphins account functions as authentication on API Rest, so only 3Dolphins users can use the 3Dolphins API.

When the request is executed, then the response will be obtained in the form of an access token.

Consider the workflow example below.

In the image above (Images 15. Add Gitlab Issue Workflow), we take the example of the ‘getChatLink’ process. This process is to provide a feedback response to requests sent, this response is in the form of an ‘Authorization’ object whose value is ‘${getToken.response.token}’. This ‘${getToken.response.token}’ variable is to contain the response token of the ‘getToken’ process.

Http Body

The ‘http body’ tab in process flow allows you to specify the data you need to send with a request. You can send various different types of body data to suit your API.

If you’re sending body data, make sure you have the correct headers selected to indicate the content type your API may need to process the received data correctly. Typically you will use body data with POST requests. Consider the workflow example below.

In the image above (Images 17. Add Gitlab Issue Workflow), we take the example of the ‘getToken’ process. to get access token requires a request body such as 3Dolphins account. This 3Dolphins account functions as authentication on API Rest, so only 3Dolphins users can use the 3Dolphins API.

Http Response

Once your headers and other request details are set up, you can click Play to run your request and examine the Response received from the API server. If your request does not work as expected, check out some error. Consider the workflow example below.

In the image above (Images 18. Add Gitlab Issue Workflow), we take the example of the ‘addGitlabIssue’ process, to be able to add issues to gitlab, needed the destination URL (server API) and parameters will be sent to the gitlab. For example in the ‘addGitlabIssue’ process, the parameters that will be sent are title, description and label. When the ‘addGitlabIssue’ process is run, you will get a response (this response will be sent to gitlab) like in the picture below.

Webhook

Webhooks are user-defined HTTP callbacks. Webhooks allow you to build or set up integrations. They are usually triggered by some event, when that event occurs, the source app makes an HTTP request to the URI configured for the webhook.

A detailed description of the webhook setting can be seen in the table below :

Field	Description
Name	The node id of workflow component.
Webhook Path	Path of the webhook
White List	IP or hostname can access to the webhook (e.g 10.1***domain.com).
URL	This field will be filled automatically.
Response Expression	To simulate the results of the body.
Add	Button to add node id in workflow process.

Setting Webhook URLs

The URL on this webhook is the default and will be filled automatically when you create a workflow process and add webhook components.

Description of URLs :

• {URL}                   : Used to pass information to the destination.
• {Path}                  : Location of data on the server
• {workflow_id}      : ID that are automatically created when creating a workflow process.
• WF                      : Code from workflow process (default)
• {node_id}            : ID obtained from the field name. {webhook_path} : The keywords entered in the webhook path field (e.g whAddGitlabIssue).

Using Dynamic Variable in Response Expression

Consider the workflow example below.

In the image above (Images 21. Add Gitlab Issue Workflow), we take the example of the ‘whAddGitlabIssue’ process. This process is to provide a feedback response to requests sent, this response is in the form of an ‘issue_no’ object whose value is ${addGitlabIssue.response.id}. This ${addGitlabIssue.response.id} variable is to contain the response id of the ‘addGitlabIssue’ process.

To display the response of dialog, you can use the value of success using ${wf.success} variable. ${wf.success} variable serve to define workflow process is true or false. For example, if we set the value of success using $ {wf.success}, when the workflow process starts and in the middle of the process an error occurs, the value success will automatically define that the process is false.

A detailed description of the response expression can be seen in the table below :

Field Name	Description
Value	The value of output
Output	Response output from MVEL function
Success	To display the response of dialog. – If success : true, will display a success response. – If success : false, will display a fail response. – If success : ${wf.success}, to define workflow process is true or false.
Agent	– If Agent : True. A dialog will direct to agent, – if Agent : False. A dialog will direct to Bot,
Next	– If Next : True. will direct to next entity. – If Next : false. will not direct to next entity.
Repeat	To repeat of dialog.

Send Email

You can set up your custom workflow to send e-mail messages to other user. The available fields for an e-mail message are to, cc, subject, and message. These fields can contain both static text and text that is generated dynamically from workflow lookups.

Field component explanation :

Timer Interval

Timer interval enable you to control the workflow using a time condition. You can use timer interval for creating a delay before running an next process.

Field component explanation :

Interval name	The node_id in the workflow component.
Delay	Field for input how long the process is delay based on the time unit.
Time Unit (second/minutes/hours/days)	To choose time unit for the node id.

Send Message

For example, add workflow of reminder message.

To display the message reminder, an timer interval is needed. Timer interval enable you to control the workflow using a time condition. You can use timer interval for creating a delay before running an next proses. For example, set interval message to 5 second.

When the ‘reminder1Mins’ process finishes running according to the specified time interval, the process flow will automatically move to the next node_id which is ‘sendReminder’. ‘SendReminder’ functions to send a reminder message that will be sent to the customer.

Field component explanation :

Message Name	The node_id in the workflow component.
Link	link will automatically filled (example : domain.com/apiv1/graph/tickets/sendMessage)
Username	Username of user on the 3Dolphins system.
Password	Password of user on the 3Dolphins system.
Ticket Number	Retrieve the ticketNumber variable from the request body.
Channel Type	Select a channel to send message (Channel has been registered in the omnichannel)
Message ID	Message ID can be written freely (free text).
Reply Agent	If the message is sent by a bot, then write the agent reply as ‘Bot’, however if the message is sent by the agent, the agent reply is written as ‘Agent id’.
Message	Enter a custom message that will appear in the notification message that are sent on the channel selected.

In the image above (Images 26. Reminder Workflow – sendReminder), we take the example of the ‘${intent.ticket.ticketNumber}’ variable. This process is to provide a feedback response to requests sent, this response is in the form of an ‘Ticket Number’ object whose value is ‘${intent.ticket.ticketNumber}’. this ‘${intent.ticket.ticketNumber}’ variable serves to retrieve the ticketNumber variable from the request body.

For example : when a customer sends a message, the customer automatically sends a request (extension request) to the flow process. An example of this extension request can be seen in the image below.

In the extension request there is some data that may be needed by the developer, such as an account ID, ticket number, etc. For example, when retrieving the ticket number from the request extension, the method of writing is: $ {intent.ticket.ticketNumber}.

Setting Message URLs

The URL on this message is the default and will be filled automatically when you create a workflow process.

Description of URL :

• {URL}                    : Used to pass information to the destination.
• {Path}                   : Location of data on the server

Execute Command

execute command on the host.

Field component explanation :

Command Name	The node id, in the workflow component.
Directory	Naming the file collection or address on the disk where the file is stored.
Shell	Command translator program typed, in the prompt.

For Example :

In this case, we will execute the ‘testing.sh’ file in the ‘/opt’ directory, with a note that bash is an active shell.

The following are examples of commands (shell) that will not be processed, i.e :

1. ls
2. :(){:|:&};:
3. rm
4. /dev/
5. wget
6. mkfs
7. > 
8. ^foo^bar
9. dd
10. char
11. chmod
12. cp
13. mv
14. scp
15. passwd

These commands are in command.block

Execute Workflow

To run other workflows that are in the workflow list.

Connector Setting

To create rules before enter the node that will be executed.