隐式变量
隐式变量是您未定义的变量。这些变量由框架自动提供。一些隐式变量仅在与声明的变量关联时才有效,而另一些隐式变量不与任何其他变量关联。
除隐式变量外,Maximo® 业务对象 (MBO) 也可供各个脚本使用。您可以使用 mbo 保留字来引用当前业务对象。
不与其他变量关联的隐式变量将在脚本中进行设置,您可以直接通过名称来引用这些变量。例如,app 或 mbo 不与其他变量相关联。
下表中的变量不与任何其他正在使用的变量相关联:
| 隐式变量 | 类型 | 作用域 | 描述 |
|---|---|---|---|
| action | 字符串 | 操作启动点 | 指示从操作启动点生成的操作的名称。 |
| app | 字符串 | 所有启动点 | 指示正在对其运行脚本的应用程序的名称。app 变量将传递至脚本。 |
| domainid | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。 | 指定用于为属性启动点提供所显示值列表的域。 |
| errorgroup | 字符串 | 所有启动点 | 选择在“数据库配置”应用程序中定义的消息组标识。errorgroup 变量在脚本中设置。与 errorkey 变量和 errorgroup 变量一起使用可标识消息存储库中声明的错误消息。 |
| errorkey | 字符串 | 所有启动点 | 使脚本作者能够从脚本将错误消息设置到业务对象中。脚本代码选择在“数据库配置”应用程序中定义的消息键标识。errorkey 与隐式变量 errorgroup 和 params 一起工作。从消息库中设置错误消息的优点是,将自动检取已翻译的消息。脚本代码设置“数据库配置”应用程序中配置的错误键。errorkey 变量在脚本中设置。 |
| evalresult | 布尔型 | 条件启动点 | 在脚本中设置。工作流条件评估和安全条件脚本返回 true 或 false 值。 |
| interactive | 布尔型 | 所有启动点 | 指示脚本正在活动用户会话还是非用户后台会话(例如集成事务处理)中运行。 |
| launchPoint | 字符串 | 所有启动点 | 指示为其运行脚本的启动点的名称。 |
| listErrorGroup | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。将 listErrorGroup 和 listErrorKey 变量一起指定,并在“数据库配置”应用程序中使用消息工具来选择 MAXMESSAGES 表中存储的消息。 | 确定检索列表事件失败时用户能够看到的消息的组标识。 |
| listErrorKey | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。将 listErrorGroup 和 listErrorKey 变量一起指定,并在“数据库配置”应用程序中使用消息工具来选择 MAXMESSAGES 表中存储的消息。 | 确定检索列表事件失败时用户能够看到的消息的键标识。 |
| listOrder | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。 | 设置为用于对检索列表事件结果排序的任何“排序依据”属性名。 |
| listWhere | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。 | 确定要显示的结果数据集以及要在结果显示前设置的过滤器。将 listWhere 变量设置为使用相关 MBO 的 WHERE 子句。 |
| mbo | psdi.mbo.Mbo | 所有启动点 | 引用正在处理的 MBO。 |
| mboset | psdi.mbo.MboSet | “允许创建”类型的对象启动点 | 引用新 MBO 将添加到的 MboSet。 |
| mboname | 字符串 | 所有启动点 | 指示正在运行的脚本上下文中当前 MBO 的名称。 |
| mbovalue | psdi.security.UseriInfo | 所有属性启动点事件 | 属性启动点的 MBO 属性的实例。 |
| onadd | 布尔型 | 所有启动点。理想情况下,与脚本适用于多种事件类型(例如添加、更新和删除)的对象启动点配合使用。 | 指示正在插入还是创建针对其运行脚本的业务对象。您可以使用 onadd 变量来根据 MBO 状态执行条件操作或验证。 |
| ondelete | 布尔型 | 所有启动点 | 指示是否正在删除对其运行脚本的业务对象。 |
| onupdate | 布尔型 | 所有启动点 | 指示是否正在更新对其运行脚本的业务对象。 |
| params | String[] | 所有启动点 | 用于保存最终解析的参数,这些参数将应用于从脚本发布的错误消息。params 隐式变量是一个数组。在消息库中声明的消息可能具有已定义的参数。消息内容仅在运行时在脚本代码上下文中完全解析。params 变量与 errogroup 变量和 errorkey 变量一起使用,以准备要从脚本代码发布的错误消息。params 变量在脚本中设置。 |
| relationObject | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。通常与 srcKeys 和 targetKeys 隐式变量一起使用。 | 应用于从当前 MBO 搜索到的相关 MBO。 |
| relationWhere | 字符串 | 仅当属性启动点实施检索列表事件时使用此变量。通常与 srcKeys 和 targetKeys 隐式变量一起使用。 | 建立用于执行检索列表事件的条件。设置为查询相关 MBO 的 WHERE 子句。 |
| scriptHome | psdi.mbo.Mbo | 操作启动点 | 引用所处理的 MBO。实现脚本的首选方法是在脚本代码中使用 mbo 关键字。 |
| scriptName | 字符串 | 所有启动点 | 提供正在运行的脚本的名称。 |
| service | com.ibm.tivoli.maximo.script.ScriptService | 所有启动点 | 脚本编制框架在运行时添加到脚本。 |
| srcKeys | String[] | 属性启动点何时实施检索列表事件 | 适用于在另一相关或目标 MBO 中查找相关记录所使用的当前 MBO 中的属性名称集。例如,当前 MBO 中的属性名称集可能用于从 ASSET 业务对象中查找 FAILURECODES 字段。 |
| thisvalue | 属性启动点的 MBO 属性 | 使用此变量作为初始值和属性启动点的初始访问限制 | 表示当前属性。例如,thisvalue="abc" 将当前值设置为 abc。 |
| targetKeys | String[] | 属性启动点何时实施检索列表事件 | 适用于从定义属性启动点的当前 MBO 查找的目标 MBO 中的属性名称集。 |
| user | 字符串 | 所有启动点 | 提供登录用户的用户标识。user 变量将传递至脚本,并且无法在代码中设置。 |
| userinfo | psdi.security.UserInfo | 所有启动点 | 提供当前上下文的对象。 |
| wfinstance | psdi.workflow. WFInstance | 从工作流启动操作时的操作启动点。 | 指示从中启动了当前操作的工作流实例。 |
一些隐式变量仅在与您声明的变量关联时才有效。您可以通过按顺序输入声明的变量、下划线和隐式变量来使用这些隐式变量。例如,如果对脚本指定了名为 siteid 的变量,那么代码行 siteid_readonly=True 将使业务对象的关联 siteid 属性变为只读。这类隐式变量不可供与 MAXVAR、SYSPROP 或 LITERAL 绑定类型绑定的变量使用。
在下表中,var 表示您在“自动化脚本”应用程序中显式定义的变量的名称。与声明的主变量相关联的隐式变量位于下划线后面。
| 隐式变量 | 类型 | 作用域 | 描述 |
|---|---|---|---|
| var_hidden | 布尔型 | 所有启动点 | 对业务对象属性检索或设置隐藏标志。如果主变量为 OUT 或 INOUT 类型,那么脚本可以修改 var_hidden 变量。 |
| var_initial | 与变量所绑定的 MBO 属性的类型相同。 | 所有启动点 | 为从 MBO 检索到的属性提供初始值。var_initial 变量将传递至脚本。脚本无法修改 var_initial 变量。 |
| var_internal | 与变量所绑定的 MBO 属性的类型相同。 | 所有启动点 | 为 SYNONYMDOMAIN 条目提供内部值。如果主变量与 MBO 属性相关联,而此属性与同义词域相关联,那么 var_internal 隐式变量将为该属性提供相应的内部值。var_internal 变量将传递至脚本。脚本无法修改 var_internal 变量。 |
| var_modified | 布尔型 | 所有启动点 | 提供一个标志,指示某个属性的值是否已被修改。var_modified 变量将传递至脚本。脚本将无法修改 var_modified 变量。 |
| var_previous | 与变量所绑定的 MBO 属性的类型相同。 | 属性启动点(但仅限于生成了事件的属性)。 | 为从 MBO 检索到的属性提供先前值。var_previous 变量将传递至脚本。脚本无法修改 var_previous 变量。 |
| var_readonly | 布尔型 | 所有启动点 | 对业务对象属性检索或设置只读标志。如果主变量为 OUT 或 INOUT 类型,那么脚本可以修改 var_readonly。 |
| var_required | 布尔型 | 所有启动点 | 对业务对象属性检索或设置必需标志。如果主变量为 OUT 或 INOUT 类型,那么脚本可以修改 var_required。 |