innovaphone wiki - User contributions [en]

Howto13r1:Hosting - Dedicated AP for every customer

2024-07-16T16:48:27Z

Thomas.hiltbrunner: /* of the AP */

==Applies To==
This information applies to

* V13



=The Idea=

This description is to simplify the installation of "one PBX and one Application Platform per customer" that can be used for Cloud setups

* Starting with the download of the images from our store,
* doing a set-up, based on the environment of the hosting platform
* copy a template (1 x IPVA; 1 x AP)
* finalising the set-up of admin devices (central Devices App, Revers Proxy, NAT)
* finalising the configuration of templates
* copying the template to a customer system

If you set up a Hosting scenario, please check our [http://wiki.innovaphone.com/index.php?title=Howto:V13_Hosting Considerations]

==Configuration we used in the setup==
In the example we use the following options: 
'''It is important to use a Subdomain, to be able to create later on for every customer their own DNS 00001.cloud.de and insert it to your Devices App.''' 
Domain: admin.cloud.de 
DNS PBX: admin-pbx.cloud.de 
DNS AP: admin-apps.cloud.de 
Folder: 00-AP and 00-IPVA 

For the first customer: 
Domain: 00001.cloud.de 
DNS PBX: 00001-pbx.cloud.de 
DNS AP: 00001-apps.cloud.de 
Folder: 01-AP and 01-IPVA 

=Download respective images=

Select in the [https://store.innovaphone.com/release/download.htm innovaphone store]

* Firmware / IPVA
* App Platform / App Platform x86_64
* Download Package

=Install images on virtualisation platform=
Installation of the above images on the virtualisation platform.

For example:

* on vmWare, use the files with extensions *.ovf (vSphere Client > file > deploy OVF template ....)
** Network Configuration of IPVA thru vmware console [https://wiki.innovaphone.com/index.php?title=Reference12r1:Concept_Innovaphone_Virtual_Appliance#What_Is_The_Console_Good_For.3F Reference12r1:Concept Innovaphone Virtual Appliance]

* on Hyper-V, use the files with extensions *.vhd (Hyper-V Manager > ....) 

=Initial Set-Up=

==of the IPVA==

In order to run the IPVA we suggest the following configuration, which has to be done manually via the PBX console: 
This IP address should be available and not in use by anything else!

[[login: admin / ipva]]
* config change DHCP0 /mode off * config show DHCP0 * config change IP0 ETH0 /addr 172.99.1.1 /mask 255.255.0.0 /dns 1.1.1.1 /dns2 1.0.0.1 * config show IP0 ETH0 * config change IP0 RT0 /gateway 172.99.0.1 * config show IP0 RT0 * config change NTP0 /addr 172.99.0.1 /alt-addr 172.99.0.2 /interval 60 * config show NTP0 * config change SYSCLIENT /sysadmin ws://admin-apps.cloud.de/admin.cloud.de/devices/sysclients * config write * reset

==of the AP==
Configuration via console of the respective virtual platform client:

[[login: root / iplinux]]
* loadkeys de * setip --addr=172.99.1.10 --mask=255.255.0.0 --dns1=1.1.1.1 --dns2=1.0.0.1 --gateway=172.99.0.1 * ifconfig * exit

Connect to Application Platform via Web (Standard Password: pwd) and insert to Settings > Devices app URL

ws://admin-apps.cloud.de/admin.cloud.de/devices/sysclients

'''Create template before you run through the Installer!''' 

=Create a Template =

This template will serve in a later stage as a pair of devices, to produce a preconfigured customer setup. The customer then, runs the installer on this copy, to finalize the own installation.
* Copy 00-IPVA --> IPVA Template
* copy 00-AP --> AP Template

=Setup of Admin Devices=
* Set another fix IP for your IPVA and AP (not the one you already used for the template)
* Delete sysclient Info in Devices and AP.
* Click through Installer of IPVA (as learned in the training)
* During Install process connect to Application Platform

=Create your first customer PBX=
*Connect to your devices
*Add customer domain and password (pwd)
*Don't choose the flag "Deploy the domain password on all devices" (Noch mal überprüfen!)
*Rename new PBX and new AP
*Insert IP for IPVA via Advanced GUI
*Insert new IP for AP via console

==Install customer PBX and AP==
Insert the following line into your browser: (adjusted to your needs)

Example: http://00001-pbx.cloud.de/install.htm?domain=00001.cloud.de&apaddr=172.16.115.46&apdns=00001-apps.cloud.de&pbxloc=master&location=master 
Explanation: 
'''00001-pbx.cloud.de''' - DNS of first customer PBX 
'''00001.cloud.de''' - Domain/System Name of first customer PBX 
'''apaddr=172.16.115.46''' - IP of App Platform 
'''apdns=00001-apps.cloud.de''' - DNS of App Platform from customer PBX 
'''pbxloc=master''' 
'''location=master''' - Choose master or slave depending on your scenario. 

Click through Installer.

[[Image:CloudSetup.png]]

'''Be sure to use this URL!''' If you don't use this URL and use our normal Installer than your new installed IPVA, AP will not have any Devices App due to the already set sysclient.
This is on purpose for other scenarios.

== Related Articles ==
*[[Howto:V13_Hosting]]
* [[Reference13r1:Concept_App_Platform]]
* [[Howto:V13_Hosting_-_Central_AP_for_multiple_customers]]
* [[Reference13r1:Concept_Talking_to_the_v13_Application_Platform_using_PHP]]

[[Category:Howto|{{PAGENAME}}]]

Reference9:Concept Operator

2021-10-19T14:42:44Z

Thomas.hiltbrunner: /* How to obtain logs with Operator Application */

[[Category:Concept9|{{PAGENAME}}]]
[[Category:Concept|{{PAGENAME}}]]
=Applies To=
This information applies to
* innovaphone Operator V9

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*at least Windows 7 (and higher) - Windows Vista & Windows XP '''may''' work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8.
*A busy lamp field(busy field, BLF) is the main addendum to the application.
**Condensed user information: Display Name, Number, PBX
**An entry's context menu allows to reveal detailed user informations for an entry
**Colored User status: available(registered & not engaged in a call), engaged in a call, not registered
**Symbolized presence status: presence activity, presence note(as tooltip)
**Display options for the BLF window
***within the main window
***within a separate window
***within a separate window on a 2nd monitor
**Two different entry layouts can be selected in three different sizes(small, medium, large)
**Freely placeable labels
<hr>
*Simplified usage
**Drag&Drop or keyboard-only usage possible
**main functionalities (accept call, initiate call) just with ENTER
**direct dialing without search / just use number
**Blind transfer eased - just use '+'
<hr>
*Search
**Full text search
***Fast, now the application default
***Targets large-scale installations
***Indexing: Long Name, Name, Number, Groups, PBX/Location
**Ldap search
***Support for Active Directory's attributes "department", "description"
***"department" offers button to search for alternative destinations within a department
**Pbx search
***"group" offers button to search for alternative destinations within a group
***Email integration, send notification on missed calls
**Individual PBX can be excluded/barred from the operator's search view
<hr>
*Call Switching
**Symbol indicating external calls
**Park+Wait functionality for blind-transferred calls towards busy internal destinations.
**Allows for operator procedure: ''The extension is busy. Do you want to wait?..''
**Blinking indicator for parked and muted calls
**Outgoing calls can be placed without paying attention to call diversions
**Call diversions can be manipulated from operator (if access right is granted)
**Call journal with simplified and detailed representation (successful, missed, transferred, etc.). Cyclic storage of max. 300 calls.
<hr>
*Miscellaneous
**Alternative layout
**Nightswitch supported in GUI
**Secured access (HTTPS/TLS)
**Call context for currently active incoming call.

=Download=
* The software can be downloaded from the ''apps'' section: http://download.innovaphone.com/ice/9.00/#apps

=Application History=
The hotfix history can be found [[Reference9:Release_Notes_Operator_V9|in the operator 9 release notes]]

=Full Text Index=
One shortcoming of the predecessor application was the confinement to search for PBX users either ''by name'' or ''by long name'' only. The Operator 9 therefore offers the new search capability ''by full text index''.

The full text index was implemented application-local. That is, that index is not going to be maintained by the PBX, but by the Operator application itself in-RAM. Thus, making full text queries lightning fast.

The full text indexed is supposed to scale well within large installations. In contrast the busy lamp field is expected to be operable with up to ~300 pbx users.

Administrators must keep control of what is going to be fed into the index. This task must be accomplished by configuration of regular group memberships within a PBX. As a quick exemplary rule of thumb:
*Make the operator's PBX object an active member of a group e.g. "soap". Make all other user objects that shall be indexed (non-active) members of the same group "soap".

'''What is indexed?''' 
*Name
*Long Name
*Display Name
*Number
*Node number + number
*Groups
*PBX

=Busy-Field=

==Layout==
A screenshot featuring some numbered screen elements, explains the BLF's makeup.
[[Image:op9-bf-overview.jpg|center|thumb|200px|Overview, Operator 9]]
*1)BLF entry
*2)BLF label
*3)Thumb for menu panel
*4)Menu panel(slid out)
*5)Selector for BLF display as separate window or within main window
*6)Selector for the layout of BLF entries
*7)Erase button for selected BLF entries/labels
*8)Button to initially show the BLF
*9)Example of a BLF entry with a presence symbol

==Arranging Entries==

*Create a free line
**Select 2x entries
**Drag the selected entries onto some other entries
**All entries within the target line and all lines below are going to be moved downwards.
[[Image:op9-bf-edit-freeline.jpg|center|thumb|200px|Create a free line]]

*Adding a label
**Right-Click into a free location
**A context menu appears - select ''Add Label''
**A label is going to be placed.
**Left-Click into the label, in order to edit the label's text.
[[Image:Op9-bf-add-label.jpg|center|thumb|200px|Adding a label]]

*Changing the position of a single entry
**Left-Click the entry and keep the left mouse button pressed.
**Drag the entry into its new position.
**Drop the entry by releasing the mouse button.
In case of an entry already occupying the new position, the two entries are going to exchange their positions.
[[Image:op9-bf-xchng-entries.jpg|center|thumb|200px|Changing the position of a single entry]]

*Changing the position of multiple entries
**Left-Click into a free position and keep the left mouse button pressed.
**Open up a selection rectangle. Entries intersecting with the rectangle are going to be selected.
**Release the left mouse button.
**Left-Click onto one of the selected entries and keep the left mouse button pressed.
**Drag the entries into their new position.
**Drop the entries by releasing the mouse button.
In case of one or more entries already occupying the new position, the entire lines containing those entries and the lines below are going to be moved downwards.
[[Image:Op9-bf-xchng-bulk.jpg|center|thumb|200px|Changing the position of multiple entries]]

=Configuration=
This section hilights a few key concepts of the Operator configuration. A few prerequisites must be considered.
*The operator's phone must be configured, such that ''call waiting'' is enabled. This is important, because of situations whith more than one call being active at the phone. Some such scenarios may be obvious: operator user is engaged in a call while an internal caller is trying to directly call through to the operator's desk. Some such scenarios aren't obvious. For instance the operation to unpark a call may often coincide with a call just being signalled by a waiting queue towards the operator's phone.
*Within the PBX the value '''PBX/Configuration/General/Recall Timeout''' should be set to a value greater than 0 seconds. Otherwise the call list ''Transferred Calls'' will remain empty and unaccepted blind transferred calls will never fallback to the operator.
==General==
The application is going to establish at least two Soap sessions. One for the operator user's identity. And one for the query user's identity.

The first session is needed in order to receive call informations for the operator user's phone. This session will be established only at the PBX configured under '''IP Address'''.

The second session is needed to receive user informations for all PBX user objects that shall be full text indexed. It is also needed for all PBX user objects that shall appear within the busy field. The Operator is going to establish this session type at every known PBX.
*'''Query User''' As a rule of thumb
**Create a user object ''_TAPI_'' (or ''SOAP'') on all PBXs within the network of PBXs (if Slaves are replicated from a Master, just create this user at Master without assigning it to a PBX).
***The user ''_TAPI_'' must be an active member of a group ''tapi''(or ''soap'').
**All other users (also the ones at Slave PBXes) that shall be full text indexed must become a non-active member in the group ''tapi''.
**In case of slave scenarios, the slavePBX object at Master itself needs to be part of that group. '''Note''': This will not work when having "sub-slaves" being registered to slaves itself.
**A dedicated PBX as search base can be selected via the drop down menu in the search area. Typing "." in the search field opens a pop-up field containing all PBXes.

==WQ (Waiting Queue)==
A WQ teams-up with an operator's phone by a group membership.
*A waiting queue ''wq-reception'' may exist.
*The WQ is an active member of a group ''reception''.
*The operator user is a non-active member of the group ''reception''.

Calls for the WQ are from now on also signalled towards the operator.

<hr>
'''Nightswitch''' 
The nightswitch configuration is just a front-end for the PBX ''Boolean object''. Its actual purpose is to provide a means for a diversion. A diversion that leads callers into an out-of-business-hour announcement. Here is the idea behind:
*A waiting queue ''wq-reception'' may exist and is configured under '''WQ'''.
*Enter the number (55 in this example) towards the out-of-business-hour announcement under '''Diversion'''. It may be the number of a dedicated voicemail object.
*Configure the time definitions for the regular business hours.
**1st: Start 9:00, End 17:00, Mon-Fri
**2nd: Start 0:00, End 0:00, Sat-Sun
**As Mode select Automatic

'''Note''': The automatic mode may be overridden by selecting ''Manual On'' or ''Manual Off'' as mode. ''Manual On'' causes the CFU (see below) to become active immediately and permanently.

What happens behind the curtain is as follows:
*A new boolean object ''wq-reception-nightswitch'' will be created automatically by the Operator app'.
*The boolean object is configured with the time definitions from above.
*A CFU is configured at the WQ ''wq-reception''.
*The CFU will have the number 55 from above as destination.
*The CFU references the Boolean object ''wq-reception-nightswitch'' from above.

The mode selector for the boolean object will be available for the user. Watch out for the WQ calls list.

==Miscellaneous==
===Configuration of the Phone's Conference Facility (Recording-/Greeting Function)===
Every innovaphone telephone offers a tiny conference function. Besides its apparent use, the conference function may be utilized to realize audio recording.
The corresponding configuration page can be found within the phone's web UI under ''Configuration/RegistrationX/Recording''.

Within the context of the innovaphone Operator it may also be used to provide the means for a personal audio greeting. A greeting that is about to played right after an incoming call was connected. For each incoming call over the course of a working-day.

Both scenarios require a voicemail script.

'''Note:''' Only one of the two possibilities can be configured. Either the audio recording or the greeting function. The two cannot be used concurrently.

The following two sub-sections are going to explain the required configuration steps for both scenarios.

===Greeting Function===
A few assumptions are taken into consideration.
*The PBX box offers a CF-card that is up and running.
*A voicemail object is going to listen on number 77.

Deploy the following voicemail script (audio menu in english)
* download [[Media:Greeting.zip]]
* copy onto a CF-card underneath a directory ''greeting''

At the PBX create a new voicemail object
* Proceed to ''PBX/Objects/New Voicemail''
* Enter ''Long Name, Name, Number'' as eg.: ''vm-greet, vm-greet, 77''
* Enter the ''Script URL'' as http://127.0.0.1/drive/CF0/greeting/greet.xml

Configure the recording function at the operator user's telephone
* Proceed to ''Configuration/RegistrationX/Recording''
* Select ''manual'' as ''Mode''
* Enter ''77'' as ''Number''

Within the innovaphone Operator proceed to ''File/Configuration/Misc.''
*''Assignment of the Recording-function'': Choose ''Greeting''
*''Destination Number'': Enter the number (''77'' in this example) that was configured in the phone's web UI underneath ''Configuration/RegistrationX/Recording''.

The audio greeting will start automatically for incoming external calls. The decision which calls are treated as external calls is based on the configuration of ''File/Configuration/LDAP Location/External Line'' (Mostly ''0''). A button will be displayed on-top of the list of incoming calls, if an audio greeting is played. The button allows to stop the greeting.

The audio greeting won't be started for:
* a fallback call, i.e. a call that was blind-transferred, but never connected.
* a call that was unparked
* a call that was refetched from the list of blind-transferred calls
* internal calls

In order to record a new audio greeting
*Just dial the number of the voicemail object (''77'' in this example).
*The script will prompt for a key press on the telephone
*Record the new greeting and stop the recording with another key press on the telephone
*You will be prompted with the new greeting
*End the call (on-hook) - the new greeting will be active from now on.

===Recording Function===
This functionality is actually a reuse of a solution being available since firmware version 6. Please read through the following article:
*[[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail|A Simple Recording Solution On-Top of The innovaphone Voicemail]]

All that's needed to be configured within the innovaphone Operator can be found underneath ''File/Configuration/Misc.''.
*''Assignment of the Recording-function'': Choose ''Recording''
*''Destination Number'': Enter the number that was configured in the phone's web UI underneath ''Configuration/RegistrationX/Recording''.

A recording button will then be offered on-top of the list of incoming calls. The button allows to start/stop recording and serves as an indicator lamp.

== External LDAP-database access ==

innovaphone Operator offers possibility to connect external databases for adress search via LDAP.

Setup is done at File/Configuration tab 'LDAP' by filling appropriate fields for connection data and ldap attributes.

The questionmark-icon opens a help page with some predefined LDAP-profiles for
* innovaphone Contacts (available from operator version 90236)
* Estos MetaDir

Use radio buttons to fill fields.
Connection specific data like server, user and password need to be filled manually.

[[image:operator_ldap_profile.png]]

=== Special settings for LDAP Profile: Estos MetaDirectory 3.5===

This article section will explain how to configure the MetaDirectory to enable full-text search by means of a single LDAP attribue.

In a standard configuration the search within the Operator application is performed according the edit field '''Configuration/LDAP/Name Attributes'''. The list of name attributes defaulted previously to '''company,sn,givenName''' and could be set by means of a profile button within the LDAP inline-help.

A second profile button '''Estos MetaDirectory 3.5''' was added into the inline-help. If that button was clicked, it sets the list of name attributes to a single attribute '''searchContact'''. The ''searchContact'' attribute is kind of a meta attribute, that doesn't physically exist within the LDAP database. It rather serves as a vehicle realizing a full-text query processing whereby multiple physical attributes will be considered by the MetaDirectory.

Which physical attributes are getting queried is subject of an administrative task. As the following screenshot illustrates, the MetaDirectoy's '''Search Assistant''' is the place where an administrator controls the behaviour of the full-text search triggered by the ''searchContact'' attribute. The search assistant allows to check multiple database fields within the column '''Contact search'''. All database fields enabled are going to be considered for the ''searchContact''-related full-text search.
[[Image:Howto fulltext search screen 01.png]]

As can be seen right next to the column ''Contact search'' resides the column '''Number search'''. The same principle applies. However, it is not targeting the attribute ''searchContact'', but the attribute '''searchNumber'''. This is why the edit field '''Configuration/LDAP/Number Attributes''' will be set to '''searchNumber''' when clicking the profile button mentioned above.

*Benefits
**Short and concise LDAP filters are sent towards the MetaDirectory
**Indexed search increases overall query performance

=Configuration, Specialties=
This section covers somewhat advanced configuration aspects.
==Suppress Call Display==
A privacy list may be administrated manually within the operator's configuration file. The purpose is to provide a means for privacy, such that call details won't be visible from within the application.
*Click on the button '''File/Configuration/Misc/AppData'''.
**A Windows Explorer is going to come up, showing the contents of ''C:\Users\<your user directory>\AppData\Roaming\innovaphone AG\innovaphone Operator\''.
*Terminate the operator.
*Open '''swconfig.xml''' witin a text editor
*Enter the list as in the following excerpt (''name=".."'' corresponds to the user's short name)
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide name="mst"/>
</privacy>
...
</config>
</switchboard>
</code>

* It's also possible to add all objects to a privacy list by adapting the config part as below:

<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide hide-all="true"/>
</privacy>
...
</config>
</switchboard>
</code>

*Restart the app'.

==Suppress Presence Display==
(From on hotifx16)A privacy list may be administrated manually within the operator's configuration file. The purpose is to provide a means for privacy, such that presence details won't be visible from within the application.
*Click on the button '''File/Configuration/Misc/AppData'''.
**A Windows Explorer is going to come up, showing the contents of ''C:\Users\<your user directory>\AppData\Roaming\innovaphone AG\innovaphone Operator\''.
*Terminate the operator.
*Open '''swconfig.xml''' witin a text editor
*Enter the list as in the following excerpt (''name=".."'' corresponds to the user's short name)
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide-presence name="mst"/>
</privacy>
...
</config>
</switchboard>
</code>

* It's also possible to add all objects to a privacy list by adapting the config part as below:

<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<privacy>
<hide-presence hide-all="true"/>
</privacy>
...
</config>
</switchboard>
</code>

*Restart the app'.

==Suppress PBX search==
A special configuration option within the configsw.xml file deactivates display of the PBX search. Valid for Operator version 9.0211 onwards.

*Terminate the operator.
*Open '''swconfig.xml''' witin a text editor
*Add the new command line as in the following excerpt
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<hide-search>pbx</hide-search>
...
</config>
</switchboard>

</code>

*store swconfig.xml
*Restart the application.

==Unattended Installation==
The following command line for the MS Installer program msiexec<ref>Windows Installer, Command Line Options: http://msdn.microsoft.com/en-us/library/aa367988%28v=vs.85%29.aspx</ref> has been reported to be working with the ''All Users'' installation setting.
<code type="text">
msiexec /i innovaphone.operator.setup.msi /passive /l* "Logdatei.txt" INSTALLDIR="C:\Program Files\innovaphone AG\innovaphone® Operator\" ALLUSERS=1
</code>

==Start With A Disctinct UI Culture==
The system culture controls the UI culture. The Operator appears in english on an english OS.

To force a different culture
*'''Win Explorer''' Browse to ''C:\Program Files (x86)\innovaphone AG\innovaphone® Operator''
*Right-Click on innovaphone.operator
*A context menu opens. Select '''Send To Desktop As Shortcut'''.
*Locate the newly created shortcut/link on the desktop and click on '''Properties'''.
*Modify the target from
<code type="text">
"C:\Program Files (x86)\innovaphone AG\innovaphone® Operator\innovaphone.operator.exe"
</code>
Into
<code type="text">
"C:\Program Files (x86)\innovaphone AG\innovaphone® Operator\innovaphone.operator.exe" /culture de-DE
</code>

Possible cultures are
*'''english''' en-GB
*'''czech''' cs-CZ
*'''german''' de-DE
*'''italian''' it-IT
*'''dutch''' nl-NL
*'''french''' fr-FR
*'''norwegian''' nb-NO
*'''polish''' pl-PL
*'''swedish''' se-SE
*'''spanish''' es-ES
*'''russian''' ru-RU

An alternative to the shortcut object vehicle is configuration file ''swconfig.xml''. The format is as follows
<code type="xml">
<?xml version="1.0" encoding="UTF-8"?>
<switchboard>
<config>
...
<culture>de-DE</culture>
...
</config>
</switchboard>
</code>

==swconfig.xml into /AppData/Local/==
The default directory for configuration data(swconfig.xml) is ''C:\Users\<user>\AppData\Roaming\innovaphone AG\innovaphone Operator''.

To keep the configuration not roaming, but PC-local, the operator application can be forced to look into ''Local'' instead:
*Click the button '''File/Configuration/Misc/AppData''' (Datei/Konfiguration/Diverses/AppData)
*WinExplore starts and displays ''C:\Users\<user>\AppData\Roaming\innovaphone AG\innovaphone Operator''.
*Terminate the operator application
*Within the WinExplorer move to ''C:\Users\<user>\AppData\Local\''
*Under 'Local' create the directory ''innovaphone AG''
*Under 'innovaphone AG' create the directory ''innovaphone Operator''
*Copy swconfig.xml from ''C:\Users\<user>\AppData\Roaming\innovaphone AG\innovaphone Operator'' into the new location ''C:\Users\<user>\AppData\Local\innovaphone AG\innovaphone Operator''

When starting the operator it is now referencing swconfig.xml from the newly created directory ''C:\Users\<user>\AppData\Local\innovaphone AG\innovaphone Operator''.

==Hosted PBX (Slave with license only)==
If you connect to a slave with ''license only'' activated you also have to activate the configuration ''Configuration :: Various :: Do not search at the master''.
Otherwise the Opeartor will search or try configuration on the license master which will not work.

=Addressing Large Scale Installations=
One of the lengthy discussions throughout the product design phase concerned large installations. Say, installations with more than 300 pbx users, up to a few thousand of them.

To make a long story short - eventually it turned out the main gimmick, the new busy lamp field, wasn't suitable. With a BLF the need for a search function would have emerged which was deemed contradictory to the intended purpose of a BLF.

Hence, the existing PBX search function received a major overhaul by adding the new [[#Full_Text_Index | Full Text Index]]. The goal of the full text index was to provide a search function being perceived as fast and superior to the one of the predecessor application. The BLF was left as-is without an extra search capability.

Finally, a checklist aiding planning of large scale installations
*Make the operator an active member of a group e.g. "soap".
*Make all other pbx users, that shall be searchable non-active members of the same group "soap".
**Per PBX not more than 2000<ref>The PBX has a hard-coded limit of 2000 group members</ref><ref>If more than 2000 users are required, those must be distributed on multiple PBXs with 2000 "soap" members each</ref>
*Ensure the Operator 9's PBX search is configured for '''Full Text/Volltext'''
*On the PC running the Operator 9 watch out for resource consumption.
**A countermeasure against too much of memory consumption is to completely disable the BLF<ref>Calculate with 80KB per BLF entry</ref>. See the checkmark '''Configuration/Misc/BLF Deactivate'''.

=Troubleshooting=
==How to obtain logs with Operator Application==

When an error occurs the Operator Application will give an alert on status bar and we can click on "save trace" button to retrieve the log. However we can force the trace on Operator Application that will generate always the trace file.

To do so, we need to go File->Configuration then Misc-tab and enable "trace" option.

[[Image:Concept_Operator_Version_9_trace.png]]

manual saving

[[Image:Save_Trace.jpg]]

=Known Issues=
==Application Won't Start On Windows XP==

'''Symptom''' 
The application doesn't start properly on Windows XP. An error text file is going to be generated comprising the following content:
<code text>
31.07.2009 16:40:46,innovaphone Operator,8.0.38.0

OS: Microsoft Windows NT 5.1.2600 Service Pack 2
CLR: 2.0.50727.1433

An internal error occurred

Alarms:
Exception, date=31.07.2009 16:40:45, info=unhandled exception
================================================================
'System.Windows.Controls.ToolTip' value cannot be assigned to property 'Value' of object 'System.Windows.Setter'.
'System.Windows.Controls.ToolTip' is not a valid value for 'Setter.Value';
values derived from Visual or ContentElement are not supported.
Error at object 'System.Windows.Controls.ToolTip' in markup file 'operator;component/activecallsincontrol.xaml'.
at System.Windows.Markup.XamlParseException.ThrowException(String message, Exception innerException, Int32 lineNumber, Int32 linePosition, Uri baseUri, XamlObjectIds currentXamlObjectIds, XamlObjectIds contextXamlObjectIds, Type objectType)
...
</code>

'''Solution''' 
Have a look into what Windows Update offers as optional components. If there's a cumulative update for .NET 2.0/3.0/3.5 you're asked to install said update (addendum: The update may also show up as ''.NET 3.5 SP1''<ref>.Net 3.5 SP1: http://www.microsoft.com/en-us/download/details.aspx?id=22</ref>). That update is going to upgrade the CLR onto the required version. Please note that Service Pack 3 is mandatory.

'''Remarks''' 
The original .Net Common Language Runtime (CLR) is not suitable and too old.

==Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"==
'''Symptom''' 
Calls that were blind-transferred by the Operator application may probably not appear in the respective call list.

'''Solution''' 
*At the PBX browse to PBX/Config/General - Field "Recall Timeout"
*Enter something useful in seconds (30 or 60)
'''Remarks''' 
A blind-transferred call is going to fall-back after that amount of seconds if not accepted in-between.

==Blind-Transferred Calls Don't Fall Back==
'''Symptom''' 
Calls that were blind-transferred by the Operator application don't fall-back to the operator.

'''Solution''' 
*The cause and solution are the same as in [[#Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"|Blind-Transferred Calls Don't Show Up in List of "Transferred Calls"]]

==Operator Freezes On Startup==
The operator application was reported to get stuck on startup. The user interface turned white and did not respond to any input.

'''Symptom''' 
The application window looks as follows [[Image:screenshot-oppi-freeze.jpg|center|thumb|200px|Operator freezes on startup]].

'''Solution''' 
This symptom can occur due to a corruption of the framework's font cache data file. Try the workaround:
*'''Start/Run''' of '''services.msc'''
*Stop the service ''Windows Presentation Foundation Font Cache 3.0.0.0''/''Windows Presentation Foundation-Schriftartcache 3.0.0.0''
*Now delete the system file ''FontCache3.0.0.0.dat''
<pre>
The file likely resides under Windows XP in
--
%systemdrive%\Documents and Settings\LocalService\Local Settings\Application Data

The file likely resides under Windows Vista/7 in
--
%windir%\ServiceProfiles\LocalService\AppData\Local</pre>
*Reboot the machine

==Operator Displays Corrupted Fonts==
After 2 years of service the operator application was reported to suddenly display corrupted fonts.

'''Symptom''' 
The application window looks as follows [[Image:Operator_font_corrupted.jpg|center|thumb|200px|Operator displays corrupted fonts]].

'''Solution''' 
This symptom occurred due to a corruption of the framework's font cache data file. Try the workaround:
*'''Start/Run''' of '''services.msc'''
*Stop the service ''Windows Presentation Foundation Font Cache 3.0.0.0''/''Windows Presentation Foundation-Schriftartcache 3.0.0.0''
*Now delete the system file ''FontCache3.0.0.0.dat''
<pre>
The file likely resides under Windows XP in
--
%systemdrive%\Documents and Settings\LocalService\Local Settings\Application Data

The file likely resides under Windows Vista/7 in
--
%windir%\ServiceProfiles\LocalService\AppData\Local</pre>
*Reboot the machine

'''Remarks''' 
It is the same root cause as above in [[#Operator_Freezes_On_Startup|Operator Freezes On Startup]].

==Pickup Of WQ Calls==
From on build 90112 the pickup of WQ calls is only possible for calls not in the CONNECT state.
*Activate the checkmark '''PBX/Objects/<WQ Object>/Queue/Operator connect for SOAP'''
**this setting guarantees that a WQ call is displayed as CONNECTed only in case of an operator actively talking to the caller party A.

==Not Working: ''Focus on incoming call''==
The configuration dialog offers an auto-focus checkmark '''File/Configuration/Misc/Focus on inc. call'''. Customers reported that the application manages getting into the foreground. However, without catching the keyboard focus. A final click into the application was necessary.

Instead, the application icon within the taskbar starts flashing, indicating that further user interaction is required.
The application window looks as follows
[[Image:Set-foreground-waiting.PNG|center|thumb|200px|Operator waiting for a click]].

This behaviour is by-design and cannot be circumvented in a common manner. An MS statement<ref>Set Foreground Window: http://msdn.microsoft.com/en-us/library/ms633539%28VS.85%29.aspx</ref> clarifies this OS-behaviour:
*''An application cannot force a window to the foreground while the user is working with another window. Instead, Windows flashes the taskbar button of the window to notify the user.''

The only reliable way to have the auto-focus feature working is by minimizing the application to the tray area. See the following menu button.
[[Image:Op-minimize-to-tray.png|center|thumb|200px|Button: Minimize to tray area]]
Auto-focusing from that window-state/application-state is supposed to be more reliable in getting the application into the foreground and assigning it the keyboard focus.

==Application Crash: Methode nicht gefunden/Method Not Found==

'''Symptom''' 
The application crashes - e.g. when searching - and prompts an exception labeled '''Methode nicht gefunden/Method Not Found'''.
<code text>
Exception, date=12.06.2013 16:35:52, info=unhandled exception
================================================================
Methode nicht gefunden: "System.Object[] innovaphone.idx.IFulltextIndex.Query(Char, System.String[])".
bei switchboard.Index.FtIndexQueryVlv(Char equalityTerminator, String[] terms, Int32 pageSize, VlvCursor& cursor)
bei switchboard.SearchPbxControl.PbxSearchFullTextExecute(String[] terms)
...
</code>

'''Solution''' 
De-install and afterwards re-install the application(The configuration won't be deleted, i.e. will remain.).

'''Remarks''' 
The root-cause is a DLL versioning problem. The problem may occur after an update-install took place. That is, where a newer Operator was installed over an older, existing installation.

==Inbound Calls Appear Doubled==
'''Symptom''' 
The upper-left list of calls titled ''Incoming calls for..'' displays a single call as two or even more calls.

'''Solution''' 
Configure a distinct '''Hardware ID''' of one of the operator's phones under '''File/Configuration/General/Hardware ID'''

'''Remarks''' 
The operator is likely to have multiple registrations active, originating from multiple endpoint devices. Only one of those devices shall be selected as the operator's active phone.

== Multiple Operator Instances and Nightswitch settings ==
'''Symptom''' 
Time settings will be empty or are not saved if more than one operator instance is used.

== Installation on Windows 10 ==
An installation was tested on Windows 10 (Microsoft Windows NT 6.2.9200.0). The installation stopped with a hint for a missing, but required .NET framework version 3.x. Just follow the offered download link for .NET 3.5 SP1 and retry the installation afterwards. This procedure provided a successful installation of the application.
[[Image:Screenshot-op9-install-win10.png|center|thumb|200px|Button: Download .Net 3.5 SP1]]

Other reports from the field show that this error might be omitted by removing the PC from its domain before installation and put it back afterwards.

==Application cannot Initialize at PBX==
The application may fail to initialize at a PBX.

Symptom:
* The application repeatedly prompts a red-colored error message onto the status line
<pre>
info='PBX Setup Completed:', error='Initialize failed!'
</pre>

Cause:
* The Windows proxy settings interfere
Solution:
* Alter the proxy configuration within '''Internet Options/Connections(/LAN Settings)'''. Those are accessible either via the Windows System Settings or from within the IE. Ensure that either the proxy-configuration is correct or deactivate it completely. It has been reported that the checkmark-activation of ''Internet Options/Connections/LAN-Settings/Bypass proxy server for local addresses'' also helped to solve the proxy-related problem.

==Installation Operator failed==
Exception, date=02.12.2015 13:20:44, info=unhandled exception

Cause:
* http://code.logos.com/blog/2009/11/how_to_crash_every_wpf_application.html

Solution:
* Open the control panel from Windows and take a look into the logs. There should be a hint.

==Contacts search: missing contacts on Full Text search==

Symptom:
*Sometimes the operator cannot find existing contacts when performing a search, this only seems to happen when "Full Text" method is used.

Cause:
*This occurs when the _TAPI_ group has more [[Howto:Config_size_Limitations#PBX_Group | than 2048]] members.

Solution:
*To workaround this issue it is recommended to split the users over multiple PBXs (max 2000 per PBX) as suggested in section [[#Addressing_Large_Scale_Installations|Addressing Large Scale Installations]]

=Localization=
The article [[Howto:Assist_In_Localization_Of_Operator_Version_9|Howto:Assist In Localization Of Operator Version 9]] serves as a starting point, if you are interested in helping to localize the application.

=Uninstall=

When we uninstall the Operator application on Windows the user configuration it's not deleted from the Roaming folder, so if we wish to do an reinstallation of the application with a new config we must delete manually the configuration data (swconfig.xml) from the Roaming folder: C:\Users\<user>\AppData\Roaming\innovaphone AG\innovaphone Operator.

=Notes=
<references/>

Reference13r1:Concept Number Resolution and LDAP

2021-08-27T11:21:26Z

Thomas.hiltbrunner: /* Estos MetaDir */

= General =
This document shows the V13 concept of number resolution, LDAP search and reverse lookup.

== Applies to ==
This information applies to

* V13 and up

= Short overview and scenarios =
There are basically two different directions for resolutions:

* Number to Name (Reverse Lookup)
:Backward resolutions are performed centrally for incoming and outgoing calls on PBX-level. A [[Reference13r1:PBX/Config/General|''Reverse Lookup URL'']] can be stored per PBX.
:By default, this is a 1-to-1 relationship (a single PBX can query an single LDAP source).

* Name to Number (Forward Search)
:Forward search differs between software and hardware:
:* myApps
::1-to-n relationship. A user can search simultaneously in multiple sources
:* Desk phone
::Search can be done according to the LDAP configuration in the [[Reference13r1:Phone/User/Directories|external directories]] settings of the user object.

=Number to Name (Reverse Lookup)=

== Concept ==
Resolution is done at the PBX for incoming and outgoing calls according to the locally defined reverse lookup setting. The URL might be different within PBXes of the same system (master, slaves).

For a general overview about the URL definition, refer to the [[Reference13r1:Concept_Reverse_Lookup|concept article on reverse lookup]].

In incoming direction resolution is done only for calls without any provider embedded display name information.

Resolution is done by LDAP-queries against sources like the PBX phonebook itself, V13-contacts application or any external 3rd-pty directory.

Setup is done via the ''Reverse Lookup URL'' which is configured under [[Reference13r1:PBX/Config/General|PBX/Config/General]]. 
If a resolution succeeds via this mechanism, the resolved name is given to all other applications/locations. (MyApps, Phones (also DECT), CDRs, Reporting, Call-List, etc.)

== PBX Configuration ==

If you want to use the central PBX Reverse Lookup you can use one of the following examples for your [[Reference13r1:PBX/Config/General|''Reverse Lookup URL'']]. 
Otherwise, you can use any other LDAP Server that you want. The URL is an [https://tools.ietf.org/html/rfc2255 RFC2255] encoded string. The format is explained [[Reference13r1:PBX/Config/General|here]]

Since v13r1sr10 the LDAP-URL support also the attribute DN (Distinguished Name) see : [http://wiki.innovaphone.com/index.php?title=Reference13r1:Release_Notes_Firmware#66919_-_PBX_Reverse_Lookup:_Allow_X.500_bindname_format Reference13r1:Release Notes Firmware]

Following prerequisites apply:

=== Prefix section ===

Depending on the PBX setup (flat or nodes) prefixes are defined either in the general PBX config and/or in the node/pbx-objects.
Only the "deepest" definition is taken into account for number conversion/adaption. In case of empty prefixes, no higher-leveled definitions are taken into account.

E.g. if the called pbx-user is located within a node, the prefix definition of this node is used for number normalisation. If those node prefixes are empty, no other prefixes in e.g. PBX-general are used.

In general, prefix definition may contain prefixes for
* International (INT)
* National (NTL)
* Subscriber (SUB)
* Area Code (AC)
* Country Code (CC)

Usage and definition depend on the country specific number plan.

The PBX tries to format the incoming number (CGPN) by performing a match against the prefixes in left to right order. In case of any prefix field is empty, the next one will be investigated.

Following rules apply upon prefix match:
* INT prefix matches: remove INT prefix
* NTL prefix matches: remove NTL prefix, prepend CC
* SUB prefix matches: remove SUB prefix, prepend CC + AC

'''Examples'''

1) German mobile call (best practice pbx config) 
:CGPN: 00171123456 (0 Trunk + mobile number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/00/0/7031/49 
:Result: 49171123456 

2) German mobile call (missing pbx config) 
:CGPN: 00171123456 (0 Trunk + mobil number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): none 
:Result: 00171123456 

3) German city call (typically ISDN, SIP-CGPNs are always signaled in international format) 
:CGPN: 0123456 (0 Trunk + local subscriber number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/00/0/7031/49 
:Result: 497031123456 

4) Spain national call (no SUB) 
:CGPN: 0925123456 (0 Trunk + national number) 
:PBX Prefixes (INT/NTL/SUB/AC/CC): 000/0//912/34 
:Result: 925123456 

=== URL definition ===

In general, reverse lookup uses the above created result after number conversion with prefixes.
Depending on the use phone book source, the reverse lookup URL might look different.
The number handed over to those source needs to be adapted by use of following variables:

* %n - cgpn
** if phone book entries are stored in international format with "+xyz", leading "+" may be prepended by using this notation: '+%n'. This is the default setting configured by Installer.
** if phone book entries are stored in international format with "00xyz", leading "00" may be prepended by using this notation: '00%n'
* %u - h323 name of the current object. Used to change the relationship of the searchbase to the user. A specific LDAP source can be requested depending of the user which receive the call.

==== Contacts App ====

ldaps://ap.domain.tld/dc=entries?givenname,sn,company?sub?(metaSearchNumber=+%n)?bindname=domain.de\contacts

Contacts is asked by further instances (e.g. PhoneAPP) for details about the found contact via websocket query.

==== Estos MetaDir ====

ldap://metadir.domain.tld:712/dc=meta?givenname,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homephone=+%n))?bindname=username

==== C4B ====

ldap[s]://c4b.domain.tld:[Port]/vdir=VDir?givenname,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homePhone=+%n))?bindname=c4b.domain.tld\telbook

==== Active Directory ====

ldaps://domain.tld:636/OU=tld,OU=company,DC=city,DC=LOCAL?givenname,sn,company?sub?(|(telephoneNumber=+%n)(mobile=+%n)(homePhone=+%n))?bindname=domain\username

==== PBX as LDAP Server ====

This refers to the legacy [[Howto:Maintaining a Phone Directory in the PBX| PBX-directory solution]].

ldap://ldap.domain.tld/cn=PBX0?dn,e164,email?sub?(&(node=PhoneBook)(e164=000%n))?bindname=telbook

== Legacy Device Configuration ==

By default, reverse number lookup is done at the PBX and displayed at the phone. Phone originated directories such as internal phone book, pbx access and external ldap are disabled.

Optionally, it is possible to enable the resolution directly at the phone. This is done by unticking the [[Reference13r1:Phone/User/Preferences | option "Disable Phonenumber Look-up"]] at Phone/User/Preferences.

The phone will then use the directory settings of the appropriate user, which are defined in the user object or config template.

If the resolution on the local phone provides a result, this is shown instead of the resolution of the PBX.

Be aware that this might lead to a different result than displayed on the PhoneAPP/SoftphoneAPP/CallList etc. as these applications always resolve against PBX-located settings.

== DECT ==
In V13, reverse number lookup for DECT systems is also done via the PBX-defined ReverseLookupURL.
Definition of any reverse lookup destination in DECT/Config/Master is obsolete.

=Name to Number (Forward Search)=
Search can be done by use of various sources. Those may be
* PBX itself (UsersApp)
* included ContactsApp
* any other external directories

== UsersApp ==
All PBX users can be searched via the UsersApp.

Preventing PBX-users from being found in Users/PhoneApp can be realized by disabling option "Visible" in privacy settings.

== ContactsApp ==
Further, contacts can be managed and searched within the [[Course13:IT_Connect_-_09.0_Contacts|ContactsApp]].

It is possible to define several contact instances hosting different contact data and assign those to dedicated users/config template.

=== Usage ===
Configure LDAP query with Contacts e.g. at phone:
* use of the correct user incl. domain (e.g. domain.tld\contacts)
* Correct password (visible in plain text in PBXManager/APContacts/configuration, checkmark show password)
* Search attributes:
** Meta Name Attributes -> metaSearchText
** Meta Number Attributes -> metaSearchNumber

== PhoneApp / SoftphoneApp / myAPPs ==

Within Phone/SoftphoneAPP search requests can be performed towards multiple sources in parallel if assigned to the respective user.

=== LDAP Object ===
To extend the amount of external search sources you can use the LDAP Object in the PBX.

To be defined depending on the external source attributes [[Reference13r1:PBX/Objects/LDAP|according to this description]].

LDAP object has to be assigned via App-tab to dedicated user / configuration template.

== myPBX ==
For myPBX, forward search is performed as usual via the [[Reference13r1:Phone/User/Directories | Phone/User/Directories]].
myPBX does not perform forward search in databases defined via ldap-objects.

== Outlook ==
* Works with myAPPs and myPBX '''windows launcher''' and so Windows compliant only
* Outlook Search will find contacts in all exchange accounts and all contact folders from these accounts
* requires a configured MAPI profile in Outlook (Exchange Account)

== Hardware Phone ==
Search on the hardware phone is done by use of the [[Reference13r1:Phone/User/Directories|configured directories]] at the phone.

In case of phone connection via ReverseProxy, refer to [[Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy|this description]] on how to configure search.

= Troubleshooting =

== Reverse Lookup doesn't work ==

=== SIP Trunk name delivery ===
Reverse Lookups are only executed for incoming calls without any embedded display name information. Some SIP provider will send the phone number as additional ''Display Name'' Information. In this case the Reverse Lookup will not be performed. 
This additional carrier information can be removed within the routing by deactivating the flag "[[Reference12r2:Gateway/Routes/Map|Interworking (QSIG,SIP)]]" in the incoming SIP route.

=== Contacts password ===
Reverse lookup against contacts does not work due to wrong password usage. Password used at ReverseLookupURL has to be equal to password defined at AP Contacts settings in PBXManager

== MyAPPs - Forward Search with LDAP Object ==

In case of non-working search request to a configured LdapApp-object, one can search in the myapps traces and crosscheck for related responses. The trace can be taken with the web console of your browser (F12), or by activating the trace flag "[[Reference13r1:Concept_myApps#Tracing_and_logging|Browser]]" available in your myApps client.

In the following example an LdapApp-object exists with the Name "MetaDir" and is configured as App to the User who searches for "jon doe":

// search pattern is "jon doe"
PhoneSearchBar::onSearchInputChange() input=jon doe

One can see the following lines in myAPPs-trace:

// start connection and login
open MetaDir url=http://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/ldap_api.htm?
name=MetaDir&title=MetaDir&scheme=dark&lang=de&originalUrl=http%3A%2F%2Fpbx.domain.de%2FPBX0%2FAPPS%2FMetaDir%2Fldap_api
started: MetaDir (hidden)
AppWebsocket(MetaDir) ws://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/132075/websocket
AppWebsocket(MetaDir) ws://localhost:10008/appproxy/ext/pbx.domain.de/PBX0/APPS/MetaDir/132075/websocket
send: {"mt":"AppLogin","app":"ldap_api","domain":"domain.de","sip":"slutz","guid":"e9653d7a7a615901b5b300155dbb1337","dn":"slutz","info":{"appobj":"MetaDir","appurl":"../../APPS/MetaDir/ldap_api","cn":"slutz","unlicensed":true,"groups":["test"]},"digest":"***","pbxObj":"MetaDir"}

// Login successful and Search API is registered
recv: {"mt":"AppLoginResult","ok":true}
recv from MetaDir: {"mt":"RegisterApi","api":"com.innovaphone.search"}

// send search request to LDAP APP
send to MetaDir: {"mt":"ApiRequest","api":"com.innovaphone.search","consumer":"dev:009033465440","provider":"*","src":"2","msg":{"mt":"Search","type":"contact","search":"jon doe"}}

// receive result from LDAP App
recv from MetaDir: {"mt":"ApiResult","api":"com.innovaphone.search","consumer":"dev:009033465449","src":"2","msg":{"mt":"SearchInfo","type":"contact","dn":"Jon Doe","contact":{"cn":"John Doe","givenname":"John","sn":"Doe","company":"Company","street":"street 123","postalcode":"12345","city":"city","telephonenumber":["+49123456789"],"homephone":[],"mobile":["+49123456789"],"sip":[],"email":["john.doe@domain.de"]}}}

= Related Articles =
* [[Reference13r1:PBX/Config/General]]
* [[Reference13r1:PBX/Objects/LDAP]]
* [[Reference13r1:Phone/User/Directories]]
* [[Reference13r1:Concept_App_Contacts]]
* [[Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy]]
* [[Reference13r1:Concept_Number_Adjustments_(Dialing_Location)]]
* [[Reference13r1:Concept_Reverse_Lookup]]

Reference10:PBX/Objects/Edit Forks

2020-02-17T16:38:20Z

Thomas.hiltbrunner: Added Eelated Article: RCC

With this page call forking can be configured for a user. This means a call for this user is not only sent to endpoints registered to the user object, but also to the forking destination. If a mobility object is configured for the forking, the phone identified by the forking destination can use the mobility functions. A delay can be configured for the call to the mobile endpoint. This delay is not supported for normal call forking without mobility functions.

;No/Name: Forking destination

;Bool/Not: The forking can be turned on and off by a Boolean object. With the '''Not''' checkmark the state is inverted.

== Properties of Mobility==

For the function of the Mobility features a Mobility license must be installed.

;Object: The [[Reference9:PBX/Objects/Mobility | Mobility]] Object (Long Name) must be set, if the mobile endpoint (GSM Phone) needs to use the [[Reference8:Administration/PBX/Objects/Mobility | mobility features]].
: Mobility license is required

;Device: The Device name of the User should be configured here (e.g. "Smartphone"). This name is used by SOAP (TAPI) to address this device for example when initiating a call, by myPBX to enable/disable Mobility for the User (on the Call Forward settings Screen of myPBX) and for Mobility Client OptiCaller for HTTP CallBack/CallThrough.

;Delay: A Delay in seconds can be configured to call the mobile endpoint.

;Disable: Disabling the Mobility features for the mobile device, this can also be en/disabled via [[Reference8:Administration/PBX/Objects/DTMF_Features#Enable.2Fdisable_mobility |DTMF featurecodes]]

;Call-Waiting: Enable or disable call-waiting for the mobile endpoint, if a mobile endpoint is in a call a call waiting tone will be played from the PBX to the mobile endpoint via the RTP stream. See [[Reference9:PBX/Objects/Mobility | R-Key Functions]] for waiting calls handling options.
: Mobility features are required

;GSM-License: When using the innovaphone GSM client a GSM license is needed and need to be activated. NB: obsolete

;Min-Alert: The minimum time in seconds a call must ring on the mobile phone until it can be accepted. If the call is accepted before this time, the call is rejected by the PBX. This way it can be achieved that the announcement from a mobile provider for phones not available does not accept a call and calls can be accepted on a fixed phone on the same number in case the mobile phone is switched off. The alert time is measured from the alert to the connect signalling. If there is no alert message (e.g. because there is a connect right away), the alert time is counted as null. '''Note: If the carrier doesn't send any Alert/180 Ringing, you may need to enable [[{{NAMESPACE}}:PBX/Objects/Mobility | Carrier w/o Alerting]] .'''
: Mobility features are required

;Max-Alert: Maximum time the mobile phone rings. After this time the PBX terminates the call to the mobile phone. This way it can be avoided that the mobile voicemail accepts the mobility call.
: Mobility features are required

== Related Articles ==
*[[Howto:V13 RemoteCallControl]]