Skip to main content
Announcements
YOUR OPINION MATTERS! Please take the Qlik Experience survey you received via email. Survey ends June 14.

Gold Client: How to Customize Data Snap Screens

cancel
Showing results for 
Search instead for 
Did you mean: 
Troy_Raney
Digital Support
Digital Support

Gold Client: How to Customize Data Snap Screens

Last Update:

Aug 9, 2022 6:52:32 AM

Updated By:

Troy_Raney

Created date:

Apr 26, 2022 7:33:32 AM

 

Environment

  • Qlik Gold Client

 

Transcript


Hello again. My name is Steve George and I’m glad that you’re watching this video today. You may have watched another video which provides content for using Data Snap to initiate data exports, but in this video, we’re going behind the curtain a bit to share how to customize the Data Snap configuration. Please keep in mind that not all users will have the permissions to deploy these config changes, but this content may still be useful so that you can request your Gold Client administrators to deploy changes accordingly.

This video will focus primarily on how to customize the selection criteria fields which appear on the Data Snap screen. We will also spend a bit of time on the Data Limit parameter, covering some other useful info, and the available resources.

Let me first share with you some useful content regarding the Data Snap config:

Qlik provides default config for more than 150 data types. It's common for customers to add new fields to the Data Snap screen for a select number of data types. Customers are free to customize those data types where no default configuration is provided.

The configuration is centered around the tables and fields which need to appear on the selection screen; additionally, there are settings available for defining Active and Required selections. Defining the entry as Active means that it will appear on the Data Snap screen where Inactive means that it will be hidden. Defining the entry as Required means that the user will be forced to input a value into this field as part of their selection criteria. There is also a field where a custom description can be defined which overrides the SAP description that appears on the Data Snap screen; this option may be useful on an occasional basis.

Let me now show how easy it is to add a couple of fields to the Data Snap screen

To reach the Gold Client solution, use t-code ZGOLD (Z-G-O-L-D). From the Gold Client screen, select the Data Snap function.

I'm going to input data type SD - SALES DOCUMENTS. Before proceeding with the config changes, let's have a quick look at how the screen looks currently. We can see three fields: Sales Doc, Sold-to, and the Created-on date. I'm going to return to the previous screen and select the Data Type Manager button.

On the next screen, expand the Data Type to see its maintenance views; double-click on the one named 'Data Snap'. This will cause two sub-screens on the right to appear. As you can see, three fields are already configured. I'm going to add an entry for Sales Organization and another for Sales Document Type.

First, convert the screen to 'change' mode and then add a new row. Input the respective table and then the field of your choosing; set the entry as Active. I'm now going to repeat this for the second field. When done, use SAP's global Save icon to save changes and then exit the config. Freely add any notes here about the changes that were deployed. From the Data Snap screen, select the 'Execute' button; on the next screen we can see the newly added fields.

I'll now share details about an important parameter that is part of this config.

The Data Snap config includes a parameter named 'Data Limit'; it controls the maximum number of records that a user is permitted to export during a single execution. The default value is defined as 1000 for all data types which are delivered standard by Qlik; users are free to adjust this value accordingly for each respective data type according to the organization's requirements.

The reason 1000 is used as the default is because the Qlik team feels this number is large enough for most use cases, and yet this number is not so large as to cause performance issues in sensitive systems such as Prod.

It's important to be aware that this parameter is only applied at the top-level data type; for example, if the user selects data type SD - SALES DOCUMENTS to export 1000 sales orders and there are 2000 related deliveries, all of these deliveries are still included in the data export. If this parameter was applied to all dependent data objects it could have a significant impact on data integrity and so this is why it's applied only to the data object that is being used as the basis of the export.

This screen capture shows where this parameter is located; it's in the sub-screen just below where I was deploying the config changes earlier in this video.

I want to now share with you some more useful information about the Data Snap config.

Be aware that if there is no Data Snap config defined, the error message of "Datatype is not configured for Data Snap" will occur. It is necessary to define at least one field within the Data Snap config to bypass this error.

Data Snap config changes can also be deployed via the Data Echo Framework function. When accessing the config using the Data Type Manger function, the user is limited to only the data type that was selected on the Data Snap screen. If there is a need to customize multiple data types, it's probably more efficient to access the Data Echo Framework instead.

The Data Snap config is global so all users will receive these changes, but the impact on them is generally minimal since most fields are optional. The notable exception is if the Required Selection setting is changed; this may create some frustration for users since they may be forced to apply criteria that they do not know or have.

The 'Default Date' parameter is a more advanced topic and is not covered in this video. Relevant content is available in the Data Echo Advanced Config User Guide and of course you can reach out to the Qlik support team for further information, if needed.

For additional information that has been shared in this video, including How-to content, please reference the Data Echo Advanced Config User Guide which is located on the Qlik Help website

I hope that you will find this content to be helpful when customizing the Data Snap screens for your organization. Please consider watching the other videos available within the Gold Client library.

 

Contributors
Version history
Last update:
‎2022-08-09 06:52 AM
Updated by: