Creating Tabular Report with single select input parameter in Helical Insight Community Reporting Method

Introduction : In this blog we are going to explain how to create a tabular report which represents the source wise travel cost by filtering based on Journey_type (Single Select) input control using community reporting method in Helical Insight.

Please make sure you have gone through the blog “Introduction to Community Reporting Interface.”

Steps to create CE Tabular report with single select parameter:

1. Data Source
2. Dashboard Layout
3. Parameter
4. Report

1. Data source :

Create data source connection.

Here we are using connection type : plain jdbc

In the configuration of data source, provide the details as shown below.

<driver>com.mysql.jdbc.Driver</driver>   // sql driver 
<url>jdbc:mysql://192.168.2.51:3306/Travel_Data </url>  // jdbc url
<user>hiuser</user>  // database username
<pass>hiuser</pass>  // database password

Note : You can choose other kind of data sources. The rest of the steps are the same as others.

2.Dashboard Layout :

In the dashboard layout we basically specify the layout of the report, dashboards, input parameters which we are creating. All the divs are specified here within which they get rendered.

Here we are creating 2 divs: client_name, client_wise

Input Parameter div is: client_name

Report div is: client_wise

When you click on dashboard layout a layout similar to below will appear:

In the above screen shot we find two options (left side)

HTML and CSS .

If you click on HTML/CSS the place holder for respective component will be displayed and highlighted in the Dashboard layout panel.

We can place the code related to layout in HTML and styling in CSS.

Dashboard layout:

HTML Code:

<script type="text/javascript" charset="utf8" src="https://cdn.datatables.net/1.10.19/js/jquery.dataTables.js"></script>
<link rel="stylesheet" href="https://cdn.datatables.net/1.10.19/css/jquery.dataTables.min.css">
<div class = "col-sm-4 col-md-4 col-xs-4" id="client_name">Travel Type</div>
<div id="client_wise"></div>

CSS:

#client_wise{
padding-left :20px !important;
padding-right :20px !important;
}

3. Parameters :

Parameters are used to filter the report data. These parameters can be single select, multiple select, date range, slider, date picker etc. We can create multiple parameters for the single report/dashboard.

When you click on add button, the parameter is created with default name parameter1. We can rename the parameter name with the help of edit icon and keep as “Journey_Type”

We should place the code for Parameter configuration, parameter query in their respective place holders.

Click on apply button to save all the configurations.

In this sample we are creating single select parameter named “Journey_Type”

A. Journey_Type : (single select)

Choose connection as “connection1”(previously created in data sources)

Here “Journey_Type” is a Single-select input control, so we need to choose input type as “String” as shown in below image. By default it is always “String”.

Note : For all multi select parameters we should select “Collection” irrespective of parameter datatype. If it is single select parameter we choose the type based on datatype of parameters

Configuration :

var dashboard = Dashboard;
dashboard.resetAll();
dashboard.setVariable('Journey_Type','Domestic');

var Journey_Type = {
    name: "Journey_Type",
    type:  "select",
    parameters:["Journey_Type"],
  options:{
        multiple:false,
        value : 'Journey_Type',
        display : 'Journey_Type',
        placeholder: 'Select Journey_Type'
    },
    htmlElementId : "#client_name",
    executeAtStart: true,
   map:1
}; 

SQL :

select distinct Journey_Type as Journey_Type FROM  `Travel_Data`.`Traval`

Note: If you do not have any parameters please make sure that you will have to add below code in the “Report” configuration as shown in below.

var dashboard = Dashboard
dashboard.resetAll();

In case if you delete first parameter then also you need to provide above code in “Report” configuration.

Note: The configuration script is added only for the first parameter. For all the remaining parameters, this script should be copied and the necessary changes are to be made.

4. Report :

We can configure different visualizations to render in different divs in the dashboard layout.

When click on add report button, the layout will appear as show below :

In the left panel we find report, SQL, Visualization related options.

Click on configure, on the right side we can see the place holders for report configuration, SQL, Visualization. Place the respective code apply click on apply.

Here we need to choose chart type as “Table” , connection as “connection1” and parameter as “Journey_Type”.

Report Configuration :

var Tabular= {
name: "Tabular",
type:"chart",
listeners:["Journey_Type"],
requestParameters :{
Journey_Type : "Journey_Type"
},
vf : {
id: "1",
file: "__efwvf_name__"
},

htmlElementId : "#client_wise",
executeAtStart: true
};

SQL :

	select 
	`Travel_Data`.`Traval`.`source` as `source`,
	sum(cost) as cost  from `Travel_Data`.`Traval` 
	where Journey_Type = ${Journey_Type} group by `source` limit 10

Visualization :

<Dimensions>source</Dimensions>
<Measures>cost</Measures>

Note: After placing the configuration , SQL , Visualization then click on apply or (control+s)

After completing all the steps save the community edition report :

In the back end server location the following files will be generated

1. Efw (report view in the front end)
2. Efwce (editable file in the front end)
3. Efwvf
4. Html
5. Efwd

In the front end file browser we can see the below file types:

When we double click on the report view file (with the extension efw) report opens like below. The other file with the extension EFWCE can be used to edit the created report/dashboard again.

Table with Single input control report View :

For more details on EFWCE reporting refer the documentation :

EFWCE method of reporting in Helical Insight

For further assistance, kindly contact us on support@helicalinsight.com or post your queries at Helical Insight Forum