GetWorkdayReport

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

Additional Details...

Tags:

Workday, report

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Workday Report URLWorkday Report URLHTTP remote URL of Workday report including a scheme of http or https, as well as a hostname or IP address with optional port and path elements.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Workday UsernameWorkday UsernameThe username provided for authentication of Workday requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Workday PasswordWorkday PasswordThe password provided for authentication of Workday requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Web Client Service ProviderWeb Client Service ProviderController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider
Web client which is used to communicate with the Workday API.
Record Readerrecord-readerController Service API:
RecordReaderFactory
Implementations: GrokReader
JsonTreeReader
WindowsEventLogReader
ReaderLookup
ParquetReader
CSVReader
Syslog5424Reader
ExcelReader
CEFReader
XMLReader
ScriptedReader
SyslogReader
JsonPathReader
AvroReader
YamlTreeReader
Specifies the Controller Service to use for parsing incoming data and determining the data's schema.
Record Writerrecord-writerController Service API:
RecordSetWriterFactory
Implementations: FreeFormTextRecordSetWriter
CSVRecordSetWriter
ParquetRecordSetWriter
RecordSetWriterLookup
ScriptedRecordSetWriter
XMLRecordSetWriter
JsonRecordSetWriter
AvroRecordSetWriter
The Record Writer to use for serializing Records to an output FlowFile.

This Property is only considered if the [Record Reader] Property has a value specified.

Relationships:

NameDescription
successResponse FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.
failureRequest FlowFiles transferred when receiving socket communication errors.
originalRequest FlowFiles transferred when receiving HTTP responses with a status code between 200 and 299.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
getworkdayreport.java.exception.classThe Java exception class raised when the processor fails
getworkdayreport.java.exception.messageThe Java exception message raised when the processor fails
mime.typeSets the mime.type attribute to the MIME Type specified by the Source / Record Writer
record.countThe number of records in an outgoing FlowFile. This is only populated on the 'success' relationship when Record Reader and Writer is set.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.