BOE OpenDocument 参数概述
本帖最后由 乔帮主 于 2014-12-3 13:36 编辑BOEOpenDocument 参数概述
一、 OpenDocument 平台参数1、iDocID2、sDocName3、sIDType4、sPath5、sType6、token二、OpenDocument 输入参数1、lsC2、lsM3、lsR4、lsS5、sInstance6、sPartContext7、sRefresh8、sReportMode9、sReportName10、 sReportPart三、OpenDocument 输出参数1、NAII2、sOutputFormat3、sViewer4、sWindow四、有关语法和参数的进一步信息1、URL 编码2、尾随空格3、区分大小写4、长度限制5、OLAP Intelligence 报表目标的提示6、将 lsS 参数和 OLAP Intelligence 一起使用7、将 lsM 参数和 OLAP Intelligence 一起使用8、子报表
本节简要概述openDocument 并包括可用命令列表。而且还提供了有关可用命令、其特定用途以及相关示例的详细信息。<platformSpecific> 参数的确切语法取决于具体的实现：• 对于Java 实现，请使用opendoc/openDocument.jsp代替<platformSpecific> 参数。链接的第一个参数http://<servername>:<port>/OpenDocument/<platformSpecific>?上面示例中显示的第一个参数必须放在所有其他参数之前。在此信息之后，参数可以按任何顺序出现。下表中显示了函数参数。必需列指定参数在链接中是否是必需。注意: 包含openDocument链接的文档称为父文档，它位于父系统中。链接指向的文档称为目标文档，它位于目标系统中。
一、 OpenDocument 平台参数
下表列出了openDocument平台参数：注意: 变量用尖括号表示。必须将这些变量替换为恰当的值。例如，必须使用服务器的名称替换<servername>（下面的代码示例中包括此变量），而且必须使用端口号替换<port>。1、 iDocID
参数语法参数说明是否必须参数接受的值
iDocID文档标识符。sDocName 或iDocID 其中之一是必需的。文档标识符（InfoObjectID）。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010注意: 要获取文档ID，请在InfoView 中导航到该文档，将鼠标悬停在文档名称超级链接上，并在浏览器的状态栏中查找ID 号。也可以从中央管理控制台中获取文档ID。
2、 sDocName
参数语法参数说明是否必须参数接受的值
sDocName无扩展名的文档名称如果有多个文档的名称相同，请使用iDocID 指定正确文档。sDocName 或iDocID 其中之一是必需的。文档名称。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+200
3、 sIDType
参数语法参数说明是否必须参数接受的值
sIDType中央管理服务器（CMS）对象标识符类型。是，条件是目标为对象包中的Crystal 报表或OLAP Intelligence报表（sType=rpt或=car ）（否则，请使用sPath和sDocName）• CUID• GUID• RUID• ParentID• InfoObjectID（默认值）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?iDocID=2010&sIDType=CUID
参数语法参数说明是否必须参数接受的值
sKind目标DesktopIntelligence 文档的文件类型。是，条件是目标为DesktopIntelligence文档（否则，请使用sType）• FullClient
sKind
示例：
http://<servername>:<port>/OpenDocument/<platformSpecific>?sKind=FullClient
4、 sPath
参数语法参数说明是否必须参数接受的值
sPath包含目标文档的文件夹和子文件夹的名称。是，条件是指定了sDocName，并且它不是唯一的。文件夹和/或子文件夹：[文件夹]、[子
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2005
注意： 为了确保URL 编码的正确，此参数和以下几个参数中的空格被替换为 +。可以使用WebIntelligence URLEncode() 函数确保参数值的 URL 编码是正确的。
参数语法参数说明是否必须参数接受的值
sType目标文档或报表的文件类型。是，但对于不可知文档却被忽略• wid：Web Intelligence 6.x版本文档• rpt：Crystal 报表• car：OLAP Intelligence 报表
5、 sType示例
http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid
6、 token
参数语法参数说明是否必须参数接受的值
token当前CMS 会话的有效登录标记。否当前CMS 会话的登录标记。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=Sales+in+2003&token=<logonToken>
二、OpenDocument 输入参数下表列出了openDocument 输入参数：注意: 变量用尖括号表示。必须将这些变量替换为恰当的值。例如，必须使用服务器的名称替换<servername>（下面的代码示例中包括此变量），而且必须使用端口号替换<port>。
1、 lsC
参数语法参数说明是否必须参数接受的值
lsC如果在SQL生成期间出现不确定情况，则指定上下文提示（仅限BusinessObjects 和WebIntelligence 文档）。注意: 不受OLAP Intelligence支持否在SQL 生成期间解决不确定情况的提示值。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&lsC=Sales
2、 lsM
参数语法参数说明是否必须参数接受的值
lsM指定提示的多个值。 是提示的文本。否以逗号分隔的多个提示值。如果目标是Crystal 报表，则必须将每个值括在方括号中。如果目标是OLAPIntelligence报表，请使用MDX WITH 子句（请参阅第114 页上的“将lsS 参数与OLAPIntelligence报表一起使用”和第115 页上的“将lsM 参数与OLAP Intelligence报表一起使用”）。•no_value（仅适用于可选参数）注意: 通过在OpenDocument查询字符串中将可选参数设置为no_value，可以从提示中删除此可选参数。如果将可选参数放在OpenDocument查询字符串之外，则将应用默认的参数值。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=rpt&sDocName=SalesReport&lsMSelect+Cities=,
3、 lsR
参数语法参数说明是否必须参数接受的值
lsR指定提示的值范围。 是提示的文本。注意: 不受OLAP Intelligence支持否•用双句点（..）分隔的提示值的范围。如果目标是Crystal 报表，则必须将范围括在方括号和/或圆括号中（在值旁边使用方括号可将值包括在范围中，在值旁边使用圆括号可将值排除在范围之外）。•no_value（仅适用于可选参数）注意: 通过在OpenDocument查询字符串中将可选参数设置为no_value，可以从提示中删除此可选参数。如果将可选参数放在OpenDocument查询字符串之外，则将应用默认的参数值。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=rpt&sDocName=SalesReport&lsRTime+Period:=[2000..2004)
4、 lsS
参数语法参数说明是否必须参数接受的值
lsS指定提示的单个值。 是提示的文本。否一个提示值（请参见第114 页上的“将lsS 参数与OLAPIntelligence报表一起使用”和第115页上的“将lsM 参数与OLAPIntelligence报表一起使用”）。•no_value（仅适用于可选参数）注意: 通过在OpenDocument查询字符串中将可选参数设置为no_value，可以从提示中删除此可选参数。如果将可选参数放在OpenDocument查询字符串之外，则将应用默认的参数值。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&lsSSelect+a+City=Paris
5、 sInstance
参数语法参数说明是否必须参数接受的值
sInstance指明要打开目标报表的哪个特定实例。否（与sDocName 和lsS一起使用）• User（指向当前用户所拥有的最新实例的链接）• Last（指向报表的最新实例的链接）• Param（指向具有匹配参数值的报表最新实例的链接）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sReportPart=Part1&sInstance=User
6、 sPartContext
参数语法参数说明是否必须参数接受的值
sPartContext在CrystalReports 中，报表部件与数据上下文关联。是，条件是为sReportPart 指定了值报表部件的数据上下文。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2005&sReportPart=Part1&sPartContext=0-4-0
7、 sRefresh
参数语法参数说明是否必须参数接受的值
sRefresh指明当目标文档或报表处于打开状态时是否应强制刷新。否• Y（强制刷新文档）• N（请注意“打开时刷新”功能将覆盖此值）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&sRefresh=Y
8、 sReportMode
参数语法参数说明是否必须参数接受的值
sReportMode仅适用于Crystal 目标，指示链接是应该打开完整目标报表，还是仅打开在sReportPart 中指定的报表部件。否（默认值为“Full”）只在为sReportPart 指定了值的情况下应用• Full• Part
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sReportPart=Part1&sReportMode=Part
9、 sReportName
参数语法参数说明是否必须参数接受的值
sReportName指明当目标文档为多报表文档时打开哪个报表。否（默认值为第一个报表）Web Intelligence文档的报表名称、CrystalReports 的子报表、OLAPIntelligence报表的页。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=Sales+in+2003&sReportName=First+Report+Tab
10、 sReportPart
参数语法参数说明是否必须参数接受的值
sReportPart指明要打开目标报表的哪个特定部件。否报表部件的名称。
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sReportPart=Part1
三、OpenDocument输出参数下表列出了openDocument 输出参数：注意: 变量用尖括号表示。必须将这些变量替换为恰当的值。例如，必须使用服务器的名称替换<servername>（下面的代码示例中包括此变量），而且必须使用端口号替换<port>。
1、 NAII
参数语法参数说明是否必须参数接受的值
NAII强制显示提示选择页。注意: 不受OLAP Intelligence支持否• Y（预先选择所有用lsS、lsM或lsR 传递值的提示）• N（只显示用lsS、lsM 或lsR 传递值的提示）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&NAII=Y
2、 sOutputFormat
参数语法参数说明是否必须参数接受的值
sOutputFormat指明打开目标文档时使用的格式。否（如果未在链接中指定此参数，则默认值为HTML）• H（HTML）• P（PDF）• E（Excel）• W（Word）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sOutputFormat=E
3、 sViewer
参数语法参数说明是否必须参数接受的值
sViewer指明用于查看文档的查看器。否• html• actx（仅限于Crystal 报表）• java（仅限于Crystal 报表）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sViewer=html
示例：注意: 为了将URL中的参数与ActiveX 查看器一起使用，必须将“:connect”附加到URL，后跟参数。http://<servername>:<port>/OpenDocument/<platformSpecific>?sPath=ports]&sDocName=Sales+in+2003&sViewer=actx:connect&IsMCountry=land],
4、 sWindow
参数语法参数说明是否必须参数接受的值
sWindow指明是将在当前浏览器窗口中打开目标报表，还是将启动一个新窗口。否• Same（当前浏览器窗口）• New（启动新浏览器窗口）
示例：http://<servername>:<port>/OpenDocument/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&sWindow=New
四、有关语法和参数的进一步信息
1、 URL 编码
参数不能包含空格或需要 URL 编码的其他特殊字符。 使用WebIntelligence URLEncode() 函数以确保 URL 编码正确。示例：对sDocName 参数进行编码要在 sDocName 参数中传递字符串“World Sales Report”，请使用 sDocName=URLEncode("World Sales Report")。 这样可确保字符串是以“World+Sales+Report”的形式传递编码的 URL。
2、 尾随空格
剪裁参数值和提示名称结尾处的尾随空格。不要将它们替换为加号(+)。查看器可能不知道是要将加号解释为提示名称的一部分，还是解释为空格。例如，如果提示名称显示：Select a City:_（其中_ 表示一个空格），请在链接中输入以下文本：lsSSelect+a+City:=Paris其中，提示名称中的空格将被替换为加号，而尾随空格将被剪裁掉。注意： 可以使用Web Intelligence RightTrim() 函数来剪裁尾随空格。
3、 区分大小写
所有 OpenDocument 参数都区分大小写。
4、 长度限制
经过编码的 URL 的总长度不能超过 2083 个字符。
5、 OLAP Intelligence 报表目标的提示
如果目标文档是 OLAP Intelligence 报表（.car），则可以使用 lsS和 lsM 参数来指定提示。
6、 将 lsS 参数和 OLAP Intelligence 一起使用
使用在OLAP Intelligence 报表中创建的唯一参数名称，将参数以编码的URL 字符串格式进行传递。OpenDocument 语法417示例：将报表打开到某一特定页面如果 23CAA3C1-8DBB-4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F是OLAP Intelligence报表中页面参数的编码的 URL 唯一名称，则可以使用以下 URL 将 OLAPIntelligence 报表打开到第 2 页：http://<webserver>/businessobjects/enterprise115/<platformSpecific>?sType=car&sIDType=InfoObject&iDocID=440&lsS23CAA3C1-8DBB-4CF3-BA%2CB8%2CD7%2CF0%2C68%2CEF%2C9C%2C6F=2示例：打开多维数据集参数如果 8401682C-9B1D-4850-8B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62是用于在MSAS 上的FoodMart 2000 目录中打开仓库多维数据集的多维数据集参数的编码的URL 唯一名称，则可以使用以下 URL 打开此多维数据集参数：http://<webserver>/businessobjects/enterprise115/<platformSpecific>?sType=car&sIDType=InfoObject&lsS8401682C-9B1D-4850-8B%2C5E%2CD9%2C1F%2C20%2CF8%2C1%2C62=CATALOG%3DFoodMart%202000,CUBE%3Dwarehouse&iDocID=616
7、 将 lsM 参数和 OLAP Intelligence 一起使用
使用在 OLAP Intelligence 报表中创建的唯一参数名称，也将 lsM参数以编码的 URL 字符串格式进行传递。以下是使用 lsM 的示例：http://<webserver>/businessobjects/enterprise115/<platformSpecific>?sType=car&sIDType=InfoObject&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]&iDocID=544这是一个在视图中通过“Customers（客户）”> “Country （国家/地区）”> “Mexico and Customers （墨西哥和客户）”> “Country （国家/地区）”> “Canada （加拿大）”打开报表的成员集参数。
8、 子报表
无法将参数值传递给目标 Crystal 报表的子报表。
页:
[1]