Maya ECR Installation

This guide helps Customer Support install the Clibase-Maya-ECR-Integration Node.js service on a Windows PC so the Maya ECR bridge can run continuously in the background.

Prerequisites

• Windows PC with Admin access

• The file: Clibase-Maya-ECR-Integration.zip (Download File Here)

• Stable network access (as required by the Maya ECR setup)

• Node.js installed (LTS recommended)

Step-by-step Installation

1) Extract the ZIP

1. Right-click Clibase-Maya-ECR-Integration.zip

2. Click Extract All…

3. You should get a folder named: Clibase-Maya-ECR-Integration

✅ Expected result: Clibase-Maya-ECR-Integration\maya_ecr.js exists inside the folder.

2) Copy folder to C:\

Copy the extracted folder to:

C:\Clibase-Maya-ECR-Integration

✅ Expected path example: C:\Clibase-Maya-ECR-Integration\maya_ecr.js

3) Install Node.js

1. Download Node.js from the official site:

   • https://nodejs.org/en

2. Install using default options

3. Confirm installation:

Open Command Prompt and run:

node -v
npm -v

✅ Expected result: versions are displayed (example: v20.xx.x)

4) Install project dependencies (npm i)

1. Open Command Prompt as Administrator (recommended)

2. Go to the folder:

cd C:\Clibase-Maya-ECR-Integration

1. Install dependencies:

npm i

✅ Expected result: a node_modules folder is created and no “fatal” errors.

5) Install Windows service tool (qckwinsvc)

Run:

npm install -g qckwinsvc

✅ Expected result: no errors, and qckwinsvc becomes available.

Create the Windows Service

6) Run the service installer wizard

In Command Prompt, run:

qckwinsvc

Fill out the prompts as follows:

• Service Name: Clibase-Maya-ECR-Integration

• Service Details: Clibase-Maya-ECR-Integration

• Service path: (choose ONE correct format)

  C:\Clibase-Maya-ECR-Integration\maya_ecr.js

  ✅ Recommended (cleanest)

  If the wizard requires escaped slashes, use:

  C:\\Clibase-Maya-ECR-Integration\\maya_ecr.js

⚠️ Avoid mixing slash styles. Use consistent backslashes.

Validation Checklist (CSR must verify)

A) Confirm service exists

Open Services:

• Press Win + R → type services.msc → Enter

• Look for: Clibase-Maya-ECR-Integration

✅ Expected: Service is listed.

B) Start the service

• Right-click → Start

✅ Expected: Status becomes Running

Device Manager - COM Port Setup

1. On the POS Windows device, open Device Manager

• Search “Device Manager” and then below image will open.

1. Turn ON the Maya Terminal Device and open the ECR App on the terminal

• In Device Manager, expand: Ports (COM & LPT)

• You should see a new entry like: USB Serial Device (COM7) ✅ This confirms the PC detects the Maya terminal USB serial connection.

1. Right-click USB Serial Device (COM7) → click Properties

1. Go to Port Settings tab → click Advanced

1. Under COM Port Number, select COM100 → click OK to apply

• Close all windows, then re-check that it now shows: USB Serial Device (COM100)

✅ Expected: The Maya terminal serial device is consistently mapped to COM100.

Common CSR Scenarios / Examples

Example 1: “npm is not recognized”

Cause: Node.js not installed or PATH not updated. Fix: Reinstall Node.js, then close/reopen Command Prompt. Retry:

node -v
npm -v

Example 2: “Cannot find module” / missing dependencies

Cause: npm i wasn’t run in the correct folder. Fix:

cd C:\Clibase-Maya-ECR-Integration
npm i

Example 3: Service created but immediately stops

Common causes:

• Wrong service path (points to a missing file)

• Script exits due to missing config/connection dependency

• Permission issues

Quick checks:

1. Confirm file exists:

   • C:\Clibase-Maya-ECR-Integration\maya_ecr.js

2. Run manually to see errors:

cd C:\Clibase-Maya-ECR-Integration
node maya_ecr.js

If it prints an error, screenshot it and escalate to Tier 2/Dev with logs.

---

CSR Notes / Best Practices

• Always run Command Prompt as Administrator for service installation.

• Keep folder strictly at: C:\Clibase-Maya-ECR-Integration to avoid path issues.

• If reinstalling, remove old service first (coordinate with Tier 2/Dev if needed).

• Capture key proofs for ticket closure:

  • Node & npm versions

  • Screenshot of service Running in services.msc

  • Any console output if troubleshooting