REFERENCE
U.CREATE_SCRIPT
Summary
Specifies a series of calculations to be run sequentially
Syntax
Parameters
| Parameter | Required | Description |
|---|---|---|
script_name |
Yes | The unique name of the script |
steps |
Yes | The range of cells whose leftmost column is a list of methods to be run sequentially from top to bottom. An optional 2nd column contains a description associated with each step; descriptions support named insertions. An optional 3rd column can be used to override the default ignore_error setting just for that step |
[log_range] |
No | If set to a range, that range will be updated with the status of the script while it is running |
[ignore_errors] |
No | If set to TRUE, then any errors encountered in individual steps will be ignored by default |
[allow_non_run_calc] |
No | If set to TRUE then all methods in the steps range will be allowed to recalculate normally when the script is not running. By default certain workflow-related methods that are part of a specified script range will only calculate when recalculated during running of the script |
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
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.
Related
- Concept: Compiled and Invoked Functions
- Concept: Workbook Automation
- How-to: Run a Click-Driven Script