MindLink API Management Center


Configuration Sections

The MindLink Management Center will load with the logging configuration as its default page. The user can navigate through different configuration settings by using the navigation tree , which includes the following configuration sections:

  • Licence
  • Logging
  • General
  • Lync/Skype for Business
  • Active Directory
  • Advanced
  • Feature
    • MindLink API


Licence

The licence page ensures the products you are using are firstly; supported by MindLink and secondly; that only the correct products (as stated by contract) are in use.

Opening the license tab, you are given the ability to browse for a file. This will be the file you received within the correspondence with your account manager.

Click the Browse for license file button which will open file explorer. Navigate to your license file.

icon

Click the Browse for license file button which will open file explorer. Navigate to your license file. Selecting a valid license file will show similar details to the corresponding management center image below.

For MindLink Mobile

  • License Holder: This field specifies the Company name the license is issued to and also the product owner at the time of purchase.

  • Expiry date: The date the product expires. At this time (grace period built in) the product will cease to function.

  • Details: This field contains the product/s that the license has been issued for. MindLink will not run with an incorrect product license (a single license can be issued for multiple products).

icon

For MindLink Anywhere Same principles apply for MLA licenses, but there is an extra feature explained below.

icon

Enabled users: This capacity is based on the number of users who couldlog on, rather than the current number of users logged on.

The system periodically checks the number of users who could log on and starts rejecting new logons if it sees that the number of hypothetical users is larger than the licensed capacity.

If a license reaches expiry the following message will appear. Please contact your account manage to receive a current license within contract renewal.

icon

If a license is issued for a different product to the one you are attempting to run. The following message will appear stating the product this license is valid for. Please contact your account manager to discuss increasing your subscribed products.

icon


Logging

The logging section enables the user to configure the logging level as well as the log file location for the Connector Service.

Please note that logging on the Connector Service is performed using the Microsoft Enterprise Library Logging Application Block.

logging

By default logging is configured as follows:

  • Error level - Error class events
  • Warning level - Warning class events (Recommended)
  • Info level - Info class events
  • Verbose level - All class events

Logging Configuration

You can Configure the Connector service logging level and log file location by Clicking on the Browse button will let you find an absolute path to a new log file location, or you can manually edit the field to a path relative to the Connector Service install location.

The account used to run the Connector Service must have write access to the install location of the product in order to log to the rolling log file. The file can by default be found at %ProgramFiles%\MindLink Software\MindLink Application\ConnectorService\Logs\Connector.log


General

The General section lets the user configure the general settings that will be applied to the Connector Service.

API General

Informaion Service

Information service port: The port number used when behind a load-balancer to provide a service heart-beat.To allow collocation, Default Ports are as below and can be tested eg http://{server}:9007/Connector/InfoService/Status

  • MindLink API = 9006
  • MindLink Anywhere = 9007
  • MindLink SharePoint 9008
  • MindLink Mobile = 9009

Features

As of 17.3 the MindLink Foundation API has the functionality required to disable the group chat modality. This is contained under the general& section of the API management centre.

If IM is disabled for the API then the Active Directory node is disabled. Conversely if it is enabled the Active Directory node becomes enabled.

With IM disabled the app/bot is unable to send a message to a channel that is not valid, thus the channel ID parameter would be invalid hence the bad request that would be subsequently thrown. This is because REST APIs throw errors when the schema isnt met.

Enable instant messaging: When set, allows connected clients to use instant messaging.

When not checked, user presence will not be published, instant messaging will be disabled, and the client will be limited to group messaging functionality. Any client that exposes instant messaging functionality when instant messaging is disabled will receive failure notifications from the server when an attempt is made to use such functionality.

Enable group chat: When set, allows connected clients to use group chat.

When not checked, group chat preferences are not loaded and users will not see any groups or chat rooms to which they are subscribed in their contacts list nor will they be able to search for and add groups.

Message Constraints

Maximum message length: The number of characters that a single message can include.

If an attempt is made to send a message that is longer than the specified length, the server will not send the message and an information message will appear in the server logs.

Maximum story length: The maximum number of characters that a single story can include.

If an attempt is made to send a story that is longer than the specified length the server will not send the story and will return an error indicating that the story exceeded the allowed story length.


Lync/Skype for Business

Lync/Skype for Business The Adaptor section manages the selection of the underlying chat system to which to connect and the infrastructure DNS servers that define the chosen platform.

Topology

Server Version: Select the chat platform version.

Auto Provisioning Server Information: (Lync 2013/SFB Only) Enable the auto detection of the Front End Server. This will allow the server to detect any server changes within the Topology and auto configure the new servers. This requires Lync Core Components to be installed

Auto Provisioning Application ID: (Lync 2013/SFB Only) Enter the Application ID of the trusted application on the Front End.

Local Server Name: Manually enter the FQDN of the local machine

Next hop connection

Server Name: Manually enter the FQDN of the OCS/Lync/SFB front end or pool server.

Trusted Application Server

Server/Listen Ports: The default communication port for OCS/Lync/SFB used by the Front End Server to listen on when using trusted authentication.To allow Collocation the default ports are as below :

  • MindLink API => 4096
  • MindLink Anywhere => 4097
  • MindLink SharePoint => 4098
  • MindLinkMobile => 4099

Platform Certificate: The certificate to use for establishing an MTLS connection with the OCS/Lync server.

Persistent Chat

Auto Provision Group Chat Information: Automatic discovery of the lookup address for querying Group Chat Lync 2013 only. Use this option to look at multiple chat pools

Lookup Server Address : Manually enter the lookup address for querying Group Chat. This is the address created upon activation, , use Get-csPersistentChatEndpoint to identify.

Connect to Multiple Persistent Chat Pools Multiple Persistent Chat Pools

Users can connect to multiple persistent chat pools. This allows users to join any chatrooms that are in the located on any of the specified persistent chat pools

Explicit

Explicit conections involve specifying specific chat pools in the management tool. Only users within those specified persistent chat pools can login. A single chatpool can be specified in the Default Persistent Chat pool endpoint address field. Multiple chat pools are specified by clicking the Connect to multiple Persistent Chat pools checkbox. Entries added in the table can be removed by pressing the Delete key.

Explicit

Auto provision

Auto provisioned connections allow users to login as any user located on the configured persistent chat pools on the server. The user does not need to specify any of the configured chat pools to login as users located on them.

Preferences

Preferences: Sets the file repository for saving local preferences.

Sessions

Session timeout: This sets the timeout for MindLink Anywhere. The MindLink client will be set to an idle/away status after being disconected from the network after the configured time has elapsed.


Active Directory

active directory figure

LDAP Connections

Enable Auto discovery of Global Catalogue

OCS/Lync/ Forest Name: Select the relevant forest name in which platform is installed and base for AD operations for users.

Server Name: Manually enter the FQDN of the LDAP server is Auto-Discover is not detecting correctly.

Use Default Port: Default port number of the Global Catalog used to look-up user SIP addresses from Active Directory i.e. 3268.

Port Number: To enter a custom port number to look-up user SIP addresses from Active Directory.

Active Directory Time-out: Specify the time interval in seconds for Active Directory queries.

Use Default Naming Context: Auto-discover the name of the root context of the directory. Use this is membership is not restricted.

Naming Context: Manually enter full OU path if users are to be restricted to this AD OU object


Advanced

Advanced tab

You can add debug keys (such as configuring Exchange Online or enable pre-release features) and you can also override any other configuration value. Examples of a couple custom setting keys include:

  • Configuration key: connector.uma.serverversion Value: Unknown
  • Configuration key: global.message.maxlength Value: 200

Notes when using custom settings:

  • Custom key/value

  • Invalid keys cause the host to crash


This section manages the MindLink Foundation API settings.

MLM

Server

Service port: The port on which to listen for incoming API connections.

Disable security: If ticked, the foundation service will be hosted as an HTTPS service, meaning that all data is encrypted between agents and the service.

Certificate: The server certificate to use for incoming connections required only when configuring for HTTPS.

Channel search timeout (seconds): Specify the timeout, in seconds, for the search channel operation against the MindLink Foundation API Service API Channel Search Timeout

Authentication

4 Authentication mode: select from ntlm, windows or manual modes.

5 Super User: A full username (including domain, in the format DOMAIN\user) of the user who will be the super user. This user will always be able to access the provisioning functionality of the foundation API, regardless of the user configuration. Other users with access to provisioning functionality can be created using the API itself.