There are various methods of integrating Helical Insight. One of the methods is using embed tag which we would be discussing here.

Following are the steps to achieve :

1. Create a report or dashboard using Helical Insight which you want to integrate.
2. Right click on the report or dashboard and open it in a new window. This way you will be able to get the URL specific to that report or dashboard.



3. Create a dummy user or use an already existing user for integration purpose.
4. Assuming dashboard to integrate, for this required folder/s, reports, metadata and dashboard has to be shared with that user. How to share file with a user clickhere
5. Once the required files are shared with the user then it will be in read only mode (dummy user cannot make any changes in the reports / dashboards)
6. For integration, an embed tag has to be included in application or web page. In that embed tag, pass the URL of the report or dashboard along with passing the username as well as password as indicated below.

embed tag code :

<embed id="helicalinsight-report-frame" src="https://applicationHost.com:8085/hi-ee/hi.html?dir=Travel_Dashboard&file=travel_dashboard.efw&mode=dashboard&j_organization=organization_name&j_username=user_name&j_password=login_password" style="height: 100%;width:100%;border:0px;" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen>
</embed></code>

Note: This link might be changed based on the port and extension provided while installation of Helical Insight.

Whereas,

embed id: any unique name can be assigned

src (source): It includes combination of source URL where Helical insight is installed, organization name, user name, user password, dashboard path and dashboard filename.

http://applicationHost.com:8085/hi-ee/hi.html: It is the baseURL of the application and port number on which application is running.

dir=Travel_Dashboard: It shows the directory name. In this case directory name is Travel_Dashboard.

file=travel_dashboard.efw: It shows the dashboard file name and the extension used is “.efw”. In this case, file name is travel_dashboard.efw.

mode=dashboard: mode parameter holds report type. If report is dashboard then mode=dashboard and if report is adhoc report then mode=report

j_organization=organization_name: j_organization parameter holds organization name. If organization is not present (login through superadmin) no need to pass this parameter.

j_username=user_name j_username parameter holds username.

j_password=login_password : j_password parameter holds password.

Passing Input parameters via URL

We can also pass input parameters while integrating any report/dashboard using embed tag.

To pass the input parameters we have to update URL passed in embed tag with parameter name and its value

Format of embed tag code with input parameters:

<embed id="helicalinsight-report-frame" src="https://applicationHost.com:8085/hi-ee/hi.html?dir=Travel_Dashboard&file=travel_dashboard.efw&mode=dashboard&TERRITORY=[“Japan”, “NA”,“Emea”]&STERRITORY=NA&j_organization=organization_name&j_username=user_name&j_password=login_password" style="height: 100%;width:100%;border:0px;" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen>
</embed>

OR

<embed id="helicalinsight-report-frame" src="https://applicationHost.com:8085/hi-ee/hi.html?dir=Travel_Dashboard&file=travel_dashboard.efw&mode=dashboard&TERRITORY=%5B“Japan”, “NA”,“Emea”%5D&STERRITORY=NA&j_organization=organization_name&j_username=user_name&j_password=login_password" style="height: 100%;width:100%;border:0px;" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen>
</embed>

where,

TERRITORY: Name of the parameter which is going to be triggered on the Integrated report.

[“Japan”, “NA”,“Emea”]: Value to be applied on TERRITORY parameter.

STERRITORY: name of the parameter which is going to be triggered on the Integrate report.

NA: Value to be applied on STERRITORY parameter.

Here TERRITORY is the multiple select parameter and we have to pass the multiple select parameter values inside square brackets ([ ]) with double quotes and separated with a comma (,) like (TERRITORY=[“Japan”, “NA”,“Emea”]).

Instead of square brackets, you can use %5B for [ and %5D for ], so it will look like TERRITORY=%5B"Japan","NA","EMEA"%5D

Here STERRITORY is the single select parameter and we have to pass single select parameter directly as STERRITORY=NA

If you want to pass date or date range as input parameter via URL please refer to the below description.

For date parameter in embed tag url you have to pass parameter and its value as date=2003-01-06.

For date range parameter in embed tag url you have to pass two parameter as sDate=2016-01-06, eDate=2017-05-31. Sdate means start date and EDate means end date.

NOTE: If you did not pass any parameter then report will open with default parameters which were defined while report creation.

Exporting in pdf/png/jpeg format via URL

Format of embed tag code with export:

<embed id="helicalinsight-report-frame" src="https://applicationHost.com:8085/hi-ee/hi.html?dir=Travel_Dashboard&file=travel_dashboard.efw&mode=dashboard&TERRITORY=[“Japan”, “NA”,“Emea”]&STERRITORY=NA&j_organization=organization_name&print=png&j_username=user_name&j_password=login_password" style="height: 100%;width:100%;border:0px;" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen>
</embed>

Where,

Print: API keyword to trigger Export.

png: Export formats value. You can pass export values as pdf /png / jpg / xls.

In case of any doubt, post your queries on forum