ferencerdei commented on code in PR #6376: URL: https://github.com/apache/nifi/pull/6376#discussion_r968135546
########## nifi-nar-bundles/nifi-workday-bundle/nifi-workday-processors/src/main/resources/docs/org.apache.nifi.processors.workday.GetWorkdayReport/additionalDetails.html: ########## @@ -0,0 +1,103 @@ +<!DOCTYPE html> +<html lang="en"> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<head> + <meta charset="utf-8"/> + <title>GetWorkdayReport</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> +</head> + +<body> +<h2>Summary</h2> +<p> + This processor acts as a client endpoint to interact with the Workday API. + It is capable of reading reports from Workday RaaS and transferring the content directly to the output, or you can define + the required Record Reader and RecordSet Writer, so you can transform the report to the required format. +</p> + +<h2>Supported report formats</h2> + +<ul> + <li>csv</li> + <li>simplexml</li> + <li>json</li> +</ul> + +<p> + In case of json source you need to set the following parameters in the JsonTreeReader: + <ul> + <li>Starting Field Strategy: Nested Field</li> + <li>Starting Field Name: Report_Entry</li> + </ul> +</p> + +<p> + It is possible to hide specific columns from the response if you define the Writer scheme explicitly in the configuration of the RecordSet Writer. +</p> + +<h2> + Example: Remove name2 column from the response +</h2> +<p> + Let's say we have the following record structure: +</p> +<code> + <pre> + RecordSet ( + Record ( + Field "name1" = "value1", + Field "name2" = 42 + ), + Record ( + Field "name1" = "value2", + Field "name2" = 84 + ) + ) + </pre> +</code> + +<p> + If you would like to remove the "name2" column from the response, then you need to define the following writer schema: +</p> + +<code> + <pre> + { + "name": "test", + "namespace": "nifi", + "type": "record", + "fields": [ + { "name": "name1", "type": "string" } + ] + } + </pre> +</code> + +<h2> + Example: Hash selected columns +</h2> + +<p> + If you would like to keep a column in the response, but hash the value, you can do it by defining the record path selector and a hashing algorithm. + <ul> + <li>Columns to hash: /personalId,/emailAddress</li> + <li>Hashing algorithm: SHA-512</li> + </ul> + The above example hashes the PersonalId and emailAddress columns. Review Comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
