Vizlib Home

Vizlib Writeback Table Settings - Destination

Vizlib Writeback Table has a Writeback Settings menu, making changes to your writeback configuration quick and easy to manage. These settings are found in the right hand panel of the Writeback Table Editor (Figure 1), below the Columns menu.

Figure 1: Writeback Settings

There are 4 sections for Writeback settings.

  • Destination contains configuration settings for writeback data output and writeback operations.
  • Audit Trail contains settings to customise an audit trail.
  • Table Settings manages the formatting of the output table.
  • Reload settings configure when writeback operations are performed. 

In this article we're going to focus on the properties for the Destination section. If you need further information on Audit Trail, Table Settings 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 2)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 2: Pick Destination

Clicking on one of these icons will display a related list of settings.

Folder Settings

  • Click the QVD/CSV/TXT icon (Figure 3).
  • 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.
  • 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.

Figure 3: Folder Settings

If you're working with an output file, you can also configure the writeback Operation type (Figure 4). The operations are 

  • Insert - New values inserted with every writeback.
  • Update - New values inserted with every writeback, existing data unchanged.
  • Delete - Existing values deleted with every writeback.
  • Overwrite - Existing values overwritten with every writeback. 

, You can find out more about operations in our article here

  • Select the operation type you need to use. If you choose an Insert operation, you'll also need to define the insert state. 

Figure 4: Operation Type 

REST Settings

  • Click the REST icon (Figure 5). 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 5: REST Settings 1

  • Choose the Payload (Figure 6) 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 send 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 6: Rest Settings 2

  • Click on Add Param (Figure 7) to add any additional parameters, entering values or using the expression editor. 

Figure 7: Add Parameters

  • Click on Add Header (Figure 8) to add a header, entering values or using the expression editor. 

Figure 8: Add Header

Server Settings

  • Select a Writeback Destination from the dropdown (Figure 9) to confirm where data should be saved. 
  • Destination paths can be broken down into parts with a structure 

Destination|Database Type|Table Name

an example would be writeback|SQL|test

Note: This path is only valid for SQL destination types. 

Figure 9: Server Settings

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. You should be able to install and configure Vizlib Writeback table using those settings. 

  • Enable the Override Server URL setting if you need to specify where Vizlib Server is installed (Figure 10). 
  • Enter the server URL and Port
  • Check Use server hostname if your server is hosted locally

Figure 10: Server Override

Related Articles

You can find a list of related articles in the Vizlib Writeback Table Overview

Writeback Operations - You can find more information on Writeback Operations in the article here  

Kenneth is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.