参数文件

参数文件包括一个 INI 文件,您可以用它来修改导出的设置。此选项允许您指定要导出的数据和要导出的文件。

要创建参数文件,需使用一个文本编辑器。自己选择参数文件的名称和文件扩展名。例如:Parameter.config.ini

下表列出了用于导出的键及其功能说明。只适用于特定导出的键可以在每个导出的描述中找到。

[User] 部分

Account 启动导出的 octoplant 用户
Domain

用户所在的域。

只有当用户属于某个域,且在启动 ExportModule 时该域没有被指定时,才需要输入此键。

Password

用户的密码

只有在参数文件中也提到执行用户时,才会考虑到这个键。

PasswordMode

指定密码的解读方式。以下是可能的值:

  • 0:密码将被解读为未加密(默认值)。
  • 2:密码必须通过命令行输入。
Token

用户访问令牌

访问令牌可以在AdminClient中生成,并且是运行ExportModule所必需的。

如果已指定令牌,则无需输入其他凭证。

[Common]节

ReportType*

您要创建的报告类型。以下是可能的值:

  • ComponentTree
  • 导出项目树

  • JobList
  • 导出作业的摘要

  • JobResults
  • 导出所有作业的作业结果摘要

  • UnequalJobresults
  • 只导出发现差异或发生错误作业的作业结果

  • UserManagement
  • 导出用户和用户组

  • ComponentTypes

  • 导出组件类型及其配置(名称、ID 等)

  • Componentlog

  • 导出组件日志的内容

  • Eventlog

    导出事件日志的内容

  • Adminlog
    导出 AdminClient 模块的更改列表
  • StandardLibraryManagement

  • 导出使用了哪些块的摘要

  • ComponentsWithStdLibAssignments

  • 导出与标准库相连的组件的摘要。

  • AssetState

    导出车间状态作业的概述

  • UsageInformation

  • 创建用户信息文件。

只有一个属性是可能的。

ExportType

指定将创建导出的格式。

不是每个导出都能以每种格式创建。您有以下可能选项:

  • ComponentTree:XML 或 JSON
  • JobList:CSV 或 JSON
  • 作业结果只能以 CSV 文件的形式提供。
  • UnequalJobResults:CSV 或 JSON
  • UserManagement:XML 或 JSON
  • ComponenTypes:XML 或 JSON
  • Componentlog:CSV 或 JSON
  • Eventlog:CSV 或 JSON 
  • Adminlog:CSV 或 JSON
  • StandardLibraryManagement 仅以 CSV 文件形式提供。
  • ComponentsWithStdLibAssignments:CSV 或 JSON
  • 资产状态只能以 CSV 文件的形式提供。

如果在参数文件中没有指定 ExportType,带下划线的格式将作为默认值使用。

ExportFile* 您想保存导出结果的文件的绝对路径(包括文件名)。如果该文件已经存在,则会被覆盖。
CsvSeparator

CSV 将使用分隔符(即分号、逗号、Tab 键或空格)创建。

如果您想使用 Tab 作为分隔符,可使用以下选项:

  • 字符串 TAB

  • 引号 + Tab 键 + 引号 ("⇥")。

您也可以输入一个带引号的空格。(" ")

如果未指定此键,则使用全局设置模块(位于AdminClient)中配置的分隔符。

FlatExport

此关键字只适用于导出格式为JSON的情况下使用。

表示JSON文件是否只包含没有封闭元素的数据。

可能有以下值:

  • Y:JSON文件不包含任何封闭元素。
    示例:

  • [
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]

  • N:显示JSON文件中的所有元素。
  • {
    "Jobs":[
    {
    Job1 ...
    },
    {
    Job2 ...
    }
    ]
    }

[Result]部分

ErrorText 这里列出了导出过程中发生的错误。
LastExecution 最后一次执行导出的时间戳

标有 *(星号)的键是强制性属性。这些都需要分配。

 

相关主题:

AdminClient -> INI文件

AdminClient -> 全局设置模块