跳转至

界面文件的通用部分

界面文件

当有相应脚本界面的事件发生时,就会生成一个界面文件。该文件作为初始化资源,为脚本应用程序提供有关组件、组件状态和触发事件用户的详细信息。界面文件遵循 INI 格式,并以 UTF-16 编码。

界面文件的结构

界面文件由多个部分和按键组成,其中一些部分和按键在所有事件中通用,而其他部分和按键则针对个别事件。
下面提供了通用部分和键值的完整列表,您可以在各自的描述中找到事件的具体细节。

[Common]

I/O 描述
RootDirAdmin I 包含 octoplant 管理文件的目录的完整路径。BeforeUpload 和 AfterUpload 事件未指定此键。
DirPrjData I 包含项目文件的目录的完整路径。BeforeUpload 和 AfterUpload 事件不指定此键。
语言 I 在 octoplant 中设置的语言的 ID(例如 en 或 en-gb、en-us、de-de、fr-fr 等)。(例如 en 或更精确的 en-gb、en-us、de-de、fr-fr 等)。
ComputerName I 执行脚本应用程序的计算机名称 格式:[对于客户端事件,指定客户端名称;对于服务器端事件,指定服务器名称。
DirTemp I 脚本应用程序存储临时数据的目录的完整路径。每个脚本程序必须独立删除临时数据。所有脚本程序共享一个临时数据目录。因此,必须能够明确分配子目录和文件,以确保脚本程序只删除自己的临时数据。
路径日志 I 存储记录信息的目录的完整路径。某些脚本应用程序会向整个系统提供这些信息。每个脚本应用程序都必须独立删除这些数据。
TimeOutInMin I 超时时间(分钟)。如果超过此处设置的值,脚本程序将立即关闭,且不会发出通知。
许可证 I 许可证中包含的功能信息
PathExeVdog I 调用脚本应用程序的完整路径(例如,C:\Program Files\vdog\VDogClient.exe 或服务器应用程序的路径)
SilentMode I 表示脚本程序是否可以请求用户输入信息(例如通过消息)。
Y:不允许请求输入。
N:可以请求输入。
这并不意味着脚本应用程序实际上会请求输入。服务器端的默认值是 Y,客户端脚本应用的默认值是 N。

[Component]

某些脚本应用程序不支持此部分。

I/O 描述
Dir I 组件目录的相对路径。路径以反斜线开头。路径末尾没有反斜线。
ID I 组件 ID
组件类型标识 I 组件类型标识
MasterData1 I 第一个主数据字段的内容
主数据2 I 第二个主数据字段的内容
主数据3 I 第三个主数据字段的内容
主数据4 I 第四个主数据字段的内容
主数据5 I 第五个主数据字段的内容
主数据6 I 第六个主数据字段的内容
主数据7 I 第七个主数据字段的内容
主数据8 I 第八个主数据字段的内容
主数据9 I 第九个主数据字段的内容
主数据10 I 第十个主数据字段的内容

[User]

某些脚本应用程序不支持此部分。

I/O 描述
ID I 用户名 32 个字符的字符串
名称 I 用户名
全名 I 用户全名。只有在 用户管理 模块中定义了用户名时,才会指定键值。模块中定义的名称。
I 用户登录的域。
电子邮件地址 I 存储在用户信息中的电子邮件地址(如果未设置电子邮件地址,则为空)。
本地登录 I 显示用户是在本地登录还是在服务器上登录。 Y: 用户已在本地登录。
N: 用户在服务器上登录。
管理员 I 显示用户是否属于管理员组。 Y: 用户属于管理员组。
N: 该用户不属于管理员组。
I 用户所属的组的ID 32 个字符的字符串,用逗号分隔

[Version]

某些脚本应用程序不支持此部分。在某些脚本应用程序中,该部分的名称有所不同。

Info

只有在可以识别用户并成功检索到其信息的情况下,本部分才会包含与用户相关的详细信息。如果无法做到这一点,以下键值将保持为空:

  • 用户名
  • 用户全名
  • 用户域名
  • 用户电子邮件地址
I/O 描述
Hversion I 版本号
HversionUserDefined I 用户定义的版本号
时间戳 I UTC-时间格式的版本时间(YYYYMMDDHHHMMSS)
时间戳本地 I 以当地时间格式表示的版本更新时间(YYYYMMDDHHHMMSS)
注释 I 对该版本的评论。换行符(LF、CR、CRLF)转换为<br>
ChangeReason I 此版本更改的原因 换行符(LF、CR、CRLF)转换为<br>
UserId I 创建版本的用户 ID,由 32 个字符组成的字符串。
用户名 I 创建版本的用户名。
用户全名 I 创建版本的用户全名。只有在 用户管理 模块中设置了名称时,才会指定键值。
用户域名 I 用户登录的域。
用户电子邮件地址 I 存储在用户信息中的电子邮件地址(如果未设置电子邮件地址,则为空)。
ComputerName I 创建该版本的计算机的名称
DnameStorage I 存储版本存档的子目录名称,格式为 YYYYMMDD.{NNN}
状态 I 版本/存档的锁定状态

[QuickSave]

只有在恢复组件的 Quicksave 后,本部分才可用。

I/O 描述
已启用 I 表示该组件是否启用快速存档。 Y:已启用快速存档。
N: 禁用快速存档。
如果未指定此密钥的值,系统将假定 N 为值。
Dir I 组件目录的相对路径,以反斜线开头。路径末尾没有反斜杠。只有当启用的键值为 Y 时,才会指定该键。
ID I 组件的 ID。只有启用关键字的值为 Y 时,才会指定该关键字。

[ExclusiveUse]

I/O 描述
用户名 I 为其他用户锁定组件的用户的 ID(32 个字符的字符串)。如果没有指定值或指定的值为零,则不锁定组件。
用户名 I 为其他用户锁定组件的用户名。
用户全名 I 为其他用户锁定组件的用户全名。只有在 用户管理 模块中定义了该名称时,才会指定键值。
域名 I 用户登录的域。
电子邮件地址 I 存储在用户信息中的电子邮件地址(如果未设置电子邮件地址,则为空)。
ComputerName I 为其他用户锁定组件的计算机名称
时间戳 I 组件设置为该状态的时间,UTC 时间格式(YYYYMMDDHHMMSS)。
时间戳本地 I 组件设置为该状态的时间,当地时间格式(YYYYMMDDHHMMSS)

[UnderDevelopment]

I/O 描述
UserId I 将组件标记为 "在开发中"的用户的 ID,用 32 个字符的字符串表示。
如果未输入值或输入的值为零,则组件不会被标记为开发中
用户名 I 将组件标记为开发中的用户名
用户全名 I 将组件标记为 开发中 的用户全名。只有在用户管理中定义了名称时,才会指定键值。
域名 I 用户登录的域。
电子邮件地址 I 存储在用户信息中的电子邮件地址(如果未设置电子邮件地址,则为空)。
ComputerName I 将组件标记为 开发中 的计算机名称
时间戳 I 组件设置为该状态的时间,UTC 时间格式(YYYYMMDDHHMMSS)。
时间戳本地 I 组件设置为该状态的时间,当地时间格式(YYYYMMDDHHMMSS)

[客户信息]

I/O 描述
ComputerName I 计算机名称,以及(如适用)借出或借入计算机的相关域。
IP 地址 I 借出或借入计算机的 IP 地址。

[Result]

I/O 描述
错误文本 o 表示脚本应用程序是否因错误而终止,并发出错误消息。错误消息会阻塞程序,直到它们被确认。因此,服务器端脚本应用程序不应使用它们。如果指定值<na> ,则不会写入错误消息。
警告 o 显示脚本应用程序是否被警告终止。

相关主题