Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Commit

Permalink
Adding info about how data is used (#249)
Browse files Browse the repository at this point in the history
* Adding info about how data is used

* Adding Data Policy to menu

* Fixing link
  • Loading branch information
Helene Rignér committed May 3, 2019
1 parent b51d409 commit ea987c4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ For catwalk to work there are two things needed:

## Hosted

You can use catwalk from [catwalk.core.qlik.com](https://catwalk.core.qlik.com), it will have the latest master build deployed and can also be used against an local Qlik Associative Engine.
You can use catwalk from [catwalk.core.qlik.com](https://catwalk.core.qlik.com), where the latest master build is deployed. It can be used against any Qlik Associative Engine, local or hosted.

## Local

If you want to run/develop the UI locally, you need [Node.js](https://nodejs.org/en/) installed. Then run these commands in Git Bash/command prompt/terminal and follow the instructions on your screen:
If you want to run/develop the catwalk UI locally, you need [Node.js](https://nodejs.org/en/) installed. Then run these commands in Git Bash/command prompt/terminal and follow the instructions on your screen:

```bash
git clone https://github.com/qlik-oss/catwalk.git
Expand All @@ -30,7 +30,7 @@ npm start
```

## 2. Qlik Associative Engine
You need to provide catwalk with a websocket URL to the app.
You need to provide catwalk with a websocket URL to the app. The URL is set with the `engine_url` query parameter.

### Example App
For convenience there is an example app and docker-compose.yml in the catwalk repository
Expand All @@ -41,20 +41,37 @@ The docker-compose.yml in the repository will expose the Qlik Associative Engine

`ws://localhost:9076/data/drugcases.qvf`

and is viewable in catwalk with e.g. `https://catwalk.core.qlik.com/?engine_url=ws://localhost:9076/data/drugcases.qvf`

### Qlik Sense Desktop
For connecting to a Qlik Sense Desktop the websocket URL will be:

`ws://localhost:4848/app/<app-name>`

### Qlik Sense Enterprise
The catwalk UI doesn't provide login to the Qlik Sense app but as long as there has been a login to the app in another tab/window the `X-Qlik-Session` cookie is set and catwalk can "reuse" that session. The URL [catwalk.core.qlik.com](https://catwalk.core.qlik.com) has to be white listed in the QMC -> virtual proxy (per virtual proxy being used) for the Sense Proxy to allow sessions from catwalk.
The catwalk UI doesn't provide a login to the Qlik Sense app, but as long as there has been a login to the app in another tab/window the `X-Qlik-Session` cookie is set, and catwalk can "reuse" that session. The URL [catwalk.core.qlik.com](https://catwalk.core.qlik.com) has to be white listed in the QMC -> virtual proxy (per virtual proxy being used) for the Sense Proxy to allow sessions from catwalk. Since catwalk is running client side only, there is nothing other then the browser session and the engine that accesses the data in the app. This means that catwalk can be seen as any externally hosted mashup which also needs to be whitelisted.

![host white list](./images/qmc-whitelist.png)

### Tip 1:tada:
We created a Qlik Sense extension that can be found in the sense-extension folder that will create a link to the Qlik hosted catwalk UI with the current open app if "dragged" onto a sheet of you Qlik Sense app.
To install the extension you have to zip the folder and import it into you Qlik Sense installation, [see](https://help.qlik.com/en-US/sense-developer/November2018/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm)
To install the extension you have to zip the folder and import it into you Qlik Sense installation, read more about how to do this [here](https://help.qlik.com/en-US/sense-developer/November2018/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm).

### Tip 2:tada:
We created a javascript bookmark that can be found in the [bookmark](./bookmark) folder that will open up a new tab to the Qlik hosted catwalk UI with the current open app.
To setup Create a bookmark and paste the content of [bookmark.js](./bookmark/bookmark.js) in the URL field.
To setup, create a bookmark and paste the content of [bookmark.js](./bookmark/bookmark.js) in the URL field.

# Data Policy
catwalk is running in a browser environment only, and creates a websocket connection directly to the QIX engine specified with the `engine_url` query parameter. This means that nothing other than the browser session and the engine will ever access the data in an app.

```
|-----------------|
| Browser running |
| catwalk |----|------------|
|--------|---|----| |
| | |
|-----|---|-| |---|----|
| you | | engine |
|-----------| |--------|
```
The only data collected is via Google Analytics which stores cookies on the users\` PC. This is to gain insight into how catwalk is used, how much and by whom. Examples of this information could be how long the users are staying, where the users are coming from (e.g. social media links, but also where in the world), and errors and exceptions.
6 changes: 6 additions & 0 deletions src/components/topbar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,19 @@ export default function TopBar({
window.open('https://github.com/qlik-oss/catwalk');
};

const goToDataPolicy = () => {
window.open('https://github.com/qlik-oss/catwalk/blob/master/README.md#Data-Policy');
};

const TopbarMenu = () => (
<Menu id="menu_id" className="menu" animation={animation.fade}>
<Item onClick={chooseApp}>Choose App</Item>
<Separator />
<Item onClick={startGuide}>Start Guide</Item>
<Separator />
<Item onClick={goToGithub}>Go to GitHub</Item>
<Separator />
<Item onClick={goToDataPolicy}>Data Policy</Item>
</Menu>
);
let selections;
Expand Down

0 comments on commit ea987c4

Please sign in to comment.