Home | About | Partners | Contact Us | Disclaimer
Harmful Algal Blooms
Tools Overview
Conceptual Model Explorer
ArcGIS Toolbox for Restoration Prioritization
Advanced Search for Coastal Ecology Topics (Noesis)
 

Data Resources



 
 
NASA logo
Battelle logo
ITSC UAH logos
Oregon State University logo

 

 

 

 

 

 

 

 

 

CME Home | CME Help | Login
Conceptual Model Explorer

CME Online Help

Table of Contents

1. Overview

2. CME Viewer

3. Personalization

4. CME Editor
4.1. Editor Overview
4.2. Editor Desktop
4.3. Editor Dialogs
4.4. Creating Workspaces
4.5. Sharing and Publishing Workspaces

5. Containers and Workspaces

6. Advanced Workflow Automation

7. CME Known Issues
7.1. Browser Compatibility
7.1.1. Camino
7.1.2. Firefox
7.1.3. Internet Explorer
7.1.4. Opera
7.1.5. Safari


1. Overview

1.1. CME Description

Conceptual models can be used by coastal and marine scientists to help identify, assess, and communicate relationships between stressors on natural systems and ecological responses. The Conceptual Model Explorer (CME) is a decision support tool that enables scientists to view existing conceptual models and create new ones to support their resource planning and management activities.

The CME consists of two components:

The CME Editor is used to create and edit conceptual models, workflows and adapters (collectively referred to as "workspaces" in the CME). The CME Viewer is used to display the workspaces created in the CME Editor. Most users will only use the CME Viewer as access to the CME Editor is only available by request.


1.2. CME Intended Uses

The CME is designed to accommodate a broad set of conceptual models and workflows. The initial conceptual model and workflow are intended to provide resource managers with decision support on submerged aquatic vegetation (SAV) habitat restoration. The CME SAV application is intended to provide:
  • A visual representation of SAV habitat restoration, which shows ecological cause and effect relationships.
  • The ability to set priorities for SAV restoration within the broader ecosystem.
  • Definitions of ecosystem components, such as ecosystem stressors, structures and processes.
  • Access to datasets and other information products that relate to the topic of interest.

1.3. CME Features

1.3.1. Conceptual Models and Workflows

The Conceptual Model Explorer was originally designed as a tool to create and publish ecological conceptual models via the Internet. The CME conceptual models embrace the concepts of Organizing Principles and System Components as a mechanism to represent ecosystem relationships. This representation serves two primary purposes:

  1. help users understand what relationships are important in determining ecosystem response to a variety of possible stressors and controlling factors, and
  2. provide an easy-to-use interface to facilitate user search for information relevant to those components and relationships.

In addition to representing Organizing Principles and System Components, the CME enables users to personalize the system by building their own "workflow" for a scientific problem of interest. The specialized components or "containers" to support workflows in the CME include Datasets, Geoprocesses, Adapters, Conceptual Models, and Workflows.

An advanced feature of the CME is that components, including entire conceptual models and workflows, can be shared among editors, copied, and reused and/or nested in multiple workspaces (conceptual models, workflows, and adapters). For more information on these features, see the Creating Workspaces and Sharing and Publishing Workspaces sections in the CME Editor chapter.

1.3.2. Searches

One of the key features of the CME is the ability to quickly perform contextual searches for the components depicted in a conceptual model or workflow. The CME Viewer has a Definitions Window and an Information Assets Window which display associated information, queried from GoMRC Catalog web services, when a component is double-clicked. The Definitions Window presents a brief description of the component and the Information Assets Window lists relevant links that may provide additional information and/or raw data relating to the clicked component. Contextual searches using the Noesis advanced search tool can also be executed in CME.

Additionally, the CME has a Query Filters Dialog window that allows the user to refine searches spatially, temporally, and with additional keywords.

For more information on searches, see Section 2.5 - Performing Searches

1.3.3. Bookmarks and Personalization

The CME allows for user personalization. Registered users have the ability to save and easily retrieve CME Bookmarks to the information assets obtained through their search results. CME Bookmarks not only store a link for quick navigation to the information asset, but they also allow the user to rank the information asset and add personal notes about the information asset. CME Bookmarks are always associated with the component(s) that were selected when the bookmark was added so it is easy to find your favorite information assets for a particular model or workflow component.

CME personalization also permits users to become Editors who can create, edit, share and publish conceptual models and workflows. For more information on becoming an Editor, see the Editors section in the Personalization chapter.

1.3.4. Workflow Automation

Conceptual Model Explorer workflow automation is currently in the early stages of development and not all features are implemented. The goal of the workflow automation feature is to enable users with minimal expertise and training to publish and easily modify a series of related elements in a scientific process (a "workflow"). Editors can configure workflows so that their components link to actual data sources and web services with geoprocessing and other modeling capabilities. The user will be able to adjust parameters, change data sources, execute the workflow and view the output. Additionally, the user will be able to select the area-of-interest for which to run the workflow via the Query Filters Dialog window.

For more information, see the Advanced Workflow Automation chapter.


1.4. Getting Started

1.4.1. Browser Requirements

The Conceptual Model Explorer is a graphics-intensive web application built to be executable in browsers without requiring a 3rd party plug-in. As such, a modern browser with native, standards-compliant vector graphics support is required to effectively use the CME.

The latest versions of Internet Explorer and Firefox are the recommended browsers for best performance. For more information, please see the Browser Compatibility section in the CME Known Issues chapter.

1.4.2. Accessing Help

The CME Help system can be accessed in two ways:
  • Outside the Editor or Viewer - Before entering the CME Viewer or Editor, the CME Help system can be accessed from all other CME web pages by clicking on the "CME Help" link in the upper right corner of the page. The browser will redirect to the CME Help system when the link is clicked.
  • Within the Editor or Viewer - Within the CME Editor or CME Viewer, the CME Help system is accessed by clicking the the CME Help button () in the Main Toolbar. Clicking the button displays the help system in a popup window within the Viewer or Editor, or if the help window is already displayed, it will close the help window.

1.4.3. Registration

Registering with the Conceptual Model Explorer provides a user with a personalized experience when using the Explorer. Benefits of registering include:
  • Potential access to non-public models as editors may limit model accessibility to select users.
  • Store and manage bookmarks associated with model components to more quickly find results from past queries.
  • Ability to request editor privileges so that users can create and edit their own models.

To register, click on "Login" in the CME Top Toolbar and then select "Create New User..." on the Login page. Fill in the user information form and click the "Create User" button when finished.

For more help with login and registration, see Login and Registration (3.2.1) in the Personalization chapter.

1.4.4. CME Viewer Quick Start

To best take advantage of the CME Viewer capbilities, users should read the CME Viewer chapter to become familiar with all of the Viewer features and tools. However, the following list should provide enough guidance to get started using the CME Viewer:

  • To use CME Bookmarking, users must register and login to the CME before starting the CME Viewer.
  • Start the CME Viewer from the CME Home Page.
  • The Open Workspace Dialog will be displayed with a list of available workspaces. If the workspace's editor has provided a description, the workspace's description will appear in a tooltip when you place the mouse cursor over a workspace name. If no tooltip appears, no description is available. Click a workspace to open it and the Open Workspace dialog will close. To open another workspace, the Open Workspace dialog can be displayed at any time by clicking the Open Workspace Dialog button () in the Main Toolbar.
  • Use the Workspace Navigation Tools in the Main Toolbar to pan and zoom the workspace.
  • Within the workspace, double-click an object to populate the Definitions Window and Information Assets Window with the container's definition and information assets. Multiple containers can be selected by holding the Ctrl key down while clicking containers.
  • Right-clicking a selected container provides a list of additional options including the ability to display only the container and its relationships in the Viewer.

1.4.5. CME Editor Quick Start

To use the CME Editor, a user must be registered and submit a request to be an Editor (see the Editors section in the Personalization chapter).

Once a user obtains Editor status, it is highly recommended that they read the CME Editor chapter before creating workspaces (conceptual models or workflows). It is important that user's understand the full functionality of CME Editor because the user's actions can potentially affect other editor's workspaces that they have access to. Help sections 4.4 Creating Workspaces and 4.5 Sharing and Publishing Workspaces are most critical to read before beginning as they describe the optimal sequence of events for building workspaces, and the implications of editing shared workspaces. Knowing the details and required sequence of events for configuring workflows for automation is extremely important before beginning to configure workflows.


1.5. CME Example Scenarios

1.5.1. Exploring the GoMRC Submerged Aquatic Vegetation (SAV) Conceptual Model

1.5.1.1. SAV Conceptual Model Overview

The Submerged Aquatic Vegetation (SAV) Conceptual Model is a decision support tool for resource managers who are concerned with coastal habitat restoration. It provides the user with a visual representation of the ecological cause and effect relationships to SAVs. Additionally, the SAV Conceptual Model provides the user with definitions of ecosystem components, such as ecosystem stressors, structures and processes, and it provides access to datasets and other information products that relate to the components.

More information about the approach and development of the SAV Conceptual Model can be found on the GoMRC Coastal Habitat Restoration web page. The following sections demonstrate performing common tasks in the CME Viewer with the SAV Conceptual Model:

1.5.1.2. Navigating the SAV Conceptual Model

The user can open the SAV Conceptual Model in the CME Viewer by selecting the "Submerged Aquatic Vegetation (SAV) Conceptual Model" link on the CME Home Page. By default, the entire SAV Conceptual Model is displayed in the CME Viewer when loaded:

Given the complexity and large size of the SAV Conceptual Model, the user will need to adjust its display as they explore the model. The following display tools are available to the user in the Main Toolbar at the left of the model:

Pan Mode Button
Puts the mouse left-click in Pan mode. The user can then move the model by holding the left mouse button down on the canvas (tan area), dragging the model to a new position, and then releasing the mouse button. (Note that the mouse left-click action should be put back into Select Mode by clicking the Select Button () before selecting containers) Alternatively, the user can pan the workspace using the right mouse button without having to use the Pan Mode button. Note that in either pan method, the mouse pointer must be over the tan background and not over a container or relationship when panning is initiated.
Zoom In Button
Clicking this button zooms-in one level on the SAV Conceptual Model.
Zoom Out Button
Clicking this button zooms-out one level on the SAV Conceptual Model.
Zoom to Extents Button
Clicking this button zooms the SAV Conceptual Model to its full extents so that the entire workspace is displayed. This is the default display (pictured above) when the model is initially loaded.
Zoom Actual Size (1:1) Button
Clicking this button zooms the SAV Conceptual Model to a one-to-one ratio (or its "actual size"). This zoom-level makes the text easy to read but limits the amount of the model displayed; therefore, the user must use the panning feature to change the displayed portion of the model when using this zoom-level.

Additionally, note that it is possible to resize the canvas displaying the model by dragging the move icon () located between the Definitions and Information Assets Windows.

1.5.1.3. Altering Displayed Relationships

By default, all relationships are displayed in the SAV Conceptual Model. Since there are so many relationships depicted, the model becomes difficult to interpret in some areas. The user may adjust the display of relationships as needed using the context menus available when right-clicking on a container. For example:

Selecting "Show Only Container's First-Level Relationships" from the "Bathymetry/Elevation" container's context menu (above) will hide all relationships except those directly connected to "Bathymetry/Elevation":

If the user wants to display all relationships that connect to the "Bathymetry/Elevation" container at all levels, they select "Show All Relationships With This Container" from the context menu:

Which yields:

To hide all of the model's relationships, the user must right-click the mouse on the canvas where no containers or relationships are displayed. This will show the Workspace Context Menu from which the user selects the "Toggle All Relationships On/Off" option:

In this state, when no relationships are displayed, the user may dynamically display all relationships associated with a container by placing the mouse over the desired container (Note: the display may take a few seconds to update while the connected relationships are determined). This technique provides a useful means to quickly explore relationships associated with different containers:

To reset the display to show all model relationships, select the "Toggle All Relationships On/Off" option in the Workspace Context Menu again.

1.5.1.4. Searching the SAV Conceptual Model

The containers in the SAV Conceptual Model can be used to search the GoMRC Catalog and Noesis. Double-clicking a container retrieves a definition and information assets for the container (from the GoMRC Catalog) that are displayed in the CME Viewer Definitions and Information Assets Windows, respectively. Information Assets are verified metadata entries in the GoMRC Catalog for available web sites, analysis tools, and data related to the container. The following image shows the results of double-clicking the "Storm Events" container within "Stressors":

The Definitions Window displays a concise definition followed by a detailed description (when available). Typically an image is provided to augment the definition. If a higher-resolution image is available, placing the mouse cursor over the image will direct the user to click it to enlarge the image. Often the GoMRC Catalog provides more information than can be optimally displayed in the CME Viewer. In these instances, a link is provided to display the full description directly from the GoMRC Catalog in a new window.

The Information Assets Window displays any verified metadata entries in the GoMRC Catalog. Placing the mouse cursor over an entry will display a brief description of the entry in a tooltip. Clicking the entry's title will expand the entry providing a hyperlink to the resource and any summary information available (see the Buoy Center entry in the example above). Clicking the entry's title a second time hides the details. Additional details are accessible by clicking the "+ more..." option on each entry and can then be hid by clicking "- hide...":

Every search provides a link in the Information Assets Window to launch (in a new browser window) a GoMRC Noesis search with the search terms previously sent to the GoMRC Catalog. Noesis performs a more extensive search using additional Internet catalogs and search engines which typically yields more search results.

It is possible to query the GoMRC Catalog and Noesis for multiple containers at one time. This is achieved by selecting multiple containers before initiating the query. Multiple containers are selected by holding the Ctrl-key down and left-clicking multiple containers while in Select Mode (the default mode). Next, right click one of the selected containers to display the container's context menu. Select "Retrieve Information Assets for Selected Items" to initiate the query. The Definitions window will display the definition for the container that was right-clicked, but the Information Assets window will query for all selected containers using an "OR" operator:

The Query Filters Dialog may be used to refine container initiated searches. The user may specify additional keywords, specify spatial extents via the interactive map, and/or select a time period to augment an information asset query. To apply these optional query parameters, one or more containers must be selected before pressing the "Submit Query" button. If the Query Filters Dialog is visible, the optional parameters set within the window (if any) will be applied to all subsequent searches (including those initiated directly from containers) until the parameters are reset or the dialog is closed.

Please note that a lot of information assets in the GoMRC Catalog do not currently have spatial or temporal attributes, so results may be limited. Also the additional keywords parameters are passed to Noesis when initiating a Noesis search from the Information Assets Window; however, the spatial and temporal constraints currently are not.

1.5.1.5. Bookmarking Search Results

Registered users have the ability to save and easily retrieve CME Bookmarks to the information assets obtained through their search results. CME Bookmarks are always associated with the container(s) selected when the information asset is bookmarked. They include not only a link for quick navigation to the information asset, but they also allow the user to rank the information asset and add personal notes.

If a user is registered and logged-on to the CME, and they perform a search as described in the previous section, each information asset returned in the Information Assets Windows will include a bookmark icon (). Clicking the button launches the Bookmarks Dialog which is then used to add the bookmark. The user may add custom notes and ratings for each bookmark added to their profile. The following images show a user adding a bookmark to the Temperature container from the Information Assets Window:

After clicking the bookmark icon next to the information asset, the Add Bookmark Dialog is displayed with a pre-populated title. The user then adds an optional comment, selects a rating and saves the bookmark. The bookmark is associated with the selected container(s) and added to the user's profile:

After closing the dialog, the user will be able to quickly view the bookmark at any time using the Temperature container's context menu by right-clicking the Temperature container:

The method described is the most direct way to add a bookmark to a container. Bookmarks can also be added directly from external sites using the Google Toolbar or added manually by selecting "Add External Bookmark" from the Bookmarks Dialog (see External Bookmarks). In addition to displaying bookmarks by container as presented above, it is possible to see a user's bookmarks for all containers at once (see the Bookmarks Button in the Main Toolbar), and sort, edit, and delete bookmarks. For more information about using these features, please see the Bookmarks Dialog and Personalization/Bookmarks sections.

1.5.2. SAV Restoration Prioritization Tool - Mobile Bay (Workflow Automation)

1.5.2.1. SAV Restoration Prioritization Tool Overview

Background

The Restoration Prioritization Toolset forms part of an integrated system within the Gulf of Mexico Regional Collaborative (GoMRC) framework to help decision makers from a variety of agencies in their environmental restoration planning process, focusing in this case on submerged aquatic vegetation.

GOMRC's approach to prioritizing sites for restoration is based on a science-based representation of how the system functions, known as an ecological conceptual model. A conceptual model was developed for SAV habitat to help users understand how ecosystem stressors and certain coastal habitat conditions, referred to as controlling factors, can influence SAV distribution and abundance.

Geospatial data can provide insights on various elements of the conceptual model for SAV habitat. Analysis of this data enables the user to predict where:

  • Controlling factor ranges are suitable for maintaining healthy SAV,
  • SAV distribution has changed over time, and
  • Local stressors are influencing SAV habitat.

GoMRC's Restoration Toolset provides a means of collectively evaluating controlling factors, SAV distribution and local stressors, and recommending sites for SAV restoration in Mobile Bay.

CME provides a simple user interface to execute complex spatial analyses and provide results. For those familiar with ArcGIS products, the restoration toolset runs analyses on ESRI's ArcGIS Server through the CME, and a user can execute with default datasets, provide new datasets, change weighting and choose to view or download results.

Restoration Toolset Elements

The Restoration Toolset contains three fundamental models that will run sequentially:

  • Model for Controlling Factors which uses NASA derived datasets with local datasets to predict areas which are suitable for a species growth.
  • Benthic Change Tool examines species structure and distribution.
  • Prioritization are scripts which summarize and weight stress and produce final recommended management actions.

Further details about each of these models are available on-line at www.gomrc.org.

1.5.2.2. Executing the SAV Restoration Prioritization Tool

The restoration framework can be executed by following four simple steps:

  1. Log on to the Conceptual Model Explorer.
  2. Select "Execute Workspace".
  3. Configure set-up if desired.
  4. Download or map results.
1.5.2.2.1. Login

While a casual user may view conceptual models and tools without logging on, a login is required to execute or change tools. Users can easily register for a free user account, by selecting "Create New User" from the CME Login page.

After logging on, the user will have a choice of different tools and models to view within the CME. In this case, we will select the "SAV Restoration Prioritization Tool" from the CME Home page. The CME Viewer will then open with the SAV Restoration Prioritization Tool workspace loaded:

This is a visual representation of analysis elements. The toolset is comprised of three separate models that will run sequentially. Input datasets are grouped by the category of the scientific conceptual model they represent: Controlling Factors, Stressors or Structure (SAV).

Models are visually represented by orange diamonds ("Adapters").

Input datasets are shown in blue, and outputs in yellow. In this case the shapefile for restoration sites is shown in green. After execution, newly derived datasets may either be visualized in our interactive map, or downloaded.

Relationships are represented by blue arrows. They can represent inputs to a model and outputs from a model.

Further details on these components and the CME itself are available through the CME help which is always accessible from the Main Toolbar on the left of the CME Viewer.

1.5.2.2.2. Execute the Workspace

To execute the spatial analysis, users should click the Workspace Execution Button () on the left side Main Toolbar. This will launch the Workspace Execution Dialog which will allow the user to run and optionally configure the SAV Restoration Prioritization Tool:

To run the SAV Restoration Prioritization Tool with its default settings, click the "Run" button. Icons will then appear on the workspace indicating the status of the containers during execution:

Processing.
Processing Complete.
Terminal output dataset populated.
Waiting to process.
Processing Error.

The dialog will indicate when execution is finished or if an error occurs. The Cancel button closes the dialog window and stops execution of the workspace if it was started.

1.5.2.2.3. Optional Configuration

Using the Workspace Execution Dialog shown above, the SAV Restoration Prioritization Tool can optionally be configured by the user to better fit their specific needs before it is executed. Currently, the user may change the default input datasets and/or adjust the scoring weights of the input stressors.

Scoring of Stressors

The Configurable Elements section of the Workspace Execution Dialog indicates that the "Stressors" parameter of the Stressors Weights Prioritization Adapter (model) is configurable. The user can view and adjust the "Stressors" parameter by clicking the Edit button () to the right of the parameter which opens the "Edit Parameter" dialog:

The user can change the relative importance of each unique stressor by entering a new number (integer) in the Weight box for each input stressor. The user should click "Save" to record their weight changes. The user is then retuned to the Workspace Execution dialog where the SAV Restoration Prioritization Tool can be run with the new stressor weights.

Input Datasets

Input datasets may also be changed prior to execution the SAV Restoration Prioritization Tool by clicking the Edit button () to the right of the desired dataset. When the Edit button is clicked, the Edit Dataset URL dialog appears:

The user must enter the URL of the dataset to be used. The complete dataset in the proper format must be available online. Please see the Coastal Habitat Restoration Model for Submerged Aquatic Vegetation documentation for each dataset requirement. (Note: User upload of datasets directly from their computer to the CME server is currently experimental and will be supported in future CME versions.) The user should click "Save" to record their dataset change. The user is then retuned to the Workspace Execution dialog where the SAV Restoration Prioritization Tool can now be executed with their data.

1.5.2.2.4. View and Download Results

The SAV Restoration Prioritization Tool may take several minutes to run. The Workspace Execution dialog will indicate when the entire SAV Restoration Prioritization Tool is finished, and then the dialog may be closed. Closing the Workspace Execution dialog during execution will cancel execution and reset all SAV Restoration Prioritization Tool parameters and datasets to their default settings.

The SAV Restoration Prioritization Tool execution progress may be monitored by watching the container status icons as mentioned above. As each adapter (model) finishes, their yellow output datasets will be populated with viewable and downloadable results. The user will know these datasets are ready when they display the MapMaker icon (). The user can click the MapMaker icon to view the results with MapMaker in a new window. Additionally, the user may launch the results in MapMaker from the dataset's context menu (right-click dataset to view) where they may also download the dataset to their computer:

The final dataset will be available in the form of an ESRI shapefile. For those interested in accessing the results in a spreadsheet, choose to download the .dbf file. This file can be opened in Excel. Intermediate dataset outputs will be in GeoTIFF format.

For more information on CME workflow automation, please see the Workflow Automation and the Advanced Workflow Automation sections.

For more information about the SAV Restoration Prioritization Tool, please see the Coastal Habitat Restoration Model for Submerged Aquatic Vegetation documentation.

Table of Contents

2. CME Viewer

2.1. Overview

The CME Viewer is a web application providing the ability to explore conceptual models, workflows and adapters (collectively referred to as "workspaces" in the CME) developed by scientists and researchers. Detailed information about workspace components (referred to as "containers" and "relationships") can be easily obtained in the CME Viewer through built in tools that query a variety of remote web services and search tools. Additionally, some workflows allow users to modify component parameters, execute the workflow, and view the results through the CME Viewer.

To get started using the CME Viewer, users should familiarize themselves with the following: Due to its extensive use of vector graphics, the CME Viewer will only work properly in modern web browsers with native support for SVG or VML graphics. Please see the Known Issues and Bugs section for supported browsers if you are having display problems.
Table of Contents

2.2. Viewer Desktop

The CME Viewer desktop (main window) is designed to have the look and feel of a desktop application. Most notably, the page flashing typically associated with web sites posting back to the server have been eliminated through extensive use of AJAX technologies which allow your browser to transparently communicate with the CME Server as you click elements in the Viewer. Additionally, the Viewer contents adjust to make the most efficient use of the entire browser area so that the user can achieve optimal graphics display. The main windows within the viewer are also size-adjustable to help maximize the viewing experience.

There are several areas of the CME Viewer that the user should be familiar with before using the tool:

2.2.1. Canvas

The Canvas (#1 in image above) is the area where workspaces (conceptual models, workflows and adapters) are displayed. For more information on using the canvas area, see the Navigating Workspaces and Main Toolbar help sections.

2.2.2. Main Toolbar

The Main Toolbar (#2) located on the left side of the Viewer contains tools to control the display of models and workflows on the canvas. Additionally, several dialogs can be toggled on and off from the toolbar. Displayed toolbar options will vary depending on the type of workspace loaded into the canvas and whether the user is registered and logged-in.

Toolbar options include:
Open Workspace Dialog Button
Shows/Hides the dialog to open a workspace. A workspace can be a conceptual model, workflow, or adapter.
Also see Open Workspace Dialog.
Print Workspace Button
Launches a new temporary window with only the currently loaded workspace (at the current zoom level) displayed and then automatically launches user's browser print dialog. After user confirms or cancels print job, the temporary window is closed and the user is returned to the CME Viewer.
Help Dialog Button
Shows/Hides the CME help dialog.

Workspace Navigation Tools:
Select Mode Button
Puts the mouse left-click in Select mode so the user can select canvas objects by left-clicking. To select multiple objects, hold the "CTRL" key while clicking.
Pan Mode Button
Puts the mouse left-click in Pan mode. The user can then move the workspace by holding the left mouse button down and dragging the workspace.
Zoom In Button
Clicking this button zooms-in one level on the workspace currently loaded in the canvas.
Zoom Out Button
Clicking this button zooms-out one level on the workspace currently loaded in the canvas.
Zoom to Extents Button
Clicking this button zooms the workspace currently loaded in the canvas out to its extents so that the entire workspace is displayed.
Zoom Actual Size (1:1) Button
Clicking this button zooms the workspace currently loaded in the canvas to a one-to-one ratio (or the "actual size").

Other Tools:
Query Filters Dialog Button
Shows/Hides the Query Filters dialog window. The Query Filters dialog window is displayed by default when the CME Viewer is launched. Constraints set in the dialog will only be used if the window is displayed when queries are sent.
Also see Query Filters Dialog.
Bookmarks Button
Launches dialog displaying all bookmarks the user has saved for all workspaces. The user can edit and delete bookmarks from this dialog, but can not add bookmarks since bookmarks are associated with workspace containers. To add a bookmark, the user must first select one or more containers and then use the right-click context menu to launch the dialog for adding bookmarks.
Also see Bookmarks Dialog.
Workspace Execution Button
Appears when a Workflow or Adapter is loaded. The Execution button launches the dialog that allows a user to run a Workflow or Adapter. Workflows and Adapters are potentially executable, but they must be configured for execution by their authors. Additionally, the user may be required to or have the option to change settings before execution. If the loaded Workflow or Adapter has not been properly configured to execute, the user will be notified when attempting to execute it.
Also see Workspace Execution Dialog.

2.2.3. Top Toolbar

The Top Toolbar (#3) is comprised of two sections. The left side provides navigation back to the main GoMRC web site:
  • Home - Gulf of Mexico Regional Collaborative (GoMRC) home page.
  • About - Overview of the Gulf of Mexico Regional Collaborative.
  • Partners - Gulf of Mexico Regional Collaborative partners.
  • Contact Us - Launches default email program to send message to GoMRC.
The right side of the Top Toolbar provides:
  • CME Home - Conceptual Model Explorer home page on the GoMRC web site.
  • Login - Allows user to register and/or login to the CME to leverage advanced features.
Additionally, if a user is already logged-on to the CME, the right side of the Top Toolbar will appear slightly different:
A hyperlink to the CME Editor is added if the user has editor privileges and the Login link is replaced with a link to the logged-on user's options which include logging-out and updating the user's profile.

To the left of the Top Toolbar is an area that displays the name of the currently loaded workspace when a workspace is loaded.

2.2.4. Definitions Window

The definitions window (#4) located in the top right of the CME viewer displays detailed information (when available) about a container when a container is double-clicked with the left mouse button. In addition to definitions, the window may display images, links and other relevant information.

If the mouse pointer changes to the hand icon when placed over an image, the image can be clicked to toggle it between its original and reduced size.

The size of the Definitions Window can be adjusted by dragging the move icon () located to the lower left of the window.

2.2.5. Information Assets Window

*If a user is logged-on, each information asset will have the Add Bookmark icon which launches the Add Bookmark Dialog so the user can easily add an information asset bookmark to their personal bookmarks.

The Information Assets window (#5) located in the bottom right of the CME viewer displays information assets (when available) linked with a container when it is double-clicked with the left mouse button. An information asset is a search result that provides links to metadata, GIS data, imagery, web sites, and more.

Clicking on an information asset title will expand the item to provide additional asset details and access to hyperlinks. Sometimes icons are displayed which will launch external applications displaying the information asset or part of the information asset in a new window. These applications include animations, interactive maps, and others. The tooltips can help familiarize the user with navigation of the dialog and the icons.

The size of the Information Assets Window can be adjusted by dragging the move icon () located to the top left of the window.

Table of Contents

2.3. Viewer Dialogs

The CME Viewer contains four main dialogs: These dialog windows can be moved by left-click and dragging the title bars. Buttons to minimize and close the windows will be displayed in the title bar's right side when available. Additionally, these dialog windows have a button to toggle their display in the Main Toolbar.

2.3.1. Open Workspace Dialog

The Open Workspace dialog appears automatically when the CME Viewer is started without a workspace. Click on the desired workspace to load the workspace into the canvas. The dialog will automatically close.

The Open Workspace dialog can be displayed or hidden at anytime using the Open Workspace Dialog Button. The dialog can be minimized or closed using the buttons in the upper-right of the window.

2.3.2. Query Filters Dialog

The Query Filters dialog allows a user to refine an information asset query. The user may specify additional keywords, specify spatial extents via the interactive map, and/or select a time period to augment an information asset query. To apply these optional query parameters, one or more containers must be selected before pressing the "Submit Query" button. If the Query Filters Dialog is visible, the optional parameters set within the window (if any) will be applied to all subsequent searches (including those initiated directly from containers) until the parameters are reset or the dialog is closed.

Please note that a lot of information assets in the GoMRC Catalog do not currently have spatial or temporal attributes, so results may be limited. Also the additional keywords parameters are passed to Noesis when initiating a Noesis search from the Information Assets Window; however, the spatial and temporal constraints currently are not.

The Query Filters dialog provides three options:
2.3.2.1. Additional Keywords
Any words entered in the Keywords textbox will be sent in addition to the selected container's name. Currently, additional keywords are combined with the container's name implicitly using the "OR" boolean operator.

2.3.2.2. Spatial Filter
A Spatial Filter can be set using the interactive map. Use the mouse wheel or ZoomIn and ZoomOut icons to zoom the map. Left-click and drag to pan the map. To draw a spatial extent on the map, put the map into Draw mode by clicking the Draw Extents button. Then left click to add points defining your desired area. Add the last point with a right-click to finish and close the polygon. The polygon will appear in red and the spatial extent will be drawn as a green box around the polygon. The minimum and maximum latitude and longitudes from the green box will be displayed in the textboxes below the map, and these are the spatial parameters that will be sent with queries. When defining a spatial extent, to quit without saving, click the Cancel button. To clear a spatial extent, click the Reset button, or if you wish to redefine the extent, just click the Draw Extents button again and the previous extents will automatically clear when the map goes into Draw mode.

2.3.2.3. Temporal Filter
The Temporal Filter allows the user to select a year or range of years from a drop-down list.

2.3.3. Bookmarks Dialog

Bookmarks are a personalization feature of the Conceptual Model Explorer. Registered users may save bookmarks created from search results in their profile. Bookmarks are always associated with one or more workspace containers.

The Bookmarks Dialog is presented to the user to add and/or manage bookmarks:

If the dialog is opened using the Bookmarks button in the main toolbar, all of the user's bookmarks from all workspaces and containers are displayed. Alternatively, a user can right click on a container and launch the dialog showing only bookmarks associated with the selected container. This method also allows a user to add external bookmarks that will be associated with the selected container.

The bookmarks dialog displays the bookmark name, user notes and user rating for each bookmark. The dialog listing can be sorted by name or rating by clicking on the desired heading. To the right of each bookmark listed are the edit () and delete () buttons. The edit button opens a dialog to allow the user to edit the name, URL, notes and rating for the bookmark. The delete button will remove the bookmark from the user's profile.

There are two potential type of bookmarks, GoMRC Catalog bookmarks and External bookmarks:

2.3.3.1. GoMRC Catalog Bookmarks

GoMRC Catalog bookmarks are added directly from search results appearing in the Viewer Information Assets Window. When clicking on a GoMRC Catalog bookmark name in the Bookmarks Dialog, additional details about the information asset appears below the name. GoMRC catalog bookmarks may also display additional icon buttons which launch remote applications. When editing a GoMRC Catalog bookmark, the user will not have the option to edit the bookmark's name or URL.

2.3.3.2. External Bookmarks

External bookmarks are those that a user finds in sources other than the GoMRC Catalog, such as through Noesis. When an External Bookmark is displayed in the Bookmarks Dialog, clicking on its name loads the bookmark's URL in a new browser window. A user adds these bookmarks to their bookmarks after launching the Bookmarks dialog by right-clicking on the selected container. Then the user selects the "Add External Bookmark" option and a dialog appears:

The Add External Bookmark dialog and the Edit Bookmark dialogs are very similar. The user must type a name for the new bookmark and type or cut-and-paste a URL into the URL text box. Optionally, the user can add notes and select a rating. When finished, the user clicks the "Save" button and the new bookmark appears in the container's bookmark list as the Add External Bookmark dialog closes.

External bookmarks can also be added from a Google toolbar. Click the link below to add a CME Bookmarking button to your Google Toolbar. The user will be prompted to install the Google Toolbar if it is not already installed:


Once installed, when the user navigates to a third party web site through a CME Search,they will have the option of clicking the CME Bookmark Icon () in the Google toolbar of that window. Clicking the icon will redirect the browser to a pre-populated CME form to add a CME bookmark from that site to the user's CME profile.

2.3.4. Workspace Execution Dialog

The Workspace Execution Dialog is still being developed and is subject to change. The dialog is launched from the main toolbar by clicking the Workspace Execution Button (). The Workspace Execution Button only appears when a Workflow or Adapter is loaded as these are the only potentially executable workspace types.

If a workspace has been configured for execution and the Workspace Execution Button is clicked, the Workspace Execution Dialog appears with the "Run" and "Cancel" buttons displayed:

Clicking the Run button begins execution of the workspace. Icons will then appear on the workspace indicating the status of containers during execution. The dialog will indicate when execution is finished or if an error occurs. The Cancel button closes the dialog window and stops execution of the workspace if it was started.

If a workspace has not been configured for execution, or has been incorrectly configured, and the Workspace Execution Button is clicked, the Workspace Execution Dialog appears as follows:

Notice the dialog indicates that the workspace is not executable and additionally lists the first error encountered when verifying workspace configuration. If the user knows the workspace is supposed to be executable, they can use the error message to help correct configuration problems.

Table of Contents

2.4. Navigating Workspaces

Workspaces (conceptual models, workflows, and adapters) are displayed in the CME Viewer Canvas. Buttons in the Workspace Navigation Tools portion of the Main Toolbar can be used to control selection, panning and zooming(scaling) the displayed workspace on the Canvas. This section describes the other tools available within the canvas which can change the workspace display.

2.4.1. Workspace Elements

There are three basic types of workspace elements the user should be familiar with to be able to navigate a workspace that is loaded in the Canvas:

Additional workspace objects including plain text and images exist to help document a workspace. These objects are static, providing no user interaction capabilities, so they require no further explanation. The following sections briefly describe the major workspace elements.

2.4.1.1. Containers

Containers are objects on a workspace that represent Organizing Principles, System Components, Datasets, Geoprocesses, Adapters, Conceptual Models, and Workflows.

2.4.1.2. Relationships

Relationships are directional edges that connect containers and are represented as arrows on the canvas. Relationships may have a type and/or duration as well as other information which can be viewed through the Properties menu by right clicking a relationship.

2.4.1.3. Workspace

The Workspace is the entire workflow, conceptual model, or adapter represented in the canvas area. Workspace options can be accessed by right clicking anywhere on the canvas where there is no object displayed.

2.4.2. Context Menus

Once a workspace is loaded into the Canvas from the Open Workspace Dialog, the user is able to alter the display of containers and relationships through the use of context menus. Context menus are popup menus that list options available related to the object (container, relationship, or canvas) that the mouse cursor is currently over when the right mouse button is clicked. The context menu options vary depending on which type of object is hovered. The following sections detail the context menu options for the three basic types of objects that may appear in the canvas:

2.4.2.1. Container Context Menus

Container context menus are the menus that the user will use most often. The following briefly describes the container context menu options:

Retrieve Information Assets for Selected Items
Sends requests to remote web service catalogs using names of selected containers and options selected in the Query Filters Dialog. Results are displayed in the Definitions and Information Assets Windows. See Performing Searches for more information.
View/Add Container Bookmarks
Launches the Bookmarks Dialog to view or add bookmarks for the selected container. If the container currently has no bookmarks, this menu item will be displayed as "Add Container Bookmarks". See Bookmarking for more information.
Show Only Container's First-Level Relationships
Hides all relationships except those directly connected (first-level) to the selected container. This option is used to isolate the items of interest in complex workspaces. All relationships can be redisplayed using the Workspace Context Menu.
Show All Relationships With This Container
Shows only the relationships that occur in the paths to and from the selected container. All other relationships are hidden. This option is used to isolate the items of interest in complex workspaces. All relationships can be redisplayed using the Workspace Context Menu.
Properties
Launches a Properties Dialog displaying additional properties about the container if any have been defined by the workspace's editor. See Properties Dialogs for more information.
Optional menu items:
Download Data To Your Computer
If the container is of type Dataset and the Dataset has been configured with an FTP or web site URL, this option will be displayed. Clicking this option will cause the URL to open in a new window so the data can be directly downloaded to your computer. Datasets with this option are typically found in Workflows or Adapters.
View Result in Map Maker
If the container is of type Dataset and the Dataset has a valid FTP or web site URL, this option will be displayed. Clicking this option will launches MapMaker to display the dataset. Datasets with this option are typically found in Workflows or Adapters.
2.4.2.2. Relationship Context Menus

Relationship context menus are not used very often at this point since most current workspaces have not been created to leverage relationships to their full extent. The following briefly describes the relationship context menu options:

Retrieve Information Assets for Selected Items
*Relationships are currently not supported by remote catalogs.
This option is for future implementation.
Sends requests to remote web service catalogs using names of selected relationship and options selected in the Query Filters Dialog. Results are displayed in the Definitions and Information Assets Windows. See Performing Searches for more information.
Properties
Launches a Properties Dialog displaying additional properties about the relationship, including type and duration, if any have been defined by the workspace's editor. See Properties Dialogs for more information.
2.4.2.3. Workspace Context Menu

The Workspace context menu is always available and provides tools that apply to the entire workspace that is displayed on the canvas. The following briefly describes the workspace context menu options:

Show Full Workspace
Redraws the workspace with all containers and relationships at its full extent so everything is displayed. This option basically resets the workspace to the same view as when it is originally loaded.
Toggle All Relationships On/Off
Toggles the display of all Relationships. If any or all relationships have previously been hidden, all relationships will be displayed. Otherwise, all relationships will be hidden which helps to simplify the display of complex workspaces to focus on containers.
Properties
Launches a Properties Dialog displaying additional properties about the workspace, including description, if any have been defined by the workspace's editor. See Properties Dialogs for more information.

2.4.3. Properties Dialogs

Properties dialogs are available from the three previously discussed context menus though their content will vary depending on the element they describe. Currently, the properties dialogs are read-only and display information used mostly by workspace editors. The properties that most users would be interested in are "Label" and "Description". Relationships additionally have "Type", "Duration", and "Edge Weight" properties which will be utilized in future workspaces. Other properties are currently irrelevant to general users and will likely change or disappear in future revisions.

2.5. Performing Searches

One of the key features of the CME is the ability to quickly perform contextual searches for the components depicted in a conceptual model or workflow. The easiest way to perform a search is by double-clicking a container. Alternatively, a search may be instantiated from a container's context menu which is available by right-clicking on a container.

When a search is submitted, the words comprising the selected container's name are sent to Gulf of Mexico Regional Collaborative (GoMRC) ontological catalogs. The catalogs are searched for the keywords, and the results are displayed in the CME Viewer Definitions Window and Information Assets Window. The Definitions Window presents a brief description of the selected container and the Information Assets Window lists relevant links that may provide additional information and/or raw data relating to the selected container(s). If multiple containers are selected (by holding down the Ctrl key while selecting with left mouse button), all selected containers' names are queried to produce the Information Assets Window results while only the last selected container is used for the Definitions Window's content.

Finally, the Query Filters Dialog allows one to refine searches spatially, temporally, and with additional keywords. Whenever the Query Filters Dialog is displayed, any parameters set within the dialog will be applied to the Asset Window results when submitting searches. Using the Query Filters Dialog with searches enhances the user's ability to refine searches, and consequently may substantially limit the number of returned results.


2.6. Bookmarking

When registered users execute searches, the results in the Information Assets Window will display a button () which permits the user to initiate saving the result in their personal CME bookmarks collection. Clicking the button launches the Bookmarks Dialog which is then used to add the bookmark. The user may add custom notes and ratings for each bookmark added to their profile. Added bookmarks are always associated with the containers selected when the search query was submitted.

For more information on bookmarks, please see the Bookmarks Dialog and Personalization/Bookmarks sections.


2.7. Workflow Automation

2.7.1. Workflow Automation Overview

A CME workflow represents a process to achieve a task or series of related tasks. Typically a workflow consists of input and output datasets linked in series by relationships with one or more adapters and/or geoprocesses. Additionally, organizing principles are often included to help categorize the containers.

While CME Workflows are usually built initially to present the details of a process or analysis methodology, the more significant and interesting feature of CME Worklflows is that they can be made user executable. If a workflow has been made executable, registered users may use the CME Viewer to configure, run, and view the results of the workflow. The following sections introduce the user to using these automated workflows.

2.7.2. Configuring and Executing the Workflow

If the user is a registered user and the loaded workflow is executable, the Workflow Execution Button () will appear in the CME Viewer Main Toolbar. Clicking the button will launch the Workspace Execution Dialog and verify that the workflow is configured properly. If the workflow has user configurable properties, such as layer weighting or dataset specification, the dialog will provide the options for the user to configure these before running the workflow. Please see the Workspace Execution Dialog for more details.

The user begins workflow execution by clicking the Run button in the dialog. As the workflow runs, each container will display an icon indicating its execution status:

Processing.
Processing Complete.
Terminal output dataset populated.
Waiting to process.
Processing Error.

The Workspace Execution Dialog will display the status of execution including if an error occurs and when the execution is successfully completed. If the user cancels execution, execution stops and all execution-related icons are removed from the workflow. The next section explains how the user may leverage the workflow execution results.

2.7.3. Workflow Results

When terminal output datasets (a dataset that does not pass to another container) have been populated with results, they will display the MapMaker icon () which the user can click to view the results with MapMaker in a new window. Additionally, the user may launch the results in MapMaker from the dataset's context menu (right-click dataset to view) where they may also download the dataset to their computer:

For more information on workflow automation, please see the SAV Restoration Prioritization Tool user scenario and the Advanced Workflow Automation sections.

Table of Contents

3. Personalization

The Conceptual Model Explorer supports two types of users, Anonymous (the default) and Registered. The following sections elaborate these two user types.

3.1. Anonymous Users

The Anonymous User type is the default. Anonymous users can access the CME Viewer only. They have access to all of the Viewer features except for CME Bookmarking. No login or registration is required for anonymous CME users.


3.2. Registered Users

Registering with the CME provides the user with the ability to store and use CME Bookmarks. Additionally, registered users can request Editor privileges to create and edit CME workspaces. Registering with the CME is free, and all private information is used only for the CME and is not shared.

3.2.1. Login and Registration

Registered users can access the Login page by clicking the "Login" item in the upper right menu on the Home page. New users can register by selecting the "Create New User..." option on the Login page which redirects them to the Registration page.

When logging-in to the CME, the checkbox for placing a cookie on the user's computer is selected by default. This option allows the user to be automatically logged-in on subsequent visits if they do not logout. If using a publicly accessible computer, the user may want to uncheck this box in case they forget to logout.

Once logged-in, the "Login" option in the Top Toolbar changes to Username's Options. This new item will redirect the user to a page with multiple task options including logging out and updating their CME Profile (user information).

3.2.2. Bookmarks

Registered users have the ability to save and easily retrieve CME Bookmarks to the information assets obtained through their search results. CME Bookmarks not only store a link for quick navigation to the information asset, but they also allow the user to rank the information asset and add personal notes about the information asset. CME Bookmarks are always associated with the component(s) that were selected when the bookmark was added so it is easy to find favorite information assets for a particular model or workflow component. A user's CME bookmark collection is private and maintained on the CME server so it is available in subsequent CME sessions.

There are two basic types of CME bookmarks which are discussed in the following sections.

3.2.2.1. GoMRC Catalog Bookmarks

Search results displayed in the Viewer Information Assets Window are generated from queries to the GoMRC Catalog. These results may be saved to the user's personal bookmarks collection as GoMRC Catalog bookmarks. GoMRC Catalog bookmarks include additional descriptive information (generated by the GoMRC Catalog) about an information asset beyond a name and URL. They may also include additional icon buttons that launch remote applications. When editing a GoMRC Catalog bookmark, the user will not have the option to edit the bookmark's name or URL.

Example GoMRC Bookmark.
3.2.2.2. External Bookmarks

External bookmarks are those that a user finds in sources other than the GoMRC Catalog, such as through Noesis. They include the URL, a user specified name, a user rating, and optionally user notes.

The External Bookmarks subsection in the Bookmarks Dialog help section provides guidance for adding external bookmarks from within the CME Viewer. External Bookmarks may also be added from the target site itself with the aid of the Google Toolbar as explained in the next section.

3.2.2.2.1. Adding Bookmarks Via the Google Toolbar
External bookmarks can be more easily added directly from a browser window displaying the target site using the Google toolbar. Click the link below to add a CME Bookmarking button to your Google Toolbar. The user will be prompted to install a Google Toolbar if it not already installed:


Once installed, , when the user navigates to a third party web site through a CME Search, they will have the option of clicking the CME Bookmark Icon () in the Google toolbar of that window. Clicking the icon will redirect the browser to a pre-populated CME form to add a CME bookmark from that site to the user's CME profile.

3.2.3. Editors

CME Registered users may request Editor permissions so that they may create, edit and share workspaces in the CME. Currently, CME Editor privileges are limited to GoMRC project partners involved with the development of GoMRC identified workspaces. To request CME Editor permissions, please register with the CME and then submit a request for Editor status via the CME Feedback Form. Be sure to include your CME Username when requesting Editor privileges.

3.2.4. Workspace Sharing and Publishing

Editors may share their workspaces with other editors for development and can publish them to the CME Viewer so all CME users can see them. For more information on how to do this, see the Workspace Sharing and Publication Dialog help in the CME Editor section.

Table of Contents

4. CME Editor

4.1. Editor Overview

The CME Editor is a web application providing the ability to create, edit and share conceptual models, workflows and adapters (collectively referred to as "workspaces"). Workspaces created with the CME Editor may be published to the CME Viewer for use by the general public. To use the CME Editor, a registered user must first request Editor privileges. The remainder of this chapter provides guidance for using the CME Editor. To obtain optimal results, new users should read the entire chapter, especially Section 4.4 Creating Workspaces, before using the editor.

Like the CME Viewer, users should be familiar with several areas of the CME Editor before using the tool:


4.2. Editor Desktop

4.2.1. Canvas

The Canvas (#1 in image above) is the area where workspaces (conceptual models, workflows and adapters) are displayed. Containers, relationships, and other graphic objects are added to the Canvas using the Editor's Main Toolbar.

4.2.2. Main Toolbar

The Main Toolbar (#2) located on the left side of the Editor contains tools to create, edit, and control the display of workspaces on the canvas. Additionally, several dialogs can be toggled on and off from the toolbar.

Toolbar options include:
Open Workspace Dialog Button
Shows/Hides the dialog to open a workspace. A workspace can be a conceptual model, workflow, or adapter.
Also see Open Workspace Dialog.
Save Workspace Button
Saves the current workspace to the CME database.
Workspace Sharing and Publishing Dialog Button
Shows/Hides the dialog to share the current workspace with other editors and to publish it to the CME Viewer.
Also see Workspace Sharing and Publishing Dialog.
Tasks Menu Button
Shows/Hides the Tasks Menu Dialog. The Tasks Menu is used to configure the properties of selected workspace elements.
Also see Tasks Menu Dialog.
Preview Workspace Button
Launches a new browser window displaying the current workspace at the current scale.
Print Workspace Button
Launches a new temporary window with only the currently loaded workspace (at the current zoom level) displayed and then automatically launches user's browser print dialog. After user confirms or cancels print job, the temporary window is closed and the user is returned to the CME Editor.
Display Workspace XML Button
Displays the workspace's underlying XML in a new browser window. This feature is currently used mostly by developers for debugging; however, it may be extended in future versions to allow saving and retrieving of models to a user's computer.
Help Dialog Button
Shows/Hides the CME help dialog.

Workspace Navigation Tools:
Select Mode Button
Puts the mouse left-click in Select mode so the user can select canvas objects by left-clicking. To select multiple objects, hold the "CTRL" key while clicking.
Pan Mode Button
Puts the mouse left-click in Pan mode. The user can then move the workspace by holding the left mouse button down and dragging the workspace.
Zoom In Button
Clicking this button zooms-in one level on the workspace currently loaded in the canvas.
Zoom Out Button
Clicking this button zooms-out one level on the workspace currently loaded in the canvas.
Zoom Actual Size (1:1) Button
Clicking this button zooms the workspace currently loaded in the canvas to a one-to-one ratio (or the "actual size").
Zoom to Extents Button
Clicking this button zooms the workspace currently loaded in the canvas out to its extents so that the entire workspace is displayed.

Edit Tools:
Undo Button
Undoes the last action in the user action history. The user may go back up to 50 actions or to the last save. Applies only to actions performed on workspace objects and not to navigation actions.
Redo Button
Moves forward through action history reapplying actions that have been undone using the Undo Button.
Cut Button
Cuts the selected element(s).
Copy Button
Copies the selected element(s).
Paste Button
Pastes the selected element(s).
Delete Button
Deletes the selected element(s).
Group Button
Creates a group containing the selected element(s).
Ungroup Button
Removes the selected group from its contained element(s).

Container & Relationship Tools:
Organizing Principle Button
Adds a new Organizing Principle container to the canvas. When button is pressed, clicking on the canvas will add an Organizing Principle. Alternatively, the user may drag-and-drop the button to the canvas.
Component Button
Adds a new Component container to the canvas. When button is pressed, clicking on the canvas will add a Component. Alternatively, the user may drag-and-drop the button to the canvas.
Workflow Button
Adds a new Workflow container to the canvas. When button is pressed, clicking on the canvas will add a Workflow. Alternatively, the user may drag-and-drop the button to the canvas.
Conceptual Model Button
Adds a new Conceptual Model container to the canvas. When button is pressed, clicking on the canvas will add a Conceptual Model. Alternatively, the user may drag-and-drop the button to the canvas.
Adapter Button
Adds a new Adapter container to the canvas. When button is pressed, clicking on the canvas will add an Adapter. Alternatively, the user may drag-and-drop the button to the canvas.
Dataset Button
Adds a new Dataset container to the canvas. When button is pressed, clicking on the canvas will add a Dataset. Alternatively, the user may drag-and-drop the button to the canvas.
Geoprocess Button
Adds a new Geoprocess container to the canvas. When button is pressed, clicking on the canvas will add a Geoprocess. Alternatively, the user may drag-and-drop the button to the canvas.
Container Gallery Button
Hides/Shows the Container Gallery Dialog. The Container Gallery is used to add exiting containers, both the user's and those created and shared by other user's, to the canvas and therefore the workspace.
Segmented Relationship Button
Adds a new elbow Relationship to the canvas.

When the button is pressed, the user may connect two containers with a new, directional relationship. The user must place the mouse cursor over the desired source container until it is highlighted with a green box. The green box indicates that pressing the left mouse button will begin the relationship add. The user must press and hold the mouse button as they drag the cursor to the desired target container. When the target container highlights with a green box, the left mouse button can be released to complete the relationship add.
Straight Relationship Button
Adds a new straight Relationship to the canvas.

When the button is pressed, the user may connect two containers with a new, directional relationship. The user must place the mouse cursor over the desired source container until it is highlighted with a green box. The green box indicates that pressing the left mouse button will begin the relationship add. The user must press and hold the mouse button as they drag the cursor to the desired target container. When the target container highlights with a green box, the left mouse button can be released to complete the relationship add.

Other Graphics Tools:
Left Arrow Button
Adds a left arrow image to the canvas.
Right Arrow Button
Adds a right arrow image to the canvas.
Up Arrow Button
Adds an up arrow image to the canvas.
Down Arrow Button
Adds a down arrow image to the canvas.
Text Button
Adds a text element to the canvas.
Horizontal Line Button
Adds a horizontal line element to the canvas.

4.2.3. Top Toolbar

The Top Toolbar (#3) is the same as for the CME Viewer except that when the user has the CME Editor open, the CME Editor menu item is replaced by a CME Viewer item so the user can go directly to the Viewer when done editing.

Please see the CME Viewer Top Toolbar section for more information.

4.2.4. Quick-Nav Window

The Quick-Nav Window (#4) allows the user to quickly pan and zoom the displayed workspace. The blue rectangle within the Quick-Nav window represents the canvas extents. The user may left-click and drag the extents to quickly pan the canvas. The lower right corner may be left-clicked on the small brighter blue square and then dragged to alter the zoom level.


4.3. Editor Dialogs

The CME Editor contains six main dialogs: These dialog windows can be moved by left-click and dragging the title bars. Buttons to minimize and close the windows will be displayed in the title bar's right side when available. Additionally, some dialog windows have a button to toggle their display in the Main Toolbar.

4.3.1. Open Workspace Dialog

The Open Workspace dialog appears automatically when the CME Editor is started without a workspace. The Open Workspace dialog can be displayed or hidden at anytime using the Open Workspace Dialog Button. The dialog can be minimized or closed using the buttons in the upper-right of the window.

The user has the option to create a new Conceptual Model, Workflow, or Adapter by clicking the "Create New" button in the corresponding category. This option will prompt the user for a workspace name. After the user submits a new workspace name, the CME Editor will initialize a new workspace with that name, and the user may then begin building their workspace.

A user may alternatively select an existing workspace from one of the dropdown lists to edit or copy if any existing workspaces are available. When the user makes a selection from a dropdown list, the "Edit" and/or "Copy" buttons will enable depending on the existing workspace's permissions. If the user has edit permissions on the existing workspace, they can click the "Edit" button to view and update that workspace. Otherwise, clicking the "Copy" button will prompt the user for a new workspace name and save a copy of the workspace with the new name and the current user as its owner. Edits to copied workspaces have no impact on the original workspace that was copied.

4.3.2. Tasks Menu Dialog

The Tasks Menu Dialog is dynamically generated and updated as workspace elements are selected and edited. The dialog will display different options depending on the type of element (container, relationship, image, etc.) selected.

Generally, the Tasks Menu is used to quickly change the style of an element. For example, a user can change the fill color, line color, font style, and font size of a selected container using the dialog.

After making such style changes, the user may view and manually edit the updated styles by right-clicking the selected container and selecting "Properties" from the context menu. The "Style" property in the Properties Dialog contains the style attributes which may be manually edited. However, this is an advanced, currently undocumented feature.

4.3.3. Container Gallery Dialog

The Container Gallery Dialog allows the user to reuse their existing containers from other workspaces or containers created by other editors.

To view the Container Gallery, the user clicks the Container Gallery Button in the left-side Main Toolbar. The top section of the dialog window displays the user's existing containers from other workspaces, and the bottom section displays other user's containers from workspaces for which the current user has edit permissions. The user may select to display all available containers or select by container type using the dropdown lists.

If the user has "Reference" selected (default), the added container will be a reference to the existing container and a new container will not be created in the CME database. If "New Object" is selected, a new container is created in the CME database and all properties of the existing container are copied to it. The current user will own that new container.

To add a displayed container, the user left-clicks and drags the desired container onto the canvas. The dialog may be closed by clicking the Close button in the upper right of the dialog or by clicking the Container Gallery Button again.

4.3.4. Workspace Sharing and Publication Dialog

A workspace owner (the original creator) may decide to share their workspace with other editors or publish the workspace to the CME Viewer. The Workspace Sharing and Publication Dialog provides these functions for the currently loaded workspace, and is accessed by clicking the Workspace Sharing and Publishing Dialog Button in the left-side Main Toolbar. If the current user is not the owner of the loaded workspace, the dialog will indicate that they are not permitted to adjust these workspace permissions.

The top section of the dialog controls if the workspace will be displayed to all users in the CME Viewer. This option should only be checked for finalized and peer-reviewed workspaces.

The bottom section lists all currently registered CME editors. Checking any box will allow that user to edit the currently loaded workspace. Un-checking a box will remove editor privileges to the workspace for that user.

Click the "Submit" button to save changes to the CME Database or the "Cancel" button to cancel any changes made.

4.3.5. Configure Containers Dialog

The Configure Containers Dialog is the main dialog used to configure a Workflow or Adapter for execution. All Datasets, Adapters, and Geoprocess connected by Relationships as part of the execution process must be configured for a workspace to successfully execute. Access each of these containers' Configuration Dialog by right-clicking the container and selecting "Properties". From the Properties Dialog, click the "Configure Container" button.

To configure a dataset, the user should select "FTP":

In the URL textbox, the user should enter a valid URL pointing to a dataset in the appropriate format. If the dataset represents an output from an Adapter or Geoprocess, the user should select the radio button to the right of the URL textbox and click the "Add" button next to the container that will produce the desired output dataset (see above).

To configure an adapter or a geoprocess, the user should select "Web Service", enter the location of the web service WSDL, and then click the "Query WSDL..." button to populate the dialog with the web service's available methods:

The URL textbox will be updated with the web service URL, and all available web methods from the service will be displayed in the "Select Method" dropdown list. A method description (if available) will display in a tooltip when the user puts the cursor over each method in the list. The user should select the desired web method. The required web method parameters will then be displayed.

The user must enter valid values for each parameter. Each required parameter will have the parameter type displayed in brackets to help the user enter a valid value. The user may pass the results from an input (usually a URL string) to a required parameter by selecting the radio button to the left of the desired parameter and then clicking the "Add" button next to the desired input container. Checking the checkbox to the right of a parameter will make that parameter user editable when the workflow or adapter is executed in the CME Viewer:

Most required web service parameters will be standard types such as string, integer, bool, and etc. However, the CME supports passing custom, complex object types as parameters. The custom parameter types must be known to both the CME and the web service being called. Currently, the CME supports two custom types:

  • Recode Array - Recodes values in a geodataset to new values.
  • WeightedLayer Array - Allows user assigned weights to multiple inputs for analysis.

The Custom Object Dialog presented in the next section is used to create a supported custom object. Once created, a custom object can be passed to a parameter by selecting the radio button to the left of the desired parameter and then clicking the "Add" button next to the desired custom object.

After the user has configured the web service or dataset URL, they should click the "Save" button which saves the configuration to the container.

The user can modify the configuration at anytime and the dialog will be prepopulated with the saved settings when it is opened. Any changes to a specified web service or web method will be reflected in the dialog as the web service's WSDL is always queried to rebuild the dialog. If changes have occurred since the last configuration, the user may have to update the container's configuration. If a specified web service no longer exists, the user will receive an error message indicating the service can not be found.

4.3.6. Custom Object Dialog

The CME supports passing custom, complex object types as parameters to web services. The Custom Object Dialog is used to create a supported custom object. The dialog is accessed by clicking the "Create New Custom Object..." button in the Configure Containers Dialog.

The user must select one of the supported custom types:

  • Recode Array - Recodes values in a geodataset to new values.
  • WeightedLayer Array - Allows user assigned weights to multiple inputs for analysis.

Next the user must follow the dialog for the selected type. Typically a unique name is specified and a button is clicked to build the object. The Recode object dialog will also request the user to specify the number of values to be included in their recode. After the custom object is created, a table will be presented for the user to enter the default values. The format of the table will vary by object type. The following shows the table to populate a WeightedLayer Array object:

The user clicks the "Save" button to save the custom object. The Configure Containers Dialog will now have the new custom object displayed, and the object may be added to a web service parameter as described in the Configure Containers Dialog section:

Additionally the user may delete or edit the custom object at anytime using the buttons to the left of the object. The user should note that a custom object is only available for use by the container it was created for - it is not a global object.


4.4. Creating Workspaces

4.4.1. Recommended Procedures

Creating workspaces in the CME Editor is fairly straightforward:

  • The user uses the Open Workspace Dialog to initialize a workspace.
  • Containers and graphics are added to the workspace using tools in the Main Toolbar and can be dragged around the canvas.
  • Container labels are editable by double-clicking the label.
  • Containers may be grouped or dropped into an Organizing Principle to create a hierarchical structure.
  • Directional relationships may be added between containers using the Relationship Buttons in the Main Toolbar.
  • The Tasks Menu Dialog may be used to quickly change the style of a container or relationship.
  • Any element put on the canvas has user editable properties and edit tools available from the context menu displayed when right-clicking the element.
  • Save the workspace before closing or navigating from the CME Editor if you want to keep it.

The easiest way to get started is to follow these few guidelines, familiarize oneself with the Editor Desktop and Editor Dialogs sections, and then begin creating a new workspace. The user will quickly learn the features of the CME Editor as they explore the tool.

It should be noted that the CME Editor is still in its early, evolving stages. Many obstacles to building the Editor in a web browser without a third party plug-in have been surmounted, but some still exist. Future versions will have more and refined features as well as extended documentation.

4.4.2. Configuring Workflows for Automation

Workflows and adapters may be configured for execution in the CME Viewer. This is typically done to allow users to perform some type of spatial, environmental analysis on an area of interest. Automation is achieved by configuring CME adapters and geoprocesses to call corresponding web services and to use Internet accessible datasets. The execution sequence is determined by the connections (relationships) between these elements.

The CME Workflow Automation feature is in its early stages and standards are still being established. However, an editor may experiment with this feature by following the guidelines presented in the Configure Containers Dialog, Custom Object Dialog, and Advanced Workflow Automation sections.

Important:
Please note that currently, all containers and relationships should be added and labeled, and the workspace saved before configuring a workflow for execution. This allows the CME database to give each container a unique ID and use the ID when passing container properties as parameters to web services. All containers in an execution sequence must be configured in the CME Editor for the CME Viewer to successfully execute a workflow. If a container is added after configuration, the new container must be configured and any connected (by a direct relationship) containers must be reconfigured after first re-saving the workspace. Likewise, if a container is deleted, any remaining containers that were previously connected to the deleted container may require reconfiguration. Future CME versions will refine this process.


4.5. Sharing and Publishing Workspaces

An editor may share their workspace with other CME editors and may publish their workspace to the CME Viewer for all CME users to view. Only the workspace owner (original creator) may share and publish a workspace. The main purpose of sharing a workspace with other editors is to collaboratively develop and review the workspace. The owner and all editors of a workspace will be able to view it in the CME Viewer as well as edit the workspace in the CME Editor. Therefore, a workspace should not be published to the CME Viewer for all users to view until it is complete and peer reviewed.

Please see the Workspace Sharing and Publication Dialog for detailed instructions on adding editors to and publishing workspaces.

Table of Contents

5. Containers and Workspaces

5.1. Containers and Workspaces Overview

The Conceptual Model Explorer is used to create and view workspaces via the Internet. The term workspace is a generic term used in the CME which can represent a Conceptual Model, a Workflow, or an Adapter.

Workspaces are comprised of Containers, Relationships (edges connecting containers) and ancillary text and images. Containers are the most important object type to understand as workspaces themselves are special containers which can be nested within other workspaces. The rest of this section focuses on detailing the different types of Containers and their use in CME workspaces.


5.2. Containers

A container is an object representing a system or workflow component or organizing principle within a CME workspace. The CME establishes a set of standard container types to represent systems and workflows. The standard container types are detailed below. The special container types, which may also be Workspaces, are subsequently detailed in Section 5.3.

5.2.1. Component

A Component is the most basic or generic type of container used in the CME and can represent any kind of system component. If the system component needed does not fit one of the other specific container types, then the Component type should be used. All other containers are derived from this basic container type.

5.2.2. Dataset

A Dataset container represents a data archive. Typically this would be an FTP or web site hosting data in a known format.

5.2.3. Geoprocess

A Geoprocess is a sequence of events that perform one or more spatial operations on data. When developing an automated workflow, a geoprocess typically represents a publicly available web service with the geoprocessing capabilities.

5.2.4. Organizing Principle

An Organizing Principle is a special container type used to group related containers.

5.3. Special Containers (Workspaces)

The containers in this section are special because they have the potential to be workspaces. When an editor creates a new workspace, it will be one of these three types, and it will be embedable into other workspaces.

5.3.1. Conceptual Model

A Conceptual Model depicts a system through the use of system components, their relationships and organizing principles.

5.3.2. Workflow

A Workflow represents a process to achieve a task or series of related tasks.

5.3.3. Adapter

An Adapter is a process that converts data from a given format to a desired format that is useable for subsequent processing. Adapters may modify not only the storage format but spatial extent, resolution and other properties as well. Adapters are usually used in workflows, and they will represent a web service with the desired functionality when automating a workflow.
Table of Contents

6. Advanced Workflow Automation

This chapter is being developed to support CME workflow editors in creating and configuring CME automated workflows. Additionally, it will eventually contain guidance on creating the underlying web services that are represented in workflows as adapters and geoprocesses. Information on hosting and uploading datasets consumed by the web services will be included as well.

Since workflow automation is still in the experimental stage, this chapter will only contain summary information until standards have been adopted for the underlying web services.

6.1. Dataset Sources

The datasets represented in CME workflows and adapters must correspond to real datasets available on the Internet and represented by a URI. These URIs should have a prefix of "ftp://" or "http://" as appropriate. Workflow datasets must be configured in the CME Editor to point to these URIs using the Configuration button on the dataset's context menu. When clicked, the configuration dialog will open. The "FTP" option should be selected and the URI entered. Click the Save button to update the dataset's configuration with the new URI.

There is an experimental option in the CME Viewer that allows users to upload their datasets to the CME server at runtime for workflow execution. This option is currently only available to select users, but look for this file upload feature to be available and expanded in future versions of the CME.


6.2. Building and Publishing Adapters and Geoprocesses

Adapters and geoprocesses in CME workflows can interface with web services that provide the represented functionality. The SAV Restoration Prioritization Tool - Mobile Bay is an example of an executable workflow with adapters that interface with such web services. That workflow was the first effort to prove the concept of creating and executing workflows within the CME. Future efforts will develop standards for web service developers to follow so that they may create web services that can be easily executed from within the CME.


6.3. Workflow Output

Adapters and geoprocesses embedded in workflows typically produce some type of spatial dataset such as a TIFF raster or an ESRI shapefile. These outputs may be final outputs or intermediate datasets to be passed to subsequent tasks. Currently, any terminal dataset (a dataset that does not pass to another container) can be downloaded or viewed in MapMaker after workflow execution using the datset context menus. For more information, please see section 2.7.3 Workflow Results.

Table of Contents

7. CME Known Issues

7.1. Browser Compatibility

The Conceptual Model Explorer is a graphics-intensive web application built to be executable in browsers without requiring a third party plug-in. As such, a modern browser with native, standards-compliant vector graphics support is required to effectively use the CME.

Compatible browsers in order of best performance include:
  • Internet Explorer 5.5 and later
  • Firefox 1.5 and later
  • Netscape 8.1.3 or later using the Internet Explorer Engine mode
  • Camino 1.2 and later (experimental)
  • Opera 9.0 and later (experimental)

The latest versions of Internet Explorer and Firefox are recommended as the majority of testing has been done with these browsers.

Some additional browser notes:

7.1.1. Camino

Support for Camino 1.2+ is currently experimental only. Camino should render graphics properly, but no testing has been performed yet.

7.1.2. Firefox

Significant CME testing has been performed with Firefox 1.5+ and 2.0+ on Windows platforms. Workspaces are best displayed in Firefox using the "Normal" text size in the browser settings. Increasing or decreasing the default browser text size may cause container labels to not display optimally. Firefox is recommended for Macintosh users although testing is still in progress.

7.1.3. Internet Explorer

Extensive CME testing has been performed with Internet Explorer on Windows. Windows version 5.5 or later should work, but IE 7.0 or later is recommended for optimal results.

7.1.4. Opera

Support for Opera 9.0+ is currently experimental only. In Opera, container's context menus must be triggered by shift-left click instead of the usual right-click.

7.1.5. Safari

Safari is unsupported due to its insufficient support of the SVG standard. Mac users should use the latest Firefox browser for best results.

Table of Contents