Bulk upload of development projects¶
Development projects can be bulk uploaded into the platform through a request here. The data schema below must be followed for the upload to occur. Development projects can either be uploaded as a CSV file or as a zipped (.zip) shapefile of polygons. CSV files and shapefiles use different methods to connect development projects to parcels, see below for details on the methods available:
Note
The ability to bulk upload development projects is not yet available in the user interface. If you would like to upload your development projects, please format them to fit the data schema and send the data with a request here.
Connecting development projects to parcels¶
Three methods are available to connect your development projects to specific parcels. The set of development projects to upload should be formatted to only utilize one method:
CSV: use a parcel_id column to directly associate the project with the primary_id of parcel polygons. This is the preferred and most accurate method of association. The parcel_id must correspond exactly to the primary_id in the uploaded parcel geometry shapefile. For projects that are associated with more than one parcel ID, denote multiple parcels using a semicolon ; as a delimiter, for example: 448878; 425091
CSV: use columns x (longitude) and y (latitude) to hold coordinates of the project address or centroid to associate with the intersecting parcel, primary_id. Coordinates must be in the World Geodetic System 1984 (WGS84) coordinate system.
Shapefile: use polygons denoting the project area to associate the project with intersecting parcel polygons, primary_id. Development project polygon intersection occurs using a within parcel polygon centroid method.
Each method requires a different data schema for specific columns to include in your file to upload, see below:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
parcel_id |
Integer |
Yes |
parcel_id must correspond exactly to |
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
x |
Float |
Yes |
Longitude coordinate of project address or centroid. |
y |
Float |
Yes |
Latitude coordinate of project address or centroid. |
Development project attribute data schema¶
A basic set of columns are required to upload development projects and are identical to those required in the user interface development projects. Required and optional columns and their data schema are described separately below by category for interpretation purposes:
General attributes: Required for all development project records.
Residential building attributes: Required for development project records that are denoted as a is_residential building type (residential) in the building types table.
Non-residential building attributes: Required for development project records that are denoted as a is_non_residential building type (non-residential) in the building types table.
Mixed use building attributes: Required for development project records that are denoted as a being both is_residential and is_non_residential building type (residential and non-residential) in the building types table.
Other building attributes (Optional): Requirement for development project records that are optionally denoted as a other building type (neither residential nor non-residential) in the building types table.
Phased attributes (Optional): Requirement for development project records that should phase the construction of units or space over multiple years. See the development projects section for more on phases.
AMI levels (Required only if project has inclusionary affordable units): Requirement for development project records that have inclusionary affordable units. See the development projects section for more on AMI levels.
General attributes¶
Regardless of development project building type, these general columns are required where indicated below:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
name |
String |
Yes |
The name of the project. |
building_type_id |
Integer |
Yes |
The ID of the project building type. Must |
start_year |
Integer |
Yes |
The construction start year of the |
duration |
Integer |
Yes |
Construction duration in months. Must |
buildings_count |
Integer |
Yes |
Total number of buildings in the |
floors |
Integer |
Yes |
Average number of floors in the buildings in |
status |
String |
Yes |
The certainty that the project will be |
redevelopment |
Boolean |
Yes |
Indicator that development is a |
tags |
String |
Yes |
Tags to use to link with scenarios. For setting |
phased |
Boolean |
Yes |
Indicator that development residential units and |
descriptive_location |
String |
No |
General description of project location. |
street |
String |
No |
Physical street address of project. |
city |
String |
No |
The city the project is located in. |
state |
String |
No |
The state or province the project is located in. |
zip |
String |
No |
The ZIP or postal code the project is located in. |
identification |
String |
No |
User specified identification (ID). |
developer |
String |
No |
Name of project developer. |
source |
String |
No |
The source of the information on the development |
notes |
String |
No |
Notes can be added to include any other pertinent |
Residential¶
If the development project is a residential only building type, additional columns are required:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
residential_units |
Integer |
Yes |
Total number of residential units. |
average_unit_size |
Integer |
Yes |
Average unit size (square feet or meters) in |
market_rate_units |
Integer |
Yes |
Total number of units that will be |
affordable_units |
Integer |
Yes |
Total number of units that will be |
affordable_program |
String |
No - Required only |
Type of affordable housing program. Must be |
own_units |
Integer |
No |
Total number of units that will be owner |
rent_units |
Integer |
No |
Total number of units that will be renter |
building_program |
String |
No |
Residential building program specific |
group_quarters |
String |
No |
If the project offers group-quarters, |
population_or_beds |
Integer |
No - Required only |
Total number of people or beds |
Non-residential¶
If the development project is a non-residential only building type, additional columns are required:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
non_residential_space |
Integer |
Yes |
Total non-residential square |
Mixed use¶
If the development project is a mixed use building type (residential and non-residential), additional columns are required that combine both the residential and non-residential attributes. Note that mixed use projects cannot have 0 or null values for both non_residential_space and residential_units:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
non_residential_space |
Integer |
Yes |
Total non-residential square |
residential_units |
Integer |
Yes |
Total number of residential units. |
average_unit_size |
Integer |
Yes |
Average unit size (square feet or meters) in |
market_rate_units |
Integer |
Yes |
Total number of units that will be |
affordable_units |
Integer |
Yes |
Total number of units that will be |
affordable_program |
String |
No - Required only |
Type of affordable housing program. Must be |
own_units |
Integer |
No |
Total number of units that will be owner |
rent_units |
Integer |
No |
Total number of units that will be renter |
building_program |
String |
No |
Residential building program specific |
group_quarters |
String |
No |
If the project offers group-quarters, |
population_or_beds |
Integer |
No - Required only |
Total number of people or beds |
Other¶
If the development project is a optional other building type (neither residential nor non-residential), additional columns are required:
Column Name |
Data Type |
Required |
Description |
---|---|---|---|
other_units |
Integer |
Yes |
Total number of generic units (e.g. hotel |
other_units_size |
Integer |
Yes |
Average unit size (square feet or meters) |
other_space |
Integer |
Yes |
Total square footage or meters of the |
building_program |
String |
No |
Residential building program specific |
group_quarters |
String |
No |
If the project offers group-quarters, |
population_or_beds |
Integer |
No - Required only |
Total number of people or beds |
Phased construction¶
If the development project utilizes the optional phased construction of unit or space over the construction duration, additional columns are required. Only market rate, affordable, non-residential space, other space, other units can be phased. The general syntax for columns follow this naming rule: “phases_[TYPE OF ATTRIBUTE]_[PHASED YEAR]” for example to phase market rate units over a two year construction period from 2011 to 2012 add the two columns: phases_market_rate_units_2011 and phases_market_rate_units_2012.
Column Name |
Data Type |
Description |
---|---|---|
phases_market_rate_units_[PHASED YEAR] |
Integer |
Total number of |
phases_affordable_units_[PHASED YEAR] |
Integer |
Total number of |
phases_non_residential_space_[PHASED YEAR] |
Integer |
Total number of |
phases_other_units_[PHASED YEAR] |
Integer |
Total number of other units |
phases_other_space_[PHASED YEAR] |
Integer |
Total number of other sqft |
AMI levels¶
If the development project has inclusionary or both affordable program unit categories, you must specify the AMI levels of units with additional columns. The general syntax for columns follow this naming rule: “ami_[AMI LEVEL]_units” for example to set two different AMI levels such as 30% and 40% for different numbers of units, add the two columns: ami_30_units and ami_40_units.
Column Name |
Data Type |
Description |
---|---|---|
ami_[AMI LEVEL]_units |
Integer |
Total number of affordable units at |