WhitepaperPutting XI openDocument to work v013.docx
- 文档编号:27119764
- 上传时间:2023-06-27
- 格式:DOCX
- 页数:20
- 大小:305.74KB
WhitepaperPutting XI openDocument to work v013.docx
《WhitepaperPutting XI openDocument to work v013.docx》由会员分享,可在线阅读,更多相关《WhitepaperPutting XI openDocument to work v013.docx(20页珍藏版)》请在冰豆网上搜索。
WhitepaperPuttingXIopenDocumenttoworkv013
PuttingXIopenDocumenttowork
Author:
FredericVanborre
Contributors:
BonnieChang,YanChen,SaurabhAbhyankar,JohnJiang,ArthurYip
PuttingXIopenDocumenttowork1
1GeneralSynopsis2
1.1Purpose2
1.2References2
1.3Undocumentedparameters3
1.4Platformparameters3
1.5Inputparameters5
1.5.1SpecifyingpromptsforOLAPIntelligencereporttargets9
1.6Outputparameters12
2Bestpractices13
2.1Howtoextractplatforminformation?
13
2.2Universeintegration13
2.3RepositoryCustomFunctions14
3What’snext15
4Conclusion15
1GeneralSynopsis
1.1Purpose
ThegoalofthiswhitepaperistoexplainhowtodeploytheXIopenDocumentfeaturesandprovidesyntaxexamples.
OpenDocumentserves2mainmissions
ÄURLreporting
ÄReporttoreportlinking
URLreportingallowsausertocallourBIsystemwithoneURL(alsocalled“1lineBI”)andeasilyintegrateoursolutionwithintheirapplications/portalswithoutadeepknowledgeoftheunderlyingSDK.
Reporttoreportlinkingisthecapabilitytolinkreportssothattheusercananalyzetheirdatabeyondthereportboundary.
1.2References
TheXIopenDocumentfeatureisdocumentedintheBusinessObjectsEnterpriseSDKguidesavailableintheXIfiletree.
-TheCOMSDKdocumentationislocatedin\ProgramFiles\BusinessObjects\BusinessObjectsEnterprise11\Help\xx\Applicationinazipcalledcom_docs.zip.
-TheJavaSDKdocumentationisalsolocatedin\ProgramFiles\BusinessObjects\BusinessObjectsEnterprise11\Help\xx\Applicationinazipcalledjava_docs.zip
Note:
xxisthelanguage
TheopenDocumentdocumentationisfoundinthe"ViewingReportsandDocumentsusingURLs">"URLReportingUsingopenDocument"sectionoftheViewerCOMSDKGuide(Report_Viewers.chm)andtheViewerJavaSDKGuide(ViewersJavaSDKGuide>GeneralReference).
ThecompleteURLsyntaxis
http:
//
openDocument.jsp
http:
//
opendocument.aspx
BydefaultXIusesthe
Exampleifmyhostnameisparis
http:
//paris:
8080/businessobjects/enterprise11/desktoplaunch/opendoc/
openDocument.jsp
http:
//paris/businessobjects/enterprise11/InfoView/scripts/
opendocument.aspx
Fortheremainderofthedocument,theterm“openDocument.jsp”isusedinplaceofthecompleteURLsyntax.
1.3Undocumentedparameters
ThefollowingparametersarealsosupportedbyopenDocument,butwerenotdocumentedintheXIreleasedocumentation.
SingleSign-on
XIopenDocumentsupportssinglesign-on(SSO).InordertoachieveSSO,openDocumentfirstcheckifasessionvariablecalledISEnterpriseSessionisavailable(thisvariableissupposedtocontainanenterprisesession).IfthishttpsessionvariableisnotavailablethentheopenDocumentpagechecksthenewtokenparameterusedtopassthesessionidentifiertoken.ThistokenisreturnbytheBusinessObjectsEnterpriseSDKwhenasessioniscreatedorviatheILogonTokenMgr.getDefaultToken()API.
ParameterName
Description
Mandatory
Example
token
Containstheuser’ssessiontokengeneratedbytheplatform
Agnosticdocuments(IgnorethesTypeparameter)
AgnosticdocumentssuchasExcel,Word,Txt,etc.canbereferencedthroughopenDocumentbyexcludingthedocumenttypeparameter(sType).
1.4Platformparameters
Thefollowingparametersareusedtodealwiththeplatformproperties.
XIprovides2optionstoreferencearesource
ÄXIplatformresourceidentifiers
ÄXIplatformresourcenames(namecanbeaconcatenationofresourcenameandfolderpathtoremoveambiguity)
XIopenDocumentintroducesanewwaytoidentifythetargeteddocuments.
In6.x,weusedamixofdocumentname,identifierandrepositorytypetopointtotherightdocument.InXI,thenameidentificationisstillavailablebutwealsointroducedamuchmoreflexiblewaytoreferenceyourdocumentsbasedontheBOEInfoObjectidentifier.
ÄIdentifier(ID)
ÄClusteridentifier(CUID)
ÄPackageidentifier(RUID)
ÄGlobalidentifier(GUID)
Thechoiceismainlydependantonyourdeployment,however,resourcenamesareprobablylessrobusttochange.
ParameterName
Description
Mandatory
Example
iDocID
Documentidentifier
CanbereplacedbysDocName
Documentidentifier(InfoObjectID)
sIDType
CMSobjectidentifiertype.
Yes,ifthedefaultdocumentidentifier(InfoObjectID)isnotused
▪CUID
▪GUID
▪RUID
▪InfoObjectID(default)
Codesample
openDocument.jsp?
iDocID=342
openDocument.jsp?
iDocID=AWimiw9StnhGm993evk.Amc&sIDType=CUID
sType
Thefiletypeof
Targetdocumentor
report.
Ignoredforagnosticdocuments
▪wid
▪rpt
▪car
Codesample
openDocument.jsp?
iDocID=342&sType=wid
openDocument.jsp?
iDocID=343&sType=rpt
sPath
ThenameoftheBOEfolderandsubfolder
containingthe
targetdocument.
ThisparameterisusedinconjunctionwithsDocName
BOEfolderand/or
subfolder:
[folder],[subfolder]
sDocName
Thenameofthedocumentwithoutextension.
AdocumentisareportintheCrystalterminology.
ThisparameterisusedinconjunctionwithsPath
myDocument
Codesample
openDocument.jsp?
sPath=[reports]&sDocName=Charting&sType=rpt
openDocument.jsp?
sPath=[reports],[finance]&sDocName=Summary&sType=rpt
Deprecatedparameters
ParameterName
Description
Mandatory
Example
sRepo
Repositoryname(orDomainname).
Defaultsto“Document”.
sRepo=Document
(deprecated-nomoreusedonXI)
sRepoType
Repositorytype
(“corporate”,
“personal”,or
“inbox”,“crystal”,
“URL”)
Defaultto“crystal”
RepoType=crystal
1.5Inputparameters
Thisinformationisprovidedtofillthedifferentparametersorreferencespecificlocationinsideadocument.
Rq:
2bugshavebeencreatedfortheWebIparameternameandreportnamecontainingspecialcharacters(ADAPT00419975-ADAPT00419189)
ParameterName
Description
Mandatory
Example
sReportName
Indicateswhichreportto
openiftargetdocumentcontainsmulti-report.
(Theactivereportisopenedbydefault)
Reportnamefor
WebIntelligence
documents,
Codesample
openDocument.jsp?
iDocID=342&sType=wid&sReportName=Report2
sReportPart
IndicateswhichspecificpartoftheCrystaltargetreporttoopen.
NameoftheCrystal
reportpart.
Codesample
TheWorldSalesReportprovidedwithXIcontainsreportparts.
File>ReportOptions…
Bydefaulttheobjectnamesare:
Text2andGraph1andthecontextequalto/
openDocument.jsp?
sType=rpt&sDocName=World+Sales+Report&sReportPart=Text2;Graph1&sPartContext=/
+isanURLencodingcharacterforaspace
sPartContext
InCrystalReportsareportpartisassociatedtoadatacontext.
YesifavalueisspecifiedforsReportPart
Datacontextofthe
reportpart.
sReportMode
ForCrystaltargetsonly,
indicateswhetherthelinkshouldopenthefulltargetreportorjustthereportpartspecifiedinsReportPart.
DefaultisFull
Onlyappliesifa
valueisspecified
forsReportPart
▪Full
▪Part
Codesample
openDocument.jsp?
sType=rpt&sDocName=World+Sales+Report&sReportPart=Text2;Graph1&sPartContext=/Country[England]&sReportMode=Part
sRefresh
Indicateswhetherarefreshshouldbeforcedwhenthetargetdocumentorreportisopened.
Rq:
ForCRusethereportobjectinsteadoftheinstancestohitthedatabase(ondemandviewing)
Y(refreshthedocument)
N(notethattherefreshonopenfeatureoverridesthisvalue)
Codesample
openDocument.jsp?
iDocID=342&sType=wid&sRefresh=Y
lsS[NAME]
Specifiesavalueforasingleprompt.
[NAME]isthetextof
theprompt.
Asinglepromptvalue.
Codesample
openDocument.jsp?
iDocID=342&sType=wid&sRefresh=Y&lsSProductName=Cycle
ThefollowingsampleusesalmostalltheCRparamtypes
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)&lsSparamBoolean=false&
lsSparamTime=Time(12,39,2)&lsSparamStringDR=a&lsSparamDateDR=Date(2003,6,1)
lsM[NAME]
Specifiesmultiplevaluesforaprompt.
[NAME]isthetextof
theprompt.
Multiplepromptvalues,
separatedbyacommaforCR&OLAP,separatedbyasemicolonforWebi.
IfthetargetisaCrystal
report,eachvaluemust
beenclosedinsquare
brackets.IfthetargetisaCrystalAnalysisreport,
usetheMDXWITH
clause.
Codesample
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]
Specifiesarangeofvaluesforaprompt.[NAME]isthe
textoftheprompt.
Arangeofvaluesforthe
prompt,separatedbya
doubleperiod(..).Ifthe
targetisaCrystalreport,therangemustbe
enclosedinsquare
bracketsand/orparentheses(usea
squarebracketnexttoa
valuetoincludeitinthe
range,andparentheses
toexcludeit).Ifthe
targetisaOLAPreport,usethe
MDXWITHclause
Codesample
openDocument.jsp?
iDocID=345&sType=wid&sRefresh=Y&lsMProductName=Cycle,Car
openDocument.jsp?
sType=rpt&iDocID=860&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]&lsRparamDate
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- WhitepaperPutting XI openDocument to work v013
链接地址:https://www.bdocx.com/doc/27119764.html