scag_logo


SCAG Scenario Planning Model (SPM) - Data Management (DM) System User Guide

Version: Dec 06, 2017

This user guide provides instruction for the user of the SPM Data Management System. This data review and editing framework provides users across the SCAG region with many critical data management and data review options. The SPM Data Management System is accessible via a single web-based application for all jurisdictions in the six-county SCAG region. This documentation covers basic functionality for data review and editing.

I. Introduction

SCAG Scenario Planning Model (SPM) is a web-based data management, land use planning and modeling platform developed to facilitate more informed and collaborative planning by local jurisdictions and other stakeholders. Built on UrbanFootprint 1.5, an open source modeling platform developed by Calthorpe Analytics in partnership with SCAG and other California public agencies, SPM enables the creation and organization of local and regional data, plan and policies, facilitates scenario creating and editing, and estimates a wide range of potential benefits resulting from alternative transportation and land use strategies.

SPM is currently deployed as two separate web services: Data Management (DM) system and Scenario Development and Analysis (SD) system. SPM-DM provides a common data framework within which local planning efforts can be easily integrated and synced with regional plans. Using a variety of data management and data review options, the user (local jurisdictions) can explore data, export attributes and edit configured layers. SPM-SD includes a suite of tools and analytic engines that facilitate scenario creation and editing with advanced analytic capabilities that allow for meaningful comparisons across different land uses and transportation options.

This user guide provides instruction for the user of SPM-DM, covering the basic functionality for data review and editing.

System Requirements

The SPM is accessed via a web page. For access to the site, there are minimum requirements

  • A relatively recent (purchased in last 5 years) desktop or laptop computer running the Windows, Mac OSX, or Linux operating systems. The current system has not been optimized for tablet or touchscreen operating systems or interfaces.

  • Current version of Google Chrome web browser. Chrome is available via free download at https://www.google.com/intl/en/chrome/browser/

  • Mouse, track-ball, or trackpad-based input device (essentially all desktop or laptop computers have this capability).

Note: If you experience difficulties in performing feature editing (e.g., feature selection, querying, etc.) while being able to view maps on the SPM, first check your internet firewall configuration with your IT support. The URL of the SPM data management site should be added to the trust list of firewall configuration to avoid block access by web filters set up locally.

II. Data Management Framework - Site Map

site_map

Figure 1: SPM Data Management Framework User Interface

III. User Interface Overview

1. Top Section Menu Pane

The top section menu drop down allows the user to toggle between Project Info, Data Explorer, and Approval/Merge options. After clicking one of the options, the map selection will resize to display the selected option.

top_section_menu_pane

Figure 2: Top Section Menu drop down

Project Info: The user can view project information and charts of key demographic statistics.

Data Explorer: The user can view and explore data in a table view and define attribute queries and join tables to explore and select data.

Approval/Merge: A user with manager or director-level permissions can approve edits and merge those edits into master versions of the editable layers.

1-1 Project Info project_info_title

The project info section displays charts on Population, Households, and Employment on the current project. It also includes a link to this User Guide.

project_info

Figure 3: Project Info window Tip: Hover the cursor over the charts to see more detailed information on the data.

1-2 Data Explorer data_explorer_title

The data explorer query functionality and the map selector tools in the SPM are linked by default. When a user selects features on the map with the map selector tools, the attributes will populate in the query table window. If the user inputs an attribute query with no map selection, the map will show the features selected from the attribute query. The user also has the option to use attribute selections and map selections in combination.

data_explorer Figure 4: Data Explorer window

Querying Attributes: The user has many options to form their query and to show helpful information in the user interface:

query_window

Figure 5: Query options

  • Select Attributes shortcut: Allows user to select from a drop down of attributes
  • Operators shortcut: Allows user to select operators from a drop-down list
  • AND/OR shortcut: Allows user a shortcut to the common AND/OR/parenthesis operators
  • Limit Results to Selected Area: If the user has selected features with a map selector tool and input an attribute query, they have the option to limit the query result to the map selection or apply them to the whole dataset.
  • Clear button: Clears the selection
  • Query button: Executes the query

SPM attribute querying functionality utilizes SQL syntax to tell the database what features the user would like to select. The user can select attribute names from a drop-down list by clicking on the arrow button next to the ‘Where’ clause or type them in.

The following comparison/equality operators are supported:

  • Greater than : >
  • Less than : <
  • Greater than or equal to : >=
  • Less than or equal to : <=
  • Equals : =
  • Not equal: !=

For querying strings, the following syntax can be used (must be capitals):

  • BEGINS_WITH : String begins with a certain letter or group of letters
  • ENDS_WITH : String ends with a certain letter or group of letters
  • CONTAINS: String contains a certain letter or group of letters

Multiple attribute queries are supported using the following syntax (must be capitals):

  • AND : SQL ‘and’ syntax, attributes must meet both query requirements
  • OR : SQL ‘or’ syntax, attributes must meet either query requirements

Tip: User can access drop down menu of attributes, operators, and AND/OR/parenthesis syntax for a quicker query.

Query Examples:

Example 1: Return all rows with land use code 1200 with a dwelling unit count greater than 2: land_use16 = 1200 AND du>=2

Example 2: Return all parcels with an apn that begins with 580 or an apn that begins with 104: apn BEGINS_WITH "580" OR apn BEGINS_WITH "104"

Joining Tables: SPM allows the user to join and query spatial tables of different geography types and geographic scales. The user utilizes these pre-defined join tables by selecting the desired table from the drop-down button in the query window. Having selected a table to join, the user will have access to all fields in that join table. Any query making use of join fields will utilize the pre-defined spatial or attribute relationship.

join_table

Figure 6: Join tables

Important: If the user is querying a field from the join table that has the same name as a field in the source table, the system defaults to the source table field. To query the join table field, the user must write the name_of_join_table.field_name or select it from a drop-down list by clicking the arrow next to the ‘Where’ clause in the Query window.

Exporting Query Results: User can export the current query result to a csv file by clicking on the ‘Export as CSV’ button in the upper right corner of the Data Explorer window.

1-3 Approve and Merge approve_merge_title

The Approve and Merge interface is accessible to users with manager or director-level permissions. The approval interface allows managers to review and approve/reject edits made by any user. Through easy to use drop-down queries, edited features can be reviewed, approved or rejected, and merged into the master version.

approve_merge

Figure 7: Approve and Merge window

Approving/Rejecting Edits: The approval interface acts on the active layer. When a manager is ready to approve or reject edits, he or she can load all pending edited rows (needing approval) by selecting the appropriate query form the drop-down list. If the user would like to review previously approved or rejected features, the system provides those options as well.

Once the data has loaded, the user can highlight a given row (or group of rows by holding down CTRL) and approve or reject the highlighted rows by pushing the corresponding “Approve” and “Reject” buttons. To simply approve or reject all edits, the user can toggle ‘Select All’ to highlight all rows. Once rows have been approved or rejected, the user must save their edits. Any approval or rejections that are not saved will be ignored.

approve_merge_interface

Figure 8: Approval interface

Merging: Once features have been reviewed and edits approved, the manager can merge all approved features into the Master version of the layer. Within the approval interface, the user can toggle the Merge screen. This will provide the user with the option to merge approved features. After clicking on the Merge button, a backend process will handle filtering and merging data tables.

approve_merge_merging

Figure 9: Merging interface

2. Layer Management Window

The Layer Management window on the left side of the SPM user interface displays layers that have been preloaded into the SPM, and that can be turned on for display and activated for selection, editing, and queries. See Appendix A for descriptions of the data available via the SPM.

The Layer Management window consists of 4 sections: - a. Layer List - b. Layer Menu - c. Reordering Layers Menu - d. Upload

layer_manager_window

Figure 10: Layer Management window

2-1 Layers List

The Layers List is broken up into 3 sections: * Basemaps * Editable Layers * Reference

Any layer under the Editable Layers section contain fields that can be edited by the user. See Appendix B for the list of fields definitions with editable fields highlighted. For definitions of each of the layers please reference Appendix A.

The user can select an active layer by clicking on the layer name and the active layer will be highlighted in blue. From the Figure 10 above, SCAG Existing Land Use Parcels is visible on the map (checkbox) and is the active layer (blue highlight).

Important: Any map selection, attribute query, export layer, export csv initiated by the user will occur on the active layer regardless of it is visible or not.

Each layer’s legend is viewable by clicking on the arrow in front of the layer and then expanding the arrow that appears below the layer.

layer_management_legend

Figure 11: Layer Legend

2-2 Layer Menu

The Layers Menu is accessed in the upper right section of the Layer Management Window via the button Layers Button. The Layers Menu has 3 options: * Export Active Layer to gdb * Layer Symbology * Manage Layers

layer_menu

Figure 12: Layer Menu

Exporting Active Layer to gdb: The user can initiate exporting by clicking ‘OK’ on a window that opens up once the user clicks on the ‘Export Active Layer – to gdb’ in the drop down. By default, the exported layer is saved to the user’s default Download folder.

Layer Symbology: The Layer symbology allows the user to modify the way a layer is displayed on the map. A user can add new styles, edit previously saved styles, and view the default style for the active layer’s legend. The user can open the Layer Symbology by clicking on the ‘Layer Symbology’ in the drop down. The default style is set by SCAG and is not editable.

layer_symbology Figure 13: Layer Symbology window

New styles can be added by clicking on the add layer style button plus in the Layer Symbology window. By default, all new layers are added with a single symbol. The user can select style type (single, categorical, or quantitative legends) and then attribute, if categorical or quantitative is selected, on which the selected style type is based.

The user can add all unique values of the selected table attribute by clicking on ‘Add All Values’ (for categorical type) or ‘Add All Ranges’ (for quantitative type) button, activated when attribute is selected.

layer_symbology1

The Layer Symbology window also provides options to edit basic symbol properties such as color, line width and opacity level. To save changes the user must click the save button when finished editing.

layer_symbology2

Manage Layers: The Manage Layers menu allows users to modify the layers visible in the Layers list. The user can check or uncheck layers here to update the Layer List.

manage_layers

Figure 14: Manage Layers window

2-3 Reordering Layers Menu

The user can re-order layers on the map by clicking on the arrow button Reorder Arrow on the right side of the Layers Tool Bar. This button will open a window where the user can re-order the layers by clicking on the layer name and dragging it into the order the user prefers within the visible list. This order corresponds to the layer order on the map.

reordering_layers

Figure 15: Reordering Layers window

2-4 Upload

Upload geodatabase (.gdb) and shapefiles (.shp) directly into the SPM using the Upload button at the bottom left corner of the page (also see ArcIntegration for importing layers from ArcMap directly to SPM).

Once the upload button is clicked, select the zipped gdb or shapefile in the file selector. The layer will start uploading immediately and is automatically added to the Layer Management Window once completed. Uploaded layers are added as reference layers to the current project and are visible to all users of that project.

upload

Figure 16: Upload button

Note: The upload file size limit is 100 MB

3. Map Tool Bar

Clicking on an icon on the map tool bar allows the user to zoom and navigate around the map as well as select and identify map features. The user can hover their pointer to get the ‘tool tip’ to identify what button corresponds with each selector.

Toolbar

Figure 17: Map Tool bar

Zoom to Extent Zoom to Project Extent: This tool allows the user to zoom the current map to the project map extent. The project in the SPM refers to a local jurisdiction.

Zoom to Selection Zoom to Selection Extent: This tool allows the user to zoom the current map to the extent of selected features of the Active Layer.

Clear Selection Clear Selection: This tool clears the selected features of the Active Layer.

Navigate Navigate: This tool allows the user to navigate around the map by clicking and dragging on the map. Tip: The user can hold ‘Shift’ and drag to create zoom extent.

IdentifyIdentify: This tool is activated when a feature is selected. The Identify tool opens a moveable summary window where the user can view the attributes of the selected feature.

Point Selector Point Selector: The point selector selects the feature that intersects with a point where the user clicks on the map.

Rectangle Selector Rectangle Selector: The rectangle selector selects the feature that intersects with a rectangle formed by the user clicking and dragging across the map.

Polygon Selector Polygon Selector: The polygon selector selects the feature that intersects with a user defined polygon shape formed by the user defining each node of the polygon by clicking on the map. Double clicking will stop forming the polygon selection.

Download Selector Export Map: The Export Map button takes a snapshot of the current map and downloads the map as a jpg image to the user’s default downloads file.

Tip: Multi-select can be activated by holding down the CTRL/CMD key (Windows/Mac) for the Point Point Selector, Rectangle Rectangle Selector, and Polygon Polygon Selector.

4. Layer Editor

The Layer Editor allows the user to edit or comment upon select layer attributes. The editable layers are listed in the Layer Management Window under Editable Layers. If a layer is editable, when that layer is active in the layer manager, the user can open the Layer Editor by clicking on the ‘Editor’ button on the right side of the screen to view and edit specific attributes.

layer_editor

Figure 18: Layer Editor window

The editor operates on the currently selected features of the active layer. If there is more than one feature selected, any changes made in the editor window will populate all rows with those values unless the layer is configured to only allow editing of one row at a time.

In case where a layer is configured to only allow editing of one row at a time (e.g., Tier 2 TAZ), following message will be displayed indicating that only one record at a time can be edited.

too_many_records_error

The layer attribute drop down allows the user to edit attributes of currently selected features of the active layer and add comments in the notes box associated to that specific edit. To save changes to edited attributes the user must push the apply button when finished editing. If the user changes the selected features without saving changes, those changes will not be saved.

The undo button is activated once changes are saved.

undo_example

4-1 Undo / Redo undo_redo

The undo and redo functionality allows users to undo or redo their most recent changes on the active layer.

  • Undo: Clicking the undo button will undo the most recently saved change on the active layer regardless of the current selection.
  • Redo: Clicking the redo button will redo the most recent change that was made using the undo button regardless of the current selection.

Tip: If the user hovers of the undo or redo buttons, they will see a message with the above definitions.

IV. ArcGIS Integration

This customized python toolbox(.pyt) allows ArcMap users to upload their layers directly to SPM with built in ArcMap functionality.

System Requirements/Supported Version - ArcMap 10.3 - ArcMap 10.4

Download ArcToolbox Version 1.0.0

Steps to upload a layer using ArcGIS Integration tool 1. Open ArcMap 2. Navigate to the ArcToolbox section 3. Right click on ArcToolbox and select 'Add Toolbox...'

arctoolbox_1

Figure 19: ArcToolbox

  1. Navigate to the ArcGIS Integration tool (ArcToolbox version 1.0.0) and click open. You should now see it at the bottom of your ArcToolbox

arc_toolbox_2

  1. Expand the Upload Toolbox to see Upload tool. To open the dialogue box, double-click the upload tool or right click the tool and click open.

    arc_toolbox_3

    Tip: If you would like the toolbox to appear every time you launch ArcMap, right click on the ArcToolbox again and select Save Settings > To Default

arc_toolbox_4

  1. Enter all the fields in the dialogue box. The upload tool 5 inputs described below:

  2. Email: The email address used to login to SPM

  3. Password: The password used to login to SPM
  4. Server URL: The URL of SPM (Example: https://spmdm.scag.ca.gov)
  5. Project Name: The name of the project or jurisdiction in SPM – case sensitive (Example: Anaheim)
  6. Input Feature: Drag a layer from ArcMap or browse to the layer using the folder

  7. After the dialog succeeds, open SPM to see your layer.

Troubleshooting: If your layer is not in SPM, please try the following steps:

  1. Navigate to the ‘Results’ section in ArcMap and view the messages.

arctoolbox_troubleshooting_1

  1. Look for an ‘ExecuteError’ in the messages. In this example, the Server URL is incorrect.

arctoolbox_troubleshooting_2

  1. Address the issue listed in the messages and try upload again.

Hint: To see the error right away, try showing the ‘Details’ of your toolbox. This dialog pops up after your click OK on the Upload tool.

arctoolbox_troubleshooting_3

V. User Manager

The User Manager allows managers and admin users to manage users in their project. Non-manager or non-admin users can update their user profiles. The User Manager can be accessed from the user profile dropdown that appears by clicking on your name. Click on the ‘Manage Users’ to go to the User Management home page.

user_manager_1

Figure 20: User Manager

In this section you will find:

  • How to update your profile
  • How to create a new user
  • How to update a user’s profile

1. How to update your profile

  1. In the upper right corner, click on your email address to expand the drop-down list. From the drop-down, select ‘Update Profile.’

user_manager_2

  1. Make the necessary changes to your user profile page and click ‘Save’ to apply the changes, or ‘Cancel’ to cancel.

user_manager_3

Note: When a change is made to the Project’ drop-down field, the available roles in the ‘Role’ drop-down list will automatically update. Not every role is available to every project. Also not that ‘New Password’ and ‘Confirm New Password’ fields are optional – they should only be completed if you want to reset your password.

2. How to create a new user

  1. Administrative and manager users can create new users. To add a new user, click on your email address in the upper right corner to expand the drop-down list and select ‘Add User’.

  2. Complete the following fields:

user_manager_4

  • Project - This property associates the user to a municipality (or administrative group)
  • Role - The role the user fulfills, e.g. ‘Manager’ or ‘User’
  • Name - This field is optional
  • Email - The email address of the user to be create. It must not already be used for another SPM account
  • Active - If this bow is unchecked, the user will not be able to log in to SPM. It defaults to checked. Uncheck this if a user should not have access to SPM
  • Password and Confirm Password – User who are given a temporary password should log in to this User Manager site and update their password.
  • Click ‘Save’

3. How to update a user’s profile

  1. Administrative and manager users can update the profiles of users they manage. To modify a user profile, find the user in the list view and click on that user’s row.

user_manager_5

  1. The user’s profile page will show similar fields as those described in ‘How to create a user’, with one difference:

  2. New Password and Confirm New Password – These fields are optional and should be set if the user needs to have their password reset.