GetBoxFileCollaborators - ACAL Lynxus 组件文档

GetBoxFileCollaborators Processor

类型全限定名：cn.org.acal.lynxus.processors.box.GetBoxFileCollaborators

所属 Bundle：cn.org.acal.lynxus:lynxus-box-nar:2.11.8

描述

检索 Box 文件上的所有协作者，并将协作信息添加到 FlowFile 的属性中。

标签

boxstoragecollaborationpermissionssharing

属性

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称	默认值	可选值	描述
Box Client Service		控制器服务 API： `BoxClientService` cn.org.acal.lynxus-lynxus-box-services-api-nar-2.11.8	Controller Service用于获取 Box API 连接。
File ID	`${box.id}`		用于检索协作者的 Box 文件的 ID 支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Roles			要检索的协作角色逗号分隔列表。可用角色：editor、viewer、previewer、uploader、previewer uploader、viewer uploader、co-owner、owner。如果未指定，将不按角色过滤。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Statuses			要检索的协作状态逗号分隔列表。可用状态：accepted、pending、rejected。如果未指定，将不按状态过滤。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）

关系 (Relationships)

名称	描述	自动终止
`failure`	处理过程中遇到错误的FlowFile将被路由到此关系	否
`not.found`	未找到指定 Box 文件的 FlowFiles	否
`success`	已成功处理的FlowFile将被路由到此关系	否

写入的 FlowFile 属性

名称	描述
`box.id`	文件的 ID
`box.collaborations.<status>.users.ids`	按状态列出的以逗号分隔的用户协作者 ID 列表
`box.collaborations.<status>.groups.ids`	按状态列出的以逗号分隔的群组协作者 ID 列表
`box.collaborations.<status>.users.emails`	按状态列出的以逗号分隔的用户协作者电子邮件列表
`box.collaborations.<status>.groups.emails`	按状态列出的以逗号分隔的群组协作者电子邮件列表
`box.collaborations.<status>.<role>.users.ids`	按状态和角色分组的用户协作者 ID 的逗号分隔列表。仅在 Roles 和 Statuses 属性都存在时存在。
`box.collaborations.<status>.<role>.users.logins`	按状态和角色分组的用户协作者登录名的逗号分隔列表。仅在 Roles 和 Statuses 属性都存在时存在。
`box.collaborations.<status>.<role>.groups.ids`	按状态和角色分组的组协作者 ID 的逗号分隔列表。仅在 Roles 和 Statuses 属性都存在时存在。
`box.collaborations.<status>.<role>.groups.emails`	按状态和角色分组的组协作者电子邮件的逗号分隔列表。仅在 Roles 和 Statuses 属性都存在时存在。
`box.collaborations.count`	文件协作总数
`error.code`	Box 返回的错误代码
`error.message`	Box 返回的错误消息

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件要求有传入连接。

另请参阅