Qlik-oss/enigma.js 项目常见问题解决方案

Qlik-oss/enigma.js 项目常见问题解决方案

enigma.js JavaScript library for consuming Qlik's Associative Engine. 项目地址: https://gitcode.com/gh_mirrors/en/enigma.js

1. 项目基础介绍和主要编程语言

enigma.js 是一个开源的 JavaScript 库，它帮助开发者与 Qlik 的 QIX Engine 进行通信。这个库可以用于构建基于浏览器的分析工具、后端服务或者命令行脚本。enigma.js 旨在让开发者能够轻松地访问和操作 Qlik Sense 的强大功能。该项目的主要编程语言是 JavaScript。

2. 新手常见问题及解决步骤

问题一：如何安装和设置 enigma.js

问题描述： 新手在使用 enigma.js 时，可能会对如何安装和配置该项目感到困惑。

解决步骤：

1. 确保你已经安装了 Node.js（版本 4.0 或更高）。
2. 使用 Git Bash（如果是 Windows 系统）或者命令行工具克隆项目到本地。
3. 在项目目录中运行 npm install 命令安装所有依赖。
4. 按照项目 README.md 文件中的指示，创建一个新文件并编写初始化 enigma.js 的代码。

问题二：如何使用 WebSocket 连接到 Qlik Sense Engine

问题描述： 初学者可能不清楚如何使用 WebSocket 连接到 Qlik Sense Engine。

解决步骤：

1. 在你的 JavaScript 文件中，首先需要引入 enigma.js 和 WebSocket 库：

   const enigma = require('enigma.js');
   const WebSocket = require('ws');
   

2. 然后，使用 enigma.create 方法创建一个新会话，并提供正确的 schema 和 WebSocket URL：

   const schema = require('enigma.js/schemas/12.20.0.json');
   const session = enigma.create([
     schema,
     {
       url: 'ws://localhost:9076/app/engineData',
       createSocket: (url) => new WebSocket(url)
     }
   ]);
   

问题三：如何调试和查看 WebSocket 通信数据

问题描述： 开发者可能需要查看 WebSocket 的发送和接收数据来调试应用程序。

解决步骤：

1. 为 session 对象添加 traffic:sent 和 traffic:received 事件监听器，用于输出通信数据：

   session.on('traffic:sent', (data) => console.log('sent:', data));
   session.on('traffic:received', (data) => console.log('received:', data));
   

2. 确保在创建 WebSocket 连接之前添加这些监听器。

通过上述步骤，新手可以更容易地开始使用 enigma.js 并解决一些常见的问题。

enigma.js JavaScript library for consuming Qlik's Associative Engine. 项目地址: https://gitcode.com/gh_mirrors/en/enigma.js