Skip to content
REFERENCE

U.DISTRIBUTE_WORKBOOK

Summary

Publishes a workbook to a specified distribution channel

Syntax

=U.DISTRIBUTE_WORKBOOK(distribution_id, [workbook_name], [prior_workbook_names], [users], [metadata], [block])

Parameters

Parameter Required Description
distribution_id Yes The one-time code required to enable a distribution
[workbook_name] No The name of the workbook that is being distributed. Must match the name of a workbook open in the current instance of Excel that contains a fully-specified U.READ_ONLY method. Workbook calling this method is distributed if not set
[prior_workbook_names] No A list of prior names for the workbook that may still be open by some users and need to be updated to the distributed version whose name has changed
[users] No The list of users who will receive the updated workbook. If not set then all non-editor users of the workbook will receive the update
[metadata] No Additional metadata to be applied to report being published. If specified this metadata is combined with the distribute_workbook metadata into a single list of metadata entries
[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

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.DISTRIBUTE_WORKBOOK("XCJQR")

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.