Overview

This document describes the Swyx component in Presence Hub.

Prerequisites

The following components/data are needed and must be configured to use the Swyx component:

1. Presence Hub Connector application
   An additional application is required, which is installed locally and performs the presence synchronization with Swyx.
   --> Please contact aurenz to get the client application.

2. Windows computer
   A Windows computer is required on which the Presence Hub Connector can be installed. This computer requires a connection to Swyx and an internet connection.
   A SwyxIt! client, which is available exclusively for the Presence Hub Connector, must also be installed on this computer.
   Note: One option is to install the Presence Hub Connector on the same computer as Swyx.

3. Local Administrator user for service
   The user used for the Precense Hub Connector service must be a member of the local Administrators group or be included in the "Launch and Activation Permissions" in the Security tab.

4. Swyx User
   In Swyx a user is required who can log in to a SwyxIt1 client.
   The Swyx user needs an internal phone number to monitor the presence state.

Quick Start

This chapter guides you through a quick set up of a Pbx Connector for Swyx. You will use the default settings (which you may change later) and an installation up and running quickly.

Step 1 - Read the Prerequisites

Please read the Prerequisites (see above) and then continue.

Step 2 - Add a Pbx Connector for Swyx

Open the Configuration in the Presence Hub and press “+ Add Pbx” in section Pbx Connectors.

Open

Use the following selection and then press “Update”:

• Name: You can give any name here.

• Description: You can give any description here.

• MainType: Here you have to select Swyx.

• Type: Swyx v2.1 - DND only for active conversations

Open

Step 3 - Download the Pbx Connector configuration

Select the just added Pbx Connector and press “Keys”.

Open

A dialog will appear where you can download the configuration by pressing "Download pbx connection strings".

Open

The file will be needed to configure the Presence Hub Connector.

Note: If your browser is blocking the download, please allow it.

Open

Step 4 - Prepare Windows Computer

We need a Windows computer for the Presence Hub Connector where SwyxIt! client is installed.

Please install the SwyxIt! client on the computer and and configure it. Especially login to the SwyxIt! client with the user you later use in Presence Hub Connector. It is necessary that the user can log in to the SwyxIt! client.

The next step is to close the SwyxIt! client and remove the SwyxIt! client from the autostart group.

DCOM configuration

To configure the DCOM settings manually, proceed as follows:
Start the Component Services management console with administrative privileges by opening a command prompt with administrator privileges and running the dcomcnfg command. Navigate to "Console Root > Component Services > Computers > My Computer > DCOM Configuration > CLMgr." For "CLMgr," open "Properties" and under "Identity" enter "The user who launches the application".

Open

Step 5 - Install Presence Hub Connector

The next step is to install the Presence Hub Connector on a Windows computer.

You have received the installation package to install the Presence Hub Connector. Install the software by execution the Setup.exe.

An installation wizard appears which guides you through the installation. Simply press Install and the software will be installed.

Open

After successful installation, "Installation Completed" appears. Now press "Launch" and the application will start and you can complete the configuration.

Open

Step 6 - Configure the Pbx

Start the Presence Hub Connector application.

Note: To install the application as a service, please start the application using "Run as administrator".

Now press "Add" and in the sub-dialog press "Load Azure configuration (pbx.config.json)" and select the previously downloaded "pbx.config.json".

Open

The parameters will now be filled in. Now click "PBX configuration" to configure the connection parameters for Swyx.

By pressing “Test” you can check if the connection can be established (the version of the Swyx should be displayed) or an error message will appear.
Note: A DOS box may appear which you can close.

If the connection is successful press “Save”.

Open

If you have already configured endpoints in Presence Hub - when pressing “Azure WebService interface test” the field “Extensions” will list the endpoints.

In the example below only 1 endpoint with the extension 18 is configured.

Open

Step 7 - Install as service

Now the application has to be installed as a service.

Note: To install the application as a service, please start the application using "Run as administrator".

Select the option “Use defined user” and add the credentials of the service user (Note: Don’t use “Local Service” as this will not work!) and press “Install service” and then “Start service”.

The Presence Hub Connector is now configured and running.

Open

Pbx Connector

In order to synchronize the presence status with Swyx, a Pbx Connector must be configured.

Type of mapping

Because of the different requirements about how customers expect the presence status to be synchronized, we provide several (what we call) mappings (mapping: what should happen in the other communication system when when a status event arrives). You can choose which mapping suits your needs.

The mapping can also be changed later (anytime).

The mappings are:

Swyx v2.1 - DND only for active conversations

An Outlook event is no reason to set PBX status to DND. Set DND only if Teams activity is InAMeeting, InACall, InAConference or Presenting. That means only if one is in an active conversation.

Endpoints

The assignment of the Endpoints between Microsoft Teams user and Swyx user is based on extension.

To configure the Endpoints you have to log in to Presence Hub and select Configuration in the menu.

Steps to sync Endpoints

The configuration of the Endpoints is described in the following steps:

Step 1 - Adding Endpoints

It must be configured which Microsoft Teams users should be synchronized with Swyx. Press the “+ Add User manually” button and a list with the available Microsoft Teams users appears.

Open

From the list select the Microsoft Teams users you want to be synchronized and press “Add selected users”.

Open

The users will then show in the Users list.

Step 2 - Edit Endpoints

An endpoint must be assigned to the users added.

If the column “Endpoints” is empty there is no endpoint currently assigned. To assign one press the “Endpoints” button on the row and fill in the extension in the “Endpoint” field.

Open

Open

Step 3 - Enable Sync

To sync the presence status, this must be activated for the Endpoints.

In the Users list select the Endpoints (you can select one or more) you want so sync then select from the action drop-down “Enable sync for selected user(s)” and pres “Apply action for selected user(s)”.

Open

The user(s) will be displayed as Sync enabled.

Open

At this point for the Sync enabled users the presence status will be synchronized.

Tips and Tricks

Info Log

In the Info Log you will see the changes made to the system/configuration (e.g. adding a Swyx endpoint; changing “Sync enabled”; …).

Open

Log

In this Log you will see the status events, the used mapping and the executed reaction.

This is useful when analyzing some behavior. The list is sortable and filterable. Please press Refresh to see new entries.

Open

Presence Hub Connector Monitor

You can always open the Presence Hub Connector application which gives you information about the status.

To get detailed information about the operations press “Monitor” which will open a window with the logs. Here you can especially check if the connection to the Swyx and Azure works.

Open

Drill down problems in the monitor

No problems - everything works fine

If everything works fine the monitor should like this:

• A line with the extensions to monitor

• A line with “StartPbxMonitor - started: True”

Open

In Teams changed from Available to DND

In the screenshot below the presence in MS Teams was changed from “Available” to “DND”. You can see that DND was received.

Open