Enables the ability to aggregate the content of identically-named sheets across multiple workbook files.

Data Type

bool

Default Value

false

Remarks

When this connection property is set to True, and if the URI connection property is set to a folder, the server aggregates the content of identically-named sheets from multiple workbook files into consolidated tables called aggregate sheet tables.

These aggregate sheet tables only draw from the workbooks that fall within the scope specified by the URI and IncludeSubdirectories connection properties -- all others are ignored.

To facilitate aggregation of identically-named sheets, a metadata source workbook must be selected. The server models each sheet from this workbook as an aggregate sheet table named after that sheet.

Each aggregate sheet table contains the combined content of all sheets that share the same name, across all selected workbooks.

You can explicitly designate a workbook file as the metadata source workbook with the MetadataDiscoveryURI connection property. If MetadataDiscoveryURI is not set, the first workbook file in the directory specified by the URI connection property is used as the metadata source workbook.

For example, if the metadata source workbook has a sheet named "SheetA", with this content:

and another workbook also has a sheet named "SheetA", with this content:

then the server would expose a single tabled called "SheetA", and querying this table would produce this aggregate result:

Considerations

• If any sheets contributing to the aggregate sheet table lack columns present in the metadata source workbook's instance of that sheet, the missing columns return null values in the aggregate sheet table.
• Workbook files that don't share any sheet names with the metadata source workbook are not included in aggregation sheet table records and are not exposed as separate tables.
• When this connection property is set to False, each sheet in each of the workbooks selected with URI and IncludeSubdirectories is exposed as its own table.