Vizlib Home
Welcome
Login

Vizlib Writeback Table - Integration Setup - SQL

If you're using Vizlib Writeback Table with Vizlib Server, you'll need to set up and select an Integration to store your data and any changes you make. Integrations allow you to connect Vizlib products with your existing solutions (e.g. an email server or a database) to improve data sharing and collaboration. Integrations are configured in the Vizlib Management Console (VMC). 

Vizlib Writeback Table can integrate with different data sources, and we're going to use SQL in this example. You can find a full list of supported data sources here


TABLE OF CONTENTS


Before you Start - Checklist 


Before you add an integration, make sure you have all the information and permissions you need. Work through all the items in this list and then you'll be ready to start. 

  • Installations - Vizlib Writeback Table and Vizlib Server should be installed before you start. We have online tutorials for installing Vizlib Server and Vizlib Products to help you (Vizlib Products are all installed in the same way, so while the tutorial uses Vizlib Library, it can also be used for Vizlib Writeback Table). 

Note: If you haven't installed any Vizlib products before, please install the product (Vizlib Writeback Table) then install Vizlib Server. If you have already installed Vizlib Server, please perform a restart after installing Vizlib Writeback Table.  

  • VMC login / Password - to create and configure the integration, writeback destination and check the audit trail. The VMC is installed as part of Vizlib Server. 
  • Database name, password, host name, port number - to enter when you're adding the integration. 
  • Table name - to configure the destination type. 
  • App name - the app you want to connect to the destination type. 
  • Writeback Operation and Reload Option - to configure Writeback settings for the destination. 
  • Security Rule - to set up secure access for a destination, a security rule should be configured in the VMC. See our article here for more information on setting up a security rule. 


Adding an Integration


The first step to connecting is to add or configure an integration. 

  • Log in to the VMC. You should see the dashboard, with all your current integrations listed in the top left panel (Figure 1). Integrations which are configured correctly have a green tick beside them, while incorrect configurations return an error shown in red. 


Figure 1: VMC Dashboard Integrations, with Integrations and System Settings >Integrations highlighted. 


  • Go to System Settings, then click Integrations (see Figure 1) to open the Integrations homepage (Figure 2). 

Figure 2: Integrations Page


  • Click Add Integration to open the pop-up screen (Figure 3 and 4). 
  • Select sql as the Type, select a database Dialect for your connection (postgres in this example) and pick a unique Id. This will be displayed in Vizlib Writeback Table so keep that in mind when you're creating it, we've used test-integration here. 
  • In the SQL settings panel, there are 2 ways you can enter values.
    • Use the Database, Username, Password, Host and Port (Protocol is currently optional). 
    • Use a Connection URI.

Check: We've included both methods here, with a numbered reference to show you where the values should go, but you'll only need to use one. 


Figure 3: Add Integration


Figure 4: Add Integration


  • Click on Add Integration when you're finished, and click Restart to save your settings. You should see the new integration listed in the dashboard. 

Check: Your integration should display the green tick icon before going to the next step. If it's showing an error, follow the advice in the message (Figure 5). 


Figure 5: Integration Completed Successfully 


Adding a Destination


Now, you'll need to add a Destination, which is the data source for your Writeback table. 


Note on LockingWhen a writeback operation is performed on a destination configured in the VMC, an auto-lock is triggered until the operation completes. If you'd like to have more direct control of the locking feature you can enable the Allow Locking setting.  

  • In the VMC menu, click on Writeback Settings, then Destinations and Security. You should see the list of current destinations displayed on the page (Figure 6). 


Figure 6: Destinations


  • Click Add Destination and you'll create a new entry. Click on the destination ID to add your destination data (Figure 7, and 9). Your destination will already have an ID which is generated from the last entry in the table, but you'll be able to change this in the next step. 


Figure 7: Adding a Destination


Figure 8: Adding a Destination


  • Enter a  destination id, then go to the Writeback Settings panel and select SQL as the type. 

Check: Destination ID has to be a unique value, or you won't be allowed to save your changes. 


Now you can start to configure your destination. The Writeback Settings panel holds information about the level of functionality allowed in your Vizlib Writeback Table app. 


Figure 9: Writeback Settings


  • Select the writeback Operation (Insert, Update, and Delete). For more information on Writeback operations please see our article here
  • Choose one of the  Reload Options (No Reload, Reload App, Partial Reload App, Reload Task)

Check: Reloading the app means when data is written back to the destination it is immediately available to other users, so you'll probably have to pick an option which enables reload. You can find more information in our article here. Reload Task is set in the Qlik Management Console, you can find more information here

  • Add the writeback App you want to use. 
  • Enable Audit trail if you want to create an audit trail for the destination.

Note: You can access audit trails on the Writeback Audit page of the VMC, there are instructions on how to use it 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 (not just an auto-lock when the writeback operation completes). When enabled, an icon appears in Vizlib Writeback Table  


In the SQL Destination Settings panel (Figure 10), enter information about your data source.  


Figure 10: SQL Destination Settings


  • Choose the integration you created from the list in Pick DB Integration.
  • Enter the Table Name which will store your writeback data.
  • Enable Allow table creation if you want users to create a table and copy it to the database. 

Check: Creating tables could change and disrupt the data model, so you should only activate this option if you really need it. 

  • Enable Allow columns creation if you want users create a column and copy it to the database. Any empty cells will be passed with a null value. 

Because this example is for an SQL destination type, you don't need to configure the Fields Validation settings, as they can be managed with Allow table creation and Allow columns creation.  If you want to find out more about how to use these with other destination types, see our article here


If you need to restrict which users can work with the destination, you can do this with Access & Security settings (Figure 11). 

Check: This setting can only be enabled if it refers to an existing security rule. 


Figure 11: Access & Security


  • Check Secure Destination to enable the setting, and click User Access to open a user list window (Figure 12). 


Figure 12: User Access


  • Select Write from the dropdown in the Role column. 

Check: Users won't be granted access automatically if Secure Destination is enabled. 

  • Click Save Changes, then Restart when you're happy you've entered the correct information. 


Adding Writeback Settings 


Now, you need to go to Vizlib Writeback Table and configure your app to write back to the destination. You'll find these settings in the property panel under Destinations

  • Open your Qlik Sense Hub and find the Vizlib Writeback Table sheet you'd like to work with.
  • Open the sheet in Edit mode, then go to Destinations in the property panel. 
  • Click on Vizlib Server in Pick Destination (Figure 13).


 Figure 13: Pick Destination


  • Select a Writeback Destination from the dropdown (Figure 14). This is where your data will be saved.  

Note on Destination Paths: SQL destination paths follow the structure 

Destination|Database Type|Table Name

So in the example here we're writing to the Vizlib table in an SQL database called sql9.  


Figure 14: Server Settings


  • When you've completed the changes and saved them, you'll be able to write back to the destination you've configured. Figure 15 shows an example of adding Writeback Settings. 


Figure 15: Adding Writeback Settings


Working with Vizlib Writeback Table - Data Load Updates


Now you've completed the setup, you will need to update your data load script to make sure data is loaded correctly back into the app. Otherwise, it will look like the operation isn't completing. 

The data load script is part of the Qlik Sense environment, you can find out more about editing the data load script in a Qlik Sense app here

Tip: Use * to specify all columns in the table should be loaded. This is especially useful when you expect the content of the table to change (e.g. by adding new columns). 

When you complete these steps, the table will be loaded back into the app correctly and you can start to use Vizlib Writeback Table to help make the most of your analytics solution.   


Vizlib Writeback Table - Further Reading


You should now be able to start working with Vizlib Writeback Table if you've completed all the steps in this article without any errors. We have a Troubleshooting reference guide with hints on how to resolve any known issues and an Overview article containing information on webinars, basic operations and a summary of all our other articles for Vizlib Writeback Table. 

Tutorial: You can watch a step-by-step video tutorial on setting up an audit trail 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.