Skip to content
REFERENCE

U.REFRESH

Summary

Used to refresh on report in the U Add-in's cache with the most recent version available

Syntax

=U.REFRESH(report_group_or_topic, report_name, [metadata], [block], [environment])

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
[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
[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. Throttle also supported. If a version of the message is known the topic will be returned when the method is blocked. Provide a 2nd column here set to TRUE to return block message instead
[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.DO(U.REFRESH(C54,C55), U.NOW(60))

=U.REFRESH(G4,G5,,TRUE)

=U.DO(U.REFRESH(G4,G5),U.NOW(5))

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.