Enterprise Content Management (ECM) 操作中的数据映射

Draft comment:
This topic is shared by BAW, CP4BA, CP4BASaaS. Last updated on 2025-01-20 10:38
每个操作都需要变量映射到输入和输出字段。 使用自动映射功能可自动创建正确类型的变量,并将这些变量分配给每个字段。
注:Process Designer中,内容管理互操作性服务 (CMIS) 规范用于确定哪些操作参数标记为可选。 但是,标记为可选的参数实际上可能对于一些 ECM 系统(如 Microsoft SharePoint)是可选的。 您可以参考 ECM 系统文档以确定参数对于 ECM 系统是可选还是必需的。

向文件夹中添加文档

输入:

  • 父文件夹标识 (ECMID): 要引用其子文档的 BPM 受管存储 文件夹的标识。 对于其他服务器,是指将包含该文档的文件夹的标识。
  • 文档标识 (ECMID): 对于 BPM 受管存储 服务器,这是外部 ECM 系统中文档的标识。 对于其他服务器,是指文档对象的唯一标识。
  • 文档服务器名称 (字符串): 对于 BPM 受管存储 服务器,这是外部系统的 ECM 服务器的名称。 对于其他服务器,此参数不可用。
  • 引用名称 (字符串): (可选) 对于 BPM 受管存储 服务器,是所引用文档的名称。 对于其他服务器,此参数不可用。
  • 服务器名称(字符串):包含该文档的服务器的名称。

输出:

  • 不返回任何输出。

向文件夹添加文件夹

输入:

  • 父文件夹标识 (ECMID): 要引用其子文件夹的 BPM 受管存储 文件夹的标识。
  • 文件夹标识 (ECMID):外部 ECM 系统中文件夹的标识。
  • 文件夹服务器名称(字符串):外部系统的 ECM 服务器的名称。
  • 引用名称(字符串):(可选)所引用文件夹的名称。
  • 服务器名称(字符串):包含该文件夹的服务器的名称。

输出:

  • 不返回任何输出。

取消检出文档

输入:

  • 专用工作副本文档标识 (ECMID):文档对象专用工作副本的唯一标识。
  • 服务器名称 (String):包含原始文档的服务器的名称。

输出:

  • 不返回任何输出。

检入文档

输入:

  • 专用工作副本文档标识 (ECMID):文档对象专用工作副本的唯一标识。
  • 主要 (Boolean):(可选)已检入文档的版本指示符。 如果设置为 true,那么文档为主版本,这是缺省值。
  • 内容流 (ECMContentStream):(可选)包含文档(如字处理文档或图像)内容的数据流。 有关 ECMContentStream 数据类型的信息可在主题 使用文档内容中找到。
  • 检入注释 (String):(可选)有关检入文档的注释。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):要包含原始文档的服务器的名称。

输出:

  • 文档标识 (ECMID):文档对象的唯一标识。

检出文档

输入:

  • 文档标识 (ECMID):文档对象的唯一标识。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 专用工作副本文档标识 (ECMID):文档对象专用工作副本的唯一标识。

复制文档

输入:

  • 文档标识 (ECMID):文档的唯一标识。
  • 父文件夹标识 (ECMID):用于文档的父文件夹的唯一标识。
  • 名称 (String):(可选)已复制文档的新名称。 设置名称后,该名称将覆盖 ECMProperty 列表中的名称(如果指定)。
  • 版本控制状态 (String):(可选)定义文档版本的名称。 有效值为:
    • major:(缺省值)已复制文档为主版本。 如果禁用了版本控制,那么 major 值是无效的版本控制状态,并且您必须改为使用 none 值。
    • minor:已复制文档为次版本。
    • checkedout:已复制文档的状态为已检出。
    • none:无法对已复制文档进行版本控制。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):文档所在的服务器的名称。

输出:

  • 文档标识 (ECMID):新文档的唯一标识。

创建文档

输入:

  • 对象类型标识 (ECMID):该标识与 ECM 系统上定义的用于创建文档的类名相对应。 例如,值 cmis:document 可用于定义基本文档。 或者,也可以使用与派生自 cmis:document 的类对应的类名。 如果选择BPM document store作为服务器名称,IBM_BPM_Document将自动指定对象类型标识,并且无法对其进行更改。
  • 文件夹标识 (ECMID):文档父文件夹的标识。 指定为值的右斜杠字符 (/) 表示目标服务器中的 Root 文件夹。 或者,也可以指定 Root 的相对文件夹名称,例如 /MyFolder
  • 名称 (字符串): 文档的名称。
  • 版本控制状态 (String):(可选)定义文档版本的名称。 有效值为:
    • major:(缺省值)已创建文档为主版本。 如果禁用了版本控制,那么 major 值是无效的版本控制状态,并且您必须改为使用 none 值。
    • minor:已创建文档为次版本。
    • checkedout:已创建文档的状态为已检出。
    • none:无法对已创建文档进行版本控制。
  • 内容流 (ECMContentStream):(可选)包含文档(如字处理文档或图像)内容的数据流。 有关 ECMContentStream 数据类型的信息可在主题 使用文档内容中找到。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):文档所在的服务器的名称。

输出:

  • 文档标识 (ECMID):该字段的值用于标识将由服务用于存储新文档的唯一标识的变量。 例如,如果定义了名为 outputDocumentId 的输出变量,那么可使用字段的选择器按钮将该值设置为 tw.local.outputDocumentId。 在成功运行创建文档操作后,新文档的唯一标识将由系统生成并分配给变量。

创建文件夹

输入:

  • 对象类型标识 (ECMID):对象类型的标识。 其基本类型必须是文件夹。
  • 父文件夹标识 (ECMID):父文件夹的标识。
  • 名称 (字符串): 文件夹的名称。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):文件夹所在的服务器的名称。

输出:

  • 文件夹标识 (ECMID):新文件夹的唯一标识。

删除文档

输入:

  • 文档标识 (ECMID):文档对象的唯一标识。
  • 所有版本 (Boolean):(可选)声明是否要删除文档的所有版本。 缺省值为 true。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 不返回任何输出。

删除文件夹

输入:

  • 文件夹标识 (ECMID):文件夹对象的唯一标识。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 不返回任何输出。

获取所有文档版本

输入:

  • 版本序列标识 (ECMID):存储在 cmis:versionSeriesId 属性中的版本序列标识。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 文档 (ECMDocument []):文档的所有版本。

获取子代

输入:

  • 文件夹标识 (ECMID):引用子代(可以是文档和文件夹)的文件夹标识。
  • 最大项数 (整数): (可选) 此值不会覆盖在存储库级别配置的最大值,例如 defaultMaxItems
  • 跳过计数(整数):(可选)在返回结果之前,存储库必须跳过或翻过的可能结果数。 缺省值为 0。
  • 排序依据(字符串):(可选)查询名称的逗号分隔列表,以及每个查询名称的升序修饰符 (ASC) 或降序修饰符 (DESC)。
  • 过滤器(字符串):(可选)属性定义查询名称的逗号分隔列表。 此操作只会返回匹配对象中的属性(如果这些属性同时存在于匹配的对象类型定义和过滤器中)。
  • 包含允许的操作(布尔):(可选)为查询中所返回对象检索可用操作的指示符。 缺省值为 false。
  • 服务器名称(字符串):包含该文件夹的服务器的名称。

输出:

  • 搜索结果 (ECMSearchResult):与输入条件匹配的文档和文件夹的列表。

获取文档

输入:

  • 文档标识 (ECMID):文档的唯一标识。
  • 服务器名称 (String):包含文档的服务器的名称。
  • 最大项数 (整数): 此值不会覆盖在存储库级别配置的最大值,例如, defaultMaxItems

输出:

  • 文档 (ECMDocument):文档对象。

获取文档内容

输入:

  • 文档标识 (ECMID):文档的唯一标识。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 内容流 (ECMContentStream):(可选)包含文档内容的数据流。 有关 ECMContentStream 数据类型的信息可在主题 使用文档内容中找到。

获取文件夹中的文档

返回的文档数取决于存储库的配置值。 缺省值通常为 25 ,可以在内容管理互操作性服务 (CMIS) 中使用 defaultMaxItems 进行更改。

输入:

  • 文件夹标识 (ECMID):包含文档的文件夹的唯一标识。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 文档 (ECMDocument []):文件夹中包含的文档。

获取文件夹

输入:

  • 文件夹标识 (ECMID):文件夹的唯一标识。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 文件夹 (ECMFolder):文件夹对象。

按路径获取文件夹

输入:

  • 路径 (String):文件夹的路径。 “/”表示 Root 文件夹。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 文件夹 (ECMFolder):文件夹对象。

获取文件夹树

输入:

  • 文件夹标识 (ECMID):文件夹的唯一标识。 它指示树结构的顶层。
  • 深度 (Integer):(可选)要返回的文件夹层数。 缺省值 -1 表示返回所有后代文件夹。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 文件夹 (ECMFolder []):包含在指定文件夹及其后代层中的文件夹对象。

获取类型定义

输入:

  • 对象类型标识 (ECMID):对象类型的标识。
  • 服务器名称 (String):包含对象类型的服务器的名称。

输出:

  • 对象类型定义 (ECMObjectTypeDefinition):类型的定义。 ECMObjectTypeDefinition 对象包含类型元数据。

获取类型后代

输入:

  • 对象类型标识 (ECMID):(可选)对象类型的标识。 如果未指定,将返回所有 Root 对象类型。
  • 深度 (Integer):(可选)要返回的类型层次结构的层数。 缺省值 -1 表示返回所有后代类型。
  • 包含属性定义 (Boolean):(可选)指定是否要返回类型属性的指示符。 缺省值 false 表示不包含类型属性。
  • 服务器名称 (String):包含对象类型的服务器的名称。

输出:

  • 对象类型定义 (ECMObjectTypeDefinition []):一系列类型定义。 ECMObjectTypeDefinition 对象包含类型元数据。

移动文档

输入:

  • 文档标识 (ECMID):文档的唯一标识。
  • 目标文件夹标识 (ECMID):用于文档的新文件夹的唯一标识。
  • 源文件夹标识 (ECMID):用于文档的当前文件夹的唯一标识。
  • 服务器名称 (String):包含文档和文件夹的服务器的名称。

输出:

  • 不返回任何输出。

移动文件夹

输入:

  • 文件夹标识 (ECMID):文件夹的标识。
  • 目标文件夹标识 (ECMID):新的父文件夹的标识。
  • 源文件夹标识 (ECMID):旧的父文件夹的标识。
  • 服务器名称 (String):标识相应 ECM 存储库的 ECM 服务器的名称。

输出:

  • 不返回任何输出。

从文件夹中除去文档

输入:

  • 父文件夹标识 (ECMID): 要对其取消引用子文档的 BPM 受管存储 文件夹的标识。 对于其他服务器,是指该文档的父文件夹的可选标识;如果未指定,将从所有文件夹中除去该文档。
  • 文档标识 (ECMID): 对于 BPM 受管存储 服务器,这是外部 ECM 系统中文档的标识。 对于其他服务器,是指文档的唯一标识。
  • 文档服务器名称 (字符串): 对于 BPM 受管存储 服务器,这是外部系统的 ECM 服务器的名称。 对于其他服务器,此参数不可用。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 不返回任何输出。

从文件夹中除去文件夹

输入:

  • 父文件夹标识 (ECMID): 要取消引用其子文件夹的 BPM 受管存储 文件夹的标识。
  • 文件夹标识 (ECMID):外部 ECM 系统中文件夹的标识。
  • 文件夹服务器名称(字符串):外部系统的 ECM 服务器的名称。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 不返回任何输出。

重命名文档引用

输入:

  • 父文件夹标识 (ECMID): 引用了子文档的 BPM 受管存储 文件夹的标识。
  • 文档标识 (ECMID): 对于 BPM 受管存储 服务器,这是外部 ECM 系统中文档的标识。
  • 文档服务器名称 (字符串): 对于 BPM 受管存储 服务器,这是外部系统的 ECM 服务器的名称。
  • 引用名称 (字符串): 对于 BPM 受管存储 服务器,这是所引用文档的新名称。
  • 服务器名称(字符串):包含该文件夹的服务器的名称。 使用数据映射时,服务器名称必须为 ECMServerNames.IBM_BPM_MANAGED_STORE。

输出:

  • 不返回任何输出。

重命名文件夹引用

输入:

  • 父文件夹标识 (ECMID): 引用了子文件夹的 BPM 受管存储 文件夹的标识。
  • 文件夹标识 (ECMID):外部 ECM 系统中文件夹的标识。
  • 文件夹服务器名称(字符串):外部系统的 ECM 服务器的名称。
  • 引用名称(字符串):引用的文件夹的新名称。
  • 服务器名称(字符串):包含该文件夹的服务器的名称。 使用数据映射时,服务器名称必须为 ECMServerNames.IBM_BPM_MANAGED_STORE。

输出:

  • 不返回任何输出。

设置文档内容

输入:

  • 文档标识 (ECMID):文档的唯一标识。
  • 内容流 (ECMContentStream):包含文档(如字处理文档或图像)内容的数据流。 有关 ECMContentStream 数据类型的信息可在主题 使用文档内容中找到。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 文档标识 (ECMID):文档的唯一标识。

设置文档内容操作只能在运行检出文档之后以及运行检入文档操作之前使用。

更新文档属性

输入:

  • 文档标识 (ECMID):文档对象的标识。
  • 名称 (String):(可选)文档的新名称。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):包含文档的服务器的名称。

输出:

  • 文档标识 (ECMID):文档的唯一标识。

更新文件夹属性

输入:

  • 文件夹标识 (ECMID):文件夹对象的标识。
  • 名称 (String):(可选)文件夹的新属性。
  • 属性 (ECMProperty []):(可选)可以任何顺序排序的一组指定属性。
  • 服务器名称 (String):包含文件夹的服务器的名称。

输出:

  • 文件夹标识 (ECMID):文件夹的唯一标识。