GetWorkdayReport Processor
描述
可以与可配置的工作日报告交互的处理器。 Processor可以不加修改地转发内容,或者您可以根据您的需求通过提供特定的Record Reader和Record Writer服务来对其进行转换。 您还可以通过在Record Writer中定义架构来删除字段。 支持的 Workday 报告格式为:csv、simplexml、json
标签
属性
| 名称 | 默认值 | 可选值 | 描述 |
|---|---|---|---|
| Workday Report URL | | Workday 报告的 HTTP 远程 URL,包括 http 或 https 方案,以及带有可选端口和路径元素的主机名或 IP 地址。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Authorization Type | BASIC_AUTH |
| 从 Workday 资源检索数据的授权类型。 |
| Access Token Provider | | 控制器服务 API:OAuth2AccessTokenProvidercn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8 | 启用 OAuth2 承载令牌的托管检索。 |
| Workday Username | | 用于验证 Workday 请求的用户名。 使用 Base64 进行编码以进行 HTTP 基本身份验证,如 RFC 7617 中所述。 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Workday Password | | 用于验证 Workday 请求的密码。 使用 Base64 进行编码以进行 HTTP 基本身份验证,如 RFC 7617 中所述。 敏感属性:是 支持表达式语言:是(使用 FlowFile 属性与环境/系统变量求值) | |
| Web Client Service Provider | | 控制器服务 API:WebClientServiceProvidercn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8 | 用于与 Workday API 通信的 Web 客户端。 |
| Record Reader | | 控制器服务 API:RecordReaderFactorycn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8 | 指定用于解析传入数据并确定数据模式的 Controller Service。 |
| Record Writer | | 控制器服务 API:RecordSetWriterFactorycn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8 | 用于将记录序列化为输出FlowFile的Record Writer。 |
关系 (Relationships)
| 名称 | 描述 | 自动终止 |
|---|---|---|
failure | 接收套接字通信错误时请求传输的FlowFile。 | 否 |
original | 收到状态代码在 200 到 299 之间的 HTTP 响应时传输的请求FlowFile。 | 是 |
success | 收到状态代码在 200 到 299 之间的 HTTP 响应时传输的响应FlowFile。 | 否 |
写入的 FlowFile 属性
| 名称 | 描述 |
|---|---|
getworkdayreport.java.exception.class | 处理器失败时引发的 Java 异常类 |
getworkdayreport.java.exception.message | 处理器失败时引发的 Java 异常消息 |
mime.type | 将 mime.type 属性设置为源/Record Writer指定的 MIME 类型 |
record.count | 传出 FlowFile 中的记录数。仅在 Record Reader 和 Record Writer 配置时在 'success' 关系上填充 |
状态管理
该组件不存储状态。
受限 (Restricted)
该组件不受限。
输入要求
该组件允许有传入连接。
详细说明
GetWorkdayReport
概述
该 Processor 充当与 Workday API 交互的客户端端点。它能够从 Workday RaaS 读取报表,并把内容直接转移到输出;也可以定义 所需的 Record Reader 和 RecordSet Writer,把报表转换为 所需的格式。
支持的报表格式
- csv
- simplexml
- json
对于 json 来源,需要在 JsonTreeReader 中设置以下参数:
- Starting Field Strategy: Nested Field
- Starting Field Name: Report_Entry
如果在 RecordSet Writer 的配置中显式定义 Writer schema, 可以从响应中隐藏特定的列。
示例:从响应中移除 name2 列
假设有以下记录结构:
RecordSet (
Record (
Field "name1" = "value1",
Field "name2" = 42
),
Record (
Field "name1" = "value2",
Field "name2" = 84
)
)
如果想从响应中移除 "name2" 列,需要定义以下 writer schema:
{ "name": "test", "namespace": "lynxus", "type": "record", "fields": [ { "name": "name1", "type": "string" } ] }