webi open document en

Viewing Documents UsingOpenDocument

SAP BusinessObjects Enterprise XI 3.1 SP3

© 2010 SAP AG. All rights reserved.SAP, R/3, SAPNetWeaver, Duet, PartnerEdge,ByDesign, SAP Business ByDesign, and other SAP products and services

Copyright

mentioned herein as well as their respective logos are trademarks or registeredtrademarks of SAP AG in Germany and other countries. Business Objects and theBusiness Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, WebIntelligence, Xcelsius, and other Business Objects products and services mentionedherein as well as their respective logos are trademarks or registered trademarksof Business Objects S.A. in the United States and in other countries. BusinessObjects is an SAP company.All other product and service names mentioned arethe trademarks of their respective companies. Data contained in this documentserves informational purposes only. National product specifications may vary.Thesematerials are subject to change without notice. These materials are provided bySAP AG and its affiliated companies ("SAP Group") for informational purposesonly, without representation or warranty of any kind, and SAP Group shall not beliable for errors or omissions with respect to the materials. The only warranties forSAP Group products and services are those that are set forth in the expresswarranty statements accompanying such products and services, if any. Nothingherein should be construed as constituting an additional warranty.

2010-05-07

ContentsGetting started 5Chapter 1

About this documentation............................................................................6Who should use this documentation?....................................................6About OpenDocument............................................................................6

What's new in SAP BusinessObjects Enterprise XI 3.1 SP3.......................7Deprecated parameters...............................................................................8

OpenDocument syntax 9Chapter 2

Basic URL syntax......................................................................................10URL syntax considerations........................................................................10

Session management 13Chapter 3

Serialized sessions....................................................................................14Logon tokens.............................................................................................15User sessions ...........................................................................................16

Parameter reference 17Chapter 4

Session management parameters.............................................................21serSes..................................................................................................21token.....................................................................................................22

Document identifier parameters................................................................24iDocID...................................................................................................24sDocName............................................................................................25sIDType................................................................................................26sInstance..............................................................................................27

Viewing Documents Using OpenDocument 3

sKind....................................................................................................27sPath....................................................................................................28sType....................................................................................................29

Input parameters........................................................................................29lsC........................................................................................................29lsM[NAME]...........................................................................................30lsR[NAME]............................................................................................32lsS[NAME]............................................................................................33sPartContext.........................................................................................35sRefresh...............................................................................................36sReportMode........................................................................................36sReportName.......................................................................................37sReportPart..........................................................................................38

Output parameters.....................................................................................39NAII......................................................................................................39sOutputFormat.....................................................................................40sViewer.................................................................................................40

More Information 43Appendix A

Index 47

4 Viewing Documents Using OpenDocument

Contents

Getting started

1

About this documentationThis documentation provides you with information for constructingparameterized URLs with the OpenDocument syntax. OpenDocument URLslink to Business Intelligence (BI) documents in an SAP BusinessObjectsEnterprise system. A parameter reference, including syntax and usageexamples, is provided for each OpenDocument URL parameter.

For information about deploying the OpenDocument web application afterthe installation of SAP BusinessObjects Enterprise, see the SAPBusinessObjects Enterprise Web Application Deployment Guide.

Who should use this documentation?

This documentation is for anyone creating URLs to BI documents with theOpenDocument syntax. We recommend consulting this guide if you are:• Providing end users with hyperlinks to a document through email or other

direct means.• Embedding hyperlinks in one document to another.• Programmatically generating hyperlinks to documents in your custom

application.Familiarity with the management and organization of objects in your SAPBusinessObjects Enterprise deployment is beneficial.

About OpenDocument

OpenDocument is one of many deployed web applications within an SAPBusinessObjects Enterprise system. It processes incoming URL requestsfor documents and any other viewable object type in the Central ManagementServer (CMS), and delivers the correct document to the end user in theappropriate viewer. This allows you to send users direct links to a documentand avoid having them navigate through a folder hierarchy, such as inInfoView. The OpenDocument syntax and its parameters allow you to


Getting started1 About this documentation

construct URLs that link to these documents. For example, consider thefollowing URL:

http://<servername>:<port>/OpenDocument/opendoc/openDocument.jsp?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID

Note:Replace <servername>:<port> with the name and port number of your webserver where OpenDocument is deployed.

This URL accesses the object in the CMS with the CUID value of Aa6GrrM79cRAmaOSMGoadKI. If this is a Crystal report, for example, then thereport is rendered to the user in a default Crystal Reports viewer. In thisexample, iDocID is one of many URL parameters. These parameters specifyhow to access a particular document in the CMS, or determine how to displaythe document to the user.

You can link to many viewable object types with the OpenDocument syntax.Some examples include:• Crystal reports• Web Intelligence documents• Voyager workspaces• InfoView dashboards• Xcelsius visualizations published as SWF files.

Some of the designers for these BI document types provide GUI-based URLbuilders to help you embed openDocument URLs into your documents.Consult their respective product documentation for information on thesefeatures.

What's new in SAP BusinessObjectsEnterprise XI 3.1 SP3

serSes parameter

The serSes parameter can now be used to pass a serialized Enterprisesession to an OpenDocument URL. Use this parameter so users avoidencountering additional logon prompts in your custom application.

For more information on the serSes parameter andmanaging user sessions,see Session management and serSes.


1Getting startedWhat's new in SAP BusinessObjects Enterprise XI 3.1 SP3

Deprecated parametersThis section lists deprecated and obsolete OpenDocument parameters asof SAP BusinessObjects Enterprise XI 3.1 Service Pack 3 (SP3) . Obsoleteparameters are unsupported.

Table 1-2: Deprecated Parameters

Replace withDescriptionParameter

Use sIDType=CUID instead.

Specifies that a GUID is usedto specify the viewable docu-ment. Use in conjunction withiDocID.

sIDType=GUID

Use sIDType=CUID instead.

Specifies that a RUID is usedto specify the viewable docu-ment. Use in conjunction withiDocID.

sIDType=RUID

Table 1-3: Obsolete Parameters

Replace withDescriptionParameter

Use the HTML anchor's target attribute or an equivalent.

Indicates whether the targetdocument will open in the cur-rent browser window orwhether a new window will belaunched.

sWindow

Note:sWindow is only obsoletefor Java deployments(openDocument.jsp).sWindow is still supportedin .NET deployments(opendocument.aspx)for this release.


Getting started1 Deprecated parameters

OpenDocument syntax

2

Basic URL syntaxThe basic syntax for an OpenDocument URL is as follows:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?<parameter1>&<parameter2>&...&<parameterN>

The exact syntax of the <platformSpecific> parameter depends on yourSAP BusinessObjects Enterprise deployment:

• For Java deployments, use openDocument.jsp in place of the<platformSpecific> parameter.

• For .NET deployments , use opendocument.aspx in place of the<platformSpecific> parameter.

Note:Variables are denoted with angle brackets. You must substitute the propervalue for these variables. For example, you must use the name of your SAPBusinessObjects Enterprise server where OpenDocument is hosted in placeof <servername> and you must use the correct port number in place of<port> to access the OpenDocument web application.

URL syntax considerations

Accessing documents

You must include the iDocID or sDocName parameter in yourOpenDocument URL to specify the document to be viewed. Since there maybe multiple documents in the Central Management Server (CMS) with thesame name, and documents can be moved or renamed, it is recommendedthat you use iDocID to ensure uniqueness.

Joining parameters

Join parameters with the ampersand (&). Do not place spaces around theampersand. For example: sType=wid&sDocName=Sales2003

The ampersand is always required between parameters.


OpenDocument syntax2 Basic URL syntax

Spaces and special characters in parameter values

Because some browsers cannot interpret spaces, the parameters of the linkcannot contain spaces or other special characters that require URL encoding.To avoid the misinterpretation of special characters, you can define aURL-encoded string in the source database to replace the special characterwith an escape sequence. This will allow the database to ignore the specialcharacter and correctly interpret the parameter value. Note that certainRDBMS have functions that allow you to replace one special character withanother.

By creating an escape sequence for the plus sign (+), you can instruct thedatabase to interpret the plus sign as a space. In this case, a document titleSales Report for 2003 would be specified in the DocName parameter as:&sDocName=Sales+Report+for+2003&

This syntax prevents the database from misinterpreting the spaces in thetitle.

Trailing spaces in parameter values

Trim trailing spaces at the end of parameter values and prompt names. Donot replace them with a plus sign (+). The viewer may not know whether tointerpret the plus sign (+) as part of the prompt name or as a space. Forexample, if the prompt name displays:

Select a City:_

(where _ represents a space), enter the following text in the link:

lsSSelect+a+City:=Paris

where the spaces within the prompt name are replaced with the plus sign,and the trailing space is trimmed off.

Capitalization

All of the OpenDocument parameters are case sensitive.

URL length limit

OpenDocument may add characters to your URL when it redirects to therequested document; however, encoded URLs cannot exceed the maximumcharacter limit for the supported browsers. For example, certain versions of


2OpenDocument syntaxURL syntax considerations

Internet Explorer limit the URL length to 2083 characters. Therefore, knowthe browser character limit to ensure your URL will be within the maximumlimit.

Parameter values in links to sub-reports

You cannot pass parameter values to a sub-report of a target Crystal report.

Opening a new window

To force OpenDocument HTML links to open a new browser window, usethe HTML anchor's target attribute or an equivalent. For example:

<a href="http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID" target="_blank">hyperlink text</a>


OpenDocument syntax2 URL syntax considerations

Session management

3

Normally when using an OpenDocument link to access password-protecteddocuments, the user will be prompted for credentials. OpenDocumentprovides two parameters to avoid having the user insert credentials withoutputting the username and password information in the OpenDocument URL.You can either insert a serialized session or a logon token directly into theOpenDocument URL. This gives you control over the duration of the accessto the document. OpenDocument URLs can be set to different languages.

Serialized sessionsSerialized sessions can be used in OpenDocument by inserting the serSesparameter into the OpenDocument URL. This allows users to access fileswithout being prompted for credentials. Creating a serialized sessions doesnot use up an additional licence. Serialized sessions expire if the originaluser's session times out or logs off.

Example:

The following example uses the SAP BusinessObjects Enterprise JavaSDK to pass in a serialized session to the OpenDocument URL. For moreinformation on the IEnterpriseSession.getSerializedSessionmethod, see the SAP BusinessObjects Enterprise Java API Reference.

String openDocumentSerSes() throws SDKException, UnsupportedEncodingException{IEnterpriseSession sess = CrystalEnterprise.getSessionMgr().logon ("username", "password", "<cms>:<port>","secEnterprise");String serSession = sess.getSerializedSession();String serSesEncode = URLEncoder.encode(serSession,"UTF-8");return ("http://<server>:<port>/OpenDocument/opendoc/openDocument.jsp?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&serSes=" + serSesEncode);}

Note:• Replace <cms> with the server name and <port> with the port number of

your web server.• You must URL-encode the serialized session.


Session management3 Serialized sessions

• Since an OpenDocument URL with a serialized session contains the usersession, they must not be shared for security reasons.

Logon tokensLogon tokens can be used in OpenDocument by inserting the tokenparameter into the OpenDocument URL. Logon tokens allow users to accesspassword-protected files without being prompted for credentials, while alsogiving you control on the duration of the access to the file. Creating a newlogon token uses up an additional licence.

Example:

The following example uses the SAP BusinessObjects Enterprise JavaSDK to pass in a logon token to the OpenDocument URL. For moreinformation on the ILogonTokenMgr.createLogonToken method, seethe SAP BusinessObjects Enterprise Java API Reference.

String openDocumentToken() throws SDKException, UnsupportedEncodingException{IEnterpriseSession sess = CrystalEnterprise.getSessionMgr().logon ("username", "password", "<cms>:<port>","secEnterprise");String token = sess.getLogonTokenMgr().createLogonToken("",120,100);String tokenEncode = URLEncoder.encode(token, "UTF-8");

return ("http://<server>:<port>/OpenDocument/opendoc/openDocument.jsp?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&token=" + tokenEncode);}

Note:• Replace <cms> with the server name and <port> with the port number of

your web server.• The createLogonToken method allows you to specify the machine that

can use the token (which can be empty to allow any user to use the token),the number of minutes the token is valid for, and the number of logons thatthe token can be used for as parameters.

• Since an OpenDocument URL with a logon token contains the user session,they must not be shared for security reasons.


3Session managementLogon tokens

User sessionsWhenOpenDocument is used from InfoView or CMC, it will access the currentuser session and the user does not need to enter credentials. When adocument is viewed using an OpenDocument URL, the user will be promptedfor credentials except in the following cases:

• Vintela or Siteminder SSO is configured in the OpenDocument web.xmlfile.

• The OpenDocument URL uses a serSes or a token parameter.• The OpenDocument application has an existing user session for that

browser session.

If the existing session is different than the session in the serSes or tokenparameter, the existing session will be closed and a new session will becreated. That is, you can use serSes or token parameter to over-ride anexisting user session. The OpenDocument application will look for an existinguser session in the Web application session and in cookies.

Note:Only one OpenDocument session can be created from a single browsersession.

If the new serSes or token parameter is incorrect and there is an existinguser session, OpenDocument will attempt to open the document using thecurrent user session. If it can't it will then prompt the user for credentials.


Session management3 User sessions

Parameter reference

4

This section provides details about the available OpenDocument parameters,their specific uses, and relevant examples.

Note:The document to which an OpenDocument link points to is referred to as thetarget document.

Table 4-1: Session Management Parameters

DescriptionParameter

Specifies a serialized Enterprise session.serSes

Specifies a valid logon token for the currentEnterprise session.token

Table 4-2: Document Identifier Parameters


Specifies the unique identifier of the viewabledocument in the CMS. Use in conjunction withsIDType.

iDocID

Specifies the name of the viewable documentin the CMS. Use in conjunction with sPathand sType.

sDocName

Specifies the type of object identifier used tospecify the viewable document. Use in con-junction with iDocID.

sIDType


Parameter reference4 Session management parameters


Specifies the scheduled instance of the targetdocument to open. Use in conjunction withsDocName or iDocID.

sInstance

Specifies the file type of the target Desktop In-telligence document. Use in conjunction withsDocName and sPath.

sKind

Specifies the name of the folder and subfoldercontaining the target document. Use in con-junction with sDocName and sType.

sPath

Specifies the file type of the target document.Use in conjunction with sDocName andsPath.

sType

Table 4-3: Input Parameters


Specifies a contextual prompt for Web Intelli-gence documents if there is an ambiguityduring SQL generation.

lsC

Specifies multiple values for a prompt.[NAME] is the text of the prompt.lsM[NAME]

Specifies a range of values for a prompt.[NAME] is the text of the prompt.lsR[NAME]


4Parameter referenceSession management parameters


Specifies a value for a single prompt. [NAME]is the text of the prompt.lsS[NAME]

Specifies the data context of a Crystal reportpart. Use in conjunction with sReportPart.sPartContext

Indicates whether a database refresh shouldbe forced when the target document isopened.

sRefresh

Indicates whether the link should open the fulltarget Crystal report or just the report partspecified in.

sReportMode

Specifies the report to open if the target doc-ument contains multiple reports.sReportName

Specifies the part of the target Crystal reportto open.sReportPart

Table 4-4: Output Parameters


Indicates whether to force the display of theprompt selection page for Web Intelligenceprompts.

NAII




Specifies the format in which to open the tar-get document.sOutputFormat

Specifies the selected report viewer.sViewer

Session management parameters

serSes

ValuesDescriptionSyntax

A serialized string representingthe current Enterprise session.

Specifies a serialized Enter-prise session.serSes

Contains a serialized session of the current user session. This can be enteredinto an OpenDocument URL to allow users to access files without beingprompted for credentials. Creating a serialized sessions does not use up anadditional licence. Serialized sessions expire if the original user's sessiontimes out or logs off.

Example:

The following example uses the SAP BusinessObjects Enterprise JavaSDK to pass in a serialized session to the OpenDocument URL. For moreinformation on the IEnterpriseSession.getSerializedSessionmethod, see the SAP BusinessObjects Enterprise Java API Reference.



You can retrieve a serialized session in a similar fashion using other SAPBusinessObjects Enterprise SDK platforms such as .NET andWeb Services.

String openDocumentSerSes() throws SDKException, UnsupportedEncodingException{IEnterpriseSession sess = CrystalEnterprise.getSessionMgr().logon ("username", "password", "<cms>:<port>","secEnterprise");String serSession = sess.getSerializedSession();String serSesEncode = URLEncoder.encode(serSession,"UTF-8");return ("http://<server>:<port>/OpenDocument/opendoc/openDocument.jsp?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&serSes=" + serSesEncode);}

Note:• Replace <server> with the server name and <port> with the port number

of your web server.• You must URL-encode the serialized session.• Since an OpenDocument URL with a serialized session contains the user

session, they must not be shared for security reasons.

token


The logon token for the currentEnterprise session.

Specifies a valid logon tokenfor the current Enterprise ses-sion.

token

Contains the logon token for the current user. This can be entered into anOpenDocument URL to allow users to access files without being promptedfor credentials. Creating a new logon token uses up an additional licence.



Example:

The following example uses the SAP BusinessObjects Enterprise JavaSDK to pass in a logon token to the OpenDocument URL. For moreinformation on the ILogonTokenMgr.createLogonToken method, seethe SAP BusinessObjects Enterprise Java API Reference. You can createlogon tokens in a similar fashion using other SAP BusinessObjectsEnterprise SDK platforms such as .NET and Web Services.

String openDocumentToken() throws SDKException, UnsupportedEncodingException{IEnterpriseSession sess = CrystalEnterprise.getSessionMgr().logon ("username", "password", "<cms>:<port>","secEnterprise");String token = sess.getLogonTokenMgr().createLogonToken("",120,100);String tokenEncode = URLEncoder.encode(token, "UTF-8");

return ("http://<server>:<port>/OpenDocument/opendoc/openDocument.jsp?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&token=" + tokenEncode);}

Note:• Replace <server> with the server name and <port> with the port number

of your web server.• The createLogonTokenmethod allows you to specify the machine that

can use the token (which can be empty to allow any user to use the token),the number of minutes the token is valid for, and the number of logonsthat the token can be used for as parameters.

• Since an OpenDocument URL with a logon token contains the usersession, they must not be shared for security reasons.



Document identifier parameters

iDocID


A numerical identifier associat-ed with the document in theCMS.

Specifies the unique identifierof the viewable document inthe CMS. Use in conjunctionwith sIDType.

iDocID

You must include the iDocID or sDocName parameter in yourOpenDocument URL to specify the document to be viewed. Since there maybe multiple documents in the CMS with the same name, it is recommendedthat you use iDocID to ensure uniqueness.

You can see identifier values for a document within the Central ManagementConsole (CMC) or InfoView applications. The properties page for eachdocument contains the document ID and the CUID. You can also obtain theidentifier programmatically using the SAP BusinessObjects Enterprise SDK.For example, in the Java SDK the com.crystaldecisions.sdk.occa.infostore.IInfoObject interface contains getID and getCUIDmethodswhich you can pass to an OpenDocument URL.

Note:If you pass in an InfoObject ID rather than a CUID, you do not need to specifythe sIDType parameter. However, InfoObject IDs are changed whenmigrating documents from one CMS to another. It is recommended that theCUID be used, which is preserved during migration.


Parameter reference4 Document identifier parameters

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=2010

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID

sDocName


The title of the document in theCMS.

Specifies the name of theviewable document in theCMS. Use in conjunction withsPath and sType.

sDocName

You must include the iDocID or sDocName parameter in yourOpenDocument URL to specify the document to be viewed. Since there maybe multiple documents in the CMS with the same name, and documents canbe moved or renamed, it is recommended that you use iDocID to ensureuniqueness.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?sDocName=Sales+in+2003&sPath=[Sales+Reports]&sType=rpt


4Parameter referenceDocument identifier parameters

sIDType


• InfoObjectID• ParentID• CUID

Specifies the type of objectidentifier used to specify theviewable document. Use inconjunction with iDocID.

sIDType

Note:If you pass in an InfoObject ID as a value to iDocID rather than a CUID,you do not need to specify the sIDType parameter. However, InfoObjectIDs are changed when migrating documents from one CMS to another. It isrecommended that the CUID be used, which is preserved during migration.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID



sInstance


• User (Latest instanceowned by current user)

• Last (Latest instance ofthe document)

• Param (Latest instance ofthe document with match-ing parameter values)

Specifies the scheduled in-stance of the target documentto open. Use in conjunctionwith sDocName or iDocID.

sInstance

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?sDocName=Sales+in+2003&sPath=[Sales+Reports]&sType=rpt&sInstance=User

sKind


• FullClient

Specifies the file type of thetarget Desktop Intelligencedocument. Use in conjunctionwith sDocName and sPath.

sKind

Note:Only mandatory if the target is a Desktop Intelligence document. Otherwise,use sType.


4Parameter referenceDocument identifier parameters

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?sDocName=Sales+in+2001&sPath=[Sales+Reports]&sKind=FullClient

sPath


Folder and/or subfolder:

[folder],[subfolder]

Specifies the name of thefolder and subfolder containingthe target document. Use inconjunction with sDocNameand sType.

sPath

sPath is used only with subfolders of the Public Folders folder. If yourdocument is outside of the Public Folders folder, for example in the MyFavorites folder, use the iDocID parameter instead of sPath andsDocName.

Do not add [Public+Folders] to the path; start with the name of the firstsubfolder within Public Folders.

Public Foldersfolder 1folder 1.1

folder 1.1.1

If your document were in folder 1.1.1, you would set sPath to: [folder+1],[folder+1.1],[folder+1.1.1].

Example:




sType


• wid

• rpt

• car

Specifies the file type of thetarget document. Use in con-junction with sDocName andsPath.

sType

Note:This parameter is ignored for agnostic documents.

Example:


Input parameters

lsC


A prompt value that resolvesthe ambiguity in the SQL gen-eration.

Specifies a contextual promptif there is an ambiguity duringSQL generation.

Note:Only supported byWeb Intelli-gence documents.

lsC


4Parameter referenceInput parameters

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&lsC=Sales

lsM[NAME]


• Multiple prompt values,separated by a comma.

• no_value (only for option-al parameters)

Specifies multiple values for aprompt. [NAME] is the text ofthe prompt.

lsM[NAME]

Note:You can remove an optional parameter from the prompt by setting it tono_value in the openDocument query string. If you leave an optionalparameter out of the openDocument query string, a default parameter valuewill be applied.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sRefresh=Y&lsMSelect+Cities=[Paris],[London]

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&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)]


Parameter reference4 Input parameters

Crystal reports

If the target is a Crystal report, each value must be enclosed in squarebrackets.

Web Intelligence documents

The character ? is a reserved prompt value for Web Intelligence documentsin an openDocument URL. Setting the prompt value to lsM[NAME]=? in theURL forces the "Prompts" dialog box to appear for that particular prompt.

Olap Intelligence reports

If the target document is an OLAP Intelligence report (.car) you can use theIsM parameter to specify prompts. The parameters are passed in as aURL-encoded string using the unique name of the parameter set up in theOLAP Intelligence report.

Example: Setting a memberset parameter

http://<servername>:<port>/OpenDocument/<platformSpecific>?iDocID=544&sIDType=InfoObject&sType=car&lsMADC216EA-D9A5-42B5-AE%2C21%2C84%2CA9%2CF9%2C6E%2C31%2C7=[%5BCustomers%5D.%5BCountry%5D.%26%5BMexico%5D],[%5BCustomers%5D.%5BCountry%5D.%26%5BCanada%5D]

This example opens up an OLAP Intelligence report with a membersetparameter to Customers > Country > Mexico and Customers > Country >Canada in the view.



lsR[NAME]


• A range of values for theprompt, separated by adouble period (..).


Specifies a range of values fora prompt. [NAME] is the textof the prompt.

Note:Not supported by OLAP Intelli-gence reports.

lsR[NAME]

Note:You can remove an optional parameter from the prompt by setting it tono_value in the openDocument query string. If you leave an optionalparameter out of the openDocument query string, a default parameter valuewill be applied.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sRefresh=Y&lsRTime+Period:=[2000..2004)

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sRefresh=Y&lsRparamStringDR=[h..i]&lsRparamNumberDR=[7..8]&lsRparamCurrencyDR=[3..4]&lsRparamDateDR=[Date(2003,6,7)..Date(2003,6,8)]&lsRparamDateTimeDR=[DateTime(2003,6,1,7,1,1)..DateTime(2003,6,1,8,1,1)]&lsRparamTimeDR=[Time(1,1,7)..Time(1,1,8)]&lsRparamUnbound1=(..6)&lsRparamUnbound2=[6..)&lsRparamStringR=[a..d]&lsRparamNumberR=[1..3]&lsRparamCurrencyR=[1..3]&lsRparamDateR=[Date(2003,6,1)..Date(2003,6,3)]&lsRparamDateTimeR=[DateTime(2003,6,1,1,1,1)..DateTime(2003,6,1,3,1,1)]&lsRparamTimeR=[Time(1,1,1)..Time(3,1,1)]



Crystal reports

If the target is a Crystal report, the rangemust be enclosed in square bracketsand/or parentheses (use a square bracket next to a value to include it in therange, and parentheses to exclude it).

lsS[NAME]


• A single prompt value.


Specifies a value for a singleprompt. [NAME] is the text ofthe prompt.

lsS[NAME]

Note:You can remove an optional parameter from the prompt by setting it tono_value in the OpenDocument URL. If you leave an optional parameterout of the OpenDocument URL, a default parameter value will be applied.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sRefresh=Y&lsSparamString=h&lsSparamNumber=1&lsSparamCurrency=121&lsSparamDate=Date(2003,6,11)&lsSparamDateTime=DateTime(2003,6,11,14,38,37)&lsSparamBoolean=false&lsSparamTime=Time(12,39,2)&lsSparamStringDR=a&lsSparamDateDR=Date(2003,6,1)

Web Intelligence documents

The character ? is a reserved prompt value for Web Intelligence documentsin an openDocument URL. Setting the prompt value to lsS[NAME]=? in theURL forces the "Prompts" dialog box to appear for that particular prompt.



OLAP Intelligence reports

If the target document is an OLAP Intelligence report (.car) you can use theIsS parameter to specify prompts. The parameters are passed in as aURL-encoded string using the unique name of the parameter set up in theOLAP Intelligence report.

Example: Opening an OLAP report to a specific page

If 23CAA3C1-8DBB-4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F is the URL-encodedunique name for the page parameter in the OLAP Intelligence report, youwould use the following URL to open the OLAP Intelligence report to page2:

http://<servername>:<port>/OpenDocument/<platformSpecific>?iDocID=440&sIDType=InfoObject&sType=car&lsS23CAA3C1-8DBB-4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F=2

Example: Setting a cube parameter

If8401682C-9B1D-4850-8B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62is the URL-encoded unique name for the cube parameter opening thewarehouse cube in the catalogue FoodMart 2000 on MSAS, you would usethe following URL to open this cube parameter:

http://<servername>:<port>/OpenDocument/<platformSpecific>?iDocID=616&sIDType=InfoObject&sType=car&lsS8401682C-9B1D-4850-8B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62=CATALOG%3DFoodMart%202000,CUBE%3Dwarehouse



sPartContext


The name of the report partdata context.

Specifies the data context ofa report part. Use in conjunc-tion with sReportPart.

Note:Only supported by Crystal re-ports.

sPartContext

Note:Only mandatory if a value is specified for sReportPart.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sReportPart=Part1&sPartContext=0-4-0

Note:The sReportPart and sPartContext parameters are only supportedwith the DHML parts viewer (sViewer=part).



sRefresh


• Y

• N

Indicates whether a databaserefresh should be forced whenthe target document isopened.

sRefresh

Certain documents can contain saved settings to specify that a databaserefresh must occur when the document is opened in a viewer. Thesedocument settings will override sRefresh=N.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sRefresh=Y

sReportMode


• Full

• Part

Indicates whether the linkshould open the full targetCrystal report or just the reportpart specified in sReportPart.


sReportMode



Note:Defaults to Full if this parameter is not specified. Only applies if a value isspecified for sReportPart.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sReportPart=Part1&sReportMode=Part

Crystal reports

The sRefresh parameter is only supported with the html and partCrystalreport viewers, and not the actx and java viewers.

sReportName


The report name forWeb Intel-ligence documents and pagename for OLAP Intelligencereports.

Specifies the report to open ifthe target document containsmultiple reports.

sReportName

Note:Defaults to the first report if this parameter is not specified.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sReportName=First+Report+Tab



sReportPart


Name of the Crystal reportpart.

Specifies the part of the targetCrystal report to open.


sReportPart

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sReportPart=Part1

Note:The sReportPart and sPartContext parameters are only supportedwith the DHML parts viewer (sViewer=part).



Output parameters

NAII


• Y (prompt values that arepassed with lsS, lsM, orlsR in the URL are appliedand not displayed in the"Prompts" dialog box)

Indicates whether to force thedisplay of the prompt selectionpage.

Note:Only supported byWeb Intelli-gence documents.

NAII

Note:• NAII=Y raises the "Prompts" dialog box for any values not specified in

the URL. Prompts created with default values are still displayed in the"Prompts" dialog box.

• If all prompt values are specified in the URL, the prompt window doesnot appear even if NAII=Y is specified.

Example:

This example assumes there are two prompts in the Web Intelligencedocument: Year and Country. NAII=Y forces the "Prompts" dialog boxto appear and allows the user to specify a value for the Country prompt.The Year prompt is already set to a value of FY1999 in the URL using thelsS parameter and therefore is not prompted for.

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&lsSYear=FY1999&NAII=Y&sRefresh=Y


4Parameter referenceOutput parameters

sOutputFormat


• H (HTML)• P (PDF)• E (Excel - Crystal Reports

only)• W (Word - Crystal Reports

only)

Specifies the format in whichto open the target document.sOutputFormat

Note:Defaults to HTML if this parameter is not specified.

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sOutputFormat=E

sViewer


• html• part (Crystal reports only)• actx (Crystal reports only)• java (Crystal reports only)

Specifies the selected reportviewer.sViewer


Parameter reference4 Output parameters

Example:

http://<servername>:<port>/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoadKI&sIDType=CUID&sViewer=html


4Parameter referenceOutput parameters


Parameter reference4 Output parameters

More Information

A

LocationInformation Resource

http://www.sap.comSAPBusinessObjects productinformation

Select http://help.sap.com > SAP BusinessObjects.

You can access the most up-to-date documentation cover-ing all SAP BusinessObjects products and their deploymentat the SAP Help Portal. You can download PDF versionsor installable HTML libraries.

Certain guides are stored on the SAP Service Marketplaceand are not available from the SAP Help Portal. Theseguides are listed on the Help Portal accompanied by a linkto the SAP Service Marketplace. Customers with a mainte-nance agreement have an authorized user ID to accessthis site. To obtain an ID, contact your customer supportrepresentative.

SAP Help Portal

http://service.sap.com/bosap-support > Documentation• Installation guides: https://service.sap.com/bosap-inst

guides• Release notes: http://service.sap.com/releasenotes

The SAP Service Marketplace stores certain installationguides, upgrade and migration guides, deployment guides,release notes and Supported Platforms documents. Cus-tomers with a maintenance agreement have an authorizeduser ID to access this site. Contact your customer supportrepresentative to obtain an ID. If you are redirected to theSAP Service Marketplace from the SAP Help Portal, usethe menu in the navigation pane on the left to locate thecategory containing the documentation you want to access.

SAP Service Marketplace

https://boc.sdn.sap.com/

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibraryDeveloper resources


More InformationA

http://www.sap.com

http://help.sap.com/

http://service.sap.com/bosap-support

https://service.sap.com/bosap-instguides

https://service.sap.com/bosap-instguides

http://service.sap.com/releasenotes

https://boc.sdn.sap.com/

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary

LocationInformation Resource

https://www.sdn.sap.com/irj/boc/businessobjects-articles

These articles were formerly known as technical papers.

SAP BusinessObjects articleson the SAP Community Net-work

https://service.sap.com/notes

These notes were formerly known as Knowledge Base ar-ticles.

Notes

https://www.sdn.sap.com/irj/scn/forumsForums on the SAPCommuni-ty Network

http://www.sap.com/services/education

From traditional classroom learning to targeted e-learningseminars, we can offer a training package to suit yourlearning needs and preferred learning style.

Training


The SAP Support Portal contains information about Cus-tomer Support programs and services. It also has links toa wide range of technical information and downloads.Customers with a maintenance agreement have an autho-rized user ID to access this site. To obtain an ID, contactyour customer support representative.

Online customer support

http://www.sap.com/services/bysubject/businessobjectsconsulting

Consultants can accompany you from the initial analysisstage to the delivery of your deployment project. Expertiseis available in topics such as relational andmultidimensionaldatabases, connectivity, database design tools, and customized embedding technology.

Consulting


AMore Information

https://www.sdn.sap.com/irj/boc/businessobjects-articles

https://service.sap.com/notes

https://www.sdn.sap.com/irj/scn/forums

http://www.sap.com/services/education





More InformationA

IndexIiDocID 24

Llogon tokens 15lsC 29lsM 30lsR 32lsS 33

NNAII 39

Pparameters

deprecated 8list of 18obsolete 8

SsDocName 25serialized sessions 14

serSes 21session management 14sIDType 26sInstance 27sKind 27sOutputFormat 40sPartContext 35sPath 28sRefresh 36sReportMode 36sReportName 37sReportPart 38sType 29sViewer 40syntax 10

Ttoken 22

Uuser sessions 16

Wwhat's new 7



Index