Sync DuctDefinition and Duct Feature Class Custom Attributes

Context

As stated in the topic DuctDefinition Object Class, DuctDefinition has fields that describe selected characteristics of a duct, such as size or material. The table below provides some common examples, and you can add more fields to the DuctDefinition object class for your business rules:

Eventually in typical workflows, these ducts are later added to underground facility diagrams (also known as butterfly diagrams). In these diagrams, the ducts are actual features within the Duct feature class.

So, if the end user changes the field within the ArcFM Conduit Configuration dialog (which is in the conduit feature class) or changes the field in the Attribute Editor (which is in the duct feature class), how do you ensure those changes are synced?

The application already syncs fields that have default field model names assigned. For example, the application already syncs fields that have these field model names:

DUCTAVAILABILITY
DUCTBYPASSFROM
DUCTBYPASSTO
DUCTID
DUCTOCCUPANCY
DUCTSIZE
DUCTTYPE
DUCTMATERIAL
DUCTUNAVAILABLEREASON

This topic discusses keeping custom attribute fields in sync. These are fields that do not have any of the standard field model names assigned. In short, to keep custom attributes in sync, you:

Ensure both DuctDefinition and Duct have the same custom attribute fields, including their data type.
Assign the SYNCDUCTCUSTOMFIELDSBYNAME field model name to the DuctDefinition object table fields.

Keep reading the subsequent topics to learn more.

Verify or Add Fields in DuctDefinition and Duct

The first part of this configuration is to ensure both DuctDefinition and Duct have the same custom fields. The fields must match exactly, including Name and Data Type (yes, even Integer type if applicable).

Thus, verify the fields already exist or add them.

This example uses “DuctManufacturer.” As you can see in the images below, that field is the same between the DuctDefinition object table and the Duct feature class.

DuctDefinition

Duct

Add and Assign the SyncDuctCustomFieldsByName Field Model Name

In this configuration step, you assign the SYNCDUCTCUSTOMFIELDSBYNAME field model name to the fields that should be synced.

Depending on when you first implemented the application, this field model name might not exist. If it does not, create the SYNCDUCTCUSTOMFIELDSBYNAME field model name.

To do so, follow these steps:

In ArcCatalog > Catalog Tree, right-click your database and choose Properties.
Click the Domains tab, if necessary.
Scroll down the list of domains until you find the Electric Field Model Name domain, then click it once to highlight.
At the bottom of the dialog, under Coded Values, scroll down to the bottom of the list until you find the first empty row.
Type SYNCDUCTCUSTOMFIELDSBYNAME for both the Code and the Description.

TIP: The fields do not accept a copy/paste. It looks like they do, but when you click OK, it clears them out. However, you can paste the model name in full, delete the last letter (in this case, “E”), then re-type it.
Click Apply, then OK to close the dialog. Now that you have the field model name, in the next few steps, you will assign it to the custom fields in the DuctDefinition object table.
Right-click the DuctDefinition object table, then choose ArcFM Properties Manager.
On the Field Model Names tab, assign the SYNCDUCTCUSTOMFIELDSBYNAME to the custom field (again, these steps use DuctManufacturer as an example).
Repeat with other fields, if necessary, then click OK.

Good to Know

You can assign the SYNCDUCTCUSTOMFIELDSBYNAME field model name to numerous fields.
You do not need to assign the SYNCDUCTCUSTOMFIELDSBYNAME field model name to the Duct feature class fields.
The application uses the already-assigned autoupdaters ArcFM UFM Conduit Cross Section AU and ArcFM UFM Duct to Conduit Sync AU to keep everything in sync. There is not an additional autoupdater for the synced fields.
Now, whether the end users update the attribute in the ArcFM Conduit Configuration dialog or in the Attribute Editor, these fields remain in sync.

IMPORTANT: This configuration does not sync existing fields (attributes that existed before you performed this configuration). Fields are synced only during an edit.