Linking Reference Entities to a Permit

Depending on agency setup, you can link permit transactions to agency-defined reference entities, such as buildings.

You must have reference entities configured for your agency to link your permits to the reference entities. After your agency defines different reference entities by type, and further differentiates them by category and subcategory, you can reference the entities as part of a permit application. For example, your agency might administer commercial building permits forbcampuses with multiple buildings. By setting up reference entities for buildings, your agency can collect information about the buildings, such as floors and stairwells. For more information, see Reference Entity Overview.

This example illustrates the page on which you can link reference entities to a permit on the intake form set up to support reference entities.

Example of the Reference Entities tab on a permit application intake form

Once permits are linked to reference entities, you can maintain the reference entities for each permit application and copy associated reference entities when you make duplicates of the permit application. The reference entity details that your agency collects are saved as part of the permit history.

Linking reference entities to the permit allows the linked reference entities to be selected when creating an inspection, if the reference entities are marked as inspectable in the agency setup.

Linking Reference Entities During Application Intake

On the Reference Entities tab in the permit application intake form, click the + Link (add link) button. On the Link reference entities drawer, you can search for and select from the available reference entities. Click Add on the drawer to associate the reference entities with the permit you are working with. Once you submit the application, the reference entities are listed on the Reference Entities page in the permit application details.

You can remove the link to a reference entity by clicking this icon in the Actions column: Unlink reference entity icon.

Linking Reference Entities After Application Submission

Once an application is submitted, only authorized agency staff can manage the reference entities linked to a permit.

On the Reference Entities page in the permit application details, agency staff can click the + Link (add link) button. On the Link reference entities drawer, you can search for and select from the available reference entities. Click Add on the drawer to associate the reference entities with the permit you are working with.

Agency staff can remove the link to a reference entity by clicking this icon in the Actions column: Unlink reference entity icon.