Skip to content
REFERENCE

U.SUBSCRIBE

Summary

Used to receive notifications of updates to reports published by Excel or another application

Syntax

=U.SUBSCRIBE(report_group_or_topic, report_name, [metadata], [environment], [auto_subscribe])

Parameters

Parameter Required Description
report_group OR topic Yes The group of reports to which the report belongs
report_name Yes The name of the report, which is unique within the report group. Not required if subscribing to a cache key
[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.
[auto_subscribe] No If set to TRUE(/FALSE) then autosubscribe of topic is enabled(/disabled) when Excel launches. Set to 32 (or 86) to enable for only 32-bit Excel, or 64 to enable for only 64-bit Excel. Only function channel topics supported. If set to TRUE and all other parameters are empty a report of auto-subscribe topics is returned. Also enables a non-RTD update mechanism.

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 an RTD-backed topic value that changes when an update is received. Pass that cell to U.GET to retrieve the current report body.

Examples

=U.SUBSCRIBE(C137,C138)

=U.SUBSCRIBE(C8,C9)

=VLOOKUP(B25,U.GET(U.SUBSCRIBE(C8,C9)),2,FALSE)

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.