ArcFM Fiber Circuit Batch Healing

For the ArcFM Fiber Circuit Batch Healing tool to be able to heal circuits in bulk during non-working hours, it needs a table to store the edits that would trigger healing circuits. This is the F_FIBER_BCT table.

To create the table, follow these steps:

1. In ArcCatalog, right-click your geodatabase and choose New > Table.

2. Name the table F_FIBER_BCT. Use the same name for the Alias.

   IMPORTANT: You must name the table F_FIBER_BCT, and it must be all uppercase.

3. Click Next.

4. Add the following fields as shown in the table. The Field Names must match the names as shown in the table exactly, including their casing.

   Field Name	Data Type	Length	Notes
   OBJECTID	Object ID	N/A	The application provides this field by default.
   BATCH_HEAL_CIRCUIT_NAME	Text	The Length must be long enough to hold your longest circuit name + longest version name + 2 more characters. So, 255 is likely large enough, but you should verify your Circuit Name length and typical version name length.
   BATCH_HEAL_CIRCUIT_GUID	Guid	N/A
   BATCH_HEAL_SOURCE_VERSION	Text	The Length must be long enough to hold your longest version name. Version names follow the syntax of Owner.VersionName, for example, “SDE.VersionA.” So, 255 is likely large enough, but you should verify your typical version name length.
   BATCH_HEAL_PARENT_VERSION	Text	The Length must be long enough to hold your longest version name. Version names follow the syntax of Owner.VersionName, for example, “SDE.VersionA.” So, 255 is likely large enough, but you should verify your typical version name length.
   BATCH_HEAL_ACTION	Short Integer	N/A	You must add a Default Value of 0 for this field.

5. Click Finish.

6. Do not register the table as versioned.

7. Do not convert to use ArcFM objects.

8. Right-click the F_FIBER_BCT table and choose Manage > Privileges.

9. The Users/Roles that make changes to circuits in your system must be able to write to this table. Further, the User/Role that you employ to run GDBM must also be able to write to this table. Thus, ensure the Users/Roles that make fiber edits in ArcMap and the User/Role that runs GBDM are granted full privileges (Select, Insert, Update, and Delete) to the F_FIBER_BCT table.

   IMPORTANT: You should also confirm the same permissions are set for the F_FIBER_BCT table in your relational database management system (SQL Server, Oracle, etc.).

10. Click OK.

Instead of Fiber Manager attempting to heal circuits in real time during edits, reconcile, or post, you can change the settings to have Fiber Manager record any edits that trigger a circuit heal in a separate table. Then, you can run a batch process to heal those circuits at a time that won’t affect performance (for example, at night during non-working hours).

To change the behavior of circuit healing, follow these steps:

1. In ArcCatalog, click your geodatabase once to highlight it.

2. On the ArcFM Solution toolbar, click the ArcFM Fiber Settings tool.

   TIP: Do you not see the tool? You need to add it to the toolbar. Go to the Customize Menu > Customize Mode > Command Tab > ArcFM Solution Category. Find the ArcFM Fiber Settings tool, and click and drag it onto the ArcFM Solution toolbar.

3. Check both options to turn off circuit healing.

   

4. Click OK.

System vs. User Settings

Changing the settings as described above is required for GDBM. GDBM looks to the Fiber System Settings for configuration guidance.

Typically, the Fiber User Settings in ArcMap match the Fiber System Settings in ArcCatalog. However, in ArcMap, end users can change these same circuit healing settings in the Fiber User Settings. This could be beneficial if the end user is performing small-scale or minor edits that affect just a few circuits. By temporarily turning the settings off, they can fully complete their edit session, including healing circuits.

With the F_FIBER_BCT table created and circuit healing turned off during ArcMap edits, reconcile, and post, what is the editing experience like in ArcMap?

In short, it is essentially the same as before.

• The end user still receives all normal messaging and feedback from Fiber Manager while editing.

• The key difference is that while they are editing, if any edit calls for a circuit to heal, instead of healing in real-time, a record is created in the F_FIBER_BCT table.

• Later, the administrator configures a time to process the records stored in the F_FIBER_BCT table. Keep reading the next topic to learn more.

As stated, above, the F_FIBER_BCT table records edits that call for a circuit to heal. This topic explains how to process those records.

1. Open ArcCatalog, and in the Catalog Tree, find your geodatabase.

2. If this is your first time using the ArcFM Fiber Circuit Batch Healing tool, you need to add it to your ArcFM Solution toolbar. If you have already added it, you can skip to the next step.

   1. Click the Customize Menu > Customize Mode.

   2. Click the Command Tab.

   3. For Category, click ArcFM Solution.

   4. Under Commands, find the ArcFM Fiber Circuit Batch Healing tool, and click and drag it onto the ArcFM Solution toolbar.

   5. Close the Customize dialog.

3. In the Catalog Tree, click your geodatabase once to highlight it.

4. On the ArcFM Solution toolbar, click the ArcFM Fiber Circuit Batch Healing tool.

5. The dialog appears.

   

   • The top of the dialog is where you set the Start and Stop time.

     • The reason for the Stop time is to coordinate your processes with GDBM. You do not want the ArcFM Fiber Circuit Batch Healing tool running at the same time as GDBM. If you do, both applications lock versions while trying to process edits, and they block and conflict with each other. In short, ensure your healing times do not overlap your GDBM processing times.

   • The left side of the dialog displays all the circuits that require healing. These are the records as found in the F_FIBER_BCT table.

     • Notice the names are a concatenation of the Version name and the Circuit name.

   • The middle of the dialog has right and left arrows. After selecting (or multi-selecting with Ctrl and Shift), these arrows let you move circuits from one side of the dialog to the other.

   • The right side of the dialog displays the circuits that are going to be healed or deleted when the batch process runs.

     • As seen in the image above, when you move circuits into the right side, they do not leave the left side. Only after they are healed do they leave the left side.

     • In standard company workflows, almost all circuits are healed or re-calculated with this tool.

     • A circuit is deleted only if the circuit’s header was deleted in ArcMap. In this edit scenario, the circuit cannot be healed or re-calculated since its origin point no longer exists. Thus, it is deleted.

6. Set your Start and Stop time. As stated above, ensure it does not overlap the time that GDBM runs.

   • Your Start time must be before your Stop time. So, if you want to run the tool presently, leave the Start time alone and change the Stop time to a future time.

7. Use Ctrl and Shift (or click and drag) on the left side to highlight circuits you want to include in the batch.

8. Click the right arrow to move them to the right side.

9. Click Run.

   • If you scheduled the batch to process later, notice the dialog states, “Waiting to begin.”

   • If you chose the current time, the dialog starts processing the circuits. The Progress bar provides updates.

10. Whether you scheduled the tool to run later or it is running currently, leave the dialog open. It needs to stay open to continue to heal or re-calcualte the circuits.

When the tool is finished, it displays completion information.

If the tool was unable to heal a circuit, that circuit remains in the dialog and it turns red. View the miner logs to see more information about the error the tool encountered.

The final part of configuring ArcFM Fiber Circuit Batch Healing is to add the appropriate Action Handlers for the Version Processing > Reconcile Process and Post Process in GDBM.

To add the ArcFM Fiber Circuit Batch Healing Action Handlers, follow these steps:

1. Open GDBM.

2. Under Available Services, click the desired service.

3. Click the Version Processing tab.

4. For Reconcile Process:

   1. Expand Reconcile Process.

   2. You are about to add Action Handlers (or verify they already exist). For all Action Handlers, the Action Name is up to you, and they require no Parameters. For more information about what each Action Handler does, see the topic Action Handlers in the Desktop Configuration Guide.

      • For Before Reconcile, add the Fiber Circuits Before Reconcile Action Handler.

      • For After Reconcile, add the Fiber Circuits After Reconcile Action Handler.

        

5. For Post Process:

   1. Expand Post Process.

   2. Expand Plain Version.

   3. Expand the Post Type (this likely already exists, but if not, see the Geodatabase Manager help topics).

   4. You are about to add Action Handlers (or verify they already exist). For all Action Handlers, the Action Name is up to you, and they require no Parameters. For more information about what each Action Handler does, see the topic Action Handlers in the Desktop Configuration Guide.

      • For Before Reconcile, add the Fiber Circuits Before Reconcile Action Handler.

      • For After Reconcile, add the Fiber Circuits After Reconcile Action Handler.

      • For Before Post, add the Fiber Circuits On Before Post Action Handler.

        

6. Click Apply.

7. Click OK if you are done configuring GDBM.