Right of Way Management

Accela’s Right of Way Management (ROWM) solution has been integrated with Civic Platform. The Right of Way Management solution enhances communication between agencies, utility companies, and citizens. Configuring and using Right of Way Management is discussed in this section.

Note: The implementation of the Right of Way Management solution requires an Accela Delivery Consultant. This section contains content useful for an Accela Delivery Consultant as well as Civic Platform users.

The integration configuration described in this section may first produce a potential conflict based on a temporary record from Civic Platform (including Citizen Access) sent to ROWM to query the ROWM database of existing records. Any potential conflict identified triggers the Condition configured in ROWM Integration, i.e., conflict detection. An actual conflict does not exist in ROWM until the Civic Platform record is created for example, during a permit submission. As the implementer, this process should be understood in the event it may affect any of the customer’s processes also being configured. While the integration can be applied to various types of objects in ROWM, i.e., records in Civic Platform, this section references a permit in both systems.

Topics:

General Information

For the data exchange in ROWM Integration, the real-world Organization involved in a configuration must exist in the core ROWM system and have a configuration in the ROWM Integration Hub. If ROWM is only being used as a tool for conflict detection, as best practice, Delivery should have a standard basic core ROWM configuration for record types available to minimize the level of effort for this part of the overall configuration.

The Organization Code in the core ROWM system is used during this configuration.

If an Organization already exists in Public Web for a Citizens View or ROWM Online Permitting portal, use that existing information.

Users

A permit applicant in Land must also exist in ROWM as a contact. Otherwise the record is not be created in ROWM and thus a Related Record is not be created in Land.

Types

A record type in Civic Platform must have a corresponding object type in ROWM. The following was configured in the reference example.

In the above example:

  • ROWM Permit Type ID = AA_Excavation
  • ROWM Permit Type Display Name = Excavation

In the above example:
  • CP Record Type = Permits/Excavation/NA/NA
  • CP Record Type Alias = General Excavation

Notify Remote Subscription Systems

The Civic Platform data transferring to any of the ROWM solutions (core ROWM system, Citizens View, ROWM Online Permitting) must be defined in the Notify Remote Systems Subscriptions. This must be configured by a user in the core ROWM system with access to System Administration.

IN ROWM navigate to System Admin > Organizations > Edit > Notify Remote Systems Subscriptions.

The definition may be as general as the record type for example, permit or specific sub-sets of a record type, for example, Excavation permit.

By including conditions, this definition may also be further refined in addition to the record type structure, such as using Status for example, Planned, Started, Submitted for Review. Placed in the optional bottom field shown in the dialog box, these are defined the same as a ROWM custom rule, for example, MVEL or JavaScript.

ROWM Integration Hub

The ROWM Integration Hub is tool used for the exchange of data between systems of the Civic Platform and ROWM. There are different settings required for setting up a sales demo environment for Accela Delivery and setting up a customers production environment. The headings in this section such as Hosts and Orgs are the name of a section in the Integration Hub that must be completed.

Standard Choices in Civic Platform require information that matches values used in the ROWM Integration Hub in order to configure conflict detection from Citizen Access and the back-office for Phase 2 ROWM Integration. Customer specific values must be confirmed with Accela Delivery.

Hosts and Orgs

For demonstration environments, for example, SC clouds, use the values as described below.

Host System ("Hosts")
  • Name =Cloud11_AA
  • Address Type=AA_CONSTRUCT
Organization ("Orgs")
  • Name=cloud11
  • Description=Chris Cirello's cloud

For customer environments (for example, ROWM Production)

Host System (“Hosts”)
  • Name = ACCELA-ROW-AGENCY-PROD
  • Address Type = ROW
Organization (“Orgs”)
  • Name = ROWM Org ID (for example, “S_ORG_KY_Lexington”)
  • Description = ROWM Org Name (for example, “Lexington KY”)

Delivery Path

For Demonstration Environments (for example, SC clouds)

Origin
  • Host System = Cloud11_AA
  • Organization = cloud11
Destination
  • Host System= ROW-AGENCY-SALESDEMO
  • Organization = DEMO_CITY

For customer environments (for example, ROWM Production)

Origin
  • Host System = TBD
    Note: Source of data to be defined per Customer. Currently, no common Host for all Customers.
  • Organization = ROWM Org ID
Destination
  • Host System = ACCELA-ROW-AGENCY-PROD
    Note: With a minimal number of Customers, this is the current configuration. As a best practice, a separate Host should be defined for each customer since a single customer may have multiple Organizations (i.e. ROWM Org IDs) configured for their use in the core ROWM system.
  • Organization = ROWM Org ID

For All Environments

Origin > Pickup Addresses

  • Event
    • Create two entries for each record type involved
      • record created
      • record updated
  • Data Type
    • Match the record type in the CP with a dash (“-“) in between each level of the record type definition: “Permit-Excavation-NA-NA”
  • Is Regex
    • Leave this box unchecked

Destination > Delivery Addresses

  • Data Type
    • Object type in ROWM (for example, permit)
  • HTTP
    • POST
  • API
    • /rest/data/v1/DEMO_CITY/createOrUpdateRecord

Delivery Paths

  • No Delivery Path needs to be defined for this effort

Configuring Right of Way Management in Civic Platform

Configure the following Standard Choices to integrate Right of Way Management with Civic Platform. The configuration of all three Standard Choices is required to enable conflict notification and detection.

ROWM_INTEGRATION

The Standard Choice ROWM_INTEGRATION is new and available with this release. Configure this Standard Choice to integrate the ROWM API with Civic Platform. After you configure this Standard Choice when you subsequently create a record type with Right of Way Management as the category, a record is created automatically with a link to the Right of Way Management site. This Standard Choice is used by both Civic Platform and Citizen Access.

  • Status - Select Enable
  • Type - Select System Switch

Add the required Standard Choice values.

Standard Choice Value Value Description
DISTANCE Numerical distance value
ROWM_API_SYSTEM_NAME Name of agency system
ROWM_API_URL Agency URL
UNIT Unit of measure for distance

Values in this Standard Choice (ROWM_API_SYSTEM_NAME and ROWM_API_URL) must match values from the ROWM Integration Hub used for this data exchange. The following provides example values.

For this Standard choice, the ROWM_API_SYSTEM_NAME value shown above as Cloud11_AA. This value is the Host System Names used in the ROWM Integration Hub.

For this Standard Choice, the ROWM_API_URL value shown above is:

https://salesdemo.envista.com/envista-public-web/rest/data/v1/CLOUD11/permit/{RECORD_ID}?systemType=AA_CONSTRUCT&systemName=Cloud11_AA&includes=properties,exchangeSystems,contacts,relations

URL Value Description
salesdemo.envista.com This value is for Demonstration Environments only. Customer Production Environments will replace this with: pap.accela.com
CLOUD11 This is the name of the CP environment; note all upper case
permit The Civic Platform record type/ ROWM object type used; note all lower case
AA_CONSTRUCT This value is the Host System > Address Type used in the ROWM Integration Hub.
Cloud11_AA This value is the Host System Name used in the ROWM Integration Hub

ROWM_CONDITIONS

The Standard Choice, ROWM_CONDITIONS is new and available with this release. Configure this Standard Choice to notify the user that a conflict exists on a date and location they applied for a permit or event. This Standard Choice is used by both Civic Platform and Citizen Access.

  • Status - Select Enable
  • Type - Select System Switch

Add the required Standard Choice values. The Standard Choice Values in the following table are provided as examples and are customizable by your agency.

Note: The mapping values for this Standard Choice element are: The Standard Choice Value = Right of Way Management Event, Activity Type; Value Description = Civic Platform Condition Type.
Standard Choice Value (Right of Way Management) Value Description (Civic Platform)
Building Permit Building Permit Notice
Communication Communication - Event
Music Music - Event
Roadway Roadway
Sanitary Sewer Sanitary Sewer Required
Water Water - Project

For the configuration to provide feedback to a user in Citizen Access or the back-office that a conflict has been identified, a Condition must be defined and applied to the Civic Platform environment. No standard Condition for conflict detection is available at the time of this writing. Therefore, the Condition must be created specifically for the integration in this Civic Platform environment.

Phase 2 ROWM Integration allows for a Condition (Notice, Hold, or Lock) to be created for as many variations of conflict detection as desired for the configuration i.e., a separate Condition for every record type if necessary.

The Condition this document references is ROW_Conflict as shown below.

For the configuration of this Standard Choice, the Standard Choices Value shown above is shown as AA_Excavation. This value is the ROWM Permit Type ID used in the ROWM core system.

Creating the Condition may be completed in Classic Administration Admin > Condition > Condition Type as shown below.

From here you can create a new Condition Type or select an existing Condition Type by using the dropdown menu. This includes a Description that may be appropriate for configurations with numerous notices for different types of conflicts. Select Status for the Condition Type’s availability.

Navigate to Admin > Conditions > Std Condition to create a new Condition Type and Condition Name, or search for an existing Condition Type or Condition Name, then select from the results.

When selected by the Condition Name, you can add a new Condition Type and Condition Name.

Creating the Condition may be completed in the Civic Platform v360 by navigating to Administration > Conditions > Conditions as shown below.

Minimum requirements for establishing the Condition for conflict detection are as follows.
  • Condition Type – if not existing
  • Condition Group – if not existing or set to Default
  • Condition Name
  • Severity – Lock, Hold, Notice
  • Short Comments (Default Comment in Classic Admin) – message to display to users
  • Status – Enabled or Disabled
  • Display Notice – select where to show the Condition
  • Record Type – select the record type(s) to associate to the Condition
More information on Managing Condition Groups and Conditions is available in Community.

LOCATION_TYPE

The Standard Choice, LOCATION_TYPE is new and available with this release. Configure this Standard Choice to specify a specific location for the event or permit. The Standard Choice Values provided in the following table are exact values and should not be modified. This Standard Choice is used by both Citizen Access and Civic Platform.

  • Status - Select Enable
  • Type - Select System Switch

Add the required Standard Choice values.

Standard Choice Value Value Description
Address Address
Intersection Intersection
Street Segment Street Segment

Configuring Right of Way Management Template in Civic Platform

To implement the Right of Way Management solution, configure the ROWM TEMPLATE. Configure this template to specify the pre-defined event start date and event end date for a specific event. These dates are used in checking for potential event conflicts.

Note: If this template does not exist, you must add it. Once added, ensure that the template is associated to the Attribute Type of Address as highlighted in the graphic below.
  1. In the Civic Platform Classic UI navigate to Administrator Tools > Property > APO Template.
  2. In the Attribute Template Name field, enter ROWM TEMPLATE and click Submit.
  3. Click the red dot to the left of ROWM TEMPLATE.
  4. Click the red dot to the left of the ROWM TEMPLATE to select it.

  5. Click the red dot to the left of Event Start Date or Event End Date to edit attributes.

Mapping Right of Way Record Types between Civic Platform and the Right of Way Management site

Each record type on the Civic Platform side must have an equivalent record type mapping on the Right of Way side. This Record type mapping equivalency is performed by an Accela Delivery Consultant.

Viewing Right of Way Management Records in Civic Platform

When you create a Record in either Citizen Access or Civic Platform mapped to a Right of Way Management Record, the Record is created automatically with a link which allows access to the Right of Way Management solution. Users may then view Right of Way Management details by clicking on the link in Civic Platform.

  1. Go to the Records portlet in Civic Platform.
  2. Look up the Civic Platform Record with the related Right of Way Management Record.
  3. Click the Related Records detail tab.
  4. Click the link under ROWM Detail.

  5. Log in to the Right of Way Management site to view Right of Way details for the Record.
    Note: The staff user will need valid credentials to access the Right of Way Management solution.