Initial configuration

An impersonation account is a Microsoft Exchange service account given the ApplicationImpersonation role by the administrator. Impersonation allows the caller (in our case, TrueConf Calendar Connector) to act as a user account. This means that the caller can perform operations using the permissions associated with the impersonated account, instead of its own permissions. Such an account is used in scenarios where centralized mailbox management is needed, such as in support services or automated systems.

Before configuration you need to generate an encrypted password for the impersonation account by executing this command:

Windows

C:\Program Files\TrueConf\Calendar\tc_calendar.exe --hash_pass <password>

Linux

sudo /opt/trueconf/calendar/bin/calendar/tc_calendar --hash_pass <password>

• where <password> is the password for the Microsoft Exchange impersonation account. If there are multiple passwords, list them separated by spaces (pass1 pass2 .... pass n).

A unique version will be generated for each password. Each line with an encrypted password matches the position of a password in the command line: Your encrypted data: dGNf....

Configuration file description

To configure TrueConf Calendar Connector, use the file stored at this path:

• on Windows C:/Program Files/Trueconf/Calendar/config.json

• on Linux /opt/trueconf/calendar/etc/calendar/config.json

The configuration file mentions the TrueConf Calendar Connector database which is intended for caching data from the Microsoft corporate server. This database helps to reduce the number of requests to the events server, which positively affects performance. The use of an encrypted password for database access ensures the security of confidential information and prevents unauthorized access. This practice complies with corporate data protection standards.

Configuration of database and network port

{
  "wsPort": 4315, 
  "dbConnectionConfig": {
    "host": "localhost",
    "port": 5441,
    "user": "bridge",
    "password": "", // by default, there is no password for database access, but if a password is set, you need to specify the encrypted password previously created for the impersonation account here
    "database": "calendar"
  },

• "wsPort" – the port for the operation of the WebSocket server. This section should be edited, if a different port was selected during installation.

• "dbConnectionConfig" – this section is needed for database connection configuration. The parameters in this section are automatically generated during installation and MUST NOT be changed manually.

Conference settings

"launchConference": true,
"temporalConfParticipantsMode": false,
"cache": {
  "autoSync": false,
  "backward": 2,
  "forward": 3
}

• "launchConference" – this parameter is responsible for the automatic start of a conference. TrueConf Calendar Connector sends a request to TrueConf Server when an event starts in Microsoft Exchange.

• "temporalConfParticipantsMode"– this parameter is responsible for adding users to the list of “expected” participants. If set to false, all users will be added to the list of participants in advance and will be able to use the chat outside the conference. If set to true, users will be invited when the event starts and will have access to the chat only during a conference.

• "cache"– the section where automatic synchronization settings can be configured:

  • "autoSync" – if set to true, calendar events will be fully synchronized. If set to false, the events created previously will not be displayed or synchronized within the selected time period.

  • "backward" – the number of months back from the current date for which recurring events should be displayed

  • "forward" – the number of months ahead of the current date for which recurring events should be displayed.

Configuration of access to TrueConf Server

"productWhitelist": {
    "tcs": ["server.trueconf.name#vcs"]
 }

• "server.trueconf.name#vcs"- you need to specify the address (or domain name) of TrueConf Server that will have access to TrueConf Calendar Connector.

Configuration of access to Microsoft Exchange

On the Microsoft Exchange side, you need to pre-create impersonation accounts permitted to view calendars "on behalf of" other users.

  "calendarProviders": [
    {
      "host": "exchange.domen.com", 
      "path": "/EWS/Exchange.asmx", 
      "port": 443, 
      "type": "ews", 
      "credentials": [
        {
          "login": "test",
          "password": "encrypted_password"
        } 
        ],
      "users": [
        "name@domen.com"
      ]
    }
  ]
}

• "calendarProviders"- the section where one can configure the settings for external calendar synchronization services

• "host" - the domain of the Microsoft Exchange server

• "path" - the path for accessing the EWS API (default path is specified)

• "port" - the default port for connecting to EWS

• "type" - the name of the external service (only Microsoft Exchange is supported)

• "credentials" - the section where one has to specify the credentials for the impersonation account on the Exchange server

  • "login" - the login for the corporate Exchange account

  • "password" - the encrypted account password. It is generated in the terminal.

• "users" - an array of users' email addresses. The calendars of these users need to be forcibly synchronized when the tc_calendar service starts.

Maintenance

On Windows TrueConf Calendar Connector is controlled with the task manager.

How to start the calendar application

After specifying the required parameters described above, start TrueConf Calendar Connector with this command:

sudo systemctl start trueconf-calendar.service

If the launch limit is exceeded, run this command:

sudo systemctl reset-failed trueconf-calendar.service

Calendar test

To test the work of TrueConf Calendar Connector, run this command:

sudo systemctl status trueconf-calendar.service

You will receive one of the responses:

active (running) – TrueConf Calendar Connector is working normally.

failed – TrueConf Calendar Connector is NOT working. In this case, try restarting the service using the command described above.

In case of any issues, please contact our technical support.