Object script
Overview
An Object script is an AnalyticsCreator object that stores a parameterized script for a supported repository object type or as a table-independent script.
Object-scoped scripts can be listed, added, and run from supported object context menus.
Function
Use object scripts to perform reusable repository actions against selected AnalyticsCreator objects.
An object-scoped script receives the selected object ID as its first runtime value. Additional user-defined parameters can provide optional default values.
Types
The Object setting determines whether a script is object-scoped or table-independent.
| Type | Use |
|---|---|
| Object-scoped script | Runs for a supported repository object type and receives the selected object ID. |
| Table-independent script | Is not bound to a repository object type. |
Attributes
Attributes define the configuration, behavior, and relationships of the object script entity.
| Attribute | Applies to | Description |
|---|---|---|
| Name | All object scripts | Required script name. |
| Description | All object scripts | Documents the purpose of the script. |
| Object scope | Object-scoped scripts | Supported repository object type associated with the script. |
| Parameters | All object scripts | Ordered user-defined parameters accepted by the script. |
| Default values | Optional parameters | Values used when checking or running the script. |
| Statement | All object scripts | Script body executed by the object script. |
How it is used in AnalyticsCreator
| Use case | Description |
|---|---|
| Run repository maintenance actions | Execute a reusable statement for a selected repository object. |
| Provide object context automatically | Pass the selected object ID as the first runtime value. |
| Expose reusable context-menu actions | List, add, and run scripts from supported object context menus. |
| Validate before saving | Check the statement with the available parameter values. |
Relationships
| Related entity | Relationship |
|---|---|
| Repository object | An object-scoped script is associated with a supported object type. |
| Object script parameter | An object script contains ordered parameters. |
| Navigation tree | Scripts are grouped under All scripts, Table-independent scripts, or object-type branches. |
Where to configure
Configure or review this entity from the matching AnalyticsCreator user-interface area.
