Vortex Menu Definitions

Vortex Menu Definitions

Vortex Qlik Harvester

What It Is
The Vortex Qlik Sense Metadata Harvester is a portable command-line tool designed to extract comprehensive metadata from Qlik Sense environments. It supports both Qlik Sense Enterprise on Windows (QSEoW) and Qlik Cloud deployments.
The tool is a 64-bit Windows executable that requires minimal installation—you simply download, extract, and run it.

Purpose
The harvester serves as the first step in any BI modernization project supported by Vortex. Its core purpose is to collect metadata that enables data-driven decisions about how to approach consolidation, modernization, or migration efforts.

What It Extracts
The harvester queries over 40 different metadata object types, including:
  1. Application metadata — apps, sheets, objects, measures, dimensions
  2. Environment information — streams/spaces, users, data connections
  3. Script and lineage information
  4. Session and reload logs
  5. Folder data connection contents
  6. Security and governance information
  7. Engagement patterns and usage statistics
How This Metadata Is Used
Once collected, the metadata enables several key activities:
Use Case
Description
Rationalization
Uncover insights about connections, lineage, and engagement patterns to prioritize what matters
Duplicate Detection
Identify derivative or duplicative content across your analytics landscape
Complexity Assessment
Factor in structural complexity to estimate conversion effort
Automated Conversion
Power Vortex's automated solution conversions to target BI platforms
Project Planning
Generate inventories, project scaffolding, and runbooks
Migration Approaches Supported
Whether you're doing a "lift-and-shift," a "rationalize-and-reimagine," or something in between, the harvester provides the foundational data needed to accelerate delivery with confidence.

Profile (Configuration File)

A profile in the Vortex Qlik Sense Harvester is the configuration file that stores all the settings needed to connect to and harvest metadata from a Qlik Sense environment.

File Details
  1. Filename: config.local.json
  2. Location: Stored in the harvester utility's directory
  3. Format: JSON

What It Contains
The profile defines all the parameters for a harvesting run, including:
Connection Settings
Parameter
Purpose
Uri
Qlik Sense server hostname or Qlik Cloud tenant URL
Type
Environment type (Enterprise or Cloud)
CertificateLocation
Path to the .pfx certificate file (Enterprise only)
CertificatePassword
Certificate password or API key (Cloud)
RunAsUserDir
User directory for authentication
RunAsUserName
Username or service account
Output & Security Settings
Parameter
Purpose
OutputLocation
Where harvested metadata is saved
EncryptionKeyFilePath
Path to PGP public key for encrypting output
Scope & Filtering Settings
Parameter
Purpose
StreamsToSearch
Limit harvest to specific streams
StreamsToIgnore
Exclude specific streams
AppIds
Harvest only specific applications
IncludeUnpublishedApps
Whether to include unpublished apps
Performance Settings
Parameter
Purpose
MaxConcurrentEngineAppConnections
Number of simultaneous engine connections
HarvestFolderDataConnectionData
Enable folder data connection scanning
MaxFileSearchDepth
Directory depth for folder scanning
How to Configure
You can update the profile only in the UI:
  1. Through the UI — When you launch the harvester, enter the parameters required.

Inventory

Definition
The Inventory is a comprehensive catalog of all objects discovered during the Vortex harvesting process from a Qlik Sense environment. It serves as the foundational dataset for understanding the scope and composition of your analytics landscape.
What the Inventory Contains
Applications
  1. Application name and ID
  2. Owner of the application
  3. Published or unpublished status
  4. Last modified date
  5. Associated reload logs (if available)
  6. Structural composition including:
    1. Sheets and sheet objects
    2. Measures and dimensions
    3. Scripts and data models
    4. Expressions
Streams/Spaces
  1. Stream or space name and ID
  2. Applications published to each stream
  3. Stream ownership information
Data Connections
  1. Connection names and types
  2. Associated applications using each connection
Users
  1. Licensed and allocated users
  2. User directory information
Tasks
  1. Reload tasks configured in the environment
  2. Execution results and script log information
Purpose of the Inventory
Purpose
Benefit
Scope Assessment
Understand the full extent of your Qlik environment
Rationalization
Identify redundant, unused, or duplicative content
Lineage Analysis
Trace data connections and dependencies across applications
Engagement Insights
Analyze usage patterns through session and reload logs
Migration Planning
Prioritize applications for conversion based on ownership, usage, and complexity
Resource Allocation
Estimate effort for manual vs. Vortex-assisted conversions
How the Inventory Is Generated
The Inventory is built from metadata extracted via Qlik's official APIs, including the Repository Service API and Engine JSON API. The harvester collects this information and stores it as encrypted files (.pgp) in the configured output location.

Harvest

Overview
The Harvest is the process of scanning and extracting metadata from a Qlik Sense environment using the Vortex command-line tool.
Warning
Important: A valid Vortex license (public key file) supplied by Axis Group is required to run the harvester. Without this license, the tool will not function.
What the Harvest Does
The harvest process connects to your Qlik Sense environment and systematically extracts metadata using officially available APIs. This includes:
  1. Application metadata — apps, sheets, objects, measures, dimensions, scripts, data models, and expressions
  2. Environment information — streams/spaces, users, data connections
  3. Execution data — reload tasks, script logs, session logs
  4. Lineage information — connections and dependencies between objects
  5. Usage statistics — engagement patterns and last modified dates
All extracted metadata is encrypted using a PGP public key and stored in the configured output location.

Harvest Requirements

Licensing
  1. Valid public key / license file supplied by Axis Group
System Requirements
Requirement
Specification
Operating System
Windows 64-bit
CPU
4-core (recommended)
RAM
8 GB (recommended)
Disk Space
2-3 GB for extracted metadata
Framework
.NET Framework 4.7.2
Qlik Sense Access
Environment
Authentication
Enterprise (QSEoW)
Certificate-based authentication via exported .pfx file
Cloud
API key generated by a Tenant Admin
Network Ports (Enterprise)
  1. 443 Qlik Sense Proxy Service (QPS)
  2. 4242 — Qlik Sense Repository Service (QRS)
  3. 4747 — Qlik Sense Engine Service (QES)
Harvest Process
  1. Configure — Set up the profile (config.local.json) with connection details, output location, and scope filters
  2. Execute — Launch the harvester and press Enter to begin
  3. Monitor — Watch progress as the tool reports App Harvest, QRS Harvest, and Folder Harvest status
  4. Validate — Review the output directory to confirm metadata was captured correctly
  5. Transfer — Send encrypted output to Axis Group via secure file transfer (psend.axisgroup.com)
Performance Characteristics
  1. Processes approximately 3 apps/minute at default concurrency settings
  2. Concurrency can be adjusted via MaxConcurrentEngineAppConnections to balance speed vs. server load
  3. The harvest consumes memory and CPU capacity from your Qlik environment during operation
Who Can Run the Harvest
The harvest can be executed by:
An Axis Group engineer as part of a services engagement
A representative analytics administrator from your organization with support from Axis Group
Notes
Note: At customer discretion, the harvest can initially be performed against a development or test environment to evaluate impact before running against production.


Harvest History

Overview
Warning
Important: A valid Vortex license (public key file) supplied by Axis Group is required to run the harvester and generate harvest history. Without this license, the tool will not function.
Harvest History is a record that combines two key elements: a log of previous harvest executions and the historical metadata captured during each harvest run.

What Harvest History Contains
Execution Logs
  1. Record of each harvest run performed
  2. Timestamps of when harvests were executed
  3. Status and completion information
  4. Any errors encountered during harvesting (captured in Harvest Errors.json)
  5. Log files stored in the Logs directory within the utility folder
Historical Metadata Captured
Data Type
Description
Reload Logs
Execution history of application data reloads (limited by automatic cleanup of historical logs)
Session Logs
User session activity and engagement patterns
Execution Results
Script log execution information for lineage analysis
Last Modified Dates
Timestamps showing when applications were last changed
Task History
Information about scheduled reload tasks and their execution
Purpose of Harvest History
Harvest History enables organizations to:
  1. Track Changes Over Time — Compare metadata across multiple harvests to identify environment changes
  2. Analyze Usage Patterns — Understand application engagement through historical session data
  3. Support Lineage Analysis — Use reload and script execution history to trace data flows
  4. Audit Harvest Operations — Maintain a record of when and how harvests were performed
  5. Troubleshoot Issues — Review logs to diagnose problems with specific harvest runs
Where Harvest History Is Stored
  1. Execution Logs — Logs directory within the Vortex harvester utility folder
  2. Historical Metadata — Output location configured in the profile, including:
    1. Reload Logs subfolder
    2. Session Logs subfolder (QlikView)
    3. Harvest Errors.json file


Harvest Results

Overview
Warning
Important: A valid Vortex license (public key file) supplied by Axis Group is required to run the harvester and generate harvest results. Without this license, the tool will not function.
Harvest Results are the complete output generated from a Vortex harvest run. This includes all extracted metadata, reports, and logs from a scanned Qlik environment, stored in the profile's configured output directory.
What Harvest Results Contain
Output Type
Description
Application Metadata
Encrypted .pgp files containing scripts, sheets, sheet objects, measures, dimensions, and data models
Repository Information
QRS data including streams, users, data connections, and tasks
Reload Logs
Execution history of application data reloads
Session Logs
User session activity and engagement data
Harvest Errors
Harvest Errors.json file documenting any issues encountered during the harvest
Execution Logs
Harvester operation logs stored in the Logs directory
Output Directory Structure
  1. OutputLocation\
  2. ├── Apps\                                    # Application metadata by app
  3. │       └── [App folders]\
  4. │               ├── script.json.pgp
  5. │               ├── sheets.json.pgp
  6. │               └── sheetObjects.json.pgp
  7. ├── QRS\                                     # Repository service data (.pgp files)
  8. ├── Reload Logs\ # Historical reload execution logs
  9. ├── Folder Data Connections\    # File metadata (if enabled)
  10. └── Harvest Errors.json               # Error log (if any issues occurred)


Transmit

Transmitting Harvest Results
Once a harvest is complete, the results must be securely transmitted to Axis Group for decryption, analysis, and conversion.

Packaging Process
  1. Select Profile — Choose the profile whose output you want to package
  2. Verify Output Directory — Confirm the correct output location is selected
  3. Create Package — Generate an encrypted package containing all metadata, reports, and logs
  4. Upload — Transmit the package to Axis Group via the secure upload portal (psend.axisgroup.com)
What Gets Packaged
  1. All contents of the output folder (Apps, QRS, Reload Logs, etc.)
  2. Harvester logs from the Logs directory
  3. Any additional files in the base output directory
Secure Transfer Methods
Method
Details
Primary
psend.axisgroup.com (Axis Group's secure file transfer portal)
Alternatives
SFTP, BLOB storage, or SendRED (if psend is not accessible)
Notes
Access Required: If you do not have access to psend, contact support@axisgroup.com for an account.
Purpose of Harvest Results
Harvest results enable Axis Group to:
  1. Analyze your environment — Build a complete inventory of your Qlik landscape
  2. Perform rationalization — Identify redundant or duplicative content
  3. Execute automated conversions — Transform Qlik assets to target BI platforms
  4. Generate project deliverables — Create inventories, runbooks, and project scaffolding

Support & Contact

Getting Help
For additional assistance or questions about the Vortex Harvester:
  1. Email: support@axisgroup.com
  2. File Transfer: psend.axisgroup.com
Additional Resources
  1. For detailed configuration information, see the Vortex Harvester Configuration Help documentation
  2. For system requirements and troubleshooting, consult your Axis Group representative
© 2024 Axis Group - Vortex Menu Definitions Documentation
Last Updated: 2025-12-30



    • Related Articles

    • Vortex Harvester Guide

      Configuration & Setup Guide Profile Name Purpose: The profile name is used to allow for multiple Qlik configurations within an organization. This allows the user to save each configuration for future use, making it easier to manage and switch between ...