Explorer
Configuring the Operations Manager¶
Two basic types of configuration exist: Global and User. The global configuration can only be modified by a user with administrator privileges. Only one global configuration exists for each workspace, but any user can define a personal configuration. The first time a user logs in the user will get a copy of the global configuration. A user can restore their personal configuration to the global configuration at any time.
Operations Menu¶
| Description | Illustration |
|---|---|
| The Operations menu is only available if the Operations explorer is opened. The Operations explorer can be opened by selecting Explorers from the View menu and then selecting Operations. The Operations Menu provides access to User Edit Mode and Global Edit Modes and also allows the User to revert the Operations Explorer settings to the Global settings. The title of the Operations Menu will vary depending on the workspace or if another name has been specified. In the example screen shots the River Operations workspace is open. |
  |
User Edit Mode¶
| Description | Illustration |
|---|---|
| User Edit mode allows customization of the users workspace. To enter User Edit Mode select Edit Mode from the Operations menu. When in User Edit Mode a check box will appear next to the Edit Mode menu item, the Edit Mode watermark will appear in the Operations explorer and the text User Edit mode will appear at the bottom of the Operations explorer. |
  |
| While in User Edit Mode is possible to configure the Operation Explorer. To exit User Edit Mode select Edit Mode from the Operations menu. If changes have been made to the Operation explorer configuration a message box will open requesting confirmation of save changes. |
 |
Global Edit Modes¶
| Description | Illustration |
|---|---|
| It is possible to enter Global Edit model if logged in as an Administrator or Workspace_Lead. There is only one Global Operations Explorer configuration for each workspace. To enter Global Edit Mode select Edit Mode from the Operations menu and then select Global from the Operations menu. When in Global Edit Mode the check boxes will appear next to the Edit Mode and Global menu item, the Edit Mode watermark will appear in the Operations explorer and the text Global Edit mode will appear at the bottom of the Operations explorer. |
 |
| While in Global Edit Mode is possible to configure the Operations explorer and manage node icons. To exit Global Edit Mode select Edit Mode from the Operations menu. If changes have been made to the Operation explorer a message box will open requesting confirmation of save changes. A second message box will open that allows the users configuration to be updated to reflect the changes made to the global configuration. |
 |
Revert To Global¶
| Description | Illustration |
|---|---|
| When in User Edit Mode it is possible to update the configuration to the current Global configuration by selecting Revert To Global from the Operations menu. This is useful where changes have been to the Global configuration that should be applied the current user configurations or if the user configuration has been corrupted through editing. |
 |
Configure the Operations Explorer¶
| Description | Illustration |
|---|---|
| When the system is in User or Global Edit Mode right clicking in the Operations explorer or right clicking a node in the Operations explorer opens a context menu with the following options: Some context menu items will behave differently when the initial right click is in the explorer rather than on a node in the explorer. Also if the initial right click is on a node with sub nodes the menu will also include: The context menu items are described below. |
 |
 Adds a new node to the tree.A dialog will open allowing the user to specify a name for the new node. If the initial right click was on a node in the Operations explorer the new node will be added as child of that node. If the initial right click in the Operations explorer but not on a node the new node will be added to the end of the tree. |
 |
 Adds new repeater node to the tree.A dialog will open allowing the user to specify a name for the new node. If the initial right click was on a node in the Operations explorer the new node will be added as child of that node. If the initial right click is in the Operations explorer but not on a node the new node will be added to the end of the tree. |
|
 The node name becomes editable until the Escape key (cancel edit) or Enter key (confirm edit) is pressed.Clicking elsewhere with the mouse will also confirm the edit. This menu item will be greyed out if the initial right click is in the Operations explorer but not on a node. |
 |
 Opens the properties window.If the initial right click was on a node in the Operations explorer the properties window for the node will open. The node properties window can be used to configure the nodes properties. If the initial right click is in the Operations explorer but not on a node the properties window for the Operations explorer will open. The operations properties window can be used to configure the Operations explorer properties. The properties windows is also shown when a node is clicked in edit mode. |
  |
 Expands all sub nodes under the selected node.This menu item is only visible if the initial right click is on a node in the Opertations explorer. |
 |
 Collapses all sub nodes under the selected node.This menu item is only visible if the initial right click is on a node in the Opertations explorer. |
 |
 Deletes the selected node.This menu item is only accessible if the initial right click is on a node in the Operations explorer. |
|
 Copies the selected node to the windows clip board and deletes the node from the tree.This menu item is only accessible if the initial right click is on a node in the Operations explorer. |
|
 Copies the selected node to the windows clip board.This menu item is only accessible if the initial right click is on a node in the Operations explorer. |
|
 Pastes a node from the windows clip board into the Operations Explorer.This menu item is only accessible a node has previously been cut or copies to the windows clip board. If the initial right click is on a node in the Opertaions Manager a new node will be pasted as a sub node of the seletected node. If the initial right click is in the Opertations Manager but not on a node the new node will be pasted at the bottom of the Operations Explorer. |
|
 Pastes only the node extensions from the Windows clip board into an existing node in the Operations Explorer.This menu item is only accessible a node has previously been cut or copies to the Windows clip board and the initial right click is on a node in the Opertaions Manager. |
|
 When checked, nodes can be dragged and dropped to reorder the tree. |
|
 Imports the tree or node from a configuration xml file.Opens a file browser dialog that allows the configuration file for importing to be selected. If the initial right click is on a node in the Operations Manager the system will attempt to import the configuration for a single node. If the initial right click is in the Operations Manager but not on a node the setting for the system will attempt to import the entire tree. |
 |
 Exports the tree or node to a configuration xml file.Opens a file browser dialog that allows the file name and path to be specified. If the initial right click is on a node in the Operations Manager the setting for the node will be exported. If the initial right click is in the Operations Manager but not on a node the setting for the entire tree will be exported. |
 |
 Saves the tree configuration to the database. |
|
 Restores the tree configuration from the version saved in the database.Any changes to the tree configuration made since the last time it was saved will be lost. |
Repeater Nodes¶
| Description | Illustration |
|---|---|
| The repeater node allows the tree to populate dynamically. The role of determining the names of the specific nodes to be created is delegated to the repeater. If such a plugin exists it will be available from the ItemDriver property. The plugin must implement a method that simply returns a list of strings. If a repeater node is created and called “MyNode” in edit mode, this node will in non-edit mode be replaced by a number of nodes corresponding to the strings returned from the repeater plugin. Any sub nodes or extensions to MyNode can in any of the string properties refer to![MyNode] and get the actual string runtime to help look up e.g. time series. |
 |
Configure Operations Explorer Properties¶
| Description | Illustration |
|---|---|
| Node properties can be accessed by right clicking on a node in the Operations Explorer and selecting Properties from the context menu. The nodes property window has the following configurable properties: The functionality of these properties is described below. |
 |
| AutoSelectLastNode: Indicates if the last selected node should be automatically selected the next time the user starts up the user interface | |
| Caption: Sets the Caption for the Operations explorer window and Menu. |   |
| ClearDataViews: If set to true, click a node will automatically close all open extensions (dataviews) before opening the new extensions | |
| Icon: Drop down icon selector, sets the Icon for the Operations explorer window. The icon appears on the Operations explorer windows tab when it is docked with other explorers. |
  |
| IgnoreReadOnly: Drop down list: True/False. This allows the Operations explorer to ignore any indication from external components that the tree should go into read only mode |
|
| Interval: Opens the Time Interval Window. The drop down list provides access to four time interval modes which determine the temporal extent of data time series data. These are: Values are entered in days, negative values are in the past, positive in the future. Values are entered in days, and must be negative. Nodes in the Operations explorer also have an interval property which includes an Inherited setting as well as Fixed, Relative, Relative to Latest and All. When Inherited is selected the mode will inherit the time interval of its parent node, or from the Operations explorer in the case of root nodes. |
    |
| OpenMode: Drop down list: LeftClick/DoubleClick. Sets the node open event for nodes in the Operations explorer. LeftClick: A single left muse button click on a node in the Operations explorer will open the extensions attached to the node. DoubleClick: Double clicking the left mouse button on a node in the Operations explorer will open the extensions attached to the node. |
|
| ReadOnly: Drop down list: True/False. When set to true editable data in extensions connected to nodes in the explorer cannot be edited. When set to false editable data in extensions connected to nodes in the explorer can be edited. Editable and non-editable data in extensions is defined by the extension. This property can be overwritten for individual nodes by setting the IgnoreReadOnly property of the node to true. |
|
| SortBy: Drop down list: Order/Alphabetical Sets the display order of nodes in the Operations explorer. Order: The order is defined by the Order specified on the mode Alphabetical: The order is alphabetical |
Configure Node Properties¶
| Description | Illustration |
|---|---|
| Node properties can be accessed by right clicking on a node in the Operations Explorer and selecting Properties from the context menu. The nodes property window has the following configurable properties: The functionality of these properties is described below. |
 |
| AllowDisable: Drop down list: True/False. When set to true the nodes right click context menu will include an item for Disabling the node. This is typically used to disable functional extensions. |
  |
| CanBeStopped: Drop down list: True/False. Determines if the node can be stopped when a functional extension is attached and being executed. If True the nodes context menu will include. This required the job tasks being executed to be able to react to the terminate event |
 |
| ExecuteIfOk: Drop down list: True/False. If a node has a functional extension attached to it and this property is true, the user will still be able to execute the node even though the node has the state of ok. Nodes with the state of ok have the  icon in the operations explorer. |
 |
| Icon: Drop down grid of selectable Icons. The selected Icon is applied to the Node in the Operations Explorer. The grid contains all Icons loaded into the system via the icon management feature of the Global Edit Mode. |
 |
| IgnoreReadOnly: Drop down list: True/False. The read only property is inherited from the nodes parent node, or in the case of root nodes from the Operations explorer. The IgnoreReadOnly property allows the inherited ReadOnly property to be overwritten. |
 |
| IncludeInUserState: Drop down list: True/False. If the node has functional extensions that can be executed, this property indicates if the state should include the user name. This is set to false if e.g. the same job and tree is visible for multiple users. This is used if multiple users share access to the same workspace |
 |
| Interval: Opens the Time Interval Window. The drop down list provides access to five time interval modes which determine the temporal extent of data displayed in the chart. These are: Values are entered in days, and must be negative. If the initial right click was on a node in the Operations explorer the interval settings will be applied to that node and to any nodes that inherit interval settings from it. If the initial right click is in the Operations explorer but not on a node the settings will be applied to the Operations explorer and all nodes that Inherit settings from it. |
    |
| PrimaryExtensions: Opens the Extension Wrapper Collection Editor. Provides the ability to connect and configure node extensions. The integer in the property grid indicated the number of primary extensions currently assigned to the node. |
 |
| ReadOnly: Drop down list: True/False. When set to true editable data in extensions connected to the node cannot be edited. When set to false editable data in extensions connected to the node can be edited. Editable and non-editable data in extensions is defined by the extension. If the IgnoreReadOnly property for the node is set to false the extension will use the parent nodes, or the Operations explorers read only property. |
 |
| SecondaryExtensions: Opens the ExtensionWrapper Collection Editor Provides the ability to connect and configure node extensions. The integer in the property grid indicated the number of secondary extensions currently assigned to the node. Secondary extensions are used to allow comparison of time series. Two nodes, having the same number of PrimaryExtensions, type of PrimaryExtensions and same number of time series attached to the extensions are selected while pressing CTRL, the time series from both nodes are fed into the SecondaryExtensions on the first node. In this node comparison of the time series can then be performed through e.g. spreadsheets. |
|
| SortBy: Drop down list: Order/Alphabetically |  |
| ViewSettings: Specifies how the extensions associated with the node should be handled. You can select from already existing view settings here. New view settings are created through a prompt when reorganizing the windows. |
Manage Icons¶
| Description | Illustration |
|---|---|
| When the system is placed in Global Edit Mode the Icons window opens. The Icons menu is used to manage icons used in the Operations manager tree. The window shows icons currently available in the system. The Import Button opens a file browser that allows one or more Icons to be imported. Icons for import can in common image file formats (*.png, *.bmp, *.jpg, *.jpeg, *.gif, *.tif, *.tiff). The Export and Delete buttons are only available if one or more icons are selected. The Delete button will delete the selected Icon/Icons. The export button opens a folder browser that allows the selected Icon/Icons to be saved to disk. When Saving Icons to disk they will be saved in the same image format as the file that was originally imported. |
 |
Configure Node Extensions¶
| Description | Illustration |
|---|---|
| Node Extensions are configured through the ExtensionWrapper Collection Editor which is accessed through the primary and secondary extension properties of nodes. The Members list on the left hand side of the window shows a list of all extensions currently attached to the node. The properties grid on the right side of the window shows the properties for the currently selected extension in the members list. |
 |
| To remove an extension, select it in the Members List and click the remove button. To add a new extension click the Add button and configure the new extension properties in the properties grid. It is necessary to specify a name and a type for the extension in the properties grid. The lower part of the properties grid will change depending on the extension type selected in the upper part of the grid. The generic extensions are described below. |
  |
| Chart: The chart extension is used to plot a chart of time series data. The chart extension has the following properties: Displays a vertical line on the chart at the current time. Refer to Legend entries should entered on separate rows, one for each time series in the chart ordered according to the TimeSeriesPathList. The names specified here will overwrite the actual time series names TimeSeriesPathList: Opens the Time series selector window that allows time series to be added to the chart. Time series are selected on the left hand side of the window and added to the list on the right hand side of the window using the add button,  . Time series can be removed from the chart by selecting them in the list of the right hand side of the window and clicking the delete button,  . The plotting order of time series in the chart and legend can be changed using the move up,  , and move down, , buttons. |
    |
| Chart with group added: Similar to a chart extension with the exception that a group of time series can be added to the chart along with those specified in the TimeSeriesPathList. The Chart with group added extension has the same properties as the chart extensions along with a TimeSeriesGroup property. The TimeSeriesGroup property is the path to the time series group to be added to the chart and should start with “/”. The time series in the time series group referenced in the TimeSeriesGroup property are added automatically to the TimeSeriesPathList. |
  |
| Chart with group in drop down: Similar to the Chart with group added extension except that the tool strip for the chart contains a drop down list that can be used to select a time series in the group to be displayed in the chart. Only one time series is displayed at a time depending on the selection in the drop down. The extension will default display the first extension |
  |
| Job Target: This extension adds an execute item to the nodes context menu which when selected executes the job referenced by the extension. The Job Target extension is coupled to a job and a target within that job. The extension has the following properties: When set to true selecting execute will cause the job referenced in the Job Name parameter to be executed. When set to false selecting execute will cause the jobs for all invalid nodes up to and including this node to be executed. Parameters are entered as Key/Value pairs. When set to true the job log for the job opens when the node is clicked. To get progress displayed on the node on which the Job Target extension is located. This is typically used in conjunction with the OperationsManagerState task that allows the job to send progress back to the Operations Manager. |
  |
| Script: Script extensions allow Python Scripts to be executed. The Script property of the script extension is used to set the path to the script. |
 |
| Spreadsheet: Displays a spreadsheet. If one or more timeseries are selected these will be shown on the RawData tab which will be added automatically to the spreadsheet. Time series shown in the RawData tab can be referenced in the spreadsheet using for example vlookup functions. The spreadsheet extension has the following properties: Time series are selected on the left hand side of the window and added to the list on the right hand side of the window using the add button, .Time series can be removed from the chart by selecting them in the list of the right hand side of the window and clicking the delete button, .The plotting order of time series in the chart and legend can be changed using the move up, , and move down,, buttons. |
     |
| Table: The table extension is used to display a table of time series data. The table extension has the following properties: Time series are selected on the left hand side of the window and added to the list on the right hand side of the window using the add button, .Time series can be removed from the chart by selecting them in the list of the right hand side of the window and clicking the delete button, .The plotting order of time series in the chart and legend can be changed using the move up, , and move down, , buttons. |
  |
| WebPage: Displays a webpage. The WebPage extension has a Url properties which sets the Url of the webpage to be displayed. |
  |
Chart Templates¶
Chart Templates allow user defined chart styles to be created and reused. The background, chart title, chart background, chart axis, axis titles, legend and time series items can be customised. The Template manager can be used to rename, delete, apply, and set default templates.
| Description | Illustration |
|---|---|
| Open a chart by clicking on a node in the Operations explorer with a chart extension attached to it. If not already open, open the properties grid for the chart by selecting Properties from the View menu. |
 |
| To configure the chart background click inside the chart to access the chart area properties. The background properties allow for various colour gradient and hatching styles to be applied to the chart back ground. The borderline properties allow the colour, line style and width of the chart border to be set. |
   |
| Clicking outside the chart area opens the properties grid for the chart background, Legend Area, and Chart Titles. The Chart background properties allow for various colour gradient and hatching styles to be applied to the chart back ground and the border colour, line style and width to be set. The Legend Area properties allow the position and style of the charts legend to be set. The font and underline style of the legend title can also be configured. The Title properties allow a title and subtitle to be configured for the chart. |
    |
| Clicking on a time series in the chart Legend provides access to the properties for the time series. The Appearance properties allow the display of the time series on the chart to be configured. This includes the chart type (Line, Spline, Fastline, StepLine, Column, Stacked Column, Stacked Column100, Bar, Stacked bar, StackedBar100, Point, FastPoint, Area, Spline Area, StackedArea, StackedArea100, and Range). Depending on the selected Chart type the Area Style, Boarder Style, Line Style, and Marker style can also be configured. The time series can also be plotted against the primary or secondary x and y axes. The Marker Lines properties allow simple statistics for the time series to be plotted on the chart. The Q/A properties allow the style of missing data point to be configured. The Statistics properties provide basic statistical analysis on the time series. These properties are for information purposes and cannot be edited. The Time Series properties provide information on the time series and allow the name of the time series, as displayed in the chart legend, to be edited. |
      |
| Clicking on the x or y axis of the chart provides access to the properties for the axis. Settings are provided for Axis width, Major and Minor Grids, Scale, Tick Marks and Units on the Axis tab. Label properties can be configured on the labels tab, and the axis title can be configured on the Title tab. |
   |
To save the chart template click the Save Chart as Template button, , on the tool strip at the top of the chart. In the Save chart template dialog that opens it is necessary to enter a name for the new chart template. Alternatively select an existing chart template from the drop down list to overwrite it with the new settings. Select chart elements to include in the template click the Save button. |
 |
The Template Manager button, , on the tool strip at the top of the chart provides access to the template manager dialog. The drop down list allows a template to be selected from the list of templates stored in the system.  Delete the selected template Rename the selected template  Apply the selected template to the current chart Sets the selected template as the default template. |
 |
| Once saved, the extension will have the char template attached to it and subsequent displays of it will use the template defined. Multiple extensions can use the same chart template and editing it would change it for all extensions. Exporting a tree will also export the chart templates and importing a tree will import any templates referred to in the tree. This allows for easy transport and deployment of the trees |