Metadata Editor Reference

Information Properties are found at the top right hand portion of most of the metadata editor screen views, separate from the metadata (runtime) properties. These are, for the most part, descriptive properties such as ID name, and a general description.

The command buttons appear at the bottom the left of the metadata editor window. There are some command buttons specific to an editor and will be discussed in that context but others, which are listed here, are common enough to cover in a general discussion.

New
The New command button created a new application object.

Copy
The Copy command button allows a user to copy an existing item while retaining the settings for a new item. Copied configurations can be modified after being copied.

Delete
The Delete command button allows a user to delete an item in the editor.

Undo Edits
The Undo Edits command button defaults the editor settings back to where they were when opening the editor in a given instance.

Properties
The Properties command button gives a full screen view of the metadata properties in the Applications, Views and View Property Sets metadata editors. Using a multiple window function allows for side by side comparison of the properties from two different objects within the active editor.

Commit
The Commit command button becomes available when changes are made in an editor. Clicking the Commit button writes the changes back to the metadata store. If inadvertent changes were made in an editor a prompt will ask if changes should be saved when you attempt to close the editor.

An application’s configuration determines whether the application can be used for metadata administration.

An Admin application allows a user to access any of the Admin tools, such as the metadata editors and the import and export metadata utilities. These tools are available from the Admin menu on the main menu bar when the UseDefaultAdminToolbarsConfiguration property in the UI section is set to True.

In an Admin application, the view selector is typically configured with a view hierarchy that contains all the views defined within the tenant. For ease of use, the view selector’s AllowEditViewMetadata property enables the ability to navigate directly from a view in the view selector to the view’s related metadata.

An Admin application is often password-protected, which is supported by the Password property in the Security section. The password provides a simple security mechanism for protecting the metadata.

An end-user application is any application that does not allow direct access to the metadata. The ToolbarsConfigurationID setting in the UI section indicates which toolbars configuration is used by the application. The Metadata Starter Kit contains a toolbars configuration, View Console, which is assigned to the Dodeca User Console application in the starter kit. The toolbars configuration can be modified and customized as needed. Or, another toolbars configuration can be created and assigned to the application.

Let’s take a look at an example of how to configure a view selector to display a particular hierarchy (or hierarchies) for users who are assigned to a particular role.

Assume that there are four possible roles defined within the environment: Admin, Analyst, Planner, and Executive. Using the dialog displayed by the HierarchyToRoleMapping property, hierarchies are mapped to each role.

The figure below is a screenshot of the View Hierarchy Metadata Editor’s list of all the hierarchies defined for this example.

If assigned the roles of Planner and Executive, the user has access to the Planning, Analysis, and Reporting hierarchies as a Planner and the Reporting and Executive Views hierarchies as an Executive. The figures below show the content of the view selector for this user as determined by the configuration settings.

The View Selector Tree is configured with the HierarchyRootNodeDisplayPolicy set to Hierarchy, which displays a root node for each hierarchy.

The Reporting hierarchy is mapped to both the Planner and Executive roles, but appears only once in the view selector.

The View Selector Tree would also display each hierarchy as a root node if the HierarchyRootNodeDisplayPolicy was set to TopLevelItemsForSingleHierarchy, since the user has access to multiple hierarchies. With this policy option, a root node is displayed for each hierarchy when the user has access to multiple hierarchies. When the user has access to only a single hierarchy, a root node is displayed for each top level item.

The View Selector Tree is configured with the HierarchyRootNodeDisplayPolicy set to TopLevelItems. With this option, the top level items of each hierarchy are displayed as root nodes.

The Variance category in the Analysis hierarchy contains the Balance Sheet Variance and the Profit & Loss Variance views; whereas, the Variance category in the Planning hierarchy contains the Plan Variance view. The Variance category item in the view selector contains the views from both categories.

Although not the case in this example, if the Variance category in both hierarchies contained the same view, only one occurrence of the view would appear under the Variance item in the view selector.

For a user assigned the Planner and Executive roles, the View Selector Explorer Bar displays a group for each top level item in the Planning, Analysis, Reporting, and Executive Views hierarchies.

The Variance group contains the Plan Variance view from the Planning hierarchy and the Balance Sheet Variance and Profit & Loss Variance views from the Analysis hierarchy.

When using the Application metadata editor to modify the settings for the Admin application that is currently running, it is necessary to exit and restart the application to see the effect of the changes.

CaptionBeforeBuild is the text that appears on the view tab or title bar when a user opens the view and before the view builds for the first time. If no value is specified, the view name is used as the caption.

CaptionAfterBuild is the text that appears on the view tab or title bar after the view builds or refreshes. If no value is specified, the CaptionBeforeBulid displays. If no CaptionBeforeBuild is specified the view name displays.

The AllowLROs setting defines whether the Linked Objects Browser dialog appears when a user double-clicks the left mouse button in a data cell. A linked reporting object (LRO) is an object that you associate with a specific data cell in an Analytic Services database; for example, a graphic file that more fully explains a cell value. LROs provide improved support for planning and reporting applications and can enhance data analysis capabilities by providing supplemental information about data. LROs can be linked files, brief cell notes, or URLs. AllowedLROTypes controls the LRO types available in the Linked Objects Browser dialog.

AllowPivot controls whether the user is allowed to initiate an Essbase operation. If True, a user can initiate a pivot operation by pressing the right mouse button in a member cell and the holding and dragging the mouse to the destination cell. The Pivot button tool can also be used to pivot a member. The tool is enabled when the AllowPivot setting is True.

AllowEssbaseOperationsOnRetrieveRange controls whether the user can perform Essbase operations, including Zoom Out, Remove Only, Keep Only, and Pivot on the data that is contained within the retrieve range.

AllowSave controls whether a user can save a view. If True, the Save View and Open Saved View buttons are enabled. AllowSend controls whether the user is allowed to update Essbase data by posting changes to the database. If True the Save View and Open Saved View tool buttons are enabled.

AllowLROsOnDrillThroughSheet controls whether the Linked Objects Browser dialog appears when a user double-clicks the left mouse button in a data cell on a drillthrough.

AllowedLROTypesOnDrillThroughSheet controls the LRO types available in the Linked Object Browser dialog for a drillthrough sheet. This option is only applicable when AllowLROsOnDrillThroughSheet is True.

SelectorsVisibleOnDrillThroughSheet controls whether the selectors are visible when a drillthrough sheet is the active sheet. AllowSendOnDrillThroughSheet controls whether the user is allowed to update Essbase data by posting changes to the database with the data from the active drillthrough.

CascadeDoCascade controls whether the view is cascaded when built. When the view is cascaded, the list each cascade source defines is obtained or generated. The Cartesian product of the lists is generated and a copy of the cascade template sheet is created for each ordered combination of members. The cascade template sheet is deleted.

The RetrievePolicy should be set to AllSheets if the cascade template does not contain a named retrieve range. The RetrievePolicy should be set to RetrieveRanges if the cascade template does contain a named retrieve range.

A source, with reference to a cascade, is either a selector, which allows the user to select the items of the cascade list or a script which is used to generate the list. CascadeSources defines the source for the views cascade list. Clicking on the ellipses on the CascadeSorces row displays the Cascade Sources Dialog showing Source Type and a list of sources.

CascadeSheetnamedPattern specifies the tokenized string used to build the name of each cascade sheet and is only applicable when the CascadeDoCascade setting is True. By default, the sheet name contains each of the member names represented by the sheet. For example, if the cascade sources are the selectors for Product, Market and Scenario, and the members represented by the sheet are Cola, New York and Actual, the default sheet name is Cola-New York-Actual.

The CascadeTemplateSheetNumber property specifies the 0-based index of the sheet in the Excel template that is used as the cascade template sheet.  CascadeTemplateSheetNumber is only applicable when the CascadeDoCascade setting is True.

SummarySheetAdd controls whether a cascade summary sheet is added to the view. If a summary sheet is added, [T.SummarySheetList] and [T.SummarySheetsRange] will be added to the view’s tokens.

ChartRetrieveRangeInfo relates each chart control in the view user-interface to the retrieve range that contains the data represented by that chart.

Clicking on the ellipses after selecting the ChartRetrieveRangeInfo property displays a dialog box.

In the dialog, the ChartName is the name of the chart control. The value is used to locate the chart control to fill with the retrieve range data. The value must match the name of an existing chart control. The Caption is the text displayed on the chart control pane title bar and tab. This value can contain tokens. The RetrieveRangeName is the name of the retrieve range that contains the data the chart will represent.

AllowCommentsExplorer controls whether to allow the comments explorer functions.

CommentsExplorereDisplayMode controls whether the comments editor displays in a docked pane or a modal dialog.

CommentsExplorerDockedControlLocation is the initial docked location for a dockable comments editor. The setting is only applicable when the *CommentsExplorereDisplayMode * is set to DockedControl or LockedDockedControl.

CommentRanges controls the behavior or comments within each specified comment range. Clicking on the CommentRanges ellipses opens the Comment Range Configuration Editor.

This configurations editor,  like the other metadata editors, has required property settings.

DataCellDoubleClickPolicy controls what happens when the user double-clicks an Essbase data cell with the left mouse button.

DataCellDoubleClickMemberFilters controls whether the action the DataCellDoubleClickPolicy defines is performed based on the level number, level name, member name or UDS of the contributing members.

DataDrillthroughSheetName indicates the base name used for a drillthrough sheet. A drillthroughsheet is added when the DataCellDoubleClickPolicy is AddSheetForDrillThrough and the user double-clicks a data cell with the left mouse button. When a drillthrough sheet is added, the sheet name is constructed using the DataDrillthroughSheetName. If other drillthrough sheets exist, the name is appended with a number of the copy in parenthesis. This is the same naming convention used by Microsoft Excel when a sheet is copied. The DataDrillThroughSheetName can be tokenized. By default, this setting is empty. When the setting is empty, the name of a drillthrough sheet is a concatenated list (delimited by dashes) of the members that intersect the data cell. Example: East – Actual – Qtr 1- Sales – Cola.DataDrillthroughSheetName is only applicable when the DataCellDoubleClickPolicy is AddSheetForDrillthrough.

DataDrillthroughSheetNameMaxLength controls the maximum length of a drillthrough sheet name. The default setting is 31, which is the maximum number of characters allowed by Microsoft Excel for a sheet name. When the view is to be saved to Microsoft Excel, use the default setting. DataDrillthroughSheetNameMaxLength is only applicable when the DataCellDoubleClickPolicy is AddSheetForDrillthrough.

DataDrillthroughViewID indicates the ID of the view that is open when the DataCellDoubleClickPolicy is OpenViewForDrillthrough and the user double-clicks a data cell with the left mouse button.

Every Token that a selector defines for a dimension whose member contributes to the data cell is passed as a view token to the drillthrough view using the ViewTokens. Since ViewTokens is used to set the default selections for the drillthrough view, both views can represent the same Essbase data (as appropriate).  DataDrillthroughViewID is only applicable when the  DataCellDoubleClickPolicy is OpenViewForDrillthrough.

When the  DataCellDoubleClickPolicy is OpenViewForDrillthrough, EnforceEssbaseFilterOnOpenViewForDrillthrough controls whether the view is opened when an Essbase filter prevents the user from accessing the data cell. If the setting is True, the view is not opened when the user has no access to the data cell. If the setting is False, the view is opened whether or not the user has access to the data cell.

EssbaseConectionID is the Essbase connection ID used to look up the connection metadata that defines the Essbase connection setting for the view. The EssbaseLoginServiceObjectTypeID is the object type ID of the login service that obtains the credentials necessary to sign on to the Dodeca Essbase service.

AllowUserEssbaseOptions controls whether a user’s Essbase options settings are used instead of the Essbase option settings that are defined for this view, which are represented by the EssProperty settings. When used in conjunction with the AllowedUserEssbaseOptions setting, an administrator can control which Essbase options a user is allowed to set. AllowedUserEssbaseOptions controls the Essbase options that a user is allowed to set.

RetrainOnRetrieval controls whether formulas within the retrieve range are retained when building or refreshing the view and during a retrieve operation.

UserEssbaseOptionsContext controls the caching of the user’s Essbase Options settings. The cache is used to initialize the settings when a view is opened.

This field contains the ID and version number of the Binary artifact that contains the Microsoft Excel template associated with the view. Clicking the ellipses displays the Select Excel Template Binary Artifact dialog containing a list of available Binary Artifacts.

When the user exports the view to Microsoft Excel, each protected worksheet is password protected with the ExportToExcelProtectedWorksheetPassword value in order to prevent a user from unprotecting a worksheet in the Microsoft Excel file.

GridLinesVisible controls whether the grid lines are visible or hidden for template and cascade sheets.

GridLinesVisibleOnDrillthroughSheet controls whether the grid lines are visible on a drillthrough sheet.

RowAndColumnHeadersVisible controls whether row and column headers are are visible or hidden for template and cascade sheets.

RowAndColumnHeadersVisibleOnDrillthroughSheet controls whether row and column headers are visible on a drillthrough sheet.

TabsVisible controls whether sheet tabs are are visible or hidden for template and cascade sheets.

MemberCellDoubleClickAllowedDimensions controls whether the action the MemberDoubleClickPolicy defines is performed only for members that belong to a particular dimension or any dimension. If one or more dimensions are specified, each selected member must belong to a specified dimension for the action to be performed.

Clicking the left mouse on the MemberCellDoubleClickAllowedDimensions ellipses opens an Essbase Login dialog.

Enter a valid user name and password to access the MemberCellDoubleClickAllowedDimensions dialog.

After choosing an Essbase Connection ID, the administrator can choose allowed dimensions from the list.

Example: If the MemberCellDoubleClickPolicy is Zoom and the MemberCellDoubleClickAllowedDimensions is Product;Market, then a Zoom In or Zoom Out operation is performed only when the user double-clicks a member(s) that belong to the Product or Market Dimension.

By default, the value is empty, which indicates that the MemberCellDoubleClickPolicy is performed on members belonging in any dimension.

MemberCellDoubleClickAllowedOrientations controls whether the action defined by the MemberCellDoubleClickPolicy applies to page, column and/or row members.

Example: If the MemberCellDoubleClickPolicy is Zoom and the MemberCellDoubleClickAllowedOrientations is Row, then a Zoom In or Zoo Out operation is performed only when the user double-clicks a row member(s), but not when the user double-clicks a page or column member. By default, the value is ALL, which indicates that the MemberCellDoubleClickPolicy is performed for page, row and column members.

Both the MemberCellDoubleClickAllowedOrientations and MemberCellDoubleClickAllowedDimensions settings are used to control whether the action is performed when the user double-clicks a member cell(s).

MemberCellDoubleClickPolicy controls what happens when the user double-clicks an Essbase member cell with the mouse button.

SelectorConfiguration configures the selectors for the view, including the order the selectors display in the tool bar. Clicking on the ellipses at the SelectorConfiguration row display a Configure Selectors dialog.

In the dialog there are a number of configurable settings for each selector.

The SelectorControlDisplayMode controls whether a docked pane or a modal dialog contains the user-interface control that displays the selectable items. The setting is only applicable to selectors that display the items in a user-interface control, such as a treeview or listbox, when the user clicks the Show button on the selector tool.

The SelectorDockedControlGroupStyle is the layout of the group of dockable selector user interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

The SelectorDockedLocation is the initial docked location for dockable selector user interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

SelectorLastUsedItemContext controls the caching of the items selected when the view is built or refreshed. The cache determines the default selected item for the selectors that are assigned a selector list with a DefaultSelectionPolicy of LastUsedItem.

ViewTokens represents the token definitions assigned to the view. Clicking on the ellipses display the Token Editor dialog that allows you to add, remove and edit the available tokens.

The GridContextMenuID is the key to the PopupMenuTool to use as the context menu for the grid control. The GridContextMenuForDrillthroughSheet is the key of the PopupMenuTool to use as the context menu for the grid control when the active worksheet is a drillthrough sheet. Any popup menu that is defined in the toolbars configuration assigned to the ViewToolbarsConfigurationID can be used as the grid context menu.

MergableToolbarsConfigurationID is the ID of the toolbar configuration that defines the view-specific menus and tools. At run-time, the menus and tools are merged with the application menus and tools providing the view with the look of a single set of tools and menus.

ViewToolbarsConfigurationID is the ID of the toolbar configuration that defines the view-specific menus and tools displayed within the view window.

WindowsViewUIObjectTypeID is the object type ID of the Microsoft Windows form that contains the user interface controls used to display the view data. This is a required setting.

For a good step by step example of adding a view, go back and review; Creating a New Essbase Ad Hoc View Definition.

To add a new property set, click the New command button in the editor. When the New Property Set dialog displays, fill in the ID, Name and Object Type (see diagram above) and click OK.

In the illustration above, the Hierarchy is Standard; the Categories are Ad hoc Views and Reporting; and the Views are Sample Basic Ad hoc and Income Statement. The View Hierarchies metadata editor gives the administrator a clear view of the organization of the available views.

To add a new item (Category), click the New Item command button, fill in ID, and click OK.

This tool allows an administrator to categorize views into an existing hierarchy. Click the Insert View command button to display the Select Views to Add dialog. Select a view and click OK to install the view.

ID: The unique name that identifies a selector. Once a selector is committed, the ID becomes read-only.

Type:  A filter for the different types of selectors that Dodeca supports, including Essbase, SQL, and Generic selector types.

Source:  The source or entity represented by the selector.

Caption:  This is the same as the member name that the user sees in the report.

Token:  The value that can be substituted into spreadsheets, formulas, Essbase report scripts and calculation scripts, and SQL statements. A Token is an object which represents the (often exclusive) right to perform some operation.

Token Range Name (optional):  The name of the defined range that refers to the cell(s) that represent the selector source in an Excel-compatible spreadsheet control.

Default Selector List:  A template of selector settings which can be referenced when creating new selectors.  See Selector Lists (on page 105).

Single-Select Tool Tip:  The dimension tool tip that the user sees when a single generation selection is enabled.

Multiple-Select Tool Tip:  The dimension tool tip that the user sees when multiple generation selections are enabled.

Selectors are the objects that define the dimensions or sources from which users may make selections to filter their views. The Importing Dimensions and Creating Selectors and Selector Lists section of the guide explains the process of importing dimensions and creating selectors. Selectors also define the tokens that may be used to substitute into worksheets, Essbase report scripts, Essbase calc scripts and SQL scripts.

The Description is simply a description of the Selector list (date created, etc). The ID is the string value that uniquely identifies the Selector List. SelectorControlObjectTypeID is the object type ID of the selector control. SelectorControlObjectTypeID determines the look of the Selector menu with available Tree View, Combo Box or List Box options.

             Tree View                                       Combo Box                                       List Box

SelectorID is the ID for the selector for which a specific selector list can be used to generate selectable items.

SelectorListObjectTypeID is the ID of the object type that contains the settings.

SelectorControlProperties are the properties used to configure the Selector Control.

The members generated by the selector list are referred to as base numbers. The BaseMemberNodePolicy setting controls whether the base members are added to the tree or root nodes or as descendant nodes.

If the BaseMemberNodePolicy is set to AddBaseMemberAsRootNode, a root node is added to the tree for each base member. When the setting is AddBaseMemberAsDescendantNode, if abase member has ancestors, a node is added to the tree for each of the member’s ancestors and for the base member. If the base member does not have ancestors, a root node is added only for the member. When the base members are added as descendant nodes, the BaseMemberAsDescendabtNode_RootNodeMemberPolicy controls how the member that is to be represented by the node is determined. The root node, which represents an ancestor of the base members, can be the dimension or another ancestor based on a specific generation, level or member name. In this same scenario, the BaseMemberAsDescendantNode_RootNodeMemberValue setting is used to specify the generation number or name, the level number or name, or the name of the member that is to be represented by the root node.

Prefill indicates whether nodes representing only the immediate children or all of the descendants of a base member are populated in the tree when the base member is added. By default the value is False which indicates that nodes are added for the immediate children only. When the user expands a node that is not filled, the tree automatically populates the selected node. Setting the value to False is the preferred approach, because it typically yields better performance.

RootNodeExpansionPolicy controls whether the root nodes are automatically expanded. The root nodes are the top-level nodes in the tree and represent the list of members that are generated based on the selector list.

AutoOpenTreeView controls whether the treeview is automatically displayed when the view is opened.

If the BaseMemberNodePolicy is set to AddBaseMemberAsRootNode, a root node is added to the tree for each base member. When the setting is AddBaseMemberAsDescendantNode , if a base member has ancestors, a node is added to the tree for each of the member’s ancestors and for the base member. If the base member does not have ancestors, a root node is added only for the member. When the base members are added as descendant nodes, the BaseMemberAsDescendabtNode_RootNodeMemberPolicy controls how the member that is to be represented by the node is determined. The root node, which represents an ancestor of the base members, can be the dimension or another ancestor based on a specific generation, level or member name. In this same scenario, the BaseMemberAsDescendantNode_RootNodeMemberValue setting is used to specify the generation number or name, the level number or name, or the name of the member that is to be represented by the root node.

MemberToolTipContentsOptions controls the member information presented by the tool tip displayed when the mouse hovers over a member item.

When the user is allowed to select multiple items, the selection text displayed by the selector is a delimited list if substrings in which each substring represents a selected item. The SelectionTextDelimiter defines the character used to to delimit the substrings. By default, the delimiter is a comma followed by a blank.

SelectorListProperties are the properties used to configure the Selector List.

DefaultSelectionPolicy allows for options with the default selection when a view is opened.

The DefaultSelectionString is a specific string set up for the DefaultSelectionPolicy when using SpecifiedString. This string can be Tokenized and is only applicable when the DefaultSelectionPolicy is set to  SpecifiedString. The DelimitedString is a semi-colon list of strings representing the list items and DependantOnSelectorIDs is a semi-colon delimited list of ID’s of the other selectors that affect this selector list. At runtime, when a selection changes for any of the specified selectors, this selector list is automatically re-generated. The NullLastUsedItemString represents the item value(s) used as the default when the DefaultSelectionPolicy is LastUsedItem and no last used item exists. NullSelectionText is the text displayed by the selector when no item is selected and the setting is often used to display a prompt. NullSelectionTokenValue is the text assigned to the token when no item is selected, typically used to specify the token value for a selector that is configured as optional but still needs to be represented by a token.

When a user is allowed to select multiple items, the token value is a delimited list of substrings in which each substring represents a selected item. The TokenValueDelimiter defines the character(s) used to delimit the substrings within the token value. By default, the delimiter is a semi-colon. TokenValueFormat is the value used to create the value that is assigned to the token. By default, the token value is a semi-colon delimited list of substrings in which each substring represents a selected item. If the token value needs to contain additional text prepended and/or appended to the text representing the selected items, you can use the TokenValueFormat to specify the text. The format must contain the format item {0}, which is replaced with the selected item string.

ValidateDefaultSelection determines whether the defualt selection is validated. Typically, the best runtime performance is achieved by setting the ValidateDefaultSelection to False and the DefaultSelectionPolicy to LastItemUsed.

SessionCachingEnabled controls whether the list of Essbase members generated by the selector are added to the session cache. By default, the items are cached. Session caching should be disabled when the members belonging in the dimension represented by the selector list change frequently and are likely to change over the course of the session. Performance can be improved when session caching is enabled. This setting is only applicable when the application’s SessionCachingEnabled setting is True.

Toolbar Preview - A preview of the selected toolbar configuration displays in the editor, showing the available functions.

The Editor is categorized into the following property groups:

The Creating Essbase Connection Definitions section (page 26) of the Administrators Guide provides a good explanation of importing Essbase connections using the Quick Start Utilities function.

The Import Connections command button in the Essbase Connections editor performs these same functions.

The Command Buttons for the editor include import and export buttons and a New Version button.

Review the sections on Send Ranges  and Retrieve Ranges for step by step directions for importing and exporting from the Binary Artifacts editor.

The New Version command button allows the user to make a change in a template, save the original, and not require a name change to the New Version other than attaching a Version number to it.

The Event Link can be described as the trigger for the procedure. Conversely, the Procedure is the action that is prompted by the Event Link. In the example in the previous section, AfterWorkbookSend, the procedure will initiate once a workbook send command is selected.

If the Procedure is the action that is prompted by the Event Link, the Methods, Arguments and Overloads make up the mechanism that drives the procedure. Looking at the examples above, there is a procedure named Do Calc. There is a EssbaseRunCalc Method with a TextBased Overload associated with this Procedure, the Method has a ScriptText Argument with a Calc all; value associated with it. What this means is that when the Event Link triggers the procedure, the Essbase Run Calc with the script text of Calc all; will initiate.  A second Method was added to the above example. ShowMessageBox has an Argument of Message with a Value of The Calc is Complete. This means once the Runcalc in the first Method has been completed the user will see a message box displaying the message The Calc is Complete.

There is a detailed example, Creating a Workbook Script, in this guide which shows you step by step instructions to create a workbook script.

When you make changes in the SQL Passthrough Datasets metadata editor, you can test the changed or added data set prior to committing the change using the Test Data Set command button.