trueChart Knowledge Base Live Search

Search

Page tree

trueChart Help

Skip to end of metadata
Go to start of metadata

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

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 host and trueChartService is the service path.
For further information where to specify these settings, take a look at the domain settings section from the installation page.

There are different ways to access the trueChart Management Console:

  • Type the URL into the web browser

  • Click on the link within the Windows start menu


Accessing the trueChart Management Console through the Qlik Sense Broker Service is currently not possible due to restrictions of the Broker Service.
Please use one of the ways described above.
But be aware that you will get a security warning about a non-valid (self-signed) SSL certificate that needs to be accepted in order to access the trueChart Management Console.


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>


Login page

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 be brought to to the My Profile page.


User management

trueChart supports local (manual) management of users and permissions or automativ import through a ldap connection.

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.

Transport management

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

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.

Deleting remote systems

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

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.

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!

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.

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.

Deleting a transfer

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

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.

Settings area

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.

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

Connecting LDAP

Apart from the manual (local) creation and management of users, 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.

Information regarding ldap(s) configuration.

Cluster server configuration

The trueChart Service also supports clustered environments to handle bigger server loades with load balancers.

Information regarding cluster configuration.

Cross-Origin resource sharing (CORS)

This setting page is used to configure the CORS capabilities of the service which restricts the access to the trueChart ServiceAPI.

Figure 3. CORS settings

This list is a whitelist of possible URLs that have access. You can add new rules and delete existing rules to a minimum of one rule. Saving changes will directly affect the currently used CORS settings by the service.

Allowed formats are:

Replacing the domain with an IP is possible, too.

The last two examples will be automatically completed with a leading http and https. A validation during inserting the rules should prevent from invalid URLs.

Converter configuration

The HiCoConverter is a Windows service with activate the functionality of exporting images, pdf, and Excel documents with trueChart.

Information regarding converter configuration.

Bulk-import Users

The import dialog can be accessed through the Settings tab. After that select Bulk import users from the left navigation panel.

At the bottom of the dialog you see the status of the current or last import procedure.

There are 2 ways for importing users through csv import:

  • manual
  • automatic

Users that have access to the trueChart Management Console will be skipped during the bulk import.

File format

The file format is a semicolon separated representation of the CSV format.
Within the file we have the following columns:

  • username: The login name of the user.
  • firstname: The firstname of the user.
  • lastname: The lastname of the user.
  • language: Language setting of the user.
  • consumer: Does the user have consumer rights.
  • designer: Does the user have designer rights.
  • nm: Does the user have notation manual rights.

Values for consumer/designer/nm that will result in true:

  • wahr
  • true
  • ja
  • yes
  • j
  • y
  • 1

Example:

username;firstname;lastname;language;consumer;designer;nm
domain\ahf;Achim;Höffner;en_US;;1;1
domain\cml;Christian;Müller;de_DE;1;;
Personal\Me;Sense;Qlik;en_UE;0;1;1


The file needs to be encoded as UTF-8 without BOM. So be carefully when exporting it from Excel.

Manual


First choose a file. The content of the file will be displayed for manual validation of the user. Now you can start the import.

The import consist of 2 steps:

  • uploading the file

  • starting a background job that runs the import

Automatic (cron)


You can activate and deactivate automatic csv import at any time you want. You only need to put the file on the server, input its filepath and enter a cron expression.

Some examples:
"0 0 * * * ?" - will run hourly
"0 0 1 ? * SUN" - will run every sunday at 1 o’clock AM


Further examples and the full syntax specification can be found at www.quartz-scheduler.org.

Log files

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

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.

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.



  • No labels