Vizlib Home
Welcome
Login

Vizlib Writeback Table Properties - Destination Types

Vizlib Writeback Table needs to be connected to a Destination to perform any operations. This article explains how to configure destination types in the Vizlib Management Console (VMC) to make sure you have the data setup you want.  

The list of supported data output types is increasing all the time, you can find a summary in Table 1

Note: Vizlib Writeback Table is supported in Qlik Sense Cloud for REST destinations only. 


Table 1: Destinations and Supported Data Output Type

DestinationData Output Type

QVD/CSV/TXT - data written to a flat file.

QVD, CSV, TXT files. 

REST- data written to a REST API response.

All REST compliant APIs should be supported, including Google Sheets, Zapier, Pipedrive, Freshdesk. 

SQL, Oracle - data written to a database table.

Microsoft SQL Server, Microsoft AzureSQL, PostgreSQL, SQLite, MySQL, Oracle Native 


Coming Soon! - Generic ODBC


TABLE OF CONTENTS


Destination Types


Vizlib Writeback Table has 3 destination types (Figure 1) which you can find in the Writeback Settings tab in the property panel. If you'd like to read more about Writeback Settings in the property panel, please see our article on Destination settings here and Audit Columns, Table Settings and Reload settings here.


Figure 1: Destination Types


In the VMC, destination settings are held in the Writeback Settings menu on the Destinations and Security page. They are ordered into 4 sections. Figure 2 shows a QVD-CSV-TXT destination type as an example. 

  • Writeback Settings - destination type settings.
  • Destination Settings  - data source settings. 
  • Fields Validation - validation table fields in the destination data source. 
  • Access and Security - security settings handling access to the destination. 


Figure 2: VMC Destinations and Security

Note: Learn more about VMC functions by clicking .


Writeback Settings 


Each destination type has its own specific Writeback Settings panel, which you display by choosing an option from the Destination Type dropdown. 

Note on Locking: By default, an auto-lock is triggered when a writeback operation is performed on a destination, and stays in place until the operation completes. You can enable the Allow Locking setting in Access and Security if you'd like to extend the locking function. 


QVD/CSV/TXT

The QVD/CSV/TXT destination type lets you select from the options shown in Figure 3

  • Operation - the available options are Insert, Update, Delete and Overwrite. For more information on Writeback operations please see our article here
  • Reload Options - choose from No Reload, Reload App, Partial Reload App and Reload Task. You can find more information on reload Writeback settings in our our article here. Reload Task is configured in the Qlik Management Console, you can find more information here
  • App - add the app connected to the destination type. 


Figure 3: QVD/CSV/TXT Writeback Settings


REST

The REST destination type displays the options shown in Figure 4

  • Reload Options - choose from No Reload, Reload App, Partial Reload App and Reload Task. You can find more information on reload Writeback settings in our our article here. Reload Task is configured in the Qlik Management Console, you can find more information here
  • App - add the app connected to the destination type. 


Figure 4: REST Writeback Settings 


SQL

The SQL destination type displays the options shown in Figure 5

  • Operation - the available options are Insert, Update, and Delete. For more information on Writeback operations please see our article here
  • Reload Options - choose from No Reload, Reload App, Partial Reload App and Reload Task. You can find more information on reload settings in our article here. You can find more information on reload Writeback settings in our our article here. Reload Task is configured in the Qlik Management Console, you can find more information here
  • App - add the app connected to the destination type. 


Figure 5: SQL Writeback Settings

Note: The SQL destination type can only be currently connected to a single app. 


Oracle

The Oracle destination type displays the options shown in Figure 6

  • Operation - the available options are Insert, Update, and Delete. For more information on Writeback operations please see our article here
  • Reload Options - choose from No Reload, Reload App, Partial Reload App and Reload Task. You can find more information on reload settings in our article here. You can find more information on reload Writeback settings in our our article here. Reload Task is configured in the Qlik Management Console, you can find more information here
  • App - add the app connected to the destination type. 


Figure 6: Oracle Writeback Settings

Note: The Oracle destination type can only be currently connected to a single app. 


Destination Settings 


Each destination type has its own specific Destination Settings panel, which holds settings related to the data source the destination uses. 


QVD/CSV/TXT

The QVD/CSV/TXT Destination Settings are shown in Figure 7

  • Data Source - enter the name of the data output type you'd like to use. 
  • File Type - the available options are qvd, csv and txt. 
  • Path (Optional) - enter the directory path for the file.
  • File Name - enter the file name. 


Note: You can use tags to create a dynamic file name and path. 


Figure 7: QVD/CSV/TXT Destination Settings


REST

The REST Destination Settings are shown in Figure 8.

  • REST Integration - select the integration option you want. Note: REST integration settings are defined in the VMC on the Integrations page of System Settings. You can edit or add REST settings on that page if you need to. 
  • Path - enter the path for the REST endpoint. This is an optional field where you can define a directory which is added to the REST integration URL defined in the VMC (see above). 
  • Method - the available options are GET, POST, PUT and PATCH. 
  • Send all rows - when enabled this will send all rows in the table with each request.


Figure 8: REST Destination Settings


The REST destination type has additional destination settings specific to APIs. 

  • Payload - for PUT, POST and PATCH methods, Payload sets the format for the message body (Figure 9) and can be sent as an array or in paginated format. 
  • Authentication - authentication checks your user credentials when a connection is attempted. The available options are None, Basic, Token, or Certificate. Note: Certificate option is only available for REST integrations. 
  • Add Param - add a parameter to send with the request.
  • Add Header - add a header to send with the request.


Figure 9: REST Payload


SQL 

The SQL Destination Settings are shown in Figure 10

  • DB Integration - select the database you want to use from the dropdown. Note: DB integration settings are defined in the VMC on the Integrations page of System Settings. You can edit or add database settings on that page if you need to. 
  • Table Name - enter the table name which will store the writeback data.
  • Allow Table Creation - enabling this option lets users create a table and copy it to the database. Important: As creating tables could change and disrupt the data model, this option should be activated only when it is seen as essential. 
  • Allow Column creation - enabling this option lets users create a column and copy it to the database. Empty cells are passed with a null value. 


Figure 10: SQL Destination Settings


Oracle

The Oracle Destination Settings are shown in Figure 11

  • DB Integration - select the database you want to use from the dropdown. Note: DB integration settings are defined in the VMC on the Integrations page of System Settings. You can edit or add database settings on that page if you need to. 
  • Table Name - enter the table name which will store the writeback data.
  • Allow Table Creation - enabling this option lets users create a table and copy it to the database. Important: As creating tables could change and disrupt the data model, this option should be activated only when it is seen as essential. 
  • Allow Column creation - enabling this option lets users create a column and copy it to the database. Empty cells are passed with a null value. 


Figure 11: SQL Destination Settings


Fields Validation


Fields Validation settings (Figure 12) are the same for each destination type, and apply validation conditions to the fields which make up the data source table. To enable the setting, slide the toggle to the right to turn it blue, and click on Add Field to create a new entry. 

  • Field Name - add the field name to be used for updating the table. An error will be returned if the writeback operation field does not match this value. 
  • Allow null - enable Allow null if you want to pass null values as part of a writeback operation. 

Note: These settings are particularly useful for QVD/CSV/TXT and REST destinations, as they don't have the SQL or Oracle destination functions Allow Table Creation and Allow Column Creation


Figure 12: Fields Validation


Access and Security


Access & Security settings (Figure 13) allows you to secure the destination connection, control the destination locking and audit trail and set user access levels. 


Figure 13: Access & Security


Check Secure Destination to enable the setting, which means users won't be granted access automatically. You'll need to set a security rule to manage levels of user access, and you can find out more about security rules in our article here 


Enabling Allow Locking means you can also lock the destination when you start to input data, and unlock the table when you have finished (in addition to the default auto-lock triggered when the writeback operation completes). When enabled, an icon appears in Vizlib Writeback Table

Audit Trail creates an audit trail for the destination held in the VMC on the Writeback Audit page, our VMC article contains instructions on using the audit trail here.


Example


Figure 14 shows you as SQL destination type being configured in the VMC. 


Figure 14: Example Destination Setup


Note on Data Connections: Data output types can be configured in the VMC when they have been added to your Qlik Sense Environment. To find out more about working with data connections in Qlik Sense please see the article here

Note on Data Load Scripts: You can configure data load settings in Qlik Sense using the app data load script. You can find out more about data load scripts in Qlik Sense in the article here.

K
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.