Skip to content
REFERENCE

U.PUBLISH

Summary

Used to publish data reports out of Excel for consumption by other Excel workbooks and applications that may be running on the same machine or other machines

Syntax

=U.PUBLISH(report_group, report_name, report_data, [metadata], [block], [environment])

Parameters

Parameter Required Description
report_group Yes The group of reports to which the report being published belongs. Can be any name determined by publisher
report_name Yes The name given to the report. Can be any name determined by publisher, but must be unique within the specified report group
report_data Yes The contents, typically a range of cells, of the report being published
[metadata] No Collection of key/value pairs that can be used to annotate the report; can be selected from multiple ranges. Certain metadata entries are recognized by the U Add-in and/or server and are used to control various bits of functionality
[block] No If set to TRUE then method will not be calculated unless triggered by user interaction or calculated as a step in a script; If set to a number then will be throttled to not calculate more frequently than the specified number of seconds; make number negative to prevent auto recalc of blocked methods
[environment] No An optional routing override that can be used to publish the report to 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 time of the publish attempt as an Excel date/time number. A blocked, skipped, invalid, or failed publish returns a status or error message instead.

Examples

=U.PUBLISH(F7,F8,B7:C9)

=U.PUBLISH(F18,F19,(B18:C20,B23:C25))

=U.PUBLISH(F33,F34,B37,U.PAGE_NAMES(B33:B34))

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.