大纲加载实用程序的命令行参数

以下命令行参数适用于大纲加载实用程序。运行实用程序后,可通过查看异常文件和日志文件的结果来验证结果。如果日志文件中未报告错误,则可以访问应用程序中导入的元数据和数据。不必重新启动应用程序服务器。

HspOutlineLoad [-f:passwordFile] /A:application /U:userName [/CP:commandPropertieFileName] [/M] [ [/I:inputFileName|/IR[:RDBConnectionPropertiesFileName]|/IRA|/E:outputFileName|/ED:outputFileNameStem] [/EDD:dataExportSpecification] [/ICB:blockSpecification] [/SDM:driverMemberSpecification] /D[U]:loadDimensionName|/DA:attributeDimensionName:baseDimensionName|TR] [/N] [[/R] [/DPU]] [/C] [/F] [/K] [/8] [/DF:datePattern] [/RIQ:inputQueryOrKey] [/RIC:catalog /RID:driver /RIR:url /RIU:userName [/RIP:password]] [/X:exceptionFileName] [L:logFileName] [/?]

参数 说明

[-f:passwordFile]

可选:如果设置了加密的密码文件,则应在命令行中将其用作第一个参数,以便通过 passwordFile 中指定的完整文件路径和名称读取密码。

/S: server

此参数已弃用,用它指定的值将被忽略。如果使用此参数,系统将检查指定的服务器名称是否不为空,并且长度大于 0 个字符。此参数仍可用于提供向后兼容。大纲加载实用程序的(默认)服务器始终为 localhost。

/A: application

要向其中进行导入的 Oracle Hyperion Planning 应用程序的名称。

/U: userName

登录应用程序的用户名。

/CP: commandPropertieFileName

指定包含命令行参数的文件,其与命令行参数一起构成执行选项。对于显示在命令属性文件和命令行中的参数,命令行参数优先。

请参阅“命令属性文件”。

/M

为应用程序的可加载维生成完全合格的标题记录。若不希望显示本信息(默认),则可以使用 /-M

/I: inputFileName

指定 CSV 格式的数据加载输入文件,其中包含标题记录和数据记录。还必须指定数据加载维(/D 选项或 /TR 选项)。可以指定 /ICB 开关来清除 Oracle Essbase 数据。

/IR[:RDBConnectionPropertiesFileName]

指定输入记录将来自关系数据源。指定可选属性文件指出可以在该属性文件内找到部分或全部所需关系连接开关属性(/RIQ/RIC/RID/RIR/RIU/RIP)。还必须指定数据加载维(/D 选项)。可以指定 /ICB 开关来清除 Essbase 数据。

/IRA

/IR 开关相同,只是所需的 RDB JDBC 连接属性(/RIQ/RIC/RID/RIR/RIU/RIP 开关值)是从当前连接的应用程序的 RDB 数据源获取的。还必须指定数据加载维(/D 选项)。可以指定 /ICB 开关来清除 Essbase 数据。

/ICB: blockSpecification

执行导入操作(/I/IR/IRA)之前,清除 Essbase 块。(以下格式的字符串:\"<loadDimensionMembers,...>、\"<driverMembers,...>、\"<point-of-view members,...>、<dataLoadCubeName>\"")。

/ALS

如果导入时别名表不存在则创建这些表(默认)。如果引用的别名表不存在,使用 /-ALS 来导致出错。

/E: outputFileName

/D 开关项指定的维导出到指定的输出文件。(导出规划单元层次时,文件使用为导入规划单元层次定义的格式。)

/ED: outputFileNameStem

将数据导出到 Planning 动因成员格式化数据文件。还必须设置 /EDD 开关。以下面的格式生成文件:<fileNameStem>.1-n.csv<fileNameStem>.n-n.csv,其中 n 是生成的文件数。

/EDH

在输出文件中以 Planning 内部 HEADERBLOCK 格式导出维标题。导入时使用此项,以在导入之前动态创建基本维和属性维。

/ER[:RDBConnectionPropertiesFileName]

指定导出记录将写入关系数据库表。设置 /EDD 开关可指定还将导出数据。指定可选属性文件指出可以在该属性文件内找到部分或全部所需关系连接开关属性(/REQ/REC/RED/RER/REU/REP)。还必须使用 /D 开关指定数据加载维。

/ERA

/ER 开关相同,只是所需的 RDB JDBC 连接属性(/REQ/REC/RED/RER/REU/REP 开关值)是从当前连接的应用程序的 RDB 数据源获取的。设置 /EDD 开关可指定将导出数据。还必须使用 /D 开关指定数据加载维。

/EDD: dataExportSpecification

指定导出的 Planning 动因成员格式化数据文件的格式。以下格式的字符串:<loadDimensionMembers,...><driverMembers,...><point-of-view members,...><dataLoadCubeName>

/SDM: driverMemberSpecification

仅在导入操作时(/I/IR/IRA),在应用程序的基本加载维上设置动因成员 (/A)。(以下格式的字符串:\"<baseLoadDimension>、\"<driverMembers,...>\"、<PlanTypeName>"

/D: loadDimensionName

要加载的维,其成员字段与加载文件中的标题记录相对应。此外,还必须指定一个加载文件 (/I) 或用 /E 开关项指定导出的规划单元层次。

请参阅以下各行加载用户定义的维和属性:/DU/DA[T]/DAN/DAB/DAD

/DU: userDefinedLoadDimensionName

用户定义的需加载的维;如果具有该名称的维不存在,则会被创建。

/DA[T]: attributeLoadDimensionName:baseDimensionName

要加载的文本属性维;具有该名称的属性维与基本维绑定,若不存在则会被创建。

/DAN: attributeLoadDimensionName:baseDimensionName

要加载的数字属性维;具有该名称的属性维与基本维绑定,若不存在则会被创建。

/DAB: attributeLoadDimensionName:baseDimensionName

要加载的布尔属性维;具有该名称的属性维与基本维绑定,若不存在则会被创建。

/DAD: attributeLoadDimensionName:baseDimensionName

要加载的数据属性维;具有该名称的属性维与基本维绑定,若不存在则会被创建。

/DX:HSP_Rates

加载 HSP_Rates 维并创建兑换率表(如果没有)。

/DS_HSP_SMARTLISTS

加载智能列表维和智能列表维的条目。

/DL:comma|tab

将字段分隔符设置为逗号 \"、\" 逗号(默认值)或制表符。

/TR

当在加载文件的“动因成员”列中指定了动因成员时加载数据。必须在“视点”列中指定除动因成员之外的所有成员。借助 /TR,您可以根据加载文件中的每一行加载一个值。

/T

添加新成员时,从父代中继承未指定的规划类型设置(默认)。使用 /-T 强制显式设置成员的规划类型设置。

/N

在不加载数据或元数据的情况下解析加载文件,执行 "dry run"。加载数据和元数据(默认)的同时,用 /-N(或者不指定 /N 参数)解析加载文件。

注:

执行手动检查时,会对加载文件进行解析(例如,检查标题记录、检查值的个数是否与标题记录号一致),但不检查该文件中定义的值是否有效。

/O

加载时保持加载文件中成员的顺序,UDA 除外(默认)。在加载时使用 /-O 忽略加载文件中成员的顺序。

/H

按父 - 子顺序输入记录(默认的 UDA 除外)。加载文件中出现输入记录时使用 /-H 加载输入记录,这一选项更快捷且节约成本。

/R

运行加载前,请删除加载维的全部成员。用 /R(或不指定 /R 参数)来保持加载维中的全体成员(默认)。另请参阅 /U

注:

请谨慎使用 /R;该选项将删除属性绑定和审批状态。

/DPU

/R 参数删除所有规划单元,否则在规划单元中的成员尝试被删除时导致出错。使用 /-DPU 阻止删除操作删除规划单元中的成员。

/IDU

删除未在加载中显式指定的未指定成员。未在输入来源中显式指定的成员将在加载完成时从 Planning 大纲中删除,除非:1) 它们是指定的成员的祖先;2) 它们是指定的共享成员的基本成员。(/-IDU 是默认值。)

/C

加载元数据后执行多维数据集刷新。若不希望执行多维数据集刷新(默认),请使用 /-C。另请参阅 /F

/F

使用 /C 选项刷新时会创建安全筛选器(默认)。若不希望刷新安全筛选器(默认),则请使用 /-F。(该选项不对应用程序设置用户,只为当前存在的用户创建安全筛选器。可使用其他方法对应用程序设置用户。)要使该选项生效,必须指定 /C

/K

加载前推荐锁定加载维(默认)。若不想锁定维,请使用 /-K(除非使用 /N,否则不推荐)。

/8

在输入、输出、日志和异常文件中指定 UTF-8 编码,并在输出文件前添加 UTF-8 BOM 标记(默认)。使用 /-8 则不设置 UTF-8 编码。

/DF:datePattern

在日期数据转换到指定模式时覆盖默认日期模式。模式必须为下列之一:

  • MM-DD-YYYY

  • DD-MM-YYYY

  • YYYY-MM-DD

使用 /-DF 来使用默认日期模式设置(默认)。

/RIQ:inputQueryOrKey

SQL 查询或命令参数属性文件中的密钥(/CP 开关),在该文件中值是 SQL 查询,将执行该查询以为导入操作生成输入。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIC/RID/RIR/RIU/RIP 开关。

/RIC:catalog

输入 RDB 连接的 RDB JDBC 目录名称。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIQ/RID/RIR/RIU/RIP 开关。如果使用 /IRA 开关,不需要指定此开关。

/RID:driver

输入 RDB 连接的 RDB JDBC 动因名称。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIQ/RIC/RIR/RIU/RIP 开关。如果使用 /IRA 开关,不需要指定此开关。

/RIR:url

输入 RDB 连接的 RDB JDBC URL。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIQ/RIC/RID/RIU/RIP 开关。如果使用 /IRA 开关,不需要指定此开关。

/RIU:userName

输入 RDB 连接的 RDB JDBC 用户名。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIQ/RIC/RID/RIR/RIP 开关。如果使用 /IRA 开关,不需要指定此开关。

/RIP:password

输入 RDB 连接的 RDB JDBC 密码。必须设置 /IR 开关才能使用此项,如果使用此项,还必须设置 /RIQ/RIC/RID/RIR/RIU 开关。如果使用 /IRA 开关,不需要指定 /RIP 开关。

在 .properties 文件中第一次指定密码时,以未加密形式输入该密码。运行大纲加载实用程序时,将使用 /RIP 密码的加密值重写属性文件。如果未在属性文件中指定该值,将发出命令行提示来获取密码。

/REQ:exportQueryOrKey

SQL 查询或命令参数属性文件中的密钥(/CP 开关),在该文件中值是 SQL 查询,其指定表单的导出值。'INSERT INTO<tableName>(column1, column2, ...) VALUES (property1, property2, ...)',其中属性是平面文件列标题记录中的 Planning 成员属性。必须设置 /ER/ERA 开关才能使用此项,如果使用此项,还必须设置 /REC/RED/RER/REU/REP 开关。

/REC:catalog

导出 RDB 连接的 RDB JDBC 目录名称。必须设置 /ER 开关才能使用此项,如果使用此项,还必须设置 /REQ/RED/RER/REU/REP 开关。

/RED:driver

导出 RDB 连接的 RDB JDBC 动因名称。必须设置 /ER 开关才能使用此项,如果使用此项,还必须设置 /REQ/REC/RER/REU/REP 开关。

/RER:url

导出 RDB 连接的 RDB JDBC URL。必须设置 /ER 开关才能使用此项,如果使用此项,还必须设置 /REQ/REC/RED/REU/REP 开关。

/REU:userName

导出 RDB 连接的 RDB JDBC 用户名。必须设置 /ER 开关才能使用此项,如果使用此项,还必须设置 /REQ/REC/RED/RER/REP 开关。

REP:password

导出 RDB 连接的 RDB JDBC 密码。必须设置 /ER 开关才能使用此项,如果使用此项,还必须设置 /REQ/REC/RED/RER/REU 开关。

如果未在命令属性文件中指定该值,将发出命令行提示来获取密码。

/C2A:(column1, alias1), (column2, alias2), ...

“列到别名”映射或运行时列重命名和排除。使用该参数可以在运行时重命名列标题、忽略列或者忽略或重命名特定规划类型属性。

注:

在列中指定的别名将覆盖此命令指定的值。

/UCH

忽略无法识别的列标题并继续加载。/-UCH 是默认的当前功能:如果遇到无法识别的列标题,则中止加载。将输出一条信息消息,其中列出了已忽略的列。

/X: exceptionFileName

指定包含异常(可能出现在加载过程中的异常)的文件。(如未指定文件名,则信息写入一个名为 stderr 的文件中。)

/L:logFileName

指定包含状态和消息的文件。(如未指定文件名,则信息将写入一个名为 stdout 的文件中。)

/?

显示用法文本。

示例:加载数字的属性维与属性值,并与“实体”维相关联。(如果没有属性维则将新建一个,但不会分配属性值到基数字中。)

OutlineLoad /A:Test  /U:admin  /M /I:c:/outline1_attribvals_text.csv /DAN:NumericAttrib:Entity /L:c:/outlineLoad.log /X:c:/outlineLoad.exc
NumericAttrib,Parent
One,NumericAttrib
1,One 
2,NumericAttrib

示例:加载“兑换率”,添加 EUR 作为“货币”维的成员,然后更改加载文件中的年,使其与 Planning 应用程序中现有的年相匹配。若不存在兑换率表,则将在 Planning 应用程序中创建。

OutlineLoad /A:Test /U:admin /M /I:c:/outline1_rates.csv /DX:HSP_Rates /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Table, To Currency, From Currency, Method, Historical, Beg Balance, Year, Period, Average, Ending
FX1 , USD, EUR, multiply, 1, 2, FY08, Jan, 3, 4
FX1 , USD, EUR, , , , FY09, Feb, 5, 6

示例:将“按周分配”设置为 Use 445

Account, Parent, Use 445
a11,a1,1

示例:加载一个包含 UDA 所有可用属性的文件。UDA 被加载并与一个维建立关联,但不会被分配给维中的任何成员。

OutlineLoad /A:Test  /U:admin  /M /I:c:/outline1_uda.csv /D:UDA /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Dimension,UDA 
Account,New2

示例:为“货币”加载一个没有指定货币符号的文件。在这种情况下,Planning 应用程序中的货币符号设置为 ISO 符号,即 EUR。默认缩放比例为 1。

Currency,Parent,Symbol,Scale
EUR,,,

示例:为“货币”加载一个将符号设置为新货币名的文件。符号自动设置为 Planning 应用程序的 NewCurr1。“货币”名称限用 8 个字符。

Currency,Parent,Symbol,Scale
NewCurr1,,,

示例:使用带加密密码的 -f 参数

若已经生成了加密的密码文件,可以使用 -f 作为命令行的第一个参数运行大纲加载实用程序(无需输入密码)。例如,若您使用 PasswordEncryption 实用程序创建了一个名为 encrypt.txt 的密码文件,则可以使用这个命令行:

OutlineLoad -f:c:\encrypt.txt /A:acpt /U:admin /M /I:c:/outline1_accounts.csv /D:Account /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc

示例/O 参数和加载文件顺序

在以下加载文件中,如果“实体”成员 e1 和 e2 已存在于“实体”维中,可将 e3 添加为最后一个同级成员(即使 e3 在加载文件中首先出现)。如果使用了 /O,则 e3 会作为第一个同级成员加载。因为 /O 为默认成员,您必须指定 /-O 将 e3 作为最后一个同级加载。

Entity,Parent,Data Storage,TextAttrib
e3,Entity,Store,
e2,Entity,Store,
e1,Entity,Store,

示例/H 参数和父/子次序

假设成员 e1 已经存在,A 和 B 是正在加载的新成员。如果不用 /H 可能会出现错误,因为成员 B 不存在。使用 /H 后,成员在内部被分类,因此 B 作为 e1 的子代最先加载,然后 A 作为 B 的子代被成功加载。

Entity,Parent,Data Storage
A,B,Store 
B,e1,Store

示例/R 参数

如果有些成员已经存在于维中,只有输入加载文件中的成员会在加载后继续存在。删除操作后,如果加载出错,维中的全体成员均可能被删除,维被清空。“属性”维未被删除。如果启动一个规划单元,则不会删除任何“实体”成员,因为规划单元中的“实体”成员不能被删除。

Entity,Parent,Data Storage,TextAttrib
e1,Entity,Store,
e11,e1,Store,orange
e2,Entity,Store,
e21,e2,Store,
e11,e2,shared,yellow

示例/T 参数

/T 加载“帐户”维,在添加新成员时从父代继承那些未在加载文件中被明确指定的规划类型。假设成员 a1 已经存在于应用程序中,并适用于全部三个规划类型。加载结束后,成员 a11 适用于全部三个规划类型,即便在加载文件中只指定了 Plan1 和 Plan3。

Account, Parent, Source Plan Type, Plan Type (Plan1), Plan Type (Plan2), Plan Type (Plan3)
a11,a1,Plan1,1,,1

示例/-T 参数

/-T 加载“帐户”维,强制显式设置新成员规划类型。假设成员 a1 已经存在于应用程序中,并适用于全部三个规划类型。加载结束后,成员 a11 只适用于 Plan1 和 Plan3 等在加载文件中指定的规划类型,而不适用于 Plan2。

示例/TR 参数

OutlineLoad /A:acpt1 /U:admin /M /I:c:\outline1data.csv /TR /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
Value,Driver Member,Point-of-View,Data Load Cube Name
14,a1,"Jan,Local,e1,Current,Version1,FY08",Plan1
sl1_value2,a2,"Jan,Local,e1,Current,Version1,FY08",Plan1

示例:使用 /DS:HSP_SMARTLISTS 参数加载智能列表维和智能列表维的条目。

OutlineLoad /A:acpt /U:admin /M /I:c:/smartlist_create1.csv /DS:HSP_SMARTLISTS /L:c:/OutlineLogs/outlineLoad.log /X:c:/OutlineLogs/outlineLoad.exc
SmartList Name, Operation, Label, Display Order, Missing Label, Use Form Missing Label, Entry ID, Entry Name, Entry Label
SL1,addsmartlist,SL1Label,,,,,,
SL1,addEntry,,,,,,entry1,entrylabel1
SL1,addEntry,,,,,,entry2,entrylabel2

示例:使用 LINEITEM 标志执行增量式数据加载。

可以在数据加载文件中包含 LINEITEM 标志,以基于唯一的动因维标识符对数据加载维的子代执行增量式数据加载。这将指定,当表单上存在具有指定唯一标识符的行时,应覆盖数据。如果不存在这样的行,则只要“数据加载维父代”成员下有足够多的子代成员,就输入数据。

例如,加载员工数据时,可以为预定义的薪金等级加载预算行项目详细信息。此示例展示了一个命令,它可以用于包括 LINEITEM 标志的数据加载文件。

OutlineLoad /A:pln1dv /U:admin  /M /I:c:\dataload_file.csv /D:"Budget Item"

该数据加载示例文件将加载“Budget Item(预算项)”维中“Grade Changes(等级更改)”子代的数据。

"Budget Item","Data Load Cube Name","Point-of-View","Grade Step","Option Value","Start Date","End Date"
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step1","31721","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step2","32673","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step3","33654","7/1/09",""
"<LINEITEM("Grade Changes">","HCP","POVMembers","Step4","33654","7/1/09",""

在本例中,根据在“数据加载设置”页中选定的唯一标识符:等级梯级、选项值、起始日期以及结束日期,<LINEITEM("Grade Changes")> 从“Budget Item(预算项)”中查找是“Grade Changes(等级更改)”成员子代的第一个可用成员。

数据加载期间,如果 Grade Changes 的任意子代成员在 Step17/1/09 中已有数据,则使用相应成员更新其余数据值。如果没有,则向下一个可用空数据行分配 Step17/1/09

处理第一个数据行时,系统会分配 Grade1 成员。同样,接下来的两个成员 Grade2Grade3 会被分配至第二个和第三个数据行。在处理第四个数据行时,Step17/1/09 已分配至成员 Grade1,因此,将使用该行更新其余字段的值。

示例:使用 /D 参数导入规划单元层次。

OutlineLoad /A:acpt /U:admin /I:c:\puh1.csv /D:PUH1

使用 /D 导入规划单元层次时,必须指定规划单元层次(不是维)的名称。在向规划单元层次中加载新成员之前,它必须已经存在于 Planning 应用程序中。

示例:使用 /E 参数导出规划单元层次。

OutlineLoad /A:acpt_580 /U:admin /M /E:puh_test2.csv /D:test2
Primary Member, Primary Enabled, Secondary Dimension, Secondary Parent, Relative Generation, Auto Include, Secondary Member, Include, Owner, Reviewers, Notifiees
e1, true, <none>, <none>, <none>, false, , true, <none>, admin, planner
e11, true, <none>, <none>, <none>, false, , true, <none>, <none>, <none>
e2, true, <none>, <none>, <none>, false, , true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, , true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a11, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a12, true, admin, <none>, "admin,admin"
e21, true, Account, a1, 1, false, a13, true, planner, "planner2,admin", admin
e21, true, Account, a1, 1, false, a14, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a15, true, <none>, <none>, <none>
e21, true, Account, a1, 1, false, a16, true, <none>, <none>, <none>
e21, true, Account, a1, 1-2, false, a111, true, <none>, <none>, <none>

注:

没有为前四条记录指定 Secondary member。