Parses a Microsoft Excel document returning each row in each sheet as a separate record. This reader allows for inferring a schema from all the required sheets or providing an explicit schema for interpreting the values.See Controller Service's Usage for further documentation. This reader is currently only capable of processing .xlsx (XSSF 2007 OOXML file format) Excel documents and not older .xls (HSSF '97(-2007) file format) documents.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Schema Access Strategy | schema-access-strategy | Infer Schema | - Use 'Schema Name' Property
 - Use 'Schema Text' Property
- Schema Reference Reader
- Infer Schema
| Specifies how to obtain the schema that is to be used for interpreting the data. |
| Schema Registry | schema-registry | | Controller Service API:
SchemaRegistry
Implementations: ConfluentSchemaRegistry
AmazonGlueSchemaRegistry
DatabaseTableSchemaRegistry
AvroSchemaRegistry
ApicurioSchemaRegistry | Specifies the Controller Service to use for the Schema Registry
This Property is only considered if the [Schema Access Strategy] Property is set to one of the following values: [Schema Reference Reader], [Use 'Schema Name' Property] |
| Schema Name | schema-name | ${schema.name} | | Specifies the name of the schema to lookup in the Schema Registry property
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property". |
| Schema Version | schema-version | | | Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property". |
| Schema Branch | schema-branch | | | Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property". |
| Schema Text | schema-text | ${avro.schema} | | The text of an Avro-formatted Schema
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Text' Property". |
| Schema Reference Reader | schema-reference-reader | | Controller Service API:
SchemaReferenceReader
Implementation: ConfluentEncodedSchemaReferenceReader | Service implementation responsible for reading FlowFile attributes or content to determine the Schema Reference Identifier
This Property is only considered if the [Schema Access Strategy] Property has a value of "Schema Reference Reader". |
| Starting Row | Starting Row | 1 | | The row number of the first row to start processing (One based). Use this to skip over rows of data at the top of a worksheet that are not part of the dataset.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Required Sheets | Required Sheets | | | Comma-separated list of Excel document sheet names whose rows should be extracted from the excel document. If this property is left blank then all the rows from all the sheets will be extracted from the Excel document. The list of names is case sensitive. Any sheets not specified in this value will be ignored. An exception will be thrown if a specified sheet(s) are not found.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
| Date Format | Date Format | | | Specifies the format to use when reading/writing Date fields. If not specified, Date fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java Simple Date Format (for example, MM/dd/yyyy for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters, as in 01/01/2017). |
| Time Format | Time Format | | | Specifies the format to use when reading/writing Time fields. If not specified, Time fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java Simple Date Format (for example, HH:mm:ss for a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 18:04:15). |
| Timestamp Format | Timestamp Format | | | Specifies the format to use when reading/writing Timestamp fields. If not specified, Timestamp fields will be assumed to be number of milliseconds since epoch (Midnight, Jan 1, 1970 GMT). If specified, the value must match the Java Simple Date Format (for example, MM/dd/yyyy HH:mm:ss for a two-digit month, followed by a two-digit day, followed by a four-digit year, all separated by '/' characters; and then followed by a two-digit hour in 24-hour format, followed by a two-digit minute, followed by a two-digit second, all separated by ':' characters, as in 01/01/2017 18:04:15). |