TSS Configuration

Solution Installation > TradeSense Installation

Terminology

On the TSS Console, TradeSense is refered to as "Productivity Tool", sometimes shortened "BTPT".

TradeSense, Productivity Tool, BT Productivity Tool or BTPT are all synonyms.

TSS functional compatibility


		Given the version X.Y.Z: - X is the major version - Y is the minor version - Z is the patch version

The TSS "major.minor" version and the TradeSense"major.minor" upgrade bundle version must be aligned.

For instance, TradeSense with the upgrade bundle 9.4.foo is compatible with the TSS 9.4.bar.
TradeSense with the upgrade bundle 9.4.foo is NOT compatible with the TSS 9.3.waldo.

In this context, all that matters is the "major.minor" version, the "patch" version does not.

ImportantNote_Icon

TradeSense can be upgraded from a TSS version 9.3 or higher.

Functional compatibility, otherwise, depends on the above requirements.


		A TradeSense server in version 9.5 can be used with the other components in 9.6. However FTP server can't be stopped/disabled on the TSS.

TradeSense activation

TSS API resources required by TradeSense are disabled by default. They must be enabled.

Go to System > Settings > TSS Settings to enable authenticated authorization.

service.authorization=authenticated

Location: TSS Settings

General

Global authorization for TSS services	noneallauthenticated
Key: service.authorization Description: By default, no one is authorized to access some TSS services (API resources). They are like closed/disabled. Those TSS services require a specific authorization to be explicitly defined in order for them to be accessible. This setting is used to globally define an authorization for all TSS services that require an authorization to be explicitly defined. Use the setting service.{resource path}.authorization to explicitly define an authorization for the only TSS service whose path is the same as the one in the key. Constraint: From the most restrictive to the most permissive: - none (or close): no one is authorized to access the TSS services (default value) - authenticated: only authenticated users, devices or administrators are authorized to access TSS services by providing a valid authentication token - all (or open): everybody is authorized to access the TSS services without providing any authentication token

Make sure to click on "Reload Application" for this setting to be taken into account.

TradeSense clustering

TradeSense does not handle clustering for the time being, the feature will be available in future versions.

Yet, to account for these future developments, the TSS considers TradeSense as a node, part of a cluster.

Therefore, the provisioning must be done accordingly :

•one node must be created per TradeSense OVA (a typical installation would only have one OVA/node)

•a node must be associated to a cluster

Node creation

Log into the TSS console, go to Device Management > Productivity Tools and click "Add New".

ImportantNote_Icon

Naming constraint:

- can contain only number, upper/lower case letters, dot (.), hyphen (-), underscore (_)

- can NOT start with a dot (.) or hyphen (-)

- can NOT end with a dot (.) or hyphen (-)

- can NOT contain consecutive dots (..)"

Enter a node name and click on the "Save and Go Back" button.

The node name will be used during the TradeSense configuration process, it must be unique.

Cluster creation


		The naming constraints are the same as node ones, refer to the "Node creation" section above.

Log into TSS console and go to Device Management > Productivity Tools Clusters and click "Add New".

The cluster name will be used during the TradeSense configuration process, it must be unique.

Enter a cluster name and click on "Save and Go Back" button.

tradesense-link-node-to-cluster

1.Click on the cluster name that you have just created.

2.Go to the Nodes tab.

3.Click on "Available Productivity Tools Nodes".

4.Check the checkbox next to the node that you have created.

5.Click the "Link Selected" button.

6.Finally, click on the "Update and Go Back" button.

ImportantNote_Icon

In the Zones tab, the cluster is linked to all zones by default. It means that all the devices will be monitored by TradeSense.

It is possible to link only a few zones that will be monitored. However be careful that TPO clusters and users also need to be linked to a zone monitored by TradeSense so that Assure is able to retrieve all the necessary information.

SNMP

Important_icon

Make sure to enable SNMP both on the TSS (see "Configuring the TSS with the Command Line Interface"),

and on devices (see "IT System Monitoring/SNMP/Configuration_keys").

SNMP traps can also be configured to target the TradeSense IP address to centralize them on Assure.

If a custom SNMP community is used instead of the default one, it needs to be the same one for all the devices monitored by the same TradeSense cluster. In addition, the custom community needs to be configured in the Productivity Tools Cluster settings :

application.global.snmp.read.community=<CustomCommunity>

application.global.snmp.trap.community=<CustomCommunity>

Mandatory configuration

Customer Relationship Management (CRM)

Presence, calls information and line subscription are sent to TradeSense via the CRM events.

In the Turret boot settings

application.crm.serviceURI=http://<TRADESENSE-IP>/gecko/api/raw-events

Location: Terminal Boot Settings, Terminal Profile Settings, boot

CRM

Service URI
Key: application.crm.serviceURI Description: Defines the location used by the turret application to contact the CRM server. Warning: Netrix does not support HTTPS, and will attempt to use HTTP to connect to the CRM Server even if HTTPS has been specified. Constraint: String, must be the URL of an existing CRM server properly configured. Example: http://10.10.50.23:81/ If connecting to Tradesense the format must be: https:///gecko/api/raw-events Related settings: User Id (profile.setting.crm.userid) Password (profile.setting.crm.userpassword) CRM receive timeout (application.crm.receivetimeout) Enable backwards compatibility (application.crm.backwardscompatibility.enable) Defines CRM messages buffer size (application.crm.buffer.size) CRM retransmission policy (application.crm.retransmission.policy) CRM messages redundancy policy (application.crm.redundancy.policy) CRM alternate service URI (application.crm.alternateServiceURI) Allow usage of user password in CRM (profile.setting.crm.allowuserpasswordusage) Avoid to retry crm request (application.crm.ignoreretry)

When using HTTPS in CRM URI and TradeSense certificate is not signed by a CA trusted by the Turret (see Deploying a trusted certificate), the following additional settings must be added:

application.crm.ignoreErrorCertCA=true

application.crm.ignoreErrorCertCN=true

application.crm.ignoreErrorCertDate=true

application.crm.ignoreErrorCertUsage=true

In the Shared Profile / User Profile settings

profile.setting.authorizecrm=true

profile.setting.crm.announceallcalls=true

Location: Terminal Profile Settings, profile

CRM

Authorize CRM	truefalse
Key: profile.setting.authorizecrm Description: Authorize the use of CRM feature Constraint: true\|false Related settings: CRM default source (profile.setting.crm.default.source) CRM call queue applet index (profile.setting.crm.applet.source) Defines CRM messages buffer size (application.crm.buffer.size) CRM retransmission policy (application.crm.retransmission.policy) Allow usage of user password in CRM (profile.setting.crm.allowuserpasswordusage)

Location: Terminal Boot Settings, Terminal Profile Settings, profile

CRM

Announce all calls	truefalse
Key: profile.setting.crm.announceallcalls Description: Defines if calls that are not the target of the CRM applet (by default, the active HS) generate requests to the CRM server. Enabling this setting allows to receive priority information on all calls, as well as being able to take actions on the calls through the Click-to-dial API. Constraint: true\|false Related settings: Defines CRM messages buffer size (application.crm.buffer.size) Announce line state changes to the CRM server (profile.setting.crm.linestate.enable) Defines tags allowed to be attached to an established call (profile.setting.call.tags)

Note : these settings are subject to a license

Optional configuration

Walk The Floor configuration

To be able to do a Walk The Floor test, Click-to-Dial needs to be enabled on the users.

In the Shared Profile / User Profiles

profile.setting.authorizetsp=true

Location: Terminal Profile Settings, profile

User Settings

Authorize Click-to-Dial	truefalse
Key: profile.setting.authorizetsp Description: Defines if external Click-to-Dial requests are treated by the turret to perform actions on calls. Constraint: true\|false If true, requests are treated. If false, requests are ignored. Related settings: Enable TCP on SIP stack (application.sip.enableTCP) TSP request skip line infos (profile.setting.tsp.skipline) Clear "on error" handset before placing TSP call (profile.setting.tsp.clear.onerror.hs)

Note : this setting is subject to a license

Recording configuration

These settings are necessary for Assure to be able to check calls on the Voice Recorder platform.

In the Turret boot settings

application.recorder.ddi.wait.mastercallid=true

application.global.recorder.keepalive=true

Location: Terminal Boot Settings, boot

Recorder

Recorder wait DDI master callID	truefalse
Key: application.recorder.ddi.wait.mastercallid Description: This key only impacts DDI calls. If this key is set to true, the turret will wait to receive the master call ID from the TPO to start to record a call. This master callID is sent to the turret as soon as the master call is created. This avoid to send 2 different callIDs to the recorder for a same call on the turret. Constraint: true\|false

Location: Terminal Boot Settings, TPO Shared Settings, TPO Private Settings, TPO Boot Settings, boot, profile

Recorder

Recorder keep alive	truefalse
Key: application.global.recorder.keepalive Description: The keep alive mode should be activated both on the Recorder Server side and on the Turret side. If keep alive mode is activated, the Recorder Server sends periodically a keep alive message. The connection will be considered as lost if no keep alive message is received by the turret during a defined time.

In the Shared Profile / User Profile settings

profile.setting.recording.adddeviceidinfo=true

Location: Terminal Boot Settings, Terminal Profile Settings, boot, profile

Recorder

Send device type information	truefalse
Key: profile.setting.recording.adddeviceidinfo Description: This parameter allows the recorder module to send the device type (Handset, Loudspeaker)information of the call For recorder server which support device type information, the recorder module sends them in the form defined in the FID-REC-GEN-01.pdf.

In the TPO boot settings

application.recorder.usetpodnsname=true

application.global.recorder.keepalive=true

Location: TPO Shared Settings, TPO Private Settings, TPO Boot Settings

Recorder

Use TPO name/DNS name as Device Id and User Id for recording	truefalse
Key: application.recorder.usetpodnsname Description: When this parameter is enabled, TPO name/DNS name is used as Device Id and User Id for recording.

Location: Terminal Boot Settings, TPO Shared Settings, TPO Private Settings, TPO Boot Settings, boot, profile

Recorder

Recorder keep alive	truefalse
Key: application.global.recorder.keepalive Description: The keep alive mode should be activated both on the Recorder Server side and on the Turret side. If keep alive mode is activated, the Recorder Server sends periodically a keep alive message. The connection will be considered as lost if no keep alive message is received by the turret during a defined time.

Call geolocation

TradeSense monitors devices exposed by the TSS with the help of Zones.

Important_icon

By default, TradeSense monitors all Zones.

If no Zone is selected, no information will be available.

Zones can be used to enrich Assure and Analytics call data with location information.

In this setup, a Zone corresponds to a geographical region.

By configuring the country, region and city for a Zone, reports will benefit from the following improvements:

•when the "country" is set, phone numbers will be located to city level of accuracy

•a location can be given to external local area calls dialed without an area code

•internal calls can be geolocated following the values provided in their respective Zone

If a Zone does not have location data configured, TradeSense will fall-back to the System zone values, if available.

Go to Device Management > Zones and either click on "Add new" to create a new one or on specific Zone name to edit an existing one.

From the General tab of the Zone edition page, you can set Country, State, City and Call Prefix information.

Dialing plan rules

Dialing plan rules are used to help determine the location of the remote party in a call.

Since the actual configuration on a platform can be a very complex interaction of settings at the Zone, Profile, Turret, User and CUCM levels, the values here should be chosen to enable a best effort description of the dialing plan.

In the Productivity Tools Cluster settings

profile.setting.dialingrule.internalnumberlength.min=5

profile.setting.dialingrule.internalnumberlength.max=6

profile.setting.dialingrule.internationalnumberlength=13

profile.setting.dialingrule.internationaloutgoingprefix=00

profile.setting.dialingrule.outgoingprefix=9

Voice Recording check Configuration

The setting (application.assure.vr.check.only) provides the admin an option to configure the calls that needs to be checked for voice recording. See below for available options for this setting.

In the Productivity Tools Cluster settings

application.assure.vr.check.only=ALLCALLS

Voice Recording check will be done for all calls

application.assure.vr.check.only=WTF

Voice Recording check will be done for Walk The Floor Calls only

application.assure.vr.check.only=EXCEPTWTF

Voice Recording check will be done for all calls except Walk The Floor Calls