SaMP Desktop User Manual.pdf

Land Management Information System

Survey and Monitoring Protocol Database SaMP Desktop User Manual Version 2.6 April 2017

Prepared for The Florida Fish and Wildlife Conservation Commission by AECOM 1625 Summit Lake Drive, Suite 200 Tallahassee, Florida 32317

SaMP Desktop Documentation i

Table of Contents

1 Introduction ..........................................................................................................1-1

1.1 Terms Used in This Document .......................................................................1-1

2 Installation ............................................................................................................2-1

2.1 Prerequisites ...................................................................................................2-1

2.1.1 Microsoft .Net Framework ......................................................................2-1

2.1.1.1 .NET Framework 4 ..........................................................................2-1

2.1.1.2 .Microsoft SQL Server Client ...........................................................2-1

3 Using the SaMP Desktop ......................................................................................3-1

3.1 Login and the SaMP Launch Window ............................................................3-1

3.2 Saving Changes to the Central SaMP Database ..............................................3-2

3.3 Data Recovery ................................................................................................3-2

3.4 Configuring Protocols ....................................................................................3-3

3.4.1 Copying Protocols ...................................................................................3-4

3.4.2 Reorganizing Protocols ...........................................................................3-4

3.4.3 Protocol Errors ........................................................................................3-4

3.4.4 Opening a Protocol for Viewing or Editing..............................................3-4

3.4.5 Editing a Protocol....................................................................................3-5

3.4.5.1 Protocol Status .................................................................................3-6

3.4.5.2 Generating Protocol Documentation .................................................3-7

3.4.5.3 Database Diagram ............................................................................3-7

3.4.5.4 Editing Sample Types ......................................................................3-8

3.4.5.5 Editing Attributes ........................................................................... 3-11

3.4.5.6 Creating and Editing Lookup Tables .............................................. 3-15

3.4.5.7 Relating Sample Types to Lookup Tables ...................................... 3-17

3.4.5.8 Editing Relationships ..................................................................... 3-19

3.4.5.9 Editing Validation Rules ................................................................ 3-22

3.4.5.10 Summarizations ............................................................................. 3-26

3.4.5.11 Conditional Expressions ................................................................. 3-35

3.5 Global Configuration .................................................................................... 3-38

3.5.1 Editing Domains ................................................................................... 3-38

3.5.2 Attribute Classes ................................................................................... 3-40

3.5.3 Common Attributes ............................................................................... 3-41

4 Data Storage and Organization .............................................................................4-1

4.1 Creating and Editing Data Groups ..................................................................4-1

4.1.1 Create a New Data Group ........................................................................4-1

4.1.1.1 Add a new Data Group .....................................................................4-2

4.1.1.2 Create a New Data Group from a Sample Event Screen....................4-7

4.1.2 Edit a Data Group ................................................................................. 4-10

4.2 Editing Sample Events and Query Groups .................................................... 4-12

4.2.1 Listing Sample Events ........................................................................... 4-12

4.2.1.1 Listing Sample Events by Protocol/Data Group .............................. 4-13

4.2.1.2 Listing Sample Events by Region/Area .......................................... 4-14

4.2.1.3 Listing Sample Events by Query Group ......................................... 4-15

SaMP Desktop Documentation ii

4.2.2 Editing Query Groups ........................................................................... 4-15

4.2.3 Creating or Editing a Sample Event ....................................................... 4-16

4.3 Data Entry and Upload ................................................................................. 4-18

4.3.1 Creating Geodatabase ............................................................................ 4-18

4.3.2 Uploading Data ..................................................................................... 4-22

4.3.2.1 Data Validation .............................................................................. 4-24

4.3.2.2 Replacing Existing Data ................................................................. 4-26

4.3.3 Special Considerations for Replacing Data ............................................ 4-26

4.4 Data Export .................................................................................................. 4-27

5 Glossary ...............................................................................................................5-1

List of Figures

Figure 3-1: SaMP Login Window .................................................................................3-1 Figure 3-2: SaMP Launch Window ..............................................................................3-1 Figure 3-3: Recover Data Prompt .................................................................................3-2 Figure 3-4: Protocol Selector Window ..........................................................................3-3 Figure 3-5: Main Protocol Editing Window ..................................................................3-5 Figure 3-6: Protocol Configuration Errors ....................................................................3-6 Figure 3-7: Create Data Dictionary ...............................................................................3-7 Figure 3-8: Sample Type Summary Box .......................................................................3-7 Figure 3-9: Protocol Window in Edit Mode ..................................................................3-8 Figure 3-10: Editing Sample Type Information .............................................................3-9 Figure 3-11: Sample Type Editor in Edit Mode .......................................................... 3-11 Figure 3-12: Editing Attributes ................................................................................... 3-12 Figure 3-13: Editing Attribute Screen in Edit Mode .................................................... 3-13 Figure 3-14: Adding a Lookup Table .......................................................................... 3-16 Figure 3-15: Editing Lookup Tables ........................................................................... 3-17 Figure 3-16: Adding a Relationship ............................................................................ 3-17 Figure 3-17: Linking Fields to a Lookup Table ........................................................... 3-18 Figure 3-18: Linking Fields to a Lookup Table ........................................................... 3-18 Figure 3-19: Relationship Details Window ................................................................. 3-19 Figure 3-20: Define Parent/Child Relationship ........................................................... 3-20 Figure 3-21: Select Related Sample Type ................................................................... 3-20 Figure 3-22: Define Relationship Keys ...................................................................... 3-21 Figure 3-23: Specify Cardinality ................................................................................. 3-21 Figure 3-24: Adding New Validation Rule ................................................................. 3-23 Figure 3-25: Editing the Validation Rule .................................................................... 3-23 Figure 3-26: Save the Validation Rule ........................................................................ 3-25 Figure 3-27: Validation Rule Editing .......................................................................... 3-25 Figure 3-28: Editing Protocol Summarizations ........................................................... 3-27 Figure 3-29: Add New Protocol Summarization ......................................................... 3-27 Figure 3-30: Editing a new Protocol Summarization ................................................... 3-28 Figure 3-31: Protocol Summarization by Date ............................................................ 3-30 Figure 3-32: Choose a Sample Type ........................................................................... 3-30

SaMP Desktop Documentation iii

Figure 3-33: Build Custom Where Clause................................................................... 3-31 Figure 3-34: Add Operator Function ........................................................................... 3-31 Figure 3-35: Add Comparison .................................................................................... 3-32 Figure 3-36: Finish Custom Where Clause ................................................................. 3-32 Figure 3-37: Edit Protocol Summarization .................................................................. 3-33 Figure 3-38: Protocol Summarization Fields ............................................................... 3-33 Figure 3-39: Sample Type Summarizations ................................................................ 3-34 Figure 3-40: Editing a Sample Type Summarization ................................................... 3-35 Figure 3-41: Edit Conditional Expression ................................................................... 3-37 Figure 3-42: Creating a Conditional Expression.......................................................... 3-37 Figure 3-43: Creating a Conditional Expression, Continued ........................................ 3-38 Figure 3-44: Coded Value Domain ............................................................................. 3-39 Figure 3-45: Range Domain ....................................................................................... 3-40 Figure 3-46: Attribute Classes .................................................................................... 3-41 Figure 3-47: Common Attributes ................................................................................ 3-42 Figure 4-1: List Sample Events .....................................................................................4-2 Figure 4-2: Select a Data Group ...................................................................................4-2 Figure 4-3: Add a Data Group ......................................................................................4-3 Figure 4-4: Protocol Under Development .....................................................................4-3 Figure 4-5: Edit Data Group .........................................................................................4-3 Figure 4-6: Save Data Group ........................................................................................4-4 Figure 4-7: Add Sample Event to Data Group...............................................................4-4 Figure 4-8: Edit Sample Event ......................................................................................4-5 Figure 4-9: Save Sample Event .....................................................................................4-5 Figure 4-10: Display Sample Event in Data Group .......................................................4-6 Figure 4-11: List of Sample Events...............................................................................4-6 Figure 4-12: View Sample Events in Data Tree ............................................................4-7 Figure 4-13: Edit Sample Event ....................................................................................4-7 Figure 4-14: Select Protocol for new Data Group .........................................................4-8 Figure 4-15: Create New Data Group ...........................................................................4-8 Figure 4-16: Display new Data Group ..........................................................................4-9 Figure 4-17: Edit New Data Group ...............................................................................4-9 Figure 4-18: New Data Group .................................................................................... 4-10 Figure 4-19: Data Groups within a Protocol ................................................................ 4-10 Figure 4-20: Open Data Group ................................................................................... 4-11 Figure 4-21: Edit Name and Description of Data Group ............................................. 4-11 Figure 4-22: Sample Events Window ......................................................................... 4-12 Figure 4-23: Listing Sample Events ............................................................................ 4-13 Figure 4-24: Listing Data Groups by Protocol ............................................................ 4-13 Figure 4-25: Sample Events Listed by Data Group ..................................................... 4-14 Figure 4-26: Hierarchical List of Regions/Areas ......................................................... 4-14 Figure 4-27: Sample Event Query Groups .................................................................. 4-15 Figure 4-28: Editing/Creating Sample Event Query Groups ........................................ 4-16 Figure 4-29: Adding a Sample Event to a Query Group .............................................. 4-16 Figure 4-30: Editing or Adding Sample Events ........................................................... 4-17 Figure 4-31: Editing Sample Event ............................................................................. 4-17

SaMP Desktop Documentation iv

Figure 4-32: Create Geodatabase Window .................................................................. 4-19 Figure 4-33: Creating Geodatabase Wizard Step 1 ...................................................... 4-19 Figure 4-34: Creating Geodatabase Wizard Step 2 ...................................................... 4-21 Figure 4-35: Geodatabase Created by SaMP Desktop ................................................. 4-22 Figure 4-36: Uploading Data ...................................................................................... 4-22 Figure 4-37: Select Geodatabase to Import ................................................................. 4-23 Figure 4-38: Import Geodatabase Wizard ................................................................... 4-24 Figure 4-39: Validation Errors .................................................................................... 4-25 Figure 4-40: Validation Warnings .............................................................................. 4-25 Figure 4-41: Resolve Conflicts ................................................................................... 4-26

Introduction

SaMP Desktop Documentation 1-1

1 Introduction The Florida Fish and Wildlife Conservation Commission (FWC) has contracted with URS Corporation to design and develop the Survey and Monitoring Protocol (SaMP) system to support the management of data associated with wildlife surveys, monitoring projects, and observations on FWC lands.

The SaMP system stores information about survey and monitoring projects, including the sample design, Protocol description, data validation rules and data summarization, and also serves as a central repository for the survey and monitoring data and reports/documents.

Sample designs are stored in Protocols, which define the various types of sample stations and samples recorded at those stations, and can include the documentation about the methodology for collecting and interpreting the data. It can be configured to store a wide range of data, while also sharing common kinds of “lookup” data, such as species names.

The key advantage to the SaMP system over other database design tools is that it provides a central repository for both the database design and the data to be collected.

The SaMP system is designed to generate tools to aid in data entry, by creating ESRI geodatabases that follow the data structures defined in the Protocol. Paired with the SaMP Data Entry ArcMap extension, it becomes a seamless data management system.

By being a single system used to define the Protocols and the structure of data to be collected, as well as being a generator of Protocol documentation and a repository for the data, the SaMP system eliminates replicated effort in documentation and database creation.

1.1 Terms Used in This Document

A glossary is included in Section 5 of this document providing definitions of many of the terms used in this document.

Installation

SaMP Desktop Documentation 2-1

2 Installation As the name implies, the SaMP Desktop is a desktop application. It is based on the Microsoft .Net Framework, incorporates ESRI ArcGIS functionality, and communicates with a central SQL Server database.

To install the SaMP Desktop, run setup.exe from the installation package. The setup wizard will start, guiding you through the installation process. Follow the on-screen prompts. You can change the installation directory if desired, and can choose to install the application for all users of the computer, or just the current user.

If your computer does not already have the Microsoft .Net Framework, the setup application will install the Framework first. You may need to reboot your computer prior to completing the installation. Alternatively, the Framework can be installed separately, following the instructions in Section 2.1.1.

To uninstall the SaMP Desktop, you can run setup.exe again, or choose the uninstall option from the Control Panel Add/Remove Programs applet.

2.1 Prerequisites

The SaMP Desktop incorporates functionality available from other applications which must be installed prior to installing the SaMP Desktop. This section describes these prerequisites and how to install them.

2.1.1 Microsoft .Net Framework

Installation of the .Net Framework is launched automatically by the installer for the SaMP desktop application. You may, however, install the Framework separately, following the instructions in this section.

2.1.1.1 .NET Framework 4 The .NET Framework is typically included in the Windows 7 and higher operating systems. If not already provided, it can be downloaded from Microsoft at:

https://www.microsoft.com/en-us/download/details.aspx?id=17851

2.1.1.2 .Microsoft SQL Server Client The Microsoft SQL Server Client files are included in Windows 7 and higher operating systems.

Using the SaMP Desktop

SaMP Desktop Documentation 3-1

3 Using the SaMP Desktop To run the SaMP Desktop, click Startà Programsà LMISà SaMP Desktop. The first window to appear is the main “dashboard” of the application, the SaMP Launch Window. If you right click on SaMP Desktop, you can select “create shortcut” and drag/drop the shortcut to the quick-launch tray or your desktop for quick access in the future. You must be connected to the FWC network to run SaMP Desktop (either on-site, or via VPN).

3.1 Login and the SaMP Launch Window

When the application starts, a login window will appear (Figure 3-1). If you do not have an account, you will have read-only access to the Protocol definitions and survey and monitoring data. Contact SaMP technical support for assistance in obtaining an account.

Figure 3-1: SaMP Login Window

The SaMP Launch Window (Figure 3-2) provides a dashboard to access the various functions of the application. Based on assigned user roles, different buttons will appear on this form.

Figure 3-2: SaMP Launch Window

SaMP Desktop Documentation 3-2

The buttons on the Launch Window provide access to the following functions:

· Configure Protocols: Provides access to creating and editing Protocols (covered in Section 3.4)

· Configure Global Settings: Provides access to creating and editing domains, attribute classes, and common attributes, which are stored independently of specific Protocols (Section 3.5)

· Manage Sample Events: Provides access to creating and editing Sample Events and Data Groups, based on the configured Protocols. (Section 4.1)

· Documentation: Provides a shortcut to a PDF of this document, the SaMP Desktop User Manual.

· About: Provides information about the current release of the application, including the version number.

· Commit: Saves data to the database. You MUST hit the commit button prior to closing out of SaMP if you want your work or changes to be saved.

3.2 Saving Changes to the Central SaMP Database

All changes you make to Protocols and global configurations are only committed to the database when you click the Commit button on the SaMP Launch Window. The purpose of this is to allow you to exit without saving changes (by not committing when you close SaMP) if the changes you’ve made are ones you decide shouldn’t be saved.

3.3 Data Recovery

If the SaMP Desktop should crash or otherwise be terminated unexpectedly, any changes made locally which have yet to be committed can be recovered when the application is restarted.

Uncommitted changes are stored in XML format file named SaMP_Recovery.xml in your temp directory. When the application starts, it checks to see if the local data file contains changes to the SaMP configuration, and if any are found, prompts you to recover the data.

Figure 3-3: Recover Data Prompt

If you click Yes, the local data file will be read. As with changes made during the normal course of using the SaMP Desktop, the changes recorded in the data file are not committed to the central database until you click the Commit button on the SaMP Launch Window. If you click No, the local data file is renamed, but remains in your temp directory.

SaMP Desktop Documentation 3-3

3.4 Configuring Protocols

To configure a Protocol, click the Configure Protocols button. A dialog window (Figure 3-4) will appear listing existing Protocols, along with an option to create a new Protocol.

The window also provides tools for organizing Protocols into groups.

Figure 3-4: Protocol Selector Window

Protocol Groups are displayed on the left side of the window in a hierarchical style similar to Windows Explorer. If there are any Protocol sub-groups they are shown on the right side of the screen with the icon; and any Protocols are shown with the icon.

Double-click on any Protocol group or click on the Open button to open the group and display the Protocols within that group. Double-click on a Protocol or click on the Open button to open the Protocol for editing.

The Protocol Selector window includes several options for managing Protocols, accessed via the four buttons at the bottom of the screen, or the right click menus. The buttons include:

· New Protocol: Creates a new Protocol.

· New Group: Create a new Protocol group or sub-group.

· Open: Opens the selected Protocol or Protocol group.

· Cancel: Closes the Protocol Selector screen.

Depending on whether you have a Protocol or a Protocol group selected, other buttons are shown. When a Protocol is selected, the buttons include two additional buttons:

· Copy Protocol: Creates a copy of the Protocol, as described below in Section 3.4.1.

· Delete Protocol: Deletes the selected Protocol.

SaMP Desktop Documentation 3-4

When a Protocol group is selected, the buttons include two additional buttons:

· Rename Group: Renames the currently selected Protocol group.

· Delete Group: Deletes the currently selected Protocol group. (Note: you will not be able to delete a group or sub-group if it contains anything within it.)

The Protocol Selector window also uses context-sensitive popup menus, displayed when you right-click on an item, to provide access to these functions. When you right-click on a Protocol, the following menu options are displayed:

· Open Protocol: Performs the same action as double-clicking a Protocol or clicking the Open button when a Protocol is selected—opens the Protocol in the Protocol Editor window, as described in Section 3.4.4.

· Copy Protocol: Creates a copy of the Protocol, as described below in Section 3.4.1.

· Delete Protocol: Deletes the selected Protocol.

When you right-click on a Protocol group, the following menu options are displayed:

· Rename Group: Renames the currently selected Protocol group.

· Delete Group: Deletes the currently selected Protocol group.

You cannot delete or rename the [root] group.

3.4.1 Copying Protocols

To create a copy of a Protocol, right-click on it and select Copy Protocol, or select the Protocol and click the Copy Protocol button.

The new Protocol will be created in the same group, with the name prefixed by “Copy of.” The copy will contain all the same sample type definitions as the original. You can then edit the copied Protocol and its sample types, as described in Section 3.4.4, without affecting the original. This can be useful in creating new Protocol that has a number of sample types and attributes similar to an existing Protocol. Be sure to save the “copy of” with an appropriate name when finished.

3.4.2 Reorganizing Protocols

To move a Protocol or group from one group to another, drag-and-drop it to the new group. Note that you can only do this for a single item at a time.

3.4.3 Protocol Errors

If a previously saved Protocol has any errors, it will appear highlighted in red in the Protocol Selector window. Move your mouse cursor over the Protocol to show a tool-tip that describes the problem(s) found in the Protocol.

3.4.4 Opening a Protocol for Viewing or Editing

To open a Protocol in the Protocol Editor window (Figure 3-5), double-click on a Protocol in the Protocol Selector window, select a Protocol and click the Open button, or select a Protocol and right-click to display the context menu, and select Open Protocol.

SaMP Desktop Documentation 3-5

If you do not have the authority to edit the Protocol, the Protocol will be viewable in read-only mode. The main window for a Protocol is displayed (Figure 3-5).

Figure 3-5: Main Protocol Editing Window

3.4.5 Editing a Protocol

The Protocol editor displays the name and description of the Protocol, along with a summary of the sample types (Section 3.4.5.4) that make up the Protocol, and the status of the Protocol (Section 3.4.5.1). Sample types are displayed in rectangles displaying an overview of the sample type’s attributes. Relationships (Section 3.4.5.6) between sample types are displayed as lines connecting related sample types.

If there are any problems detected with the Protocol structure, they will be visible on this screen. The sample types with errors will be shaded red, and the tool tip will contain a description of the problem (Figure 3-6).

SaMP Desktop Documentation 3-6

Figure 3-6: Protocol Configuration Errors

You can rearrange the sample types in the overview by clicking and dragging them, or click the Auto Layout button to let SaMP organize the sample types.

3.4.5.1 Protocol Status

The Status of a Protocol determines the SaMP Desktop and database will treat the data entry portions of the system.

· Under Development: changes may be made to the Protocol by any user with the authority to create or edit Protocols. No Sample Events may be created that reference the Protocol, and no data may be uploaded based on the Protocol.

· Testing: changes may be made to the Protocol, just as when it is under development, but Sample Events can be created for test data only. Data uploaded based on the Protocol is considered for testing purposes only, and may be deleted before the Protocol is finalized if significant changes to the Protocol’s data definitions are made.

· Active: No changes may be made to the Protocol, except under certain circumstances by administrative users with care that the changes do not adversely affect the ability to upload data (e.g.: do not add a new required field). Data groups and Sample Events may be created that reference the Protocol, data uploaded are considered real data.

SaMP Desktop Documentation 3-7

· Archived: No changes may be made to the Protocol, and no new Sample Events or data can be uploaded.

3.4.5.2 Generating Protocol Documentation

To create a data dictionary which fully describes all the sample types that make up the Protocol, click the Create Data Dictionary button on the main toolbar (Figure 3-7). The data dictionary includes the Protocol overview graphic shown on the main Protocol editing screen and detailed information about each of the sample types, the attributes of those sample types, and the data validation rules used to help ensure the quality of the data.

Figure 3-7: Create Data Dictionary

3.4.5.3 Database Diagram

A Protocol is made up of a variety of types of station and sample types, which may in turn be made up of sample subtypes, all of which are defined collectively (including station data) as sample type records. A sample type record is analogous to the definition of a physical table or feature class in a traditional database or geodatabase.

Each sample type is displayed on the main Protocol screen in the database diagram area as a boxy “bubble” (Figure 3-8), which also lists the attributes of the sample type, along with the data type of each attribute, and a “PK” (primary key) flag to identify the attribute(s) that uniquely identify rows in a table based on the sample type. For example, TREE_ID is listed as an attribute for sample type RCW_TREE. The “PK” to the left of the attribute identifies this attribute as a unique identifier of an RCW_TREE record. The “Number” data type listed to the right indicates the attribute stores only numbers.

Figure 3-8: Sample Type Summary Box

Move your mouse cursor over a sample type box to display descriptive information about the Protocol, as well as the geometry type (point, line or polygon, or none if it is a standard table without a geographic representation).

To edit the Protocol Name, Description, or Status, click the Edit button in the top part of the form (Figure 3-5), and make changes (Figure 3-9).

When you are editing this basic Protocol information, the tab will display an asterisk (*) in the tab caption to indicate you have unsaved changes (Figure 3-9).

SaMP Desktop Documentation 3-8

Figure 3-9: Protocol Window in Edit Mode

Allowed status values, available in the Status drop-down menu, are:

· Under Development: Protocol can be edited; Sample Events cannot be created based on the Protocol.

· Testing: Protocol can be edited; Sample Events for test data can be created based on the Protocol.

· Active: Sample events can be created based on the Protocol; Protocol cannot be edited.

· Archived: Sample events cannot be created based on the Protocol; Protocol cannot be edited.

Click the Save button to save your changes to the Protocol name and description, or the Cancel button to undo your changes. (Note: the changes will not actually be saved to the central database until you hit the “Commit” button prior to closing the application.)

3.4.5.4 Editing Sample Types

Double click on a sample type balloon (Figure 3-9) to open a new tab displaying the details about the sample type (Figure 3-10), or click the Add Sample Type button (shown in Figure 3-9) to create a new sample type.

SaMP Desktop Documentation 3-9

Figure 3-10: Editing Sample Type Information

In this example the RCW_TREE tab displays an outline of the information about the sample type on the left side of the screen and the basic information about the sample type on the right side of the screen. The outline consists of:

· Attributes, which define the properties of individual data elements, and are the columns or fields of the sample type table (see Section 3.4.5.5).

· Summarizations, which perform automated calculation or summarization of the data (see Section 3.4.5.10).

· Relationships (Parent and Child), which link the sample type to other sample types in the Protocol (see Section 3.4.5.6)

· Validation Rules, which help to constrain and validate data recorded for the sample type (see Section 3.4.5.9)

The information about the Sample Type includes:

· Name: The primary name of the sample type, used as the name of the table or feature class to be generated. Names must be compliant with both Oracle and Microsoft Access database management systems, as the data will exist in both systems. (The application will warn you if the name you enter is not compliant;

the complete list of naming rules is available in Oracle and Microsoft Access documentation). The name must be unique within a Protocol.

SaMP Desktop Documentation 3-10

· Alias: An optional, more user-friendly name of the sample type.

· Description: A detailed description on the purpose and general content of the sample type.

· Collection Method: An optional description of the method to be used when collecting the data, providing documentation of the sampling methodology.

· Sample Type Role: Allows you to specify how data in this table will be treated when generating new sample events:

o Sample Table: Records in this sample type will be tied to a specific sample event only, and not carried forward into new sample events.

o Station Table: AKA “Reference Data”, records in this sample type will be included in all new sample events generated for the data group.

· Geometry Type: Defines whether data stored in the sample type will have a geographic component, and if so, what feature type to store (point, line or polygon).

· ID Format: Allows you to specify how the IDs of records recorded for this sample type will be displayed in SaMP Data Entry.

o Automatic: SaMP Data Entry will use the alias(es) and value(s) of the unique ID(s) of the records in this table. For example, if the ANNUAL_TREE_INSPECTION table is uniquely identified by the TREE_ID and VISIT_DATE fields, it will default to Tree ID:

{TREE_ID} Visit Date: {VISIT_DATE}, and display as “Tree Id: M001 Visit Date: 3/13/2016” o Custom: To override the automatic IDs, select the second option and enter a formatting statement, using {} around column names as placeholders for the values to display.

· Row Filter: Allows you to set up conditions under which a record will be hidden from the SaMP Data Entry user interface. For example, you may want to only include live RC trees (excluding dead/destroyed trees) from the user interface, to simplify entering new inspection records without having to skip past trees that are no longer applicable. You can set up the row filter to test the conditions of attributes and summarizations of the sample type, and SaMP Data Entry will only show the records that meet the conditions set. To enter a row filter, click the link next to the label (“All Records” if no filter has been set, or the established row filter if one has been set). See Section 3.4.5.11 for an explanation of how to use the conditional expression wizard.

Any problems detected with attributes, relationships or validation rules will be visible on the left side of the screen. The item’s text will be red, and its tool tip will contain a description of the problem.

To edit the basic information about a sample type, click the Edit button. The screen will change to edit mode (Figure 3-11), enabling the data entry fields. Note that when you are editing the basic information about a sample type or information about any of the sample

SaMP Desktop Documentation 3-11 type attributes, the tab will display an asterisk (*) in the tab caption to indicate you have unsaved changes. To save your changes, click the Save button. To undo your changes, click the Cancel button.

Figure 3-11: Sample Type Editor in Edit Mode

Click on an item in the outline to display information about the currently selected item on the right side of the form.

If you select any of the attributes, relationships or validation rules from the outline, you will need to click the sample type header link (labeled “RCW Tree” in the example shown in Figure 3-10) to display the sample type header information again.

3.4.5.5 Editing Attributes

Click on an attribute in the outline to display the details of the attribute. The data for the attribute will appear on the right side of the window, as shown in Figure 3-12.

SaMP Desktop Documentation 3-12

Figure 3-12: Editing Attributes

To edit the select attribute, click the Edit button (shown highlighted by a green oval in Figure 3-12) at the bottom right of the form. To create a new attribute, click the Add Attribute button (highlighted in red) on the main toolbar. To add one of the common attributes (see Section 3.5.3) click the Add Common Attribute button (highlighted in purple). The screen will switch to edit mode, as shown in Figure 3-13.

To save an attribute as one of the common attributes, click the Save as Common Attribute button (shown highlighted in orange in Figure 3-12).

SaMP Desktop Documentation 3-13

Figure 3-13: Editing Attribute Screen in Edit Mode

The Editing Attribute Screen (Figure 3-13) displays the following stored information about an attribute:

· Name: The primary identifier of the attribute, used as the field name when generating a table or feature class in ArcSDE or personal geodatabases. The name cannot be longer than 30 characters, must be unique within a sample type, must begin with a letter, and can contain only letters, numbers or underscore (_) characters.

· Short Name: The name that is used when exporting to a database format that limits field names to no more than 10 characters, such as shapefiles or dbf files.

· Alias: A more user-friendly, descriptive name of the attribute.

· Description: Detailed information on the purpose and content of data to be stored in the attribute.

SaMP Desktop Documentation 3-14

· Collection Method: An optional text field to be used to document the collection method for the data stored in the attribute.

· Units: An optional text field to be used to document the units of measure for values stored in the attribute.

· Category: An optional text field to be used to organize attributes.

· Data Type: Specifies what type of data will be stored in the attribute.

· Required: Specifies whether data for the attribute are required or optional.

Choose from:

o “Required (in field)”: the data management system (Access, SaMP Data Entry, ArcMap or ArcPad) will raise an error when attempting to save a record without providing a value for the field storing the attribute.

o “Required (upon upload)”: the data management system will allow records to be saved without providing a value for the field storing the attribute, but when uploading data via SaMP Desktop an error will be raised. Choose this option for data that might not be available at the time of initial data entry.

o “Not required”: null values are always allowed.

· Part of Unique Key: Specifies whether the attribute will contain values that uniquely identify records in the sample type.

· Include in Export: Specifies whether the attribute will be included in default data export routines.

· Allow Filtering In Queries: Specifies whether the attribute will be displayed on the SaMP Web Query tools as a field that can be used to filter and query data.

· Max Length: The maximum length of text or numbers stored in the attribute. For numbers, the length includes all digits before and after the decimal point, but not the decimal point itself.

· Scale: The number of digits after the decimal point (applies to the data type of Number only).

· Domain: A domain can define a range of values or a list of valid values. An attribute cannot have both an attribute class and a domain. This option is not available when the data type is set to Date.

· Attribute Class: An attribute class defines a list of value ranges that have an associated specific numeric value used for data summarization purposes. An attribute cannot have both an attribute class and a domain. This option is only available when the data type is set to Text.

· Date/Time Options: If the data type is set to Date, check boxes will appear to give you the option to display only the date portion, only the time portion, or a combined date/time.( Note that this is only supported by the SaMP Data Entry application, and not direct editing in ArcMap or ArcPad.)

SaMP Desktop Documentation 3-15

· Default Value Options: You can choose from any of the following options to set up default values for the attribute during data entry:

o None: No default value will be presented to the user. (The field will be blank when a new record is created.)

o Previous Value: When entering a series of records, the value of the most recently entered record will be used as the default for the new record.

o Auto-Increment: For numeric fields, the default value will be one greater than the highest value already entered for this attribute.

o Current Date/Time: For date fields, the default value will be the current system date/time.

o Literal Value: A numeric or text value that will be entered into the attribute field by default.

· Field Dependency: Allows you to set whether a field is required, visible or both, depending on the state of other fields in the sample type.

o Requirement: select this option to flag a field as required when the condition is true o Visibility: select this option to only show the field when the condition is true

· Field Dependency Condition: When you’ve selected one of the Field Dependency options, use this link to open a dialog for defining the field dependency condition. See Section 3.4.5.11 for an explanation of how to use this form.

3.4.5.6 Creating and Editing Lookup Tables

Lookup tables are a special category of table that is primarily designed to provide lookup values with more complex structures than a simple domain. (See Section 3.5.1 for more information on editing Domains.) A good example of the utility of a lookup table is for species lists, where you may want to pair scientific name with common name, or other attributes such as upland/wetland classification.

To create a lookup table, click Add Lookup Table from the menu at the top of the Protocol main tab.

SaMP Desktop Documentation 3-16

Figure 3-14: Adding a Lookup Table

The interface for editing Lookup Tables is a simplified version of the interface for editing Sample Types, prompting you to enter just Name, Alias and Description. (See Section

3.4.5.4 for more information on these fields.) You will add attributes to the Lookup Table in the same way you do Sample Types (see Section 3.4.5.5).

You must add at least one attribute to the lookup table. Data types for attributes of lookup tables are limited to Text and Number.

SaMP Desktop Documentation 3-17

Figure 3-15: Editing Lookup Tables

3.4.5.7 Relating Sample Types to Lookup Tables

After you have created a Lookup Table, you can establish a relationship to it. You do this in a similar way to editing Relationships (see Section 3.4.5.8).

1. Open the Sample Type you will be relating to the Lookup Table.

2. Click the Add Relationship button.

Figure 3-16: Adding a Relationship

SaMP Desktop Documentation 3-18

3. Select the Link Fields to a Lookup Table option.

Figure 3-17: Linking Fields to a Lookup Table

4. Click Next

5. Select the Lookup Table and click Next

6. Choose whether or not to constrain the value combinations entered in your

Sample Type to those found in the Lookup Table. (If not constrained, you will be able to enter values not found in the Lookup Table.)

7. Click Next

8. Choose matching existing attributes, or create new attributes in your Sample

Type.

Figure 3-18: Linking Fields to a Lookup Table

SaMP Desktop Documentation 3-19

9. Click Finish

3.4.5.8 Editing Relationships

Relationships define how records in the current sample type are related to other records in other sample types. To see the details of a relationship, click on it in the outline.

Figure 3-19: Relationship Details Window

The Relationship Details screen (Figure 3-19) will show the two sample types that make up the relationship and the attributes that store the data used to establish the relationship.

If any rules have been specified about the cardinality, these will be displayed in terms of the minimum and maximum child records per parent.

Creating or editing existing relationships is done using the Relationship Wizard. To edit an existing relationship, select it on the outline and click the Edit Using Wizard button.

To create a new relationship, click the Add Relationship button.

SaMP Desktop Documentation 3-20

Figure 3-20: Define Parent/Child Relationship

The first screen that appears when adding a new relationship asks you to define whether the current sample type will be the parent or child in the relationship (Figure 3-20) (note that you cannot change this for an existing relationship, so this page of the wizard is not shown when editing existing relationships).

Figure 3-21: Select Related Sample Type

The second screen displayed when adding a new relationship prompts you to choose the other sample type to relate to the current sample type (Figure 3-21).

SaMP Desktop Documentation 3-21

Figure 3-22: Define Relationship Keys

The next page of the wizard (the first page when editing an existing relationship, or the third page when adding a new relationship) allows you to specify which attributes will store the information used to relate sample records (Figure 3-22). The left side of the form shows the unique identifier(s) of the parent sample type. On the right side you choose the fields from the child sample type. The wizard also allows you to “auto create” the child key attribute. If you choose this option, a new attribute will be added to the child sample type with the same name, type and size.

Figure 3-23: Specify Cardinality

The final page of the wizard (Figure 3-23) allows you to specify a specific number or range of child records required for each parent record. For example, to specify that a sample must be made up of one to three sub-samples, enter a minimum value of 1 and a maximum value of 3. To specify that exactly three sub-samples must be created, enter 3 in both fields. For a real-world example, if you have a herp array, and each array has 12 traps (and only 12 traps), you would enter 12 in both fields. Leave the fields blank to allow for any number of child records to be created per parent.

SaMP Desktop Documentation 3-22

Note that multi-attribute keys are not supported for establishing relationships in ArcMap or ArcPad. Only the SaMP Data Entry application supports establishing relationships between tables or feature classes with more than a single unique key.

3.4.5.9 Editing Validation Rules

Validation rules allow for the creation of more complex rules for validating data for specific attributes, or across many attributes of the same sample record. Multiple rules may be created for each attribute or data row.

An important distinction between the custom validation rules and basic rules (which check data type, maximum length, or compare data to coded-value or range domains or attribute classes) is that the basic rules are enforced in any front-end geodatabases used for data entry purposes, while the custom rules are only checked during the process of uploading to the central database. This is because the central database has more capability for evaluating complex validation rules that compare values stored in different fields and across multiple sample types. Changes to custom validation rules do not affect data already uploaded to the central database. To re-check data against new or modified rules, you must re-upload the data from the external data source used for data entry purposes.

The validation rule is a SQL statement that references the attributes and results in a true or false condition when evaluated by the system with the referenced attribute values. If the condition returns false for a given record, the warning (or error, depending on the severity specified) message is presented to the user. Errors result in the system rejecting the data, while warnings require the data to be reviewed by FWC staff.

The logical statement is evaluated within an Oracle CASE WHEN statement, which returns a true or false value. The application will formulate this statement as an Oracle command object and assign the uploaded value(s) as parameters, then pass the command to Oracle for evaluation.

Creating a New Validation Rule A validation rule is associated with a Sample Type and added or edited through the Editing Sample Type screen. To add a new validation rule, select the Sample Type you wish to add a validation rule to and open it for editing by double clicking on it To create a new rule, click Add Validation Rule in the menu choices or click the [+] to the right of [Validation Rules] in the directory tree on the left (Figure 3-24)..

SaMP Desktop Documentation 3-23

Figure 3-24: Adding New Validation Rule

The Editing Validation Rule screen (Figure 3-25) opens.

Figure 3-25: Editing the Validation Rule

On the Editing Validation Rule screen you will be able to edit the following basic fields and set the conditional expression to be evaluated and the response the user sees when it gets evaluated.

· Description: Enter a short description of the validation rule that will be used to identify the rule and explain its purpose.

· Attribute: Shows the attribute the rule…