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>


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


User management

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

Managing applications

On the Applications page you're able to publish, copy and delete the settings of TRUECHART objects in any known applications/reports. It's also possible to archive the current TRUECHART settings and restore them later.
The actions that can be triggered on an app are only displayed when hovering the app entry with the mouse.

Additional you can delete all applications of one stream.

Copy app definition

This feature is to copy an application definition from one application to another.

The main use for this is for BI systems that don't support saving settings into the app directly. This way, the user could copy the definition from a dev app to the prod/published app for example.

Copying app definitions to an existing app will automatically create an archive state (version) for the target app.

After clicking on the copy button you will enter the "Copy Application" view. On this form you can define the stream ("Target mounted folders"), the target (original ID of the app, given from the BI system) and the copy settings for the comments.

After confirming the copy action the app definition will be copied from the source app to the target app.

The "Target mounted folder" does not default to the currently selected folder. So please take care to select the correct one.


To get the target information it might be helpful to first open the target app in the copy dialog to be able to copy the sourceID into the real targetID field.

If you want to copy a definition from an older state of a published app into the current one you need to compare the IDs carefully.

The IDs of published apps could be split into two parts. Part one is the AppID used by the BI system and the second part is the timestamp when this app was published.

To find the correct IDs the timestamp information needs to be compared. The most recent is the current state of the app. So this can be used as the target. Now you only need to find the correct source version and hit the copy button there, together with defining the correct target.

Delete an app

Apps are deleted permantently and cannot be restored.

There are cases when this might be helpful. For example in BI systems where the definition of an app is stored within the BI system and you want to revert everything to the state which is stored there.

Deleting an app:

After clicking on delete you need to confirm this action.

Deleting a stream

Deleting a whole stream is even more dangerous, as this action will delete all apps within this stream from the TRUECHART server.

In BI systems that do not directly support streams, all apps are stored in a single stream. This would result in deleting all apps that are created within that BI system.

This can be devastating for BI systems that don't support storing settings in the app directly, as no data can be restored from there.

After clicking on delete you need to confirm this action.

Archiving an app

The TRUECHART service has the ability to store a snapshot of the current app definition in case you want to try something and you're not sure if it will work as expected.

This only stores the definition of the objects. If you create new objects or delete objects within the app, these changes won't be covered by the archive restore functionality.

After clicking on that button you enter the version overview for that selected app.

Here you can configure how many versions are stored for one app and get a list of versions that are already stored, together with the information when it was created and through which action.

Actions that could create a new version entry are:

  • Direct user action (manual, by hitting the archive button at the bottom)
  • Copy of app definition
  • Transport of app definition between servers

Every time a new version within that archive list is created the system checks if some old version exceeds the configured limit. If this is the case then these old version will be removed. The maximum number of versions to keep is configured per app and is 50 by default.

Managing common tables

On the Common Tables page you're able to delete, archive or change the password for existing 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 necessary 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

Active Directory

A connection to your Active Directory can be established here and users will be synched to TRUECHART on regular interval

  1. Open the TRUECHART Management Console.
  2. Go to the Settings page.
  3. In the General pane click on the dash Active Directories
  4. Your existing Active Directories will be listed here  or you may click on NewDirectory to create a new one.
  5. Enter the Server settings,LDAP Schema,User Schema and Group Schema
  6. Optionally click on Test Connection to verify your input and Save your settings.

Bulk-import Users

The import dialog could be accessed through the settings tab. After that select Bulk import users at the left navigation panel.

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

There are 2 ways for importing users through CSV import:

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

Manual import

First, choose a file. The format of the file should match the following example.

example.csv
username;firstname;lastname;language;email;consumer;designer;nm;kpichat_admin;kpichat_consumer
domain\ahf;Achim;Höffner;en_US;achim@domain.com;;1;1;;
domain\cml;Christian;Müller;de_DE;christian@domain.com;1;;;;

The content of the file will be displayed for manual validation of the user. Now you could start the import.

The import consist of 2 steps:

  • uploading the file

  • starting a background job that runs the import

Automated import

You could activate and deactivate automatic CSV import at any time you want. You only need to place a file at the server, input its file path, and enter a Cron expression.

Some examples:
"0 0 * * * ?" - will run a hourly job
"0 0 1 ? * SUN" - will run a job every Sunday at 1 o’clock am

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

Cluster server configuration

The TRUECHART Service also supports clustered environments to handle bigger server loads with load balancers.

Information regarding cluster configuration.

Converter configuration

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

Cross-Origin resource sharing (CORS)

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

This 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.

Data Permissions

Download Extension

This entry is for downloading the different extensions for the different supported BI systems.

Further information could be found here: Download extensions for various platforms

Email Notifications

This is a KPI-Chat related setting. An email notification is an email sent to inform when an user is mentioned in a chat .

Follow these steps to configure the email server .

  1. Open the TRUECHART Management Console.

  2. Go to the Settings page.

  3. In the General pane click on the dash Email Notifications and enter the details for the server .

       Notification Enabled - To enable or Disable the feature 

SSL Enabled - To enable or Disable SSL

Host - Hostname of the Email Server

Port - Port number 

From - Address from which email is being sent ( eg: noreply@domain.com)

Label - Name given 

Username - Username for the Email Server

Password - Password to authenticate the Server 


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 for applying License for KPI-CHAT and/or TRUECHART

  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.

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 chosen 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