VFD Installation

Purpose: This guide helps CSR install and activate the VFD (Customer Display) service on a Windows POS device using the Clibase-VFD-Integration package.

What you need?

• Clibase-VFD-Integration.zip - Download File Here

• The file must be copied to Local Disk (C:)

• Node.js must be installed (required for the service setup)

Part A — Prepare the Files

1. Open “This PC”

   • You can double-click This PC on the Desktop, or open File Explorer and click This PC.

2. Go to “Local Disk (C:)”

   • Under Devices and drives, click Local Disk (C:).

3. Locate Clibase-VFD-Integration.zip

   • Look for the downloaded file named Clibase-VFD-Integration.zip

4. Extract Clibase-VFD-Integration.zip

   • Right-click Clibase-VFD-Integration.zip → click Extract / Extract Here.

   • After extraction, you should see a folder named Clibase-VFD-Integration

5. Copy the extracted folder to Drive C

   • Copy the folder Clibase-VFD-Integration.

   • Paste it directly in Local Disk (C:).

   • Final expected path: C:\Clibase-VFD-Integration\

If you already see C:\Clibase-VFD-Integration\, you may skip Steps 4–6.

Part B — Install Node.js

1. Open Microsoft Edge browser

2. Download and install Node.js

   • In Edge, go to: https://nodejs.org/en

   • Download the installer, then run it.

   • Click Next through the setup (use default settings).

3. Restart the POS device (recommended)

   • Restarting helps Windows recognize Node.js properly.

Part C — Run the VFD Setup Commands

This section installs the needed packages and starts the local VFD service.

1. Open Command Prompt (Command Line)

• Press the Windows key, type cmd, then press Enter.

• If you encounter permission issues later, close it and re-open using Run as administrator.

1. Go to the API folder: Clibase-VFD-Integration/api

• In Command Prompt, type one of the following, then press Enter:

cd C:\Clibase-VFD-Integration\api

• If the above does not work, you may also try:

cd C://Clibase-VFD-Integration/api

1. Install required packages (API)

• Type this, then press Enter:

npm i

1. Go to the Scheduler folder: Clibase-VFD-Integration/scheduler

• In the same Command Prompt window, type one of the following, then press Enter:

cd C:\Clibase-VFD-Integration\scheduler

• If the above does not work, you may also try:

cd C://Clibase-VFD-Integration/scheduler

1. Install required packages (Scheduler)

• Type this, then press Enter:

npm i

1. Run the scheduler script

• Type this, then press Enter:

node execute.js

Important: Do not close the Command Prompt immediately after running node execute.js unless your internal process explicitly says so.

Verify the VFD service is running (Browser Test)

1. Open Microsoft Edge browser

2. Open the local test URL

• Copy and paste this exact link into the Edge address bar, then press Enter:

http://localhost:2024/sendtovfd?line1=100.00&line2=200.00

1. Confirm the result

• The page result must show:

  • “Services: Running”

If it shows “Services: Running”, the installation is successful.

Part D — Set Up VFD to Run as a Windows Service

Use this section so the VFD service can auto-run in the background (recommended for POS devices), even after restart.

1. Open Command Prompt as Administrator

   • Press the Windows key, type cmd.

   • Right-click Command Prompt → click Run as administrator.

2. Go to the API folder

   • Type this, then press Enter:

   cd C:\Clibase-VFD-Integration\api

   • If needed, you may also use:

   cd C://Clibase-VFD-Integration/api

3. Install qckwinsvc (Windows service tool)

   • Type this, then press Enter:

   npm install -g qckwinsvc

4. Run the service setup wizard

   • Type this, then press Enter:

   qckwinsvc

5. Fill in the prompts exactly as follows

   • Service Name: Clibase-VFD-Integration

     • Type Clibase-VFD-Integration, then press Enter

   • Service Details: Clibase-VFD-Integration

     • Type Clibase-VFD-Integration, then press Enter

   • Service path: (choose one accepted format)

     • C:\\Clibase-VFD-Integration\\api\\app.js OR

     • C:\\Clibase-VFD-Intergration\api\app.js

   • Tip: You can copy and paste the service path to avoid typing mistakes.

6. Verify the service is running

   • Press the Windows key, type Services, then press Enter.

   • Find Clibase-VFD-Integration → Status should be Running.

   • If not running: right-click → Start.

7. Confirm via browser test (recommended)

   • Open Microsoft Edge and go to:

   http://localhost:2024/sendtovfd?line1=1.00&line2=1.00

   • The result must show: “Services: Running”

Common Issues (Quick Fix Guide)

If you see: “npm is not recognized…”

• Node.js is missing or not installed correctly.

• Reinstall Node.js from https://nodejs.org/en, then restart the PC.

If you see: “The system cannot find the path…”

• Confirm the folder exists here: C:\Clibase-VFD-Integration\

• If it’s missing, redo Part A (extract + copy).

If the browser test does not show “Services: Running”

• Keep Command Prompt open and confirm node execute.js is still running.

• Re-run Step 15, then refresh the browser link in Step 17.

• If still failing, re-check Node.js installation and repeat Part C.

Check Microsoft Edge Local Network Access is Allowed (IMPORTANT)

• Meaning: Edge may block requests to http://localhost / http://127.0.0.1 or local network endpoints if Local Network Access is not allowed.

• Fix (Edge Permission):

  1. In Edge, open:

     edge://settings/content/localNetworkAccess

  2. Set Local network access to Allow (or “Ask/Allow”, depending on device policy).

  3. Close Edge, re-open Edge, then retry the browser test link.

• If the setting resets back to “Not allowed”:

  • This is usually a device policy / managed setting. Escalate to IT/admin to enforce:

    • Local Network Access = Allowed for POS devices

    • Or whitelist the POS domain that calls localhost (e.g., https://pos.clibase.tech) to access local network resources.