Object script

Overview

An Object script is a repository entity that stores a reusable SQL statement for repository objects. Object scripts can be table-independent or linked to a specific AnalyticsCreator repository table so they can be listed, edited, and run from the matching object context.

Function

Use the Object script entity to maintain script metadata such as script name, description, target object table, SQL statement, and script parameters.

For object-related scripts, the first parameter is always the selected object ID. Additional parameters are stored with a parameter number, parameter name, and default value. Table-independent scripts start their custom parameters at the first parameter number.

When a script is saved, AnalyticsCreator validates that the script name and statement are not empty, stores the script definition, refreshes the navigation tree, and reloads the saved detail page. The Check action parses the statement with sample parameter values and validates the SQL syntax with parse-only execution.

Access

Object scripts can be opened from the Object scripts branch in the repository navigation tree, from the object scripts list, or from the script commands added to supported repository-object context menus.

How to access

Navigation tree

Data warehouse -> Object scripts -> SCRIPT GROUP -> OBJECT SCRIPT

Toolbar

Not direct. Use the Object scripts navigation-tree branch or an object context menu.

Diagram

Not direct.

Visual element

Object scripts list, Object script detail page, Run object script dialog, and object script nodes in the repository navigation tree.

Screen overview

The Object script detail page contains the following visible fields, grids, and actions.

ID Property Description
1Script nameObject script name. Saving requires a non-empty value.
2DescriptionFree-text description for the script.
3ObjectRepository object table that the script belongs to. When a table is selected for a new script, AnalyticsCreator can generate a sample statement that filters the table by its primary key using parameter :1.
4First parameter of the object-related scripts is always the object IDHighlighted helper text explaining that object-related scripts reserve the first parameter for the selected object ID.
5ParametersGrid for additional script parameters.
6ParamNrRead-only sequence number for the parameter. For object-related scripts, custom parameters start after the reserved object ID parameter.
7ParameterParameter name used by the object script.
8Default valueDefault value used when checking or running the script unless a different value is entered in the run dialog.
9StatementSQL statement for the object script. Saving requires a non-empty statement.
10CheckParses the statement with sample parameter values and validates the resulting SQL syntax with parse-only execution.
11SaveValidates and saves the object script, refreshes the navigation tree, and reloads the saved detail page.
12CancelReturns to the previous page. If there are unsaved changes, AnalyticsCreator asks whether to save or cancel the navigation.

List behavior

  • The object scripts list filters by script name or description.
  • When opened from an object-table branch or object context, the list is filtered to that table.
  • The list grid shows Object, Name, and Description.
  • Double-clicking an object script row opens the selected script in the Object script detail page.
  • New opens the Object script detail page for a new script. Delete removes the selected script after confirmation.

Run behavior

  • Supported object context menus can expose List scripts, Add script, and a Run script submenu for scripts linked to the selected object's repository table.
  • The Run object script dialog shows Object, Object ID, Timeout (sec), parameter rows with ParamNr, Parameter, and Value, and a read-only result grid.
  • Running the script parses the statement with the object ID and parameter values, executes it against the repository connection, displays returned rows in the result grid, and stores the last timeout value.

Object script actions

  • The Object scripts branch provides Refresh, List object scripts, and Add object script.
  • The branch groups scripts under All scripts, Table-independent scripts, and object-table groups.
  • A selected object script provides Edit object script, Run object script when available, and Delete object script.

Related topics