Skip to content
REFERENCE

U.GET_METADATA

Summary

Used to retrieve the metadata of reports published by Excel or another application

Syntax

=U.GET_METADATA(report_group_or_topic, report_name, [metadata_key], [convert_types], [metadata], [environment])

Parameters

Parameter Required Description
report_group OR topic Yes Usually set to a field containing a valid topic, most commonly a cell containing a call to U.SUBSCRIBE. Otherwise, the group of reports to which the report belongs
report_name Depends The name of the report, which is unique within the report group. This field is optional if the first field is set to a full topic
[metadata_key] No The name or partial name of the specific metadata entry whose value, if the entry exists, will be returned. If not set then a report of all metadata entries is returned
[convert_types] No If set to TRUE then returned metadata entries are converted from text to their original data types (number, datetime or boolean). If set to "TOC" a table of contents for the report is returned
[metadata] No Collection of key/value pairs that can be used to annotate the request. Certain metadata entries are recognized by the U Add-in and/or server and are used to control various bits of functionality
[environment] No An optional routing override that can be used to get the report from a non-default environment.

Behavior

The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.

Return Value

Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.

Examples

=U.GET_METADATA(C112)

=U.GET_METADATA(C112,,C135)

=U.GET_METADATA(C112,,C135,TRUE)

Notes

  • Formula examples are preserved from maintained workbook usage and normalized to the current U. prefix.
  • Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
  • Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
  • For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.