Admin

Twilio SMS

The Twilio connector enables Totalview to send SMS messages. Go to Twilio.com to create a SMS account.

The required Twilio settings can be found on the Twilio dashboard.

Account SID
Twilio account id
Token
Twilio authorization token
Default Sender
Sender is the information shown as “From” on sms messages. You can use any custom string like your own business name.
Support for sending messages from an alphanumeric sender depends on your destination (‘To’) phone number and is not available everywhere.
International Prefix Default prefix to add to receiver  number where international code is missing. Twilio requires that receiver numbers are fully qualified, i.e. +<int-code>number.

SMS Box parameters

The SMS is of the SMS Service Type, this service enables Totalview to send SMS messages. SMS messages sent to Totalview can be used to change current state setting or request users contact information.

COM Port
Fill in the value of the serial port the GSM station is connected to
Baud rate
Fill in the Baud rate (300, 600, 1200, 2400 etc. – 115200)
Pin
The Pin code of the SIM card (4 digits)
Service centre
The number of the SMS gateway of the GSM provider
Preferred Storage
Select how the messages should be saved on the GSM station. The options are: SIM Card which saves on the SIM card, GSM Memory which saves on the memory on the GSM station and Both which does both
Start up Script
The name of the script file with possible instructions to the GSM station, while configuring the SMS connector first time. This parameter is optional.
Prefix
The country code that is set in front of numbers without country code, e.g. 45 (Denmark) and (46 Sweden).
Drop nat. digits
Digits to remove in front of international telephone numbers which do not have the standard + or 00 country code prefix.
Input Only
Set the checkmark if the GSM station should be allowed to send messages.
State Change Receipts
Set the checkmark if the GSM station should send receipt to the Users when Receiving  Change State messages.
SMS syntax 2.0

Set the checkmark if the syntax 2.0 is used. The syntax 2.0 allows the user to select a state or a template when changing state using SMS messages

Message to known users

If a user with a registered mobile number in Totalview sends an unknown command to Totalview via SMS, the system can reply a specific message to the user.

Message to unknown users

If a user, not existing in Totalview, sends an unknown command to Totalview via SMS, the system can reply a specific message to the user.

LinkMobility

The LinkMobility is of the SMS Service Type, this service enables Totalview to send SMS messages.

LinkMobility Support will provide you with the following information:

  • Username, Password, Platform Parrent ID, Platform ID, Gate ID.

Request URI should be set to “https://wsx.sp247.net/sms/send”

Sender information is the string that is shown as “From” on sms messages. It can be any text within 2-11 character range.
If “use default mobile as sender” is checked the users default mobile number is used as “From”.
If the users mobile number is unavailable the “Default sender information” is used.

International Prefix: Default prefix to add to receiver  number where international code is missing. LinkMobility requires that receiver numbers are fully qualified, i.e. +<int-code>number.

 

Using this feature to impersonate other parties will lead to a termination of your LinkMobility account

Lotus Notes parameters

The Lotus Notes connector monitors listed users and notifies Totalview when changes happen in a user’s appointments list. The connector also sends create, update and delete commands from Totalview to the Lotus Notes Domino server.

Specific Lotus Notes issues

Using service credentials. It is not possible to use service credentials when using the Lotus Notes connector. Username and password must be passed from the Totalview server.

Recurring appointments. When handling recurring appointments, Lotus Notes only creates one appointment and lets the rules for the recurring appointments be stored in this one appointment. Currently the CC only looks for appointments created within the last 12 months. That means that if a recurring appointment is created more that 12 months ago, it will not be synchronized with Totalview.

Query user rights. Lotus Notes calendar users must grant the query user access to their calendar folder. There is no global setting allowing the query user access to other users’ calendar folders.

Before you start

The Lotus Notes connector uses the Lotus Notes client API to query information from the user’s calendar folder. To be able to query the user, the Lotus Notes client must be installed on the same machine as the Lotus Notes connector and a user must be created with rights to query user’s calendars.

Lotus Notes IP address
This is the IP address of the IBM Lotus Domino server.
Username
Query user with access to the attached users’ calendars
Password
Password for user with access to all calendars. The password can be saved scrambled or unscrambled. If scrambled then the Scrambled property must be set to true. Use the “Totalview Password Scrambler” to scramble the password (located in the InstallFiles folder)
Scrambled
The password can be saved scrambled in the TV3 server. Set the checkmark if the password is scrambled. Use the program “Totalview Password Scrambler” located in the InstallFiles folder to scramble the passwords.
Recurring days ahead
How many days forward, should recurring appointments from Lotus Notes be shown in Totalview. This is necessary to be able to limit the number of recurring appointments retrieved from Lotus Notes
Ignore char When synchronizing, appointments with subject starting with the ignore char are ignored and not shown in Totalview. The default value is *.
If the ignore char is changed, the connector must be restarted to apply the new rule.
Busy template
Select the template to use for Busy Lotus Notes appointments. Appointments with state Busy in Lotus Notes are mapped to this template when retrieved and shown in Totalview. If the Busy template is changed, the Lotus Notes connector must be restarted to apply the new template
Categories Mappings
Specify mappings between states and categories. For more information See: Notes categories synchronization
If forwarding rules have influence on the phone settings of synchronized appointments, and the forwarding rules changes, then the Exchange/Lotus Notes connector must be restarted to apply the new phone settings.

Google Calendar parameters

The GoogleCalendar connector monitors listed users and notifies Totalview when changes happen in a user’s appointments list. The connector also sends create, update and delete commands from Totalview to Google Calendar.

 

Before you start

The GoogleCalendar connector uses the GoogleCalendar API and service credentials to access the users’ calendar folder. Details on setting up the service credentials can be found in “Google Calendar settings“.

Account name The name of the create GoogleCalendar service application.
Certificate filename
The name of the GoogleCalendar service certificate. If the path to the file is not included, the certificate must be located in the same folder as the TotalviewGoogleCalendar executable.
Password
Password for the GoogleCalendar service certificate.
Initial user
An initial user used to the the access to Google Calendar.
Recurring days ahead
How many days forward, should recurring appointments from Google Calendar be shown in Totalview. This is necessary to be able to limit the number of recurring appointments retrieved from Google Calendar
Busy template
Select the template to use for Google Calendar appointments. Appointments in Google Calendar are mapped to this template when retrieved and shown in Totalview. If the template is changed, the Google Calendar connector must be restarted to apply the new template
 Ignore char When synchronizing, appointments with subject starting with the ignore char are ignored and not shown in Totalview. The default value is *.
If the ignore char is changed, the connector must be restarted to apply the new rule.
If forwarding rules have influence on the phone settings of synchronized appointments, and the forwarding rules changes, then the GoogleCalendar connector must be restarted to apply the new phone settings.

Exchange Parameters

The Exchange Connectors monitors subscribed users, and notifies Totalview when changes happen in a user’s appointments list. The connector also sends create, update and delete commands from Totalview to the Exchange server.

Exchange365 Connector Connection Parameters

An App registration must be made in Azure for the customer’s tenant. See the Exchange security settings guide for more information.

Tenant id
The Azure App Registration tenant id
Client id
The Azure App Registration client id
Secret The Azure App Registration secret

The App registration must have assigned the following permissions on Graph API:

  • Calendar.Read
  • Calendar.Write
  • User.Read
  • Mail.Send

Email Settings

Sender from-address
The e-mail account used to emails by Exchange365 connector

Exchange Online Connector Connection Parameters using OAuth2 authentication (Deprecated)

Using OAuth2 authentication with Exchange Online, reqires an App Registration being created in Azure, with permission to use the EWS Legacy API (full permission).
See the Exchange security settings guide for more information.

Tenant id
The App Registration tenant id
Client id
The App Registration client id
Secret The App Registration Secret
Test user An user existing in Exchange Online. The user is used to test that the connection with Exchange Online is successful. Format of test user is name@domain.com.
The test user will also be used as the send user when sending mail using the Exchange Online connector

On-premise Exchange or Exchange Online Connector using basic authentication (Deprecated)

The Exchange connector uses EWS to query information from the user’s calendar folder. To be able to query the user, a user must be created with rights to query user’s calendars. See the Exchange security settings guide for more information.

If running the Exchange connector with the service credentials, it is necessary to use the service manager to enable the service to run under the Totalview service user. A description of creating the Totalview service user is specified in the Exchange security guide.

URI (using EWS)
http:// <server name>/. This is the URL/URI to the Exchange server where the Exchange web service request will be sent
URI (using Exchange Online)
When using Exchange Online no server URI is provided. The server is found based on the username, e.g. name@domain.onmicrosoft.com
Username
Query user with access to all the attached users’ calendars.

N.B. When using service credentials, username should be left blank. The use of service credentials is listed in the Totalview Exchange security guide. Service credentials cannot be used when connecting to Exchange Online

Password
Password for user with access to all calendars.

N.B When connecting to Exchange Online the password must not contain any of the reserved XML characters. The five reserved characters are < (less than), & (ampersand), > (greater than), ” (quotation) and ‘ (apostrophe).

N.B. When using service credentials, password should be left blank

Scrambled
The password can be saved scrambled in the Totalview server. Set the checkmark if the password is scrambled. Use the program “Totalview Password Scrambler” located in the InstallFiles folder to scramble the passwords.
Domain
The query user domain. Used when authentication the query user on the Exchange. The domain should be the NetBIOS name or the fully qualified domain name (FQDN). Domain is not set when using Exchange Online
Use FBA
Set the checkmark if Form Based Authentication is used when connecting to the Exchange server. Use FBA is not set when using Exchange Online

 

Synchronization settings

Recurring days ahead How many days forward, should recurring appointments from Exchange be shown in Totalview. This is necessary to be able to limit the number of recurring appointments retrieved from Exchange
Busy template
Select the template to use for Busy Exchange appointments. Appointments with state Busy in Exchange are mapped to this template when retrieved and shown in Totalview. If the Busy template is changed, the Exchange connector must be restarted to apply the new template
Out of office template

Select the template to use for Out of Office Exchange appointment. Appointments with state Out of Office in Exchange are mapped to this template when retrieved and shown in Totalview. If the Out of Office template is changed, the Exchange connector must be restarted to apply the new Template

Tentative Select the template to use for Tentative Exchange appointment. Appointments with state Tentative in Exchange are mapped to this template when retrieved and shown in Totalview. If the template is changed, the Exchange connector must be restarted to apply the new template. If no template is selected the Tentative appointments are not show in Totalview.
Working elsewhere Select the template to use for Working Elsewhere Exchange appointment. Appointments with state Working Elsewhere in Exchange are mapped to this template when retrieved and shown in Totalview. If the template is changed, the Exchange connector must be restarted to apply the new template. If no template is selected the Tentative appointments are not show in Totalview.
Working Elsewhere is supported in Exchange 2013 and newer.
Synchronize current If enabled then Change state (current state/F5 in the client) settings are synchronized with the Exchange calendar. See the synchronization rules in section: The Totalview server synchronization rules in the Totalview Calendar Technical guide.
Valid until end

 

Is used with Fallback appointments (See: Promoting appointments with fallback for more information)
Exchange version (Deprecated)
 
Specify exchange version (Not defined, Exchange 2007, Exchange 2007 SP1, Exchange 2010, Exchange 2010 SP1, Exchange 2013, Exchange 2013 SP1). This only applies to ExchangeEWS
Ignore char When synchronizing, appointments with subject starting with the ignore char are ignored and not shown in Totalview. The default value is *.
If the char is changed, the Exchange connector must be restarted to apply the new rule.
If forwarding rules have influence on the phone settings of synchronized appointments, and the forwarding rules changes, then the Exchange connector must be restarted to apply the new phone settings.

System Extensions

Extends the Totalview system with additional connectors, e.g. the AD Connector

 

Mobile Connectors

Connectors of the mobile status type enables Totalview to display the status (idle/busy) of mobile phones in the Totalview client. To enable mobile status, a service agreement must be done with a corresponding telecom operator.  The service operator sends messages about the mobile status to the connector through an external URI:Port.

Mobile status subtype parameter settings

 

Web service connectors

Connectors of the web service status type enables Totalview to communicate with external systems using web services.

Totalview MobileWeb Connector Parameters

The MobileWeb connector enables smart clients, wallboard, doorway and more to communicate with the Totalview server using standard SOAP or REST requests.

Clients can request information from the Totalview server via the MobileWeb Connector and display it on clients. Clients can also send commands such as change current state to the Totalview server.

Call Group Groups
Grouping of call group numbers in Totalview Wallboard

WCF endpoint address
Enter the endpoint address for the WCF connector.
Min. password length
Define the minimum length of the passwords used when logging in from the smart clients.
Prefix intervals
The prefix interval setting is used to map local number to their external fully qualified numbers.

Local numbers are stored without area and trunk codes, but when listing the local number on the mobile devices, they should be listed as fully qualified; otherwise the mobile devices can not dial the numbers.

E.g. local number 4000 should be listed as +45xxxx4000 so that the mobile device can dial the numbers.

The order of the rules is essential. The first rule that matches the local number will be used.

Star/End local
Defines what devices will use the specified prefix. All devices within the interval will have the prefix applied to their local number when listed on the mobile device.
Max length
In case the local numberplan is x4000 and the external numberplan is xxxx4000, then only the last 4 digits should be used. Set the max length if only a part of the local number should be used – otherwise leave max length blank.
Prefix
Define the prefix to put in front of the local number to be able to list it as fully qualified. In the example above the prefix would be set to +45xxxx.
Enable win login
Enable use of the UserWinLogin web service method. Enables login using the users win login. Can e.g. be used when logging in using a Sharepoint client. Admin username and password must be set to use this service.
Admin user
Username when calling the UserWinLogin web service or when logging in using the PublishClient or ExternalClient.
Admin password
Password when calling the UserWinLogin web service or when logging in using the PublishClient or ExternalClient.
API Key – Wallboard
The API key used by the wallboards. To generate a new key you can click on the generate button. Copy will copy the key to your clipboard.
Group Id
Id of call group group
Members
Comma separated list of call group numbers in group
Logging level Select the log level for the connector. Levels are Trace, Debug, Info, Warn, Error, Fatal, Off.
Default log level is Info.
Changing the log level does not require restart of the connector.

Prefix interval examples

Below are two examples for what prefix interval settings to use when local number are mapped to external numbers.

Local numbers 100 to 199 are externally known as +4533449100 to +4533449199.

  • Start/End local : 100-199
  • Max length : <empty>
  • Prefix : +4533449

Local numbers 100 to 199 are externally known as +4533449500 to +4533449599.

  • Start/End local : 100-199
  • Max length : 2
  • Prefix : +45334495

Logging

The log will be written to the logs folder relative to the connector (i.e. [Totalview Installation]\WCF\[ConnectorName]\logs).
By default the logs will be kept for 30 days, and the log for today is called “_current.log”.
Any internal log errors will be logged to _interanl-log.log

NB! if you set the log level to Trace it will log a lot of data. Only have this enabled for a short time.

Data Dump

What is data dump

Data dump, is a service that will store the current state and location of all users in Totalview to a given directory.

 

How to enable data dump

Stop the MobileWeb connector from the Totalview Admin console.

From Totalview Admin, select the MobileWeb connector in Connectors-Overview and press Install/Update.

Open Totalview3WCF.exe.config in a text editor and add this section right below the <configuration> tag

<configSections>
<section name=”dataDumpConfigurationSection” type=”Totalview.ConfigurationSections.DataDumpConfigurationSection, Totalview3WCF”/>
</configSections>
<dataDumpConfigurationSection outputDirectoryPath=”c:\DataDump” saveInterval=”00:05:00″ saveAsHTML=”false” errorEmailToAddress=”mail@domain.com”/>

 

Valid options for the dataDumpConfigurationSection

Name Type Default value Required Description
outputDirectoryPath Text Yes Where the files should be written
saveInterval TimeSpan 00:05:00 Yes The interval for the pull
saveAsHTML Boolean false No File format as fully styled .html file (false provides plaintext .txt file)
errorEmailToAddress Text No If an error occurs, it will be logged and sent to this address.
errorEmailFromAddress Text No If an error occurs, it will be logged and sent from this address. Not used if email is sent using the Exchange connector.

 

 

Save as HTML

Example of Data Dump file with saveAsHTML configuration option set to “true”.

 

Error Emails

If you write an email address in the errorEmailToAddress field in the dataDumpConfigurationSection, an email will be set to this address if an error occurs.

The same email will be sent once every 30 minutes as long as the error persists.

Totalview Data Dump Error Email

Example of Data Dump Error Email

HTTPS MobileWeb Connector Configuration

Prerequisites

All prerequisites must be passed before the configuration can commence.

1. MobileWeb connector must be configured and running with settings that are going to be used in production, except that it is running http instead of https.

To verify that it is running, query the MobileWeb connector endpoint with browser.

For example http://localhost:8034/rest/registerversion.

Replace localhost:8034 with the actual values used in your installation. Note the port number, as it will be used again later in this guide.

The response from MobileWeb connector to the HTTP request should be a JSON with RegisterVersionResult and information about license and version numbers.

2. PowerShell version must be 3 or newer.

To determine PowerShell version, run the following command in PowerShell (as Administrator) prompt:

$PSVersionTable.PSVersion.Major

The output should be 3 or higher.

3. A valid certificate, with private key, must be installed on Personal Certificate Store for Local Computer account.

To see list of installed certificates run in PowerShell, as Administrator:

Get-ChildItem Cert:\LocalMachine\My

The certificate intended to be used with the MobileWeb connector must be shown in the output from the command.

To verify that you also have the private key for the certificate, an export with certutil -exportPFX should output message “Encryption test passed”.

Run the following in PowerShell (as Administrator):

certutil -exportPFX <thumbprint> foo.bar

Use the relevant thumbprint from the Get-ChildItem command before.

There should now come a prompt to provide password. Press ctrl+c to abort.

In the output for the certutil command it should say “Encryption test passed”, before the password prompt. If that’s the case, then the certificate is installed correctly, with private key.

If, in the output of the certutil command it says, “Cannot find the certificate and private key for decryption.”, then you don’t have the private key and cannot proceed with configuring MobileWeb connector for secure communication (https) until this is fixed.

Gather Information

1. Get MobileWeb port number

(This step can be skipped if you already got the MobileWeb connector port number in the prerequisite check section.)

Start PowerShell prompt as Administrator in MobileWeb installation folder under Totalview installation. It is often C:\Program Files (x86)\formula.fo\Totalview3\WCF\MobileWeb_XXX (where XXX is MobileWeb connector name in Totalview Admin).

Run the following command:

Get-Content Totalview3WCF.exe.config | Select-String “add baseAddress” | Select-Object -First 1

This should output the MobileWeb connector endpoint and the port number that it is running on.

2. Assign MobileWeb connector port number to PowerShell variable

Store the port number from previous command in a PowerShell variable by running the following command (RUN AS ADMINISTRATOR):

$mobilewebport = <port number>

Replace <port number> with the port number outputted in PowerShell command in previous section.

Example:

$mobilewebport = 8034

Verify that the port number was saved by running the following command:

echo $mobilewebport

It should output the port number to the console.

Use this same PowerShell session for the remainder of this guide.

3. Get certificate thumbprint

Take the thumbprint of the certificate that passed in step 3 of the prerequisite check. Assign it to a PowerShell variable the same way as you did with the mobilewebport variable:

$thumbprint = ‘<thumbprint>’

Example:

$thumbprint = ‘6042aef35be8da8a454d0288cf57f6e8’

Verify that the thumbprint was saved by running the following command:

echo $thumbprint

It should echo the thumbprint value in the console.

Use this same PowerShell session for the remainder of this guide.

Making the switch to HTTPS

MobileWeb Configuration

Method 1: Manual Edit

Stop the MobileWeb connector from the Totalview Admin console.

From Totalview Admin, select the MobileWeb connector in Connectors-Overview and press Install/Update.

Open Totalview3WCF.exe.config in a text editor and follow the instructions described there.

Method 2: Script

Stop the MobileWeb connector from the Totalview Admin console.

From Totalview Admin, select the MobileWeb connector in Connectors-Overview and press Install/Update.

Use the same PowerShell session as in previous sections. Make sure your current directory is in the MobileWeb connector folder.

Execute the following two commands to make the configuration changes MobileWeb connector configuration file:

$qm = [string]([char]34)

(Get-Content Totalview3WCF.exe.config).Replace(“baseAddress=$($qm)http://”, “baseAddress=$($qm)https://”).Replace(“bindingConfiguration=$($qm)basicHttpWithoutTls$($qm)”, “bindingConfiguration=$($qm)basicHttpWithTls$($qm)”).Replace(“bindingConfiguration=$($qm)webHttpWithoutTls$($qm)”, “bindingConfiguration=$($qm)webHttpWithTls$($qm)”).Replace(‘httpGetEnabled’, ‘httpsGetEnabled’).Replace(‘mexHttpBinding’, ‘mexHttpsBinding’) | Set-Content Totalview3WCF.exe.config

There is no output.

Verification

To verify that the configuration has been updated a sample of baseAddress attribute can be made. The protocol value should now be https, instead of http:

Get-Content Totalview3WCF.exe.config | Select-String “add baseAddress” | Select-Object -First 1

Windows OS Configuration

Run the following commands to assign the certificate to the port where the MobileWeb connector is running:

netsh http add sslcert ipport=”0.0.0.0:$mobilewebport” certhash=”$thumbprint” appid=”{bfc1c581-4403-4fcf-b527-5312d1511822}”

If you get error “Cannot create a file when that file already exists.”, then you need to remove existing sslcert configuration for same port. Running the following command, and rerunning previous netsh http add sslcert, should fix the issue:

netsh http del sslcert ipport=”0.0.0.0:$mobilewebport”

Now start the MobileWeb connector again.

Verification

Verify in Totalview Admin that the MobileWeb connector is running.

Open https://localhost:8034/rest/registerversion (replace localhost:8034 with the actual values used in your installation) in browser.

Request should work and browser should say that communication is secure and certificate is valid.

HTTPS configuration is now complete. Congratulations!

Post Script

Beware when upgrading MobileWeb connector, using the Install/Update functionality in Totalview Admin, that all value in Totalview3WCF.exe.config will be changed back to be http compatible. To support https again, this must be reconfigured. This can be done by through the steps described in Making the switch to HTTPS section.
Alternatively the configuration file (Totalview3WCF.exe.config) can be backed up before Install/Update and then restored afterwards.

The Connectors view

Totalview uses connectors to receive and send user presence and other information to external systems.