Report Launch may be run as either a stand-alone application or one that is embedded in an existing application. It can be embedded in two ways:

  • By embedding a list of reports
  • By allowing the application to call reports individually


1. Embedding a Report List

Whether it is a single report call or a report list, Launch delivers report content by way of an HTTP URL. Displaying a list of reports is supported by "reports.jsp." Based on the URL parameters specified, the content, layout and overall look-and-feel can be controlled. 



1.1 Basic Syntax of reports.jsp

The basic syntax of the reports.jsp call is as follows:http://{launch server}:{port}/launch/report.jsp?AppName={profile}&roleid={encrypted user id}. . . where {profile} is the name of the configured application profile (e.g. "launch").Note: For calls made within the dashboard launch application, the following relative URL may also be used instead:/launch/reports.jspIn this case, neither the application profile nor the roleid should be included.


1.2 Sample iframe HTML of an Embedded Call

Using the URL syntax mentioned above, the report list call can be displayed in several ways: In a separate (pop-up) window, in an iframe, or even using AJAX. The most common, however, is using an iframe, as shown below:

<html style="margin: 0 0 0 0;padding:0 0 0 0">
<body style="margin: 0 0 0 0;padding:0 0 0 0;width:100%">
<iframe scrolling=no frameborder=0 style="width:100%;height:500px;padding: 0 0 0 0" src="http://localhost:8090/launch/reports.jsp?AppName=launch&roleid=YWQxMDc4NTM=" /> <%
</body>
</html> 

Note: The roleid URL parameter in this example would typically be dynamic so that it will reflect the current user. The roleid parameter is explained further below.

1.3 The roleid Parameter

The roleid specified in the URL represents a valid user id which has been encrypted with 64B encryption. This parameter reflects use of BOE Trusted Authentication, which must be enabled. 1.3.1 Enabling BOE Trusted Authentication

Log into the CMC and go to Authentication.

Select the Enterprise object.
worddav9f19acbda07b325f52fc9d4e5b423268.png
Select the Trusted Authentication check box and specify a shared secret. The shared secret acts as implicit password between the Launch application and BOE so that a user can be authenticated without his/her personal password.

Enter the shared secret in the Launch AppConfiguration.properties file. The AppConfiguration.properties file is located in the WEB-INF subfolder of the launch web application folder.


1.3.2 Encoding roleid

The roleid can be encrypted manually by using the encoder.jsp page of the Launch application. 


Open an internet browser and navigate to the following URL: http://{launch server}:{port}/launch/administration/encoder.jsp



Enter the BOE user id in the field provided and click SUBMIT.

  • Copy the resulting encrypted string in your Launch URL.




1.4 Dynamic Encryption 

For C#.Net applications, the following code can be used to so that the encoded roleid can be generated dynamically. This code can be easily modified to Visual Basic .Net code. 


public string EncryptUser(string user) {
                    string EncodedString = string.Empty;
                    string error = "";
                    if (user != string.Empty) {
                        try {                  
                                byte[] encodedBytes = Encoding.UTF8.GetBytes(user);
                                EncodedString = Convert.ToBase64String(encodedBytes);
                        } catch (Exception exp) {
                            //LogError(exp.Message)                        }
                    }
                    return (EncodedString == null) ? String.Empty : EncodedString.Trim();
           } 



1.5 Specifying a Root Folder

One of the purposes of the application profile, represented by the AppName URL parameter, is to define the root folder — that is, the folder whose content is to be displayed in the report list. The root folder is stored as an application attribute is defined at the time of application configuration (see the Application Attributes section for more information.) However, this folder can be overridden with the help of the folder URL parameter: 


http://{launch server}:{port}/launch/reports.jsp . . . folder={encrypted folder name} 


Here, the {encrypted folder name} represents the name of the BOE folder to be used as the root folder (curly braces excluded). The folder name can be encrypted in the same manner that roleid is. (See above section for how to manually encrypt a value).


2. Embedding Dashboard Launch


Dashboard Launch provides a tabbed interface for displaying not only Launch report list content but also virtually any web content. Dashboard Launch operates as a stand-alone application but also can be embedded in an existing application, using trusted authentication (described in the previous section). Note that it is necessary to configure a dashboard template (i.e. the tabs and their content) before using Dashboard Launch. Please see the Dashboard Launch Administrator's Guide for more information. 



2.1 Basic Syntax for Embedding Dashboard Launch

The basic syntax of the reports.jsp call is as follows:
http://{launch server}:{port}/launch/dashboard/indexDashboardDirect.jsp?AppName={profile}&roleid={encrypted user id} 


3. Calling a Report By URL using callreport.jsp


In addition to displaying a list of reports, Report Launch also allows viewing an individual report directly via URL. This is supported by "callreport.jsp." Based on the URL parameters specified, a report may be viewed or exported. A report may also be filtered via pre-supplied prompt values passed in the URL. Additionally, look-and-feel requirements may also be specified based on the application profile defined in the URL. 



3.1 Basic Syntax of callreport.jsp

Calling a report directly, for display or export, is accomplished by a simple URL call to callreport.jsp. The URL syntax of callreport.jsp is:
http://{launch server}:{port}/launch/callreport.jsp?AppName={profile}&roleid={encrypted user id}&ReportTitle={title}

where {profile} is the name of the configured application, {encrypted user id} is the name of the user id encrypted using Launch encryption, and {report name} is the name of the report to be executed (curly braces excluded). The application profile has been explained in previous sections. The roleid parameter, as well as other options for is explained below.

Note: For calls made within the dashboard launch application, the following relative URL may also be used instead:
/launch/callreport.jsp?ReportTitle={report name}

In this case, neither the application profile nor the roleid should be included

URL Option
Definition
Required
Example
Report Title
Calls the report by the BO Report Title
No
Report Title=Inventory and Sales
ID
Calls the report by the BO Report ID
No
ID=456879
Viewer
Defines the Export/Display option for the report
No
viewer=XLS
App_name
Report Launch Defined Application Name
Yes
App_name=launch
Roiled
Using Trusted Authentication, the Launch encrypted BOE username
No
Roiled=zxyytrsepretl==
Mode
Set to Direct or Indirect. This is determined whether the call comes from the report list (indirect) or from external of the application (direct)
No
Mode=indirect
Refresh
Used in conjunction with Report Title or Report ID, will refresh the report before displaying
No
Refresh=Y
Instance
Calls the report by the BO Instance ID or latest instance (To be clarified)
 No
instance=#ID# vs Instance=Y
SA
Required Parameter Key Value
Yes (if passing parameters)
See section 1.3.18
Transpose
Used to transpose and summarize data.
No
Transpose=Y
Publication
Instead of running the report, looks for a publication with the report title name, grabbing the latest instance
No
Publication=Y
viewercontrols
Instructs the viewer window to display the Back button and the report list Icon.
No
viewercontrols=Y
popup
Opens the returned report/report part in a separate popup window
No
popup=y

3.2 Defining Export Options

Whether a report is displayed on screen or directly exported to another format (e.g. Excel) is defined by the "viewer" URL parameter. For example, the following URL will export the report directly to Excel.
http://{launch server}:{port}/launch/callreport.jsp?AppName={profile}&ReportTitle={ReportName}&viewer=XLS 


The following export options are available: 

Export Option
URL value
Microsoft Excel
XLS
Microsoft Excel 2007+
XLSX
Microsoft Excel (Data Only)
XLSDataCentric
Adobe Acrobat (PDF)
PDF
Microsoft PowerPoint
PPT
HTML (on-screen)
HTML
Interactive Viewer (Webi Only)
N


3.3 Passing Prompt Values

A report's parameter values may be passed via the URL call, either in part or in whole. If no parameter values, or only some, are passed to a report which requires them, Report Launch will direct the user to a parameter screen to supply the parameter values that are missing. If all parameter values of a report are passed, Report Launch bypasses the parameter screen and executes the report directly. 

If you wish to pass prompt values, the prompt syntax is as follows:
../callreport.jsp?ReportTitle={Title}&SA={prompt1}={value1};{prompt2}={value2} 


. . . where {prompt1} is the full name of the prompt, including spaces and any trailing colon ( : ), and {value1} is the value being passed, etc. For multiple parameter values, use double right bracket (]]) to separate values. 


Note each "parameter=value" pair is separated by a semi-colon( ; ). 

Example:
http://localhost:8080/launch/callreport.jsp?AppName=launch&ReportTitle=Sales Report &SA=Enter value(s) for DC:=Orlando;Type:=ABC]]XYZ]]G 


4. Basic Syntax of Calling a Report Part by URL using callreportpart.jsp

In addition to displaying a Business Objects report , Report Launch also allows viewing an individual report tab or report part directly via URL. This is supported by "callreportpart.jsp."
Calling a report directly for display or export is accomplished by a simple URL call to callreport.jsp. The URL syntax of callreport.jsp is:
http://\{launch server}:{port}/launch/callreportpart.jsp?AppName={profile}&roleid={encrypted user id}&ReportTitle={report name}&tab=3&image={y/n} 


Note: For the attribute tab=x, the numbering index begins at tab=0 for the first tab in the report. Using this logic if there are four tabs in a report, they will be 


Where {profile} is the name of the configured application, {encrypted user id} is the name of the user id encrypted using Launch encryption, {report title} is the name of the report to be executed (curly braces excluded), {tab name} is equal to the tab index that should be displayed, and {image} is set to y for images such as charts or graphs, and set to N for basic reports.


Note: For calls made within the dashboard launch application, the following relative URL may also be used instead:
../launch/callreportpart.jsp?ReportTitle={report name}&tab=3&image=Y 


In this case, neither the application profile nor the roleid should be included.

5. Scheduling a report externally by using ScheduleReportExternal.jsp

In addition to viewing a report tab or report part via URL, Report Launch also allows the scheduling of reports from outside the CMC. This is supported by "SchdeuleReportExternal.jsp".

5.1  Basic Syntax of ScheduleReportExternal.jsp


Scheduling a report instance is accomplished by a simple URL call to ScheduleReportExternal.jsp. The URL syntax of ScheduleReportExternal.is:
http://\{servername}:{port} /launch/ScheduleReportExternal.jsp?AppName={appname}&roleid={encrypted roleID}&ReportTitle={ReportName} 


Additional Notes: 

  • Parameters can be entered by adding the following to the URL: &SA={PromptName}:={PromptValue}
  • The scheduled instance name can be defined by adding the following to the URL: &title={IntstanceTitle}
6. Configure Launch to use hidden Domain value

Below are the requirements to configure the Launch application to allow a "domain" like behavior. This will allow a specific report parameter to be assigned a "global" value AND be hidden automatically, for all reports during a session, by directly calling reports.jsp.


6.1 Requirements for using hidden Domain value

  • Confirm that the hidden_parameter attribute is set to the name of the "domain". This should exactly match the prompt name of any report to be hidden and automatically assigned a value.
  • The reports.jsp URL is appended with a keyword=value pair, the keyword matching the "domain" name, and the value being its desired value to be passed to prompts for the current session.
  • Confirm that the refresh_prompts_ondemand attribute is not set to N unless reports to be executed have been configured appropriately in the parameter admin screen.


6.2 Configuring the use of a hidden Domain value



The expected result will be that from the parameter screen, any parameter/prompt with name that matches the hidden_parameter name is assigned the domain value passed and hidden.