Script Function ACTIVATE_UC_OBJECT syntax is incorrectly documented, not all commas are mandatory

Products

• CA Automic Workload Automation - Automation Engine

Issue/Introduction

Error Message :
N/A

Automic's documentation for the syntax of the script function ACTIVATE_UC_OBJECT is not accurately displayed.  Most of the commas are shown outside of square brackets, which means that they are mandatory.  However, this is not the case as the funciton also works without any of those commas.

Investigation

Incorrect Syntax

ACTIVATE_UC_OBJECT(Object name, [WAIT], [Logical Date], [TimeZone], [Start time | Period object], , [PASS_VALUES], [Queue], [Alias], [ENABLE_PROMPTS], [Time Limit], [TERMINATE], [Run])

 

Corrected Syntax

ACTIVATE_UC_OBJECT(Object name[, [WAIT][, [Logical Date][, [TimeZone][, [Start time | Period object],[ , [PASS_VALUES][, [Queue][, [Alias][, [ENABLE_PROMPTS][, [Time Limit][, [TERMINATE][, [Run] ]]]]]]]]]])

Resources

Automation Engine v11 Documentation

Automation Engine Script Guide > Ordered by Function > Activate Objects > ACTIVATE_UC_OBJECT

Automation Engine v12 Documentation

Automic Scripting Guide > Ordered by Function > Activate Objects > ACTIVATE_UC_OBJECT

Environment

OS Version: N/A

Cause

Cause type:
Defect
Root Cause: The documented syntax for the ACTIVATE_UC_OBJECT script function indicates non-mandatory commas are mandatory.

Resolution

This field was added on 30/03/2017. This article has not been updated yet. Refer to the "Description" or "Workaround" sections for solution information.

Fix Status: Released

Fix Version(s):
Component: Documentation Guides

Automation.Engine 12.0.1 - Available
Automation.Engine 11.2.4 - Available

Additional Information

Workaround :
N/A