Object descriptions

Root folder

Defines a basic container object that can contain various child objects which affect how dashboard pages are displayed. Exists directly under the Root object.

Portal folder

Defines a basic container object that can contain various child objects which affect how dashboard pages are displayed. Exists within Root folders and other Portal folders.

Dashboard

Defines the page that renders the Dashboard Interface.

Filters group

Metric filter

Defines a control that allows the user to select a value that affects the content of those Metric objects which contain this filter as an @@Prompt parameter in their query. This object is visible to (and is rendered for) any dashboard page or metric which lies along the same path in the hierarchy as this object (e.g., a filter contained in the same or a parent folder of a dashboard renders this filter and has it available to its metric objects).

Variables group

Represents a "logical" object that contains the scoped variables that have been defined under a Folder or Dashboard Page object. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Scoped variable

Defines a single constant or dynamic value that is substituted in those object's properties that support @@Variable replacement, as long as this scoped variable is along the path of that object.

Dashboard navigation

Defines an element on the page that will have navigation to other parts of the dashboard. Up to two tiers of navigation are supported.

Sticky page margin

Defines a group of dashboard elements that will be stickied to the top of the dashboard. When a dashboard has enough content to scroll elements inside this will always be visible.

Metric

Defines an element whose content is dynamically generated from a query for a dataset, which can then be displayed as a chart image, or a data listing table. Available display styles include HTML Table, Crosstab, Dynamic Grid, Line, Pie, or Bar Chart.

Iframe

Defines an element whose content is a web page, defined by its URL, using the height and width specified for this element as the size of the Iframe.

Image

An Image element is an internal or external image on the dashboard page at the element's location.

Literal HTML

Defines an element whose content is statically defined HTML, allowing you to create custom HTML code and have it rendered at the element's location on the dashboard page.

Metric action buttons group

Represents a "logical" object that contains the Metric Action Button objects defined under a Metric object. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Metric action button

Defines a shortcut button to another object in the hierarchy or a custom page by its URL that is displayed when this Action Button is clicked.

Metric checkbox

Defines a checkbox for users to select rows within a table. The inclusion of the checkbox also adds an "Actions" button to let the user add the selected rows to a student group.

Metric rules group

Represents a "logical" object that contains the rendering rules defined under a Metric object. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Display rule

Defines a display rule that will apply certain rendering attributes to this metric depending on the outcome of its evaluation statement. This will allow you to set up a rule that will hide the metric, or toolbar actions, for a specific group of users, or a certain set of filtering criteria. Both scoped variables and User filter prompt statements can be used in the evaluation statement.

Metric action links group

Represents a "logical" object that contains the Metric Action Link objects defined under a Metric object. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Metric action link

Defines a shortcut link to another object in the hierarchy or a custom page by its URL that is displayed when this Action Link is selected. These Action Links are not context-sensitive, and more than one can be defined per Metric object.

Metric drill links group

Represents a "logical" object that contains the Metric Drill Link objects defined under a Metric object. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Metric drill link

Defines a shortcut link to another object in the hierarchy or a custom page by its URL that is displayed when the Metric content is clicked (or drilled into).

Metric data display rule group

Represents a "logical" object that contains the Data Display Rule objects defined under a dashboard element. This object is "logical" only (display only) in the hierarchy Navigation tree and not a "physical" Portal object in the repository. It is automatically generated when the Navigation tree is rendered for the user. This "logical" object may only contain the objects defined under the "physical" parent object it is contained under. The contained children, as well as other settings for these "logical" objects, are custom definable per object type per application installation but require a Portal programmer's assistance to define properly.

Data display rule

Defines a statement that can be used to show/hide a dashboard element on the page. The statement is only checked when elements are processed for rendering (i.e. on page load, on filter change).

Metric base Root Folder

Defines the topmost container folder that can contain Metric Base Folders and Metric Base objects.

Metric base Folder

Defines a sub-container folder that can contain other Metric Base folders and Metric Base objects.

Metric base

Defines the most basic query definition for a Metric that is reusable by other Metrics.

Metric base Column Root Folder

Defines the topmost container folder that can contain Metric Base Column folders and Metric Base Column objects.

Metric base Column Folder

Defines a sub-container folder that can contain other Metric Base Column folders and Metric Base Column objects.

Metric base Column

Defines the most basic definition for a data column that is reusable by the columns defined for Metrics.

Metric Conditions Root Folder

Defines the topmost container folder that can contain Metric Conditions Folders and Metric Conditions Group objects.

Metric Conditions Folder

Defines a sub-container folder that can contain other Metric Conditions folders and Metric Condition sets.

Metric Condition Set

Defines a set of conditional values that can be used to highlight data elements of a Metric (via color coding) based on their current value.

Metric Detail Template Root Folder

Defines the topmost container folder that can contain Metric Detail Template Folders and the Metric Detail Default Template objects.

Metric Detail Default Template

Defines the default template to use when showing metric details, for all those metrics that are not using a custom template.

Metric Detail Template Folder

Defines a sub-container folder that can contain other Metric Detail Template folders and Metric Detail Custom Template objects.

Metric Detail Custom Template

Defines a custom detail template to use when showing metric details, for those metrics that are using this template.

Palettes

Defines the topmost container folder that can contain Color Palette objects.

Color Palette

Defines a collection of color codes to be used within Metrics and Condition Sets.

Metric Style Template Root Folder

Defines the topmost container folder that can contain Metric Style Templates (various types) and Metric Style Template Folder objects.

Metric Style Template Folder

Defines a sub-container folder that can contain other Metric Style Template folders and Metric Style Template objects.

Metric Dynamic Style Template

Defines a dynamic type of style that can be used by metrics when they are rendered. These include Dynamic Grid, Dynamic Grouped Grid, and Dynamic Tree Grid.

Metric HTML Style Template

Defines an HTML repeater type of style that can be used by metrics when they are rendered. These include Single Item HTML, Double Item HTML, Profile Headers, etc.

Metric Static Style Template

Defines a static type of style that can be used by metrics when they are rendered. These include Crosstab, Form, and HTML table.

Interactive Chart Style Template

Defines an interactive chart type of style that can be used by metrics when they are rendered. These include VBars, Line, Spline, Pie, Scatter, etc.

Metric Chart Style Template

Defines a chart type of style that can be used by metrics when they are rendered. Used to render the metric as a Chart image.

Metric Map Style Template

Defines a geospatial map type of style that can be used by metrics when they are rendered.

Applications Folder

Defines a container object that contains various integrated web applications.

Maintenance Application

Defines an integrated web application that allows the user to maintain specific user data tables for the data warehouse.

Managed Lists Application

Defines an integrated web application that allows the user to maintain the data in custom tables in their data warehouse, or any other database table. The application uses customizable XML definition files to provide the mappings and layout necessary to generate a custom user interface without requiring any additional application code to be written. The Administrate Lists, Manage Lists, and View Lists roles have been added to allow various user-level access.