Skip to main content

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

Tags

Workday, report

Properties

In the list below required Properties are shown with an asterisk (*). Other properties 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 URL *Workday 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, using FlowFile attributes and Environment variables.
Workday Username *Workday UsernameThe username provided for authentication of Workday requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

Supports Expression Language, using FlowFile attributes and Environment variables.
Workday Password *Workday PasswordThe password provided for authentication of Workday requests. Encoded using Base64 for HTTP Basic Authentication as described in RFC 7617.

Supports Expression Language, using FlowFile attributes and Environment variables.
Web Client Service Provider *Web Client Service ProviderController Service:
WebClientServiceProvider

Implementations:
StandardWebClientServiceProvider
Web client which is used to communicate with the Workday API.
Record Readerrecord-readerController Service:
RecordReaderFactory

Implementations:
AvroReader
CEFReader
CSVReader
ExcelReader
GrokReader
JsonPathReader
JsonTreeReader
ReaderLookup
ScriptedReader
Syslog5424Reader
SyslogReader
WindowsEventLogReader
XMLReader
YamlTreeReader
Specifies the Controller Service to use for parsing incoming data and determining the data's schema.
Record Writer *record-writerController Service:
RecordSetWriterFactory

Implementations:
AvroRecordSetWriter
CSVRecordSetWriter
FreeFormTextRecordSetWriter
JsonRecordSetWriter
RecordSetWriterLookup
ScriptedRecordSetWriter
XMLRecordSetWriter
The Record Writer to use for serializing Records to an output FlowFile.

This property is only considered if:
  • the property Record Reader has a value specified

Dynamic Properties

This component does not support dynamic properties.

Relationships

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

Reads Attributes

This processor does not read attributes.

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

This component does not specify system resource considerations.

See Also