Intellicus Enterprise Reporting and Business Insights 19.0

HTTP APIs

0 views June 28, 2020 0

When Intellicus and Host application are running on different web servers as described in deployment scenario 1, then Single Sign-On need to be implemented.

Please refer IntellicusSingleSign-on.doc for more details on single sign on.

Note: IntellicusSingleSign-On.doc will be provided with Intellicus setup.

Path: <Intellicus_Install_path>DocsManuals

For deployment scenario 2, in which Intellicus is embedded inside Host application, Single Sign-On is not required.

Intellicus functionalities can be accessed from within an application.  This is done through HTTP APIs.  APIs are available for following functionalities:

  • Getting category and report list
  • Run, Schedule, Publish, E-Mail report
  • Dashboard, Widget listing, Setting/Getting Dashboard Preferences
  • Query/Parameter Object Editor
  • Adhoc reporting

General steps of integration are:

  • Take Intellicus Token by implementing single sign-on
  • Call HTTP API for the needed functionality
  • Receive response from Intellicus
  • Display the information in host application

Prerequisites

If the host application’s users are expected to authenticate in order to enter into the application, host application will need to integrate with Intellicus using single sign-on (user authentication by host application).

Intellicus needs to make sure that a request received from a host application is from a user already authenticated by the host application.  Intellicus provides token exchange mechanism for user identification.

Before calling Intellicus HTTP APIs, we assume that token had been generated by Intellicus and received by host application with the help of single sign on.

Method to get a token for Single Sign-On

This method calls Intellicus Controller API and passes the user credentials and other hidden/business/request parameters to Intellicus.

Name: getIntellicusToken

Class: SingleSignOn

Syntax:

public String getIntellicusToken() throws SingleSignOnException

Returns:

TokenString:  Received token from Intellicus

Method to access HTTP API

This method is called after getting a token from Intellicus.  This method sets the name of Intellicus HTTP API where request is being redirected.

Name: redirectToIntellicus

Class: SingleSignOn class

Syntax:

public void redirectToIntellicus(String onSuccess, String intellicusToken, HttpServletResponse response) throws IOException

Parameters:

  • OnSuccess: Relative URL of the requested Intellicus HTTP API.
  • IntellicusToken: Token received from Intellicus after user authentication.
  • Response: It is the HttpServletResponse object. It is used for redirecting a request.

CategoryListing.jsp

The objective of the API is to fetch the all the categories in tree hierarchy on UI and show report listing based on category selection.

For example:

String onSuccess =”/core/CategoryListing.jsp”;

CategoryList.jsp

The objective of the API is to fetch the all the categories.

REQ_CATEGORY_ID

(Optional)

This parameter is used to show only specified category.

Example:  REQ_CATEGORY_ID= 4F9245A7-D639-4F99-604D-F32641B77725

REPORT_TYPE

(Optional)

This parameter is used to list the given type of reports in the specified category.  Possible values for this parameter are STANDARD/STUDIO,  ADHOC, OLAP and All.  In case this parameter is not specified both types of reports will be listed.

Example:  REPORT_TYPE= STUDIO.

Combination of the above parameters makes a relative URL that invokes category listing of Intellicus.  For example:

String onSuccess =”/core/CategoryList.jsp?REPORT_TYPE=STUDIO&REQ_CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725”;

ReportListForCategory.jsp

The objective of the API is to fetch the reports for a particular category.  It also acts as an interface to perform any operations on the reports.  This API is configurable on the basis of access rights and license.

With this API, user having the required access rights can perform all the report operations like run a report in desired format, schedule it, view saved reports and its description.

This API governs following behaviors:

  • If the user is Super Admin or Admin he can perform all the activities.
  • If the user is an end-user, and no access rights are granted, no icons will be visible.
  • To quick run or run the report, ‘run report’ and ‘publish’ access rights are needed.
  • To publish a report, ‘view saved reports’ right is needed.
  • For scheduling, ‘run report’ and ‘schedule report’ rights are required.
  • For editing Adhoc report, ‘publish layout’ rights are needed.

CATEGORY_ID

(Mandatory)

This is the id of the category in which the report being run exists.  This API will list all the reports belonging to the specified category.

Example:  CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725

CAT_NAME

(Optional)

This is the Category Menu Name to which the Report belongs.

Example: CAT_NAME=DemoCategory

REPORT_TYPE

(Optional)

This parameter is used when user wants to list which type of reports available in a specified category.  Possible values for this parameter are STANDARD/STUDIO, ADHOC, OLAP and ALL.

In case this parameter is not specified, both types of reports will be listed.

Example:  REPORT_TYPE=STANDARD

SEARCH_STRING

(Optional)

This parameter is used to display a list of reports having report name that is given in the SEARCH_STRING parameter.

Example:  SEARCH_STRING=Country Sales

This API will list of all reports which contains ‘Country Sales’ in report name

FROM_DATE

(Optional)

This parameter is used for giving list of all reports which is updated from specified date.

Example:  FROM_DATE = 06/06/2007

This API will list of all reports which updated from 06/06/2007 date.

TO_DATE

(Optional)

This parameter is used for giving list of all reports which is updated up to specified date.

Example: TO_DATE = 06/06/2008

This API will list of all reports which updated up to 06/06/2008 date.

If FROM_DATE and TO_DATE both parameters are given in HTTP API then it will fetch list of all reports which updated between these two dates

SHOW_RERUN

(Optional)

This parameter is used to enable/disable Re-Run option in the report listing page.

Example:  SHOW_RERUN=true

This API will enable Re-Run Option in report listing.

SHOW_DELETE

(Optional)

This parameter is used to enable/disable delete option in the report listing page.

Example:  SHOW_DELETE=true

This API will enable delete Option in report listing.

Combination of above parameters constructs a URL to get report listing of Intellicus reports.  For example:

String onSuccess
=”/core/ReportListForCategory.jsp?REPORT_TYPE=ADHOC&CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725&SHOW_DELETE=true&FROM_DATE=06/06/2007&TO_DATE=06/06/2009&SHOW_RERUN=true”;

Sample URLs:

For getting list of all the reports in the category

/core/ReportListForCategory.jsp?CATEGORYID=96EF065A-92DE-5F64-E2AF-C4139396DD6B

For getting list of Standards reports in the category

/core/ReportListForCategory.jsp?CATEGORYID=96EF065A-92DE-5F64-E2AF-C4139396DD6B&REPORT_TYPE=STUDIO

For getting list of Adhoc reports in the category

/core/ReportListForCategory.jsp?CATEGORYID=96EF065A-92DE-5F64-E2AF-C4139396DD6B&REPORT_TYPE=ADHOC

RepositoryExplorer.jsp

The objective of this API is to show the repository explorer to the User.  This API is configurable on the basis of access rights and license.

With this API, user having the required access rights can view explorer for different entities like Reports, Categories, Queries, Parameter objects, Dashboards, Favorites etc.

ENTITYTYPE

(Optional)

This parameter takes entity that is to be shown in the Explorer.

Example:  ENTITYTYPE = REPORT

Valid Values:

ENTITYTYPE = REPORT

ENTITYTYPE = FAVORITES

ENTITYTYPE = QUERY

ENTITYTYPE = PARAMETER

ENTITYTYPE = DASHBOARD2

ENTITYTYPE = DASHBOARD_WIDGET

In case this parameter is not specified, it takes “Repository” as default and shows Repository Explorer.

EXPLORER_TITLE              

(Optional)

This parameter takes name that is to be shown in the Explorer Title.

Example:  EXLPORER_TITLE = Reports

Combination of above parameters constructs a URL to get Object Explorer for Query Objects.  For example:

StringonSuccess=”/core/RepositoryExplorer.jsp?ENTITYTYPE=QUERY&EXPLORER_TITLE=Queries

Now pass above onSuccess parameter to redirectToIntellicus method of SingleSignOn class.

InteraController.jsp

This API is the main controller of Intellicus report server.  All the reports related requests to the report server are passed through this API. This controller is used for both Standard and Adhoc reports.  Depending on the Action code given, this controller will ask report server to do the required task.

InteraController.jsp is used to:

Quick run a report

  • Execute and view a report in a specific output format
  • Execute and deliver a report as email, publish or printout
  • View published report
  • Schedule a report

This jsp accepts system parameters and business parameters.

System Parameters

ACTION_CODE

(Mandatory)

This parameter is to specify the action that this API will initiate.  A list of action-codes and actions is provided in the table given below.

Action Code Description
000 Takes navigation to system parameter page.  From here a user can select report delivery option, database connection, output format and other options before running the report.
001 If the report has user parameters, it takes navigation to Intellicus user parameters page.  User can specify values for parameters from this screen and can execute the report. If report does not have any parameters, it executes report directly.
010 To Run Report with previous run report parameter values.
002 Executes report and navigates to report viewer screen.
003 Request to show all the system, report parameter in one jsp.
300 Request to show all the system, eport parameter in one jsp.
004 Open Scheduled Repots in viewer.
005 Open published report in viewer.
400 Submission of edit parameter form and request for updated report.
500 Save dialog submission and request to save report.
600 Delete report layout.
700 Delete saved report.
800 Generate dynamic report.
802 Dynamic report generation for drilldown reports.
900 Promptable information check and execution of dynamic adhoc report with no parameter.
901 Execution of adhoc report after taking promptable information from AdHocWizardRun.jsp.
902 Promptable information check and execution of saved adhoc report with no parameter.

 Example:  ACTION_CODE=002

REPORT_ID

(Mandatory)

This is the Id of the report being run.  User can view report id from Intellicus portal’s “Deploy Categories and Reports” page.

Example:  REPORT_ID=96EF065A-92DE-5F64-E2AF-C4139396DD6B

DSGN_MODE

(Optional)

This parameter is to specify designer of the report.  The way report is executed, also depends on its design mode. Valid values are:

  • STUDIO: Specify this value when report being run is designed in Intellicus Studio (these reports are also known as Standard Reports).
  • ADHOC: Specify this value when report being run is designed in Adhoc designer (these reports are also known as Adhoc Reports).

Default value: STUDIO

Example:  DSGN_MODE=STUDIO

MENU_NAME

(Optional)

This is the name of the report being run. Report name is used in the UI for identifying the report.

Example: MENU_NAME=Sales by Country

CATEGORY_ID

(Optional)

This is the id of the category in which the report being run exists.  User can view category id from Intellicus portal’s “Deploy Categories and Reports” page.

Example: CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725

REPORT_FORMAT

(Optional)

This is the output format in which report is to view.  Possible values for this parameter are rdf, pdf, htm, xls, txt, rtf, ppt, dhtm(iHTML), csv, doc, xml, rwt(Rawtext), dhtm2(SMART)

Default value: htm

Example:  REPORT_FORMAT=htm

REPORT_CONN_NAME

(Optional)

This parameter is to specify name of the database connection to be used for running the report. Specified connection must exist in report server.

Example:  REPORT_CONN_NAME=ReportDB

OPERATION_TYPE

(Optional)

This parameter is to specify type of the operation requested.  Possible values are VIEW, EMAIL, SAVE, PRINT, PRINT_AT_SERVER.

  • VIEW: Generated report is sent to the report viewer for display.
  • EMAIL: Generated report is E-mailed as an attachment or hyperlink.
  • SAVE: Report output is saved as snapshot instead of being displayed.
  • PRINT: Report is sent to the local printer instead of being displayed.
  • PRINT_AT_SERVER: Report is sent to the printer on report server instead of being displayed.
  • PRINT_LOCALLY: Report is sent to the local printer instead of being displayed.

Default value: VIEW

Example:  OPERATION_TYPE=VIEW

HTM_MULTIPAGEOUTPUT

(Optional)

This parameter is used to specify whether report output should be in multiple pages or single page.  Possible values are true and false.

  • True: Displays the report using multiple HTML pages.
  • False: Displays report using a single HTML page by merging all report pages into one.

This parameter is used when OPERATION_TYPE is VIEW and REPORT_FORMAT is HTM.

Default value: true

Example:  HTM_MULTIPAGEOUTPUT=true

HTM_SHOWTOOLBAR

(Optional)

This parameter is used to specify whether toolbar in the html report output should be displayed or not.  Possible values are 0,1 and 2 for SHOW_NEVER, SHOW_ALWAYS, and SHOW_WHEN_MULTIPAGE respectively.

SHOW_NEVER: Never shows the toolbar in HTML viewer. The viewer cannot navigate to further pages if the report has many pages.

SHOW_ALWAYS: Always shows the toolbar in HTML viewer.

SHOW_WHEN_MULTIPAGE: The toolbar is shown only when the report generates more than one page. Otherwise, when the report generates only one page the toolbar is hidden.

This parameter is used when OPERATION_TYPE is VIEW and REPORT_FORMAT is HTM.

Default value: SHOW_ALWAYS

Example:  HTM_SHOWTOOLBAR= 1

SHOW_NEVER=0

SHOW_ALWAYS=1

SHOW_WHEN_MULTIPAGE=2

IRLDATA

(Optional)

It is used to get the IRL xml from the request object.

ARLDATA

(Optional)

It is used to get the ARL xml from the request object.

REQUESTTYPE

(Optional)

It is used to specify the type of Request related to particular Report whether to Cancel the Running Report or not.

Example:  REQUESTTYPE = CANCEL

EXECUTIONTYPE

(Optional)

It is used to specify the Execution Type whether Run, Run In Background, or Scheduled

Example:  EXECUTIONTYPE  = : ALL

EXECUTIONTYPE  = DIRECT: Run

EXECUTIONTYPE  = SCHD: Scheduled Report

EXECUTIONTYPE  = ASYNC: Run in Background

STATUS

(Optional)

It is used to specify the Status of Report.

Example:

STATUS = : All

STATUS = UNDERPROCESS: Running

STATUS = COMPLETED: Completed

FROMDATE

(Optional)

This parameter is used for giving list of all reports updated from specified date.

Example:  FROMDATE = 06/06/2007

This API will list of all reports updated from 06/06/2007 date.

TODATE

(Optional)

This parameter is used for giving list of all reports updated up to specified date.

Example: TODATE = 06/06/2008

This API will list of all reports updated up to 06/06/2008 date.

If both parameters, FROMDATE and TODATE are given in HTTP API then it will fetch list of all reports updated between these two dates.

ORPHAN

(Optional)

This specifies whether Orphan option is selected in Look in Category i.e. FRO   MCATEGORY or from ReportLayout i.e. FROMREPORT.

Example: ORPHAN = FROMCATEGORY

APP_PRO_STATUS

(Optional)

This specifies the approval process status value.

Example: APP_PRO_STATUS = All

 IS_DIRECT_EXEC

(Optional)

This specifies whether the Report should directly Run or show Parameters.

Example: IS_DIRECT_EXEC = False i.e. Show Parameters and then run the Report.

Business Parameters

(Optional)

Apart from system parameters and user parameters, host application can pass business parameters to Intellicus.  These parameters can be used for enforcing authorization.  Also business parameters can be used in report SQL for filtering records.

These parameters are used to specify query parameter names (and their respective values) in the HTTP URL.

Suppose we have a report having certain parameters, based on which it will fetch some records.  For example a report named “country details” fetches records on the basis of country name.  Parameter name is “prmCountry”.

So we will send prmCountry parameter and its value in the URL.

Example:  prmCountry=’Brazil’

The URL to run a report (in HTML) accepting prmCountry as a run time parameter, the URL would be:

String onSuccess =”/InteraController.jsp? ACTION_CODE=002&OPERATION_TYPE=VIEW&DSGN_MODE=STUDIO&REPORT_ID=2030DDEA-841B-E360-3CA0-5954AA945B92&REPORT_FORMAT=htm&prmCountry=Brazil”;

Sample URLs:

Run-time System parameters page

 /InteraController.jsp?ACTION_CODE=000&REPORT_ID=96EF065A-92DE-5F64-E2AF-C4139396DD6B

Input parameters page

/InteraController.jsp?ACTION_CODE=001&REPORT_ID=96EF065A-92DE-5F64-E2AF-C4139396DD6B

For running Standard report

/InteraController.jsp?ACTION_CODE=002&OPERATION_TYPE=VIEW&DSGN_MODE=STUDIO&REPORT_ID=2030DDEA-841B-E360-3CA0-5954AA945B92&REPORT_FORMAT=htm

For running Adhoc report

/InteraController.jsp?ACTION_CODE=002&OPERATION_TYPE=VIEW&DSGN_MODE=ADHOC&REPORT_ID=2030DDEA-841B-E360-3CA0-5954AA945B92&REPORT_FORMAT=htm

For running Adhoc report in pdf format

/InteraController.jsp?ACTION_CODE=002&OPERATION_TYPE=VIEW&DSGN_MODE=ADHOC&REPORT_ID=2030DDEA-841B-E360-3CA0-5954AA945B92&REPORT_FORMAT=pdf

OlapViewer.jsp

The objective of API is to show the list of OLAP reports available in the Repository.

This API takes below parameter

LAYOUT_ID

(Optional)

This parameter is used for opening a saved layout. When this parameter is specified, layout saved with this id should be opened and viewed in specified web browser’s view port. Any valid Cube Layout ID saved in repository String onSuccess = /olap/OlapViewer.jsp?LAYOUT_ID=F46DB80D-C532-5069-F7A7-A43D726CB663

SavedReportList.jsp

The objective of API is to show the list of saved reports available for the given report. Each saved report provides us with following details:

  • Saved Report Name
  • Published By
  • Generation Time
  • Expiry Time
  • Comments

In addition to the above details, following options are also available:

Option to view each saved report in any of the supported report output format.

Option to view the comments provided by user(s) on that saved report. If collaboration is disabled in the license then when user clicks on the comment icon a message would pop-up indicating the same.

Option to delete any of the saved report-instance(s).

The Administrator (Super-Admin and Admin) are also provided with the option of viewing privately saved reports of other users.

REPORT_ID

(Mandatory)

This is the Id of the report for which saved reports list is requested.

Example:  REPORT_ID=96EF065A-92DE-5F64-E2AF-C4139396DD6B

ISPUBLIC

(Optional)

This is to specify whether the report is public or private.  Possible values for this parameter are true and false.  In case this parameter is not specified both types of reports will be listed.

Example:  ISPUBLIC=true

Combination of above parameters makes a URL that invokes saved report listing of Intellicus.

MENU_NAME

(Optional)

This is the name of the report being run. Report name is used in the UI for identifying the report.

Example: MENU_NAME=Sales by Country

CATEGORY_ID

(Optional)

This is the id of the category in which the report being run exists.  User can view category id from Intellicus portal’s “Manage Folders and Reports” page.

Example: CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725

FROM_DATE

(Optional)

This parameter is used for giving list of all reports updated from specified date.

(FROM_DATE shuold be in MM/DD/YYYY format).

Example:  FROM_DATE = 06/06/2007

This API will list of all reports which updated from 06/06/2007 date.

TO_DATE

(Optional)

This parameter is used for giving list of all reports updated up to specified date.

(TO_DATE shuold be in MM/DD/YYYY format).

Example: TO_DATE = 06/06/2008

This API will list of all reports updated up to 06/06/2008 date.

If FROM_DATE and TO_DATE both parameters are given in HTTP API then it will fetch list of all reports updated between these two dates.

DEPTH

(Optional)

This parameter is to specify level of searching i.e. whether COMPLETE or CURRENT_LEVEL.

COMPLETE = -1 (Searches in complete multilevel category hierarchy)

CURRENT_LEVEL = 0 (Searches in current Category of multilevel hierarchy)

ACCESSRIGHTS

(Optional)

This parameter is to specify Access Rights for the Report.

CATACCESSRights

(Optional)

This parameter is to specify Access Rights for the given Category.

CALLEDFROM

(Optional)

It specifies the page, from where it is called.

Example:  CALLEDFROM = VIEWER

ALL_USER_RPTS

(Optional)

This is the Request Parameter that is used to decide whether to get all the user’s published report or not.

For example: ALL_USER_RPTS = true

String onSuccess = “/core/ SavedReportList.jsp? REPORT_ID=96EF065A-92DE-5F64-E2AF-C4139396DD6B& ISPUBLIC=true&DEPTH=-1”;

Now pass above onSuccess parameter to redirectToIntellicus method of SingleSignOn class.

Dashboard

Objective of API: To load any dashboard by default or for editing any existing one.

DashboardViewer.jsp

This API takes below parameter.

DASHBOARD_ID: The unique identifier of the Dashboard that should be loaded for editing in the Dashboard viewer.

This parameter makes a URL that invokes Dashboard Viewer page of Intellicus.

For example:

String onSuccess = “/dashboard/DashBoardViewer.jsp?DASHBOARD_ID=DE65F377-5E46-153B-A56E-54E1073D59B2”;

 SELECTED_DASHBOARD_ID: This parameter shall be respected only if the dashboard with this id is in user’s preferences.

For example:

String onSuccess = “/dashboard/DashBoardViewer.jsp?SELECTED_DASHBOARD_ID=B954111B-1881-21CE-1958-0DB411187785”;

AdhocWizard.jsp

Objective of the API: To load the Ad Hoc report designer and facilitate the user to perform all the desired activities on that UI. Moreover it is used to design new report as well as open and edit a saved report.

Parameters

  • DEFAULTEXPANDTABS: All or None.
  • SYS_TEMPLATE_NAME: is send as request to show template. It needs no validations and no pre defined values.
  • CATEGORY_ID: Saves report in predefined category.(Only when designing a new Report and saving it)
  • REPORT_ID: Opens the Report with given Report_Id for Editing.
  • LINK_TO_IDENTIFIER: Provides tab identifier for launching use case on click of Query Editor.
  • REPORT_FORMAT: This request parameter is used for governing default value for report format
  • WIZARD_LAYOUT_TYPE: This request level parameter is used for defining layout type of Adhoc Wizard.

Possible Values: TABBED/ACCORDION

  • SHOW_TAB: HTTP request level parameter for selecting particular tab or section of Adhoc Wizard. This could be comma separated values.

Possible Values: SELECT/GROUP/FILTER/TOTAL/SORT/HIGHLIGHT/MATRIX/CHART/NETWORK_GRAPH

  • SHOW_CHART_TYPE: HTTP request level parameter for showing specified chart type as default selected.

Possible Values: PIE/BAR/LINE/CURVE/CURVEAREA/AREA/SCATTER/RADAR/BUBBLE

There are no mandatory parameters required in this case.

Combination of above parameters makes a URL that invokes AdhocWizard report design page of Intellicus.

For example:

Creating a new report

String onSuccess=”/custom/AdHocWizard.jsp? DEFAULTEXPANDTABS=All”;

Editing an existing report

String onSuccess=”/custom/ AdHocWizard.jsp?DEFAULTEXPANDTABS=All&CATEGORY_ID=4F9245A7-D639-4F99-604D-F32641B77725”;

Now pass above onSuccess parameter to redirectToIntellicus method of SingleSignOn class.

SelectAdhocSource.jsp

Objective of the API: To load the Ad Hoc report visualizer with Data source selection selection. This page is called when we open Adhoc visualizer from Navigation.

Adhoc Visualizer with Data Source selection Screen

String onSuccess=/custom/SelectAdhocSource.jsp

Now pass above onSuccess parameter to redirectToIntellicus method of SingleSignOn class.

AdhocVisualizer.jsp

Objective of the API: To load the Ad Hoc report visualizer and facilitate the user to perform all the desired activities on that UI. Adhoc Visualizer allows user to directly view the report data with all columns as default and then the user has provision to change certain things like selected columns, filters, grid view, chart view or Map view, apply grouping, sorting, filters, highlighting, total etc. Also the user can select existing report and view from this visualizer.

Parameters

VIEW_USECASE:

(Optional)

This parameter takes value of VIEW_USECASE parameter to allow user to open visualizer for various usecases like NEW for opening new report with given QUERY_ID or SAVED for opening existing report for given REPORTID etc.

Possible Values

  • NEW- Used to design a new Report.QUERY_ID is mandatory. (Default)
  • SAVED- Open Existing Report(REPORTID is mandatory)
  • PUBLISHED- Open Saved instance of Report(REPORTOID is mandatory)
  • REQUEST- To Open Adhoc Visualizer using ARLDATA.
  • RUNINBACKGROUND- Run Smart Report in background(REPORTID is mandatory)
  • AUDIT- Called for Auditted Reports (REPORTOID is mandatory)
  • CHANGEDATASOURCE- To Open Report with different Data Source

Adhoc Visualizer with Data Source loaded for designing New Report

String onSuccess=”/custom/AdhocVisualizer.jsp? VIEW_USECASE=NEW&QUERY_ID=12607729345009203129192910671882”;

Adhoc Visualizer opened for Existing Report

String onSuccess=”/custom/AdhocVisualizer.jsp? VIEW_USECASE=SAVED&REPORT_ID=AF654266-1477-EE8A-BFB1-5D0A2A59A4BE”;

QUERY_ID:

This parameter is mandatory for VIEW_USECASE as NEW. It takes Query Id which is to be loaded in Adhoc Visualizer.

Open Adhoc Visualizer with Data Source loaded

http://localhost:91/intellicus/custom/AdhocVisualizer.jsp?VIEW_USECASE=NEW&QUERY_ID=12607729345009203129192910671882

REPORTID:

This parameter is mandatory for VIEW_USECASE as SAVED. It takes Report Id so as to load the existing Report in Adhoc Visualizer.

Open Adhoc Visualizer with Report loaded

http://localhost:91/intellicus/custom/AdhocVisualizer.jsp?VIEW_USECASE=SAVED&REPORT_ID=AF654266-1477-EE8A-BFB1-5D0A2A59A4BE

EDIT_MODE:

(Optional)

This parameter takes value of EDIT_MODE parameter to allow user to open visualizer in Edit mode or View Mode.

Possible Values

  • TRUE: Opened with Edit Mode
  • FALSE: Opened in View Mode.

Adhoc Visualizer with Data Source loaded in view mode

String onSuccess=”/custom/AdhocVisualizer.jsp? QUERY_ID=12607729345009203129192910671882&EDIT_MODE=FALSE”;

Adhoc Visualizer with Data Source loaded in Edit mode

String onSuccess=”/custom/AdhocVisualizer.jsp? QUERY_ID=12607729345009203129192910671882&EDIT_MODE=TRUE”;

Combination of above parameters makes a URL that invokes AdhocWizard report design page of Intellicus.

Now pass above onSuccess parameter to redirectToIntellicus method of SingleSignOn class.

QueryObjectList.jsp

To display the detail of a query object.

Parameters

QUERY_ ID

(Optional)

To specify the query object’s Id to view details.

onSuccess = /custom/reportobjects/QueryObjectList.jsp?QUERY_ID=126077328926986838754445

QUERY_NAME

(Optional)

To specify the query object’s name to view its details.

onSuccess = /custom/reportobjects/QueryObjectList.jsp?QUERY_NAME=Sales Detail

ParameterObjectList.jsp

To display the detail of a query object.

Parameters

PARAMETER_NAME

(Optional)

To specify the Parameter object’s name to view its details.

onSuccess = /custom/reportobjects/ParameterObjectList.jsp?PARAMETER_NAME=prmCountry

PARAMETER_ID

(Optional)

To specify the Parameter Id of the parameter to view its details.

/custom/reportobjects/ParameterObjectList.jsp?PARAMETER_ID=12646774660505127018091194654991

PrintSettingList.jsp

This API is used to call page that have functionalities of working with print related settings.  When a report is associated with a print setting, report is printed as per the preferences set in the associated print setting.

For example:

onSuccess = “/core/PrintSettingsList.jsp?PrintSettingsName=PrintSetting1”;

Preferences.jsp

This API provides UI to set following user preferences:

Change password

  • Set default connection
  • Set portal preferences
  • Set parameter preferences
  • Set dashboard preferences
  • Messenger preferences

For example: onSuccess = personalization/Preferences.jsp