├── LICENSE ├── README.md ├── app_template ├── automation_template.json └── images ├── field_usage_1.png ├── field_usage_2.png ├── field_usage_3.png ├── field_usage_4.png ├── run1.png ├── run2.png ├── run3.png ├── run4.png ├── setup1.png ├── setup2.png ├── setup3.png ├── setup4.png ├── setup5.png ├── setup6.png ├── setup7.png └── youtube_screen.png /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public 379 | licenses. Notwithstanding, Creative Commons may elect to apply one of 380 | its public licenses to material it publishes and in those instances 381 | will be considered the “Licensor.” The text of the Creative Commons 382 | public licenses is dedicated to the public domain under the CC0 Public 383 | Domain Dedication. Except for the limited purpose of indicating that 384 | material is shared under a Creative Commons public license or as 385 | otherwise permitted by the Creative Commons policies published at 386 | creativecommons.org/policies, Creative Commons does not authorize the 387 | use of the trademark "Creative Commons" or any other trademark or logo 388 | of Creative Commons without its prior written consent including, 389 | without limitation, in connection with any unauthorized modifications 390 | to any of its public licenses or any other arrangements, 391 | understandings, or agreements concerning use of licensed material. For 392 | the avoidance of doubt, this paragraph does not form part of the 393 | public licenses. 394 | 395 | Creative Commons may be contacted at creativecommons.org. 396 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Status 2 | [![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive) 3 | 4 | # Qlik Field Usage Automation 5 | 6 | - [About](#about) 7 | * [What is it](#what-is-it) 8 | * [What makes this different from other tools or products](#what-makes-this-different-from-other-tools-or-products) 9 | * [When is this automation not a fit](#when-is-this-automation-not-a-fit) 10 | * [Video Overview and Demo](#video-overview-and-demo) 11 | - [Screenshots](#screenshots) 12 | * [Generated App](#generated-app) 13 | * [Automation Output](#automation-output) 14 | - [Capabilities](#capabilities) 15 | - [Setup](#setup) 16 | - [Running the automation](#running-the-automation) 17 | * [Via the Automation Directly](#via-the-automation-directly) 18 | * [Via another Automation Directly](#via-another-automation-directly) 19 | * [Via REST](#via-rest) 20 | - [Definitions](#definitions) 21 | - [Updates and Versioning](#updates-and-versioning) 22 | - [Current Scope and Limitations](#current-scope-and-limitations) 23 | - [Field and Variable Recognition](#field-and-variable-recognition) 24 | * [Field Recognition](#field-recognition) 25 | * [Variable Recognition](#variable-recognition) 26 | * [Nested Variable Referencing](#nested-variable-referencing) 27 | 28 | ## About 29 | ### What is it 30 | A Qlik Application Automation template and programmatically generated app for Qlik Sense apps in Qlik Cloud that exposes field usage and allows for impact analysis. In short, this application allows the user to quickly identify and drop unused fields in a Qlik Sense application, as well as perform impact analysis for Fields, Variables, and Master Items. 31 | 32 | > _Keep your Qlik Sense apps slim and performant, and gain an understanding of where and how fields are used._ 33 | 34 | ### What makes this different from other tools or products 35 | - This automation is completely native to Qlik Cloud, and has zero footprint (i.e. it requires no additional hardware or external code/programs) 36 | - As this is an automation, it can be run as part of a pipeline/workflow in Qlik Cloud. As an example, one could create a publish process that runs this automation, and if the contains more than ~20% unused RAM, it is kicked back to the owner to drop X fields with the generated statement. 37 | - This automation is open source. 38 | 39 | ### When is this automation not a fit 40 | - If the goal is to optimize the objects and/or the fields/expressions themselves, this is not the utility to do so as it does not "exercise" the objects nor does it provide recommendations to optimize the fields. The [App Evaluator](https://community.qlik.com/t5/Qlik-Product-Innovation-Blog/Manage-performance-with-the-new-Application-Evaluator-available/ba-p/1799878) which is native to Qlik Cloud can assist with identifying poorly performing objects, and other third-party document analyzers offer more prescriptive approaches to field optimization. 41 | 42 | ### Video Overview and Demo 43 | [![Field Usage Overview Youtube](/images/youtube_screen.png)](https://www.youtube.com/watch?v=xS7KmAjboWk) 44 | 45 | ## Screenshots 46 | ### Generated App 47 | ![](/images/field_usage_2.png) 48 | ![](/images/field_usage_3.png) 49 | ![](/images/field_usage_4.png) 50 | 51 | ### Automation Output 52 | ![](/images/run3.png) 53 | 54 | ## Capabilities 55 | This automation can identify unused: 56 | - Fields 57 | - Variables 58 | - Master Objects 59 | - Master Measures\* 60 | - Master Dimensions\* 61 | 62 | Regarding impact analysis, this automation traces field usage across: 63 | - Objects 64 | - Master Objects 65 | - Variables 66 | - Nested Variable References 67 | - Bookmarks 68 | - Master Dimensions* 69 | - Master Measures* 70 | 71 | \* Note that this automation does not currently support the identification of Master Measure/Master Dimension references, e.g. using [Total Sum of Sales] (the name of a Master Measure) as a reference in an expression. This does not affect the algorithm used for determining unused fields, but it would not show those references for impact analysis. 72 | 73 | ## Setup 74 | Ultimately, all that needs to be done to configure this automation is to import the `automation_template.json` template into a new, blank automation in Qlik Cloud. There are however some nuances as well as tips and tricks to this, so the suggested flow is documented below: 75 | 76 | 1. On this GitHub repository, select the **Code** button on the top right, and then select **Download zip**. 77 | 78 | ![](/images/setup1.png) 79 | 80 | 2. Once downloaded, unzip the file and locate the `automation_template.json` file. This is the automation template that will be uploaded into Qlik Cloud. 81 | 82 | 4. Navigate to Qlik Cloud, and select **Add new**, then select **New automation**. 83 | 84 | ![](/images/setup2.png) 85 | 86 | 4. A modal will appear where a template can be selected. Find the **Blank automation** template, hover over it, and select **Use template**. 87 | 88 | ![](/images/setup3.png) 89 | 90 | 5. Provide a Name and optionally a Description, and then select **Save**. 91 | 92 | ![](/images/setup4.png) 93 | 94 | 6. In the new automation editor, mouse-over anywhere on the canvas (the whitespace) and right-click. An options dropdown will appear. Select **Upload workspace**. Be patient while the workflow is generated (it might look broken at first and the UI might lock up). 95 | 96 | ![](/images/setup5.png) 97 | 98 | --- 99 | **IMPORTANT!** 100 | This process can take several minutes as this automation is complex. This process only needs to be done a single time, and this screen never has to be returned to, as the automation can be triggered from the Overview in the future which does not trigger the rendering of the automation workflow. 101 | 102 | --- 103 | 7. Once the UI is fully rendered (make sure by clicking on something and confirming that the UI reacts), select the **Save** button on the top right. This can take ~10 seconds until it is complete. 104 | 105 | ![](/images/setup6.png) 106 | 107 | 8. Now that the template has been uploaded and saved, return to the Hub, and then open the automation by simply hovering over it and clicking **Open automation**. This ensures that the heavy rendering of the workflow GUI has been flushed, and this will take the user straight to the **Overview** section of the automation. This will keep the UI speedy, and this is the suggested way to always open and run the automation in the UI, as the automation itself never needs to be edited and will slow down the browser. 108 | 109 | ![](/images/setup7.png) 110 | 111 | 9. The automation is now ready to be run! 112 | 113 | ## Running the automation 114 | ### Via the Automation Directly 115 | 1. In the Hub, open the automation by simply hovering over it and clicking **Open automation**. This will take the user straight to the **Overview** section of the automation. This will keep the UI speedy (vs going to the Editor), and is the suggested way to always open and run the automation in the UI, as the automation itself never needs to be edited and will slow down the browser. 116 | 2. On the top right of the screen, select **Run** 117 | 118 | ![](/images/run1.png) 119 | 120 | 3. A number of user inputs will appear, however the only required input is **AppId to Scan**, which is the AppId of the Qlik Sense application that it should scan. If only that input is entered and submitted, the automation will just output the results directly on the output screen. This is helpful if the user only wants the DROP FIELDS statement generated for that Qlik Sense application and does not care about any additional analysis that could be done in a generated Qlik Sense application. 121 | 3a. The additional inputs are shown and documented below (directly in the automation) and provide the user the ability to generate an output application (integral for impact analysis), as well as to control what types of sheets are scanned (Base or All). 122 | 123 | ![](/images/run2.png) 124 | 125 | 4. Once the desired inputs have been filled out/selected, select the **Submit** button to start the automation. 126 | 5. The automation can take anywhere from ~1 minute to ~30 minutes or more depending on the amount of objects/sheets that are to be scanned. Scanning _Base_ sheets only decreases the execution time by eliminating the scanning of _Community_ or any of the executing user's _Personal_ sheets. 127 | 6. Once complete, the output will be displayed directly on the screen, as well as in an app if that selection was toggled. 128 | 7. If an application was generated, it will appear in the selected space (Personal if no space was selected), and should be fully populated and reloaded with all of the output data. 129 | 130 | ### Via another Automation Directly 131 | If this automation is to be triggered via another automation, ensure that the following required inputs are passed: 132 | - AppId to Scan 133 | - Scan Base Sheets Only (Yes/No input) 134 | - Generate Output App (Yes/No input) 135 | - Use Custom Template (Yes/No input) 136 | 137 | ### Via REST 138 | If its desired to trigger this automation remotely via REST, all of the inputs can be passed as parameters. The required parameters are: 139 | - AppId to Scan 140 | - Scan Base Sheets Only (Yes/No input) 141 | - Generate Output App (Yes/No input) 142 | - Use Custom Template (Yes/No input) 143 | 144 | The full path to the URL and X-Execution-Token along with example call templates can be found by navigating to the Editor of the automation template and clicking on the **Start** block. 145 | ![](run4.png) 146 | 147 | ## Definitions 148 | **Unused Fields** 149 | - A field is determined to be unused if it is not found in any Object, Master Dimension, Master Measure, Master Object, Bookmark, or Variable and that field is also not a Key field. If a field is found only in a Master Measure and that Master Measure is not used, the field will still be marked as used. 150 | 151 | **Unused Variables** 152 | - A variable is determined to be unused if it is not in any other variable that is used, it is not a script created variable, and it isn't found in any Object, Master Dimension, Master Measure, Master Object, or Bookmark. 153 | 154 | **Unused Master Objects** 155 | - A Master Object is determined to be unused if it is not found on any scanned sheet. 156 | 157 | **Unused Master Dimensions/Master Measures** 158 | - Master Dimensions and Master Measures can be determined to be unused if they are not found on any scanned sheets, **_however_** this automation does not scan for Master Dimension or Master Measure references, so this cannot be guaranteed. 159 | 160 | ## Updates and Versioning 161 | The automation will automatically let you know (in its Output) when a new version of the template is available to be downloaded from this location. Updates are not forced, as the template is locked to a specific version (branch), so it is up to the user when a new template should be fetched. 162 | 163 | ## Current Scope and Limitations 164 | This automation does not currently support: 165 | - Scanning of QVW files. Only Qlik Sense apps are supported 166 | - Scanning Master Measure and Master Dimension references (e.g. [Total Sum of Sales] used in an expression) 167 | - Logging of parent objects (containers, filterpanes) that do not have matches in any child objects (e.g. a container that holds a text object with no matches -- the text object will still be logged with no hit, but the parent container will not) 168 | 169 | This automation is currently limited to: 170 | - Scanning a single Qlik Sense application at a time 171 | 172 | ## Field and Variable Recognition 173 | ### Field Recognition 174 | The field scanning algorithm classifies fields that are recognized into two types: 175 | - Exact 176 | - Wild 177 | 178 | An _Exact_ match is captured when the string value matches any of the following patterns: 179 | - `[{fieldName}]` 180 | - `"{fieldName}"` 181 | - `({fieldName})` 182 | - `` `{fieldName}` `` 183 | 184 | or if the string value matches the following verbatim: 185 | - `={fieldName}` 186 | - `{fieldName}` 187 | 188 | A _Wild_ match is captured when an _Exact_ match is not found, but that field is found as part of a substring. 189 | 190 | In the output app, the field `"FieldExactMatchFound"` indicates if there was ever an exact match of that field found in the scan (meaning it must be used), whereas if an exact match was never found, that field's value will be set to `False`. The user can then manually identify in the app by looking at the expressions that were captured to see if the field is in fact actually used. The automation is in this way overly conservative, in that it might indicate a number of fields are used when they in fact are not, but the opposite should never be true. 191 | 192 | ### Variable Recognition 193 | The variable scanning algorithm classifies variables that are recognized into two types: 194 | - Exact 195 | - Wild 196 | 197 | Does the Dimension entity contain an exact match ($({Variable}), $(={Variable}), ({Variable})) or does the entire entity match the Variable name exactly? 198 | 199 | An _Exact_ match is captured when the string value matches any of the following patterns: 200 | - `$({variableName})` 201 | - `$(={variableName})` 202 | - `({variableName})` 203 | 204 | or if the string value matches the following verbatim: 205 | - `={variableName}` 206 | - `{variableName}` 207 | 208 | A _Wild_ match is captured when an _Exact_ match is not found, but that variable is found as part of a substring. 209 | 210 | ### Nested Variable Referencing 211 | Variables are also scanned recursively for the presence of other variable names, and thereby associated to any fields that those nested variables contain. 212 | 213 | For example, if a Qlik Sense application contains the following three variables: 214 | - Name: `vCost`, Definition: `=Sum(Cost)` 215 | - Name: `vSales`, Definition: `=Sum(Sales)` 216 | - Name: `vProfit`, Definition: `$(vSales) - $(vCost)` 217 | 218 | `vProfit` will be associated with the fields `"Cost"` and `"Sales"`, along with any asset that uses that variable (e.g. if an Object uses `vProfit`, it will also be associated with those fields.) 219 | -------------------------------------------------------------------------------- /images/field_usage_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/field_usage_1.png -------------------------------------------------------------------------------- /images/field_usage_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/field_usage_2.png -------------------------------------------------------------------------------- /images/field_usage_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/field_usage_3.png -------------------------------------------------------------------------------- /images/field_usage_4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/field_usage_4.png -------------------------------------------------------------------------------- /images/run1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/run1.png -------------------------------------------------------------------------------- /images/run2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/run2.png -------------------------------------------------------------------------------- /images/run3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/run3.png -------------------------------------------------------------------------------- /images/run4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/run4.png -------------------------------------------------------------------------------- /images/setup1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup1.png -------------------------------------------------------------------------------- /images/setup2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup2.png -------------------------------------------------------------------------------- /images/setup3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup3.png -------------------------------------------------------------------------------- /images/setup4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup4.png -------------------------------------------------------------------------------- /images/setup5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup5.png -------------------------------------------------------------------------------- /images/setup6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup6.png -------------------------------------------------------------------------------- /images/setup7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/setup7.png -------------------------------------------------------------------------------- /images/youtube_screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eapowertools/qlik-field-usage-automation/983208d1019dd1887511f02a5f776dc493e77874/images/youtube_screen.png --------------------------------------------------------------------------------