In this article, we will walkthough the thought process on designing a solution for the following business use case:-
- Visitor would request for demo by submitting a form in the Joget app.
- Upon submission of the form, fields will be validated to make sure that all mandatory fields are filled up.
Upon successful validation of data, the form data will be shared with external system (i.e. CRM software) for further processing through the use plugins (i.e. JSON Tool) or Bean Shell code. More on this later on.
- The main objective is to ensure successful delivery of data with the external system.
This is an example on how the form would look like.
The only external factor that may be outside of the Joget platform's control would be the external integration with the CRM software. We will walkthrough a few scenarios on how best to design for this business use case with UI/UX kept in mind.
We will design the app and discuss where best to invoke the external API.
Preparing the Form and Userview
- We will start with desiging the form itself. The form itself is quite simple, with just 3 fields and all of them made mandatroy.
- In the userview, we are making use of the Form Menu and link it to the form we have just designed.
Configure "Action to Perform After Form Saved" to redirect to a "HTML Page" to show form submitted message (e.g. Form submitted. Thank you!).
- Do not forget to create a CRUD menu too so that we can browse through all the submissions easily using Generate CRUD.
- At this point of time, there's no integration yet with the external CRM.
What Happens on Form Submission?
When end user hits on the Submit button, the following will take place.
- Form Validation - Joget would iterate through each and every form element and invoking the validator (if configured).
If all validations pass, then it will move to the next step, else, end user will be redirected back to the same form with validation errors displayed like what is shown in the screenshot below.
- Form Store - Since validations have passed, Joget will now proceed to the next step, form data will be passed to the store binder.
By default, the load/store binder is Workflow Form Binder where it will load and store form data into the table name declared in the form properties. In this case, the table name is "demo_request".
- Since we are using Workflow Form Binder, this would also mean that we are saving the form data locally in Joget's database.
With what we have learned so far, this can be presented using the following diagram.
Invoke Restful API Call
There are many ways to do it. Here's a list.
Method 1 - JSON Tool
The easiest, no-code approach is to make use of JSON Tool plugin itself. The JSON Tool itself is a Process Tool & Post Form Submission Processing Plugin. This means that we can invoke it from within a process flow or from submission of form.
Method 2 - Bean Shell Code
We can also write Bean Shell code. Here's a quick sample code to make http get call.
We can execute this piece of code from various plugin types giving us the flexibility on where/when we want to invoke it. The only disadvantage compared to the former is that we need to maintain the custom coding ourselves instead of configuring through a plugin. These are the plugin types relevant to our solution to call the code from:-
Method 3 - JSON Tool from Bean Shell Code
We can only combine the both methods together by triggering the JSON process tool plugin in a beanshell code too. Here's a quick sample code written to be used in Bean Shell for Process Tool. Note that each plugin type would inject different variables for the Bean Shell code to consume.
Possible Integration Points to Invoke Restful API Call
Method 1 - Post Form Submission Processing and JSON Tool
By using Post Form Submission Processing in Form, and "Method 1 JSON Call" earlier, this is the easiest and quickest method. This allows us to invoke any Process Tool & Post Form Submission Processing Plugin. JSON Tool is one such candidate.
- Upon form submission, form fields will be validated, with its form data stored, then, the "Post Form Submission Processing" will be triggered.
- Response time of form submission will now include complete execution of the JSON Tool.
- Imagine that the external JSON API takes longer than expected to respond, the end user will be kept waiting.
Depending on the feature of the API call, we would assume that it would return a response to indicate successful execution. For example:-
- By using this integration point, there's no way to redirect the user to other place/menu when error occurs.
This is to sum things up so far.
Read on to see how we can improve.
Method 2 - Post Form Submission Processing and JSON Tool with Multi Tools
To avoid the waiting time for JSON Tool to finish executing, we can place it under Multi Tools instead.
Set the "Run Mode" such that it would execute the process tool (JSON Tool) in a new thread.
Method 3 - Workflow Process with JSON Tool
With what we have learned so far, there's still 1 con that we are trying to solve. Let's try to put the form within a process flow in a diagram as below.
By using a process flow, we can check the content of the returned JSON call to see if it matches the intended content. For example, we are expecting this reply and have it mapped to a workflow variable.
By doing so, we would be able to redirect back to the same form again and prompting the end user to submit the form again. The potential customer (end user) may not be able to complete the submission process when the external API is not reliable and sees the same form repetitively. This would lead to confusing UI presentation and frustrating user experience.
As this design expects a "true/false" response from the JSON Tool itself, when the external API service is unresponsive, it may not even return anything at all and we will need to wait for it to time out by itself (i.e. 60 seconds).
Method 4 - Form Validator and Form Store Binder
Triggering the JSON call from these 2 plugin types are not feasible but we will explain as part of knowledge sharing.
As the JSON Tool plugin is not a form validator nor form store binder type of plugin, we will need to use the workaround shared earlier, which is writing the bean shell code from scratch or calling the JSON Tool plugin programmatically.
Form Validator Plugin expects a true/false to be returned. We may try to avoid the need of designing a process flow and achieve the same JSON result checking by making the JSON call through the validator plugin. The problem that would arise from this appraoch are:-
- Same form content may get submitted repetitively as other form fields' validators may kick in too (i.e. mandatory field checking). This results in many JSON calls which in most cases, not the behavior desired.
- If the external API system becomes unresponsive, the Joget app will stop working.
- Increased wait time. Response time includes JSON Tool's turnaround time.
Form Store Binder
To avoid calling the API repetitively, let's move down to the next layer, store binder.
By calling the JSON API within the Form Store Binder Plugin, we will need to explore on how to handle events such as when JSON API is not being responsive. In this type of plugin, it won't be expecting a true/false to be returned like the validator plugin though.
We can try to throw an exception instead in the Bean Shell code that we are writing.
This approach suffers from the following issues:-
- If the external API system becomes unresponsive, the Joget app will stop working. If the intent is not to let user proceed until the JSON call is successful, then this is a viable choice to consider.
- Error message is not friendly. This is because the code written is wrapped within the Bean Shell plugin itself and the exception message from the code does not propagate to the form UI. To mitigate/improve on this, we will need to develop a custom store binder itself.
- Increased wait time. Response time includes JSON Tool's turnaround time.
Method 5 - Post Form Submission Processing and JSON Tool with Multi Tools and Follow-Up on Failed API Calls
How can we ensure that form submission captured, without the need for potential customer to wait for the JSON call to be completed and to continue to receive form submissions when the external API is not reachable at the point of form submisison?
Without reinventing the wheel, we extend the capabilities of the current JSON Tool to capture the response's status code and store it into workflow variable and/or form data. You can find the plugin here.
Taking cues from method 2 earlier, we will put the new plugin in Multi Tools and set the Run Mode to "Run tools sequentially in a new single thread". This is so that customer does not need to wait for JSON call to complete.
The following is a new section to configure to capture the JSON call's response status.
We created a new form to capture the JSON call log.
In this screenshot below, we are able to inspect each of the form submission made (left) and the result of the API call (right).
In the highlighted row, we can see that the API call failed with response status code of 524.
And in this screenshot below, there are 2 log records created. The JSON call is successful but the data response triggerred a casting exception.
With the log data on hand, we can then create a scheduled tasks that picked up unsuccessful API calls and attempt to trigger them again later on by using the following SQL (MySQL).
This is how the list would look like in the screenshot below. Each of the request row submitted will show the latest log.
Since we are storing the exact form data into Joget's database, we can try to make the same JSON call again later on.
For example, we can make use of Form Update Process Tool Datalist Action and map to the JSON Tool.
Once it is tested working, we can consider to automate it and set up a scheduler job - iterate through the same list and execute JSON Tool using Iterator Process Tool.