interface control document mobilize maintenance pavement … · 2020. 8. 18. · core with esri...
TRANSCRIPT
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 1 of 17
Interface Control Document Mobilize Maintenance Pavement Core with Esri ArcGIS Online
Table of Contents Section 1 Document Information ............................................................................................................................................ 3
1.1 Information .................................................................................................................................................................... 3
1.1.1 Functional Requirements – Data Management and Reporting on Pavement Core Sample Data ......................... 4
1.1.2 Functional Requirements – Data Exporting ............................................................................................................ 4
1.1.3 Functional Requirements – User Interface ............................................................................................................. 5
1.1.4 Functional Requirements – System Access and Security ....................................................................................... 5
1.2 Version History ............................................................................................................................................................... 5
1.3 References ..................................................................................................................................................................... 6
1.4 Relevant Glossary........................................................................................................................................................... 6
Section 2 Integration Conceptual View ................................................................................................................................... 7
2.1 Diagram and Description ............................................................................................................................................... 7
2.2 Products, Platforms and Software Matrix ..................................................................................................................... 7
Section 3 Logical View.............................................................................................................................................................. 8
3.1 Diagram and Description ............................................................................................................................................... 8
3.2 ArcGIS Online Content and Web Services ................................................................................................................... 10
3.2.1 Pavement Core Feature Services .......................................................................................................................... 10
3.2.2 ArcGIS Online Content .......................................................................................................................................... 11
3.3 ETL ................................................................................................................................................................................ 12
3.3.1 Pavement Core Sample: Update RNS Intersection and RNS Route Name (Figure 1-a) ....................................... 12
3.3.2 Pavement Core Sample: Update Coring Report Reference Line (Figure 1-a) ....................................................... 14
3.3.3 Pavement Core Sample: Export from GIS to CSV (Figure 1-b) .............................................................................. 15
3.3.4 Pavement Core Sample: Import from GIS Export to PMS Staging Table (Figure 1-c1) ........................................ 15
3.3.5 Pavement Core Sample: Import from PMS Staging Table to PMS Tables (Figure 1-c2) ....................................... 15
Section 4 Physical View .......................................................................................................................................................... 16
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 2 of 17
4.1 Diagram and Description ............................................................................................................................................. 16
Section 5 Assumptions and Risks ........................................................................................................................................... 17
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 3 of 17
Section 1 Document Information This document includes the systems integration information and implementation in order to facilitate the flow of
data between field collected data managed by ArcGIS Online externally hosted by Esri, as well as image
integration and storage. Generally, Systems integration is defined as facilitating the communication of
information between two (2) or more different applications, systems, platforms and/or products. This document
includes the details for the following types of components in an effort to provide sufficient to identify the method
of information flow among systems:
• Web service integrations
• Data integrations
• Mobile field data integrations
However, this document does not include information for the following components as they are considered
Universal across most applications:
• Active directory because it is done to provide security, not to achieve specific reusable functionality
• Database connections made by an application to perform CRUD transactional operations as these
connections do not qualify as integration efforts among different systems
1.1 Information
The Pavement Management and Materials programs require a technology based solution for agency-wide data
collection and management system whose primary function is to expedite and streamline the process of collection,
storage and reporting on pavement core sample data.
In order to accomplish the above articulated need, VDOT requires an agency-wide data collection and
management system that includes the following functionality:
• Coring Data Management Services
o tracking of pavement core sample data (core location and business data)
o share pavement core sample data across the agency
o ability to store and search image files
o store core sample location data on GIS
o ability to define extent along a route and link report files
o utilize mobile technologies for data collection
o capacity to export business data to support District information needs (e.g. pavement coring
report generation)
• Exporting Capacity
o capacity to select from map and export the associated data
o access to image files and reports
o capacity to generate a map output of current extent
• User Interface
o provide a visual indication of required data elements in online screens
o provide a save option for data editing
• System Interfaces
o Pavement Management System
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 4 of 17
o Pavement Maintenance Scheduling System
o ArcGIS Online
o Survey123 for ArcGIS
o Azure Cloud
• System Access and Security
o Integrated technical safeguards to ensure a level of privacy and security, including
Administrator controlled user name and password access
Administrator controlled user level read, write, edit and delete capabilities
o Capable of supporting 50 concurrent users (collection at multiple paving locations across
multiple Districts, with simultaneous data entry/review in office)
o Capable of supporting single sign-on
1.1.1 Functional Requirements – Data Management and Reporting on Pavement Core Sample Data
Req. ID Requirement Definition
FR1.0 The system shall provide the ability to manage pavement core sample
data in a relational database
FR1.1 The system shall provide functionality for data (including
image/document) entry, selection, identification, query and exporting
from a mapping interface.
FR1.2 The system shall provide functionality for data (including
image/document) selection, identification, query and exporting from a
graphic interface.
FR1.3 The system shall store coring locations in a GIS data format
FR1.4 The system shall allow a user to define an extent along a route from
PMS and link associated coring report files
FR1.5 The system shall provide the functionality for data entry, review, and
update through mobile technology
FR1.5.1 The system shall provide functionality to manage file sizes of images
collected in field on mobile devices
1.1.2 Functional Requirements – Data Exporting
Req. ID Requirement Definition
FR3.0 The system shall provide capability to select from map and export data
FR3.1 The system shall provide user access to image files and reports
FR3.2 The system shall provide ability to generate a map output from current
extent
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 5 of 17
1.1.3 Functional Requirements – User Interface
Req. ID Requirement Definition
FR4.0 The system shall provide a visual indication of required data elements
on screen in online and mobile screens during user data entry
FR4.1 The system shall provide a save option for data editing
1.1.4 Functional Requirements – System Access and Security
Req. ID Requirement Definition
FR6.0 The system shall provide integrated technical safeguards to ensure of
level of data privacy and security
FR6.0.1 The system shall provide Administrator controlled user name and
password access
FR6.0.2 The system shall provide Administrator controlled user level read, write,
edit, and delete capabilities
FR6.1 The system shall support 50 concurrent users (through both office and
mobile field data review, entry, and update)
FR6.2 The system shall be capable of supporting single sign-on
1.2 Version History
Version Date Author Description
1.0 3/24/17 Courtney Moore Beginning draft document 1.1 3/29/17 Rachel O’Neil Technical, logical and physical architecture
1.2 3/29/17 Matt McCracken Review
1.3 3/29/17 Rachel O’Neil Updated an error
1.4 3/29/17 Will Duke Updated functional requirements 1.5 5/10/17 Jennifer Kennedy Split document from M20, update integration concept
1.6 5/11/17 Courtney Moore Review / proofing
1.7 5/19/17 Courtney Moore Updated for ArcGIS Online instead of Portal 1.8 7/13/17 Courtney Moore Updated & polished draft ready for VDOT ITD
1.9 9/21/17 Jarrett Green Updated ICD
1.10 10/10/17 Joshua Weaver & Jarrett Green Updated ICD and diagram
1.11 10/27/17 Jarrett Green Updated ICD per VDOT’s review
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 6 of 17
1.3 References
Reference Name Link Description <<Project Solution Architecture Document>>
Link to the SA Document Library [both document link and project View]
Will contain overall Project Architecture information if the integration is being created as a result of a project.
1.4 Relevant Glossary Glossary Item Link
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 7 of 17
Section 2 Integration Conceptual View
2.1 Diagram and Description The Pavement Core Sample data will reside in ArcGIS Online, and will provide a feature service for field collection of data
through Survey123 for ArcGIS – which includes attribution and photographs – and will be accessible from the PMS front-
end. Tools will provide the ability to export data from an interactive map to CSV.
Pavement Coring Report Location data:
• Office Materials Users will access the GIS pavement core records and select and export data to manipulate and use for analysis
• Office Materials Users will manually create Pavement Coring Reports, and then manually define a start and end point along a route, and attach the coring report to the location definition
• An automated process will create a route segment as a GIS line feature, using the user-created start and end points and the LRS Route dataset
• An automated process will export the coring reports to CSV every morning at 10AM
• On demand import tool will be run by Maintenance Division admin to import CSV into PMS Staging Tables and finally PMS Tables through PMS front-end. Data will remain in GIS for viewing, but will not be pushed again after moving to PMS.
Information about the new PMS table needed to support the PMS Report Location:
• Table will contain at minimum the basic information listed below: o District o County Maintenance Jurisdiction o Report Date o Link to the report itself (file path in cloud-based file storage solution) o Location Information (as stored in PMS SETUP LOC IDENT table)
• Table may be expanded to include other information deemed useful
2.2 Products, Platforms and Software Matrix
No. Name Version Vendor Name Purpose Lifecycle Status
License Status
1 VDOT PMS 7.0.4.0 VDOT Provides Pavement management by collecting and retaining information on pavement management activities
Static Licensed
2 ArcGIS Online 10.5.1 Esri To provide feature services to facilitate and store geospatial and business data collected in the field via mobile collector applications and to allow the
Static with scheduled updates
Licensed
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 8 of 17
viewing and editing of data via in office applications
Section 3 Logical View
3.1 Diagram and Description For pavement core workflow, the process is initiated through mobile field collection which then writes this collected
data to ArcGIS Online via a published feature service, this includes the collection of image data. The Materials user
accesses the field collected data via a Web Mapping App, exports data to create a report, defines a Report Start and End
point in GIS data, and attaches the report to the Report Start point. A scheduled python script creates GIS line features
from the Start and End points and the LRS data (visualizing the extent of the report along a route). A PMS admin user
can run import tools on demand to import data from GIS to PMS through the PMS front-end.
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 9 of 17
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 10 of 17
3.2 ArcGIS Online Content and Web Services The following ArcGIS Online content and web services are used in the creation and editing of field collected data. Please
note that all item URLs and service URLs are subject to change if/when moved up the environment stack.
3.2.1 Pavement Core Feature Services
The following feature services are consumed by Survey123 and the Pavement Core Web AppBuilder.
Name: M20_Pavement_Core_StartEndLine
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=e1a4c29741084c0d928ede9b408c6474
Service URL:
https://services.arcgis.com/p5v98VHDX9Atv3l7/arcgis/rest/services/M20_Pavement_Core_StartEndLine/FeatureServer
Purpose: This feature service contains the report start and end points that users create in the Web AppBuilder. A
scheduled python script will generate the reference line between the start and end points.
Name: PavementCore_Intersections
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=f42fe7caf9ed40f7b67572b63d2353af
Service URL:
https://services.arcgis.com/p5v98VHDX9Atv3l7/arcgis/rest/services/PavementCore_Intersections/FeatureServer
Purpose: This feature service contains RNS intersections and can be used as a reference layer in the web app. A
scheduled python script will also use this layer to find the nearest intersection along the route and populate the
intersection ID into the field collected pavement core points.
Name: PavementCore_LRS
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=e260bf1e8f3e4283913a39bcd96d7a40
Service URL: https://services.arcgis.com/p5v98VHDX9Atv3l7/arcgis/rest/services/PavementCore_LRS/FeatureServer
Purpose: This feature service is used as a reference layer in the web app. A scheduled python script will also use this
layer to find the nearest route and populate the route name into the field collected pavement core points.
Name: PavementCore_Boundaries
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=abda99682a3844a59403146234cd614f
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 11 of 17
Service URL:
https://services.arcgis.com/p5v98VHDX9Atv3l7/arcgis/rest/services/PavementCore_Boundaries/FeatureServer
Purpose: This layer serves as a reference layer for field and desktop users.
Name: Pavement Core
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=e598f4d5462c4f0fa416169dcf14f82b
Service URL:
https://services.arcgis.com/p5v98VHDX9Atv3l7/arcgis/rest/services/service_2af7a45a6478487e9d1c214b4aff06ae/Feat
ureServer
Purpose: This feature service is the service used in the Survey123 application to create pavement core sample points in
the field.
3.2.2 ArcGIS Online Content
The following content is used to display GIS data to end users.
Name: Pavement Core WebMap DEV
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=6b634871bb504901a8312e612bc89d67
End User URL:
http://vdot.maps.arcgis.com/home/webmap/viewer.html?webmap=6b634871bb504901a8312e612bc89d67
Purpose: This web map is used as the input for the web application below. End users will generally not need to access
this map but must be shared so they can access the data in the web app. Layer configurations and pop-ups will be set
here by the item owner.
Name: Pavement Core WebApp DEV
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=a45ff0aeb75541bfba15df40765b3fc1
End User URL: http://vdot.maps.arcgis.com/apps/webappviewer/index.html?id=a45ff0aeb75541bfba15df40765b3fc1
Purpose: This web app is the primary desktop application used by end users. Users can query, edit and export table data
from this application. Users will also perform the business function of attaching the coring report to the coring start
points through the edit widget in this application.
Name: Pavement Core Authentication DEV
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 12 of 17
Item URL: http://vdot.maps.arcgis.com/home/item.html?id=1751c5c7a9204f038124fe235f731db6
Purpose: This is the authentication application for the Web AppBuilder. The python scripts processing data need to
access the feature services being edited by the end users.
3.3 ETL
Figure 1: Pavement Process Diagram
3.3.1 Pavement Core Sample: Update RNS Intersection and RNS Route Name (Figure 1-a)
Scheduled process (Python) that updates the RNS Intersection and RNS Route Name attributes of Pavement Core Points.
Field data collection users will not be able to manually enter these attributes. Instead, users will populate attribute
fields to indicate the Route associated with the data (including Route Prefix, Route Number, and Route Suffix), and the
update process will take that information as well as the spatial location of the point and match that against the LRS to
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 13 of 17
populate the RNS Route Name. The process will use the spatial location to populate the nearest RNS Intersection along
the matched route.
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 14 of 17
3.3.2 Pavement Core Sample: Update Coring Report Reference Line (Figure 1-a)
Scheduled process (Python) that creates a GIS line feature as a segment of an LRS route, using the user-defined Report
Start and Report End points (and attribution on the data, including Route Prefix, Route Number, and Route Suffix) and
the LRS dataset. This tool will create Reference lines for newly created Report Start and Report End points, as well as
update any lines if the Start and End points have been modified.
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 15 of 17
3.3.3 Pavement Core Sample: Export from GIS to CSV (Figure 1-b)
Scheduled tool (Python) that will export data from GIS to CSV file format. The tool will place the data in a location known
to the PMS.
3.3.4 Pavement Core Sample: Import from GIS Export to PMS Staging Table (Figure 1-c1)
On demand tool (Groovy Script) accessed from the PMS front end to import data from the exported GIS data in CSV file
format into the PMS Coring Report Staging Table.
3.3.5 Pavement Core Sample: Import from PMS Staging Table to PMS Tables (Figure 1-c2)
On demand tool (Groovy Script) accessed from the PMS front end to import data from the PMS Coring Report Staging
Table into the PMS Coring Report Location table.
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 16 of 17
Section 4 Physical View
4.1 Diagram and Description
Figure 2: ArcGIS Platform Diagram
Figure 3: ArcGIS Online Data Process
Oracle GDB
INTERFACE CONTROL DOCUMENT MOBILIZE MAINTENANCE PAVEMENT
CORE WITH ESRI ARCGIS ONLINE
October 30, 2017
Page 17 of 17
To access Survey123 and ArcGIS online. Users must be registered with the VDOT ArcGIS Online account and have access
to the internet.
Section 5 Assumptions and Risks
Assumptions:
• Timmons Group/Spy Pond Partners Team will be granted access to necessary data
• Timmons Group/Spy Pond Partners Team will be granted access to necessary systems
• VDOT ITD will support in an advisory and consulting role
Risks:
• Tight project deadline
• Changes in solutions