Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This Guides provides instructions for setting up, configuring and demonstrating the capabilities of x-hoppers Green Box.

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
exclude
typelist
class
printablefalse

...

How to assemble the Box

Tip

Before proceeding, change the admin password and upgrade your PBX from rel60beta.

Note that W-AIR Small Business Base Station is already provisioned to your PBX and listed in WMS Devices menu, Devices tab.

...

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

If you need any guidance, follow the instructions in W-AIR Headset User Guide, “Update of the Firmware” section.

How to Set Up

Note

Note that certain settings have been pre-set to ensure the proper operation of the system.

Please do NOT delete or modify these settings:

  1. User 100 "DemoFlowUser. DoNOTtouch" in WMS Users

  2. Simple Token created in WMS Integrations -> Applications

Step 1. Creating users

  • Access WMS and navigate to Users menu

  • Create user profiles for each individual who will be using x-hoppers

...

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to create users can be found in WMS Start Guide, “Adding users manually” section.

Step 2. Assigning users to the Headsets

  • Navigate to Devices menu, W-AIR devices tab

  • Associate each user with their respective W-AIR Headset

...

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to assign W-AIR Headsets can be found in x-hoppers Admin Guide, “Assign headsets to PBX users” section.

Step 3. Configuring settings for demonstration

  • Navigate to Dialplan menu, Dialplan rules tab

  • Download and import the following Dialplan procedures in Dialplan rules tab

    • View file
      name"XHoppersHelpPoints" and "clickcollect" Dialplan procedures.bkp
      - required for playing notifications for x-hoppers users if one of the help points is triggered and demonstrating click and collect scenario

...

View file
name"ChatGPT" Dialplan procedure.bkp
- required for ChatGPT Integration

...

Add the following Dialplan applications:

  • Set -> Language -> choose language

  • Speech to text -> insert Please unmute and say question for Chat GPT, or wait to join the broadcast or any customized text

  • Jump to if -> "${RECOGNITION_RESULT}"="question" -> ChatGPT procedure

  • Play sound -> click Browse (three dots) and choose the sound to be played on joining the broadcast or create it dynamically using TTS, for example Welcome to x-hoppers, joining the broadcast

  • Conference -> enter the conference room ID number. This can be any number, e.g. 1, 2, 3, etc

...

Tip

If you need to customize Dialplan procedures to your specific language, install a dedicated sound package that corresponds to your language in WMS Settings -> PBX -> Language & Region and make changes for the following Dialplan applications:

  • Set -> Language

  • Play sound

  • Speech to text

  • Navigate to General Settings tab, under Set dialplan variables, set the following variables and click Save button:

    • HelpPoint1=Help point 1 is triggered. Customer is looking for help in fresh fruits area

    • HelpPoint2=QR 2 is scanned. Customer is looking for more info about Workforce phone

...

Tip

With the variable HelpPointX, where X is a help point ID, you can customize the content of audio alerts sent to users and create any additional help points if needed. Please note that Help points 1-10 are preserved so you need to start adding from HelpPoint11.

  • Navigate to Call Groups tab and create a new call group specifically for handling assistance requests triggered by QR codes (it is needed for Help point 3 scenario). Make sure to activate Call waiting option when configuring the Call group strategy, so its members can receive more than one call at a time (consult the documentation for detailed guidance on how to create Call groups)

  • Proceed to Dialplan rules tab and select kite Dialplan procedure

  • Add 223344 as the called number and Call group Dialplan application to the chosen number

  • In the Call Group application settings, select the call group that you created

...

  • Log in to x-bees and create x-bees conversation with all the users that are participating in x-hoppers conference and also needed managers. In the next step, you will need to copy its ID

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to create x-bees conversations can be found in x-bees User Guide, “Conversations” section.

...

To gather and post transcriptions of conversations, use these commands in Terminal:

...

create directory /etc/systemd/system/pbx-data-engine.service.d

Code Block
# mkdir /etc/systemd/system/pbx-data-engine.service.d

...

add the following key to the file 

Code Block
# vi /etc/systemd/system/pbx-data-engine.service.d/override.conf
 
[Service]
ExecStart=
ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr

...

add the following data to /rw2/etc/pbx/x-hoppers.json file

Code Block
[
  {
    "audio_conf_id": "2",
    "xbees_channel_id": "f6d17593-98b6-471d-941a-cd03153f"
  }
]
  • audio_conf_id: ID of the audio broadcast channel in x-hoppers where the communication takes place

  • xbees_channel_id: ID of the x-bees conversation, where the content will be posted

reload systemd and restart the service to apply the changes:

...

Tip

Before proceeding with the setup, change the admin password and upgrade your PBX from rel60beta.

Step 1. Mapping Green Box to PBX

By following this procedure, you ensure that your x-hoppers Green Box is correctly mapped to the appropriate PBX:

  • Access WMS and navigate to Users menu

  • Create a user profile with the following parameters:

    • Role -> Admin

    • Full Name -> DemoFlowUser

    • Extension -> 100

...

  • Navigate to PBX menu, Integrations -> Applications -> Simple Token tab

  • Create a token for the user 100 and copy its key

    Image Added
  • Scan any QR code located inside the box

  • After scanning, you will be redirected to a web page where you need to provide the necessary data to map the box to your PBX (you can find the required data in the email we sent you):

    • Your company name

    • PBX domain name

    • Simple Token key

      Image Added
  • Once the mapping process is completed, you can proceed to the further setup

    Image Added
Tip

You can always verify which PBX your particular box is mapped to by following this link:

Step 2. Creating users

  • Access WMS and navigate to Users menu

  • Create user profiles for each individual who will be using x-hoppers

...

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to create users can be found in WMS Start Guide, “Adding users manually” section.

Step 3. Assigning users to the Headsets

  • Navigate to Devices menu, W-AIR devices tab

  • Associate each user with their respective W-AIR Headset

...

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to assign W-AIR Headsets can be found in x-hoppers Admin Guide, “Assign headsets to PBX users” section.

Step 4. Configuring settings for demonstration

  • Navigate to Dialplan menu, Dialplan rules tab

  • Download and import the following Dialplan procedures in Dialplan rules tab

    • View file
      name"XHoppersHelpPoints" and "clickcollect" Dialplan procedures.bkp
      - required for playing notifications for x-hoppers users if one of the help points is triggered and demonstrating click and collect scenario

...

  • View file
    name"ChatGPT" Dialplan procedure.bkp
    - required for ChatGPT Integration

  • Modify the users Dialplan by adding *Wairhotline*as a called number

  • Add the following Dialplan applications:

    • Set -> Language -> choose language

    • Speech to text -> insert Please unmute and say question for Chat GPT, or wait to join the broadcast or any customized text

    • Jump to if -> "${RECOGNITION_RESULT}"="question" -> ChatGPT procedure

    • Play sound -> click Browse (three dots) and choose the sound to be played on joining the broadcast or create it dynamically using TTS, for example Welcome to x-hoppers, joining the broadcast

    • Conference -> enter the conference room ID number. This can be any number, e.g. 1, 2, 3, etc

...

Tip

If you need to customize Dialplan procedures to your specific language, install a dedicated sound package that corresponds to your language in WMS Settings -> PBX -> Language & Region and make changes for the following Dialplan applications:

  • Set -> Language

  • Play sound

  • Speech to text

  • Navigate to General Settings tab, under Set dialplan variables, set the following variables and click Save button:

    • HelpPoint1=Help point 1 is triggered. Customer is looking for help in fresh fruits area

    • HelpPoint2=QR 2 is scanned. Customer is looking for more info about Workforce phone

...

Tip

With the variable HelpPointX, where X is a help point ID, you can customize the content of audio alerts sent to users and create any additional help points if needed. Please note that Help points 1-10 are preserved so you need to start adding from HelpPoint11.

  • Navigate to Call Groups tab and create a new call group specifically for handling assistance requests triggered by QR codes (it is needed for Help point 3 scenario). Make sure to activate Call waiting option when configuring the Call group strategy, so its members can receive more than one call at a time (consult the documentation for detailed guidance on how to create Call groups)

  • Proceed to Dialplan rules tab and select kite Dialplan procedure

  • Add 223344 as the called number and Call group Dialplan application to the chosen number

  • In the Call Group application settings, select the call group that you created

...

  • Log in to x-bees and create x-bees conversation with all the users that are participating in x-hoppers conference and also needed managers. In the next step, you will need to copy its ID

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on how to create x-bees conversations can be found in x-bees User Guide, “Conversations” section.

...

  • To gather and post transcriptions of conversations, use these commands in Terminal:

    • create directory /etc/systemd/system/pbx-data-engine.service.d

      Code Block
      # mkdir /etc/systemd/system/pbx-data-engine.service.d
    • add the following key to the file 

      Code Block
      # vi /etc/systemd/system/pbx-data-engine.service.d/override.conf
       
      [Service]
      ExecStart=
      ExecStart=/usr/sbin/pbx_data_engine.py --daemon --mode calls presence -cr
    • add the following data to /rw2/etc/pbx/x-hoppers.json file

      Code Block
      [
        {
          "audio_conf_id": "2",
          "xbees_channel_id": "f6d17593-98b6-471d-941a-cd03153f"
        }
      ]
      • audio_conf_id: ID of the audio broadcast channel in x-hoppers where the communication takes place

      • xbees_channel_id: ID of the x-bees conversation, where the content will be posted

    • reload systemd and restart the service to apply the changes:

      Code Block
      # systemctl daemon-reload
      # systemctl restart pbx-data-engine

Step 5. Installing W-AIR firmware to receive incoming calls

  • Download the firmware package: https://packages-deb.s3.eu-central-1.amazonaws.com/wms-wildixair-firmwares_6.04.20230926.1~786e2dc8_all.deb

  • Upload the package from your PC to the PBX using the FileZilla tool (SFTP) or the console

    Code Block
    scp -P2222 WAIR-HS_v0829_b1218.fwu admin@pbx_domain.wildixin.com:/home/admin
    • admin@pbx_domain.wildixin.com -> insert your PBX domain name

  • Access home/admin directory

    Code Block
    cd /home/admin/
  • Unpack the package

    Code Block
    dpkg -i WAIR-HS_v0829_b1218.fwu
  • Navigate to WMS Devices menu, select the W-AIR Base Station and click Configure / Sync device

  • W-AIR Headsets start updating, you can check the status on the Base station’s web interface

Panel
panelIconId1f4d7
panelIcon:green_book:
panelIconText📗
bgColor#E3FCEF

Note: Detailed description on W-AIR Headsets firmware update can be found in W-AIR Headset User Guide, “Update of the Firmware” section.

How to perform the Demo 

During a demonstration of x-hoppers, you can present both basic and advanced scenarios to showcase the system's capabilities. Basic scenarios involve scanning QR codes or using tablets and utilizing x-bees for gathering and posting content, while advanced scenarios showcase integration with Veesion and ChatGPT, taking communication to the next level.

Tip

To showcase tablet scenarios, you do not need to have an actual tablet, you can use a web version by using the link:

Joining the broadcast

The broadcast is the core functionality of x-hoppers, it refers to the network created by the system that enables real-time communication between x-hoppers users (retail assistants).

...

To demonstrate:

  • Trigger QR code 1 3 or follow the link designed for tablets https://x-hoppers-tablet.wildix.com/?box_id=X&key=X&action_id=3 (insert your own box_id and key instead of X)

  • Upon triggering the help point, the system redirects customers to Kite web page

  • After entering customer’s name, a call is placed automatically to a pre-configured call group

  • Retail assistants within the call group receive the call and are alerted to the customer's request for assistance

  • Double-press the Call button to answer the call, double-press the AUX Function button to finish the call

Help point 4. Click and Collect (optional)

...