参数文件
参数文件是一个 INI 文件,可以在其中对导出进行设置。例如,可用于设置导出哪些数据或将数据存储在哪个文件中。
您可以使用任何文本编辑器自行创建参数文件。参数文件的名称和文件扩展名可以自由选择,例如Parameter.config.ini
。
下表列出了可对所有导出进行的设置。仅适用于个别导出的设置可在相应导出的说明中找到。
[User] 节
键 | 描述 | 值 |
---|---|---|
账户 | 启动导出的用户 | |
域 | 创建用户所在的域。只有当用户属于某个域,且调用时没有指定该域时,才需要指定此密钥。 | |
密码 | 用户密码(只有在参数文件中也指定了执行用户时,才会考虑此密钥)。 | |
PasswordMode | 指定密码的解释方式。 | 0:密码被解释为未加密(默认值)。 2:密码必须通过命令行输入。 |
令牌 | 用户的访问令牌。访问令牌可在 AdminClient 中生成,执行 ExportModule 时需要使用该令牌。如果指定了令牌,则无需传输其他登录信息。 |
[Common] 节
ReportType*
要生成的报告。只能有一个属性。
值 | 描述 |
---|---|
ComponentTree | 导出 项目树 |
JobList | 导出作业概述 |
JobResults | 导出所有作业的作业结果 |
UnequalJobResults | 只导出发现差异或发生错误的作业的作业结果。 |
UserManagement | 导出用户和用户组 |
ComponentTypes | 导出组件类型及其配置(名称、ID 等)。 |
Componentlog | 导出组件日志内容 |
Eventlog | 导出事件日志模块的内容 |
Adminlog | 向 AdminClient 导出更改列表 |
StandardLibraryManagement | 导出使用标准模块的位置概览 |
ComponentsWithStdLibAssignments | 导出与标准库链接的组件概览。 |
AssetState | 导出厂区状态作业概览 |
UsageInformation | 创建使用信息文件 |
ExportType
指定以何种格式创建导出进程。并非每个导出进程都能以任意格式创建。如果参数文件中没有指定 ExportType,则使用默认值。
值 | 格式 | 默认格式 |
---|---|---|
ComponentTree | XML 或 JSON | XML |
JobList | CSV 或 JSON | CSV |
JobResults | CSV 或 JSON | CSV |
UnequalJobResults | CSV 或 JSON | CSV |
UserManagement | XML 或 JSON | XML |
ComponentTypes | XML 或 JSON | XML |
ComponentLog | CSV 或 JSON | CSV |
Eventlog | CSV 或 JSON | CSV |
Adminlog | CSV 或 JSON | CSV |
StandardLibraryManagement | CSV 或 JSON | CSV |
ComponentsWithStdLibAssignments | CSV 或 JSON | CSV |
AssetState | CSV 或 JSON | CSV |
ExportFile*
存储导出进程结果的文件的绝对路径(含文件名)。如果该文件已经存在,则会被覆盖。如果未指定此密钥,则使用 全局设置 模块中 AdminClient 配置的分隔符。
CsvSeparator
CSV 文件中作为导出结果输出的列之间的分隔符,如分号、逗号、制表符或空格。要使用制表符作为分隔符,有以下几种选择:
- 字符串 TAB
- 字符串 TAB 引号 + 制表符键 + 引号("⇥")
- 您还可以输入带引号的空格 (" ")
FlatExport
此键只能用于 JSON 导出类型。指定 JSON 文件是否只包含数据而不包含外层元素。
值 | 描述 |
---|---|
Y | JSON 文件不包含任何外层元素。示例:[ { Job1 ... }, { Job2 ... } ] |
N | 输出 JSON 文件中的所有元素。示例: { "作业":[ { Job1 ... }, { Job2 ... } ] } |
[Result] 节
键 | 值 |
---|---|
ErrorText | 此处列出了导出过程中出现的错误。 |
LastExecution | 最后一次执行导出的时间戳 |
Info
带星号(*)标记的属性是必填项,必须进行赋值。