Vizlib Input Form has a Writeback Settings menu, making changes to your writeback configuration quick and easy to manage.
TABLE OF CONTENTS
Writeback Settings are found in the property panel below the Input Fields menu. In this article we're going to focus on the properties for the Destination section. If you need further information on Load Script, Audit Columns and Reload, you can find a link to the article here.
Pick Destination
The first set of configuration settings in the Destination section relates to Pick Destination (Figure 1), where you choose if you'd like your writeback output to be written to a database table (Vizlib Server) data file (QVD/CSV/TXT), or a REST API response (REST).
Figure 1: Pick Destination
Clicking on one of these icons will display a related list of settings.
Folder Settings
Note: Before you start, make sure you have the correct Data Connection, File Type and File Name.
- Click the QVD/CSV/TXT icon (Figure 2).
- Scroll down to the Folder Settings options.
- Select the Data Connection.
- Click the
button to select a connection from the dropdown. - Click the
button to enter the connection name as an expression.
- Click the
- Select the File type by clicking on the extension name you want.
- Choose the File name.
- Click the button to select a file from the dropdown.
- Click the
button to enter the filename as an expression.
- Click the
Figure 2: Folder Settings
REST Settings
Note: Before you start, make sure you have the correct endpoint URL, Method, Payload and Authentication settings, and Params (Parameter) and Header details.
- Click the REST icon (Figure 3) and go to the REST Settings options.
- Select the endpoint URL for your output by clicking the
button to enter the URL. - Select the Method by clicking on POST, GET, PUT or PATCH.
Figure 3: REST Settings
- Choose the Payload (Figure 4) by clicking on JSON, Form or as Params.
- Choose to send the payload as an Array or a Record/Request.
- Choose the Pagination options. Selecting Custom will let you specify the number of records in each request.
- Choose an Authentication method from the dropdown (None, Basic, Token).
Note: If you choose GET you don't need to select a payload or specify how it is sent. The data will be sent as query parameters in the request. If you send multiple rows of data within a writeback operation, for GET, a separate request will be sent for each modified row.
Figure 4: Payload and Authentication
- Click on Add Param (Figure 5) to add any additional parameters, entering values or using the expression editor.
Figure 5: Add Parameters
- Click on Add Header (Figure 6) to add a header, entering values or using the expression editor.
Figure 6: Add Header
Server Settings
Note: Before you start, make sure you have the correct Destination name and Destination Path (Database type and Table name). You can currently use Server Settings to connect to SQL, BigQuery and Oracle Integrations.
- Select a Writeback Destination from the dropdown (Figure 7) to confirm where data should be saved.
- Destination paths can be broken down into parts with a structure
Destination|Database Type|Table Name
- Example SQL path - writeback|SQL|test
Figure 7: Server Settings
You can also select the Use Destination Expression checkbox and use a Qlik Sense expression to connect to your destination (Figure 8).
Figure 8: Use Destination Expression
Note: The Override Server URL settings do not need to be enabled if the extension URL is defined correctly in the VMC under on the Server Settings page of System Settings.
- Enable the Override Server URL setting if you need to specify where Vizlib Server is installed (Figure 9).
- Enter the server URL and Port.
- Check Use server hostname if your server is hosted locally.
Figure 9: Server Override
Variable Settings
Variable Settings (Figure 10) allow you to use variables with Vizlib Input Form, where input fields are used to set and change variable values.
Figure 10: Variable Settings
To change the value of a variable in the input field, you use a Trigger. There are 2 trigger settings (Figure 11).
- On Submit - variables in the form are updated when the Submit button is pressed.
- On Change - variables in the form are updated whenever a new value is entered in a field.
Figure 11: Trigger
You can also choose to include a Default Button Label which sets all the variables in the form to their original values.