trueChart Knowledge Base Live Search

Search

Page tree

trueChart Help

Skip to end of metadata
Go to start of metadata

This document describes the first steps on how to use trueChart in Jedox.

Prerequisites

trueChart4Jedox requires that the trueChart Service is installed and accessible from the Jedox environment. Also you need to define a data range on your worksheet, which has at least two columns that includes the trueChart configuration.

First steps

Add trueChart to your work sheet

Add new custom widget via the top menu by clicking on “Tools” → “Widget” → “Custom Widget…​”.

 

In the upcoming dialog select HTML radio button in content field and open the editor.

Paste the following html into the editor and hit the save button.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>

</head>

<body>
<script type="text/javascript">
function __exec(a,b){
if(!window.dataUpdate){
window.data = [a,b];
}else{
window.dataUpdate(a,b);
}
}
</script>

<script type="text/javascript" src="https://truechart.highcoordination.com/tc4jedox/1.0.3/tc4jedox.js"></script>
<script type="text/javascript" src="https://www.truechart.com/core/1.3.0/index.js"></script>
</body>

</html>


In source field, select the range where trueChart find its configuration and the data model.

How to configure trueChart

trueChart reads all of the configuration from the first two columns of the data range. The first column defines the configuration key and the second one defines the value of that specific key.

It is a mandatory that you specify at least the service configuration to use trueChart. After the initialization process changing that part of the configuration has no impact. When you like the update the configuration afterwards, a reload is required.

The configuration parameters are case sensitive. If you add values in the first two columns that are not defined as keywords trueChart will ignore that, so commenting your configuration is possible.

trueChart Service

trueChart4Jedox needs connection to the trueChart Service for store the defined chart and comments.

DocumentName

The document name identifies the save status in the trueChart Service. So the definition of the chart will be used, of the document name.


Caution

trueChart4Jedox can not know if you like to update an existing chart definition or if you like to create a new one, so you need to make sure that you use an unique identification to not overriding an existing chart.


The
document title is displayed the trueChart Management Console for identifying the chart definition.DocumentTitle
DocumentLocation

The document location is the folder to which the chart definition is appended to at the trueChart Management Console.

ServiceHost

Insert the host on which the trueChart Service is running.

ServicePort

The parameter service port defines the port number of the trueChart Service. In a default installation that port will be 8080.

ServicePath

This parameter defines the path of trueChart Service in the url. In a default trueChart installation that is trueChartService.

UserName

The user name is used to identify the user to the trueChart Service.

Caution

Jedox will remove some special characters when it passes data to a custom widget. One of the characters is the '\'. So we recommend using the email address as user name.

Adding data

To use trueChart for charting, you need to specify where the data model can be found. This configuration need to be added to the first two columns of the data range.

Start defining a data model with the keyword DataModel and the name of the model. The next two rows have to include the keywords Dimension and Measure and the columns where the data is located. We have specified that this first row of the dimension or measure will be used as name of that specific data column.

Dimensions will be ordered by hierarchy. trueChart assumes that the last defined dimension has the lowest hierarchy. trueChart takes this column as a reference when preparing the data model for charting.

To define a data column there are 3 different ways:

  1. Adding only one column by defining its id started counting with 1 at the left column. So if your range starts in the column right of the configuration 3 is a valid value.

  2. Adding a range by defining a start and an end column with the '-' sign in between e.g. 3-5 means that it will include the columns 3, 4 and 5.

  3. Combining that two way for multiple ranges and columns e.g. 3; 5-7 will include all columns from 3 to 7 but not column 4.


Important

Make sure that all columns defined for the data range are specified in the trueChart widget.


Important

trueChart for Jedox fills up the data model by taking the last defined dimension column as reference column. If this column has empty fields the whole data row will not be displayed in your chart. In case attributes (Jedox) with empty fields will be used as last dimension, specified as lowest hierarchy, result in no data will be displayed in trueChart.

Adding variables to trueChart

To define BI variables you can proceed similar to data model.

Start defining a variable range by the keyword Variables. In the next two rows you need to define in which columns the Name and the Value of the variables can be found. Different to the data model for each of these keywords only one column is supported.

  • No labels