how to use the opendocument url command

7/30/2019 How to Use the OpenDocument URL Command

1/18

BusinessObjects Enterprise XI

Release 2How to use the openDocument URL command

Overview

This document contains information on using the openDocument

command to call a report that is published in a BusinessObjectsEnterprise XI Release 2 system. This URL command allows for theintegration of BusinessObjects Enterprise XI Release 2 into webapplications and portals without requiring thorough knowledge of theunderlying SDK.

Contents

INTRODUCTION............................................................................................ 2URL syntax .................................................................................................2Background..................................................................................................2

DETERMINING PLATFORM INFORMATION

.......................................................2

Query Builder..............................................................................................2OPENDOCUMENT PARAMETERS ................................................................... 3

Undocumented openDocument parameters.................................................3Single Sign-On.................................................................................................3

Platform parameters ....................................................................................4Deprecated parameters.................................................................................6

INPUT PARAMETERS .................................................................................... 7Specifying prompts for OLAP Intelligence report targets.........................12Understanding the OLAP context.............................................................13Conventions used by OLAP Intelligence...................................................13

Syntax for a member parameter.................................................................. 14Syntax for a memberset parameter............................................................. 14

Syntax for a cube parameter........................................................................15Syntax for a page parameter........................................................................ 15

OUTPUT PARAMETERS............................................................................... 15BEST PRACTICES ...................................................................................... 16

Integrating universes.................................................................................16Using repository custom functions............................................................17

FINDING MORE INFORMATION .....................................................................18

8/16/2007 11:19:00 AM Copyright 2006 Business Objects. All rights reserved. Page 1


2/18

BusinessObjects Enterprise XI Release 2 How to use the openDocument URL command

Introduction

This document lists the parameters that are available to use with theopenDocument command as well as how to use them. It also explainssome best practices and shows the location of help files related to usingthis technology.

URL syntax

The typical URL syntax is as follows:

JAVA

http://:/businessobjects/enterprise115/desk

toplaunch/opendoc/openDocument.jsp

COM

http://:/businessobjects/enterprise115/Info

View/scripts/opendocument.aspx

By default, BusinessObjects Enterprise XI Release 2 uses the as the server name. The port is 8080 for Tomcat web servers and 80 forIIS web servers (which is the default HTTP port and can be omitted).

The following are example URLs where the server name is paris:

TOMCAT

http://paris:8080/businessobjects/enterprise115/desktoplaun

ch/opendoc/openDocument.jsp

IIS

http://paris/businessobjects/enterprise115/InfoView/scripts

/opendocument.aspx

IMPORTANT For the remainder of this document, the term openDocument.jsp is used in place of thecomplete URL path.

Background

In BusinessObjects Enterprise XI Release 2, you can call theopenDocument URL command to generate and display reports andother documents that have been previously published to theBusinessObjects Enterprise XI Release 2 system.

The openDocument command replaces the viewrpt.cwr command thatis available in earlier versions.

Determining platform information

Query Builder

BusinessObjects Enterprise XI Release 2 stores a large amount ofinformation, which is why the Query Builder application is included toquery the platform. This application is found on the left side of theEnterprise XI Release 2 Administration Launchpad page. The Query


be_xi_r2_opendocument.pdf


3/18


Builder can help you determine the values you will use to build yourcomplete openDocument URL. Figure 1 shows a typical query in theQuery Builder:

Figure 1: The Query Bui lder

The query in Figure 1 returns the Name, ID, Cluster ID, and Package IDof the Web Intelligence documents that are published on this

BusinessObjects Enterprise XI Release 2 system:

select SI_NAME, SI_ID, SI_CUID, SI_RUID FROM CI_INFOOBJECTS

WHERE SI_KIND = 'Webi'

The complete syntax is detailed in the BusinessObjects Enterprise XIRelease 2 (COM or Java) SDK Query Language Reference chapter. Tofind this reference refer to the Finding more information section.

OpenDocument parameters

Undocumented openDocument parameters

The following parameters are supported by openDocument, but are notdocumented in the BusinessObjects Enterprise XI Release 2 releasedocumentation.

Single Sign-On

OpenDocument supports Single Sign-On (SSO). In order to use SSO,openDocument first checks if a session variable calledCE_ENTERPRISESESSION is available (this variable contains anEnterprise session). If this HTTP session variable is not available, then




4/18


openDocument checks the new token parameter (Table 1) that is usedto pass the session identifier token. This token is returned by theBusinessObjects Enterprise XI Release 2 SDK when a session is created orby the ILogonTokenMgr.getDefaultToken() API.

Table 1: Token parameter

ParameterName

Description Mandatory

token Contains the users session tokengenerated by the platform

No

Platform parameters

BusinessObjects Enterprise XI Release 2 provides two options toreference a resource:

Platform resource identifiers

Platform resource names (name can be a concatenation of resourcename and folder path to remove ambiguity)

OpenDocument introduces a new way to identify the targeteddocuments. With BusinessObjects Enterprise 6.x, a mix of documentname, identifier, and repository type are used to reference the correctdocument. In BusinessObjects Enterprise XI Release 2, the nameidentification is still available but a much more flexible way to referenceyour documents based on the InfoObject identifier has been introduced:

Identifier (ID)

Cluster identifier (CUID)

Package identifier (RUID)

Global identifier (GUID)

The choice is dependent on your deployment; however, resource namesare less robust to change when generating URLs programmatically.




5/18


Table 2: Platform parameters

ParameterName

Descript ion Mandatory Example

iDocID Documentidentifier

Yes, but can bereplaced bysDocName

Documentidentifier(InfoObjectID)

sIDType CentralManagementServer (CMS)objectidentifier type

Yes, if the defaultdocument identifier(InfoObjectID) isnot used

CUID

GUID

RUID

InfoObjectID(default)

Code samples

openDocument . j sp?iDocID=342

openDocument . j sp?iDocID=AWi mi w9St nhGm993evk. Amc&sIDType=CUI D

sType The file typeof the

targetdocument or

report

Yes, but ignored foragnostic documents(xls, doc, txt, etc.)

.wid

.rpt

.car

.rep

Code samples

openDocument . j sp?iDocID=342& sType=wi d

openDocument . j sp?iDocID=343& sType=r pt

sPath The name oftheEnterprise XIRelease 2folder andsubfolderthat contains

the targetdocument

Thisparameter isused inconjunctionwith

No Enterprise XIRelease 2 folderand/orsubfolder:

[folder],[subfolder]




6/18


ParameterName


sDocName

sDocName The name ofthe documentwithoutextension

Thisparameter isused inconjunctionwith sPath

No myDocument

Code samples

openDocument . j sp?sPath=[ r epor t s] &sDocName=Char t i ng&sType=r pt

openDocument . j sp?sPath=[ r epor t s] , [f i nance] &sDocName=Summar y&sType=r pt

Deprecated parameters

Table 3 lists and describes the deprecated parameters, as well asprovides examples of each parameter.

Table 3: Deprecated parameters

ParameterName

Descrip tion Mandatory Example

sRepo Repository name (orDomain name),defaultsto Document

No sRepo=Document

(no longerused)

sRepoType Repository type

(corporate,personal, inbox,crystal, or URL)

Defaults to crystal

No RepoType=crystal




7/18


Input parameters

Table 4 provides information to populate the different parameters orreference a specific location inside a document.

Table 4: Input Parameters

ParameterName


sReportName Indicates whichreport to open iftarget documentcontains multi-report (the activereport is opened bydefault)

No Report name forWebIntelligencedocuments, sub-report forCrystal Reports,pages for OLAPIntelligence

reports.Code sample

openDocument . j sp?iDocID=342&sType=wi d&sReportName=Repor t 2

sReportPart Indicates whichspecific part of thetarget Crystalreport to open

No Name of thereport part

sPartContext In Crystal reports, areport part is

associated to a datacontext.

Yes, if avalue is

specified forsReportPart

Data context ofthe

report part

sReportMode For Crystal reporttargets only,indicates whetherthe link shouldopen the full targetreport or just thereport partspecified insReportPart

No, defaultis Full

(onlyapplies if avalue isspecified forsReportPart)

Full

Part

Code samples




8/18


TheWorld Sales Report (Figure 2) provided with Enterprise XIRelease 2 contains report parts.

To see the report parts information, open the report in the Designer,go to the File menu, and click Report Options. See the Initial ReportPart Settings section of the Report Options dialog.

By default, the Object Name is Text2;Graph1 and the Data Contextis /:

openDocument.jsp?sType=rpt&sDocName=World+Sales+Report&sReportPart=Text2;Graph1&sPartContext=/

Figure 2: The World Sales Report

openDocument.jsp?sType=rpt&sDocName=World+Sales+Report&sReportPart=Text2;Graph1&sPartContext=/Country[England]&sReportMode=Part

NOTE In the above code sample, the addition sign (+) is a URL encoded character for the spacecharacter.




9/18


Table 4 (continued)

ParameterName


sRefresh Indicates whether arefresh should beforced when thetarget document orreport is opened

For Crystal reports,use the report objectinstead of theinstances to connectto the database (ondemand viewing)

No Y (refreshthedocument)

N (note thatthe refreshon openfeatureoverridesthis value)

Code sample

openDocument.jsp?iDocID=342&sType=wid&sRefresh=Y

lsS[NAME] Specifies a value fora single prompt

[NAME] is the textof the prompt

No A singleprompt value

Code samples

openDocument.jsp?iDocID=342&

sType=wid&sRefresh=Y&lsSProductName=Cycle

The following sample uses almost all of the Crystal report parameter types:

openDocument.jsp?sType=rpt&iDocID=858&sRefresh=Y&

lsSparamString=h&lsSparamNumber=1&

lsSparamCurrency=121&lsSparamDate=Date(2003,6,11)&

lsSparamDateTime=DateTime(2003,6,11,14,38,37)&lsSparamBool

ean=false&

lsSparamTime=Time(12,39,2)&lsSparamStringDR=a&lsSparamDate

DR=Date(2003,6,1)




10/18


ParameterName


lsM[NAME]

Specifies multiplevalues for a prompt

[NAME] is the text

of the prompt

No Multiplepromptvalues

separated bya comma forCR & OLAP

Separatedby asemicolonfor Webi

If the target isa Crystalreport, eachvalue must beenclosed insquarebrackets. Ifthe target is aCrystalAnalysisreport, use theMDX WITHclause.

Code samples

openDocument.jsp?iDocID=345&

sType=wid&sRefresh=Y&lsMProductName=Cycle;Car

openDocument.jsp?sType=rpt&iDocID=859&sRefresh=Y&

lsMparamStringDR=[c],[d]&lsMparamNumberDR=[3],[4]&

lsMparamDateDR=[Date(2003,6,3)],[Date(2003,6,4)]&

lsMparamDateTimeDR=[DateTime(2003,6,1,3,1,1)],[DateTime(2003,6,1,4,1,1)]

lsR[NAME] Specifies a range ofvalues for a prompt.[NAME] is the text ofthe prompt.

No A range ofvalues forthe prompt,separated by

a doubleperiod (..)

If the targetis a Crystalreport, therange mustbe enclosedin square




11/18


ParameterName


bracketsand/orparentheses

(use asquarebracket nextto a value toinclude it inthe range,andparenthesesto exclude it)

If the targetis a OLAPreport, use

the MDXWITHclause

Code samples

openDocument . j sp?iDocID=345&sType=wi d&sRefresh=Y&lsMPr oduct Name=Cycl e, Car

openDocument . j sp?sType=r pt&iDocID=860&lsRparamSt r i ngDR=[ h. . i ] &

lsRpar amNumber DR=[ 7. . 8] &lsRparamCur r encyDR=[ 3. . 4]&

lsRparamDat eDR=[ Dat e( 2003, 6, 7) . . Dat e( 2003, 6, 8) ] &

lsRpar amDat eTi meDR=[ Dat eTi me( 2003, 6, 1, 7, 1, 1) . . Dat eTi me( 2003, 6, 1, 8, 1, 1) ] &

lsRpar amTi meDR=[ Ti me( 1, 1, 7) . . Ti me( 1, 1, 8) ] &lsRpar amUnbound1=( . . 6) &

lsRpar amUnbound2=[ 6. . ) &lsRparamSt r i ngR=[ a. . d] &lsRparamNumber R=[ 1. . 3] &

lsRparamCurr encyR=[ 1. . 3] &lsRpar amDat eR=[ Dat e( 2003, 6, 1) . . Dat e( 2003, 6, 3) ] &

lsRpar amDat eTi meR=[ Dat eTi me( 2003, 6, 1, 1, 1, 1) . . Dat eTi me( 2003, 6, 1, 3, 1, 1) ] &

lsRpar amTi meR=[ Ti me( 1, 1, 1) . . Ti me( 3, 1, 1) ]




12/18


ParameterName


lsC Specifies a contextualprompt if there is anambiguity during SQL

generation(BusinessObjects and

Web Intelligencedocuments only)

No A promptvalue that

resolves the

ambiguity inthe SQLgeneration

Code sample

openDocument . j sp?iDocID=346&sType=wi d&sRefresh=Y&lsC=Reservat i ons

sInstance Indicates which specific

instance of the targetreport to open

No User (Link

to latestinstanceowned bycurrent user)

Last (Link tolatestinstance forreport)

Param (Linkto latestinstance ofreport with

matchingparametervalues)

Specifying prompts for OLAP Intelligence reporttargets

If the target document is an OLAP Intelligence report (*.car), use theOLAP database vendor query language to pass the context to thedatabase. Each OLAP database vendor implements its own syntax toreference a member or a child.

In addition, the BusinessObjects XI Release 2 version of OLAPIntelligence is updated to support SAP server- and client-sideparameters. As a result of exposing SAP server side-defined parameters,report authors may not be aware of the parameter names used on theserver, which could lead to using a duplicate client-side parameter name.In order to uniquely identify each parameter, the unique name must beused in the openDocument URL command.




13/18


An example is the name Year Sl i ce whi ch has t o ber epl aced by i t s uni que name 1272DDB3- FC5B- 40B7-81, E9, 6F, 3F, B0, 3B, 1F, 7B as shown i n Fi gure 3.

Figure 3: The Parameter Manager

Understanding the OLAP context

When linking to an OLAP Intelligence report, the prompt value must befully qualified (full hierarchy) with the full syntax which is providerdependant. For example:

[Time].&[1997].&[Q4].&[10].

When linking from OLAP Intelligence to Crystal or Web Intelligencedocuments, the user needs to provide only the prompt value. Forexample:

10 (with no brackets)

Conventions used by OLAP Intelligence

The following sections describe the conventions used for

Microsoft Analysis Services (MSAS)

Essbase/DB2 OLAP (Enhanced Driver)

Essbase/DB2 OLAP (Legacy Driver)

Holos

NOTE The following examples use these URL encoding conventions:

%26 =& (ampersand)

%40 =@ (at sign)




14/18


Syntax for a member parameter

openDocument.jsp?iDocID=367&sType=car&lsS[unique parametername]=[unique member name]

Microsoft Analysis Services

lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=[Time].%26[1998]


lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B =Qtr4

Essbase/DB2 OLAP (Legacy Dri ver)

lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=Year%40Year%40Qtr4

Holos

[unique member name]

lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=Year%40Qtr4

Syntax for a memberset parameter

openDocument.jsp?iDocID=367&sType=car&lsM[unique parametername]=[unique member name],[unique member name]


NOTE As Microsoft Analysis Services unique member names contain brackets ( [ , ] ), add anadditional set of brackets around the unique name.

lsM1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=[[Time].%26[1997]],[[Time].%26[1998]]


lsM1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B =Qtr3,Qtr4


lsM1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B

=Year%40Year%40Qtr3,Year%40Year%40Qtr4

Holos

lsM1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B =Year%40Qtr3, Year%40Qtr4




15/18


Syntax for a cube parameter

openDocument.jsp?iDocID=367&sType=car&lsS[unique parametername]=[cube location]


lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=SERVER=server1,CATALOG=FoodMart 2000,CUBE=warehouse


lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=SERVER=server1,USER=bob,PWD=bobpassword,APPLICATION=Samppart,CUBE=Company


lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=SERVER=server1,USER=bob,PWD=bobpassword,DATABASE=Samppart,SCHEMA=Company,CUBE=Company

Holos

lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B=NSHOST=NSserver1,NSPORT=10000,OCASERVER=test.server1,USER=bob,PWD=bobpassword,CUBE=cube1

Syntax for a page parameter

openDocument.jsp?iDocID=367&sType=car&lsS[parametername]=[page #]

lsS1272DDB3- FC5B- 40B7- 81, E9, 6F, 3F, B0, 3B, 1F, 7B =2

Output parameters

Table 5 lists and describes the deprecated parameters, as well asprovides examples of each parameter.

Table 5: Output parameters

ParameterName


sOutputFormat Indicates theformat in whichthe targetdocument isdisplayed

No. Defaultis HTML

H (HTML)

P (PDF)

Crystal reportsonly

W (Word)

E (Excel)




16/18


Code samples

openDocument . j sp?iDocID=347&sType=wi d&sOutputFormat=P

openDocument . j sp?iDocID=861&sType=r pt&sOutputFormat=W

sViewer Indicates theselected reportviewer (CR &CA only)

CAUTION: Thisparameter canconflict withsOutputFormatand should notbe combined

No CR & CA

html (HTML)

CR only

interactive(dHTML)

Code sample

openDocument . j sp?sType=r pt&iDocID=860&sRefresh=Y&sViewer=i nt eract i ve

sWindow Indicateswhether thetarget reportwill open in thecurrent browserinstance orlaunch a newone

No Same

New

Best practices

Integrating universes

A good practice is to create an object wrapping the complete URL thatincludes the openDocument command. This approach allows you to

migrate your deployment with just a universe object update. In Figure 4,the Select statement contains:

'


17/18


Another technique is to use the HTML target keyword (target=_parent)pointing to the parent frame to avoid nested frames.

Figure 4: A Universe

Using repository custom functionsWhen using Crystal Reports, it is a good practice to use a repositorycustom function to store your link definitions. With this approach, anychanges to a URL are centralized and all the reports using this object areautomatically updated.

The following is the content of the ReportLinker function from Figure 5.

function(stringvar doctype, stringvar idtype, stringvar id,

stringvar otherparams);

"http://cdi30xi:8080/businessobjects/enterprise11/desktopla

unch/opendoc/openDocument.jsp?" + "sType=" + doctype +

"&sIDType=" + idtype + "&iDocID=" + id + (if otherparams >"" then "&" + otherparams)

Figure 5: The Formula Workshop




18/18


Finding more information

The BusinessObjects XI Release 2 openDocument command is

documented in the BusinessObjects Enterprise SDK guides that areinstalled with the product.

The COM SDK documentation is located at the following location:

[drive letter]:\Program Files\Business Objects\BusinessObjectsEnterprise 115\Help\[language]\Application\com_docs.zip

The Java SDK documentation is located at the following location:

[drive letter]:\Program Files\Business Objects\BusinessObjectsEnterprise 115\Help\[language]\Application\java_docs.zip

Documentation for the openDocument command is found in the sectionViewing Reports and Documents using URLs > URL Reporting UsingopenDocument of the Viewer COM SDK Guide (Report_Viewers.chm)and the Viewer Java SDK Guide (Viewers Java SDK Guide > GeneralReference).


be xi r2 opendocument pdf
http://www.businessobjects.com/