Use the Orcl_blank frame to customize the component. Table 30 describes the Orcl_blank object titles, names, and functions required to construct a component.
Table 30. Orcl_blank Object Titles, Names, and Functionality
Object Title | Object Name (where applicable) | Functionality |
|---|---|---|
ParentOrcl_blank | txlParent | Reserved for future use (also see MeOrcl_blank) |
MeOrcl_blank | txlMe | Provides the component name which is identical to the section name (Can be used internally by the component code) |
Run Time Event Handlers and Functions | cbt_events_runTime | Activated at document startup, the button contains functions that are used by the runtime document (The blank component is preconfigured with a set of empty functions that have tracing to enable developers to test that the component properties are correctly configured, and that the component is functioning before adding custom code) |
Configuration Time Event Handlers and Functions | cbt_events_config | Activated at document startup, the button contains functions that are used during dashboard development to handle the configuration or properties frames (The first line of code establishes if the document is a runtime release, and if so, it exits. The blank component is preconfigured with a set of empty functions that have tracing to enable developers to test that the component properties are correctly configured, and that the component is functioning before adding custom code) |
Aspect Event Handlers | cbt_events_aspec | Commented out pre- and post-event handlers called before or after the event handlers for an event. These are commented out because they add overhead to every event and should only be used where some specific behavior that cannot be achieved through standard events is required. Note: These override the behavior of other components; however, the developer can un-comment these handlers where required. Most components do not use them. |
VersionInfo | Release information about the component | |
txlReqBrio | Minimum required release number of Interactive Reporting Studio (The framework checks for the release and only initializes the component if the release of Interactive Reporting Studio is equal to or later than the listed value) | |
txlReqTemplate | Minimum required release number of the Dashboard Studio core template (The framework checks for the release and only initializes the component if the release of the template is equal to or later than the listed value) | |
txlFrameName | Name of the first configuration frame for the component | |
txlPriority | Order in which the component is initialized; that is, the order the component receives broadcast events, such as OnStartup, OnShutDown, OnActivate, OnPreProcess, and so on, including aspect events (The lower the priority, the earlier the component is acted upon. Priorities range from 1–10, with an empty value being treated as a priority of 10) | |
ComponentDefinition | Core component sections, sequence of properties frames, and sections to remove when an ESM is saved as a runtime (The text label is affected by Synch Component Definition, Rename Component, and Rename Property Editor) | |
gtxlProperties | Unique settings and options for dashboards (Clicking Apply on a configuration or properties frame updates the gtxlProperties text label) | |
gtxlToolTip (click to generate for configurator) | Parses the configuration frame and generates, in the Console Window, a default floating comment for each clickable shape (The developer copies, pastes, and edits these into the gtxlToolTip text label) | |
gtxlToolTip | Language strings for floating comments displayed when hovering over clickable objects | |
gtxlLanguageStrings (click to generate for configurator) | Parses the configuration frame and generates, in the Console Window, a default text string for each shape with a text property (Developers copy, paste, and edit these strings into the gtxlLanguageStrings text label) | |
gtxlLanguageStrings | Language strings for text labels, alert boxes, and so on, displayed in the component user interface | |
gtxlLanguageMappings | Association between strings and objects so code is not required for changes in the user interface text values; for example, in response to a user switching the dashboard language | |
Synch Component Definition | txlSynchCompoentDefinition | Only visible if the Interactive Reporting document is a component; that is, not a template, an ESM, nor a runtime (Updates the contents of ComponentDefinition using sections located in the component, and assumes all sections are part of the component and must be retained. It identifies configuration or properties frames based on the FrameType, and clicking Default when creating a runtime release selects all sections, except the core, to be discarded) |
Rename Component | txlRenameComponent | Code to apply consistent renaming to sections in the component (When renaming is complete, it calls Synch Component Definition if the Interactive Reporting document is a component) |
Revert to Component | txlMakeComponent | Discards sections that are not part of the component, so the component can be extracted from the template (Only operates if the Interactive Reporting document is a template) |
Rename Property Editor | txlRenamePropertyEditor | Renames the selected Property Editor (configuration or properties frame), and updates ComponentDefinition and txlFrameName |
Set Dependency Version To Current | txlSetDep | Updates txlReqBrio to the current release, and if the Interactive Reporting document is a template, an ESM, or a runtime release, sets txlReqTemplate to the version of the current template |
txlName | User-friendly component name (Used by Dashboard Architect to generate the JavaDoc for the component) | |
Descriptive text | txlDescription | Component synopsis (Used by Dashboard Architect to generate the JavaDoc for the component) |