全局接口文件部分

接口文件

如果一个事件发生在有相应的脚本接口， octoplant将创建一个接口文件。这个接口文件是一个初始化文件，它提供了脚本程序以及关于组件、其状态和触发事件的用户的信息。它以INI文件格式提供，并用UTF-16编码。

脚本接口文件的一般部分和键值列在下面。只存在于个别事件的接口文件中的部分和键值，可以在事件的描述中找到。

 

[Common]

INI键 I/O 描述
RootDirAdmin I

来自 octoplant 的管理文件所在目录的完整路径

BeforeUpload和AfterUpload没有给出这个键。
DirPrjData I

项目文件所在目录的完整路径

BeforeUpload和AfterUpload没有给出这个键。
Language I 语言的ID，其中 octoplant 被设置（例如，en或准确地说，en-gb，en-us，de-de，fr-fr等等。）
ComputerName I

执行脚本程序的计算机名称。

格式： [Domain].ComputerName

(对于客户端的结果，给出了客户端名称；对于服务器端的结果，给出了服务器端的名称)
DirTemp I

存储脚本应用程序的临时文件所在的目录的完整路径

每个脚本应用程序都需要独立删除临时数据。所有脚本应用程序的临时文件共享一个目录。由于这个原因，子目录和文件需要正确排序，以确保脚本应用程序只删除自己的临时数据。
PathLog I

存储协议信息所在目录的完整路径

一些脚本应用程序将这些信息提供给整个系统。每个脚本应用程序必须删除自己的数据。
TimeOutInMin I

距离超时的时间（分钟）。

如果超过了这里设置的值，脚本应用程序会不发出通知立即关闭。
Licence I

该键值包含了关于许可证所涵盖的功能信息。
PathExeVdog I

由脚本程序触发的应用程序的完整路径

（比如, C:\Programme\vdog\VDogClient.exe 或者到服务器应用的路径）

SilentMode I

显示脚本程序是否被允许请求用户输入（例如通过消息）。

Y: 不可要求输入

N: 可要求输入。这并不意味着脚本应用程序需要请求输入。

服务器端应用的默认值是Y，客户端应用的默认值是N。

 

[Component]

一些脚本应用程序不支持这一部分。

INI键 I/O 描述
Dir I

组件目录的相对路径

以反斜杠符号开始的路径。路径的结尾没有反斜杠符号。
ID I 组件 ID
ComponentTypeId I 组件类型ID

MasterData1

 I 第一个主数据字段的内容
MasterData2 I 第二个主数据字段的内容
MasterData3 I 第三个主数据字段的内容
MasterData4 I 第四个主数据字段的内容
MasterData5 I 第五个主数据字段的内容
MasterData6 I 第六个主数据字段的内容
MasterData7 I 第七个主数据字段的内容
MasterData8 I 第八个主数据字段的内容
MasterData9 I 第九个主数据字段的内容
MasterData10 I 第十个主数据字段的内容

 

[User]

一些脚本应用程序不支持这一部分。

INI键 I/O 描述
ID I 该键包含32位字符串的用户ID
Name I 用户的名称
FullName I

完整的用户名称

只有当名称包含在 用户管理 模块中时，才会给出键值。
Domain I 用户登录后所有的域。
LocalLogon I

显示用户是在本地还是在服务器上登录的。

Y: 用户在本地登录。

N: 用户在服务器端登录。
Admin I

显示该用户是否属于管理员组

Y: 用户属于octoplant管理员组。

N: 用户不属于管理员组。
Groups I

用户所属的组的ID

ID显示为32位字符串，用逗号分隔。

 

[Version]

一些脚本应用程序不支持这一部分。对于一些脚本应用，这部分被赋予了不同的名称

INI键 I/O 描述
Hversion I 版本号
HversionUserDefined I 用户定义的版本号。
TimestampUTC I 该键值包含版本创建的时间戳（以UTC时间格式）(YYYYMMDDHHMMSS)
TimestampLocal I 该键值包含版本创建的时间戳（以本地时间格式）(YYYYMMDDHHMMSS)
Comment I

该键值包含对该版本的注释

每一个换行（LF, CR, CRLF）都被转换为<br> 。
ChangeReason I

版本的更改原因

每一个换行（LF, CR, CRLF）都被转换为<br> 。
UserId I 创建此版本的用户 ID（32位字符串）。
Username I 创建此版本的用户名称。
UserFullName I

创建此版本的用户的完整名称。

只有当名称包含在 用户管理 模块中时，才会给出键值。
UserDomainName I 用户所在的域。
ComputerName I 创建该版本的计算机名称
DnameStorage I 保存该版本存档所在的子目录的名称。 (格式 YYYYMMDD.{NNN} )
State I

版本/存档的锁定状态

 

[QuickSave]

这个部分只有在恢复了组件的快速保存后才能使用。

INI键 I/O 描述
Enabled I

该键包含该组件是否启用了Quicksave的信息。

Y: Quicksave功能被激活

N: Quicksave功能无效

如果没有提供这个键的值，系统就认为这个值是 N。
Dir I

以反斜杠开头的组件目录的相对路径
路径的末尾没有反斜杠符号。

这个键只有在键 Enabled 的值为 Y 时才会提供。
ID I 组件的ID

这个键只有在键 Enabled 的值为 Y 时才会提供。

 

[ExclusiveUse]

INI键 I/O 描述
UserId I

创建版本的用户 ID（32位字符串）。

如果没有为这个键设置值，或者它被设置为零值，那么这个组件就不会被锁定。
Username I 为其他用户锁定组件的用户的名称
UserFullName I

为其他用户锁定组件的用户全名

只有当名称包含在 用户管理 模块中时，才会给出键值。
DomainName I 用户所在的域。
ComputerName I 组件被锁定的计算机名称。
TimestampUTC I 该键包含组件被设置为该状态的时间戳（UTC时间格式）（YYYYMMDDHHMMSS）。
TimestampLocal I 此键包含组件被设置为该状态的时间戳（以当地时间格式）（YYYMMDDHHMMSS）。

 

[UnderDevelopment]

INI键 I/O 描述
UserId I 这个键包含将组件标记为 开发中 的用户的ID，是32位字符串。
如果没有输入数值，或者输入的值为零，则该组件不会被标记为 开发中。
Username I 这个键包含将组件标记为 开发中 的用户名称
UserFullName I

这个键包含将组件标记为 开发中 的用户的全称

只有当名称包含在 用户管理 模块中时，才会给出键值。
DomainName I 用户所在的域。
ComputerName I 组件被标记为 开发中的电脑的名称
TimestampUTC I 该键包含组件被设置为该状态的时间戳（UTC时间格式）（YYYYMMDDHHMMSS）。
TimestampLocal I 此键包含组件被设置为该状态的时间戳（以当地时间格式）（YYYMMDDHHMMSS）。

 

[ClientInformation]

INI键 I/O 描述
ComputerName I

计算机名称，如有必要，进行签出或签入的计算机的域名。
IPAddress I 进行签出或签入的计算机的IP地址

 

[Result]

INI键 I/O 描述
ErrorText O

这个键显示脚本程序是否以错误的方式终止，以及消息框中是否给出了错误信息。
信息封锁程序，直到它们被确认。由于这个原因，它不应该被用于服务器端的脚本应用。

如果提供的值是 <N>，则不会在此键中写入错误信息。
警告 O 如果脚本应用程序以警告方式终止，这个键将被写入。

 

相关主题

服务器端脚本事件

客户端脚本事件

AdminClient -> 用户管理

UserClient -> Quicksave