Howto:Hotdesk - MediaRunway - Partner App: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
(Created page with "<!-- replace CompanyLogo by real logo-name. Do not change size & alignment. Upload image by pressing red link --> |200px|right ==Product Name== <!-- Mandatory topic. --> <!-- replace CompanyName & ProductName by real names and add URL to productpage --> <!-- MR-TODO: Replace NewAppName (newappname) with the name of your app --> MediaRunway [https://mediarunway.com/myapps/ Call Info] ==Certification Status== <!-- do not remove...")
 
 
(30 intermediate revisions by 2 users not shown)
Line 6: Line 6:
<!-- replace CompanyName & ProductName by real names and add URL to productpage -->
<!-- replace CompanyName & ProductName by real names and add URL to productpage -->
<!-- MR-TODO: Replace NewAppName (newappname) with the name of your app -->
<!-- MR-TODO: Replace NewAppName (newappname) with the name of your app -->
MediaRunway [https://mediarunway.com/myapps/ Call Info]
MediaRunway [https://mediarunway.com/myapps/ Hotdesk]


==Certification Status==
==Certification Status==
Line 37: Line 37:


<!-- MR-TODO: Change to icon of the app 100x100 -->
<!-- MR-TODO: Change to icon of the app 100x100 -->
[[Image:mediarunway-callinfo.png]]
[[Image:mediarunway-hotdesk.png]]
 


<!-- Give description about the main product purpose. -->
<!-- Give description about the main product purpose. -->
Line 44: Line 43:


<!-- MR-TODO: Max. 3 sentences describing the general functionality of the app. -->
<!-- MR-TODO: Max. 3 sentences describing the general functionality of the app. -->
'''Call Info''' is a myApps App.
'''Hotdesk''' is a myApps App.


Design your own template with call information and display it inside the Phone App, for this you can use the phonebook data from your own LDAP server. The app is a LDAP client that works in the background: For each incoming call, more information about the phone number is fetched from your LDAP server and sent to the Phone App of the respective user. As admin you define which data should be displayed and how they should look like.
The Hotdesk myApps App enables an easy change of telephones when you change your workplace. This can be done by a click in the Windows myApps Client. Tested with innovaphone and SNOM phones.


<!-- For further information refer to vendor product website via link -->
<!-- For further information refer to vendor product website via link -->
Line 65: Line 64:
<!-- Give functional description about the application. Use formattings if needed -->
<!-- Give functional description about the application. Use formattings if needed -->
<!-- Preferred format is a short list of functions/buzz words offered by the product -->  
<!-- Preferred format is a short list of functions/buzz words offered by the product -->  
The Call Info App acts here as a proxy/relay/intermediary, between the Phone App and a LDAP Server. As soon as a call has been established, the app working in the background sends the phone number to the Call Info service. The service makes a secured request to the server and sends the answer back to the user. The html template, created with the build in editor, displays the data inside Phone App as desired.
In a hotdesk scenario a user change his workplace. On a Windows PC the user login with personal credentials. Thats also possible on a innovpaphone phone. With the Hotdesk app the registration of the phone could be done with the myApps app. And so it is also possible to do hotdesking also with 3rd party phones like snom. And so hotdesking also work in scenarios where a phone device has no display and input buttons. There are three possible ways to do the registration with the hotdesk app.
 
*typing the desk name to an input field
 
*clicking on a button to send the computer name of the desktop pc, if PCs then notebooks are used)
<!-- MR-TODO: Change the picture, adjust px to width of your picture. The first picture/s should give an impression of the look and/or the functionality provided by the app -->
*clicking on a button to send the (thin) client name, if the user works on a terminalserver
[[Image:callinfo_main.png|969px]]
When one of the possibilities is used the app checks the matching table of desk-/computername and phone-mac-adress and do a mac-adress changing in the users hardware_id list and also realize that the phone app app icon will not be lost on the users my apps home screen.


The hotdesk app admin decide which of these three possibilities will be shown in the hotdesk user app.
For the matching of the phone-mac-address and the desk-/computername the admin has to upload a csv file with the matching infos.


<!--
<!--
Line 81: Line 82:
<!-- Mandatory topic. -->
<!-- Mandatory topic. -->
<!-- Give information about costs and licensing model. Use formattings if needed -->
<!-- Give information about costs and licensing model. Use formattings if needed -->
Licensing: One license per user with any number of devices for one instance of the app. No floating licensing, only the users who got a configured license have access. For licensing and test licensing please contact [mailto:myApps-sales@mediarunway.com myApps-sales@mediarunway.com].
Licensing: innovaphone licensing, one license per user with any number of devices for one instance of the app. No floating licensing, only the users who got a configured license have access.
 
* Example: "Hello MediaRunway, we would like to purchase the Call Info app. Here is our authentication key 1113335557, we have only one app instance. A one year license for 10 users would fullfill our needs. Please send us the license key as fast as possible. Best reagards"
 
 
'''Enter license key and activate user license''': Simply enter the license key that you received from us and press "Confirm". After that, you should see the valid date of your license and the number of available user licenses. Next to the desired user name, activate or deactivate the user's license, see [https://wiki.innovaphone.com/index.php?title=Howto:CallInfo_-_MediaRunway_-_3rd_Party_Product#Set_licenses_as_needed Configuration] section for details.
 
 
If you need a second connection to another LDAP server or another baseDN entry point (scope), you have to add a second app instance and purchase a second license for that instance. In this way, one group of users can make requests to one server/scope and the second group to another.


==Prerequisites==
==Prerequisites==
Line 97: Line 90:
<!-- MR-TODO: Prerequisites needed for this app. See current MR apps as example and the prerequisites-template.md file. -->
<!-- MR-TODO: Prerequisites needed for this app. See current MR apps as example and the prerequisites-template.md file. -->
<!-- None (at least knowledge about installing an App and adding the App Object for the users) -->
<!-- None (at least knowledge about installing an App and adding the App Object for the users) -->
The first requirement here is, that you have a properly configured LDAP server running.
You need a pbx with Hotdesk app license, and compatible phones (like innovaphone and snom).
We strongly recommend to setup a (TLS) secured "ldaps" connection and to configure one user with password, that will be used for fetching data. This means, the communication between Call Info and the LDAP server is encrypted, the client can validate your server with a certificate authority, and username and password has to be known to establish a connection. Later you will see the certificate chain file (with intermediate and root) that needs to be uploaded.
 
The [https://www.estos.com/products/metadirectory estos MetaDirectory] served as our LDAP server. The LDAP client that we implemented has been configured by default to work with the estos MetaDirectory, the "searchNumber" field, kind of a meta field, is used to search for a number. If you are using another LDAP server that does not support the "searchNumber" field and none of the other options fit your needs, do not hesitate to contact us. An individual adjustment to be able to address also your LDAP server optimally is feasible at any time.
 


==Versions==
==Versions==
Line 110: Line 99:
<!-- List compatible major innovaphone firmware versions. Several listings are valid -->
<!-- List compatible major innovaphone firmware versions. Several listings are valid -->
<!-- MR-TODO: Replace NewAppName and versions text. What SDK version was used during development? With which platform versions was it tested? -->
<!-- MR-TODO: Replace NewAppName and versions text. What SDK version was used during development? With which platform versions was it tested? -->
* MediaRunway Call Info 1.0 (133xxx)
* MediaRunway Hotdesk 1.0 (133xxx)
** innovaphone V13r3
** innovaphone V13r3, V14r1


===Application versions used for interop testing===
===Application versions used for interop testing===
Line 117: Line 106:
<!-- replace 3rd-Pty-Application by real name -->
<!-- replace 3rd-Pty-Application by real name -->
<!-- MR-TODO: Replace NewAppName and versions text. What SDK version was used during development? With which platform versions was it tested? -->
<!-- MR-TODO: Replace NewAppName and versions text. What SDK version was used during development? With which platform versions was it tested? -->
* MediaRunway Call Info 1.0 (133xxx)
* MediaRunway Hotdesk 1.0 (133xxx)
<!-- adjust tested innovaphone FW -->
<!-- adjust tested innovaphone FW -->
** innovaphone IPVA V13r2 sr18
** innovaphone IPVA V13r3 sr8
** innovaphone IPVA V13r3 final
** innovaphone IPVA V13r3 sr1
** innovaphone IPVA V13r3 sr2
** innovaphone IPVA V13r3 sr3
 
 
===Release Notes===
==== MediaRunway CallInfo 1.1 ====
* NEW
** Select your own search query by checkmarking the options your LDAP server supports and that you need. The selection options correspond to the attributes of a LDAP server.




Line 140: Line 119:
<!-- If not present, no certificate will be given at all -->
<!-- If not present, no certificate will be given at all -->
<!-- in any case you must be aware of the fact that any questions concerning configuration issues will be directly forwarded by innovaphone to you as manufacturer -->
<!-- in any case you must be aware of the fact that any questions concerning configuration issues will be directly forwarded by innovaphone to you as manufacturer -->
The admin part of the app, contains the LDAP Server configuration, the licensing, and an editor for generating/manipulating the information style displayed inside Phone App.
With the Hotdesk admin app you can configure the app.


<!-- MR-TODO: In case it needs to be configured, place text here. If the configuration part is more than a few sentences, go ahead and add a new section below ==Installation==. See current apps as example. -->
<!-- MR-TODO: In case it needs to be configured, place text here. If the configuration part is more than a few sentences, go ahead and add a new section below ==Installation==. See current apps as example. -->
===Configure your LDAP server connection===
===Configure the Hotdesk app===
What we need to configure a LDAP connection is:
This is to configure in the Hotdesk admin app:
* A valid address (with port number)
* the pbx name
* A username and password
* the name of the hotdesk device, configured in the pbx user object (on each user object it has to be the same name)
* Our base DN
* the options which buttons (functions) will be shown in the Hotdesk user app to register the phone
* The scope to use
* upload a csv with the list of hw_id (phone mac adress) and a name for the desk of the workplace, and optional the windows host-/clientname
* Select the attributes to be used in the search
[[File:Hotdesk-admin-app-configuration.png]]
* The certificate chain file received from certificate authority
 
Save the configuration and go to next step (adding the cert file as last step will save the configuration automatically). One can add the configuration values and test the connection without a license. The license is needed to display the information inside Phone App.
 
 
'''Configuration overview'''
 
[[Image:Callinfo_general_configuration1_1.png|784px]]
 
 
'''Chain file format'''
 
[[Image:Callinfo_chainfile_example.png|395px]]
 
For privacy reasons the values of the certificates was removed. The file uploaded has to be a PEM file.
 
 
===Test your connection===
With the connection test you can verify that the connection works as expected. One should see that search results are available and a list of data entries (placeholders) that can be used inside the style editor.
 
 
'''Connection Test'''
 
[[Image:Callinfo_contest_result.png|404px]]
 
If everything is configured properly one should see a list of available placeholders that can be used inside the style editor. More placeholders can be added (or disabled) via your LDAP server administration, making them available to the Call Info App as well.
 
 
In case of erros during the connection test, the type of error and a few hints will be displayed. We will briefly discuss a few cases here.
* Init failed: Your LDAP server is not reachable at all, because of missing firewall rules, wrong or expired certificate, or similar.
* Bind not successful: Something is wrong with your configuration settings, check server address/credentials (and baseDN/scope). If you are using the secured connection, make sure that your certificate has been issued for the correct domain or subdomain and that your LDAP server has been configured correctly.
* Search not successful: Is caused by a misconfiguration of your baseDN/scope (or the user was not configured correctly on the LDAP server).
* Search empty: If the search returns no results, the reason may be that the wrong baseDN or scope was used or your LDAP server is not properly configured.
* Size limit exceeded: During the test it is tried to capture all entries, for this a limit is set to protect the LDAP server and CallInfo. If the output does not look like the figure above, but a "Size limit exceeded" is displayed, proceed as follows:
** Temporarily select another or extend the "base DN" and  set a different "scope" in your configuration that you know contains fewer entries
** Run the test and copy the placeholders for use in the style editor
** Set your original "base DN" and "scope" again
** After all configuration and installation steps have been performed and users have been assigned a license, they should see another window in their SoftPhone app after restarting their SofPhone app and making a call to a number that exists in the LDAP directory
 
===Manipulate the style of your informations===
The built-in editor allows you to define your own html file, that will be displayed inside Phone App. The supplied default template makes it easy to get started. The placeholders will be replaced by the data fetched from your LDAP server. We get the complete list of available placeholders through the connection test.
 
If the query of a phone number on the LDAP server was successful, we get the rest of the data for this phone number. Each data entry has a name that corresponds to the placeholder, so the placeholder can be replaced by the real data entry.
 
 
'''Style Editor example'''
 
[[Image:Callinfo_style_editor.png|1147px]]
 
As one can see, we can use the LDAP values here and we can use innovaphone elements, for example the default colors (this way your Phone App template will switch between black and white mode). Save your changes by hitting the "Save" button or by pressing STRG-s.
 
<!-- MR-TODO: Add Links with html file examples. -->
 
 
===Set licenses as needed===
If you have purchased a license key, assign a license to the desired users. Restart the Phone App (reload and/or clean browser cache) and establish a call to see your information style inside Phone App (make sure that the number called is part of your phonebook/LDAP server otherwise there is no result to show).
 
[[Image:Callinfo_licensing.png|560px]]
 
 
===Call Info Phone App hints and example===
* If everything is properly configured and the users have received licenses, the Phone App will display the required information when a call has been established.
 
(* After setting the license restart the Phone App of the corresponding user and make sure the phone number searched for is available on your LDAP server.)
 
* Only the first result entry will be returned and displayed inside Phone App.
 
* Phone numbers starting with "+", "000", "00", or "0" will be cleaned and an wildcard (*) is placed at the beginning before the search starts. Numbers with digit count between 1 and 3 will not be cleaned and searched without wildcard.
 
* For internal calls the extension of the corresponding user will be used for lookup.
 
* The number is searched with the "searchNumber" field of the estos LDAP server. In the estos MetaDirectory administration you can set the checkmarks to the fields that will be taken into account for the search.
[[Image:estos_searchNumber.png|985px]]


* The LDAP client that we implemented has been optimized to work with the estos MetaDirectory. If you are using another LDAP server that does not support the "searchNumber" field and none of the other options fit your needs, do not hesitate to contact us. An individual adjustment to be able to address also your LDAP server optimally is feasible at any time.


 
===Upload csv file===
'''Phone App example'''
That a user could register a phone with the Hotdesk app, the admin has to upload a correct csv file in the Hotdesk admin app.
 
* 1. click in the admin app on the hamburgermenue
[[Image:Callinfo_softphone_example.png|408px]]
* 2. click in the menue on CSV file import [csv format: "hw_id","name","computername"]
* 3. click on browse (choose the csv file you want to upload)
* 4. after the selection of the csv file for upload you will see a table with the csv data, to save this data in the application you have to click on import.
ATTENTION:
* a windows computername has a limit of 15 character
* if the csv upload has an error, the updloaded csv data before is deleted
[[File:Hotdesk-csv-upload.png|400px]]


==Installation==
==Installation==
After installing the App, adding the App instance and the App Object for the users and the admin, one can start using "CallInfo". The steps of the installation process are the same as described in this article [https://wiki.innovaphone.com/index.php?title=Howto:Callback_-_mediarunway_-_3rd_Party_Product#Install_app_from_App_Store "Callback - Install App from App Store"] only with different names.
After installing the app, adding the app instance and the app object for the users and the admin, one can start using "Hotdesk". The steps of the installation process are the same as described in this article [https://wiki.innovaphone.com/index.php?title=Howto:Callback_-_mediarunway_-_3rd_Party_Product#Install_app_from_App_Store "Callback - Install App from App Store"] only with different names.


===Brief summary of the installation===
===Brief summary of the installation===
* Install the app from app store
* Install the app from app store
* Create an instance of the app
* Create an instance of the app
** Values needed: Name ("CallInfo", no blanks here please) - Domain (your platform domain) - App Password (generate one, 15 characters) - DB Password (generate one, 15 characters) - other values will be filled up automatically
** Values needed: Name ("Hotdesk", no blanks here please) - Domain (your platform domain) - App Password (generate one, 15 characters) - DB Password (generate one, 15 characters) - other values will be filled up automatically
* Add the user and the admin object with PbxManager (when selecting the name, please do not use spaces.)
* Add the user and the admin object with PbxManager app (when selecting the name, please do not use spaces.)
* [https://wiki.innovaphone.com/index.php?title=Howto:CallInfo_-_MediaRunway_-_3rd_Party_Product#Configuration Configuration and licensing]
* [https://wiki.innovaphone.com/index.php?title=Howto:Hotdesk_-_MediaRunway_-_Partner_App#Configuration Configuration and licensing]


The following is an installation example.
The following is an installation example.
Line 245: Line 156:


<!-- MR-TODO: Screenshots show how it should look like. -->
<!-- MR-TODO: Screenshots show how it should look like. -->
===AP manager settings===
===AP manager settings===
<!-- MR-TODO: Change the picture, adjust px to width of your picture. Replace newappname. -->
<!-- MR-TODO: Change the picture, adjust px to width of your picture. Replace newappname. -->
[[Image:Callinfo_ap_manager.png|1085px]]
[[Image:Hotdesk_ap_manager.png|800px]]
 


===PBX manager settings===
===PBX manager settings===
<!-- MR-TODO: adjust text as needed (Does your app have an admin area?) -->
<!-- MR-TODO: adjust text as needed (Does your app have an admin area?) -->
Please allways add the CallInfo User object first, and the CallInfo Admin Object second.
You have to create the user and admin object.


<!-- MR-TODO: Change the picture, adjust px to width of your picture. Replace newappname. -->
<!-- MR-TODO: Change the picture, adjust px to width of your picture. Replace newappname. -->
[[Image:Callinfo_pbx_manager.png|1072px]]
[[Image:Hotdesk_pbx_manager.png|1000px]]
 
 
Checkmark your users config while adding the object. The user object is not visible at all, the app is launched together with the Phone App and remains in background.
 
[[Image:Callinfo_pbx_man_user.png|1069px]]
 
 
Checkmark your admin config while adding the object.
 
[[Image:Callinfo_pbx_man_admin.png|1068px]]
 


==Copyright information==
==Copyright information==
The following third party tools had been used to create the Call Info App:
The following third party tools had been used to create the Hotdesk app:


* Cryptography and SSL/TLS Toolkit: [https://www.openssl.org/ OpenSSL 1.1.1o]
* csv parser (license: MIT): [https://www.papaparse.com/ Papap Parse]
** [https://www.openssl.org/source/license-openssl-ssleay.txt OpenSSL License]
** [https://github.com/mholt/PapaParse GitHub]
* LDAP Toolkit: [https://www.openldap.org/ OpenLDAP® 2.5.13 LTS]
** [https://www.openldap.org/software/release/license_lts.html OpenLDAP® License]
** [https://www.openldap.org/software/release/copyright_lts.html OpenLDAP® Copyright]
* Pure Javascript editor: [https://ace.c9.io/ ACE®]  
** [https://github.com/ajaxorg/ace/blob/master/LICENSE ACE® License]


==Contact==
==Contact==

Latest revision as of 09:06, 6 May 2024

Mediarunway company logo 200.png

Product Name

MediaRunway Hotdesk

Certification Status

Category

Computer Telephony Integration and Unified Messaging / Unified Communication

Vendor

Mediarunway company logo 150 2.png


MediaRunway is an ITC enterprise that provides its customers with contemporary IT services in all areas - Your business, our solution.

MediaRunway - About us


Description

Mediarunway-hotdesk.png


Hotdesk is a myApps App.

The Hotdesk myApps App enables an easy change of telephones when you change your workplace. This can be done by a click in the Windows myApps Client. Tested with innovaphone and SNOM phones.

MediaRunway - About this application


Functions

In a hotdesk scenario a user change his workplace. On a Windows PC the user login with personal credentials. Thats also possible on a innovpaphone phone. With the Hotdesk app the registration of the phone could be done with the myApps app. And so it is also possible to do hotdesking also with 3rd party phones like snom. And so hotdesking also work in scenarios where a phone device has no display and input buttons. There are three possible ways to do the registration with the hotdesk app.

  • typing the desk name to an input field
  • clicking on a button to send the computer name of the desktop pc, if PCs then notebooks are used)
  • clicking on a button to send the (thin) client name, if the user works on a terminalserver

When one of the possibilities is used the app checks the matching table of desk-/computername and phone-mac-adress and do a mac-adress changing in the users hardware_id list and also realize that the phone app app icon will not be lost on the users my apps home screen.

The hotdesk app admin decide which of these three possibilities will be shown in the hotdesk user app. For the matching of the phone-mac-address and the desk-/computername the admin has to upload a csv file with the matching infos.


Licensing

Licensing: innovaphone licensing, one license per user with any number of devices for one instance of the app. No floating licensing, only the users who got a configured license have access.

Prerequisites

You need a pbx with Hotdesk app license, and compatible phones (like innovaphone and snom).

Versions

Compatible innovaphone firmware versions

  • MediaRunway Hotdesk 1.0 (133xxx)
    • innovaphone V13r3, V14r1

Application versions used for interop testing

  • MediaRunway Hotdesk 1.0 (133xxx)
    • innovaphone IPVA V13r3 sr8


Configuration

With the Hotdesk admin app you can configure the app.

Configure the Hotdesk app

This is to configure in the Hotdesk admin app:

  • the pbx name
  • the name of the hotdesk device, configured in the pbx user object (on each user object it has to be the same name)
  • the options which buttons (functions) will be shown in the Hotdesk user app to register the phone
  • upload a csv with the list of hw_id (phone mac adress) and a name for the desk of the workplace, and optional the windows host-/clientname

Hotdesk-admin-app-configuration.png


Upload csv file

That a user could register a phone with the Hotdesk app, the admin has to upload a correct csv file in the Hotdesk admin app.

  • 1. click in the admin app on the hamburgermenue
  • 2. click in the menue on CSV file import [csv format: "hw_id","name","computername"]
  • 3. click on browse (choose the csv file you want to upload)
  • 4. after the selection of the csv file for upload you will see a table with the csv data, to save this data in the application you have to click on import.

ATTENTION:

  • a windows computername has a limit of 15 character
  • if the csv upload has an error, the updloaded csv data before is deleted

Hotdesk-csv-upload.png

Installation

After installing the app, adding the app instance and the app object for the users and the admin, one can start using "Hotdesk". The steps of the installation process are the same as described in this article "Callback - Install App from App Store" only with different names.

Brief summary of the installation

  • Install the app from app store
  • Create an instance of the app
    • Values needed: Name ("Hotdesk", no blanks here please) - Domain (your platform domain) - App Password (generate one, 15 characters) - DB Password (generate one, 15 characters) - other values will be filled up automatically
  • Add the user and the admin object with PbxManager app (when selecting the name, please do not use spaces.)
  • Configuration and licensing

The following is an installation example.


AP manager settings

Hotdesk ap manager.png

PBX manager settings

You have to create the user and admin object.

Hotdesk pbx manager.png

Copyright information

The following third party tools had been used to create the Hotdesk app:

Contact

MediaRunway GmbH & Co. KG
Venloer Str. 8
D-41569 Rommerskirchen
Tel: +49 2183 80628-0
Mail: myApps-sales@mediarunway.com
Support: myApps-support@mediarunway.com
Website: MediaRunway.com

For any questions please refer to our contact page.

Retrieved from "https://wiki.innovaphone.com/index.php?title=Howto:Hotdesk_-_MediaRunway_-_Partner_App&oldid=71703"