Forms Manager is a LLodi module that allows you to create forms, define the workflow you will trigger from Qlik and the visual aspect of your extension, among other things.
To make easier comprehend what you can do with Forms Manager, we are gonna check some useful concepts:
Forms: You create them in the Forms Manager. In the form, you will define how to “paint” the extension in your dashboard (number and type of fields) and what do you want to do with the data provided by the user (how to handle it and where send the payload).
GUID: 'Globally Unique Identifier', this number helps you to tell the extension which form has to paint.
LLodi Fields: With this special fields you can define where the field will obtain the data from. Use Qlik formulas to get the right data in your extension and combine the data from Qlik with the logic from LLodi.
Our LLodi forms allow you to create workflows that adapt to the needs of your business and to take actions directly from your BI application.
When defining your forms you will choose how the extension will look like in the dashboard, the fields that will be sent, where will you send it and a bunch of advanced options.
Before creating a new form, you must define your workflow.
Depending on your desired workflow the fields, appearance of the JSON, headers, URL and security will change. It’s key to know this information before getting down to business, although you can change the form settings as many times as you want.
This LLodi App lets you register new workflows just by adding a name and URL (WebHook, endpoint) and choosing a form type. You can also fill a description for the form or add tags to manage your forms easily.
Once you register a new form, you will be guided to the page to create/edit your LLodi Fields, in the option “Show form fields”.
At first, the URL field can be empty, but to make your workflow work it will be mandatory to enter the WebHook address or the endpoint.
See More: Step by Step: Create a Form
In this menu, you can define the settings of your form. In addition to name, description and tags you will find:
The different types available just make easier the integration with different integration tools or services, making your form meet the conditions about headers, fields or authentication required by the tool used. The custom type works universally letting you choose all the parameters.
This is the endpoint for your request, you can find it in the API documentation. If you use an integration tool they will provide it to you. You can create dynamic URLs using Dynamic request fields (the value of that field is defined in a LLodi Field in the platform).
Send as array: The final endpoint will receive an array with a number of objects equal to the number of values of the field selected to act as array filter.
HTTP Method: Get, post, put, delete and patch are available. Know more
Custom HTTP headers: Here you can add headers to your request. You can write the value or use a dynamic field to get the data from Qlik.
LLodi Forms has a flexible design that let you create a myriad of solutions, there are different types of fields that let you adapt the appearance of the extension to your needs.
You can combine simple and multiline forms, but table type cannot be combined with the previous types.
The field types available are:
Text: One line box to enter text. All the data entered is defined as text.
Text Area: Multiline box to enter text.
Select: Provides a menu of options, you can only select one option.
Multiselect: It is a select field where you can choose more than one option.
Checkbox: permits the user to make a binary choice. Is false by default, is activated when ticked.
Read Only: This field only shows the user the value of the field but does not allow the user to modify its value manually. Usually this field get the value directly from the data model and is showed to make it easier for the user.
Hidden: This field is not showed in the extension. This kind of field is really useful when you need some data to do your action, but you do not want the user to enter it or even know it. This provides an advanced environment for customization and complexity for consultants and, yet, a visual and user friendly appearance for the end user.
Screenshot: Save a screenshot as a base64 string.
HTML: This field adds an HTML block to your extension. You can use it to add spaces or titles.
There are different ways to populate this fields: you can add a value directly in the value field, you can use the LLodi Fields to use a Qlik formula and get the value from your data model and you can enter manually the value.
To populate Select and multiselect fields you can use actions that allow you to parse a string separated by commas (in the data model or the field value) or a Qlik formula in the app.
This feature allows you to send a test request to the endpoint. You will have to fill all the fields manually
This advance feature allows you to modify the output JSON to fit the documentation API requirements.
You can build the JSON doing “Drag & Drop” with the blocks in the left side of the screen or you can copy the structure of a JSON using the Copy button.
When the advanced JSON is modified it is directly enabled.
Using the placeholder feature you can help the user to know how to fill the values of the fields.
You can set a condition in Qlik using a LLodi Field, if the condition is met this field will be hidden or required. You can use this feature to show a field only if some conditions are met, for example depending on the user or the selections different fields will be shown.
You can define a LLodi Field as a Dynamic Field. This field will get its value directly from Qlik.
You can use Dynamic Fields in “Form URL” and as a value for a header. This allows you to change the endpoint (and therefore the action) or the headers or your request dynamically depending on values on your data model.
You can find this fields (highlighted in green) in the dropdown in the right of the form URL or in Header's value options.
Protocol: If you have added a certificate, HTTPS, otherwise HTTP.
Address: localhost or the address to the server where you installed it.
Port: . If you are making a remote call, make sure the port is open in your firewall.