Howto:Inno2TANSS - MediaRunway - Partner App

From innovaphone wiki
Jump to navigation Jump to search
Mediarunway company logo 200.png

Product Name

MediaRunway inno2TANSS

Certification Status

Referralprod.PNGThis product is listed due to a customer testimonial. No tests have been conducted by innovaphone.

Testing of this product has been finalized June 8th, 2022.

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 inno2TANSS.png


The app inno2TANSS needs the ticketsystem TANSS® and a licensed innovaphone reporting. The app pushes the call information to the ticketsystem so that it becomes available to your TANSS® integrated call list and visualized in your timelines.

MediaRunway - About this application


Functions

Once configured, the app will run in background and forward every call from your innovaphone PBX to your TANSS® website. Please see the Configuration section in this article.

Start procedure summary: :

  • Install the app and add a admin object to access the configuration area.
  • Do set your TANSS configuration and save your config.
  • App will start trying to read call data from reporting db and send this information to your TANSS as soon as you check the "Activate/Deactive autopush mode" and press "Save" afterwards.
    • After installation, the "Last CDRS ID to use" value for call data is "0". On the very first start of inno2TANSS with checked "Activate/Deactive autopush mode", the app will read the latest ID and start sending call information for new incoming calls.
    • If you increase the "Last CDRS ID to use" value to "1" before the application is started with checked "Activate/Deactive autopush mode" for the first time, the application will read all call information available in the database and starts sending these to your TANSS. Please be aware: There may be a lot of call information in the database, so it may take some time to send. The "Last CDRS ID to use" value is updated continuously.
    • We do not recommend changing the "Last CDRS ID to use" value afterwards, otherwise call information will be sent twice or new arriving calls can overwrite your "Last CDRS ID to use" value set. Do uncheck "Activate/Deactive autopush mode" and press "Save", before changing the "Last CDRS ID to use" value.
  • The information about the reporting database connection and the HTTP connection will be updated if you check "Activate/Deactive autopush mode" and press "Save" afterwards. Several error states can be output here, but not all error causes can be provided with a suitable notification. A timeout of the connection to TANSS can be due to a misconfiguration, e.g. if the URL was not entered correctly, or the firewall blocks the connection between the App platform and TANSS.


Licensing

Licensing: You need one license for one PBX and ticketsystem connection. No user licensing. For licensing and test licensing please contact myApps-sales@mediarunway.com.

  • Example: "Hello MediaRunway, we would like to purchase the inno2TANSS app. Here is our authentication key 1113335557. Please send us the license key as fast as possible. Best reagards"


Enter license key and activate: Simply enter the license key that you received from us and press "Save". After that, you should see that your license is valid. Please see the Configuration section in this article.


Prerequisites

What you need is this Wiki article and a valid license. For a valid license please install the app and in the admin area of the app you will find the authentication key. Please send us this authentication key, together with the desired license period to myApps-sales@mediarunway.com.

The steps of the installation process are the same as described in this article "Callback - Install app from App Store" only with different names. We need to install the app, add an app instance, and the admin app object, the names of these can be found in the Configuration area of this article.


TANSS® Prerequisites

  • First of all, make sure, that your innovaphone PBX/App instance can reach your TANSS® system via network. Allow http/https on your firewall in both directions.
    • If the network is not configured properly, trying to connect to TANSS® will result in a timeout.
  • The TANSS® installation must be correctly configured with the phone numbers of the employees.
  • Furthermore, we need a Bearer Token that we can create in our TANSS® backend.


Versions

Compatible innovaphone firmware versions

  • MediaRunway inno2TANSS 1.2 (132xxx)
    • innovaphone V13r2
    • innovaphone V13r3
  • MediaRunway inno2TANSS 1.0 (132xxx)
    • innovaphone V13r2

Application versions used for interop testing

  • MediaRunway inno2TANSS 1.2 (132xxx)
    • innovaphone IPVA V13r2 sr15
    • innovaphone IPVA V13r2 sr18
    • innovaphone IPVA V13r2 sr19
    • innovaphone IPVA V13r3 final
    • innovaphone IPVA V13r3 sr1
  • MediaRunway inno2TANSS 1.0 (132xxx)
    • innovaphone IPVA V13r2 sr11
    • innovaphone IPVA V13r2 sr12


Release Notes

MediaRunway inno2TANSS 1.2

  • NEW
    • Add/Save Bearer Token without "Bearer" string at front
  • Optimizations


Installation Notes

MediaRunway inno2TANSS 1.2

If you upgrade your current inno2TANSS instance remember the last CDRS id sent and deactivate the "autopush mode" while running the installation.


Configuration

After successfully installing the app, start with the configuration.

inno2TANSS Backend: Overview

The inno2TANSS backend configuration consists of the following areas:

Inno2TANSS config.png


Database connection

Every single call information will be written to the reporting database. The inno2TANSS app connects to the reporting database and forwards call information to TANSS®. In order to do that, we have to provide the reporting database login information to our inno2TANSS instance. One will find the necessary information inside "AP MANAGER" by clicking on "Reports", mark the "reporting" instance and click "Edit". Inside the "Reports - Edit instance" window you will find:

Reportings db config.png


We strongly recommend to change reportings default password:

  • Inside the "Reports - Edit instance" window, checkmark "Change password" next to "Database password" (it will change to "Show Password")
  • Insert your new password (15 characters) and press the "Save" button

Inno2TANSS reporting changepass.png


TANSS® configuration

Next we will configure our TANSS® connection. Enter the appropriate information in the text fields provided.

  • URL of your TANSS® instance
  • URL of your TANSS® api
  • TANSS® area code (single digit only)
    • Cut out the TANSS® area code from the beginning of the phone numbers
  • TANSS® telephone system ID (single digit only)
    • Cut out the telephone system ID from the beginning of the phone numbers
  • TANSS® api token
    • From your TANSS® backend, one can generate a Bearer Token ("Bearer abc...xyz")
  • TANSS® api token expiring date
    • Enter the expiration date of the Bearer Token so that you can remember when it needs to be renewed. Usually you will generate a one year valid Bearer Token.
  • Last ID to use (if set to 0 a readout will be performed)
    • This value should be modified only if the app is not running ("Activate/Deactivate autopush mode" not check marked), the backend will update this value while running.
    • When running the inno2TANSS instance for the first time with "Last ID to use" equals 0, the app will read the last ID from reporting database and only new call data entries will be send to your TANSS® instance.
      • It would be possible to send all the reportings database entries from the past to TANSS® while starting the app for the first time.
  • Activate/Deactivate autopush mode
    • First, set all other configuration values and press the "Save" button.
    • If everything is configured, activate the "autopush mode" by marking the checkbox and press "Save".
      • inno2TANSS will first try to establish a database connection, next it will try to fetch data from reporting database for send out, and as last step try to connect to your TANSS® instance and send the data entries if present.
      • "Last State" area will show the connection states and in the Last State section of this article you will find additional information.
  • Autopush intervall in seconds (Min: 3 sec, first run after interval)
    • Default is set to 3 seconds.
  • Write extended log (activate if needed)
    • Mark the check box if extended Log should be written.


License key

As mentioned in the "License" and "Prerequisites" section you need a license key. As shown in the overview diagram, the license is entered in the corresponding field and then the "Save" button is pressed.


Action buttons

  • By pressing the "Save" button, your current entries will be written to the configuration database.
  • By pressing the "Cancel" button, the configuration values from the database will be reloaded.


Last State

  • "HTTPS TANSS: unknown" : This entry shows the last status of the TANSS® connection. If everything is properly configured, a "HTTP OK" will be displayed.
    • If the configuration is correct, you can see the calls in your TANSS® timeline.
    • If there is a problem with the connection, it may be due to one of the following causes:
      • If the connection between inno2TANSS and TANSS® is blocked, for example by your firewall, or if there is no route at all, this will result in a timeout error. The status will not change for 30 seconds until the timeout event occurs.
      • If the data entry was lost or not properly delivered, inno2TANSS will try again and again to send this data entry. This also happens if TANSS® could not process the sent entry due to a missing or incorrect configuration. One can skip a data entry, simply by increasing the "Last ID to use" by 1. A better way would be to check the call entry and your TANSS® configuration to figure out why the entry was not processed.
  • "Reporting database: unknown" : This entry shows the last status of the reporting database connection. If everything is properly configured, a "Connection established" will be displayed.
    • If there is a problem with the connection, it may be due to one of the following causes:
      • Wrong credentials, check the password and user name in your configuration and try again.


App Installation and inno2TANSS admin object

As mentioned in the Prerequisites section of this article, for the steps of the installation process we can use this article "Callback - Install app from App Store". However, next here you will find an example for a naming convention of your inno2TANSS instance.


AP Manager: This is how the AP manager will look like after adding the inno2TANSS instance. (Important Notice: Do not use blank space or special characters for your instance name)

  • The name of our instance
    • inno2tanss

Inno2TANSS running.png


PBX Manager: Following pictures show the added admin object for our app instance

1. Select "AP inno2tanss" and press "+ Add an App"

Inno2TANSS admin object 1.png


2. Click on "inno2TANSS admin" and enter texts

  • Name: "inno2TANSS"
  • SIP: "inno2tanss"
  • Config Admin: check mark it

Inno2TANSS admin object 2.png


3. Click on "OK" and see your admin object connected

Inno2TANSS admin object 3.png


After installation

After successful installation of the app, the app instance and the admin object, we have to perform some configuration steps. Please see the Configuration section in this article.


Additional Information About this App

This app was developed by MediaRunway. The ticketsystem TANSS® is developed and purchased by HUCK IT GmbH, please find more information about the ticketsystem on www.tanss.de


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.