GetWorkdayReport 2.0.0

Bundle
org.apache.nifi | nifi-workday-processors-nar
Description
A processor which can interact with a configurable Workday Report. The processor can forward the content without modification, or you can transform it by providing the specific Record Reader and Record Writer services based on your needs. You can also remove fields by defining schema in the Record Writer. Supported Workday report formats are: csv, simplexml, json
Tags
Workday, report
Input Requirement
ALLOWED
Supports Sensitive Dynamic Properties
false
  • Additional Details for GetWorkdayReport 2.0.0

    GetWorkdayReport

    Summary

    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.

    Supported report formats

    • csv
    • simplexml
    • json

    In case of json source you need to set the following parameters in the JsonTreeReader:

    • Starting Field Strategy: Nested Field
    • Starting Field Name: Report_Entry

    It is possible to hide specific columns from the response if you define the Writer scheme explicitly in the configuration of the RecordSet Writer.

    Example: Remove name2 column from the response

    Let’s say we have the following record structure:

    RecordSet (
      Record (
        Field "name1" = "value1",
        Field "name2" = 42
      ),
      Record (
        Field "name1" = "value2",
        Field "name2" = 84
      )
    )
    

    If you would like to remove the “name2” column from the response, then you need to define the following writer schema:

    {                   "name": "test",                   "namespace": "nifi",                   "type": "record",                   "fields": [                     { "name": "name1", "type": "string" }                 ]                 }
    
Properties
Relationships
Name Description
success Response FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.
failure Request FlowFiles transferred when receiving socket communication errors.
original Request FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.
Writes Attributes
Name Description
getworkdayreport.java.exception.class The Java exception class raised when the processor fails
getworkdayreport.java.exception.message The Java exception message raised when the processor fails
mime.type Sets the mime.type attribute to the MIME Type specified by the Source / Record Writer
record.count The number of records in an outgoing FlowFile. This is only populated on the 'success' relationship when Record Reader and Writer is set.