SBAS/UsersGuide

From CIRPwiki
Jump to: navigation, search


Versions & Requirements

  • SBAS ArcGIS Pro
  • SBAS ArcGIS Desktop
Requires ArcGIS 10.1 - 10.4
Python comtypes package (tested with 0.6.2 - included with this tool)
Author: Thomas Heller, theller@ctypes.org
License: MIT License
The package must be installed into the local python instance.
Install does not require admin rights.
Can be installed by running comtypes-0.6.2\install_comtypes.bat
Snippets.py, slightly modified code snippets file for accessing ArcObjects via Python. (Included)
  • File: snippets.py -- (Previous link http://www.pierssen.com/arcgis/misc.htm no longer works)
Author: Mark Cederholm
License: No specific license.
(Formerly available on http://www.pierssen.com/ and indicated "Free stuff for GIS Developers and Users!")
  • SBAS Desktop

For information on all past and present versions of SBAS, see the SBAS main wiki page.

SBAS ArcGIS Pro

Installation Instructions

Figure 1: SBAS 2020 Toolbox installed and viewed in the Catalog pane
  • Installation for SBAS for ArcGIS Pro is as simple as unzipping the distribution file to a local drive. The zip file includes the toolbar (SBAS_2020.pyt), layer packages (*.lyrx), a settings file (SBAS_settings.txt), and a template geodatabase (SBAS.gdb).
  • To launch the SBAS tools, create a new project in ArcGIS Pro. In order to access the contents of the SBAS tool, be sure to Add a Folder Connection to your project in the Catalog pane.
  • The SBAS ArcGIS Pro Toolbox
  • SBAS for ArcGIS Pro is designed as an ArcToolbox written in Python. Browsing to the file SBAS_2020.pyt in the Catalog pane, will expand to show the individual tools included in the toolbox (Figure 1).
  • The toolbox reads a settings file, SBAS_settings.txt, that MUST side in the the same directory as the pyt file. This file is used but the different SBAS tools to easily find the designated local SBAS database.

Creating a Sediment Budget

Set Local Database

  • Tool 00 - Set Local Database is used to set a known locality for your local SBAS database. This provides the flexibility to have one or more local SBAS databases. Use Tool 00a to let ArcGIS Pro know which database is your active database for this SBAS session.
  • Behind the scenes this tools is simply writing a string value into SBAS_settings.txt (which is housed in the same directory as the SBAS_2020.pyt file). Each time SBAS needs to locate the SBAS database in the data processing, it will put the value listed in this file.
Set Local Database Tool

Create SBAS Alternative

  • Tool 01a - Create SBAS Alternative is used to create a new alternative for a sediment budget. Basic information is collected to assist in building metadata for the alternative. The following pieces are data are required:
a. Budget Type (Micro or Macro)
b. Alternative Name
c. Alternative Description
d. Geographic Area Name or Description
e. Data From (Epoch)
f. Date To (Epoch)
g. Flux Q Units (Cubic Year/Year or Cubic Meters/Year)
h. Cell Volume Units (Cubic Yards or Cubic Meters)
Creating the SBASAlternative
  • Sediment Budget Alternatives Definition: Sediment Budget data is grouped into Alternatives. Alternatives are representations of one set of assumed conditions for a sediment budget. Each alternative has its own set of littoral cells (with delta, placement [input], and removal [output] volumes) and fluxes.
  • Alternatives may be created to reflect different assumptions about sediment-transport paths/rates and engineering activities, or they may reflect different time periods.
  • Alternatives hold all values applied to littoral cells and fluxes.
  • Data is written to the Alternative table in the local geodatabase.
  • There is a checkbox to Load New Alternative Immediately. If checkbox is ticked, 3 new layers will be added to the table of contents. Each layer will named "Fluxes for Alternative Name" or "Cells for Alternative Name"
Upon successful creation of a new alternative, the ArcPro Table of Contents will populate with three layers.
  • As different alternatives are created, each are assigned a unique ID. This value is stored in the scenarioIDPK attribute field. When added to the Table of Contents, the SBAS tool pulls the supplied layer files (Cells.lyrx, AllCells.lyrx, and Flux.lyrx) and applies a definition query to the items that filters only on the assigned unique ID for the active alternative.
  • Creating a New Alternative is the first step in building the geometry container to hold littoral cells and fluxes features. You will use additional tools - 02b, 03a, or 05a/05b to add geometry to the sediment budget alternative.


Load SBAS Alternative

  • optional step
  • Tool 01b - If an alternative was created using tool 01a, then Tool 01b - Load SBAS Alternative is used to simply load the respective feature layers (and definition query filters) into Table of Contents. Multiple alternative can be loaded at the same time.
  • All available alternatives are listed in the drop down menu are that are stored in your local SBAS database.
  • As different alternatives are created, each are assigned a unique ID. This value is stored in the scenarioIDPK attribute field. When added to the Table of Contents, the SBAS tool pulls the supplied layer files (Cells.lyrx, AllCells.lyrx, and Flux.lyrx) and applies a definition query to the items that filters only on the assigned unique ID for the active alternative.


Create SBAS Feature Geometry

LITTORAL CELLS

In SBAS there are 3 ways to create littoral cell geometry; sketching cells by hand, importing cells from GenCade outputs, and importing cells from existing GIS layers.

Sketching New Cells

drawing littoral cells by hand

1. Creating new feature geometry in SBAS, follows much of the same process inherent in GIS, however in SBAS we first have to start an 'SBAS Edit Session' so geometry is related to the correct alternative.
2. To begin launch tool 05a - Start Editing (Add Features)
3. A list of all alternative in the Table of Contents will be listed in the drop-down list. Choose the desired alternative and click Run.
4. In the background, SBAS sets the default values for the scenarioIDFK equal to that of the selected alternative. Remember, this is the value that is used in all of the definition queries.
5. Zoom to your area of interest and click on ArcGIS Pro's Edit ribbon and click on Create.
6. In the Create Features panel, click on the symbol in front of Cells for Alternative Name layer. This will expand to show you the sketch options. Click on the first icon. This is turn on your sketch tool. Click in the map to drop vertices for your littoral cell polygon. Double-click to complete sketch.
7. When done sketching all of the new littoral cell features, launch tool 05b - Stop Editing (Add Features) to commit your changes.
8. To Modify location of vertices, click on the Modify button from ArcGIS Pro's Edit ribbon. Click on Reshape, then Edit Vertices. Click on the vertices to move to new location or right click to remove. Save changes when complete.
  • Importing Cells from GenCade Data: When importing GenCade data, geometry for both Cells and Fluxes is created.
1. Littoral cells and fluxes defined in GenCade can also be imported into SBAS. Tools 02a - Plot GenCade Points and 02b - Convert GenCade Points to Budget Features are used for this data transformation.
2. For the data transformation, for the GenCade budget, the associated *.gen, *.slo, and *.map are required.
3. First run 02a - Plot GenCade Points. This will plot the shoreline point locations documented in the .slo file. The output shapefile is need for the input into 02b.
  • What's happening behind the scenes:
The values are extracted from the .gen file
X0 and Y0 values = the starting coordinate
Azimuth
Dx = distance between points
The collection of distances from the starting location is collected for each date is extracted from the .slo file
A new point shapefile is created.
Note: if "Use only First Date in Point Plot" is selected in the tool, only the first row of the .slo is used to for plot.
4. Next open 02b - Convert GenCade Points to Budget Features. You will need to supply the 3 GenCade files, the newly created GenCade shoreline points, set temporary placeholder feature classes for the Cells and Fluxes, set design distant variables, and choose the Alternative that will be the home for these features.
Distance variables are for the design width of the littoral cells and the length of the flux lines.
  • Distance (ft) Stretch Width of Littoral Cell - when this conversion tool is constructing the cells, the script builds a buffer around the shoreline position plot. The width of the buffer correlates to the width of the littoral cell. The value listed for this parameter is used as the buffer width.
  • Distance (ft) Offset for Flux Arrows - when this conversion tool is constructing the fluxes, the script builds 2 flux arrows. The distance defined here defines how far apart the flux lines will be offset.
Coordinate system of the feature will be re-projected automatically to match that of the selected Alternative.
  • The origin coordinate system is pulled from the GenCade *.map file between the COV_WKT PROJCS and END_COV_WKT tags.
  • Sample Coordinate System Text:
COV_WKT PROJCS["NAD83_Delaware",GEOGCS["GCS_North_American_1983",DATUM["D_NORTH_AMERICAN_1983",SPHEROID["GRS_1980",6378137,298.257222101]],
PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]],PROJECTION["Transverse_Mercator"],PARAMETER["scale_factor",0.999995],
PARAMETER["central_meridian",-75.41666666666667],PARAMETER["latitude_of_origin",38],PARAMETER["false_easting",200000],
PARAMETER["false_northing",0],UNIT["Meter",1]]END_COV_WKT
Cell and flux boundaries are pulled from the SBAS section of the .gen file.
  • Cell boundaries are captured by the sequence of start/end definitions. In this example, there are 4 cells. Values represent point counter.
  • V1 = start location of cell
  • V2 = end location of cell
  • Flux connections are captured by the sequence of start/end definitions. In this example, there are 5 fluxes. Values represent point counter.
  • Q1 = start of flux
  • Q2 = end of flux
  • Importing Cells from Existing GIS Layers

If you have GIS layers already created that represent cells or fluxes, but were created outside of this SBAS toolbox, these features can be imported into SBAS.

  • If your existing features are to be a part of a new Alternative, use tool 01a - Create New Alternative to set up your Alternative Placeholder. Otherwise move to the next step.
  • Using tool 03a - Import GIS Features to SBAS Alternative, browse to an existing feature class or shapefile, then provide field mapping to connect your original field names to the SBAS values.
  • Field mapping for Littoral Cells include: Name, Description, Placement Volume, Removal Volume, and Volume Change
  • Checking for Duplicate Geometries: This tool will check for duplicate geometries, or polygons and polylines footprints that already exist in the local SBAS database. If this is what you would like to do (e.g., you use the same cells for multiple alternatives), check the Duplicate Geometries OK checkbox.

FLUXES

  • Sketching Flux Lines

These are the instruction to create fluxes by hand - using either straight or curved geometry. Creating new feature geometry in SBAS, follows much of the same process inherent in GIS, however in SBAS we first have to start an 'SBAS Edit Session' so geometry is related to the correct alternative.

  • To begin launch tool 05a - Start Editing (Add Features)
A list of all alternative in the Table of Contents will be listed in the drop-down. Choose the desired alternative and click Run.
In the background, SBAS sets the default values for the scenarioIDFK equal to that of the selected alternative. Remember, this is the value used in all of the definition queries.
  • Zoom to your area of interest and click on ArcGIS Pro's Edit ribbon and click on Create.
  • In the Create Features panel, click on the symbol in front of Fluxes for Alternative Name layer. This will expand to show you the sketch options. Click on the first icon. This is turn on your sketch tool. Click in the map to drop vertices for your littoral cell polygon. Double-click to complete sketch.
  • When done sketching all of the new littoral cell features, launch tool 05b - Stop Editing (Add Features) to commit your changes.
  • To Modify location of vertices, click on the Modify button from ArcGIS Pro's Edit ribbon. Click on Reshape, then Edit Vertices. Click on the vertices to move to new location or right click to remove. Save changes when complete.
  • Importing Fluxes from GenCade Data

Cells and Fluxes are imported at the same time with GenCade data import. Refer to this instructions in the Littoral Cells section above.

  • Importing Fluxes from Existing GIS Layers
  • If your existing features are to be a part of a new Alternative, use tool 01a - Create New Alternative to set up your Alternative Placeholder.
  • Using tool 03a - Import GIS Features to SBAS Alternative, browse to an existing feature class or shapefile, then provide field mapping to connect your original field names to the SBAS values.
  • Field mapping for Littoral Cells include: Name, Description, and Q Value
  • Duplicate Geometries: This tool will check for duplicate geometries, or polygons and polylines footprints that already exist in the local SBAS database. If this is what you would like to do (e.g., you use the same cells for multiple alternatives), check the Duplicate Geometries OK checkbox.


SBAS Feature Values

Manually Add SBAS Feature Values

Sediment budget values like cell volumes and fluxes can easily be added to geometry as feature attributes. Use these steps to add or modify values for Cells (Placement, Removal, Delta Volume, Confidence Level) & Flux (Q Values)

  • From the Edit ribbon, click the Attributes button. This will open the Attribute pane.
  • Select a budget feature (cell or flux) on the map with the Selection Tool. The Attribute pane will display the values for the selected feature.
  • Click on the value next to the attribute to edit. Enter in the new value.
Attribute Values available to Edit:
Littoral Cells, user-defined values:
-sdsFeatureName (text, 50 characters). Name or label of the littoral cell.
-sdsFeatureDescription (text, 255 characters). Description of the littoral cell.
-removalVolume (double). Volume of sediment removal (per littoral cell and alternative).
-placementVolume (double). Volume of sediment placement (per littoral cell and alternative).
-deltaVolume (double). Change in volume per littoral cell and alternative.
-valConfidence (text, 255 characters). Determine level of data confidence, assigned by sediment budget author. Low, Medium, High
-projectID (text, 50 characters). Optional project id for internal management purpose.The SBAS application does not reference or write to this field.
Littoral Cells, dynamic fields:
For littoral cells, the residual, transportRemoval, and transportPlacement attribute values will automatically re-calculate each time the 06 - Recompute Residual tool is executed. Values for these fields DO NOT NEED to be manually updated.
-residualVolume: Computed Residual volume per littoral cell and alternative.
Residual is computed by Sum of Transport Placement - Sum of Transport Removal - delta volume + Placement volume - Removal volume.
SBAS tools will compute the residual volume based on values assigned to SBAS features.
SBAS determines the direction of sediment fluxes and automatically identifies each as either a "source" or "sink" for each cell.
-transportRemoval: Sum of transport removal per cell.
SBAS finds all sediment fluxes where the starting point of the line intersects the littoral cell. These fluxes are classified as "sink" volumes.
All sink volumes are summed and values reported to this field.
-transportPlacement: Sum of transport placement per cell.
SBAS finds all sediment fluxes where the end point of the line (arrow head) intersects the littoral cell. These fluxes are classified as "sources" volumes.
All source volumes are summed and values reported to this field.
Fluxes, user-defined values:
-sdsFeatureName (text, 50 characters). Name or label of the flux.
sdsFeatureDescription (text, 255 characters). Description of the flux.
-qValue (double). Volume of sediment moving in or out of cell.
  • To finish:
-Save Attribute Changes
-From the Edit ribbon, click the save button

Transfer Values into SBAS Cell Attributes

If sediment budget geometries and values exists outside of your local SBAS database in a feature class with identical geometry, the attributes can be transferred into your selected Alternative using tool 03b - Transfer Values to SBAS Cell Attributes. To use this tool to update feature values. The geometries in both datasets must match.

  • Verify that the geometries in the SBAS dataset and outside dataset match.
  • Open tool 03b - Transfer Values to SBAS Cell Attributes, select your desired input parameters and click Run.
  • All values from your Input Feature Class will be used to update your littoral cell layer.
  • A record of all transferred values will be listed in the the Results Window.
  • The residual is automatically recalculated.

Create Relationship to SBAS Features

Additional attribute data may be stored outside of the SBAS local database in feature classes . Contents from supplemental databases can be related to SBAS features using the 03c - Create Relationship to SBAS Features tool. This tool uses spatial and non-spatial relationships to determine how to connect the data attribute to the sediment budget. If you created geometry and values outside of this SBAS toolbox, but would like to use these in your budget, this tool will create a spatial relationship and add the correct SBAS foreign keys to easily join the datasets together.

  • About Tool 03c - Create Relationship to SBAS Features tool
-Do you have data that uses the same geometry, does NOT have a SBAS key attribute, but has values you would like intergrated in your budget? This tool should be used if there is not an ID field in the comparison layer and the geometry of the compars, and therefore a simple table join can not easily be performed.
-A FOREIGN KEY is a key used to link two tables together. A FOREIGN KEY is a field (or collection of fields) in one table that refers to the PRIMARY KEY in another table.
-The PRIMARY KEY for each littoral cell is littoralcellIDPK
-The PRIMARY KEY for each flux is sedimentTransportDirectionIDPK
-This tool adds a new FOREIGN KEY field to the comparison dataset: littoralCellIDFK or sedimentTransportDirectionIDFK
-This tool does NOT support Grouped layers. If this tool opens with a "No Parameters" message, or intended data layers are not listed in the drop down menus.
  • Steps
  • Open tool 03c - Create Relationship to SBAS Features tool.
  • Select SBAS Layer : choose the layer in SBAS to which values will be related
  • Choose Comparison Input Layer : select the layer outside of the SBAS database to be related
  • Click run


Load Complementary Data & Published Sediment Budgets

SBAS 2020 is configured to work with available content on ArcGIS Online. Tools 04a - Load Complementary Data and 04b - Load Published Sediment Budgets allow you to quickly connect to online content that have been appropriately tagged in AGOL item descriptions or data published through the SBAS 2020 toolbox (see tool 08 - Share Sediment Budget Online)

Tool 04a - Load Complementary Data To view or load data that may support your sediment budget, use this tool.

  • Open the tool and view data sources listed under Select RSM Data Source, a list of datasets configured in AGOL to assist with finding data
  • Coose the desired dataset and click Run
  • Expand the tool results window. A short summary and link to discover more details is provided.

Tool 04b - Load Published Sediment Budgets

  • Ensure you are logged in to an account with access to the USACE AGOL.
  • Open the tool and open the drop-down under Select Published Sediment Budget
  • Choose the budget you'd like to load and click Run

Modifying Alternatives

Opening an Existing Alternative

Tool 01b Load Alternative Opening an Alternative is the function as Loading Alternatives. Use tool 01b Load Alternatives to complete this function. Loading an alternative will automatically load in the applicable data layers available to the Table of Contents.
  • If an alternative was created using Tool 01a, Tool 01b - Load SBAS Alternative is used to simply load the respective feature layers (and definition query filters) into Table of Contents. Multiple alternative can be loaded at the same time.
  • All available alternatives are listed in the drop down menu are that are stored in your local SBAS database.
  • As different alternatives are created, each are assigned a unique ID. This value is stored in the scenarioIDPK attribute field. When added to the Table of Contents, the SBAS tool pulls the supplied layer files (Cells.lyrx, AllCells.lyrx, and Flux.lyrx) and applies a definition query to the items that filters only on the assigned unique ID for the active alternative.

Copying Alternatives

Tool 01c - Copy Alternative is used to copy and existing Alternative into a new Alternative. Use this tool if you would like to reuse the feature geometry for a selected Alternative. All features will be copied and labeled with the new Alternative ID (scenarioIDFK) value.

Changing Alternative Property Values

If you need to change any of the Alternative details like Name, Description, Start and End Date you can directly modify the Alternative table.

  • In the Catalog pane, browse and expand the SBAS.gdb.
  • Right-click on the Alternative table and select Add to Current Map.
  • In the Table of Contents pane, right-click on the Alternative table and select Open.
  • In the Attribute window, click the row/column value to modify.
  • Enter any changes. When complete, from the Edit ribbon click the Save button. Note: If the Save button is disabled, hit the enter key (with the attribute table) to complete the change
  • If you have renamed your Alternative, to see these changes reflected in toolbox right-click on the toolbox name and click Refresh.

Deleting Alternatives

Tool 07 - Delete Alternative If you need to delete an alternative, use this tool to remove the alternative from your personal database. This tool does NOT automatically remove any published datasets. If you have published a sediment budget to ArcGIS Online, and you would like to remove it, log-in to https://usace.maps.arcgis.com/home/index.html and delete the feature service from My Contents.

Local and Enterprise Data Storage

Local Database Location

SBAS uses the template database (SBAS.gdb) to store all sediment budge geometries and alternative values. This local geodatabase contains 5 objects. The database schema follows the schema identified by SDSFIE.

Alternative is a table that holds basic metadata information related to individual sediment budgets.
  • scenarioIDPK (text, 50 characters). Primary Key. This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario).
  • sdsID (guid). This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario). Value can be used to link to items in other enterprise GIS.
  • scenarioAuthor (text, 100 characters). Author of the alternative. Name of author is pre-determined by the user login to ArcGIS Pro. Name is listed as the ArcGIS Online username.
  • sdsFeatureName (text, 50 characters). Name or label of alternative.
  • sdsFeatureDescription (text, 255 characters). Description of alternative.
  • geoAreaDescription (text, 255 characters). Description of location of sediment budget
  • projectID (text, 50 characters). Optional project id for internal management purposes. The SBAS application does not reference or write to this field.
  • dateScenarioCreated (date). Data alternative created in teh SBAS database.
  • budgetType (text, 50 characters). Type of sediment budget (Micro - local or Macro - regional).
  • dateIntervalStart (date). Start date of alternative epoch.
  • dateIntervalEnd (date). End date of alternative epoch.
  • cellUnits (text, 255 characters). Units of volume for litttoral cells (Cubic Yards or Cubic Meters)
  • qUnits (text, 255 characters). Units of volume for sediment transport rate (Cupic Yards/Year or Cubic Meters/Year)
  • uncertaintyMethods (text, 50 characters). List of uncertainty methods used in Sediment Budget. The SBAS application does not reference or write to this field.
  • medialDPK (text, 50 characters). ID to hold links to related media documentation. The SBAS application does not reference or write to this field.
  • sdsMetadataID (text, 50 characters). ID to hold unique metadata ID.
Sediment Management Cells (polygon) Boundaries of each littoral cell.
  • littoralCellIDPK (text, 50 characters). Primary Key. This value is auto-generated by SBAS and provides a unique identifier for each littoral cell.
  • sdsFeatureName (text, 50 characters). Name or label of the littoral cell.
  • sdsFeatureDescription (text, 255 characters). Description of the littoral cell.
  • scenarioIDFK (text, 50 characters). Foreign Key. Value to the related alternative (or scenario).
  • removalVolume (double). Volume of sediment removal (per littoral cell and alternative).
  • placementVolume (double). Volume of sediment placement (per littoral cell and alternative).
  • deltaVolume (double). Change in volume per littoral cell and alternative.
  • valConfidence (text, 255 characters). Determine level of data confidence, assigned by sediment budget author. Low, Medium, High
  • residualVolume (double). Computed Residual volume per littoral cell and alternative.
  • Residual is computed by Sum of Transport Placement - Sum of Transport Removal - delta volume + Placement volume - Removal volume.
  • SBAS tools will compute the residual volume based on values assigned to SBAS features.
  • SBAS determines the direction of sediment fluxes and automatically identifies each as either a "source" or "sink" for each cell.
  • transportRemoval (double). Sum of transport removal per cell.
  • SBAS finds all sediment fluxes where the starting point of the line intersects the littoral cell. These fluxes are classified as "sink" volumes.
  • All sink volumes are summed and values reported to this field.
  • transportPlacement (double).Sum of transport placement per cell.
  • SBAS finds all sediment fluxes where the end point of the line (arrow head) intersects the littoral cell. These fluxes are classified as "sources" volumes.
  • All source volumes are summed and values reported to this field.
  • volumeUom (text, 50 characters). Units of measure for Volume Change, Removal, Placement and Residual volumes. Cubic Yards or Cubic Meters.
  • transportUom (text, 50 characters). Units of measure for Sediment Transport Rates. Cubic Yards/Year or Cubic Meters/Year.
  • alternativeLable (text, 255 characters). Name of Alternative
  • mediaIDPK (text, 50 characters). ID to hold links to related media documentation.The SBAS application does not reference or write to this field.
  • sdsMetadataID (text, 50 characters). ID to hold unique metadata ID.
  • projectID (text, 50 characters). Optional project id for internal management purpose.The SBAS application does not reference or write to this field.
  • sdsID (guid). This value is auto-generated by SBAS and provides a unique identifier for each alternative (or scenario). Value can be used to link to items in other enterprise GIS.
SedimentTransportDirection (polyline) Linear representation of sediment transport.
  • sedimentTransportDirectionIDPK (text, 50 characters). Primary Key. This value is auto-generated by SBAS and provides a unique identifier for each flux.
  • sdsFeatureName (text, 50 characters). Name or label of the flux.
  • sdsFeatureDescription (text, 255 characters). Description of the flux.
  • scenarioIDFK (text, 50 characters). Foreign Key. Value to the related alternative (or scenario).
  • qValue (double). Volume of sediment moving in or out of cell.
  • transportUom (text, 50 characters). Units of measure for Sediment Transport Rates. Cubic Yards/Year or Cubic Meters/Year.
  • alternativeLable (text, 255 characters). Name of Alternative

Enterprise Database Location

Arc Online Accessibility

All users of SBAS can control the accessibility of their Sediment Budgets published on the Enterprise. You must be signed into to ArcGIS Pro with your user id. To determine if you are logged into ArcGIS Pro:

  • Look in the upper right corner of the ArcGIS Pro window. If you are signed in you will see your account name, otherwise it will list "Not signed in".
  • Click the drop-down menu, and follow the Sign-In link to log into your account (Figure 2).
  • When running SBAS, if you drop a connection and are signed out you will receive an error (Figure 3). If this occurs, just sign in again and relaunch the tool.
Figure 4: SBAS 2020 Step 08

Publishing your completed datasets

  • use tool 08 - Share Sediment Budget Online. This tool will create a copy of your selected Sediment Budget Alternative and create a feature web service hosted on USACE's ArcGIS Online (AGOL) (Figure 4). Feature web services are a way geographic information is created, modified and exchanged on the Internet.
  • Prepare your ArcGIS Pro project. Remove any extraneous datasets from the Table of Contents. Anything list here will be included in your webservice. Don't forget to to Save your project.
Figure 5: Table of Contents view including only one visualization
  • The Table of Contents may have multiple display options for a single dataset, e.g. cell outlines and color-coded cells by residual. Only keep one visualization per dataset for your service (Figure 5). Remove all others from your table of content.
  • To obtain an AGO account, please contact one of the POCs listed at the bottom of this page.
  • In ArcGIS Pro you must be logged in with your USACE AGO credential to correctly publish SBAS data.
  • If your tool shows "No Parameters" message, this means you have been logged out of ArcGIS Online within ArcGIS Pro (Figure 6). To fix, in the upper right corner of ArcGIS Pro, click Sign-In.
  • This tool will OVERWRITE any web services you own of the same name.
  • Set your connection and content parameters.
  • Local Staging Location is the local drive where ArcGIS ArcPro will copy temporary files needed to create your service.
  • Your SBAS Service will be created for all layers within your current saved version of your ArcGIS Pro project.
  • Your selected Alternative will be used to build a summary and description for your Feature Service.
  • If you have more than 1 alternative loaded in your Table of Contents, all will be combined into a single feature service but as separate layers.
a. The Feature Service description will be pulled from the alternative selected with tool 08 - Share Sediment Budget Online.
b. All layers will be listed in your service definition.
c. Supplemental Budget Data
  • Do not publish any datasets that contain PII (Personally identifiable information), For Official Use Only (FOUO), other other sensitive information.
  • Do not publish datasets that are already available online. E.g., NOAA Shorelines are available as a web service hosted by NOAA and should not be included as part of your service package.
  • SBAS Budget service should include littoral cells, sediment fluxes, and optional supplemental data such as properties of bluffs.
  • Feature Web Services are created for each alternative and are documented with the details you provide when the alternative is created.
  • See Create SBAS Alternative section
  • Web Services are initially only shared to the USACE organization. To share your sediment budgets to Everyone, edit the AGO item in My Contents on https://usace.maps.arcgis.com/
  • Log-in to https://usace.maps.arcgis.com/
  • Browse to My Contents and locate the budget to share. Click the checkbox in front of the budget item (Figure 7).
Figure 7: Sharing a budget on AGOL
  • Click the Share link
  • To share to Everyone (public) click this sharing level (Figure 8). Group level sharing can also be modified. All sediment budgets created in SBAS should be shared.

SBAS ArcGIS Desktop

Installation

  1. Download SBASArc10 Toolbox Here
  2. Extract ZIP distribution
  3. Move SBAS directory to one's desired location
  4. Run SBAS\comtypes-0.6.2\install_comtypes.bat
  5. Run SBAS\install_dependencies.bat
  6. Within the Catalog, add a Folder Connection to the SBAS directory
  7. Within the Folder Connection to the SBAS toolbox, expand the toolbox and execute the "00 - Set Up SBAS Environment" tool.

Usage

  • If you would like to specify a workspace path and/or load a basemap, run the "00 - Set Up Environment" tool before running any other tools on your map document.
  • For the remainder of the workflow, tools should be executed essentially in order. For example, one must execute "01a - Create SBAS Alternative" before executing "01b - Load SBAS Alternative", which must be run before executing "02a - Convert Graphics to New Features".

Points of Contact

Main POC: Eve Eisemann
Email: Eve.Eisemann@usace.army.mil

Secondary POC: Katie Brutsche
Email: Katherine.E.Brutsche@usace.army.mil

Technical Issues: Rose Dopsovic
Email: Rose.Dopsovic@usace.army.mil



Back to Main SBAS Page