Object script

Overview

The Object script page maintains reusable scripts that can be run from an AnalyticsCreator object context or kept available as table-independent scripts. Use it to name the script, choose the object scope, define parameters, write the statement, and validate it before saving.

Function

Script name is the required name shown in the navigation tree and Object Scripts list. Description documents the purpose of the script.

Object selects the object scope for the script. When the page is opened from an object context, that scope is preselected. For a new scoped script, AnalyticsCreator can prepare a starter statement for the selected scope.

The Parameters grid defines script parameters with a sequence number, parameter name, and optional default value. Object-scoped scripts reserve the first runtime value for the selected object, so user-defined parameters start after that reserved value.

Statement contains the script body. Check validates the current statement with the available parameter values. Save requires a script name and statement, stores the script definition, refreshes the navigation tree, and reloads the page. Cancel closes the page without continuing the current edit.

Access

Open an existing script from the Object scripts branch in the navigation tree, or double-click it in the Object Scripts list. Use Add object script from the Object scripts branch, or New from the list, to create a script.

How to access

Data warehouse -> Object scripts -> [group] -> [script] -> Edit object script, or Data warehouse -> Object scripts -> Add object script.

Toolbar

Not opened directly from the toolbar. Use the Object scripts navigation-tree node or an object context command.

Diagram

Not opened directly from the diagram. Manage scripts from the navigation tree, list page, or supported object context menus.

Visual element

Object script page

Screen overview

ID Property Description
1Object scriptEditor area for adding or changing a single reusable object script.
2Script nameRequired name shown in the navigation tree and Object Scripts list.
3DescriptionOptional description of the script's purpose.
4ObjectObject scope for the script. It can be preselected when the page is opened from an object context.
5Parameter noteHighlighted guidance explaining that object-scoped scripts receive the selected object as the first runtime value.
6ParametersEditable grid for script parameters and default values.
7ParamNrParameter sequence number. In object-scoped scripts, user-defined parameters start after the reserved object value.
8ParameterParameter name used by the script statement.
9Default valueOptional value used when checking or running the script.
10StatementScript body. New object-scoped scripts can start with a generated sample statement for the selected scope.
11CheckValidates the current statement using the available object context and parameter values.
12SaveRequires a script name and statement, saves the script definition, refreshes the navigation tree, and reloads the page.
13CancelCloses the page without continuing the current edit.

Related topics