Skip to main content

Excel

This page describes the Excel-specific properties that appear in the Properties tab of Source and Target gems. These settings are the same for Excel files regardless of which connection type is configured in the gem (for example, S3, SFTP, or SharePoint).

If you need details on configuring a Source or Target gem end to end (including all tabs such as Location), see the documentation for the specific file storage connection:

info

You can also use the upload file feature to use Excel files. These will be stored in the SQL warehouse configured in your fabric.

Properties

Source properties

The following properties are available for the Excel Source gem.

PropertyDescriptionDefault
DescriptionDescription of the table.None
HeaderWhether the first row is the column header.True
Allow Undefined RowsWhether to permit rows with all values undefined (null or empty).True
Allow Incomplete RowsWhether to permit rows with missing values for some columns.True
Ignore Cell FormattingWhether to apply the number format for the cell value or get the raw value.True
Sheet Reading methodWhether to read one sheet of data or union the data from multiple sheets into one table. Learn more in Reading sheets.Read single sheet data
Skip Undefined RowsWhether to skip rows where all values are undefined.False
Date Format ReferenceDate format to use when parsing date values.2006-01-02
Time Format ReferenceTime format to use when parsing time values.15:04:05
Timestamp Format ReferenceTimestamp format to use when parsing date-time values.2006-01-02 15:04:05
Inference Data Sampling LimitMaximum number of rows to sample for inferring the schema.0
PasswordPassword for password-protected sheets.None

Reading sheets

Depending on the Sheet Reading method you choose, you will need to provide additional details.

Read single sheet data

For this option, Prophecy only reads one sheet of the Excel file.

Additional propertyDescription
Sheet NameProvide the name of the sheet to read. If the name you provide does not match the name of an existing sheet in the file, the gem will fail to run.

Read union of multiple sheet data

For this option, Prophecy reads the data from each of the sheets that you specify. Then, the data is unioned into one output table.

Additional propertyDescription
Sheet Filter ConditionChoose how you define the set of sheets to read.
  • Sheet name prefix equals: Read sheets whose names start with the provided value.
  • Sheet name suffix equals: Read sheets whose names end with the provided value.
  • Sheet name contains value: Read sheets whose names contain the provided substring.
  • Sheet name is in below list (comma separated): Read sheets whose names exactly match any comma-separated value provided in Filter Value.
Filter ValueProvide the value used to evaluate the filter condition.
Output Sheet Column NameProvide the name of the column to append to the output table that contains the original sheet name for each row.
info

The union operation will only succeed if each sheet has the same schema.

Target properties

The following properties are available for the Excel Target gem.

PropertyDescriptionDefault
DescriptionDescription of the table.None
Sheet Write methodChoose how rows are written.
  • Write data to a single sheet: All rows are written to one sheet specified in Sheet Name/Sheet Column Name. The sheet is created if it does not exist.
  • Dynamic data write to multiple sheets: Rows are partitioned by the value in the column specified in Sheet Name/Sheet Column Name, and each partition is written to a sheet with that name. Sheets are created as needed.
Write data to a single sheet
Sheet Name/Sheet Column NameConfigure the destination name reference.
  • Single sheet: Provide the exact sheet name to write to (for example, Sheet1).
  • Multiple sheets: Provide the column that contains the target sheet name for each row.
Sheet1
HeaderWhether to make the first row the column header.True
Ignore Cell FormattingWhether to apply the number format for the cell value or get the raw value.True
PasswordPassword for password-protected sheets.None