流程和服务流中的 JavaScript API

斜体中的参数是可选的。

名称空间摘要

名称空间目录
tw.object 对象名称空间用于初始化复杂的 IBM Business Automation Workflow 对象。
tw.local 包含所有私有、输入和输出变量的本地名称空间。
tw.system 包含流程和步骤常量的系统名称空间。
tw.epv 包含与流程相连的 EPV 的 EPV 名称空间。
tw.env 包含所有环境变量的环境名称空间。
<!#-- Comparison of top-level namespaces -->

名称空间比较

您可以在 JavaScript API 名称空间中找到 BPD 名称空间与服务名称空间之间的比较。

服务名称空间

名称空间目录
OrgNamespace “tw.system.org”对象包含访问用户组织的有用方法。
TWHelpRequest 帮助请求的实例。
TWInstallNamespace "tw.system.install" 对象包含有关安装历史记录的有用变量和方法。
TWInstallStatuses名称空间 "tw.system.install.Statuses" 对象包含可能状态的常量值。
TWPerfNamespace “tw.perf”对象包含性能服务器的运行时数据。 不推荐使用。
TWServiceClass TWObject，是系统内所有变量的包装程序。
TWServiceSystem名称空间 用于使用“tw.system”从服务上下文访问和操纵系统数据的名称空间。 它包含关于系统和特定服务实例的有用变量和常量。

BPD 名称空间

名称空间目录
TWBPDPerfNamespace 流程上下文中使用的“tw.perf”对象包含性能服务器的运行时数据。
TWBPDSystemBPDNamespace 流程上下文中使用的“tw.system.bpd”对象包含关于系统和此特殊流程的有用变量和常量。
TWBPDSystemNamespace 用于使用“tw.system”从流程上下文访问和操纵系统数据的名称空间。 它包含关于系统和特定流程实例的有用变量和常量。
TWBPDSystemOrg名称空间 流程上下文中使用的“tw.system.org”对象包含访问用户组织的有用方法。
TWEnvironmentNamespace 用于访问和操纵环境变量的名称空间。
TWHelpRequest 帮助请求的实例。
TWInstallNamespace "tw.system.install" 对象包含有关安装历史记录的有用变量和方法。
TWInstallStatuses名称空间 "tw.system.install.Statuses" 对象包含可能状态的常量值。
TWObjectNamespace 对象名称空间用于初始化 IBM Business Automation Workflow 中的复杂对象。

对象摘要

对象目录
ActivityDetails “活动详细信息服务”返回的对象。
ActivityInstance 该对象提供要用于活动实例的属性和方法。
ActivityListData “活动列表服务”返回的对象。
ActivityListFilter 该对象用作“活动列表服务”输入的一部分以限制所返回活动的列表。
ActivityListItem 用于表示“活动列表服务”所返回 ActivityListData 对象中的活动列表项的对象。
ActivityListProperties 该对象将用作“活动列表服务”的输入。 使用该对象指定排序或过滤条件，并支持其他返回信息。
ActivitySummary 这些对象的列表由“活动摘要服务”返回。
AlignTypes 用于提供对齐选择选项的业务对象。
任何 在 IBM Business Automation Workflow 中，此类表示任意内容。 使用此类可指示任意类型的变量
BOOLEAN 布尔值类型
BPMAlertDefinition 定义警报出现状况的条件。
BPMAlertDefinitionStatus 评估警报定义时返回的警报定义状态。
BPMAlertDefinitionStatusResponse 返回对多个警报定义执行“获取状态”操作的结果。
BPMBOPropertyChange 包含已更新的共享业务对象的旧值和新值
BPMBOSaveFailedError 包含由保存服务对执行上下文中所有共享业务对象引发的验证错误的列表
BPMBOSaveServiceValidationErrors 包含由保存服务对共享业务对象引发的验证错误的列表
BPMBOValidationError 表示由保存服务对共享业务对象引发的验证错误
BPMDocumentDisplayOptions 针对 IBM Business Automation Workflow 文档库中的文档指定搜索和显示选项。
BPMDocumentMatchRule 指定在 IBM Business Automation Workflow 文档库中搜索文档时的匹配规则。
BPMDocumentOptions 指定用于处理 IBM Business Automation Workflow 文档库中的文档的选项。
BPMDocumentUploadOptions 指定在 IBM Business Automation Workflow 文档库中创建文档时的上载选项。
BPMExposedItem 公开项的描述。
BPMFailedOperation 描述批量请求期间的失败操作。
BPMRelationship 描述不适用
BPMRelationshipDetails 描述两个实例之间的关系。 此业务对象是由创建关系的 JavaScript API 返回的，并且是从对现有关系的查询返回的。
BPMRESTRequest 表示 REST 请求。 要创建该对象的新实例，请使用“new BPMRESTRequest()”
BPMRESTResponse 表示 REST 响应。
CaptionHorizontalPositionSelection 描述不适用
CaptionVerticalPositionSelection 描述不适用
CaseReference 此对象表示目标对象库中的案例实例。
ChartClickEvent ChartClickEvent 包含有关所单击的图表段的信息，包括曾经所属的序列和所单击段的名称和值。
ChartData ChartData 直接绑定到图表控件，包含一个或多个 ChartDataPlot 对象。 各个 ChartDataPlot 对象会显示在图表中（重叠）。 例如，图表可以同时显示折线图和柱图。 每个图表都包含一个或多个图，每个图包含一个或多个序列，而每个序列由一个或多个数据点组成。
ChartDataPlot ChartDataPlot 是一个或多个代表图数据的 ChartDataSeries 对象。 同一图中的序列看起来相似。 例如，图中显示为列的两个序列将分别显示为列集合。
ChartDataPoint ChartDataPoint 是单个数据点，如 (Apples, 5) 或 (2013, 637)。 每个数据点会根据图类型显示在图中。 例如，饼图数据点显示为扇区，柱图数据点显示为柱形，折线图数据点显示为折线上的单个点，等等。
ChartDataSeries ChartDataSeries 代表数据点序列。 在列图表中，相同序列的数据点以同一种颜色显示为一列。 在折线图中，每个数据序列通过一种颜色的线表示，行中的每个点表示序列中的一个数据点。 序列标签显示在图表图注中。 因为饼图一次只能显示一个序列，因此数据点名称会改为显示在图注中。
ChartDisplayOptions ChartDisplayOptions 是可以绑定到“显示”选项配置设置的 ChartPlotDisplayOptions 序列（ChartData 中的每个 ChartDataPlot 都有一个）。
ChartLegendPositionSelection ChartLegendPositionSelection 决定是否显示图注以及它在图表中的位置。 缺省设置为“无”（图注隐藏），位置设置包括左侧、右侧和底部。
ChartPieLabelSelection ChartPieLabelSelection 决定饼图标签如何显示。 设置包括“无”、“数字”和“百分比”。
ChartPlotDisplayOptions ChartPlotDisplayOptions 有可以指示图显示方式的属性。 ChartData 对象中的每个 ChartPlotData 对象都需要对应的 ChartPlotDisplayOptions 对象。 plotType 属性非常重要，因为它可以决定图类型，如饼图或柱图。 有一些属性可以决定图轴名外观和位置。 例如，垂直轴可以显示为在右侧滑动，或者水平轴可以显示为在顶部滑动。
ChartPlotType ChartPlotType 包括以下类型的图：饼图、条形图、柱图、折线图和面积图。
ChartThemeSelection ChartThemeSelection 设置为“缺省值”、“存在风险”和“过期”以及“定制”。 如果设置为“定制”，请使用“定制主题”配置选项定义您自己的主题。
CMISDocumentOptions 指定用于处理“内容管理互操作性服务”文档的选项。
CoachValidation 此对象包含 Coach 验证错误。
CoachValidationError 该对象表示 CoachValidationError 信息。
ConditionalActivity 该对象表示 BPD 中的条件活动。
CurrencyCodeSelectionType 描述不适用
日期 日期类型
DateRangeString 该对象在 TaskListProperties 对象中使用，用于指定应返回哪个日期范围的任务。
decimal 十进制类型
DocumentSelection 指定在 IBM Business Automation Workflow 文档库中创建文档时的上载选项。
ECMAllowableActions 该对象允许的操作的列表。
ECMContentEvent ECMContentEvent 对象代表从 ECM 系统中收到的文件夹/文档事件。
ECMContentStream ECMContentStream 对象包含 ECM 文档的内容。
ECMDocument ECMDocument 对象代表 ECM 系统中的文档。
ECMDocumentInfo ECMDocumentInfo 对象包含关于 ECM 文档的信息。
ECMError ECMError 对象包含关于 ECM 操作的异常结果的信息。
ECMEventClass ECMEventClass 对象代表从 ECM 系统中收到的事件的类别（文档或文件夹）。
ECMEventType ECMEventType 对象代表从 ECM 系统中收到的事件的类型。
ECMFolder ECMFolder 对象代表 ECM 系统中的文件夹。
ECMFolderInfo ECMFolderInfo 对象包含关于 ECM 文件夹的信息。
ECMID ECMID 对象表示 ECM 系统中对象的唯一标识。
ECMMultiValue ECMMultiValue 对象包含 cardinality=multi 的 ECM 属性的值。
ECMObjectTypeDefinition ECMObjectTypeDefinition 对象包含 ECM 文件夹和 ECM 文档的类型元数据。
ECMProperty ECMProperty 对象代表 ECM 文件夹或 ECM 文档的属性。
ECMPropertyMetadata ECMPropertyMetadata 对象在 ECM 搜索结果集内包含属性的类型元数据。
ECMPropertyTypeDefinition ECMPropertyTypeDefinition 对象包含 Enterprise Content Management (ECM) 文件夹或 ECM 文档的属性的类型元数据。
ECMSearchResult ECMSearchResult 对象包含 ECM 搜索操作的响应。
ECMSearchResultRow ECMSearchResultRow 对象代表 ECM 搜索结果集内的一行。
ECMSearchResultSet ECMSearchResultSet 对象表示 ECM 搜索结果集。
ECMServer 包含有关定义 ECM 服务器的信息。
ECMServerNames 在内容集成步骤中使用的服务器名称。
IndexedMap 此类型包含键值对列表。 可通过以下方式获取“theKey”键的值：- 按名称：myVariable = myIndexedMap.theKey；- 按索引：myVariable = myIndexMap.data[0]；，其中 0 是键的索引；
InstanceListData “实例列表服务”返回的对象。
InstanceListItem 用于表示“实例列表服务”所返回 InstanceListData 对象中嵌套的单个实例列表项的对象。
InstanceListProperties 该对象用作“实例列表服务”的输入以过滤或限制所返回实例的列表。
InstanceTasksData “实例任务列表服务”返回的对象。
InstanceTasksFilter 该对象用作“实例任务服务”输入的一部分以限制所返回的任务列表。
InstanceTasksProperties 该对象用作“实例任务列表服务”的输入以过滤或限制所返回任务的列表。
整数 整数类型
IntegrationComponent 此类通过 JavaScript 提供 IntegrationComponents 的访问权。
LayoutTypes 提供布局的选择选项的业务对象。
map 在 IBM Business Automation Workflow 中，此类表示“映射”类型。 使用此类可指示某个变量的类型为“映射”。 可分配给映射的唯一对象是原语和业务对象。
PathStep 此对象保存遍历路径的相关信息。
阶段 该对象表示为流程定义的阶段或里程碑。
ProcessHistoricalStatistics “流程历史统计信息服务”返回的对象。
ProcessHistoricalStatisticsProperties 对象用作“流程历史统计信息服务”的输入。 对象属性确定返回的结果集。
ProcessInstanceListItem 这些对象的列表由“流程实例列表服务”返回。
ProcessInstanceListProperties 该对象用作“流程实例列表服务”的输入以过滤或限制所返回流程实例的列表。
ProcessSummary “流程摘要服务”返回的对象。
ProjectedPathLinkChange 该对象表示将影响规划路径预览的链路更改。
ProjectedPath步骤 此对象保存规划路径的相关信息。
ProjectedPathStepChange 该对象表示将影响规划路径预览的步骤更改。
ProjectedPathTaskChange 该对象表示将影响规划路径预览的任务更改。
RadioButtonsOrientation 提供布局的选择选项的业务对象。
记录 在 IBM Business Automation Workflow 中，此类表示“记录”类型。 使用此类可指示某个变量是结构化类型，并且您不希望指定所有属性或者属性数在运行时确定。 无需预先声明将使用所有属性。 每个属性的类型将为 ANY
SearchScopeSelection 该对象由“搜索”Coach 视图使用，可用于选择搜索范围以将缺省自动补全服务返回的数据标签限制为“团队”或“业务流程”。
序列化器 提供 IBM Business Automation Workflow 变量的序列化/反序列化方法。
显示为选择 描述不适用
显示日历选择 描述不适用
SLAViolationRecord SLAViolationRecord 传递给正用作名为“violationRecord”的参数中 SLA 结果的任何 BPD。
SOAPHeader 该对象表示可显示在 Web Service 请求或响应中的单个 SOAP 头元素。
SOAPHeaders 该类型表示可显示在 Web Service 请求或响应中的 SOAPHeaders。
SQLDatabaseType 此信息来自与连接关联的 JDBC DatabaseMetaData。 提供了属性 isDb2、isOracle 和 isSqlServer，可使检测底层数据库实施更加容易。 可以使用 productName 属性来确定其他数据库类型。
SQLParameter SQLParameter 与 SQLStatement 结合使用，以描述用于参数化的 SQL 语句的参数值、类型和方式信息。
SQLResult SQL 结果可表示结果集、更新计数或存储过程中的输出值。 结果的类型由“type”属性指明。 RESULT_SET“columns”、“columnIndexes”和“rows”属性由结果集中的数据进行填充。 UPDATE_COUNT“updateCount”属性设置为更新计数。 OUT_VALUES“outValues”属性设置为存储过程中输出值的列表。
SQLResultSetColumn 此类型的属性是从结果集内每个列的 JDBC ResultSetMetaData 复制的。
SQLResultSetRow 行包含值的列表，每列一个值。 这些值可以是任意 IBM Business Automation Workflow 简单类型。
SQLStatement SQLStatement 包含要执行的 SQL 及其关联的参数（如果适用），并且与 IBMBPM.SQLConnector API 结合使用。
步骤 步骤是 BPD 图中的流对象。
流 该对象保存一个或多个流条目。
StreamActivity 该对象保存流条目的所有属性。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms。
StreamMediaLink 该对象保存简单的媒体属性，如图像或图标。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms
StreamObject 该对象保存通用的模型属性。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms
StreamObjectCollection 该对象保存一系列流对象。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms
字符串 字符串类型
TableEditMode 用于为表提供编辑方式选项的业务对象。
表选择类型 用于为表提供选择选项的业务对象。
TaskAllTimeStatistics 此类型的任务的所有时间统计信息。
TaskDueData “任务到期服务”返回的对象。
TaskDueProperties 该对象用作“任务到期服务”的输入以过滤或限制所返回任务到期片的列表。
TaskDueSummary 特定时间片内处于风险状态的任务数。
TaskHistoricalGanttStatistics 此类型流程的任务历史甘特图统计信息。
TaskListData “任务列表服务”返回的对象。
TaskListItem 用于表示“任务列表服务”所返回 TaskListData 对象中的任务列表项的对象。
TaskListProperties 该对象用作“任务列表服务”的输入以过滤或限制所返回任务的列表。
团队 该对象表示一个团队。
TeamDashboard支持 仪表板 Coach 视图支持。
TeamMemberTaskSummary “团队成员摘要服务”返回的对象。
TeamRosterEntry 这些对象的列表由“团队登记簿服务”返回。
TeamTaskSummary 团队的活动任务的摘要数据。
TextAreaType 用于为文本区域提供选择选项的业务对象。
时间 时间类型
TimingIntervalHistoricalStatistics 此类型流程的计时时间间隔的历史统计信息。
TWAdhocStarting点 表示特别起始点。
TWAssetTypes 引用链接资产类型。
TWChart 报告的图表对象。 可将布局名称用作构造函数来在流程中创建图表。 已在可用的上下文中正常公开为图表变量。 不推荐使用。 请改用基于 Coach 的仪表板。
TWDate 表示日期。 要创建此对象的新实例，请使用 "new TWDate ()"。 IBM Business Automation Workflow 日期类型表示日期和时间。 例如，2017-06-15 23:00:00:0。 如果 IBM Business Automation Workflow 服务器和用户位于不同的时区，请确保根据用户时区来调整日期。 考虑以下示例：日期时间选取器 Coach 视图的缺省时间为午夜 12:00。 当用户位于东部标准时间 (EST) 时区并且服务器位于中部标准时间 (CST) 时区时，将以 CST 返回日期。 因此，如果用户选择 6 月 16 日，返回的日期将为“6 月 15 日中午 11:00”。 要以用户时区返回日期，您必须从用户的系统（而不是从 IBM Business Automation Workflow 服务器）中选取时区。 您可以使用以下格式来实现：tw.local.date.format("2017-06-15",tw.system.user_timeZone)
TWDocument 表示文档。
TWDocumentSearch类型 可能的文档搜索类型的常量值。
TWDocumentTypes 文档类型的常量值。
TWEvent 表示事件。 要创建此对象的新实例，请使用“new TWEvent()”。
TWHolidaySchedule 包含假期安排的 IBM Business Automation Workflow 变量类型。
TWLink 文档部分中的引用链接。
TWLinkTypes 引用链接类型。
TWLogger 允许将错误、警告和调试结果记录到日志文件中的帮助程序类。 在 IBM Business Automation Workflow 的所有 JavaScript 字段中，此类用作“log”变量。
TWManagedFile 表示流程应用程序/Toolkit 特殊 Snapshot 的受管理文件。
TWManagedFile类型 包含受管文件类型的常量。
TWModelNamespace “tw.system.model”对象包含用于获取模型对象的有用函数。
TWObject TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].
TWObjectContent对象 TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].
TWObjectContentObjectActivity TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].
TWObjectContentObjectCase TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].
TWObjectProperty TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].
TWParticipantGroup 包含访问团队的有用方法。
TWProcess 表示 BPD。
TWProcessApp 流程应用程序/Toolkit 对象。
TWProcessApp缺省值 包含此版本流程应用程序/Toolkit 的缺省值。
TWProcessApp快照 流程应用程序 Snapshot 对象。
TWProcessInstance 表示流程实例。
TWProcessInstanceParentCase 表示与流程实例关联的父案例。
TWProcessInstance状态 表示 TWProcessInstance 状态的常量。
TWProcessPerformance度量 要访问“流程性能指标”对象方法，用户必须具有在“公开”性能指标中定义的访问权。
TWProcessStep信息 提供有关 BPD 中当前流程步骤的信息。
TWRelationshipTypes 引用链接的链接类型。
TWReport 从此对象，您可以访问报告定义的各方面。 不推荐使用。 请改用基于 Coach 的仪表板。
TWReportFilter 仅报告过滤器布局中存在此对象。 它用于提供报告过滤器的运行时和作者集值的访问权。
TWRole 包含访问角色的有用方法。 角色在 JavaScript API 中用作组的同义词。
TWSavedSearch 表示已保存的搜索对象。
TWScoreboard 表示计分板对象。 不推荐使用。 请改用基于 Coach 的仪表板。
TWSearch 包含搜索的属性和方法。
TWSearchColumn 包含搜索列的属性。
TWSearchColumnMetaData 根据列返回和查询的搜索列信息。
TWSearchColumnMetaDataValueTypes 搜索列元数据的值类型。
TWSearchColumnProcessColumns 包含流程的可搜索列名称的常量。
TWSearchColumnProcessInstance列 包含流程实例的可搜索列名称的常量。
TWSearchColumnTaskColumns 包含任务的可搜索列名称的常量。
TWSearchColumn类型 包含搜索列类型操作的常量。
TWSearchCondition 包含搜索条件的属性。
TWSearchCondition操作 包含搜索条件操作的常量。
TWSearchMeta数据 用于描述可用于执行搜索的数据。
TWSearchOptions 将针对 TWSearch 行为的多个参数合并为一个对象。
TWSearchOrdering 包含搜索排序的属性。
TWSearchOrderingorders 包含搜索顺序操作的常量。
TWSearchOrganizeByTypes 包含按类型组织的任务的常量。
TWSearchResult行 搜索结果行对象。
TWSearchResults 搜索结果对象。
TWService 表示可执行的服务。
TWServiceTypes 表示服务类型的常量。
TWTask 包含访问任务的有用方法。
TWTaskPriorities 包含优先级类型的常量。
TWTaskStatuses 包含可能状态的常量值。
TWTeam 包含团队的有用方法。
TWTimePeriod 用于描述时间段（例如，周一到周五早上 7 点到晚上 7 点）的 IBM Business Automation Workflow 变量类型。 请注意，开始时间和结束时间的值不能相同。 否则，将忽略该时间段，因为其持续时间实际上为 0。
TWTimerInstance 计时器等待的实例。
TWTimeSchedule 用于描述时间安排（例如 24x7）的 IBM Business Automation Workflow 变量类型，该时间安排涵盖要用于 SLA 的时间段
TWUser 包含访问用户的有用方法。
TWUserLocale首选项 保留有关用户语言环境首选项的信息。
TWWorkSchedule 包含时间安排、时区和假期安排的瞬态 IBM Business Automation Workflow 变量类型
url URL 类型
UserDashboard支持 仪表板 Coach 视图支持。
UserInfo 用户信息。
XMLDocument 在 IBM Business Automation Workflow 中，此类表示 XML 文档。 使用此类可指示某个变量是 XML 文档
XMLElement 在 IBM Business Automation Workflow 中，此类表示 XML 元素。 使用此类可指示某个变量是 XML 元素
XMLNodeList 在 IBM Business Automation Workflow 中，此类表示 XML 节点列表。 使用此类可指示某个变量是 XML 节点列表

ActivityDetails

“活动详细信息服务”返回的对象。

Type属性目录
String[] actions 包含 checkActions 过滤器中指定的操作（如果适用于当前用户的活动实例）。 如果 checkActions 过滤器不包含任何操作，那么将不会检查活动列表项的操作，并且不会设置该属性。 有效值包括：ACTION_START、ACTION_VIEW。
String activityType 活动实例的活动类型。 有效值包括：USER_TASK、SERVICE_TASK、CALLED_PROCESS 和 SUB_PROCESS。
Date dueDate 活动实例的到期日期。 可选字段。 仅适用于活动类型为 USER_TASK 的活动实例。
Date endDate 活动实例的结束日期。
String executionState 活动实例的执行状态。 有效值包括：READY、WORKING、COMPLETED、WAITING、FAILED、NOT_USED 和 SKIPPED。
String executionType 活动实例的执行类型。 有效值包括：AUTOMATIC 和 MANUAL。
Boolean hidden 指示活动实例是否已隐藏。
String id 活动实例的标识。
Boolean isPreconditionMatchAll 指示需要满足前置条件表达式的整个列表还是只需满足其中一个前置条件表达式。 可选字段。 仅适用于带有前置条件的活动实例。
String name 活动实例的名称。
String narrative 活动实例的叙述。
String optionType 建模期间指定的活动实例的选项类型。 有效值包括：REQUIRED 和 OPTIONAL。
String[] preconditionExpressions 为使活动继续需要满足的表达式。 可选字段。 仅适用于带有前置条件的活动实例。
String[] preconditionExpressionsDisplay 为使活动能够继续而必须满足的表达式。 这些表达式已进行格式化，以供显示在用户界面中。 可选字段。 仅适用于带有前置条件的活动实例。
String[] preconditionTrigger 为使活动继续需要满足的触发器。 可选字段。 仅适用于带有前置条件的活动实例。
String preconditionType 活动必须满足的前置条件类型。 有效值包括：NO_PRECONDITION、ANY_DOCUMENT_TYPE、SPECIFIC_DOCUMENT_TYPES、SPECIFIC_VARIABLES 和 EXPRESSIONS_ONLY。
Boolean repeatable 指示活动实例是否可重复。
Boolean required 指示流程执行是否需要活动实例。
Date startDate 活动实例的开始日期。
String taskId 活动实例的任务实施的任务标识。 可选字段。 仅适用于活动类型为 USER_TASK 的活动实例。
String taskOwnerGroupId 分配到活动实例的任务实施的组标识。 可选字段。 仅适用于活动类型为 USER_TASK 的活动实例。
String taskOwnerUserId 分配到活动实例的任务实施的用户标识。 可选字段。 仅适用于活动类型为 USER_TASK 的活动实例。

ActivityInstance

该对象提供要用于活动实例的属性和方法。

Type属性目录
String activityType 活动实例的类型。 有效值包括 USER_TASK、SERVICE_TASK、CALLED_PROCESS、SUB_PROCESS。
String enablingDocumentID 启用活动实例的文档的标识（如果有）。
String enablingDocumentServerName 包含已启用活动实例的文档的服务器（如果有）的名称。
TWDate endDate 活动实例的选项类型。 有效值包括：REQUIRED 和 OPTIONAL。
String executionState 活动实例的状态。 有效值包括：READY、WORKING、COMPLETED、WAITING、DISABLED、FAILED、NOT_USED 和 SKIPPED。
String executionType 活动实例的执行类型。 有效值包括：AUTOMATIC 和 MANUAL。
Boolean hidden 指示在建模过程中是否已将活动定义为隐藏。
String id 活动实例的标识。
String name 活动实例的名称。
String optionType 活动实例的选项类型。 有效值包括：REQUIRED 和 OPTIONAL。
Boolean repeatable 指示活动实例是否可重复。
Boolean required 指示某个活动实例是否为执行所必需。
TWDate startDate 活动实例的开始日期。
TWTask task 活动实例的任务实施。 仅适用于具有活动类型 USER_TASK 的活动实例。
TWTask[] tasks 返回活动类型为 USER_TASK 的活动实例的相关任务实例，或者返回其他活动类型的活动实例的潜在可申领任务实例列表。
方法概要
void disable( Boolean checkAuthorization) 禁用处于 "就绪" ， "正在等待" 或 "失败" 状态的活动。
void enable( Boolean checkAuthorization) 启用处于 DISABLED 状态的活动。
String[] getAvailableActions( String[] actionsFilter) 返回指定用户的活动实例上的可用操作的列表。
void start( String taskOwnerUserId) 启动状态为 READY 的活动。
ActivityDetails toActivityDetails( String[] actionsFilter) 将活动实例转换为 ActivityDetails 业务对象。

ActivityListData

“活动列表服务”返回的对象。

Type属性目录
ActivityListItem[] activities ActivityListItem 对象的列表。

ActivityListFilter

该对象用作“活动列表服务”输入的一部分以限制所返回活动的列表。

Type属性目录
String[] activityTypeFilter 按指定值过滤结果列表。 有效值包括：USER_TASK、SERVICE_TASK、CALLED_PROCESS 和 SUB_PROCESS。 可选字段。
String[] executionStateFilter 按指定值过滤结果列表。 有效值包括：READY、WORKING、COMPLETED、WAITING、FAILED、NOT_USED 和 SKIPPED。 可选字段。
String[] executionTypeFilter 按指定值过滤结果列表。 有效值包括：AUTOMATIC 和 MANUAL。 可选字段。
String[] optionTypeFilter 按指定值过滤结果列表以检索在建模期间标记为可选或必需的活动。 有效值包括：REQUIRED 和 OPTIONAL。 可选字段。
String repeatableFilter 按指定值过滤结果列表。 有效值包括：REPEATABLE 和 NOT_REPEATABLE。 可选字段。
String requiredFilter 按指定值过滤结果列表以检索完成实例的可选或必需活动。 有效值包括：REQUIRED 和 OPTIONAL。 可选字段。

ActivityListItem

用于表示“活动列表服务”所返回 ActivityListData 对象中的活动列表项的对象。

Type属性目录
String[] actions 包含 checkActions 过滤器中指定的操作（如果适用于当前用户的活动列表项）。 如果未在 checkActions 过滤器中指定任何操作，那么将不会检查这些项的操作，并且该属性将为空。 有效值包括：ACTION_VIEW_ACTIVITY 和 ACTION_START_ACTIVITY。
String activityType 活动实例的活动类型。 有效值包括：USER_TASK、SERVICE_TASK、CALLED_PROCESS 和 SUB_PROCESS。
String endDate 活动实例的结束日期，采用 UTC 格式（ISO 日期字符串）。
String executionState 活动实例的执行状态。 有效值包括：READY、WORKING、COMPLETED、WAITING、FAILED、NOT_USED 和 SKIPPED。
String executionType 活动实例的执行类型。 有效值包括：AUTOMATIC 和 MANUAL。
Boolean hidden 指示活动实例是否已隐藏。
String id 活动实例的标识。
String name 活动实例的名称。
String optionType 建模期间指定的活动实例的选项类型。 有效值包括：REQUIRED 和 OPTIONAL。
Boolean repeatable 指示活动实例是否可重复。
Boolean required 指示流程完成是否需要活动实例。
String startDate 活动实例的开始日期，采用 UTC 格式（ISO 日期字符串）。

ActivityListProperties

该对象将用作“活动列表服务”的输入。 使用该对象指定排序或过滤条件，并支持其他返回信息。

Type属性目录
String[] checkActions 检查活动操作的已定义列表是否适用于当前用户的活动列表项。 有效值包括：ACTION_VIEW_ACTIVITY 和 ACTION_START_ACTIVITY。 如果未在 checkActions 中定义操作，那么将根本不会为操作检查项，且项中的 actions 属性将为空。 可选字段。
ActivityListFilter[] filters 返回的活动列表项必须与其中至少一个过滤器匹配。 可选字段。
String hiddenFilter 按指定值过滤结果列表。 有效值包括：HIDDEN 和 NOT_HIDDEN。 可选字段。
String[] sortCriteria 按指定值对结果列表排序。 有效值包括：STATE_ASC、STATE_DESC、NAME_ASC、NAME_DESC、STARTDATE_ASC、STARTDATE_DESC、OPTIONTYPE_ASC 和 OPTIONTYPE_DESC。 可选字段。 缺省值：NAME_ASC

ActivitySummary

这些对象的列表由“活动摘要服务”返回。

Type属性目录
String bpdFlowObjectId 当前 BPD 和应用程序标识的活动的 BPD 流对象标识。
Integer countActive 当前 BPD 和流程应用程序标识的此活动中处于“活动”状态的流程实例数。
Integer countAtRisk 当前 BPD 和流程应用程序标识的此活动中处于“存在风险”状态的流程实例数。
Integer countOnTrack 当前 BPD 和流程应用程序标识的此活动中处于“正常”状态的流程实例数。
Integer countOverdue 当前 BPD 和流程应用程序标识的此活动中处于“过期”状态的流程实例数。
String name 当前 BPD 和应用程序标识的活动的名称。

AlignTypes

用于提供对齐选择选项的业务对象。

任何

在 IBM Business Automation Workflow 中，此类表示任意内容。 使用此类可指示任意类型的变量

BOOLEAN

布尔值类型

BPMAlertDefinition

定义警报出现状况的条件。

Type属性目录
String bpdDisplayName 警报定义中选定业务流程定义的显示名称。 该字段为可选字段，对警报定义评估没有任何影响。 该属性和“bpdId”属性必须来自相同的业务流程定义。 它在设置“bpdId”属性时自动进行设置。
String bpdId 警报定义中采用外部字符串格式的选定业务流程定义标识（例如，25.c904b3b1-afc1-4698-bf5a-a20892c20275）。 除非设置了属性“bpdDisplayName”，否则该字段为可选字段。 通过该属性指定的业务流程定义必须与在“projectId”属性中选择性指定的项目以及通过“snapshotId”属性选择性指定的 Snapshot 相关。 如果未指定业务流程定义，那么缺省情况下包含所有业务流程定义。
String category 警报定义的类别。 有效值：INSTANCE 和 TASK。
String displayName 警报定义的显示名称。
String id 警报定义的标识。
String instanceStatus 警报定义中选定的实例执行状态。 有效值：ACTIVE、COMPLETED、FAILED、TERMINATED 和 SUSPENDED。 可选字段。 如果未设置，那么缺省情况下，所有实例执行状态都包含在警报定义中。
String projectId 警报定义中采用外部字符串格式的选定流程应用程序标识（例如，2066.9ab0d0c6-d92c-4355-9ed5-d8a05acdc4b0）。 此字段是可选字段。 它将在设置属性“snapshotId”或“bpdId”时自动进行设置。 如果未指定项目，那么缺省情况下，所有项目都包含在警报定义中。
String snapshotId 警报定义中采用外部字符串格式的选定 Snapshot 标识（例如，2064.aaa569e9-a57a-4684-b357-34237e4e49ea）。 此字段是可选字段。 通过该属性指定的 Snapshot 必须与通过属性“projectId”选择性指定的项目相关。 如果未指定 Snapshot，那么缺省情况下包含所有 Snapshot。
String taskStatus 警报定义中选定的任务执行状态。 有效值包括 NEW、RECEIVED 和 CLOSED。 此字段是可选字段。 如果未设置，那么警报定义针对所有三个任务执行状态。 该字段仅适用于类型为 TASK 的警报定义。
String thresholdOperator 警报定义中的阈值运算符。 有效值：： LESS、EQUAL 和 GREATER。
String thresholdValue 警报定义中的阈值。 有效值必须是数字，并且大于或等于零。

BPMAlertDefinitionStatus

评估警报定义时返回的警报定义状态。

Type属性目录
String actualValue 警报定义中设置的阈值在运行时的实际值。
Boolean conditionMet 指示是否满足警报定义的条件。
BPMAlertDefinition definition 针对该警报定义状态评估的警报定义。

BPMAlertDefinitionStatusResponse

返回对多个警报定义执行“获取状态”操作的结果。

Type属性目录
BPMAlertDefinitionStatus[] alertDefinitionStatus 包含警报定义状态的零个或更多对象的列表。
BPMFailedOperation[] failedOperations 零个或更多失败操作的列表。

BPMBOPropertyChange

包含已更新的共享业务对象的旧值和新值

Type属性目录
ANY newValue 该属性的新值
ANY oldValue 基本版本中该属性的旧值
String property 以 JSON 格式更改的属性的名称。 示例：- "name" - "customer.name" - "item[2].amount"

BPMBOSaveFailedError

包含由保存服务对执行上下文中所有共享业务对象引发的验证错误的列表

Type属性目录
BPMBOSaveServiceValidationErrors[] errors 描述不适用

BPMBOSaveServiceValidationErrors

包含由保存服务对共享业务对象引发的验证错误的列表

Type属性目录
ANY object 由于验证错误而导致保存服务失败的对象。 表示合并后且保存服务对其进行更改后的对象。
BPMBOValidationError[] validationErrors 共享业务对象保存服务各自的输出
String variablePath 指向执行保存的执行上下文中共享业务对象的路径

BPMBOValidationError

表示由保存服务对共享业务对象引发的验证错误

Type属性目录
String errorcode 描述不适用
String errorCode 可用于以编程方式处理 BPD 或服务中错误的代码
String errortext 描述不适用
String errorText 当运行时出现错误时可向用户显示的消息文本。 还可以提供错误消息的本地化版本
String property 该验证错误所针对的 JSON 格式的属性的名称。 示例：- "name" - "customer.name" - "item[2].amount"

BPMDocumentDisplayOptions

针对 IBM Business Automation Workflow 文档库中的文档指定搜索和显示选项。

Type属性目录
Boolean associatedWithProcessInstance 描述不适用
BPMDocumentMatchRule displayMatchRule 描述不适用
NameValuePair[] displayProperties 描述不适用

BPMDocumentMatchRule

指定在 IBM Business Automation Workflow 文档库中搜索文档时的匹配规则。

BPMDocumentOptions

指定用于处理 IBM Business Automation Workflow 文档库中的文档的选项。

Type属性目录
BPMDocumentDisplayOptions displayOptions 针对 IBM Business Automation Workflow 文档库中的文档指定搜索和显示选项。
BPMDocumentUploadOptions uploadOptions 指定在 IBM Business Automation Workflow 文档库中创建文档时的上载选项。

BPMDocumentUploadOptions

指定在 IBM Business Automation Workflow 文档库中创建文档时的上载选项。

Type属性目录
Boolean addProperties 描述不适用
String defaultUploadName 描述不适用
Boolean hideInPortal 描述不适用
NameValuePair[] uploadProperties 描述不适用
Boolean userEditable 描述不适用

BPMExposedItem

公开项的描述。

Type属性目录
String branchID 分支（或轨道）的 UUID（通用唯一标识）。
String branchName 分支（或轨道）的名称。
String display 公开项的名称
String ID 属性标识
boolean isDefault 缺省属性。
String itemID 公开项的 UUID（通用唯一标识）
String itemReference 公开项的引用
String processAppAcronym 包含公开项的流程应用程序的首字母缩略词。
String processAppID 包含公开项的流程应用程序的 UUID（通用唯一标识）
String processAppName 包含公开项的流程应用程序的名称。
String runURL 运行 URL
String snapshotCreatedOn Snapshot 创建日期和时间。
String snapshotID Snapshot 的 UUID（通用唯一标识）。
String snapshotName Snapshot 的名称。
String startURL 启动公开项的 URL。
boolean tip 布尔值。 如果公开项在顶部，那么为 True，如果它在 Snapshot 中，那么为 false
String topLevelToolkitAcronym 如果该 Toolkit 依赖于另一个 Toolkit，那么为顶级 Toolkit 的首字母缩略词。
String topLevelToolkitName 如果该 Toolkit 依赖于另一个 Toolkit，那么为顶级 Toolkit 的首字母缩略词。
String type 公开项的类型。 例如，过程或服务。

BPMFailedOperation

描述批量请求期间的失败操作。

Type属性目录
String errorMessage 与错误关联的错误消息。
String errorNumber 与错误关联的错误消息前缀。
String objectId 对其操作失败的对象标识。

BPMRelationship

描述不适用

Type属性目录
Date creationDate 描述不适用
UserInfo creator 描述不适用
String description 描述不适用
String id 描述不适用
Date lastModified 描述不适用
String sourceId 描述不适用
String targetId 描述不适用
String type 描述不适用
方法概要
BPMRelationshipDetails toRelationshipDetails() 将关系实例转换为 RelationshipDetails 业务对象。
void updateDescription(String newDescription , Boolean checkAuthorization) 更新关系的描述。

BPMRelationshipDetails

描述两个实例之间的关系。 此业务对象是由创建关系的 JavaScript API 返回的，并且是从对现有关系的查询返回的。

Type属性目录
Date creationDate 关系创建日期。
UserInfo creator 创建关系的用户。
String description 关系的描述。
String id 关系的标识。
Date lastModified 关系上次修改日期。
String sourceId 源的实例标识的外部化格式，由类型标识和实例标识组成。
String[] tags 与关系相关联的标记。 标记可用于关系查询。
String targetId 目标的实例标识的外部化格式，由类型标识和实例标识组成。
String type 关系的类型。 它可以是以下项之一：INDEPENDENT、DEPENDENT。

BPMRESTRequest

表示 REST 请求。 要创建该对象的新实例，请使用“new BPMRESTRequest()”

Type属性目录
String endpointAddress 覆盖端点地址。
String externalServiceName 外部服务的名称。
Object httpHeaders 已选择 REST 请求头作为具有键值对的 JavaScript 对象，例如 BPMRESTRequest.httpHeaders={"Content-Type": "application/xml"}
String httpMethod 操作的类型，例如 GET、POST、PUT、DELETE...
String invocationCredential 提供调用凭证以代替基本认证。
String operationName 操作的名称。
Object parameters 作为键值对的所有必需参数。
String password 提供基本认证密码。
String path 操作的路径。
Integer requestTimeout 以毫秒为单位设置请求超时前可以等待的时间。
Integer responseTimeout 以毫秒为单位设置响应超时前可以等待的时间。
String sslConfiguration 要使用的 SSL 配置。
String username 提供基本认证用户名。

BPMRESTResponse

表示 REST 响应。

Type属性目录
String content 响应的内容。
Object httpHeaders 响应头作为具有键值对的 JavaScript 对象，例如 {"Content-Type": "application/xml"}。
String httpStatusCode 响应的状态码。
String httpStatusMessage 响应的状态消息。

CaptionHorizontalPositionSelection

描述不适用

CaptionVerticalPositionSelection

描述不适用

CaseReference

此对象表示目标对象库中的案例实例。

Type属性目录
String caseFolderId 案例实例的文件夹标识。
String caseId 案例实例的标识。
String caseTitle 案例实例的标题。

ChartClickEvent

ChartClickEvent 包含有关所单击的图表段的信息，包括曾经所属的序列和所单击段的名称和值。

Type属性目录
ChartDataPoint dataPoint 描述不适用
Integer dataPointIndex 描述不适用
String seriesLabel 描述不适用

ChartData

ChartData 直接绑定到图表控件，包含一个或多个 ChartDataPlot 对象。 各个 ChartDataPlot 对象会显示在图表中（重叠）。 例如，图表可以同时显示折线图和柱图。 每个图表都包含一个或多个图，每个图包含一个或多个序列，而每个序列由一个或多个数据点组成。

Type属性目录
ChartDataPlot[] plots ChartDataPlot 是一个或多个代表图数据的 ChartDataSeries 对象。 同一图中的序列看起来相似。 例如，图中显示为列的两个序列将分别显示为列集合。

ChartDataPlot

ChartDataPlot 是一个或多个代表图数据的 ChartDataSeries 对象。 同一图中的序列看起来相似。 例如，图中显示为列的两个序列将分别显示为列集合。

Type属性目录
ChartDataSeries[] series ChartDataSeries 代表数据点序列。 在列图表中，相同序列的数据点以同一种颜色显示为一列。 在折线图中，每个数据序列通过一种颜色的线表示，行中的每个点表示序列中的一个数据点。 序列标签显示在图表图注中。 因为饼图一次只能显示一个序列，因此数据点名称会改为显示在图注中。

ChartDataPoint

ChartDataPoint 是单个数据点，如 (Apples, 5) 或 (2013, 637)。 每个数据点会根据图类型显示在图中。 例如，饼图数据点显示为扇区，柱图数据点显示为柱形，折线图数据点显示为折线上的单个点，等等。

Type属性目录
String name 数据点的标签 。
Decimal value 数据点的值。

ChartDataSeries

ChartDataSeries 代表数据点序列。 在列图表中，相同序列的数据点以同一种颜色显示为一列。 在折线图中，每个数据序列通过一种颜色的线表示，行中的每个点表示序列中的一个数据点。 序列标签显示在图表图注中。 因为饼图一次只能显示一个序列，因此数据点名称会改为显示在图注中。

Type属性目录
ChartDataPoint[] data ChartDataPoint 是单个数据点，如 (Apples, 5) 或 (2013, 637)。 每个数据点会根据图类型显示在图中。 例如，饼图数据点显示为扇区，柱图数据点显示为柱形，折线图数据点显示为折线上的单个点，等等。
String label 要显示在图表图注中的序列标签 。

ChartDisplayOptions

ChartDisplayOptions 是可以绑定到“显示”选项配置设置的 ChartPlotDisplayOptions 序列（ChartData 中的每个 ChartDataPlot 都有一个）。

Type属性目录
ChartPlotDisplayOptions[] plots 描述不适用

ChartLegendPositionSelection

ChartLegendPositionSelection 决定是否显示图注以及它在图表中的位置。 缺省设置为“无”（图注隐藏），位置设置包括左侧、右侧和底部。

ChartPieLabelSelection

ChartPieLabelSelection 决定饼图标签如何显示。 设置包括“无”、“数字”和“百分比”。

ChartPlotDisplayOptions

ChartPlotDisplayOptions 有可以指示图显示方式的属性。 ChartData 对象中的每个 ChartPlotData 对象都需要对应的 ChartPlotDisplayOptions 对象。 plotType 属性非常重要，因为它可以决定图类型，如饼图或柱图。 有一些属性可以决定图轴名外观和位置。 例如，垂直轴可以显示为在右侧滑动，或者水平轴可以显示为在顶部滑动。

Type属性目录
Boolean displayHorizontalAxis 描述不适用
Boolean displayHorizontalAxisScrollButtons 描述不适用
Boolean displayVerticalAxis 描述不适用
Boolean flipHorizontalAxisToTop 描述不适用
Boolean flipVerticalAxisToRight 描述不适用
Integer gap 描述不适用
Decimal horizontalAxisMajorTickMarks 描述不适用
Decimal horizontalAxisMinorTickMarks 描述不适用
String horizontalAxisTitle 描述不适用
Decimal horizontalAxisWindowOffset 描述不适用
Boolean horizontalAxisWindowOffsetIsTrailing 描述不适用
Decimal horizontalAxisWindowScale 描述不适用
Integer maxBarSize 描述不适用
Integer minBarSize 描述不适用
ChartPieLabelSelection pieLabels 描述不适用
ChartPlotType plotType 描述不适用
Boolean plotTypeFixed 描述不适用
String tooltipTemplate 描述不适用
Decimal verticalAxisMajorTickMarks 描述不适用
Decimal verticalAxisMinorTickMarks 描述不适用
String verticalAxisTitle 描述不适用

ChartPlotType

ChartPlotType 包括以下类型的图：饼图、条形图、柱图、折线图和面积图。

ChartThemeSelection

ChartThemeSelection 设置为“缺省值”、“存在风险”和“过期”以及“定制”。 如果设置为“定制”，请使用“定制主题”配置选项定义您自己的主题。

CMISDocumentOptions

指定用于处理“内容管理互操作性服务”文档的选项。

Type属性目录
String cmisQuery 要执行的 CMIS 查询。
String parentFolderPath 描述不适用

CoachValidation

此对象包含 Coach 验证错误。

Type属性目录
CoachValidationError[] validationErrors CoachValidationError 的列表。

CoachValidationError

该对象表示 CoachValidationError 信息。

Type属性目录
String errorBOPath 错误的 bo 路径。
String errorMessage 错误消息。

ConditionalActivity

该对象表示 BPD 中的条件活动。

Type属性目录
ConditionalActivity[] children 该条件活动的子条件活动的列表。
String id 条件活动的标识。
Boolean isConditional 指示该活动是否为条件活动。
String name 条件活动的名称。

CurrencyCodeSelectionType

描述不适用

日期

日期类型

DateRangeString

该对象在 TaskListProperties 对象中使用，用于指定应返回哪个日期范围的任务。

Type属性目录
String endDate 日期范围的结束日期，采用 UTC 格式（ISO 日期字符串）。
String startDate 日期范围的开始日期，采用 UTC 格式（ISO 日期字符串）。

decimal

十进制类型

DocumentSelection

指定在 IBM Business Automation Workflow 文档库中创建文档时的上载选项。

ECMAllowableActions

该对象允许的操作的列表。

Type属性目录
Boolean canAddObjectToFolder 可以将对象归档在文件夹中
Boolean canApplyACL 可以将“访问控制表”应用于该对象
Boolean canApplyPolicy 可以将指定策略应用于对象
Boolean canCancelCheckOut 可以取消检出指定的专用工作副本文档
Boolean canCheckIn 可以检入指定的专用工作副本文档
Boolean canCheckOut 可以检出指定的文档
Boolean canCreateDocument 可以在指定文件夹中创建文档
Boolean canCreateFolder 可以创建文件夹作为指定文件夹的子代
Boolean canCreateRelationship 可以将该对象作为源来创建关系对象
Boolean canDeleteContentStream 可以删除文档对象的内容流
Boolean canDeleteObject 可以删除指定对象
Boolean canDeleteTree 可以删除指定文件夹及其包含的所有对象
Boolean canGetACL 可以获取指定对象的“访问控制表”
Boolean canGetAllVersions 可以获取“文档”对象的版本序列
Boolean canGetAppliedPolicies 可以获取应用于指定对象的策略的列表
Boolean canGetChildren 可以获取文件夹的子代
Boolean canGetContentStream 可以获取文档对象的内容流
Boolean canGetDescendants 可以获取文件夹的后代
Boolean canGetFolderParent 可以获取文件夹的父文件夹
Boolean canGetFolderTree 可以获取文件夹的子文件夹树
Boolean canGetObjectParents 可以获取对象的父文件夹
Boolean canGetObjectRelationships 可以获取以此对象为源或目标的关系
Boolean canGetProperties 可以读取指定对象的属性
Boolean canGetRenditions 可以检索此对象的副本
Boolean canMoveObject 可以将对象移出/移入此文件夹
Boolean canRemoveObjectFromFolder 可以从文件夹取消归档指定的文档
Boolean canRemovePolicy 可以从指定对象移除策略
Boolean canSetContentStream 可以为文档对象设置内容流
Boolean canUpdateProperties 可以更新此对象的属性

ECMContentEvent

ECMContentEvent 对象代表从 ECM 系统中收到的文件夹/文档事件。

Type属性目录
ECMEventClass eventClass ECMEventClass 对象代表从 ECM 系统中收到的事件的类别（文档或文件夹）。
ECMEventType eventType ECMEventType 对象代表从 ECM 系统中收到的事件的类型。
ECMID objectId 对象定义的对象身份。
ECMID objectTypeId 对象类型定义的对象身份。
ECMEventClass relatedObjectClass 相关对象的类型定义的类型（文档或文件夹），例如，归档到文件夹的对象。
ECMID relatedObjectId 相关对象的对象标识，例如，归档到文件夹的对象。
ECMID relatedObjectTypeId 相关对象的类型定义的对象标识，例如，归档到文件夹的对象。
ECMID repositoryId ECM 服务器上发送事件的 ECM 存储库的 ECMID。
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称

ECMContentStream

ECMContentStream 对象包含 ECM 文档的内容。

Type属性目录
ANY content 文档内容，以基本 64 位编码的二进制数据表示。
Integer contentLength 内容流的长度（以字节为单位），或者如果无法检索到长度，那么为 -1。
String fileName 文档内容的文件名。
String mimeType 文档内容的 MIME 类型。

ECMDocument

ECMDocument 对象代表 ECM 系统中的文档。

Type属性目录
String checkinComment 与给定版本关联的文本注释。
String contentURL 文档内容的位置。
String createdBy 创建该文档的用户。
Date creationDate 创建该文件夹的日期和时间。
Boolean isLatestMajorVersion 如果此文档是最新的主版本，那么为 True。
Boolean isLatestVersion 如果此文档是最新版本，那么为 True。
Boolean isMajorVersion 如果此文档是主版本，那么为 True。
Date lastModificationDate 上次修改该文档的日期和时间。
String lastModifiedBy 上次修改该文档的用户。
String name 文档的名称。
ECMID objectId 文档的对象身份。
ECMID objectTypeId 对象类型定义的对象身份。
ECMProperty[] properties 一组已命名但未明确排序的属性。 在一个对象中，每个属性都通过其属性定义标识来唯一识别。
ECMID repositoryId 托管对象类型定义的存储库的标识。
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称。
String versionLabel 为此文档的版本提供的版本标签。

ECMDocumentInfo

ECMDocumentInfo 对象包含关于 ECM 文档的信息。

Type属性目录
String contentURL 文档内容的位置。
ECMID objectId 文档的对象身份。
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称。

ECMError

ECMError 对象包含关于 ECM 操作的异常结果的信息。

Type属性目录
Integer code CMIS 异常代码。
String message CMIS 异常消息文本。
String type CMIS 异常类型。

ECMEventClass

ECMEventClass 对象代表从 ECM 系统中收到的事件的类别（文档或文件夹）。

ECMEventType

ECMEventType 对象代表从 ECM 系统中收到的事件的类型。

ECMFolder

ECMFolder 对象代表 ECM 系统中的文件夹。

Type属性目录
String createdBy 创建该文件夹的用户。
Date creationDate 创建该文件夹的日期和时间。
Date lastModificationDate 上次修改该对象的日期和时间。
String lastModifiedBy 上次修改该文件夹的用户。
String name 文件夹的名称。
ECMID objectId 对象定义的对象身份。
ECMID objectTypeId 对象类型定义的对象身份。
ECMID parentId 对象的直接父类型的对象身份。
String path 此文件夹的标准路径。 Root 文件夹的路径为“/”。
ECMProperty[] properties 一组已命名但未明确排序的属性。 在一个对象中，每个属性都通过其属性定义标识来唯一识别。
ECMID repositoryId 托管对象类型定义的存储库的标识
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称。
ECMFolder[] subFolders 此文件夹中包含的文件夹对象。 可以为 null（如果未请求）或为空（如果不存在子文件夹）

ECMFolderInfo

ECMFolderInfo 对象包含关于 ECM 文件夹的信息。

Type属性目录
String displayName 显示文件夹的名称。
ECMID objectId 文件夹的对象身份。
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称。

ECMID

ECMID 对象表示 ECM 系统中对象的唯一标识。

ECMMultiValue

ECMMultiValue 对象包含 cardinality=multi 的 ECM 属性的值。

Type属性目录
ANY[] value ECM 属性的值列表。

ECMObjectTypeDefinition

ECMObjectTypeDefinition 对象包含 ECM 文件夹和 ECM 文档的类型元数据。

Type属性目录
ECMID baseId 表示此对象类型的基本类型是文档还是文件夹的值。
ECMObjectTypeDefinition[] children 对象类型的直接子类型。 （如果返回此类型对象的操作未请求，那么可以为 null；如果不存在子类型，那么可以为空）。
String description 对象类型的描述。
String displayName 对象类型的显示名称。
String localName 对象类型的局部名称。
String localNamespace 对象类型的局部名称空间。
ECMID objectTypeId 对象类型定义的对象身份。
ECMID parentId 对象类型的直接父类型的对象身份。
ECMPropertyTypeDefinition[] propertyTypeDefinitions 此对象类型定义的属性类型定义列表。 （如果返回此类型对象的操作未请求，那么可以为 null）。
Boolean queryable 表示对象类型是否可用于过滤（在搜索操作的 WHERE 子句中）。
String queryName 用于对对象类型的查询和过滤操作。
ECMID repositoryId 托管对象类型定义的存储库的标识
String serverName 托管对象类型定义的 ECM 服务器的名称。

ECMProperty

ECMProperty 对象代表 ECM 文件夹或 ECM 文档的属性。

Type属性目录
ECMID objectTypeId 属性类型定义的对象身份。
ANY value 属性值。

ECMPropertyMetadata

ECMPropertyMetadata 对象在 ECM 搜索结果集内包含属性的类型元数据。

Type属性目录
String displayName 所选属性的显示名称。
String queryName 所选属性的查询名称。

ECMPropertyTypeDefinition

ECMPropertyTypeDefinition 对象包含 Enterprise Content Management (ECM) 文件夹或 ECM 文档的属性的类型元数据。

Type属性目录
String cardinality 属性的基数（“single”或“multi”）。
ANY[] choices 此属性允许的单值的有序集。
ANY[] defaultValues 存储库为属性设置的值（如果在创建对象时应用程序未提供任何值）。 缺省值元素上的特性与属性定义上的特性相同。
String description 属性的描述。
String displayName 属性的显示名称。
String localName 属性的局部名称。
String localNamespace 属性的局部名称空间。
Decimal maxDecimalValue 该属性允许的最大值。 仅当 propertyType 为 Decimal 时设置。
Integer maxIntegerValue 该属性允许的最大值。 仅当 propertyType 为 Integer 时设置。
Integer maxStringLength 该属性的值所允许的最大长度（以字符为单位）。 仅当 propertyType 为 String 时设置。
Decimal minDecimalValue 该属性允许的最小值。 仅当 propertyType 为 Decimal 时设置。
Integer minIntegerValue 该属性允许的最小值。 仅当 propertyType 为 Integer 时设置。
ECMID objectTypeId 属性类型定义的对象身份。
Boolean orderable 表示属性是否可用于排序（即，属性可以出现在搜索操作的 ORDER-BY 子句中）。
Integer precisionDecimal 该属性的值所支持的精度（以位为单位）。 该特性的有效值包括：o 32：32 位精度（在 IEEE-754-1985 中指定为 single）。 o 64：64 位精度（在 IEEE-754-1985 中指定为 double）。 仅当 propertyType 为 Decimal 时设置。
String propertyType 此特性指示此属性的类型。
Boolean queryable 表示属性是否可用于过滤（在搜索操作的 WHERE 子句中）。
String queryName 用于对属性的查询操作。
Boolean required 表示调用者（或存储库）是否必须提供一个值。
String resolutionDateTime 该属性的值所支持的精度（以位为单位）。 该特性的有效值包括：o Year：将持久存储年分辨率。 o Date：将持久存储日期分辨率。 o Time：将持久存储时间分辨率。 仅当 propertyType 为 DateTime 时设置。
String updatability 表示在哪些情况下可以更新属性（“readonly”、“readwrite”、“whencheckedout”、“oncreate”）。

ECMSearchResult

ECMSearchResult 对象包含 ECM 搜索操作的响应。

Type属性目录
Boolean hasMoreItems 有更多项可用。
Integer numItems 应用分页之前结果集中的项数。 请注意，根据 ECM 服务器，此数目可能不准确。
ECMID objectTypeId 此搜索返回的对象类型定义的对象身份。
ECMPropertyMetadata[] propertyMetadata 已选属性的元数据。
ECMID repositoryId ECM 服务器上从中检索到结果的 ECM 存储库的 ECMID。
ANY resultSet 查询的结果。
String serverName 识别对应 ECM 存储库的 ECM 服务器的名称。

ECMSearchResultRow

ECMSearchResultRow 对象代表 ECM 搜索结果集内的一行。

Type属性目录
ECMAllowableActions allowableActions 该对象允许的 Enterprise Content Management 操作的列表
ANY[] column SQL 语句所返回的值列表。

ECMSearchResultSet

ECMSearchResultSet 对象表示 ECM 搜索结果集。

Type属性目录
ANY[] row SQL 语句所返回的值列表。

ECMServer

包含有关定义 ECM 服务器的信息。

Type属性目录
String contextPath 服务器的上下文路径。
String description 服务器的描述。
String eventSourceID 事件源的标识。
String hostname 服务器的主机名。
String name 服务器的名称。
Number port 服务器的端口。
String repository 服务器的存储库。
String repositoryID 存储库的标识。
String rootFolderID 服务器的 Root 文件夹的标识。 如果无法建立到服务器的连接，那么将返回“null”。
Boolean useHTTPS 指示协议是否为 HTTPS。

ECMServerNames

在内容集成步骤中使用的服务器名称。

Type属性目录
String IBM_BPM_CONTENT_STORE IBM Business Automation Workflow 内容库的服务器名称。
String IBM_BPM_DOCUMENT_STORE IBM Business Automation Workflow 文档库的服务器名称。
String IBM_BPM_MANAGED_STORE IBM Business Automation Workflow 受管库的服务器名称。
String IBM_BPM_TARGET_STORE IBM Business Automation Workflow 目标库的服务器名称。

IndexedMap

此类型包含键值对列表。 可通过以下方式获取“theKey”键的值：- 按名称：myVariable = myIndexedMap.theKey；- 按索引：myVariable = myIndexMap.data[0]；，其中 0 是键的索引；

Type属性目录
ANY[] data 该列表包含密钥值。
ANY indexedMap 假参数。 它用于在运行时添加属性的不同类型和名称。

InstanceListData

“实例列表服务”返回的对象。

Type属性目录
String instanceIndexLastIndexStartTime 上次索引更新开始的日期，采用 UTC 格式（ISO 日期字符串）。
Integer instanceIndexUpdateInterval 相邻两次实例索引更新之间的秒数。
InstanceListItem[] instances 实例列表项的列表。
Integer total 实例列表中的实例总数。

InstanceListItem

用于表示“实例列表服务”所返回 InstanceListData 对象中嵌套的单个实例列表项的对象。

Type属性目录
String completionDate 实例的完成日期。
String creationDate 实例的创建日期。
String dueDate 实例的到期日期。
String id 实例的标识。
Boolean isFollowed 指示该实例列表项是否后跟有当前用户。
String name 实例的名称。
String owningTeamId 实例的实例所有者团队的标识。
String owningTeamName 描述不适用
String riskState 实例所处的风险状态。
String status 实例的状态。

InstanceListProperties

该对象用作“实例列表服务”的输入以过滤或限制所返回实例的列表。

Type属性目录
String searchFilter 用于限制所包括实例的 Lucene 查询语法过滤器字符串。 可选字段。
String[] statusFilter 按指定值过滤实例列表。 可选字段。 有效值包括：ACTIVE、COMPLETED、FAILED、TERMINATED、DID_NOT_START 和 SUSPENDED。

InstanceTasksData

“实例任务列表服务”返回的对象。

Type属性目录
TaskListItem[] tasks 任务列表。
Integer total 列表中的任务总数。

InstanceTasksFilter

该对象用作“实例任务服务”输入的一部分以限制所返回的任务列表。

Type属性目录
String[] statusFilter 按指定值过滤结果列表。 有效值包括：NEW、RECEIVED、REPLIED、FORWARDED、SENT、ACTIONED、CLOSED、SPECIAL 和 DELETED。 可选字段。

InstanceTasksProperties

该对象用作“实例任务列表服务”的输入以过滤或限制所返回任务的列表。

Type属性目录
String[] checkActions 检查任务操作的已定义列表是否适用于当前用户的任务列表项。 有效值包括：ACTION_CANCELCLAIM、ACTION_CLAIM、ACTION_COMPLETE、ACTION_CREATEMESSAGE、ACTION_GETTASK、ACTION_GETUISETTINGS、ACTION_UPDATEDUEDATE、ACTION_UPDATEPRIORITY、 ACTION_REASSIGNTOUSER、ACTION_REASSIGNTOGROUP、ACTION_VIEW_TASK 和 ACTION_VIEW_TASK_DETAILS。 如果未在 checkActions 中定义操作，那么将根本不会为操作检查项，且项中的 actions 属性将为空。 可选字段。
InstanceTasksFilter[] filters 返回的任务列表项必须与其中至少一个过滤器匹配。 可选字段。
String[] sortCriteria 按指定值对结果列表排序。 有效值包括：DUEDATE_ASC、DUEDATE_DESC、COMPLETEDDATE_ASC、COMPLETEDDATE_DESC、ID_ASC 和 ID_DESC。 您最多可以指定三个排序值。 可选字段。 缺省值：DUEDATE_ASC

整数

整数类型

IntegrationComponent

此类通过 JavaScript 提供 IntegrationComponents 的访问权。

Type属性目录
TWObject resultArray 此对象包含标准结构对象中的所有结果。 属性仅在调用 execute() 之后可用。
方法概要
IntegrationComponent execute() 执行集成组件。
IntegrationComponent getByName(String name) 使用其名称查找集成组件。 如果找不到所提供名称的组件，那么会抛出异常。

LayoutTypes

提供布局的选择选项的业务对象。

map

在 IBM Business Automation Workflow 中，此类表示“映射”类型。 使用此类可指示某个变量的类型为“映射”。 可分配给映射的唯一对象是原语和业务对象。

方法概要
boolean containsKey(Object key) 如果键存在，那么返回 true。
Object get(Object key) 返回映射中特定键的值。
Object[] keyArray() 返回映射中所有键的数组。
Object put(Object key , Object value) 将新条目添加到映射中。
void remove(Object key) 从地图中除去密钥。
int size() 此映射中的项数。
Object[] valueArray() 返回映射中所有值的数组。

PathStep

此对象保存遍历路径的相关信息。

Type属性目录
Step fromStep 提供链接的“开始”步骤
String pathId 提供连接器路径或链接标识
String processFlowPathId 提供可引用至 PDW 视图表的连接器路径或链接标识
Step toStep 提供链接的“结束”步骤

阶段

该对象表示为流程定义的阶段或里程碑。

Type属性目录
String id 阶段或里程碑的标识。
String name 阶段或里程碑的名称。

ProcessHistoricalStatistics

“流程历史统计信息服务”返回的对象。

Type属性目录
Integer averageInstanceDuration 此类型流程的平均实例持续时间列表。
TaskAllTimeStatistics[] taskAllTimeStatistics 此类型流程的所有时间统计信息列表。
TaskHistoricalGanttStatistics[] taskHistoricalGanttStatistics 此类型流程的历史甘特图统计信息列表。
TimingIntervalHistoricalStatistics[] timingIntervalHistoricalStatistics 此类型流程的计时时间间隔的历史统计信息列表。

ProcessHistoricalStatisticsProperties

对象用作“流程历史统计信息服务”的输入。 对象属性确定返回的结果集。

Type属性目录
Boolean includeAllTimeTaskStatistics 控制是否返回所有时间任务统计信息（任务最短和最长完成时间）列表。 可选字段。 缺省值：false。
Boolean includeAverageInstanceDuration 控制是否返回平均实例持续时间列表。 可选字段。 缺省值：false。
Boolean includeGanttTaskStatistics 控制是否返回甘特任务统计信息（平均持续时间、平均相对开始时间、执行的百分比、活动计数器）列表。 可选字段。 缺省值：false。
Boolean includeTimingIntervalStatistics 控制是否返回计时时间间隔统计信息列表。 可选字段。 缺省值：false。
String searchFilter 仅返回包含指定文本的条目。 可选字段。

ProcessInstanceListItem

这些对象的列表由“流程实例列表服务”返回。

Type属性目录
Integer age 流程实例的存在时间（以分钟为单位）。
String dueDate 流程实例的到期日期。
Boolean estimatedCompletionDateEnabled 指示此流程实例是否启用了“允许规划路径管理”。
String id 流程实例的标识。
String name 流程实例的名称。
String riskState 流程实例的风险状态。

ProcessInstanceListProperties

该对象用作“流程实例列表服务”的输入以过滤或限制所返回流程实例的列表。

Type属性目录
Integer beginIndex 从结果集顶部跳过指定数量的实例。 可选字段。 缺省值：0
Integer maxRows 将所返回的流程实例数限制为指定数字。 可选字段。 缺省值：25
String riskState 仅返回处于指定状态的流程实例。 有效值包括：OnTrack、AtRisk、Overdue。 可选字段。 如果未指定状态，将返回所有流程实例。
String searchFilter 仅返回包含指定文本的流程实例。 可选字段。
String sortCriteria 按给定值对结果列表排序。 有效值包括：AGE、RISK、DUEDATE、ALPHABET。 可选字段。 缺省值：DUEDATE
String stepId 仅返回位于指定步骤或活动中的流程实例。 可选字段。
String stepRiskState 仅返回步骤或活动（由步骤标识指定）中处于指定风险状态的流程实例。 有效值包括：OnTrack、AtRisk、Overdue。 可选字段。 如果未指定步骤标识，将返回所有流程实例。

ProcessSummary

“流程摘要服务”返回的对象。

Type属性目录
Integer countActive 此摘要适用的流程中的活动任务数。
Integer countAtRisk 此摘要适用的流程中存在风险的任务数。
Integer countOnTrack 此摘要适用的流程中的正常任务数。
Integer countOverdue 此摘要适用的流程中的过期任务数。
String description 此摘要适用的流程的描述。
String name 此摘要适用的流程的名称。
String processAppId 此摘要适用的流程应用程序的标识。
String processAppName 此摘要适用的流程应用程序的名称。
String processId 此摘要适用的流程的标识。

ProjectedPathLinkChange

该对象表示将影响规划路径预览的链路更改。

Type属性目录
String sourceStep 源步骤。
String targetStep 目标步骤。

ProjectedPath步骤

此对象保存规划路径的相关信息。

Type属性目录
Date dueDate 可选属性，仅对人员任务可用。 它是活动的到期日期。
Long duration 提供活动的持续时间。
boolean isDueDateCalculated 如果 DueDate 是根据持续时间计算得来，那么返回 True。 如果指定了特定到期日期，那么返回 False。
ProjectedPathStep nextProjectedPathStep 提供下一个规划路径步骤。
Integer priority 可选属性，仅对人员任务可用。 有五种优先级和一个未设置值：10（最高）、20（高）、30（一般）、40（低）、50（最低）和 -1（未设置）。
Step step 步骤是映射到用于描述 BPD 的静态数据的实体。 它是图中的流对象。
TWTask[] tasks 可选属性，仅当这是要执行的人员任务时才可用。

ProjectedPathStepChange

该对象表示将影响规划路径预览的步骤更改。

Type属性目录
Date dueDate 步骤的到期日期。
Integer duration 步骤的持续时间。
String id 步骤的标识。
Integer priority 步骤的优先级。

ProjectedPathTaskChange

该对象表示将影响规划路径预览的任务更改。

Type属性目录
Date dueDate 任务的到期日期。
String iid 任务的标识。

RadioButtonsOrientation

提供布局的选择选项的业务对象。

记录

在 IBM Business Automation Workflow 中，此类表示“记录”类型。 使用此类可指示某个变量是结构化类型，并且您不希望指定所有属性或者属性数在运行时确定。 无需预先声明将使用所有属性。 每个属性的类型将为 ANY

Type属性目录
int arrayLength 不推荐使用。 不推荐使用 arr.arrayLength 。 请改为使用 arr.listLength 。
返回此对象列表属性的长度。
#[] listAllSelected 返回此数组中所有所选项的数组。 项按顺序返回，这样最近选择的项位于位置 0，最初选择的项位于结尾。
int[] listAllSelectedIndices 返回此数组所有所选索引的数组。 索引按顺序返回，这样最近选择的索引位于位置 0，最初选择的索引位于结尾。
int listLength 返回此对象列表属性的长度。
# listSelected 返回数组中最近选定的项，如果没有选定项，那么返回未定义。
int listSelectedIndex 返回数组中最近所选项的索引，如果没有所选索引，那么返回 -1。
String[] propertyNames 以数组返回此对象中定义的属性名称。
Object[] propertyValues 以数组形式返回此对象中定义的属性值。
方法概要
Array arrayToNativeArray() 不推荐使用。 不推荐使用 arrayToNativeArray 。 请改为使用 listToNativeArray 。
将此 TWObject 数组转换为本机 JavaScript 数组对象。
XMLElement describe() 返回与此对象关联的属性和结构的 xml 结构。 这对调试很有用。
Object getPropertyValue(String name) 返回指定属性的值。
void insertIntoArray(int position , Object object) 不推荐使用。 改为使用 insertIntoList ()。
将值添加到特殊位置的列表。 应该重新调整列表大小以适合对象。
void insertIntoList(int position , Object object) 在特定位置向列表添加值。 应该重新调整列表大小以适合对象。
void listAddSelected(int index) 从所选项列表中添加项。
void listClearAllSelected() 从选择列表中除去所有项。
boolean listIsSelected(int index) 如果选择了项索引，那么返回 true ，否则返回 false。
void listRemoveSelected(int index) 从所选项列表中除去项。
Array listToNativeArray() 将此 TWObject 数组转换为本机 JavaScript 数组对象。
void removeIndex(int listIndex) 从列表中除去值。 将重新调整列表大小以适合其余对象。
void removeProperty(String propertyName) 从此对象中除去属性。
void setPropertyValue(String name , Object value) 设置属性的值。
String toJSONString( boolean formatted) 返回对象的 JSON 表示。
XMLElement toXML() 返回与此对象关联的属性的 xml 结构。
String toXMLString() 将 XML 结构作为与此对象关联的属性的字符串返回。

SearchScopeSelection

该对象由“搜索”Coach 视图使用，可用于选择搜索范围以将缺省自动补全服务返回的数据标签限制为“团队”或“业务流程”。

序列化器

提供 IBM Business Automation Workflow 变量的序列化/反序列化方法。

方法概要
Object fromXml(TWObject variable) 将字符串或 XMLElement 对象描述为 IBM Business Automation Workflow 变量。 字符串或 XMLElement 格式应遵循使用 toXml() API 的序列化的格式。
XMLElement toXml(TWObject variable) 将对象序列化为 XML。

显示为选择

描述不适用

显示日历选择

描述不适用

SLAViolationRecord

‌传统:‌ 将 SLAViolationRecord 传递到作为名为 "violationRecord" 的参数中 SLA 的结果的任何 BPD

Type属性目录
String slaName SLA 的名称
Decimal value 违反 SLA 时的值。 此值的含义取决于 SLA
Decimal violationLevel The violation level of the SLA 0 <= level < 1 means unviolated >=1 means violated
Date violationTime 违例发生的时间

SOAPHeader

该对象表示可显示在 Web Service 请求或响应中的单个 SOAP 头元素。

Type属性目录
String name 与 SOAP 头元素关联的名称。
String nameSpace 与 SOAP 头元素关联的名称空间。
String value SOAP 头元素的值。 这必须是完整 SOAP 头的有效 XML 表示。 例如： Joe VISA xxxxxxxxxxxxxx 2005-12

SOAPHeaders

该类型表示可显示在 Web Service 请求或响应中的 SOAPHeaders。

Type属性目录
SOAPHeader[] headers 该对象表示可在 Web Service 请求或响应中出现的单个 SOAP 头元素。

SQLDatabaseType

此信息来自与连接关联的 JDBC DatabaseMetaData。 提供了属性 isDb2、isOracle 和 isSqlServer，可使检测底层数据库实施更加容易。 可以使用 productName 属性来确定其他数据库类型。

Type属性目录
Integer driverMajorVersion 使用的 JDBC 驱动程序的主版本号。
Integer driverMinorVersion 使用的 JDBC 驱动程序的次版本号。
String driverName 使用的 JDBC 驱动程序的名称。
String driverVersion 使用的 JDBC 驱动程序的版本号。
Boolean isDb2 如果使用的数据库产品为 Db2，那么为 True。
Boolean isOracle 如果使用的数据库产品为 Oracle，那么为 True。
Boolean isSqlServer 如果使用的数据库产品为 SqlServer，那么为 True。
Integer majorVersion 使用的数据库产品的主版本。
Integer minorVersion 使用的数据库产品的次版本。
String productName 使用的数据库产品的名称。
String productVersion 使用的数据库产品的版本号。

SQLParameter

SQLParameter 与 SQLStatement 结合使用，以描述用于参数化的 SQL 语句的参数值、类型和方式信息。

Type属性目录
String mode 此参数的模式。 如果未指定，那么参数模式缺省为“输入”。 必须将模式指定为“输出”或“输入/输出”存储过程参数。 模式：“输入”、“输入/输出”、“输出”
String type 此参数的 SQL 类型。 如果未指定参数的类型，那么将使用底层数据库的缺省行为。 调用使用“输出”或“输入/输出”参数的存储过程时必须指定参数类型。 要从使用 REF CURSOR 输出参数的 Oracle 存储过程检索结果集，请使用 ORACLE_CURSOR 类型。 请注意， Oracle 上的多字节字符支持需要使用特殊的 Oracle 多字节类型 (ORACLE_NCHAR 等) ， 否则多字节字符数据可能损坏。 也可以精确指定类型。 在下列情况中这是必须的：此类型用作来自可调用语句的“输入/输出”或“输出”参数时，使用某些数字类型以避免截断数字。 例如：十进制 (31,10) 标准 JDBC 类型：ARRAY、BIGINT、BINARY、BIT、BLOB、BOOLEAN、CHAR、CLOB、DATALINK、DATE、DECIMAL、DISTINCT、DOUBLE、FLOAT、INTEGER、JAVA_OBJECT、LONGVARBINARY、LONGVARCHAR、NULL、NUMERIC、OTHER、REAL、REAL、SMALLINT、STRUCT、TIME、TIMESTAMP、TINYINT、VARBINARY、VARCHAR Oracle 特定类型：ORACLE_TIMESTAMPNS、ORACLE_TIMESTAMPTZ、ORACLE_TIMESTAMPLTZ、ORACLE_INTERVALYM、ORACLE_INTERVALDS、ORACLE_ROWID、ORACLE_CURSOR、ORACLE_BFILE、ORACLE_OPAQUE、ORACLE_JAVA_STRUCT、ORACLE_PLSQL_INDEX_TABLE、ORACLE_BINARY_FLOAT、ORACLE_BINARY_DOUBLE、ORACLE_FIXED_CHAR、ORACLE_NUMBER、ORACLE_RAW 供多字节字符数据使用的 Oracle 特定类型：ORACLE_NCHAR、ORACLE_NVARCHAR、ORACLE_NVARCHAR2、ORACLE_NCLOB Db2 特定类型：Db2_ROWID、Db2_XML。 IBM Business Automation Workflow 产品不会将任何复杂 IBM Business Automation Workflow 类型（例如，TWObject、数组）变换为数据库可处理的标准 JDBC 类型。 SQL 连接器只能处理简单类型。
ANY value 此参数的值。 如果参数模式为“输入参数”或“输入/输出参数”，需要此参数的值。 对于“输出”模式参数则不需要。

SQLResult

SQL 结果可表示结果集、更新计数或存储过程中的输出值。 结果的类型由“type”属性指明。 RESULT_SET“columns”、“columnIndexes”和“rows”属性由结果集中的数据进行填充。 UPDATE_COUNT“updateCount”属性设置为更新计数。 OUT_VALUES“outValues”属性设置为存储过程中输出值的列表。

Type属性目录
Map columnIndexes 从列名映射到结果集的列索引中。
SQLResultSetColumn[] columns 结果集的列元数据。
ANY[] outValues 从存储过程输出值
IndexedMap[] rows 结果集中的行。
String type SQL 结果对象类型有：RESULT_SET、UPDATE_COUNT、OUT_VALUES
Integer updateCount SQL 命令更新的行数

SQLResultSetColumn

此类型的属性是从结果集内每个列的 JDBC ResultSetMetaData 复制的。

Type属性目录
Boolean autoIncrement 表示指定列是否自动编号。
Boolean caseSensitive 表示某个列是否区分大小写。
String catalogName 指定列的表的目录名称。
String columnClassName 创造其实例以从列中检索值的 Java 类的标准名称。
Integer columnDisplaySize 表示指定列的正常最大宽度（以字符为单位）。
String columnLabel 指定列用于打印输出和显示的建议标题。
String columnName 指定列的名称。
String columnTypeName 指定列的特定于数据库的类型名称。
Boolean currency 表示指定列是否为现金值。
Boolean definitelyWritable 表示对指定列的写入操作是否肯定会成功。
Integer nullable 表示指定列中的值是否可为 null。
Integer precision 指定列的指定列大小。
Boolean readOnly 表示指定列是否绝对不可写。
Integer scale 指定列在小数点右侧的位数。
String schemaName 指定列的表的模式。
Boolean searchable 表示指定列是否可用于 where 子句。
Boolean signed 表示指定列中的值是否为有符号数。
String tableName 指定列的表的名称。
Boolean writable 表示对指定列的写入操作是否有可能成功。

SQLResultSetRow

行包含值的列表，每列一个值。 这些值可以是任意 IBM Business Automation Workflow 简单类型。

Type属性目录
ANY[] data SQL 语句所返回的值列表。

SQLStatement

SQLStatement 包含要执行的 SQL 及其关联的参数（如果适用），并且与 IBMBPM.SQLConnector API 结合使用。

Type属性目录
Integer maxRows （可选）如果已指定，那么从结果集读取的行数将限于此属性的值。 否则，将读取所有行。
SQLParameter[] parameters SQLParameter 与 SQLStatement 结合使用，以描述用于参数化的 SQL 语句的参数值、类型和方式信息。
String sql SQL 命令（选择、插入、更新、删除和调用等）。 它是参数化 SQL 语句的最佳方法，无需使用参数的字面值。

步骤

步骤是 BPD 图中的流对象。

Type属性目录
Integer duration 步骤的持续时间。
String id 步骤的标识。
String name 步骤的名称。
String[] nextSteps 后续步骤的列表。
String parentBPD 步骤的父 BPD。
String parentStepId 步骤的父步骤标识。
String phaseId 步骤的阶段标识。
String type 步骤的类型。

流

该对象保存一个或多个流条目。

Type属性目录
Boolean more 布尔值，用于指示在当前页面范围外是否还有其他 StreamEntries。
StreamActivity[] streamActivities 流页面中的 StreamActivity 条目的列表。
Integer totalItems 流页面中的 StreamActivity 条目的数量。

StreamActivity

该对象保存流条目的所有属性。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms。

Type属性目录
StreamObject actor 描述不适用
String content 描述不适用
StreamObject generator 描述不适用
StreamObject ibmbpmext 描述不适用
StreamMediaLink icon 描述不适用
String id 描述不适用
StreamObject object 描述不适用
StreamObject provider 描述不适用
String published 描述不适用
StreamObjectCollection replies 描述不适用
StreamObject target 描述不适用
String title 描述不适用
String updated 描述不适用
String url 描述不适用
String verb 描述不适用

StreamMediaLink

该对象保存简单的媒体属性，如图像或图标。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms

Type属性目录
Integer duration 描述不适用
Integer height 描述不适用
String url 描述不适用
Integer width 描述不适用

StreamObject

该对象保存通用的模型属性。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms

Type属性目录
StreamObjectCollection attachments 描述不适用
StreamObject author 描述不适用
String content 描述不适用
String displayName 描述不适用
String[] downstreamDuplicates 描述不适用
String fileName 描述不适用
String id 描述不适用
StreamMediaLink image 描述不适用
String objectType 描述不适用
String parent 描述不适用
String processId 描述不适用
String processName 描述不适用
String published 描述不适用
String summary 描述不适用
String taskId 描述不适用
String taskName 描述不适用
String taskText 描述不适用
String updated 描述不适用
String[] upstreamDuplicates 描述不适用
String url 描述不适用

StreamObjectCollection

该对象保存一系列流对象。 请参阅“活动流”规范以获取属性详细信息：http://activitystrea.ms

Type属性目录
StreamObject[] items 描述不适用
Integer totalItems 描述不适用
String url 描述不适用

字符串

字符串类型

TableEditMode

用于为表提供编辑方式选项的业务对象。

表选择类型

用于为表提供选择选项的业务对象。

TaskAllTimeStatistics

此类型的任务的所有时间统计信息。

Type属性目录
Integer averageDuration 任务的平均持续时间（秒）。
String id 任务的活动标识。
Integer maximumDuration 任务的最长持续时间（秒）
Integer minimumDuration 任务的最短持续时间（秒）。
String name 任务的活动名称。

TaskDueData

“任务到期服务”返回的对象。

Type属性目录
Integer futureCount 给定时间片的将来任务数。
Integer oldCount 早于指定时间片的任务数。
TaskDueSummary[] taskDueSummaries TaskDueSummary 对象的列表（片）。
String taskIndexLastIndexStartTime 上次索引开始时间的日期，采用 UTC 格式（ISO 日期字符串）。
Integer taskIndexUpdateInterval 相邻两次任务索引更新之间的秒数。

TaskDueProperties

该对象用作“任务到期服务”的输入以过滤或限制所返回任务到期片的列表。

Type属性目录
String interactionFilter 仅返回与指定交互过滤器相匹配的任务。 有效值包括：ASSESS_AND_WORK_ON、ASSESS_AVAILABLE、CHECK_COMPLETED、WORK_ON。 可选字段。 如果未设置该字段，将使用 ASSESS_AND_WORK_ON。
String searchFilter 仅返回包含指定文本的任务。 可选字段。
String taskDueSelectionEndDate 仅返回在指定 UTC 日期（ISO 8601 日期字符串）前到期的任务的任务到期片。 可选字段。 如果未指定日期，将返回所有日期和时间的任务到期片。
String taskDueSelectionStartDate 仅返回在指定 UTC 日期（ISO 8601 日期字符串）后到期的任务的任务到期片。 可选字段。 如果未指定日期，将返回所有日期和时间的任务到期片。
String teamId 仅返回分配到指定团队标识的任务的任务到期片。 可选字段。 如果未指定团队标识，将返回所有任务的任务到期片。
String userId 仅返回分配到指定用户标识的任务的任务到期片。 可选字段。 如果未指定用户标识，将返回所有任务的任务到期片。

TaskDueSummary

特定时间片内处于风险状态的任务数。

Type属性目录
Integer atRisk 指定时间片内处于“存在风险”风险状态的任务数。
String endDate 时间片的结束日期，采用 UTC 格式（ISO 8601 日期字符串）。
Integer onTrack 指定时间片内处于“正常”风险状态的任务数。
Integer overdue 指定时间片内处于“过期”风险状态的任务数。
String startDate 时间片的开始日期，采用 UTC 格式（ISO 8601 日期字符串）。

TaskHistoricalGanttStatistics

此类型流程的任务历史甘特图统计信息。

Type属性目录
Integer activityCounter 对于每个流程实例，此计数器都用于区分初始活动执行与后续执行（返工）。
Integer averageDuration 平均任务持续时间（以秒为单位）。
Integer averageRelativeStartTime 实例开始和任务开始之间的平均持续时间（以秒为单位）。
String id 任务的标识。
String name 任务的名称。
Integer percentExecuted 表明该任务相对于实例计数的执行频率的百分比。

TaskListData

“任务列表服务”返回的对象。

Type属性目录
UserInfo[] assignedUsers 分配给列表中任务的用户的 UserInfo 对象列表。
Map riskStateSummary 映射包含列表中处于特定风险状态的任务数。 键：风险状态；值：此类任务数。
String taskIndexLastIndexStartTime 上次索引开始时间的日期，采用 UTC 格式（ISO 8601 日期字符串）。
Integer taskIndexUpdateInterval 相邻两次任务索引更新之间的秒数。
TaskListItem[] tasks 任务列表项的列表。
Integer total 列表中的任务总数。

TaskListItem

用于表示“任务列表服务”所返回 TaskListData 对象中的任务列表项的对象。

Type属性目录
String[] actions 包含 checkActions 过滤器中指定的操作（如果适用于当前用户的任务列表项）。 如果未在 checkActions 过滤器中指定任何操作，那么将不会检查这些项的操作，并且该属性将为空。 有效值包括：ACTION_CANCELCLAIM、ACTION_CLAIM、ACTION_COMPLETE、ACTION_CREATEMESSAGE、ACTION_GETTASK、ACTION_GETUISETTINGS、ACTION_UPDATEDUEDATE、ACTION_UPDATEPRIORITY、 ACTION_REASSIGNTOUSER、ACTION_REASSIGNTOGROUP、ACTION_VIEW_TASK 和 ACTION_VIEW_TASK_DETAILS。
String assignedToTeamId 将任务分配到的团队的团队标识。
String assignedToTeamName 将任务分配到的团队的名称。
String assignedToUserFullName 将任务分配到的用户的全名。
String assignedToUserId 将任务分配到的用户的用户标识。
String closedDate 任务的关闭日期。
String dueDate 任务的到期日期。
String id 任务的标识。
Boolean isAtRisk 表明任务是否存在风险。
Integer priority 任务的优先级。
String processInstanceId 任务所属的流程实例的标识。
String processInstanceName 任务所属的流程实例的名称。
String riskState 任务所处的风险状态。
String subject 任务的主题。

TaskListProperties

该对象用作“任务列表服务”的输入以过滤或限制所返回任务的列表。

Type属性目录
String[] collapsedRiskStates 隐藏处于所列风险状态（Overdue、AtRisk、DueToday、DueTomorrow、DueThisWeek 和 DueLater）的任务，并仅返回非所列风险状态的任务。 可选字段。 如果未指定状态，那么将返回所有任务实例。
DateRangeString dueSlice 应返回哪个日期范围的任务。 可选字段。 如果未设置该字段，会返回所有任务。
Boolean includeAssignedUsers 控制是否应返回分配给列表中任务的用户列表。 可选字段。 缺省值：false。
Boolean includeRiskStateSummary 控制是否应返回包含列表中处于风险状态的任务数的映射。 可选字段。 默认值：false
String interactionFilter 仅返回与指定交互过滤器相匹配的任务。 有效值包括：ASSESS_AND_WORK_ON、ASSESS_AVAILABLE、CHECK_COMPLETED、WORK_ON。 可选字段。 如果未设置该字段，将使用 ASSESS_AND_WORK_ON。 WORK_ON：处理任务。 这意味着检索已经申领的任务。 将排除已暂挂流程实例中包含的任务。 ASSESS_AVAILABLE：评估可用任务。 这意味着检索可申领的任务。 将排除已暂挂流程实例中包含的任务。 ASSESS_AND_WORK_ON：评估和处理任务。 这意味着检索 WORK_ON 或 ASSESS_AVAILABLE 过滤器值所指示的任务。 CHECK_COMPLETED：处理任务。 这意味着检索完成的已申领任务。
String searchFilter 仅返回包含指定文本的任务。 可选字段。
String teamId 仅返回分配到给定团队标识的任务。 可选字段。 如果未设置该字段，会返回所有任务。
String userId 仅返回分配到给定用户标识的任务。 可选字段。 如果未设置该字段，会返回所有任务。

团队

该对象表示一个团队。

Type属性目录
String managerTeam 负责管理该团队的团队。
String[] members 团队中成员的列表。
String name 团队的名称。

TeamDashboard支持

仪表板 Coach 视图支持。

方法概要
TWObject*TeamRosterEntry retrieveTeamMemberList( String timezone , Boolean checkAuthorization) 检索此团队的团队成员列表及其打开和完成的任务计数。 与“团队登记簿”Coach 控件配合使用。
TeamTaskSummary retrieveTeamSummary( String searchFilter , String timeZoneAsString , Boolean checkAuthorization) 检索团队活动任务的摘要数据。
ChartData retrieveTeamTaskTrend( String units , Integer numPeriods , String endPeriod , String timezone , String searchFilter , Boolean checkAuthorization) 返回组成新任务和已完成任务的数据序列的 ChartData 对象。

TeamMemberTaskSummary

“团队成员摘要服务”返回的对象。

Type属性目录
Integer countAtRisk 针对此摘要的当前用户的风险任务数。
Integer countOnTrack 针对此摘要的当前用户的正常任务数。
Integer countOverdue 针对此摘要的当前用户的过期任务数。
String fullName 针对此摘要的当前用户的全名。
String name 针对此摘要的当前用户的名称。
Integer tasksCompletedToday 针对此摘要的当前用户今天已完成的任务数。
Integer totalOpenTasks 针对此摘要的当前用户的打开任务总数。
String userId 针对此摘要的当前用户的用户标识。

TeamRosterEntry

这些对象的列表由“团队登记簿服务”返回。

Type属性目录
String emailAddress 团队成员的电子邮件地址。
String fullName 团队成员的全名。
String jobTitle 团队成员的职位。
String name 团队成员的名称。
String phoneNumber 团队成员的电话号码。
Integer tasksCompletedToday 团队成员今天完成的任务数。
Integer totalOpenTasks 团队成员的打开任务数。
String userId 团队成员的用户标识。

TeamTaskSummary

团队的活动任务的摘要数据。

Type属性目录
Integer countAtRisk 团队存在风险的任务数。
Integer countOnTrack 团队的正常任务数。
Integer countOverdue 团队的过期任务数。
String description 团队的描述。
String name 团队的名称。
String processAppId 包含团队的流程应用程序的标识。
String processAppName 包含团队的流程应用程序的名称。
Integer tasksCompletedToday 团队今天已完成的任务数。
String teamId 团队的团队标识。
Integer totalOpenTasks 团队的打开任务总数。

TextAreaType

用于为文本区域提供选择选项的业务对象。

时间

时间类型

TimingIntervalHistoricalStatistics

此类型流程的计时时间间隔的历史统计信息。

Type属性目录
Integer averageDuration 平均计时时间间隔持续时间（以秒为单位）。
String id 计时时间间隔的标识。
String name 计时时间间隔的名称。

TWAdhocStarting点

表示特别起始点。

Type属性目录
String id 特别起始点的标识。
String name 特别起始点的名称。
TWProcessInstance processInstance 此特别起始点所属于的流程实例。
方法概要
String[] startNew() 触发特别开始事件。

TWAssetTypes

引用链接资产类型。

Type属性目录
String CHANGE_REQUEST “变更请求”资产类型。
String DEFECT “缺陷”资产类型。
String PLAN “计划”资产类型。
String PLAN_ITEM “计划项”资产类型。
String REQUIREMENT “需求”资产类型。
String REQUIREMENTS_CHANGE_REQUEST “需求变更请求”资产类型。
String REQUIREMENTS_COLLECTION “需求收集”资产类型。
String RESOURCE “资源”资产类型。
String TASK “任务”资产类型。
String TEST_CASE “测试用例”资产类型。
String TEST_EXECUTION_RECORD “测试执行记录”资产类型。
String TEST_PLAN “测试计划”资产类型。
String TEST_RESULT “测试结果”资产类型。
String TEST_SCRIPT “测试脚本”资产类型。

TWChart

报告的图表对象。 可将布局名称用作构造函数来在流程中创建图表。 已在可用的上下文中正常公开为图表变量。 不推荐使用。 请改用基于 Coach 的仪表板。

Type属性目录
Array bottomLabels 不推荐使用。 请改用基于 Coach 的仪表板。
在此图表上设置的标签的列表。
String chartType 不推荐使用。 请改用基于 Coach 的仪表板。
图表类型。
boolean hasBarSeries 不推荐使用。 请改用基于 Coach 的仪表板。
如果此图表类型采用条形图系列，那么返回 true。
boolean hasDialSeries 不推荐使用。 请改用基于 Coach 的仪表板。
如果此图表类型采用仪表板图系列，那么返回 true。
boolean hasLineSeries 不推荐使用。 请改用基于 Coach 的仪表板。
如果此图表类型采用折线图系列，那么返回 true。
boolean hasPieSeries 不推荐使用。 请改用基于 Coach 的仪表板。
如果此图表类型采用饼图系列，那么返回 true。
boolean seriesCount 不推荐使用。 请改用基于 Coach 的仪表板。
返回应用到此图表的系列的数量。
方法概要
void addBottomLabels() 不推荐使用。 请改用基于 Coach 的仪表板。
（系列）设置底部标签。
void addSeries(int index , String name , String type , Object series) 不推荐使用。 请改用基于 Coach 的仪表板。
将系列添加到图表中。 （索引、名称、类型和系列）：索引 - 此系列的索引（用于排序），名称 - 图注中使用的系列名称，类型 - 系列的类型（条形图、折线图、饼图和仪表板图），系列 - 以逗号分隔的列表、列表，以及包含此系列数据的 TWObject。
String display(int width , int height , boolean removeDemoData) 不推荐使用。 请改用基于 Coach 的仪表板。
(width, height) 显示图表。 返回所需的 HTML。
String displayCSVTable() 不推荐使用。 请改用基于 Coach 的仪表板。
显示以逗号分隔的图表数据的表。
String displayTable() 不推荐使用。 请改用基于 Coach 的仪表板。
显示图表数据的 HTML 表。
Object[] getSeriesData() 不推荐使用。 请改用基于 Coach 的仪表板。
（系列）从系列获取数据。
String getTypeName() 不推荐使用。 请改用基于 Coach 的仪表板。
返回类型的名称。
void setFeature(String feature , Object value) 不推荐使用。 请改用基于 Coach 的仪表板。
设置或更改图表的功能部件。 支持以下功能: 轴更改图表的左轴。 您可以使用 feature="auto "将其设置为 auto ，或者使用字符串自变量" fixed " 将其设置为固定轴。,,".,和必须是定义轴作用域的数字值。 标题更改图表的顶部标题 (如果有)。 值应该是标题文本。 leftLabel 更改图表的左侧标签 (如果有)。 该值应该是左侧标签的文本。 bottomLabel 更改图表的底部标签 (如果有)。 该值应该是底部标签的文本。 colorTable 更改图表的缺省颜色主题 (如果使用)。 该值是所用图表软件包所确定的颜色项的数组。 自变量可以是数组或以逗号分隔的字符串。.
void setLayout(String layoutID) 不推荐使用。 请改用基于 Coach 的仪表板。
更新图表的布局。
void setLayoutByName(String layoutName) 不推荐使用。 请改用基于 Coach 的仪表板。
通过查看当前和下面的上下文更新图表的布局。

TWDate

表示日期。 要创建此对象的新实例，请使用 "new TWDate ()"。 IBM Business Automation Workflow 日期类型表示日期和时间。 例如，2017-06-15 23:00:00:0。 如果 IBM Business Automation Workflow 服务器和用户位于不同的时区，请确保根据用户时区来调整日期。 考虑以下示例：日期时间选取器 Coach 视图的缺省时间为午夜 12:00。 当用户位于东部标准时间 (EST) 时区并且服务器位于中部标准时间 (CST) 时区时，将以 CST 返回日期。 因此，如果用户选择 6 月 16 日，返回的日期将为“6 月 15 日中午 11:00”。 要以用户时区返回日期，您必须从用户的系统（而不是从 IBM Business Automation Workflow 服务器）中选取时区。 您可以使用以下格式来实现：tw.local.date.format("2017-06-15",tw.system.user_timeZone)

方法概要
String format( String formatString , String timeZoneString) 使用提供的特定格式和时区将日期转换为字符串表示。 可选的 formatString 必须遵循为 java.text.SimpleDateFormat 类制定的语法和规则：如果省略，那么将使用“short”格式。 根据 java.util.TimeZone 中的规则，可选 timeZoneString 必须是有效时区标识。
String formatDate( String dateStyle) 使用特定格式将日期转换为字符串表示。 可选参数“dateStyle”的值可以是 short、medium、long 和 full：如果省略，那么将使用“medium”样式。
String formatDateTime( String dateStyle , String timeStyle) 使用特定格式将此日期和时间转换为字符串表示。 可选参数“dateStyle”和“timeStyle”的值可以是 short、medium、long 和 full：如果省略，那么将对这两个参数使用“medium”样式。
String formatTime( String timeStyle) 使用特定格式将时间转换为字符串表示。 可选参数“timeStyle”的值可以是 short、medium、long 和 full：如果省略，那么将使用“medium”样式。
int getDate() 以整数形式返回月份中的日期。
int getDay() 以整数形式返回一周中的第一天，其中第一天是星期日，并且等于 1。
int getDayOfWeek() 此方法返回表示指定日期的星期几的整数值。
int getFullYear() 以整数形式返回四位数的年份。
int getHours() 返回一天中的小时 (24h)。
int getMilliseconds() 返回秒内的毫秒数。
int getMinutes() 以整数形式返回小时内的分钟数。
int getMonth() 返回整数形式的月数，其中一月是第一个月且等于 0。
int getSeconds() 返回分钟内的秒数。
int getTime() 此方法返回一个整数值，表示自 1970 年 1 月 1 日午夜以来指定日期的秒数。
String getTimeString() 此方法返回一个字符串值，该值表示自 1970 年 1 月 1 日午夜以来指定日期的毫秒数。
int getTimezoneOffset() 返回 GMT 的原始偏移量 (以分钟为单位)。
int getUTCDate() 以全球标准时间 (UTC) 中的整数形式返回月份中的日期。
int getUTCDay() 以整数形式返回一周中的第一天，其中第一天是星期日，并且在全球标准时间 (UTC) 中等于 1。
int getUTCFullYear() 以全球标准时间 (UTC) 中的整数形式返回四位数年份。
int getUTCHours() 以全球标准时间 (UTC) 的整数形式返回一天中的小时。
int getUTCMilliseconds() 以全球标准时间 (UTC) 的整数形式返回秒内的毫秒数。
int getUTCMinutes() 以全球标准时间 (UTC) 中的整数形式返回小时内的分钟。
int getUTCMonth() 返回整数，其中一月是第一个月，在全球标准时间 (UTC) 中等于 0。
int getUTCSeconds() 以全球标准时间 (UTC) 的整数形式返回分钟内的秒数。
int getUTCTime() 此方法返回一个整数值，表示自 1970 年 1 月 1 日午夜 (UTC) 以来指定日期的秒数。
String getUTCTimeString() 此方法返回一个字符串值，表示自 1970 年 1 月 1 日午夜 (UTC) 以来指定日期的毫秒数。
void parse(String dateAsString , String formatString , String timeZoneString , String localeString) 通过使用提供的 formatString 和可选的 timeZoneString 和可选的 localeString 解析 dateAsString 来设置日期的值。 formatString 必须遵循为 java.text.SimpleDateFormat 类制定的语法和规则。 根据 java.util.TimeZone 中的规则（例如：“PST”、“GMT-8:00”、“America/Los_Angeles”），可选 timeZoneString 必须是有效时区标识。 根据 java.util.Locale 中的规则（例如：“en-US”、“fr-CA”），可选 localeString 必须是有效语言环境目标。
void setDate(int dayOfMonth) 将月份的日期设置为参数中提供的数字 (必须对月份有效)。
void setDay(int dayOfWeek) 将星期几设置为提供的整数 (以星期几为单位) ，其中星期日是 1 ，而星期一是第一天。
void setFullYear(int year) 将年份设置为全年中的四位数字。
void setHours(int hours) 将 24 小时制的小时设置为指定的小时值。 午夜的钟点为 0。
void setMilliseconds(int millis) 将秒内的毫秒数设置为以毫秒为单位的值。
void setMinutes(int minutes) 设置小时内的分钟数。
void setMonth(int month) 将月份设置为以月号指示的数字。 一月是第一个月，等于 0。 数字必须是有效的月份 0-11。
void setSeconds(int seconds) 将分钟内的秒数设置为以秒为单位的值。
void setTime(int time) 此方法用于根据本地时间设置 Date 对象的时间。
void setTimeFromString(String timeInString) 此方法用于根据本地时间设置 Date 对象的时间。
void setUTCDate(int dayOfMonth) 以全球标准时间 (UTC) 将月份中的日数设置为提供的月份中的日数 (对于月份必须有效)。
void setUTCDay(int dayOfWeek) 将星期几设置为以星期几提供的整数，其中星期日是 1 ，一周的第一天采用全球标准时间 (UTC)。
void setUTCFullYear(int year) 以全球标准时间 (UTC) 将年份设置为整年的四位数字。
void setUTCHours(int hours) 将 24 小时制的小时设置为以全球标准时间 (UTC) 表示的小时。 午夜的钟点为 0。
void setUTCMilliseconds(int millis) 将秒内的毫秒数设置为全球标准时间 (UTC) 中的值 (以毫秒为单位)。
void setUTCMinutes(int minutes) 以全球标准时间 (UTC) 为单位设置小时内的分钟数。
void setUTCMonth(int month) 将月份设置为以月号指示的数字。 一月是第一个月，等于 0。 数字必须是全球标准时间 (UTC) 中的有效月份 0-11。
void setUTCSeconds(int seconds) 将分钟内的秒数设置为以全球标准时间 (UTC) 为单位的值 (以秒为单位)。
void setUTCTime(int time) 此方法用于根据 UTC 时间设置日期对象的时间。
void setUTCTimeFromString(String timeInString) 此方法用于根据 UTC 时间设置日期对象的时间。
Date toNativeDate() 将 TWDate 转换为 JavaScript Date 对象。

TWDocument

表示文档。

Type属性目录
TWDocument[] allVersions 返回包含所有文档版本的数组。
String contentType 返回文档的内容类型。
String ecmId 返回可用于在服务中执行“内容集成”步骤的文档的 ECM 标识。
boolean hideInPortal 返回文档是否隐藏在门户网站中。
String id 返回文档的标识。
TWDate modificationDate 返回文档的修改日期。
TWUser modifiedBy 返回修改文档的用户。
String name 返回文档的名称。
TWProcessInstance processInstance 返回该文档所属的流程实例。
String type 返回文档的类型（TWDocument.Types.File 或 TWDocument.Types.URL）。
TWDocumentTypes Types 包含文档类型的常量值。
String uri 返回文档的文件名。
int version 返回文档的版本号。
方法概要
TWDocument addVersion(String type , String fileLocation , TWUser user , Boolean checkAuthorization , Map properties) 添加具有指定文件名 (以及 (可选) 指定用户) 的指定类型 ( TWDocument.Types.File 或 TWDocument.Types.URL) 文档的新版本。 将返回已创建的文档版本。
void deleteAllVersions( Boolean checkAuthorization) 删除此文档的所有版本。
void writeDataToFile(String filename) 如果文档的类型为 TWDocument.Types.File，那么将数据写入指定的文件名; 否则，将不执行任何操作。

TWDocumentSearch类型

可能的文档搜索类型的常量值。

Type属性目录
String All 所有属性都必须相同，才能返回文档。
String Any 任何属性都必须相同，才能返回文档。

TWDocumentTypes

文档类型的常量值。

Type属性目录
String File 文档表示文件。
String URL 文档表示 URL。

TWEvent

表示事件。 要创建此对象的新实例，请使用“new TWEvent()”。

方法概要
void send() 发送事件的方法。
int setFactory(String factory) 用于设置事件的工厂的方法。
void setSnapshotName(String snapshotName) 用于设置事件的快照名称的方法。
void setURL(String url) 用于设置事件 URL 的方法。

TWHolidaySchedule

包含假期安排的 IBM Business Automation Workflow 变量类型。

Type属性目录
Date[] dates 假期的日期列表
String id 假期安排的标识
String name 假期安排的名称

TWLink

文档部分中的引用链接。

Type属性目录
String assetType 引用链接定义的资产类型。
String assetTypeNamespace 资产类型的名称空间标识。
TWAssetTypes AssetTypes 现成资产类型列表。
String linkType 定义链接类型。
TWLinkTypes LinkTypes 现成链接类型列表。
String name 定义链接名称。
String relationshipType 此引用链接定义的关系。
String relationshipTypeNamespace 关系类型的名称空间标识。
TWRelationshipTypes RelationshipTypes 现成关系类型列表。
String url 定义链接 URL。

TWLinkTypes

引用链接类型。

Type属性目录
String FILE 文件链接类型。
String OSLC OSLC 链接类型。

TWLogger

允许将错误、警告和调试结果记录到日志文件中的帮助程序类。 在 IBM Business Automation Workflow 的所有 JavaScript 字段中，此类用作“log”变量。

Type属性目录
boolean debugEnabled 如果在 TraceSettings.properties 配置文件中启用了调试级别日志记录，那么返回“true”。
boolean infoEnabled 如果在 TraceSettings.properties 配置文件中启用了“信息”级别日志记录，那么返回“true”。
方法概要
void debug(String text) 当将 com.lombardisoftware.core.script.js.LoggerScriptable= FINE 或更高版本添加到跟踪规范时，此方法会将调试信息写入 Business Automation Workflow 服务器端跟踪日志。
void error(String text) 写入严重性为 "错误" 的日志文件。 如果在配置中设置的级别高于“错误”，那么此方法可能不会记录任何内容。
void info(String text) 写入严重性为 INFO 的日志文件。 如果在配置中设置的跟踪级别高于“信息”，那么此方法可能不会记录任何内容。
void warn(String text) 写入严重性为 WARNING 的日志文件。 如果在配置中设置的跟踪级别高于“警告”，那么此方法可能不会记录任何内容。

TWManagedFile

表示流程应用程序/Toolkit 特殊 Snapshot 的受管理文件。

Type属性目录
String id 受管文件的标识。
String name 受管文件的名称。
String path 受管理文件的相对路径。 在 IBM Business Automation Workflow 中，这与名称相同。
TWManagedFileTypes Types 返回受管文件的类型。
String url 可用于引用文件的 URL（如果类型为 Web）。
方法概要
String getTypeName() 返回类型的名称。
String readText() 读取受管文件的文本。 这假设文件是文本文件而不是二进制文件。 如果文件是二进制文件，那么此调用可能会发生转换错误而失败，或者可能成功但返回乱码。 应考虑在高性能运行时情况中使用此调用。 注释：因为文件的整个文本都将装入到内存，因此建议不要对大型文件使用此操作。
void writeDataToFile(String newFileLocation) 将数据 (文本或二进制) 保存到给定位置。 当文件需要在安装期间存储在本地服务器上时，此函数会很有用。

TWManagedFile类型

包含受管文件类型的常量。

Type属性目录
String Design 表示诸如 XSL 等可与 Coach Designer 关联的文件的常量。
String Server 表示诸如 JAR 和 JavaScript 等可在服务器端脚本中使用的文件的常量。
String Web 表示诸如 PNG、JPEG、CSS 和 HTML 等可在浏览器中用于表示 UI 的文件的常量。

TWModelNamespace

“tw.system.model”对象包含用于获取模型对象的有用函数。

Type属性目录
TWEnvironmentNamespace env 环境变量名称空间。
TWSearchMetaData fullTextSearchMetaData 获取搜索索引中提供的可搜索字段。
TWProcessApp processApp 当前流程应用程序。
TWProcessAppSnapshot processAppSnapshot 当前的流程应用程序 Snapshot。
TWSearchMetaData searchMetaData 有关可用于搜索的列的信息。
方法概要
TWManagedFile findManagedFileByPath(String managedFilePath , String managedFileType) 返回给定其文件路径和受管文件类型 (例如， Web 或服务器) 的受管文件。 从流程应用程序开始，然后查找到其 Toolkit。
TWProcess findProcess(String bpdId , String processAppId) 返回使用进程标识找到的进程。
TWProcessApp findProcessAppByAcronym(String processAppAcronym) 返回具有给定 Acronym 的流程应用程序。
TWProcessApp findProcessAppByID(String processAppID) 返回具有给定标识的流程应用程序。
TWProcessApp findProcessAppByName(String processAppName) 返回具有给定名称的流程应用程序。
TWProcess findProcessByName(String processName) 返回正在运行的脚本的当前快照作用域中具有指定名称的流程。
TWService findServiceByName(String serviceName) 返回正在运行的脚本的当前快照作用域中具有指定名称的服务。
TWProcessApp[] getAllProcessApps( boolean includeToolkits) 返回系统中所有流程应用程序的数组 (可选) ，包括 Toolkit。
TWProcessApp[] getAllToolkits() 返回系统中的所有 Toolkit。

TWObject

TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].

Type属性目录
int arrayLength 不推荐使用。 不推荐使用 arr.arrayLength 。 请改为使用 arr.listLength 。
返回此对象列表属性的长度。
int length 不推荐使用。 不推荐使用 arr.length 。 请改为使用 arr.listLength 。
返回此对象列表属性的长度。
#[] listAllSelected 返回此数组中所有所选项的数组。 项按顺序返回，这样最近选择的项位于位置 0，最初选择的项位于结尾。
int[] listAllSelectedIndices 返回此数组所有所选索引的数组。 索引按顺序返回，这样最近选择的索引位于位置 0，最初选择的索引位于结尾。
int listLength 返回此对象列表属性的长度。
# listSelected 返回数组中最近选定的项，如果没有选定项，那么返回未定义。
int listSelectedIndex 返回数组中最近所选项的索引，如果没有所选索引，那么返回 -1。
String[] propertyNames 以数组返回此对象中定义的属性名称。
Object[] propertyValues 以数组形式返回此对象中定义的属性值。
方法概要
[init]( String version) 构造函数。 例如：var v = new tw.object.MyObject();
Array arrayToNativeArray() 不推荐使用。 不推荐使用 arrayToNativeArray 。 请改为使用 listToNativeArray 。
将此 TWObject 数组转换为本机 JavaScript 数组对象。
XMLElement describe() 返回与此对象关联的属性和结构的 xml 结构。 这对调试很有用。
Object getPropertyValue(String name) 返回指定属性的值。
String getTypeName() 返回类型的名称。
void insertIntoArray(int position , Object object) 不推荐使用。 改为使用 insertIntoList ()。
将值添加到特殊位置的列表。 应该重新调整列表大小以适合对象。
void insertIntoList(int position , Object object) 在特定位置向列表添加值。 应该重新调整列表大小以适合对象。
boolean isDirty() 如果在此 TWObject 或任何包含的 TWObject 中设置了元数据 isDirty 标志，那么返回 true。
void listAddSelected(int index) 从所选项列表中添加项。
void listClearAllSelected() 从选择列表中除去所有项。
boolean listIsSelected(int index) 如果选择了项索引，那么返回 true ，否则返回 false。
void listRemoveSelected(int index) 从所选项列表中除去项。
Array listToNativeArray() 将此 TWObject 数组转换为本机 JavaScript 数组对象。
void load( String key) 从数据库装入此共享业务对象的当前版本。 如果指定了键，那么装入由该键定义的共享业务对象的当前版本。 无法使用键参数为案例文件夹装入共享业务对象。
Object metadata(String key) 返回指定键的元数据字段的值。 （示例：“shared”返回布尔值，“key”返回字符串，“version”返回 BigInteger，“isDirty”返回布尔值）
void removeIndex(int listIndex) 从列表中除去值。 将重新调整列表大小以适合其余对象。
void removeProperty(String propertyName) 从此对象中除去属性。
void save() 将此共享业务对象持久存储到数据库中。
void setPropertyValue(String name , Object value) 设置属性的值。
String toJSONString( boolean formatted) 返回对象的 JSON 表示。
String toString() 返回对象的字符串表示。
XMLElement toXML() 返回与此对象关联的属性的 xml 结构。
String toXMLString() 将 XML 结构作为与此对象关联的属性的字符串返回。

TWObjectContent对象

TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].

TWObjectContentObjectActivity

TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].

TWObjectContentObjectCase

TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].

TWObjectProperty

TWObject 可以具有许多属性，具体视其设置而定。 它们都可以通过执行对象进行访问。或对象 [""].

TWParticipantGroup

包含访问团队的有用方法。

Type属性目录
TWUser[] allUsers 返回作为团队直接或间接成员的所有用户的列表。
TWRole associatedRole 返回参与者组的关联角色。
String id 返回参与者组的标识。
String name 返回参与者组的名称。
TWProcessApp processApp 返回参与者组的流程应用程序。
TWRole[] roles 返回作为团队直接成员的角色列表。
TWProcessAppSnapshot snapshot 返回参与者组的流程应用程序。
TWUser[] users 返回作为团队直接成员的用户列表。
方法概要
void addRoles(TWRole roles) 将角色添加到角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void addUsers(TWUser users) 将用户添加到角色。 接受 TWUser、TWUser[]、String 和 String[] 作为输入。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
String getTypeName() 返回类型的名称。
boolean hasUser(TWUser user) 如果用户是成员，那么返回 true。 接受用户名或 TWUser 对象。
void refresh() 刷新关联的运行时角色成员资格。 注释：使用添加/移除函数，可自动完成此操作。
void removeRoles(TWRole roles) 从角色中除去角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void removeUsers(TWUser users) 从角色中除去用户。 接受 TWUser、TWUser[]、String 和 String[] 作为输入。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。

TWProcess

表示 BPD。

Type属性目录
TWObject*ConditionalActivity conditionalActivities 当前 BPD 中条件活动的分层列表。
String description BPD 的描述。
TWSearchMetaData fullTextSearchMetaData 获取 BPD 的可搜索字段。
String guid 此业务流程的 GUID。
String id BPD 的标识（标识的外部化形式）。
TWLink[] links 文档中的引用链接。
String name BPD 的名称。
TWProcessPerformanceMetric performanceMetrics 提供对“流程性能指标”对象的访问权，可按照“公开”性能指标中定义的那样来访问这些对象。
TWObject*Phase phases 为流程定义的阶段/里程碑。
TWProcessApp processApp 实例的流程应用程序/Toolkit。
TWSearchMetaData searchMetaData 有关可用于搜索的列的信息。
TWObject*Step steps 为流程定义的步骤/流对象。 注：项目中需要包含“仪表板”Toolkit 才能使用此功能。
方法概要
String getTypeName() 返回类型的名称。
BPMExposedItem[] retrieveExposedProcesses() 检索可用公开流程的列表。
TWProcessInstance startNew( Map inputParams , Boolean checkAuthorization) 启动流程实例。

TWProcessApp

流程应用程序/Toolkit 对象。

Type属性目录
String acronym 流程应用程序或 Toolkit 的首字母缩略词。
TWProcessInstance[] activeInstances 此 Snapshot 的所有活动实例的数组。
TWProcessAppSnapshot currentSnapshot 当前执行或安装的当前流程应用程序的 Snapshot。
TWProcessAppSnapshot defaultSnapshot 指定流程应用程序的缺省 Snapshot。 如果设置了此属性，那么它将更改 Process Portal 中的缺省 Snapshot。
String id 流程应用程序或 Toolkit 的标识（外部化标识）。
boolean isToolkit 返回布尔值；如果流程应用程序表示可复用的 Toolkit，那么为 true，否则为 false。
TWLink[] links 文档中的引用链接。
String name 流程应用程序或 Toolkit 的名称。
TWProcessAppSnapshot[] snapshots 返回 Teamworks Process Server 或 Process Center 上当前流程应用程序的所有 Snapshot 的 JavaScript 数组。 如果在 Process Center 上，将排除已归档的 Snapshot。 此列表按 Snapshot 创建日期从旧到新的顺序返回 Snapshot。
方法概要
TWProcessAppSnapshot findSnapshotByAcronym(String snapshotAcronym) 按首字母缩略词返回此 Process App 的 Snapshot。
TWProcessAppSnapshot findSnapshotByID(String snapshotID) 返回此 Process App 的快照 (按其标识)。
TWProcessAppSnapshot findSnapshotByName(String snapshotName) 返回此 Process App 的快照 (按其名称)。
TWLink[] getLinks( boolean includeReferencedToolkits , function linkFilter) 返回流程应用程序中经过过滤的链接列表。 如果 includeReferencedToolkits 为 true，那么还会列出子库元素和被引用 Toolkit 元素上的链接。 如果不设置 includeReferencedToolkits，那么它缺省为 false，并仅返回当前流程应用程序的链接。 linkFilter 函数充当针对链接列表的过滤器。 该过滤器函数接受 TWLink 参数并返回布尔值。 如果过滤器求值为 true，那么将过滤掉该链接。 该函数的样本用法如下：var twFilter = function (twLink) { if (condition on twLink) {return true;} else {return false;} } var links = getLinks (true, twFilter)；注：如果调用来自其他流程应用程序的上下文，那么只能获得此流程应用程序的链接。 该过滤列表不包含任何子代。
String getTypeName() 返回类型的名称。

TWProcessApp缺省值

包含此版本流程应用程序/Toolkit 的缺省值。

Type属性目录
TWManagedFile coachCSS 缺省 Coach CSS。
TWManagedFile coachTransformXSL 缺省 Coach Designer 变换 XSL。
TWLink[] links 文档中的引用链接。
方法概要
String getTypeName() 返回类型的名称。

TWProcessApp快照

流程应用程序 Snapshot 对象。

Type属性目录
String acronym Snapshot 的首字母缩略词。
TWProcessInstance[] activeInstances 此 Snapshot 的所有活动实例的数组。
TWDate dateCreated Snapshot 的创建日期。
TWDate dateInstalled Snapshot 的安装日期。 此 API 没有实现。 请改为使用 dateCreated。
TWProcessAppDefaults defaultSettings 缺省流程应用程序/Toolkit 设置。
String id Snapshot 的标识。
boolean isActive Snapshot 是否处于活动状态。
TWLink[] links 文档中的引用链接。
String name Snapshot 的名称。 在 Process Center 环境中，在 Current (TIP) Snapshot 上调用将返回空值。
TWProcessApp processApp 此 Snapshot 的流程应用程序/Toolkit。
方法概要
void activate() 如果 Process App 处于不活动状态并且不是 Toolkit ，那么将其激活，否则将被忽略。
void deactivate() 如果 Process App 处于活动状态并且不是 Toolkit ，那么将其取消激活，否则将被忽略。
TWManagedFile findManagedFileByPath(String managedFilePath , String managedFileType) 返回给定其文件路径和受管文件类型 (例如， Web 或服务器) 的受管文件。
TWParticipantGroup findParticipantGroupByName(String participantGroupName) 按名称查找参与者组。
TWProcess findProcessByName(String processName) 使用关联 Snapshot 对象作用域中的名称来查找流程。 如果找不到流程，那么搜索将扩展到正在运行的脚本的当前 Snapshot 作用域。
TWService findServiceByName(String serviceName) 使用关联快照对象作用域中的名称来查找服务。 如果找不到服务，那么搜索将扩展到正在运行的脚本的当前 Snapshot 作用域。
TWService findServiceByNameInSnapshot(String serviceName) 使用关联快照对象作用域中的名称来查找服务。
TWTeam findTeamByName(String teamName) 查找具有其名称的团队。
ECMServer[] getECMServers( Boolean checkAuthorization) 获取当前快照的类型为 "ECM" 的所有服务器的列表。
String[] getEnvironmentVariableNames() 获取当前快照中定义的环境变量的名称列表。
String getTypeName() 返回类型的名称。

TWProcessInstance

表示流程实例。

Type属性目录
TWAdhocStartingPoint[] adhocStartingPoints 流程实例上当前可用的所有特别起点的 JavaScript 数组。
TWDate atRiskDate 实例的风险日期。
Map businessData 实例的业务数据。 注：此业务数据包括公开的业务数据以及可变数据。 此外，如果业务数据包含列表，并且选择了列表中的某个项，那么将仅返回所选项。 如果没有选择任何项，那么将返回整个列表。 如果要更改此行为，那么需要在 100Custom.xml 服务器配置中将 server -> bpd-engine -> instance-variable-data-return-list 设置为 true。
String caseFolderId 不推荐使用。 请改为使用 processInstanceFolderId 。
与流程实例关联的案例文件夹的标识。
String caseFolderServerName 不推荐使用。 请改为使用 processInstanceFolderServer名称。
与流程实例关联的服务器的名称。
TWDate closeDatetime 关闭日期。
TWDocument[] documents 与实例关联的所有文档的 JavaScript 数组。
TWDocumentSearchTypes DocumentSearchTypes 包含可能文档搜索类型的常量值。
TWDate dueDate 到期日期。
String id 实例的标识（标识的外部化形式）。
boolean isAtRisk 实例存在风险时的实例状态。
TWDate lastModifiedDatetime 上次修改日期。
TWLink[] links 文档中的引用链接。
String name 实例的名称。
TWProcessInstanceParentCase parentCase 与实例关联的父案例。
TWProcess process 实例的 BPD。
TWProcessApp processApp 实例的流程应用程序/Toolkit。
String processInstanceFolderId 与流程实例关联的案例文件夹的标识。
String processInstanceFolderServerName 与流程实例案例文件夹关联的服务器的名称。
String[] selectedConditionalActivities 已选择条件活动的列表。 可以为 null 且可以设置。
String sharepointSiteURL SharePoint 站点 URL。
TWProcessAppSnapshot snapshot 实例的特定 Snapshot。
TWDate startDate 实例的创建时间。
String startingDocumentId 使实例启动的文档的标识。
String startingDocumentServerName 与实例关联的服务器的名称。
String status 流程实例的当前状态。
TWProcessInstanceStatuses Statuses 状态的类型。
TWTask[] tasks 实例的所有任务的 JavaScript 数组。
PathStep traversedPath 实例的遍历路径。 注：项目中需要包含“仪表板”Toolkit 才能使用此功能。
String workflowApplication 与实例关联的工作流程应用程序。
方法概要
void abort() 异常中止实例。 注：如果想要异常中止从中调用它的正在运行的实例，请勿使用此方法。 请使用“终止结束事件”节点代替。
void addComment(String comment) 向实例添加注释。
BPMRelationship addDependencyOnProcess(String processInstanceId , String description , Boolean checkAuthorization) 添加从属关系，在此关系中，当前实例将依赖于传递到方法中的实例。 此关系阻止当前流程实例完成，直到其所依赖于的实例完成为止。
BPMRelationship addDependentProcess(String processInstanceId , String description , Boolean checkAuthorization) 添加从属关系，其中传递到方法中的实例将依赖于当前流程实例。 此关系阻止从属流程实例完成，直到当前流程实例完成为止。
TWDocument addDocument(String type , String name , String fileLocation , boolean hideInPortal , TWUser createdBy , Map properties , Boolean checkAuthorization) 向实例添加文档。 如果类型为 TWDocument.Types.File，那么 fileLocation 应引用服务器上的文件，否则它应引用 URL。 将返回已创建的文档。
BPMRelationship addRelatedProcess(String processInstanceId , String description , Boolean checkAuthorization) 添加当前实例与传递到方法中的实例之间的独立关系。 返回可编写脚本的 Relationship 对象。
String createCase(String caseType , Record caseProperties , String[] caseStructure) 为指定的案例类型创建案例的新实例。 返回新案例的标识。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
String createCaseUsingSpecifiedCaseType(String caseType , String[] casePropertyNames , String[] casePropertyValues , String[] caseStructure) 为指定的案例类型创建案例的新实例。 返回新案例的标识。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
TWAdhocStartingPoint findAdhocStartingPointByID(String adhocStartingPointID) 查找特别活动，以便可以启动该活动。
TWAdhocStartingPoint findAdhocStartingPointByName(String adhocStartingPointName) 查找特别活动，以便可以启动该活动。
TWDocument[] findDocuments(Map properties , String searchType) 查找并返回与给定属性匹配的实例文档的 JavaScript 数组。
String[] getAvailableActions( String[] actionsFilter) 返回针对指定用户的实例的可用操作列表。
TWProcessInstance[] getDependedOnProcesses( Boolean checkAuthorization , String[] statusFilter) 返回当前流程实例所依赖的流程实例的列表。
TWProcessInstance getDependentProcess( Boolean checkAuthorization) 返回依赖于当前流程实例的流程实例。
TWProcessInstance[] getRelatedProcesses( Boolean checkAuthorization , String[] statusFilter) 返回与当前流程实例具有独立关系的流程实例的列表。
BPMRelationship[] getRelationships( Boolean checkAuthorization) 返回与流程实例关联的关系的列表。
String getRepositoryName(String serverId) 检索匹配服务器的存储库名称
String getTypeName() 返回类型的名称。
void migrateTo(TWProcessAppSnapshot snapshot) 将实例迁移到指定的快照。 不推荐使用此方法。 请使用 migrateWithContextTo 代替。
void migrateWithContextTo(TWProcessAppSnapshot snapshot) 将实例及其上下文迁移到指定的快照。 使用此方法与从 Process Admin 控制台迁移动态数据的效果相同。
void migrateWithPolicyTo(TWProcessAppSnapshot targetSnapshot , String policyFileUrl) 将实例及其上下文迁移到指定的快照，并应用孤标记策略文件。 使用此方法与从 Process Admin 控制台迁移动态数据的效果相同。
void overrideProjectedPathStep(ProjectedPathLinkChange[] listOfLinkChanges) 根据一组新步骤更改实例的预计路径。
void removeDependedOnProcessRelationship(String processInstanceId , Boolean checkAuthorization) 除去当前实例与其所依赖的实例之间的从属关系。
void removeDependentProcessRelationship(String processInstanceId , Boolean checkAuthorization) 除去当前实例与从属实例之间的从属关系。
void removeRelatedProcessRelationship(String processInstanceId , Boolean checkAuthorization) 除去当前实例与传递到方法中的实例之间的独立关系。
void resetAtRiskDate() 重置实例的风险日期，并恢复到自动风险计算。
void resume() 恢复实例，无论是已暂挂还是处于失败状态。
ActivityListData retrieveActivityList(ActivityListProperties properties , Integer maxRows , Integer beginIndex , Boolean checkAuthorization) 根据给定的属性返回活动列表。
Stream retrieveInstanceStream( String sortOrder , String page , String pageSize , TWDate sinceDateTime , Boolean filterStreamForGantt) 检索 bpd 实例的流条目。
ProjectedPathStep retrieveProjectedPath( String searchFilter , ProjectedPathStepChange[] listofPreviewStepChanges , ProjectedPathTaskChange[] listofPreviewTaskChanges , ProjectedPathLinkChange[] listofPreviewLinkChanges) 检索实例的预计路径。
InstanceTasksData retrieveTaskList(InstanceTasksProperties properties , Integer maxRows , Integer beginIndex , String timezone , Boolean checkAuthorization , Boolean excludeSystemTasks) 返回任务列表。
void sendHelpRequest(String sendTo , String description) 向给定用户/组发送帮助请求。
void setOwners( String groupId , String teamName , Boolean checkAuth) 设置流程实例所有者。 指定 groupId 或 teamName。
void suspend() 暂挂实例。
void updateFutureStep(ProjectedPathStepChange[] listOfStepChanges) 更新一组未来步骤的预期 duedate ， priority 或 duration。

TWProcessInstanceParentCase

表示与流程实例关联的父案例。

Type属性目录
String caseId 与实例关联的父案例标识。
String caseServerId 与父案例实例关联的服务器的标识。 该标识不打算向最终用户显示。
String parentActivityId 与流程实例关联的父活动标识。
方法概要
String addCommentToCase(String comment) 向父案例添加注释。 返回新注释的 GUID。
String addCommentToParentActivity(String comment) 向父案例中的父活动添加注释。 返回新注释的 GUID。
String completeCurrentStage() 完成父案例阶段并前进到下一个案例阶段 (如果存在下一个案例阶段)。 返回下一个案例阶段的名称，下一个阶段是新父案例阶段。 如果不存在下一个案例阶段，那么该字符串包含“CmAcmComplete”。
void createCasePackage(String casePackageName , Map packagingOptions) 创建包含由打包选项指定的案例工件的包，并将该包存储在案例文件夹中。
String createCaseUsingSameCaseType(String[] casePropertyNames , String[] casePropertyValues , String[] caseStructure) 使用相同的案例类型创建新的案例实例。 返回新案例的标识。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void createDefaultCasePackage(String casePackageName) 创建包含所有案例相关工件的包，并将该包存储在案例文件夹中。
String createDiscretionaryActivity(String discretionaryActivityName , Boolean asAdministrator , String newActivityName) 创建自主活动类型的新活动实例。 此自主活动必须在同一个解决方案内定义。 返回新活动的标识。
String createDiscretionaryActivityWithProps(String discretionaryActivityName , String[] activityPropertyNames , String[] activityPropertyValues , String[] processInputNames , String[] processInputValues , Boolean asAdministrator , String newActivityName) 创建具有指定属性的自主活动类型的新活动实例。 返回新活动的 GUID。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
String createSubfolder(String subfolderPath , Boolean asAdministrator , String subfolderClass) 在父案例文件夹下创建子文件夹。 返回新子文件夹标识。
String disableSpecifiedCaseStage(String stageId) 从定义的案例阶段列表中禁用指定的案例阶段。 如果已成功禁用指定的案例阶段，那么返回下一个案例阶段的名称。 如果未成功禁用案例阶段，那么返回空字符串。
String enableSpecifiedCaseStage(String stageId) 允许指定的案例阶段返回到现有案例阶段的列表。 必须更早禁用指定的案例阶段。 如果成功启用了案例阶段，那么将返回已启用的案例阶段的名称。 如果无法启用阶段，那么将返回空字符串。
String executeRule(String ruleName , String[] parameterNames , String[] parameterValues) 运行当前案例的业务规则。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void fileDocumentInCase(String documentId , String subFolderPath) 将文档归档到当前案例下的指定子文件夹。
String[] getActivityPropertyValue(String activityGUID , String[] activityPropertyNames) 对于指定的活动标识，它将返回给定活动属性名称列表的活动属性值的字符串列表。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
String getCaseCalendarEvents() 返回案例上定义的所有日历事件的 JSON 字符串。 如果案例中未定义任何日历事件，那么将返回空字符串。
String[] getCasePropertyNames() 返回案例中属性的符号名称列表 (唯一标识)。
String[] getCasePropertyValues(String[] casePropertyNames) 返回父案例的属性值列表。 您可使用此函数返回的值来设置新案例的值。 如果新案例的案例类型与您为此函数指定的类型不同，那么属性名称和值可能不匹配。 仅限两个案例类型之间共享的案例属性的值才可匹配。 未共享的案例属性的值在新案例中为空白。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
String[] getCaseStructure() 返回给定案例的案例结构。 将以文件夹名称和文档序列标识的列表形式返回该结构，但排除任何空文件夹。 通常，在调用 createCase 函数前通过调用该函数即可获取案例结构。 CaseStructure 值为字符串列表，包含的案例结构为“folder_path/=doc_version_series_ID”格式的字符串。
String getCurrentStage() 返回当前父案例阶段的名称。 如果案例中未定义任何阶段，那么将返回空字符串。 如果完成案例中的所有阶段，那么将返回字符串“CmAcmComplete”。
String[] getParentActivityPropertyNames() 返回活动的属性符号名称 (唯一标识) 的列表。
String[] getParentActivityPropertyValues(String[] activityPropertyNames) 返回父活动的给定活动属性名称列表的活动属性值列表。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
String placeCurrentStageOnHold() 使当前父案例阶段处于暂挂状态，并返回当前父案例阶段的名称。
String relateCase(String relateTargetId , String relateDescription , String relationshipCategory , Boolean twoWayRelationship) 创建父工作案例与目标案例之间的关系。 返回新关系的标识。
String releaseCurrentOnHoldStage() 发布当前父案例阶段的暂挂，并返回当前父案例阶段的名称。
String restartPreviousStage() 重新启动先前的父案例阶段，并返回先前案例阶段 (即新的父案例阶段) 的名称。 如果没有上一案例阶段，那么该字符串包含当前案例阶段的名称。
String[] searchActivities( String[] activityTypes , String propertyFilter) 使用提供的属性过滤条件在指定案例中搜索活动。 它返回与条件匹配的活动标识的字符串列表。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void setActivityPropertyValues(String activityGUID , String[] activityPropertyNames , String[] activityPropertyValues) 设置指定活动的活动属性值。 通常，当您更新除父活动以外的活动的属性时，此方法适用。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void setCasePropertyValues(String[] casePropertyNames , String[] casePropertyValues) 设置父案例中指定案例属性的值。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void setParentActivityPropertyValues(String[] activityPropertyNames , String[] activityPropertyValues) 设置父活动的活动属性。 对于父活动，可使用步骤参数来设置活动属性。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
void terminateActivities() 终止父案例中的所有工作流程 (活动)。 仅终止尚未完成但未失败的活动。 注: 只能从服务流 (而不是流程) 调用此函数。
void unrelateCase(String relationshipId , String unrelateDescription) 除去与父案例的指定关系。

TWProcessInstance状态

表示 TWProcessInstance 状态的常量。

Type属性目录
String Active BPD 实例处于活动状态。
String Completed BPD 实例已完成。
String DidNotStart 由于启动消息事件条件返回了 false，因此 BPD 实例未启动。
String Failed BPD 实例由于运行时错误而失败。
String Suspended BPD 实例已暂挂。
String Terminated BPD 实例已终止。

TWProcessPerformance度量

要访问“流程性能指标”对象方法，用户必须具有在“公开”性能指标中定义的访问权。

方法概要
ActivitySummary[] retrieveActivitySummaries( String searchFilter , Boolean checkAuthorization) 返回当前 bpd 的活动摘要列表。
ChartData retrieveInstanceTrend( String units , Integer numPeriods , String endPeriod , String timezone , String searchFilter , boolean checkAuthorization) 返回组成新实例和已完成实例的数据系列的 ChartData 对象。
ProcessHistoricalStatistics retrieveProcessHistoricalStatistics(ProcessHistoricalStatisticsProperties properties , Boolean checkAuthorization) 检索流程统计信息 (例如，平均实例持续时间) 以及 (可选) 与流程中的任务和计时时间间隔相关的统计数据。
ProcessInstanceListItem[] retrieveProcessInstanceList(ProcessInstanceListProperties properties , Boolean checkAuthorization) 返回 ProcessInstanceListItem BOs 的列表，这些 BOs 表示与过滤条件匹配的流程实例的列表
ProcessSummary retrieveProcessSummary( String searchFilter , Boolean checkAuthorization) 返回当前 bpd 的进程摘要计数。

TWProcessStep信息

提供有关 BPD 中当前流程步骤的信息。

Type属性目录
int counter 多实例中的计数器。 仅在多实例步骤中可用。
XMLElement error 来自异常的错误消息。 仅在发布异常事件时发生。
String guid 当前步骤 GUID。
int id 当前步骤标识。
boolean isConditionalActivitySelected 当前活动为条件活动时是否已选择该活动。 如果不是条件活动，那么始终为 true。
TWLink[] links 描述不适用
String name 当前步骤名称。
TWProcessInstance processInstance 父流程实例。
TWTask task 已附加的任务活动。 仅在发布任务活动和连接到任务活动的事件时可用。
String taskId 不推荐使用。 true
附加任务活动的任务旧标识。 仅在发布任务活动和连接到任务活动的事件时可用。
TWTimerInstance timer 当前计时器。 此属性仅对计时器事件有效。
String timerId 不推荐使用。 true
当前计时器旧标识。 此属性仅对计时器事件有效。
方法概要
String getTypeName() 返回类型的名称。

TWRelationshipTypes

引用链接的链接类型。

Type属性目录
String AFFECTED_BY 关系类型“受影响”。
String IMPLEMENTS 关系类型“实施”。
String RELATED_TO 关系类型“相关”。
String RESOLVES 关系类型“解析”。
String USES 关系类型“使用”。

TWReport

从此对象，您可以访问报告定义的各方面。 不推荐使用。 请改用基于 Coach 的仪表板。

Type属性目录
Object epv 不推荐使用。 请改用基于 Coach 的仪表板。
与报告关联的公开流程变量的存取器对象。
boolean isEmbedded 不推荐使用。 请改用基于 Coach 的仪表板。
返回一个布尔值以指示页面是否内嵌在计分板中（仅在页面内有效）。
String name 不推荐使用。 请改用基于 Coach 的仪表板。
报告的名称。
String pageName 不推荐使用。 请改用基于 Coach 的仪表板。
当前呈现页面的页面名称（仅在页面内有效）。
方法概要
String applyFilter(String filterName , String value) 不推荐使用。 请改用基于 Coach 的仪表板。
设置过滤器的值并返回新值。
String createPageLink(String reportPageName , String linkText) 不推荐使用。 请改用基于 Coach 的仪表板。
(pageName, linkText) 创建 HTML，您可以单击 "linkText" 到达 pageName。 如果为嵌入页面，那么这返回的内容与 createPageLinkInNewWindow() 相同。
String createPageLinkInNewWindow(String reportPagename , String linkText) 不推荐使用。 请改用基于 Coach 的仪表板。
返回 HTML 链接以在新窗口中打开给定的报告页面。
String displayDefaultPage() 不推荐使用。 请改用基于 Coach 的仪表板。
返回以 HTML 呈现的缺省页面。
String displayPage(String reportPageName) 不推荐使用。 请改用基于 Coach 的仪表板。
准备并返回给定报告页面的 HTML。
TWReport getByName(String reportName) 不推荐使用。 请改用基于 Coach 的仪表板。
根据名称返回报告对象。
TWChart getChartInstance(String chartName) 不推荐使用。 请改用基于 Coach 的仪表板。
检索在指定报告图表之后设置的 TWChart 实例。
Array getFilterParameters() 不推荐使用。 请改用基于 Coach 的仪表板。
返回所有当前参数的列表。
String getFilterValue(String filterName) 不推荐使用。 请改用基于 Coach 的仪表板。
返回过滤器值。
String getPageId(String reportPageName) 不推荐使用。 请改用基于 Coach 的仪表板。
返回给定报告页面的标识。
String getPageURL(String reportPageName) 不推荐使用。 请改用基于 Coach 的仪表板。
返回给定报告页面的 URL。
String getPortalPageURL(String reportPageName) 不推荐使用。 请改用基于 Coach 的仪表板。
返回给定报告页面的门户网站 URL。
String getTypeName() 不推荐使用。 请改用基于 Coach 的仪表板。
返回类型的名称。
String linkPageInNewWindowURL() 不推荐使用。 请改用基于 Coach 的仪表板。
返回其他目标中的链接。
String linkPageURL() 不推荐使用。 请改用基于 Coach 的仪表板。
返回其他报告页面的链接。 如果为嵌入页面，那么它返回的内容与 linkPageInNewWindowURL(pageName) 相同。
void removeFilterValue(String filterName) 不推荐使用。 请改用基于 Coach 的仪表板。
移除过滤器值。 将使用缺省值。
void setFilterValue(String filterName , String value) 不推荐使用。 请改用基于 Coach 的仪表板。
设置过滤器值。

TWReportFilter

仅报告过滤器布局中存在此对象。 它用于提供报告过滤器的运行时和作者集值的访问权。

Type属性目录
String content 此过滤器替换的原始内容。 在 where 子句过滤器中，这通常是要打开和关闭的实际 where 子句。 在替代文本过滤器中，这通常是缺省值。
String defaultValue 提供给报告数据源中此过滤器的缺省值。
String label 提供给报告数据源中此过滤器的标签。
String name 报告过滤器的名称。 这是 report.applyFilter() ， report.setFilterValue() 和 report.getFilterValue() 使用的名称。 它是在此过滤器所连接的报告数据源中设置的。 请勿将此与布局名称混淆。
String value 从缺省值、手动设置的报告过滤器值或提供给此过滤器的 HTML 页面值提供的当前值。

TWRole

包含访问角色的有用方法。 角色在 JavaScript API 中用作组的同义词。

Type属性目录
TWObject*TWUser allUsers 此角色的所有用户及其包含的角色等的用户的 JavaScript 数组。 这应该清除列表，以便用户无论处于多少角色都只显示一次。 此外，外部安全组中的所有用户都应该拖入此列表中，无论这些用户是否已登录。
TWObject*TWRole children 不推荐使用。 使用 TWRole 对象上的 managedTeamRoles 属性
返回角色的直接子代。
TWObject*TWRole containerRoles 返回此角色所属的角色列表。
int id 返回角色的标识。
TWObject*TWRole managedTeamRoles 此角色管理的团队的 JavaScript 数组。
String name 返回角色的名称。
TWRole parent 不推荐使用。 使用 TWRole 对象上的 teamManager角色属性
返回角色的父代。
TWObject*TWRole roles 如果角色不表示 LDAP 组，那么将返回角色的角色成员。 否则，返回空数组。
TWRole teamManagerRole 返回我的团队业绩的管理员角色。
TWObject*TWUser users 返回角色的用户成员。
方法概要
void addRoles( TWRole roles , TWRole[] roles , String roles , String[] roles) 将角色添加到角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void addUsers( TWUser users , TWUser[] users , String users , String[] users) 将用户添加到角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
TWRole[] getChildren() 不推荐使用。 使用属性子代
返回角色的直接子代。
int getId() 不推荐使用。 使用属性标识
返回角色的标识。
String getName() 不推荐使用。 使用属性名
返回角色的名称。
TWRole getParent() 不推荐使用。 使用属性 parent
返回角色的父代。
String getTypeName() 返回类型的名称。
TWUser[] getUsers() 不推荐使用。 使用属性用户
返回角色的成员。
void remove( Boolean checkAuthorization) 删除内部组类型的 TWRole 对象。 注：您无法删除已分配任务的组，或者在 BPMServerSecurityGroups 配置中配置为 bpmAdminGroup 的组。
void removeRoles( TWRole roles , TWRole[] roles , String roles , String[] roles) 除去角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void removeUsers( TWUser users , TWUser[] users , String users , String[] users) 从角色中除去用户。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。

TWSavedSearch

表示已保存的搜索对象。

Type属性目录
String id 已保存的搜索的标识。
String name 保存的搜索名称。
TWSearch search 表示实际搜索对象的搜索对象。
方法概要
String getTypeName() 返回类型的名称。

TWScoreboard

表示计分板对象。 不推荐使用。 请改用基于 Coach 的仪表板。

Type属性目录
String id 不推荐使用。 请改用基于 Coach 的仪表板。
计分板的标识。
String name 不推荐使用。 请改用基于 Coach 的仪表板。
计分板的名称。
String systemID 不推荐使用。 请改用基于 Coach 的仪表板。
计分板的系统标识。
String url 不推荐使用。 请改用基于 Coach 的仪表板。
计分板的 URL。
方法概要
String getTypeName() 不推荐使用。 请改用基于 Coach 的仪表板。
返回类型的名称。

TWSearch

包含搜索的属性和方法。

Type属性目录
TWSearchColumn[] columns 要在搜索中返回的列的数组。
TWSearchCondition[] conditions 要在搜索中使用的条件的数组。
TWSearchOptions options 用于更改搜索行为的选项。
TWSearchOrdering[] orderBy 用于搜索结果的排序数组。
TWSearchOrganizeByTypes OrganizeByTypes 返回按常量组织的搜索结果。
String organizedBy 如何组织搜索（任务或流程实例）。 请参阅 TWSearch.OrganizeByTypes 以获取有效常量。
boolean usersFullName 属性指示已保存的搜索返回的是用户的登录名还是全名。 缺省值为 false。
方法概要
TWSearchResults execute( TWUser | TWParticipantGroup | String userOrGroup , Integer maxRows , Integer beginIndex) 针对指定的用户或参与者组运行此搜索。 与 Web API 相似，过滤器基于用户及其所有角色。 当 userOrRole 为空或 null 时，该搜索将在无过滤器的情况下运行。 maxRows 参数将限制返回的搜索结果数（最多 2,147,483,647 个结果）。 将 beginIndex 参数与 maxRows 结合使用以对搜索结果分区。
TWProcessInstance[] executeForProcessInstances( TWUser | TWParticipantGroup | String userOrGroup , Integer maxRows , Integer beginIndex) 针对返回流程实例的 JavaScript 数组的指定用户或参与者组运行此搜索。 与 Web API 相似，过滤器基于用户及其所有角色。 当 userOrRole 为空或 null 时，该搜索将在无过滤器的情况下运行。 maxRows 参数将限制返回的搜索结果数（最多 2,147,483,647 个结果）。 将 beginIndex 参数与 maxRows 结合使用以对搜索结果分区。
TWTask[] executeForTasks( TWUser | TWParticipantGroup | String userOrGroup , Integer maxRows , Integer beginIndex) 针对返回 JavaScript 任务数组的指定用户或参与者组运行此搜索。 与 Web API 相似，过滤器基于用户及其所有角色。 当 userOrRole 为空或 null 时，该搜索将在无过滤器的情况下运行。 maxRows 参数将限制返回的搜索结果数（最多 2,147,483,647 个结果）。 将 beginIndex 参数与 maxRows 结合使用以对搜索结果分区。
String getTypeName() 返回类型的名称。

TWSearchColumn

包含搜索列的属性。

Type属性目录
String name 返回列的名称。
TWSearchColumnProcessColumns ProcessColumns 返回流程的可搜索列名称。
TWSearchColumnProcessInstanceColumns ProcessInstanceColumns 返回流程实例的可搜索列名称。
TWSearchColumnTaskColumns TaskColumns 返回任务的可搜索列名称。
String type 从 TWSearchColumn.Types 返回搜索列的类型。
TWSearchColumnTypes Types 返回搜索列类型常量。
方法概要
String getTypeName() 返回类型的名称。

TWSearchColumnMetaData

根据列返回和查询的搜索列信息。

Type属性目录
String displayName 列的显示名称。 可选字段。 缺省值：null
boolean isUsableInSearchCondition 由于在搜索结果中可用的任意列也可用作搜索条件的一部分，因此始终返回 true。
String label 基于驼峰大小写字符的变量名称的列标签，例如， customerName....客户名称
String name 列的名称。
String type 列类型（TWSearchColumn.Types 之一）。
String valueType 列值的类型（TWSearchColumnMetaData.ValueTypes 之一）。
TWSearchColumnMetaDataValueTypes ValueTypes 搜索元数据值类型的常量集。
方法概要
String getTypeName() 返回类型的名称。

TWSearchColumnMetaDataValueTypes

搜索列元数据的值类型。

Type属性目录
String Boolean 可搜索的业务数据类型为 Boolean
String DateTime 可搜索的业务数据类型为 DateTime
String Decimal 可搜索的业务数据类型为 Decimal
String Integer 可搜索的业务数据类型为 Integer
String String 可搜索的业务数据类型为 String

TWSearchColumnProcessColumns

包含流程的可搜索列名称的常量。

Type属性目录
String Name 按 BPD 名称搜索 BPD 实例。

TWSearchColumnProcessInstance列

包含流程实例的可搜索列名称的常量。

Type属性目录
String CaseFolderID 按案例文件夹标识搜索案例实例或任务。
String CaseFolderServerName 按案例文件夹服务器名称搜索案例实例或任务。
String CaseIdentifier 按案例标识搜索 BPD 实例或任务。
String CaseProcessTypeLocation 按案例流程类型位置搜索案例实例或任务。
String CaseStageStatus 按案例阶段状态搜索案例实例或任务。
String CaseTargetOSSymname 按案例目标对象存储库符号名称搜索案例实例或任务。
String CaseTypeId 按案例类型标识搜索 BPD 实例或任务。
String CreateDate 按实例创建日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String DueDate 按实例到期日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String ID 按实例标识搜索 BPD 实例或任务。
String ModifyDate 按实例上次修改日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String Name 按实例名称搜索 BPD 实例。
String ParentActivityId 按父活动标识搜索案例实例或任务。
String ParentCaseId 按父案例标识搜索案例实例或任务。
String ProcessApp 按流程应用程序首字母缩略词搜索 BPD 实例或任务。
String Snapshot 按 Snapshot 名称搜索 BPD 实例或任务。
String StartingDocumentID 按启动文档标识搜索案例实例或任务。
String StartingDocumentServerName 按启动文档服务器名称搜索案例实例或任务。
String Status 按实例状态搜索 BPD 实例或任务。
String WorkflowApplication 按工作流程应用程序搜索案例实例或任务。

TWSearchColumnTaskColumns

包含任务的可搜索列名称的常量。

Type属性目录
String Activity 使用活动名称来搜索任务以及拥有这些任务的 BPD 实例。
String ActivityType 通过使用任务的活动类型来搜索任务以及具有这些任务的 BPD 实例。 有效值：USER_TASK、SERVICE_TASK 和 DECISION_TASK。
String AssignedToRole 搜索分配给某个角色的任务以及拥有这些任务的 BPD 实例。
String AssignedToRoleDisplayName 使用角色的显示名称来搜索分配给该角色的任务以及拥有这些任务的 BPD 实例。
String AssignedToUser 搜索分配给某个用户的任务以及拥有这些任务的 BPD 实例。
String AssignedToUserFullName 搜索分配给使用全名的用户的任务以及具有这些任务的 BPD 实例。
String ClosedBy 通过任务结束者来搜索任务以及拥有这些任务的 BPD 实例。
String ClosedDate 按任务结束日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String DueDate 按任务到期日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String ID 使用任务标识来搜索任务以及拥有这些任务的 BPD 实例。
String Priority 使用任务优先级来搜索任务以及拥有这些任务的 BPD 实例。
String ReadDate 按任务就绪日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String ReceivedDate 按任务收到日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String ReceivedFrom 按用户标识（从该用户标识接收任务）搜索 BPD 实例或其任务。
String SentDate 按任务发送日期搜索 BPD 实例或其任务。 日期格式为“yyyy-MM-dd HH:mm:ss.SSS”。
String Status 使用任务状态来搜索任务以及拥有这些任务的 BPD 实例。
String Subject 使用任务主题文本来搜索任务以及拥有这些任务的 BPD 实例。

TWSearchColumn类型

包含搜索列类型操作的常量。

Type属性目录
String BusinessData 使用条件中的业务数据属性搜索 BPD 实例或任务。
String Process 使用条件中的 BPD 属性搜索 BPD 实例或任务。
String ProcessInstance 使用条件中的实例属性搜索 BPD 实例或任务。
String Task 使用条件中的任务属性搜索 BPD 实例或任务。

TWSearchCondition

包含搜索条件的属性。

Type属性目录
TWSearchColumn column 要应用条件的搜索列。
TWSearchConditionOperations Operations 返回按常量组织的搜索结果。
TWSearchConditionOperations operator 搜索条件运算符。
TWObject value 要应用条件的搜索列。
方法概要
String getTypeName() 返回类型的名称。

TWSearchCondition操作

包含搜索条件操作的常量。

Type属性目录
String Contains 搜索数据应该包含指定的值。
String Equals 搜索数据应该等于指定的值。
String GreaterThan 搜索数据应该大于指定的值。
String LessThan 搜索数据应该小于指定的值。
String NotEquals 搜索数据应该不等于指定的值。
String StartsWith 搜索数据应该以指定的值开头。

TWSearchMeta数据

用于描述可用于执行搜索的数据。

Type属性目录
TWSearchColumnMetaData[] columns 可用于搜索的列信息的 JavaScript 数组。
方法概要
String getTypeName() 返回类型的名称。

TWSearchOptions

将针对 TWSearch 行为的多个参数合并为一个对象。

Type属性目录
boolean isTieBreakerSorting 指定 TWSearch 是严格按照查询中指定的排序对结果进行排序 (false)， 还是将所谓的决定性列附加 到排序内容后面。 决定性列包括：实例标识、任务到期日期、任务优先级等级和任务标识。

TWSearchOrdering

包含搜索排序的属性。

Type属性目录
TWSearchColumn column 返回排序引用的搜索列。
String order 返回搜索顺序。
TWSearchOrderingOrders Orders 返回按常量组织的搜索结果。
方法概要
String getTypeName() 返回类型的名称。

TWSearchOrderingorders

包含搜索顺序操作的常量。

Type属性目录
String Ascending 搜索结果按升序排序。
String Descending 搜索结果按降序排序。

TWSearchOrganizeByTypes

包含按类型组织的任务的常量。

Type属性目录
String ProcessInstance 按流程实例排序。
String Task 按任务排序。

TWSearchResult行

搜索结果行对象。

Type属性目录
TWObject[] values 搜索结果行值。
方法概要
String getTypeName() 返回类型的名称。

TWSearchResults

搜索结果对象。

Type属性目录
TWSearchColumnMetaData[] columns 结果中的列。
TWSearchResultRow[] rows 结果中的行。
方法概要
String getTypeName() 返回类型的名称。

TWService

表示可执行的服务。

Type属性目录
String id 服务的标识。
TWLink[] links 文档中的引用链接。
String name 服务的名称。
String type 服务的类型。
TWServiceTypes Types 返回服务的类型。
方法概要
Map execute( Map inputParams) 执行具有给定输入的服务，返回输出参数。 为异步调用启用的传统人员服务和服务流均不支持此 API。
String getTypeName() 返回类型的名称。

TWServiceTypes

表示服务类型的常量。

Type属性目录
String Ajax 可用于 Coach 控件的服务，这些控件支持使用 Ajax 的异步服务器调用。
String ExternalService 用于调用 REST 服务、Web Service 或 Java 方法的外部服务。
String GeneralSystem 可用作系统任务的通用服务。
String Human 为用户交互而设计的服务。
String Installation 安装流程应用程序期间执行的服务。
String Integration 包含 Web Service 和 Java Reflection 等的集成组件的服务。
String Rule 可用于决策网关的服务。
String ServiceFlow 可在 Web Process Designer 中编辑的服务流。

TWTask

包含访问任务的有用方法。

Type属性目录
TWDate activationTime 收到任务的日期和时间。
TWObject assignedTo 任务当前分配到的 TWUser 或 TWRole。
TWDate atRiskDate 未完成任务的执行时间长于平均时间量的日期；该任务会被视为存在风险。
TWDate completionTime 任务完成时间。
TWDate dueDate 任务到期日期。
String flowObjectId 任务流对象标识。
String id 返回任务标识。
Boolean isAtRisk 任务处于存在风险状态。
String localId 返回本地化标识。
String narrative 任务叙述。
String originator 发起任务的人员。
String owner 任务所有者。
String phaseId 任务阶段标识。
TWTaskPriorities Priorities 返回任务优先级常量。
String priority 任务优先级。
Integer priorityValue 任务优先级值。
String processActivityDescription 与任务关联的流程活动的描述
String processActivityName 与任务关联的流程活动的名称
String processActivityRichDescription 与任务关联的流程活动的描述（富文本格式）
TWProcessInstance processInstance 与任务关联的流程实例。
TWProcessStepInfo processInstanceStep 父流程实例中的步骤。
TWDate startDate 任务开始日期。
String state 任务状态。
String status 任务状态。
TWTaskStatuses Statuses 返回任务状态常量。
String subject 任务主题。
Map[] transactions 与此任务关联的 SAP 事务列表。 每个事务都具有以下属性：scope、logicalComponent、standard、object、name、sapId、typeDescription 和 type
方法概要
boolean claim() 以当前用户身份声明任务。 如果申领成功，那么将返回“true”，否则将返回“false”。
long[] complete(TWUser user , Map outputValues) 完成任务。 通常，会将它与 External Activity 一起使用。 如果启用了自动流并发现下一个自动流任务，那么将返回该任务的标识。
String[] getAvailableActions( String[] actionsFilter) 返回针对指定用户的任务的可用操作列表。
String getTypeName() 返回类型的名称。
void reassignBackToRole() 将任务重新分配给其原始角色。
void reassignTo(TWUser usersOrRoles) 将任务重新分配给给定用户和/或角色。 接受单个 TWUser 对象。
void reassignTo(TWRole usersOrRoles) 将任务重新分配给给定用户和/或角色。 接受单个 TWRole 对象。
void reassignTo(TWTeam usersOrRoles) 将任务重新分配给给定用户和/或角色。 接受单个 TWTeam 对象。
void reassignTo(String usersOrRoles) 将任务重新分配给指定的用户，角色或团队，并接受可以逗号分隔的单个字符串。 按用户名、角色名称或团队名称匹配用户、角色或团队。 仅当角色以“ROLE:”为前缀时才匹配这些角色。 仅当团队以“TEAM:”或“PG:”为前缀时才匹配这些团队。 用户名无需添加前缀“USER:”，但是也可以进行添加。
void reassignTo(Array usersOrRoles) 将任务重新分配给给定用户和/或角色。 接受由 TWUser、TWRole 或 String 组成的 JS 数组。 可以使用 TWUser、TWRole、TWParticipantGroup 或 String 中的任意项填充 JavaScript 数组，例如，该数组可包含 TWUser、TWRole 和 TWParticipantGroup。
void reassignTo(String[] usersOrRoles) 将任务重新分配给指定的用户，角色或团队，并接受 TW 字符串列表。 按用户名、角色名称或团队名称匹配用户、角色或团队。 仅当角色以“ROLE:”为前缀时才匹配这些角色。 仅当团队以“TEAM:”或“PG:”为前缀时才匹配这些团队。 用户名无需添加前缀“USER:”，但是也可以进行添加。
void start(TWUser user) 使用给定用户启动任务。 这仅会有效地设置任务的开始时间。

TWTaskPriorities

包含优先级类型的常量。

Type属性目录
String High 高优先级。
String Highest 最高优先级。
String Low 低优先级。
String Lowest 最低优先级。
String Normal 一般优先级。

TWTaskStatuses

包含可能状态的常量值。

Type属性目录
String Actioned 已关闭任务。
String Closed 已关闭任务。
String Deleted 任务已删除。
String Forwarded 已转发任务。
String New 由当前用户创建并已分配给该用户的任务。
String Received 由特定用户或角色创建并且已分配给该用户或角色的任务。
String Replied 已回复任务。
String Sent 已发送任务。

TWTeam

包含团队的有用方法。

Type属性目录
TWUser[] allUsers 返回作为团队直接或间接成员的所有用户的列表。
TWRole associatedRole 返回与此团队关联的角色。
TeamDashboardSupport dashboard 仪表板 Coach 视图支持。
String id 团队的标识。
String name 团队的名称。
TWProcessApp processApp 已定义团队的流程应用程序。
TWRole[] roles 返回作为团队直接成员的角色列表。
TWProcessAppSnapshot snapshot 返回与团队关联的 Snapshot。
TWUser[] users 返回作为团队直接成员的用户列表。
方法概要
void addRoles(TWRole roles) 向团队添加角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void addUsers(TWUser users) 将用户添加到团队。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
Team asTeam() 将 TWTeam 转换为 Team 业务对象。
TWTeam getManagerTeam() 返回此团队的经理团队。
String getTypeName() 返回类型的名称。
boolean hasUser(TWUser user) 如果用户是成员，那么返回 true。 接受 TWUser 对象。
void refresh() 刷新关联的运行时角色成员资格。
void removeRoles(TWRole roles) 从团队中除去角色。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void removeUsers(TWUser users) 从团队中除去用户。 安装 IBM BPM V8.5.7 累积修订 2016.09 之后，组成员资格更新将具有更多限制。 请参阅组成员资格更新 REST API 文档以了解更多详细信息。
void setAutomaticRefresh(boolean enable) 设置此团队的 enable-automatic-refresh 标志。
void setManagerTeam(String teamName) 设置此团队的经理团队。

TWTimePeriod

用于描述时间段（例如，周一到周五早上 7 点到晚上 7 点）的 IBM Business Automation Workflow 变量类型。 请注意，开始时间和结束时间的值不能相同。 否则，将忽略该时间段，因为其持续时间实际上为 0。

Type属性目录
Time endTime 一天的结束时间（使用 23:59 表示一天的结束（午夜））
Boolean friday 这个时期对周五是否有效（例如：周五是工作日）
String id 时间段实例的标识。
Boolean monday 这个时期对周一是否有效（例如：周一是工作日）
Boolean saturday 这个时期对周六是否有效（例如：周六是工作日）
Time startTime 一天的开始时间（使用 00:00 表示一天的开始（午夜））
Boolean sunday 这个时期对周日是否有效（例如：周日是工作日）
Boolean thursday 这个时期对周四是否有效（例如：周四是工作日）
Boolean tuesday 这个时期对周二是否有效（例如：周二是工作日）
Boolean wednesday 这个时期对周三是否有效（例如：周三是工作日）

TWTimerInstance

计时器等待的实例。

Type属性目录
String id 计时器的实例标识。
方法概要
String getTypeName() 返回类型的名称。

TWTimeSchedule

用于描述时间安排（例如 24x7）的 IBM Business Automation Workflow 变量类型，该时间安排涵盖要用于 SLA 的时间段

Type属性目录
Boolean excludeHolidays 此时间安排是否移除假期。 如果不包括假期，那么应该为活动或 BPD 定义并选择一个有效的假期安排。
String id 时间安排的标识
String name 时间安排的名称
TWTimePeriod[] periods 组成此时间安排的时间段列表。 如果已对多个时段的每一天进行定义（如 8A-12P M-F 和 1P-5P M-F），那么所有时段共同组成完整的安排范围

TWUser

包含访问用户的有用方法。

Type属性目录
Record attributes 返回所有用户的属性。
UserDashboardSupport dashboard 仪表板 Coach 视图支持。
String fullName 返回用户的全名。
int id 返回用户标识。
boolean isActive 返回用户状态；用户可以为活动或不活动。
String name 返回用户的名称。
TWObject*TWParticipantGroup participantGroups 返回用户所属的所有团队。
TWRole primaryRole 不推荐使用。 不推荐使用的
返回用户的主角色。
TWRole primaryRoleParent 不推荐使用。 不推荐使用的
返回用户的主角色的父角色。
TWObject*TWRole roles 返回用户所属的所有角色。
TWSavedSearch[] savedSearches 用户可访问的所有已保存门户网站搜索的数组。
TWScoreboard[] scoreboards 用户可访问的所有计分板的数组。
TWObject*TWTeam teams 返回用户所属的所有团队。 它在指定了 JavaScript 的 Process App/Toolkit 中进行搜索。
方法概要
Map getAttributes() 不推荐使用。 use 属性属性
返回用户的所有属性。
String getFullName() 不推荐使用。 use 属性 fullName
返回用户的全名。
int getId() 不推荐使用。 使用属性标识
返回用户的标识。
TWUserLocalePreferences getLocalePreferences(TWUser user) 设置用户的语言环境首选项。
String getName() 不推荐使用。 使用属性名
返回用户的名称。
TWRole getPrimaryRole() 不推荐使用。 use 属性 parimaryRole
返回用户的主角色。
TWRole getPrimaryRoleParent() 不推荐使用。 use 属性 primaryRoleParent
返回用户的主角色的父角色。
TWRole[] getRoles() 不推荐使用。 使用属性角色
返回用户所属的所有角色。
String getTypeName() 返回类型的名称。
boolean isInParticipantGroup(TWParticipantGroup participantGroup) 用户是团队成员时的电话。
boolean isInRole( String | TWRole role) 如果用户是角色的成员，那么会进行电话通信。 其中角色可以是 TWRole 对象或者角色的字符串名称。
boolean isInTeam(TWTeam team) 如果用户是给定团队的成员，那么返回 true。
void removeAttribute(String name) 除去此用户的给定属性及其所有值。
StreamsForUser retrieveUserStream( String sortOrder , String page , String pageSize , TWDate sinceDateTime , String taskId) 检索用户的流条目。
void setAttributeValue(String name , String value) 将具有提供的名称的属性设置为提供的值。 如果属性不存在，那么会创建该属性，否则会替换属性值。 属性不在任何名称空间中。
void setLocalePreferences(TWUser user , TWUserLocalePreferences localePreferences) 设置用户的语言环境首选项。

TWUserLocale首选项

保留有关用户语言环境首选项的信息。

Type属性目录
String locale 保留标准格式的语言环境:[_[_变体]]。 例如，"en"、"en_US"。
String localeCountry 返回此语言环境的国家/地区代码，可能是空字符串或两个大写的 ISO 3166 2 字母代码。
String localeDisplayCountry 返回适合显示给用户的语言环境的国家/地区名称。
String localeDisplayLanguage 返回适合显示给用户的语言环境的语言名称。
String localeDisplayName 返回适合显示给用户的语言环境的名称。
String localeDisplayVariant 返回适合显示给用户的语言环境的变量代码名称。
String localeLanguage 返回此语言环境的语言代码，可能是空字符串或小写 ISO 639 代码。
String localeVariant 返回此语言环境的变量代码。

TWWorkSchedule

包含时间安排、时区和假期安排的瞬态 IBM Business Automation Workflow 变量类型

Type属性目录
TWHolidaySchedule holidaySchedule 假期安排
TWTimeSchedule timeSchedule 时间安排
String timeZone 时区

url

URL 类型

UserDashboard支持

仪表板 Coach 视图支持。

方法概要
TeamMemberTaskSummary retrieveTeamMemberSummary( String filterString , String timeZoneAsString) 检索用户的任务状态摘要计数。

UserInfo

用户信息。

Type属性目录
String fullName 用户的全名。
String name 用户的名称。
String userId 用户的用户标识。

XMLDocument

在 IBM Business Automation Workflow 中，此类表示 XML 文档。 使用此类可指示某个变量是 XML 文档

方法概要
XMLElement createElement(String elementName) 创建并返回新的 XMLElement。 新创建的 XMLElement 不属于用于创建它的 XMLDocument。 在正确父元素上使用插入方法来将新创建的元素添加到正确位置。
XMLElement getElementByTagName(String tagName) 如果文档的名称为 tagName，那么返回该文档的根元素。
XMLNodeList*XMLElement getElements() 返回由单个文档根元素组成的列表。
String toString( boolean deep) 返回文档的字符串表示。 如果 deep 参数设置为 true，整个文档返回为字符串，否则仅会转换并返回 root 元素。
String transform(String fileName) 此函数使用 XSLT 变换当前文档。 返回变换结果的字符串表示形式。
XMLNodeList*XMLElement xpath(String xPathExpression) 将提供的 XPath 表达式应用于文档，并返回表达式选择的元素列表。 请注意，这仅会返回元素而不返回其他内容类型。

XMLElement

在 IBM Business Automation Workflow 中，此类表示 XML 元素。 使用此类可指示某个变量是 XML 元素

Type属性目录
XMLNodeList*XMLElement childNodes 返回此元素下所有子代元素的列表。
XMLElement firstChild 返回此元素下的第一个子代元素，如果此元素没有任何子代，那么返回 Null。
XMLElement lastChild 返回此元素下的最后一个子代元素，如果此元素没有任何子代，那么返回 Null。
String namespaceURI 此元素的名称空间 URI。 如果元素没有前缀，那么这是缺省名称空间 URI。
XMLElement nextSibling 返回此元素的下一个同代元素，如果此元素没有下一个同代，那么返回 Null。
XMLDocument ownerDocument 返回包含此元素的文档，如果元素不在任何文档中，那么返回 Null。
XMLElement parentNode 返回此元素的父元素，如果此元素没有父元素（包括它是其包含文档的 root 元素的情况），那么返回 Null。
XMLElement previousSibling 返回此元素的先前同代，如果此元素没有任何先前同代，那么返回 Null。
String tagName 返回当前元素的名称。
方法概要
XMLElement appendChild(XMLElement newChild) 将 newChild 附加到此元素的子代列表的末尾。 返回 newchild。
XMLElement cloneNode( boolean deep) 返回此元素的克隆。 如果 deep 为 true，那么子代会递归克隆。
String getAttribute(String attributeName) 返回具有指定名称的属性的值，如果没有此类元素，那么返回 null。
String getAttributeNS(String namespaceURI , String attributeName) 返回由 namespaceURI 和 localName标识的属性值。
XMLNodeList*XMLElement getElementByTagName(String tagName) 返回具有给定名称的当前元素的所有子元素的 XMLNodeList 。 如果所有子代元素都没有给定名称，那么返回空的 XMLNodeList。
XMLNodeList*XMLElement getElementsByTagNameNS(String namespaceURI , String localName) 返回具有指定 localName 和 namespaceURI的当前元素的所有子代的列表。
String getText() 返回当前元素的文本内容，如果没有文本，那么返回 null。
boolean hasChildNodes() 如果此元素具有任何子元素，那么返回 true。
XMLElement insertBefore(XMLElement newChild , XMLElement refChild) 将新元素 newChild作为此元素的子代插入到其现有子代 refChild之前。 返回 newchild。
void removeAttribute(String name) 从元素中除去具有提供的名称且没有名称空间的属性。
void removeAttributeNS(String namespaceURI , String name) 除去由 namespaceURI 和 localName标识的属性。
XMLElement removeChild(XMLElement oldChild) 除去此元素的子代 oldChild。 返回 oldChild。
XMLElement replaceChild(XMLElement newChild , XMLElement oldChild) 将此元素的子代 oldChild替换为新的子代 newChild。 返回 newchild。
void setAttribute(String name , String value) 将具有提供的名称的属性设置为提供的值。 如果属性不存在，那么会创建该属性，否则会替换属性值。 属性不在任何名称空间中。
void setAttributeNS(String namespaceURI , String name , String value) 将 namespaceURI 和 localName 标识的属性值设置为值。
void setText(String text) 将当前元素的文本内容设置为提供的值，以替换任何现有文本和/或元素内容。
String toString( boolean deep) 返回文档的字符串表示。 如果 deep 参数设置为 true，整个文档返回为字符串，否则仅会转换并返回 root 元素。
String transform(String fileName) 此函数使用 XSLT 变换当前文档。 返回变换结果的字符串表示形式。请注意：XSLT 仅适用于文档，因此该调用假设此元素是文档的 root 元素。 所有 XPATH 等都应该假设这是 root 元素。
XMLNodeList*XMLElement xpath(String xPathExpression) 返回应用于此元素时由 XPath 表达式选择的节点的列表。 注：XSLT 仅适用于文档，因此该调用假定此元素是文档的根元素。 所有 XPATH 等都应该假设这是 root 元素。

XMLNodeList

在 IBM Business Automation Workflow 中，此类表示 XML 节点列表。 使用此类可指示某个变量是 XML 节点列表

Type属性目录
int length 列表中的项数。
方法概要
XMLElement item(Integer index) 位置索引处的项。

TWBPDPerfNamespace

流程上下文中使用的“tw.perf”对象包含性能服务器的运行时数据。

Type属性目录
TWSLANamespace sla 不推荐使用。 不推荐使用 TWSLANamespace。
SLA 名称空间包含运行时服务级别协议统计信息。

TWBPDSystemBPDNamespace

流程上下文中使用的“tw.system.bpd”对象包含关于系统和此特殊流程的有用变量和常量。

Type属性目录
TWObject*ConditionalActivity conditionalActivities 当前 BPD 中条件活动的分层列表。
TWDate dueDate 实例的到期日期。 可以为 null 且可以设置。
String guid 此业务流程的 GUID。
String id 此业务流程的标识。
String instanceId 此特殊实例的唯一标识。
String name 此特殊实例的名称。
String[] selectedConditionalActivities 已选择条件活动的列表。 可以为 null 且可以设置。

TWBPDSystemNamespace

用于使用“tw.system”从流程上下文访问和操纵系统数据的名称空间。 它包含关于系统和特定流程实例的有用变量和常量。

Type属性目录
ActivityInstance currentAdHocActivityInstance 包含的活动实例（如果有）。
TWProcess currentProcess 获取当前流程。
TWProcessInstance currentProcessInstance 获取当前流程实例。
TWHolidaySchedule defaultHolidaySchedule 包含系统缺省假期安排的系统名称空间。
TWTimeSchedule defaultTimeSchedule 包含系统缺省时间安排的系统名称空间。
String defaultTimeZone 包含系统缺省时区的系统名称空间。
CaseReference enclosingCaseInstance 目标对象库中的案例实例。
TWHolidaySchedule[] holidaySchedules 包含所有假期安排访问权的系统名称空间。
TWInstallNamespace install 包含安装历史记录信息访问权的系统名称空间。
TWModelNamespace model 包含模型对象访问权的系统名称空间。
TWBPDSystemOrgNamespace org 包含用户组织访问权的系统名称空间。
TWBPDSystemBPDNamespace process 包含系统 bpd 常量的系统名称空间。
Serializer serializer 不推荐使用。 序列化格式是内部的。
包含对象串行器的串行器名称空间。
TWProcessStepInfo step 包含系统步骤常量的系统名称空间。
TWTimeSchedule[] timeSchedules 包含所有时间安排访问权的系统名称空间。
TWUser user 包含当前用户访问权的系统名称空间。
方法概要
boolean addHolidaySchedule(TWHolidaySchedule holidaySchedule) 添加 TWHolidaySchedule 的新实例，该实例将包括在 "tw.system.holidaySchedules" 中的假期调度列表中。
boolean addTimeSchedule(TWTimeSchedule timeSchedule) 添加 TWTimeSchedule 的新实例，该实例将包括在 "tw.system.timeSchedules" 中可用的时间安排列表中。
String assignNextTask(String groupId , String sortCriteria , Boolean enabledRetryOptimization , String userId) 根据 groupId 和 sortCriteria，将下一个任务分配给由 userId标识的用户。
String assignNextTaskByTeamName(String teamName , String sortCriteria , Integer optimizationLevel , Boolean includeAllSnapshotTasks , String userId) 根据 teamName 和 sortCriteria 参数，将下一个任务分配给由 userId标识的用户。
String bidiTransform(String src , String inputFormat , String outputFormat , boolean symmetricSwapping) 返回 Bidi 变换的输出值。
TWDate calculateBusinessDate(TWDate originalDate , Integer delta , String units , TWWorkSchedule workSchedule) 计算从 originalDate开始的业务日期，根据给定的 workSchedule，按给定单位 (月，日，小时，分钟) 的给定增量 (负值表示减少) 进行更改。 例如，如果原始日期位于星期六或星期日，增量为 -1 天，工作安排设置为星期一至星期五上午 9 点到下午 5 点且无一组假日安排，那么计算的日期将是星期五上午 9:00。 如果增量为 1 天，那么生成的日期将为星期二上午 9:00。 在正演计算中，在后退时将跳过 1 个工作日，返回工作日的开始时间。
void cancelStep(Integer stepId) 重新调度计时器。
String convertIDToDB(String id) 将输入的外部标识转换为适合在数据库查询中使用的标识。
String createCase(String caseType , String objectStoreName , Record caseProperties , String[] caseStructure , String asAdministrator) 为指定的案例类型创建案例的新实例。 返回新案例的标识。
有关更多信息，请参阅 案例属性值的格式 和 与流程或服务流中的案例和活动进行交互。
variableTypeName[] createFromSql(String variableTypeName , String jndiName , String sqlQuery , ANY params) 返回指定变量类型名称的对象列表。 对象包含 SQL 查询的结果。
void createFromXmlElement(String variableTypeName , Element xml) 返回 {variableTypeName} 对象的数组，这些对象包含给定XML化记录集中的数据。
BPMFailedOperation[] deleteAlertDefinitions(String[] ids , Boolean checkAuthorization) 根据给定的标识列表删除警报定义。
String escapeHtml(String content) 对可能包含特殊字符的输入字符串进行美化。 此函数可用于避免潜在的跨站点脚本编制 (XSS) 攻击。
Map executeServiceByName(String name , Map inputValues) 使用给定名称启动服务。 为异步调用启用的传统人员服务和服务流均不支持此 API。
ActivityInstance findActivityInstanceByID(String activityId) 返回按标识找到的活动实例。
TWDocument findDocumentByID(String documentId) 返回按标识找到的文档。
TWHelpRequest findHelpRequestByID(String id) 按标识查找帮助请求。
TWHolidaySchedule findHolidayScheduleByName(String name) 在 "tw.system.holidaySchedules" 中的可用时间调度列表中按名称查找 TWHolidaySchedule 。
TWProcessInstance findProcessInstanceByID(String id) 返回按标识找到的进程。
TWTask findTaskByID(Integer taskID) 返回按标识找到的任务。
TWTask findTaskByID(String taskID) 返回按标识找到的任务。
TWTimeSchedule findTimeScheduleByName(String name) 按 "tw.system.timeSchedules" 中可用的时间安排列表中的名称查找 TWTimeSchedule 。
BPMAlertDefinition[] getAlertDefinitions( String[] categoryFilter , Boolean checkAuthorization) 返回警报定义的列表。
BPMAlertDefinitionStatusResponse getAlertDefinitionsStatus(String[] ids , Boolean checkAuthorization) 返回指定的警报定义列表的当前运行时值，包括实际值以及是否满足条件。
String getECMDefaultTargetRepositoryName() 返回表示定义良好的常量 IBM_TargetObjectStore 的缺省目标存储库名称。
String getECMFolderPath(String serverName , String folderId) 返回 ECM 服务器中文件夹的路径。
String getEnvironmentVariableValue(String processAppAcronym , String snapshotAcronym , String environmentVariableName) 在指定流程应用程序 Snapshot 的上下文中返回指定环境变量的当前值。
String initializeContentObject(String caseType , String objectStoreName , String caseID) 使用案例类型或案例实例中的值来初始化 CaseProperties 内容对象。 返回可设置为已绑定对象的内容对象值。
boolean removeHolidaySchedule(String id) 从 "tw.system.holidaySchedules" 中提供的假日调度列表中除去具有给定标识的 TWHolidaySchedule 。
boolean removeTimeSchedule(String id) 从 "tw.system.timeSchedules" 中可用的时间安排列表中除去具有给定标识的 TWTimeSchedule 。
void rescheduleTimer(String timerId , TWDate newFireTime) 重新调度计时器。
InstanceListData retrieveInstanceList(InstanceListProperties properties , Integer maxRows , Integer beginIndex , Boolean checkAuthorization) 不推荐使用。 在容器环境中不推荐使用 retrieveInstanceList 方法。 当前没有替换项。
根据给定属性返回实例列表。
ProcessSummary[] retrieveProcessSummaries( String searchFilter , Boolean checkAuthorization) 返回项目中所有活动/已部署的流程的流程摘要计数列表。
TaskDueData retrieveTaskDueData(TaskDueProperties properties , String timezone) 返回给定到期日期时间片的任务到期数据。
TaskListData retrieveTaskList(TaskListProperties properties , Integer maxRows , Integer beginIndex , String timezone) 根据当前用户的授权，返回给定团队，团队成员或用户的任务列表。
TeamTaskSummary[] retrieveTeamSummaries( String searchFilter , String timeZoneAsString , Boolean checkAuthorization) 检索所有团队的活动任务的汇总计数数据。
BPMAlertDefinition[] saveAlertDefinitions(BPMAlertDefinition[] definitions , Boolean importMode , Boolean checkAuthorization) 保存数据库中的警报定义列表。
void saveCaseProperties(String caseID , String objectStoreName , Record caseProperties , String asAdministrator) 保存相应案例实例的 CaseProperties 值。
String sortByNextBestTask(String taskList , String workerId) 对给定工作程序标识的任务列表进行排序，以根据具有该标识的工作程序的技能集以及将产生最大影响的内容来显示该工作程序应该处理的下一个任务。 生成的任务列表会进行排序并返回，但不会修改已位于列表中的对象。 如果无法与 AI Agent Server 建立连接，那么 API 将返回 null。 在这种情况下，会将错误记录在系统日志中。
String splitCase(String caseInstanceId , String objectStoreName , String caseType , Record caseProperties , String[] docsToFile , String description , String[] asAdministrator) 通过从父案例拆分案例来创建案例的新实例。 返回新案例的标识。
描述不适用
TWProcessInstance startProcessByName(String name , Map inputValues , Boolean checkAuthorization) 使用给定名称启动 BPD。
void touchVariable(String name) 更新 "tw.local" namespace.\nThis 可用于在修改复杂对象的属性值后 \n 手动更新其修改时间，因为这不会自动发生。
void trainNextBestTask() 使用 Business Automation Insights中的最新数据来刷新任务优先级划分模型。
String unescapeHtml(String content) 解析输入字符串中可能存在的转义字符，可能是调用 tw.system.escapeHtml() 的结果。 返回未转义的字符串。
boolean updateHolidaySchedule(TWHolidaySchedule holidaySchedule) 更新 TWHolidaySchedule的实例。
boolean updateTimeSchedule(TWTimeSchedule timeSchedule) 更新 TWTimeSchedule的实例。
String variableTypeForVariable(String fullyQualifiedVariableName) 返回与变量关联的 IBM Business Automation Workflow 变量类型的名称。

TWBPDSystemOrg名称空间

流程上下文中使用的“tw.system.org”对象包含访问用户组织的有用方法。

Type属性目录
PGNamespace pg 不推荐使用。 不推荐使用 tw.system.org.pg 。 请改为使用 tw.system.org.team 。
pg 名称空间包含模型的所有参与者组。
TeamNamespace team team 名称空间包含模型的所有团队。
方法概要
TWRole createRole(String roleName , String roleDisplayName , String roleDescription , Boolean checkAuthorization) 创建新角色。
TWUser[] findAllUsersForRoles(TWRole[] roles) 返回属于给定角色 (联合) 的所有用户。
TWUser[] findCommonUsersForRoles(TWRole[] roles) 返回仅属于所有给定角色 (Intersection) 的用户。
TWParticipantGroup findParticipantGroupByID(String participantId) 查找给定其标识的团队。
TWParticipantGroup findParticipantGroupByName(String participantName) 查找给定名称的团队。
TWRole findRoleById(Integer roleId) 查找给定其标识的角色。
TWRole findRoleByName(String roleName) 查找给定名称的角色。
TWTeam findTeam(String teamId , String processAppId) 第二个参数是可选的。 如果传递了第二个参数，该方法将在对应的流程应用程序或 Toolkit 中搜索具有指定 teamId 的团队。 如果第二个参数被省略或为空，将搜索所有流程应用程序和 Toolkit。 首先在缺省 Snapshot（包括其依赖关系层次结构）中执行搜索，接下来在最新的 Snapshot N（包括其依赖关系层次结构）中执行搜索，然后在次新 (=N-1) 的 Snapshot（包括其依赖关系层次结构）中执行搜索，依次类推。 返回与 teamId 匹配的第一个团队。
TWTeam findTeamByID(String teamId) 此方法在当前上下文中搜索具有指定 teamId的团队。 调用者的上下文取决于搜索是在流程应用程序还是 Toolkit 中执行，以及调用者所在的对应 Snapshot。 如果在流程应用程序或 Toolkit 中找不到该 teamId，那么将搜索依赖关系层次结构。 返回与 teamId 匹配的第一个团队。
TWTeam findTeamByName(String teamName) 此方法在当前上下文 (即调用者的上下文) 中搜索具有指定 teamName的团队。 teamName 在 Process Designer 中指定。 如果调用者在 Snapshot 的上下文中，将仅搜索该 Snapshot 上下文。 该方法搜索具有指定 teamName 的团队。如果找不到团队，将返回“null”。
TWUser findUserById(Integer userId) 查找给定其标识的用户。
TWUser findUserByName(String userName) 查找给定名称的用户。
TWParticipantGroup[] getAllParticipantGroups() 返回 Process App 及其 Toolkit 中所有团队的数组。
TWRole[] getAllRoles() 返回系统中的所有角色。
TWTeam[] getAllTeams() 返回所有团队。
TWUser[] getAllUsers() 返回系统中的所有用户。
TWRole[] getUMSSubTeams(String roleName , Boolean deep , Boolean sync) 返回作为输入 UMS 团队子代的 UMS 团队。
void removeRole(String roleName , Boolean checkAuthorization) 删除内部组。 注：您无法删除已分配任务的组，或者在 BPMServerSecurityGroups 配置中配置为 bpmAdminGroup 的组。

TWEnvironmentNamespace

用于访问和操纵环境变量的名称空间。

方法概要
void update(TWEnvironmentVariable envVar , String value , Boolean withRespectToToolkit) 更新环境变量的值。
String variableValue(String envVarName , String toolkitName) 返回指定环境变量名称的值。

TWHelpRequest

帮助请求的实例。

Type属性目录
String id 返回帮助请求的只读标识（外部化标识）。
方法概要
void ignore( String comment) 忽略带有给定注释的帮助请求。
void reply( String comment) 回复具有给定注释的帮助请求。

TWInstallNamespace

"tw.system.install" 对象包含有关安装历史记录的有用变量和方法。

Type属性目录
TWProcessAppSnapshot[] snapshotsMigratingInstances 正迁移实例的 Snapshot 的 JavaScript 数组。
String status 访问安装状态。
TWInstallStatusesNamespace Statuses 包含对可能状态常量值的访问权的安装名称空间。
方法概要
String getStatusMessage( String locale) 返回针对给定语言环境本地化的安装状态消息。 \nIf 语言环境，那么将使用当前用户 (或系统，如果没有用户) 的语言环境。

TWInstallStatuses名称空间

"tw.system.install.Statuses" 对象包含可能状态的常量值。

Type属性目录
String CreatingPackage 创建安装软件包。
String Error 安装中的一般错误。
String InProgress 正在进行安装。
String Installed 安装已完成。
String MigrationError 实例迁移中的一般错误。
String MigrationInProgress 迁移实例。
String PackageCreated 已创建安装软件包。
String PartialMigrationError 迁移部分实例时出错。
String Scheduled 已安排为以后安装。

TWObjectNamespace

对象名称空间用于初始化 IBM Business Automation Workflow 中的复杂对象。

Type属性目录
TWContentObjectNamespace contentObject 内容对象名称空间用于初始化内容对象。
TWPropertyNamespace property 属性名称空间用于初始化内容对象属性。
TWToolkitNamespace toolkit Toolkit 名称空间用于指定包含要在 IBM Business Automation Workflow 中初始化的复杂对象的 Toolkit。

OrgNamespace

“tw.system.org”对象包含访问用户组织的有用方法。

Type属性目录
PGNamespace pg 不推荐使用。 不推荐使用 tw.system.org.pg 。 请改为使用 tw.system.org.team 。
pg 名称空间包含所有团队。
TWSLANamespace sla 不推荐使用。 不推荐使用 TWSLANamespace。
SLA 名称空间包含运行时服务级别协议统计信息。
TeamNamespace team pg 名称空间包含所有团队。
方法概要
TWRole createRole(String roleName , String roleDisplayName , String roleDescription , Boolean checkAuthorization) 创建新角色。
TWUser[] findAllUsersForRoles(TWRole[] roles) 返回属于给定角色 (联合) 的所有用户。
TWUser[] findCommonUsersForRoles(TWRole[] roles) 返回仅属于所有给定角色 (Intersection) 的用户。
TWParticipantGroup findParticipantGroupByID(String participantId) 查找给定其标识的团队。
TWParticipantGroup findParticipantGroupByName(String roleName) 查找具有其名称的团队。
TWRole findRoleById(String | Integer roleId) 查找给定其标识的角色。
TWRole findRoleByName(String roleName) 查找给定名称的角色。
TWTeam findTeam(String teamId , String processAppId) 在任何流程应用程序中查找给定其标识的团队。
TWTeam findTeamByID(String teamId) 查找给定其标识的团队。
TWTeam findTeamByName(String teamName) 查找具有其名称的团队。
TWUser findUserById(String | Integer userId) 查找给定其标识的用户。
TWUser findUserByName(String userName) 查找给定名称的用户。
TWParticipantGroup[] getAllParticipantGroups() 返回 Process App 及其 Toolkit 中所有团队的数组。
TWRole[] getAllRoles() 返回所有角色。
TWTeam[] getAllTeams() 返回所有团队。
TWUser[] getAllUsers() 返回所有用户。
TWRole[] getUMSSubTeams(String roleName , Boolean deep , Boolean sync) 返回作为输入 UMS 团队子代的 UMS 团队。
void removeRole(String roleName , Boolean checkAuthorization) 删除 IBM Business Automation Workflow 安全组。 注：您无法删除已分配任务的组，或者在 BPMServerSecurityGroups 配置中配置为 bpmAdminGroup 的组。

TWHelpRequest

帮助请求的实例。

Type属性目录
String id 帮助请求的标识。
方法概要
void ignore( String comment) 忽略带有给定注释的帮助请求。
void reply( String comment) 回复具有给定注释的帮助请求。

TWInstallNamespace

"tw.system.install" 对象包含有关安装历史记录的有用变量和方法。

Type属性目录
TWProcessAppSnapshot[] snapshotsMigratingInstances 正迁移实例的 Snapshot 的 JavaScript 数组。
String status 访问安装状态。
TWInstallStatusesNamespace Statuses 包含可能状态常量值的访问权的安装名称空间。
方法概要
String getStatusMessage( String locale) 返回针对给定语言环境本地化的安装状态消息。 \nIf 语言环境，那么将使用当前用户 (或系统，如果没有用户) 的语言环境。

TWInstallStatuses名称空间

"tw.system.install.Statuses" 对象包含可能状态的常量值。

Type属性目录
String CreatingPackage 创建安装软件包。
String Error 安装中的一般错误。
String InProgress 正在进行安装。
String Installed 安装已完成。
String MigrationError 实例迁移中的一般错误。
String MigrationInProgress 迁移实例。
String PackageCreated 已创建安装软件包。
String PartialMigrationError 迁移部分实例时出错。
String Scheduled 已安排为以后安装。

TWPerfNamespace

“tw.perf”对象包含性能服务器的运行时数据。 不推荐使用。

Type属性目录
TWSLANamespace sla 不推荐使用。 不推荐使用 TWSLANamespace。
SLA 名称空间包含运行时服务级别协议统计信息

TWServiceClass

TWObject，是系统内所有变量的包装程序。

Type属性目录
TWViewNamespace businessData 描述不适用
TWEnvironmentNamespace env 环境名称空间包含所有环境变量。
TWServiceEpvNamespace epv epv 名称空间包含连接此服务的公开的流程值。
TWServiceGlobalNamespace global 不推荐使用。 已不推荐使用全局名称空间
包含所有专用变量，输入变量和输出变量的全局名称空间。
TWServiceLocalNamespace local 包含所有私有、输入和输出变量的本地名称空间。
TWObjectNamespace object 包含系统常量的系统名称空间。
TWViewNamespace options 描述不适用
TWPerfNamespace perf 这是公开业绩服务器数据的 perf 名称空间
TWServiceResourceNamespace resource 资源名称空间包含连接此服务的资源束组。
TWServiceSystemNamespace system 包含系统常量的系统名称空间。

TWServiceSystem名称空间

用于使用“tw.system”从服务上下文访问和操纵系统数据的名称空间。 它包含关于系统和特定服务实例的有用变量和常量。

Type属性目录
String buttonPressed 按 Coach 按钮时表达式的值
CoachValidation coachValidation Coach 验证对象
ActivityInstance currentAdHocActivityInstance 正在执行的当前特别活动实例（如果有）
TWProcess currentProcess 获取当前流程
TWProcessInstance currentProcessInstance 获取当前流程实例
String currentProcessInstanceID 当前 BPD 实例标识
TWTask currentTask 获取当前任务
TWHolidaySchedule defaultHolidaySchedule 包含系统缺省假期安排的系统名称空间。
TWTimeSchedule defaultTimeSchedule 包含系统缺省时间安排的系统名称空间。
String defaultTimeZone 包含系统缺省时区的系统名称空间。
XMLElement error 包含有关上次错误的信息
String error_type 包含有关上次错误类型的信息。 可能值为 "PRE"、"ITEM" 和 "POST"
TWHeaderNamespace header 包含头信息访问权的系统名称空间。
TWHolidaySchedule[] holidaySchedules 包含所有假期安排访问权的系统名称空间。
TWInstallNamespace install 包含安装历史记录信息访问权的系统名称空间。
TWModelNamespace model 提供模型对象的访问权。
OrgNamespace org 提供用户组织的访问权。
String result 返回上次执行项所导出的数据。 如果为发送任务组件，\n它返回有关已创建任务的信息。
Serializer serializer 提供 IBM Business Automation Workflow 变量的序列化/反序列化方法。
TWService serviceFlow 获取服务流。
String task_id 当前任务标识
String temporary_directory 包含可用于存储临时 files.\n 它从配置系统填充并以文件分隔符结尾
TWTimeSchedule[] timeSchedules 包含所有时间安排访问权的系统名称空间。
TWUser user 包含当前用户访问权的系统名称空间。
String user_fullName 当前用户全名
String user_id 当前用户标识
String user_locale I18N 支持使用的当前用户集语言环境的当前 Java 表示法。
String user_localeCountry 不推荐使用。 新的 I18N 系统不使用此属性。 使用 user_locale。
当前用户所在的国家/地区。 这些代码是由 ISO-3166.\n 定义的大写字母二字母代码，可从 http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html 获取完整列表
String user_localeDescription 以用户本地语言撰写的人类可读的用户语言环境描述。
String user_localeLanguage 不推荐使用。 新的 I18N 系统不使用此属性。 使用 user_locale。
当前用户本地语言。 这些代码是由 ISO-639.\n 可从 http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt 获取完整列表所定义的小写两字母代码
String user_loginName 当前用户登录名
String user_timeZone 当前用户时区
String user_timeZoneOffset 当前用户时区偏移
String user_timeZoneOffset 当前用户时区偏移
方法概要
String addCaseCalendarSubscription(String caseId , String objectStoreName , String subscription , String asAdministrator) 为案例添加新的日历预订。
void addCoachValidationError(CoachValidation coachValidation , String errorBOPath , String errorMessage) 向 CoachValidation 类型的实例添加验证错误。 如果已存在具有给定 BO 路径的错误，那么将更新错误消息。
String addCommentToCase(String caseId , String objectStoreName , String comment , String asAdministrator) 向案例实例添加注释。
boolean addHolidaySchedule(TWHolidaySchedule holidaySchedule) 添加 TWHolidaySchedule 的新实例，该实例将包括在 "tw.system.holidaySchedules" 中的假期调度列表中。
boolean addTimeSchedule(TWTimeSchedule timeSchedule) 添加 TWTimeSchedule 的新实例，该实例将包括在 "tw.system.timeSchedules" 中可用的时间安排列表中。
String[] allVars() 返回名称空间中所有变量名称的数组
String assignNextTask(String groupId , String sortCriteria , Boolean enabledRetryOptimization , String userId) 描述不适用
String assignNextTaskByTeamName(String teamName , String sortCriteria , Integer optimizationLevel , Boolean includeAllSnapshotTasks , String userId) 描述不适用
String bidiTransform(String src , String inputFormat , String outputFormat , boolean symmetricSwapping) 返回 Bidi 变换的输出值。
TWDate calculateBusinessDate(TWDate originalDate , Integer delta , String units , TWWorkSchedule workSchedule) 计算从 originalDate开始的业务日期，根据给定的 workSchedule，按给定单位 (月，日，小时，分钟) 的给定增量 (负值表示减少) 进行更改。 例如，如果原始日期位于星期六或星期日，增量为 -1 天，工作安排设置为星期一至星期五上午 9 点到下午 5 点且无一组假日安排，那么计算的日期将是星期五上午 9:00。 如果增量为 1 天，那么生成的日期将为星期二上午 9:00。 在正演计算中，在后退时将跳过 1 个工作日，返回工作日的开始时间。
void clearCoachValidationErrors(CoachValidation coachValidation) 清除所有 Coach 验证错误。
void clearError() 清除错误变量 tw.system.error
String completeCurrentStage(String caseId , String objectStoreName , String asAdministrator) 完成当前案例阶段并前进到下一个案例阶段 (如果存在下一个案例阶段)。 返回下一个案例阶段的名称，下一个阶段是新父案例阶段。 如果不存在下一个案例阶段，那么该字符串包含“CmAcmComplete”。
String convertIDToDB(String id) 将输入的外部标识转换为适合在数据库查询中使用的标识
String createCase(String caseType , String objectStoreName , Record caseProperties , String[] caseStructure , String asAdministrator) 描述不适用
String createDiscretionaryActivityWithProps(String caseId , String objectStoreName , String discretionaryActivityName , String[] activityPropertyNames , String[] activityPropertyValues , Boolean asAdministrator , String newActivityName) 描述不适用
variableTypeName[] createFromSql(String variableTypeName , String jndiName , String sqlQuery , ANY params) 返回指定变量类型名称的对象列表。 对象包含 SQL 查询的结果。
void createFromXmlElement(String variableTypeName , Element xml) 返回 {variableTypeName} 对象的数组，这些对象包含给定XML化记录集中的数据。
BPMFailedOperation[] deleteAlertDefinitions(String[] ids , Boolean checkAuthorization) 根据给定的标识列表删除警报定义。
String escapeHtml(String content) 对可能包含特殊字符的输入字符串进行美化。 此函数可用于避免潜在的跨站点脚本编制 (XSS) 攻击。
Map executeServiceByName(String name , Map inputValues) 使用给定名称启动服务。 为异步调用启用的传统人员服务和服务流均不支持此 API。
ActivityInstance findActivityInstanceByID(String activityId) 返回按标识找到的活动实例。
TWDocument findDocumentByID(String documentId) 返回按标识找到的文档。
TWHelpRequest findHelpRequestByID(String id) 按标识查找帮助请求
TWHolidaySchedule findHolidayScheduleByName(String name) 在 "tw.system.holidaySchedules" 中的可用时间调度列表中按名称查找 TWHolidaySchedule 。
TWProcessInstance findProcessInstanceByID(String id) 返回按标识找到的进程。
TWTask findTaskByID(Integer taskID) 返回按标识找到的任务。
TWTask findTaskByID(String taskID) 返回按标识找到的任务。
TWTimeSchedule findTimeScheduleByName(String name) 按 "tw.system.timeSchedules" 中可用的时间安排列表中的名称查找 TWTimeSchedule 。
BPMAlertDefinition[] getAlertDefinitions( String[] categoryFilter , Boolean checkAuthorization) 返回警报定义的列表。
BPMAlertDefinitionStatusResponse getAlertDefinitionsStatus(String[] ids , Boolean checkAuthorization) 返回指定的警报定义列表的当前运行时值，包括实际值以及是否满足条件。
String getCaseCalendarEvents(String caseId , String objectStoreName , String asAdministrator) 获取案例的日历事件。
String getCaseCalendarSubscriptions(String caseId , String objectStoreName , String asAdministrator) 获取案例的日历预订信息。
String getCaseConfiguration(String caseId , String objectStoreName , String asAdministrator) 获取案例类型的配置。
String getECMDefaultTargetRepositoryName() 描述不适用
String getECMFolderPath(String serverName , String folderId) 描述不适用
String getEnvironmentVariableValue(String processAppAcronym , String snapshotAcronym , String environmentVariableName) 在指定流程应用程序 Snapshot 的上下文中返回指定环境变量的当前值。
String initializeContentObject(String caseType , String objectStoreName , String caseID) 描述不适用
BPMRESTResponse invokeREST(BPMRESTRequest request) 用于通过 REST 绑定调用外部服务的函数。
void populateCoachValidationFromBOSaveFailedError(CoachValidation coachValidation , BPMBOSaveFailedError boSaveFailedError) 使用 BOSaveFailed错误实例中的验证错误填充 CoachValidation 实例。
void reassignTask(Integer taskId , String reassignTo , ANY resetTask) 不推荐使用。 已不推荐使用 reassignTask()。 请改为在 TWTask 中使用 reassignTo() 函数
将任务重新分配给另一个用户或角色。
String refreshCaseCalendarSubscription(String objectStoreName , String subscriptionId , String asAdministrator) 刷新日历预订。
String removeCaseCalendarSubscription(String objectStoreName , String subscriptionId , String asAdministrator) 删除日历预订。
boolean removeCoachValidationError(CoachValidation coachValidation , String errorBOPath) 除去给定业务对象路径的 Coach 验证错误
boolean removeHolidaySchedule(String id) 从 "tw.system.holidaySchedules" 中提供的假日调度列表中除去具有给定标识的 TWHolidaySchedule 。
boolean removeTimeSchedule(String id) 从 "tw.system.timeSchedules" 中可用的时间安排列表中除去具有给定标识的 TWTimeSchedule 。
InstanceListData retrieveInstanceList(InstanceListProperties properties , Integer maxRows , Integer beginIndex , Boolean checkAuthorization) 不推荐使用。 在容器环境中不推荐使用 retrieveInstanceList 方法。 当前没有替换项。
根据给定属性返回实例列表。
ProcessSummary[] retrieveProcessSummaries( String searchFilter , Boolean checkAuthorization) 返回项目中所有活动/已部署的流程的流程摘要计数列表。
TaskDueData retrieveTaskDueData(TaskDueProperties properties , String timezone) 返回给定到期日期时间片的任务到期数据。
TaskListData retrieveTaskList(TaskListProperties properties , Integer maxRows , Integer beginIndex , String timezone) 返回给定团队，团队成员或用户的任务列表。
TeamTaskSummary[] retrieveTeamSummaries( String searchFilter , String timeZoneAsString , Boolean checkAuthorization) 检索所有团队的活动任务的汇总计数数据。
BPMAlertDefinition[] saveAlertDefinitions(BPMAlertDefinition[] definitions , Boolean importMode , Boolean checkAuthorization) 保存数据库中的警报定义列表。
void saveCaseProperties(String caseID , String objectStoreName , Record caseProperties , String asAdministrator) 描述不适用
String sortByNextBestTask(String taskList , String workerId) 对给定工作程序标识的任务列表进行排序，以根据具有该标识的工作程序的技能集以及将产生最大影响的内容来显示该工作程序应该处理的下一个任务。 生成的任务列表会进行排序并返回，但不会修改已位于列表中的对象。 如果无法与 AI Agent Server 建立连接，那么 API 将返回 null。 在这种情况下，会将错误记录在系统日志中。
String splitCase(String caseInstanceId , String objectStoreName , String caseType , Record caseProperties , String[] docsToFile , String description , String[] asAdministrator) 描述不适用
TWProcessInstance startProcessByName(String name , Map inputValues , Boolean checkAuthorization) 使用给定名称启动 BPD。
String toString() 返回名称空间的字符串表示
void trainNextBestTask() 使用 Business Automation Insights中的最新数据来刷新任务优先级划分模型。
String unescapeHtml(String content) 解析输入字符串中可能存在的转义字符，可能是调用 tw.system.escapeHtml() 的结果。 返回未转义的字符串。
String updateCaseCalendarSubscription(String objectStoreName , String subscriptionId , String subscriptionInfo , String asAdministrator) 更新现有日历预订。
boolean updateCoachValidationErrorMessage(CoachValidation coachValidation , String errorBOPath , String errorMessage) 更新给定业务对象路径的验证错误消息。
void updateCurrentInstanceVariablesByCurrentTaskOwner(Object values , Boolean isTopLevel) 按当前任务所有者更新当前实例变量。
boolean updateHolidaySchedule(TWHolidaySchedule holidaySchedule) 更新 TWHolidaySchedule的实例。
boolean updateTimeSchedule(TWTimeSchedule timeSchedule) 更新 TWTimeSchedule的实例。
String variableTypeForVariable(String fullyQualifiedVariableName) 返回与变量关联的 IBM Business Automation Workflow 变量类型的名称