1. Introduction

The trueChart Service is a Windows service application that runs on the server besides Qlik Sense and is responsible for serving and saving all the neccessary data for every user of trueChart.

2. Controlling the trueChart Service

The trueChart service is a Windows service that is generated and automatically started upon installation of trueChart and can be controlled the same way as any other Windows service:

  1. Open the Service console from the Server Manager, Start menu or by running console.msc.

  2. Click on trueChartService from the list of services.

  3. Start, stop or restart the service by clicking on the control buttons in the console’s toolbar.

tcservice windows services

Apart from the Services console, any Windows service can be also controlled via the command line by utilizing the sc command.

To query the status of the trueChart service, simply execute sc query trueChartService:

C:\>sc query trueChartService

SERVICE_NAME: trueChartService
TYPE : 10 WIN32_OWN_PROCESS
STATE : 4 RUNNING
(STOPPABLE, NOT_PAUSABLE, IGNORES_SHUTDOWN)
WIN32_EXIT_CODE : 0 (0x0)
SERVICE_EXIT_CODE : 0 (0x0)
CHECKPOINT : 0x0
WAIT_HINT : 0x0</pre>

The service can be started or stopped using sc start trueChartService or sc stop trueChartService respectivly.

Using the sc command has the additional advantage of being both scriptable and allowing you to control the service on a remote server by putting the hostname before the control command, e.g. sc tcserver query trueChartService, where tcserver is the hostname of the target system.

More information about sc can be found at MSDN.

3. trueChart Management Console

The trueChart Management Console is a web-based application for configuring and administrating the trueChart Service and used for:

  1. User administration

  2. License management

  3. Accessing logfiles

3.1. Accessing the trueChart Management Console

The location of the trueChart Management Console depends on the settings of your trueChart installation and was set during the installation process. The default location is: http://truecharthost:8080/trueChartService where truecharthost is the server trueChart has been installed on.

To open the trueChart Management Console type in the URL into your web-browser to get the log-on page:

tcmc login
Figure 1. The login dialog of the trueChart Management Console

After logging-in with the admin credentials that have been set during the installation process, you will get to the My Profile page.

If you cannot access the trueChart Management Console this way, the right URL can also be obtained by opening the config.xml file in the trueChart installation directory (default: C:\Program Files\High Coordination) and looking for the ServiceHost, ServicePath and ServicePort elements:

<ServiceHost>http://localhost</ServiceHost>
<ServicePath>trueChartService</ServicePath>
<ServicePort>8080</ServicePort></pre>

3.2. Setting the license key

Follow these steps to enter your trueChart license key into your installation of trueChart:

  1. Open the trueChart Management Console.

  2. Go to the Settings page.

  3. In the General pane click on the dash next to License Key.

  4. Paste your License Key.

  5. Click on Apply License.

tcmc applylicense
Figure 2. Applying a license in the trueChart Management Console.

3.3. User management

Local user management

Adding new users
  1. Open the User Administration page in the trueChart Management Console.

  2. Click on Create Local User.

  3. In the New User dialog, enter First name, Last name, Username, Language and desired role from the Permissions list.

  4. Click on Save to create the new user.

After these steps are done, the new user will appear in the Users section.

Changing existing users
  1. Open the User Administration page in the trueChart Management Console.

  2. Hover over the user you want to change and click on edit.

  3. Change the desired user information.

  4. Click on Save to apply the changes.

Deleting users
  1. Open the User Administration page in the trueChart Management Console.

  2. Hover over the user and click on delete.

Connecting LDAP

The trueChart Service can be linked to a existing LDAP service (such as OpenLDAP, Active Directory, eDirectory, etc.) to control access to users already existing in your directory:

  1. Open the trueChart Management Console and go to the Settings page.

  2. Click on New Directory.

  3. In the New LDAP Connector dialog enter the following information:

    1. Name and Domain name of the LDAP server

    2. URL to the Port the LDAP service is listening on.

    3. Username and Password to authenticate to the LDAP service.

    4. Sync-Interval and Search Timeout

4. Managing applications

The trueChart Management Console features an overview of all applications on the Applications page, where they can be published, copied, deleted or versioned. It also features an overview on common tables.

5. Transport management

Transports are a way to transfer apps or common tables from one server to another.

5.1. Adding remote systems

Before you can transport apps or common tables, the desired remote systems need to be added:

  1. Open the trueChart Management Console.

  2. Go to the Transport Management page.

  3. Click on New Remote System.

  4. In the New Remote System dialog enter a Name, the URL to the trueChart service of the remote system, Username and Password of the administrator account set up for the remote server.

  5. Optionally click on Test Connection to verify your input.

  6. Click on Save to add the remote system.

The remote system is now enlisted in the Remote System section of the Transport Management page.

5.2. Deleting remote systems

Remote systems can be deleted by hovering over the remote system entry and clicking on delete.

5.3. Creating transports

Transports can be created for both applications and common tables.

Before creating a new transport, ensure to click on the Applications or Common Tables tab before, depending on what type of transport you want to create. After that, follow these steps:

  1. Click on New Transport.

  2. In the New Transport dialog, enter a desired Name of transport and the target system from the Remote System list.

  3. In the same dialog, choose at least one of the provided apps resp. common tables.

  4. Set the properties for every checked app or common table by clicking on the icon in the Properties column (see next section for description).

  5. Click on Save to create this new transport.

After this, the new transport is visible in either the Applications or Common Tables list.

5.4. Transfer properties

In the Transfer Properties dialog, you can check which types of texts are affected by the transfer. These are Title, Subtitle, Comments (perspective) and Comments (local table).

Note that the text transfer setting can be overwritten in the text properties of the extension!

5.5. Starting a transfer

To start a transfer, hover over the transfer entry and click on start. The icon of the entry indicates if the transport was successful.

5.6. Editing a transfer

To edit a transfer, hover over the transfer entry and click on edit. This will open a dialog with all the settings known from the New Transport dialog.

5.7. Deleting a transfer

To delete a transfer, hover over the transfer entry and click on delete.

5.8. Remote triggers

It is not neccessary to start a transfer from the trueChart Management Console. Every transport can also be triggered by sending a HTTP request to the trueChart service. To obtain a trigger URL for a transfer, hover over the transfer entry and click on remote trigger. This will open the Remote Transport Trigger dialog and provide a URL for the remote trigger.

6. Log files

The trueChart Management Console offers a way to obtain log files from several components of the underlying trueChart infrastructure.

6.1. Obtaining the log files

  1. Open the trueChart Management Console.

  2. Go to the Settings page.

  3. In the Category pane, choose Logfiles.

  4. Pick one out of Latest, Last 7 days or All.

  5. This will provide a ZIP file containing all the logs of the choosen timespan.

6.2. Contents of log files

The log files archive contains the following files:

  • catalina.YYYY-MM-DD.log: Log of TomCat’s Catalina servlet container.

  • commons-daemon.YYYY-MM-DD.log

  • host-manager.YYYY-MM-DD.log

  • localhost.YYYY-MM-DD.log

  • localhost_access_log.2017-08-17.txt: HTTP access log of the trueChart Service.

  • manager.YYYY-MM-DD.log

  • truechartservice-stderr.YYYY-MM-DD.log: Standard error stream of the trueChart Service.

  • truechartservice-stdout.YYYY-MM-DD.log: Standart output stream of the trueChart Service.

  • trueChartService.log: Log of the trueChart Service.