BOE中opendocument使用说明

BusinessObjects Enterprise XIHow to Use the openDocument URL CommandOverviewThis document contains information on using the openDocumentcommand in order to call a report that is published in a BusinessObjectsEnterprise XI system. This URL command allows the easy integration ofEnterprise XI within web applications and portals without a deepknowledge of the underlying SDK.ContentsI NTRODUCTION (2)Background (2)D ETERMINING P LATFORM I NFORMATION (2)Query Builder (2)O PEN D OCUMENT P ARAMETERS (4)Undocumented openDocument parameters (4)Single Sign-on (4)Platform parameters (4)Deprecated parameters (6)I NPUT P ARAMETERS (6)Specifying prompts for OLAP Intelligence report targets (11)Understanding the OLAP context (11)Conventions used by OLAP Intelligence (12)Syntax for a member parameter (12)Syntax for a memberset parameter (12)Syntax for a cube parameter (13)Syntax for a page parameter (13)O UTPUT PARAMETERS (14)B EST PRACTICES (15)Integrating Universes (15)Using Repository custom functions (15)F INDING MORE INFORMATION (16)IntroductionThis document lists the parameters that are available to use with theopenDocument command and how to use them. It also explains somebest practices and shows the location of help files related to this usingthis technology.The typical URL syntax is:JAVA-http://<hostname>:<port>/businessobjects/enterprise11/desktoplaunch/opendoc/openDocument.jspCOM-http://<hostname>:<port>/businessobjects/enterprise11/InfoView/scripts/opendocument.aspxBy default, Enterprise XI uses the <hostname> as the server name. Theport is 8080 for Tomcat web servers and 80 for IIS web servers (which isthe default HTTP port and can be omitted).Example URLs where the server name is “paris”:TOMCAT-http://paris:8080/businessobjects/enterprise11/desktoplaunch/opendoc/openDocument.jspIIS-http://paris/businessobjects/enterprise11/InfoView/scripts/opendocument.aspxIMPORTANT For the remainder of the document, the term “openDocument.jsp” is used in place of thecomplete URL path.BackgroundIn BusinessObjects Enterprise XI, you can call the openDocument URLcommand to generate and display reports and other documents thathave been previously published to that Enterprise XI system.The openDocument command replaces the viewrpt.cwr command thatwas available in prior versions of Enterprise.Determining Platform InformationQuery BuilderEnterprise XI stores a lot of information. This is why Enterprise XIincludes a convenient web application, the Query Builder, to query theplatform. This application is found on the left side of the Enterprise XIAdministration Launchpad page. The Query Builder can help youdetermine the values you will use to build your completeopenDocument URL.The following diagram, Figure 1, shows what the Query Builder lookslike with a typical query entered into it.Figure 1: The Query BuilderThe query in the diagram above returns the Name, ID, Cluster ID, andPackage ID of the Web Intelligence documents that are published on thisEnterprise XI system.select SI_NAME, SI_ID, SI_CUID, SI_RUID FROM CI_INFOOBJECTSWHERE SI_KIND = 'Webi'The complete syntax is detailed in the BusinessObjects Enterprise XI(COM or Java) SDK “Query Language Reference” chapter. To find thisreference see the Finding more information section below.OpenDocument ParametersUndocumented openDocument parametersThe following parameters are supported by openDocument, but are notdocumented in the Enterprise XI release documentation.Single Sign-onOpenDocument supports single sign-on (SSO). In order to achieve SSO,openDocument first checks if a session variable calledISEnterpriseSession is available (this variable contains an Enterprise XIsession). If this HTTP session variable is not available, thenopenDocument checks the new token parameter used to pass thesession identifier token. This token is returned by the Enterprise XI SDKwhen a session is created or via theILogonTokenMgr.getDefaultToken() API.Parameter Name Description MandatoryExampletoken Contains the user’ssession token generatedby the platformNoPlatform parametersEnterprise XI provides two options to reference a resource:• Enterprise XI platform resource identifiers• Enterprise XI platform resource names (name can be a concatenationof resource name 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 were utilized to point to the rightdocument. In Enterprise XI, the name identification is still available but amuch more flexible way to reference your documents based on theEnterprise XI InfoObject identifier has been introduced.• Identifier (ID)• Cluster identifier (CUID)• Package identifier (RUID)• Global identifier (GUID)The choice is dependant on your deployment, however, resource namesare less robust to change when generating URLs programmatically.Parameter Name Description MandatoryExampleiDocID Document identifier Yes, but canbe replaced bysDocName Document identifier (InfoObjectID)sIDType Central Management Server(CMS) object identifiertype Yes, if thedefaultdocumentidentifier(InfoObjectID)is not used• CUID• GUID• RUID• InfoObjectID(default)Code samplesopenDocument.jsp?iDocID=342openDocument.jsp?iDocID=AWimiw9StnhGm993evk.Amc&sIDType=CUIDsType The file type of thetarget document orreport Yes, butignored foragnosticdocuments(xls, doc,txt, etc.)• wid• rpt• carCode samplesopenDocument.jsp?iDocID=342& sType=wid openDocument.jsp?iDocID=343& sType=rptsPath • The name of theEnterprise XI folderand subfolder thatcontains the targetdocument• This parameter isused in conjunctionwith sDocName No Enterprise XI folderand/or subfolder:[folder],[subfolder]sDocName • The name of thedocument withoutextension• This parameter isused in conjunctionwith sPathNo myDocumentCode samplesopenDocument.jsp?sPath=[reports]&sDocName=Charting&sType=rptopenDocument.jsp?sPath=[reports],[finance]&sDocName=Summary&sType=rptDeprecated parametersParameter Name Description MandatoryExamplesRepo Repository name (orDomain name),defaultsto “Document” No sRepo=Document(no longer used)sRepoType • Repository type(“corporate”,“personal”, “inbox”,“crystal”, or “URL”)• Defaults to“crystal”No RepoType=crystalInput ParametersThis information is provided to populate the different parameters orreference a specific location inside a document.Parameter Name Description MandatoryExamplesReportName Indicates which reportto open if targetdocument containsmulti-report (theactive report isopened by default) No Report name for WebIntelligencedocuments, sub-reportfor Crystal Reports,pages for OLAPIntelligence reports.Code sampleopenDocument.jsp?iDocID=342&sType=wid&sReportName=Report2sReportPart Indicates whichspecific part of thetarget Crystal reportto open No Name of the reportpartsPartContext In Crystal reports, areport part isassociated to a datacontext. Yes, if avalue isspecified forsReportPartData context of thereport partsReportModeFor Crystal report targets only,indicates whether the link should open the full target report or just the report part specified in sReportPartNo, default is Full(only applies if a value is specified for sReportPart)• Full •PartCode samplesThe World Sales Report provided with Enterprise XI 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 Report Part Settings section of the Report Options dialog.By default, the Object Name is “Text2;Graph1” and the Data Context is “/”.openDocument.jsp?sType =rpt&sDocName =World+Sales+Report&sReportPart =Text2;Grap h1&sPartContext =/Figure 2: The World Sales ReportopenDocument.jsp?sType =rpt&sDocName =World+Sales+Report&sReportPart =Text2;Grap h1&sPartContext =/Country[England]&sReportMode =PartNOTE In the above code sample, the addition sign (+) is a URL encoded character for the space character.Parameter Name Description MandatoryExamplesRefresh • Indicates whether arefresh should beforced when thetarget document orreport is opened• For Crystal reports,use the reportobject instead ofthe instances toconnect to thedatabase (on demandviewing) No • Y (refresh thedocument)• N (note that therefresh on openfeature overridesthis value)Code sampleopenDocument.jsp?iDocID=342&sType=wid&sRefresh=YlsS[NAME] • Specifies a valuefor a single prompt• [NAME] is the textof the promptNo A single prompt valueCode samplesopenDocument.jsp?iDocID=342& sType=wid&sRefresh=Y&lsS ProductName=CycleThe following sample uses almost all of the Crystal report parameter types: openDocument.jsp?sType=rpt&iDocID=858&sRefresh=Y&lsS paramString=h&lsS paramNumber=1&lsS paramCurrency=121&lsS paramDate=Date(2003,6,11)&lsS paramDateTime=DateTime(2003,6,11,14,38,37)&lsS paramBoolean=false&lsS paramTime=Time(12,39,2)&lsS paramStringDR=a&lsS paramDateDR=Date(2003,6,1)NamelsM[NAME] • Specifies multiplevalues for a prompt• [NAME] is the textof the promptNo • Multiple promptvalues separated bya comma for CR &OLAP• Separated by asemicolon for Webi• If the target is aCrystal report,each value must beenclosed in squarebrackets. If thetarget is a CrystalAnalysis report,use the MDX WITHclause.Code samplesopenDocument.jsp?iDocID=345& sType=wid&sRefresh=Y&lsM ProductName=Cycle;CaropenDocument.jsp?sType=rpt&iDocID=859&sRefresh=Y&lsM paramStringDR=[c],[d]&lsM paramNumberDR=[3],[4]&lsM paramDateDR=[Date(2003,6,3)],[Date(2003,6,4)]&lsM paramDateTimeDR=[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 of valuesfor the prompt,separated by adouble period (..)• If the target is aCrystal report, therange must beenclosed in squarebrackets and/orparentheses (use asquare bracket nextto a value toinclude it in therange, andparentheses toexclude it)• If the target is aOLAP report, usethe MDX WITH clauseNameCode samplesopenDocument.jsp?iDocID=345& sType=wid&sRefresh=Y&lsM ProductName=Cycle,CaropenDocument.jsp?sType=rpt&iDocID=860&lsR paramStringDR=[h..i]&lsR paramNumberDR=[7..8]&lsR paramCurrencyDR=[3..4]&lsR paramDateDR=[Date(2003,6,7)..Date(2003,6,8)]&lsR paramDateTimeDR=[DateTime(2003,6,1,7,1,1)..DateTime(2003,6,1,8,1,1)]& lsR paramTimeDR=[Time(1,1,7)..Time(1,1,8)]&lsR paramUnbound1=(..6)&lsR paramUnbound2=[6..)&lsR paramStringR=[a..d]&lsR paramNumberR=[1..3]&lsR paramCurrencyR=[1..3]&lsR paramDateR=[Date(2003,6,1)..Date(2003,6,3)]& lsR paramDateTimeR=[DateTime(2003,6,1,1,1,1)..DateTime(2003,6,1,3,1,1)]&lsR paramTimeR=[Time(1,1,1)..Time(3,1,1)]lsC Specifies a contextualprompt if there is anambiguity during SQLgeneration(BusinessObjects andWeb Intelligencedocuments only) No A prompt value thatresolves the ambiguityin the SQL generationCode sampleopenDocument.jsp?iDocID=346&sType=wid&sRefresh=Y&lsC=ReservationssInstance Indicates whichspecific instance ofthe target report toopen No• User (Link tolatest instanceowned by currentuser)• Last (Link tolatest instance forreport)• Param (Link tolatest instance ofreport withmatching parametervalues)Specifying prompts for OLAP Intelligence reporttargetsIf the target document is an OLAP Intelligence report (*.car) you mustuse the OLAP database vendor query language to pass the context to thedatabase. Each OLAP database vendor has implemented its own syntaxto reference a member or a child.In addition, the XI version of OLAP Intelligence has been updated tosupport SAP server and client side parameters. As a result of exposingSAP server side-defined parameters, report authors may not be aware ofthe parameter names used on the server, which could lead to a duplicateclient side parameter name to be used. In order to uniquely identify eachparameter, the unique name must be used in the openDocument URLcommand. An example is the name “YearSlice” which has to bereplaced by its unique name “1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B” as shown in the ParameterManager below.Figure 3: The Parameter ManagerUnderstanding the OLAP contextWhen linking to an OLAP Intelligence report, the prompt value needs tobe fully 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 IntelligenceThe following sections describe the conventions used for• Microsoft Analysis Services (MSAS)• Essbase/DB2 OLAP (Enhanced Driver)• Essbase/DB2 OLAP (Legacy Driver)• HolosNOTE The following examples use these URL encoding conventions:• %26 = & (ampersand)• %40 = @ (at sign)Syntax for a member parameteropenDocument.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]Essbase/DB2 OLAP (Enhanced Driver):lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B =Qtr4Essbase/DB2 OLAP (Legacy Driver):lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=Year%40Year%40Qtr4Holos:[unique member name]lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=Year%40’Qtr4’Syntax for a memberset parameteropenDocument.jsp?iDocID=367&sType=car&lsM[unique parametername]=[unique member name],[unique member name]Microsoft Analysis Services:NOTE As Microsoft Analysis Services unique member names contain brackets ( [ , ] ), add an additional set of brackets around the unique name.lsM1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=[[Time].%26[1997]],[[Time].%26[1998]]Essbase/DB2 OLAP (Enhanced Driver):lsM1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B =Qtr3,Qtr4 Essbase/DB2 OLAP (Legacy Driver):lsM1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=Year%40Year%40Qtr3,Year%40Year%40Qtr4Holos:lsM1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B =Year%40’Qtr3’, Year%40’Qtr4’Syntax for a cube parameteropenDocument.jsp?iDocID=367&sType=car&lsS[unique parameter name]=[cube location]Microsoft Analysis Services:lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=SERVER=server1,CATALOG=FoodMart 2000,CUBE=warehouse Essbase/DB2 OLAP (Enhanced Driver):lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=SERVER=server1,USER=bob,PWD=bobpassword,APPLICATION=Sam ppart,CUBE=CompanyEssbase/DB2 OLAP (Legacy Driver):lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=SERVER=server1,USER=bob,PWD=bobpassword,DATABASE=Sampp art,SCHEMA=Company,CUBE=CompanyHolos:lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B=NSHOST=NSserver1,NSPORT=10000,OCASERVER=test.server1,USER =bob,PWD=bobpassword,CUBE=cube1Syntax for a page parameteropenDocument.jsp?iDocID=367&sType=car&lsS[parameter name]=[page #]lsS1272DDB3-FC5B-40B7-81,E9,6F,3F,B0,3B,1F,7B =2Output parametersParameter Name Description Mandatory ExamplesOutputFormat Indicates theformat in whichthe targetdocument isdisplayed No.Defaultis HTML• H (HTML)• P (PDF)• E (Excel)Crystal reports only• W (Word)Code samplesopenDocument.jsp?iDocID=347&sType=wid&sOutputFormat=P openDocument.jsp?iDocID=861&sType=rpt&sOutputFormat=WsViewer Indicates theselected reportviewer (CR & CAonly)CAUTION: Thisparameter canconflict withsOutputFormatand should notbe combined No• CR & CAhtml (HTML)• CR onlyinteractive (dHTML)Code sampleopenDocument.jsp?sType=rpt&iDocID=860&sRefresh=Y&sViewer=interactivesWindow Indicateswhether thetarget reportwill open in thecurrent browserinstance orlaunch a new one No• Same• NewNAII Avoid thedisplay of thevalorizedprompts, justdisplay theprompts thathave no lsS, lsMor LsR No• Y (all prompts whose valuesare passed with lsS, lsM orlsR are pre-selected)• N (displays only the promptswhose values passed with lsS,lsM or lsR)Best practicesIntegrating UniversesA good practice is to create an object wrapping the complete URL thatincludes the openDocument command. This approach allows you tomigrate your deployment with just a Universe object update.Figure 4: A UniverseIn the above diagram, the Select statement contains:'<ahref=../../opendoc/openDocument.jsp?sType=wid&sIDType=CUID&iDocID=AWimiw9StnhGm993evk.Amc&lsSCountry?='+Resort_Country.country+'"target="_parent">'+Resort_Country.country+'</a>'The href uses relative reference (../..) to synchronize with the newEnterprise XI Interactive Viewer.Another technique is to use the HTML target keyword (target=_parent)pointing to the parent frame to avoid nested frames.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 will be centralized and all the reports using this objectwill be automatically updated.Figure 2: The Formula WorkshopThe following is the content of the ReportLinker function from theabove diagram:function(stringvar doctype, stringvar idtype, stringvar id,stringvar otherparams);"http://cdi30xi:8080/businessobjects/enterprise11/desktoplaunch/opendoc/openDocument.jsp?" + "sType=" + doctype +"&sIDType=" + idtype + "&iDocID=" + id + (if otherparams >"" then "&" + otherparams)Finding more informationThe XI openDocument command is documented in the BusinessObjectsEnterprise SDK guides that are installed with the product.The COM SDK documentation is located in:[drive letter]:\Program Files\Business Objects\BusinessObjectsEnterprise 11\Help\[language]\Application\com_docs.zipThe Java SDK documentation is located in:[drive letter]:\Program Files\Business Objects\BusinessObjectsEnterprise 11\Help\[language]\Application\java_docs.zipDocumentation 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).For more information and resources, refer to the product documentationand visit the support area of the web site at:/NOTE To highlight text in a PDF document for copying and pasting code, click the Text Select Tool toolbar button in Adobe Acrobat.This procedure applies to Adobe Acrobat 4.0 and 5.0.。