Capital Projects Explorer
Schema and Examples
Welcome to Socrata's Capital Projects Explorer (CPE) experience. This page is designed to provide documentation that will help your team better understand the CPE application, and how you'll need to structure your data so that the application can read and display information in meaningful ways.
This page includes:
- Introducing Capital Projects Explorer
- Understanding Schemas
- Schema Documentation
- Customer Examples
- Additional Resources
Introducing Capital Projects Explorer
Capital Projects explorer is an application that allows your citizens to explore details about your past, present, and future capital projects. Users can learn more about the projects themselves, the status, as well as the impacted locations for each project.
Because of this focus on not only project detail, but location, there are three datasets that you will need to upload to your platform in order to properly use the application: one Projects Dataset, that contains the information about the project(s) themselves, and two Geo-Boundary Datasets.
There are three required datasets for the Capital Projects Explorer :
- Project Details Dataset - REQUIRED - Detailed dataset that has information about each Capital Project. The data within this dataset can be separated into four major "subcategories", though data from each subcategory is not required (though strongly recommended)
- Filters - Data that will allow the app to filter the data by geography (such as district), or by project stage
- Descriptions - Core details about projects, including descriptions, websites, images, and other supporting information
- Budget - Budget and spending data for each project
- Status - Flags and other information about the on-track status of the project
- Project Shapes Dataset - REQUIRED - Geographic boundary information about each project, allowing users to see where the project will take place
- Agency Shapes Dataset - REQUIRED - Geographic boundary information about the general area of your jurisdiction. For example, neighborhoods, wards, or other area-specific geographic boundaries that would provide your users with better context
Within the schema documentation, you'll find three field types:
- Required Fields: These fields are required by CPE to function. Think of these fields as the data that you simply could not report about your projects without. For example, the name of a project or a unique identifier.
- Recommended Fields: These fields are not required, but including them will allow users to see a richer picture of your projects' information. For example, a description for each project, or budgetary information about the project
- Optional Fields: These fields are useful for analysts or power-users accessing the information, or for adding a deeper level of hierarchy. For example, text providing context behind budgetary figures or a subcategory of project.
For the full documentation of the schemas for Capital Projects Explorer, which includes all three required datasets, click the link below:
Below are examples of actual customers' Capital Project Explorer implementations, from both the application-level as well as the data-level. Use the below examples to explore how the data is structured and how it is displayed in the final version of the application.