View source for Siemens Sivelliance - ICX-AlphaCom Integration

{{AI}}
<table style="float:right; max-width:80%; border-style: double; border-color: #c7c7c7;">
<tr style="rowspan:2;">
<td style="display: block; vertical-align: bottom;">[[Image:Siemens Sivelliance_ICX-AlphaCom.png|400px]]</td>
</tr>
<tr>
<td style='background-color:#efefef;'>Siemens Sivelliance - ICX-AlphaCom Integration</td>
</tr>
</table>

==Introduction==
The interface between ICX-AlphaCom and Siemens Sivelliance VMS is through an [https://alpha.zenitel.com/downloads/Siemens_Siveliance_ZenitelCallHandlerSetupIcxAlphaCom_3.0.6.msi integration module] which is available on the [[Downloads#Interface_modules|Downloads page]] of Zenitel Wiki. 

This integration requires a Zenitel desktop station or SoftClient to be associated with each Sivelliance Video Client, as SIP audio is routed through ICX-AlphaCom.

This article assumes that the reader is:
*familiar with setup and operation of the Siemens Sivelliance VMS
*that the Siemens Sivelliance VMS is operational, with all to the system connected cameras configured
*that ICX-AlphaCom is operational, with all the system connected intercom devices and SoftClients configured

Only points which are specific to this integration and to connected intercom stations/SoftClients and IP speakers are described.
<br>
<br style="clear:both;" />

==Licensing==

===Siemens Sivelliance ===
The integration interface does not require a specific license from Siemens.

However, note that Zenitel stations are typically registered as ONVIF devices in Sievlliance, to e.g. stream and record audio/video from stations. This requires separate station licenses from Siemens.
For an overview of the ONVIF features supported in Zenitel devices, please read our article [[ONVIF Settings]]

===ICX-AlphaCom===
ICX-AlphaCom gateways requires the presence of the appropriate API/OPC license: 
*1002602306 - ILI-API64 - API License Supporting 64 Intercom Stations
*1002602309 - ILI-API512 - API License Supporting 512 Intercom Stations

With ICX-AlphaCom it is possible to purchase a single Product Key which covers all stations connected to all ICX-AlphaCom's in a network. Licenses can be stacked, i.e. 1x 1002602306 + 2x 1002602309 gives 1088 API licenses which can be used on 2 or more ICX-AlphaCom's.

Note that the licenses are based on the number of intercom stations, not the number of gateways and servers. Thus, 1 API license can be used across multiple networked ICX-AlphaCom gateways and Siemens servers. 
The license is independent of the number of Sievlliance Video Clients.

If the Zenitel SoftClient is to be used for SIP audio directly in the Sievlliance Video Client you will need 1 SoftClient license (item number 1002600300) per Operator computer.

<!--===AlphaCom XE===
AlphaCom XE requires the presence of the appropriate API/OPC license, depending on the number of intercom stations connected to ICX-AlphaCom. Note that every AlphaCom XE in an AlphaNet requires such a license.
*1009649901 - STENTOFON API License Supporting 40 Stations
*1009649902 - STENTOFON API License Supporting 80 Stations
*1009649903 - STENTOFON API License Supporting 160 Stations
*1009649904 - STENTOFON API License Supporting 240 Stations
*1009649905 - STENTOFON API License Supporting 320 Stations
*1009649906 - STENTOFON API License Supporting 400 Stations
*1009649907 - STENTOFON API License Supporting 552 Stations

If the Zenitel SoftClient is to be used for SIP audio directly in the Siemens Sivelliance Video Client you will need 1 SoftClient license (item number 1002600300) per Operator computer.
<br style="clear:both;" /> -->

==Installation==
This section describes how to install the integration plugin.
It is assumed that the Siemens Sivelliance VMS has been installed and is running. It is also assumed that the Siemens Sivelliance VMS has been licensed appropriately.<br>

*When installing (or uninstalling) the plugin all Sievlliance Video Clients (Sievlliance Management Client and Sievlliance Video Client) must be closed.
*The plugin is to be installed on the same machine as the Sievlliance Video client.

#[https://alpha.zenitel.com/downloads/Siemens_Siveliance_ZenitelCallHandlerSetupIcxAlphaCom_3.0.6.msi Download the msi setup file] from the Downloads section on Zenitel Wiki.
#Run the setup file, and follow the instructions on the screen
#When prompted for the installation location, select the Siemens/MIP installation folder (e.g. C:\Program Files\Siemens\MIPPlugins).
#Click "Close" to complete the installation.<br>
<br style="clear:both;" />

== Configuration ==
===Basic plugin configuration===
#Open the Sievlliance Video Client.
#Open the "Configuration" window by clicking the "Configuration" Icon button in the toolbar.
#In the "Configuration" window enter the IP address and port number of your Zenitel intercom system in the "IP Address" and "Port" fields, respectively.
#Click the "Connect" button and wait for the system to retrieve the list of available devices.
#Select the operator's device by choosing its directory number from the drop-down list.
<br>
{{warn|When using  the [[Milestone_XProtect_-_ICX-AlphaCom_Integration#Broadcasting_.28available_from_Plugin_Version_3.0.6.29|Broadcasting]] feature, the operator station should not be an ITSV-2, ITSV-3, ITSV-4 or ITSV-5}}

[[File:ZenitelCallHandlerConfigurationGif_306_Siemens.gif|thumb|center|800px|Animation of the Zenitel Cal Handler configuration process]]


<br>
===Associating cameras with devices===
# Open the camera settings window.
# On the left side, there will be a list of devices registered with ICX-AlphaCom. On the right side, there will be a list of cameras registered within the Sievlliance system.
# Click on a device in the left list to select it.
# Click on an item in the right list to preview the video feed from that camera.
# To associate a camera with a selected device, click on the checkbox next to the camera's name.
# Repeat steps 3-5 to associate additional cameras with the selected device.
# Once satisfied with the configuration, close the camera settings window.
# Click "Save and Close" on the configuration window to save the changes.
<br>
[[File:ZenitelCallHandlerCameraConfiguration_306_Siemens.png|thumb|center|800px|Screenshot of the camera assosiation process]]


<br>
===Groups configuration===
To enable live announcements and prerecorded message broadcasting, you'll first need to configure the groups. <br>
To do this, you'll require access to the AlphaPro software, and then you can proceed with the following steps:

<br>
1. Open the AlphaPro software and follow these steps to export the groups csv file:
[[File:ZenitelCallHandlerExportGroups_306.gif|thumb|center|800px|]]
<br>
2. Return to Siemens Sivelliance and within the Zenitel Call Handler, navigate to the 'Broadcasting' tab.
<br>
3. Follow these steps to import the groups list file exported from AlphaPro into Zenitel Call Handler:
[[File:ZenitelCallHandlerImportGroups_306_Siemens.gif|thumb|center|800px|]]
<br>
4. Return to the AlphaPro software and follow these steps to configure the necessary events for group UI to function properly:
* Open '''Exchange Information -> Events''' 
[[File:ZenitelCallHandlerEventsConfig.gif|thumb|center|800px|]]

* then '''Insert''' two new records with the following information:
[[File:ZenitelCallHandlerEventConfig_1_306.JPG|thumb|center|650px|<table style="border-style: double; border-color: #c7c7c7;">
  <tr>
    <td>Owner type</td>
    <td>'''Stations w. UDP'''</td>
  </tr>
 <tr>
    <td>Id</td>
    <td>8</td>
  </tr>
 <tr>
    <td>Event Type</td>
    <td>'''8 - Conversation - Outgoing'''</td>
  </tr>
 <tr>
    <td>Sub Event</td>
    <td>0</td>
  </tr>
 <tr>
    <td>When Change To</td>
    <td>'''ON or OFF'''</td>
  </tr>
 <tr style="rowspan:2;">
    <td>When Related To</td>
    <td>'''All'''</td>
  </tr>
 <tr>
    <td>
For the section '''Action: Command or RCO''' <br> 
select the first option and type this command<br> 
in the text box
    </td>
    <td>'''@*d1 M7F01 %1.ref %2.ref W%chg(1,0) W0 W0 W0 W0'''</td>
  </tr>
</table>]]

<br>

===Configuration of prerecorded messages===
In the message configuration window, the user needs to provide the message's name and the corresponding directory number.
[[File:ZenitelCallHandlerBroadcastMessageConfigWindow_1_306.JPG|thumb|center|800px|Prerecorded message configuration window]]
{{note| Add the '''L''' character before the directory number. example '''L8194'''}}

You can get the message directory number in the ICX-Web
[[File:ZenitelCallHandlerICX-Web-PrerecordedMsg_DirNo.JPG|thumb|center|800px|]]


<br>

==Using the Call Handler==
The Zenitel Call Handler (ICX-AlphaCom) plugin can be used for two scenarios: initiating calls and handling incoming calls.

Note that SIP audio is routed through ICX-AlphaCom, so audio calls and audio broadcasts are established on a Zenitel desktop station or softclient.

If the Operator uses a desktop station, the Call Handler transfers the call from the Sievlliance Video Client to the desktop station where the operator gets audio through the station connected handset, speaker or headset.

If the Operator uses the Zenitel softclient, the Call Handler transfers the call from the Sievlliance Video Client to the softclient, which runs in background on the PC, and the operator gets audio through the PC connected microphone, speakers or headset.

===Initiating Calls===
In Sievlliance Video Client on the Zenitel Audio tab select a device you wish to call and click on the green "Answer/Call" button.<br>
A popup window will be displayed showing the active call, along with a video preview from an associated camera.
<br>
[[File:ZenitelCallHandlerOperation1_306_Siemens.png|thumb|center|800px|Screenshot of popup window displaying the active call and associated camera]]


<br>
===Answering queued Calls===
# When an inbound call is received, a popup window will be displayed showing the queued call, along with a video preview from an associated camera.
# To answer the call, click the green "Answer/Call" button.
# If there is an active call, the Call Handler will automatically hang up the active call and answer the inbound call.
# If there are multiple queued calls, they will be displayed in order of priority. To answer a specific queued call, simply click on the green "Answer/Call" button.
<br>
[[File:ZenitelCallHandlerOperation2_306_Siemens.png|thumb|center|800px|Screenshot of popup window displaying the active call and his associated camera with two queued calls]]


<br>
===Tracking calls meant for a different operator===
You can determine if a station is busy by checking the device list. 
If another operator has initiated a call, the current user will be informed about which operator and station are engaged.
Notably, there will be no popup window displayed in this scenario.
[[File:ZenitelCallHandlerOperation3_306_Siemens.png|thumb|center|800px|Two stations busy but the operator is not involved]]


<br>
===Using the Popup Window===
* The popup window displays the active call (if it was initiated by the operator) or a list of queued calls, along with a video preview from an associated camera.
* The popup window will display the camera feed from the first associated camera of the active call (if present) or if there are no active calls, the first queued device-associated camera will be displayed.
* To manually switch the camera video feed to any active or queued device, select the desired device from the dropdown list in the popup window.
* To hang up the active call, click the red "Hang-Up" button.
* To answer a queued call, click the green "Answer/Call" button.
* If there are multiple queued calls, they will be displayed in order of priority. To answer a specific queued call, select it from the dropdown list in the popup window.


<br>
===Broadcasting===
{{note | Prior to utilizing the features in the broadcasting tab, please ensure that you have configured groups, as explained in the '''Groups configuration''' section of this page.}}

====Live announcements====
The user will be presented with a list of all available groups. <br>
From this list, the user can make a selection to interact with a particular group by simply clicking either of the two buttons: "Live Announcement" or "Prerecorded Message."
[[File:ZenitelCallHandlerBroadcastView_306_Siemens.png|thumb|center|800px|Broadcast tab view]]

<br>
Notably, if any group is currently engaged or busy, both buttons will be displayed in a distinctive red color to indicate the unavailability of the group. <br>
This visual cue helps users quickly identify the status of the chosen group.
[[File:ZenitelCallHandlerGroupBussy_306_Siemens.png|thumb|center|800px|Example of a busy group]]

<br>
When the user clicks on the "Live Announcement" button, a new window will appear, providing the user with essential information about the selected group. <br>
Within this window, the user will have access to the following controls:

1. Stop Live Announcement Call: This button allows the user to halt the live announcement call in progress.

2. Mute/Unmute Operator Microphone: Users can control the operator's microphone by toggling between mute and unmute states. <br>
It's important to note that the initial microphone state is set to mute, ensuring a silent start for the operator's microphone during the live announcement.
<br>
[[File:ZenitelCallHandlerLiveAnnouncementWindow_306_updated.png|thumb|center|800px|Live Announcement Window]]


====Broadcasting prerecorded messages====
{{note | Before using prerecorded messages, it's essential to upload WAV audio files to the ICX-AlphaCom system. For more information, please refer to the [https://wiki.zenitel.com/wiki/ICX_Web#Messaging ICX web Messaging]}}

When the user clicks on the "Prerecorded Message" button, a new window will appear, providing the user with vital information about the selected group and controls for broadcasting prerecorded messages to that group. Within this window, the user can:

* Select a prerecorded message.
* Choose whether to play it once, repeat it indefinitely (until manually stopped), or repeat it a specific number of times.
* Configure message settings using the "Configure" button, which opens a new window for message setup.
[[File:ZenitelCallHandlerBroadcastMsgWindow_306_Updated.png|thumb|center|800px|Prerecorded message control Window]]

<br style="clear:both;" />

[[Category:3rd party integration]]