Skip to content

Latest commit

 

History

History
96 lines (74 loc) · 3.3 KB

README.md

File metadata and controls

96 lines (74 loc) · 3.3 KB
Raw

BIForm

BIForm is a powerful CLI tool designed for managing Qlik Sense BI applications and their configurations in a version control system (VCS) such as Git.

Getting Started

Follow the instructions below to get a copy of the project running on your local machine.

Prerequisites

  • A Qlik Sense Cloud tenant: You can get a free trail here
  • Qlik Sense Cloud API key
    • Profile Settings > API keys
  • IDE such as VS Code
  • Version Control such as GitHub or GitLab
  • Python 3.6 or higher installed on your local machine

Installing Qlik CLI

  • Follow the instructions here to install Qlik CLI

How it works

To initialize and run the project, open your terminal in the projects folder and enter the following commands:

# To initialize the project (will create all the required files and folders)
python biform.py init # for Mac and Linux

Add the Qlik Sense app ids to the newly created config.json file.

{
"APP_IDS": [
    "YOUR_QLIK_CLOUD_APP_ID_1",
    "YOUR_QLIK_CLOUD_APP_ID_2"
    ]
}

You can find the app ids in the URL of the Qlik Sense Cloud app. E.g. https://cloud.qlik.com/sense/app/<APP_ID>/sheet/<SHEET_ID>/state/analysis

# To pull the latest changes from the remote repository
python biform.py pull # for Mac and Linux
# To apply any changes made locally
# currently works for master measures, dimensions, variables, and the script
python biform.py apply # for Mac and Linux

Scaffolding

└── /
  ├── biform.py # Contains the main logic of the application
  ├── README.md # Contains the documentation of the application
  └── biforms/
          ├── state.json # Contains the state of the application
          ├── config.json # Contains the configuration of the application (e.g. Qlik Sense Cloud API key and tenant)
          └── app-id-1/
              └── app-unbuild/
                  ├── app.qvf # Contains the Qlik Sense application
                  ├── app-properties.json
                  ├── config.yml
                  ├── connections.yml
                  ├── dimensions.json
                  ├── measures.json
                  ├── script.qvs
                  ├── variables.json
                  └── objects/
                    ├── appprops.json
                    ├── loadmodel.json
                    ├── sheet1
                    ├── sheet2
                    └── sheet3

Contributing

We welcome contributions from the community! If you'd like to contribute to the project, please follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes.
  3. Make your changes and commit them with clear commit messages.
  4. Push your changes to your fork.
  5. Submit a pull request to the main repository.

We'll review your changes and work with you to get them merged into the project.

Built With

  • Python - The programming language used
  • Qlik CLI - The CLI tool used to manage Qlik Sense applications