Connection Cleanup Tool

The Connection Cleanup tool (CCT) improves performance by fixing or deleting invalid connections.

It looks for orphaned records in object tables (records that no longer have a parent record), then either repairs the orphaned records based on identified implied connection relationships or the orphan's connectable objects, or if a repair is not possible, it deletes the appropriate parent and child records. There are two ways in which the tool repairs orphaned records:
- Identified Implied Connection: This is the most common method. When an orphaned record is part of an implied connection relationship, all objects must have the same parent. So, if the tool finds one that is orphaned, it looks through the implied connection relationship to get the other objects involved. Then, it checks to see if the related object has a parent. If the related object does have a parent and that parent still exists, then the tool re-parents the orphan to that same parent.
  - For example, if there is a 1 x 8 splitter, and the parent information is deleted from the 8 output ports (but the actual parent object was not deleted), the tool can see that the 8 output ports have an implied alignment with the input port. The tool can then find the parent of the input port and assign that as the parent of the 8 output ports.
- Orphan's Connectable Objects: In this method, a child object’s information in the F_FIBERCONNECTIONOBJECT table can be used to fix missing information in an “upper-level” object.
  - For example, let’s take the case of a rack missing its FiberParent information. The tool can check if the rack’s child objects (such as a back port or front port) has a connection in the F_FIBERCONNECTIONOBJECT table. If so, the tool takes the value found in the ContainerGlobalID field for that child object and uses it to fix the FiberParent field in the rack.
It looks for “unpaired” connections (connection records that do not have two “sides,” or in other words, are not connected to anything), then deletes the connection records.
If a circuit is affected, its child objects are deleted or recalculated as needed.
- In the CCT’s registry key, there is a string called “SkipCircuitRebuild.” This key is set to “1” by default.
  - SkipCircuitRebuild Set to 1: The tool skips the circuit rebuild process. For example, if a BackSidePort is the header for a circuit, and that port loses its attribute for FiberParent, the CCT deletes the connection information associated with the port and it deletes the port record itself. But, it does not delete the circuit.
  - SkipCircuitRebuild Set to 0: The tool does not skip the circuit rebuild process. Using the same example as above, not only does the CCT delete the connection information and the BackSidePort record, it also deletes the circuit (because the header for that circuit was deleted).

If the application was properly configured from the beginning of your implementation and if users have been editing with the proper Fiber Manager tools, there should not be anything to clean up. Invalid connections are sometimes created if the application is not properly configured. For example, if the ArcFM Fiber Object Deleted Autoupdater was not configured for certain features, there could be orphaned records as fiber facilities were deleted in your database. Or, if users improperly deleted or split fiber facilities without using ArcFM/Fiber Manager tools, there could be invalid records.

IMPORTANT:

Before using this tool, back up your database.
This tool is hidden by default and must be first unlocked with a “key” from Support. Contact your Support representative to attain this key and discuss this tool. Your Support representative can also discuss fiber availability count options that can be recalculated with the tool at the same time it is deleting invalid records.
Run this tool first in an Esri version. After running the tool, perform your own QA/QC to validate that only expected records were deleted. This version is not used to reconcile and post the changes to the default (the number of records could be too voluminous for the post process). Instead, this test version is discarded, then you re-run the tool against the default version of the SDE database.
This tool should only be run by a database administrator and used with extreme caution. It deletes records as it runs, and therefore, you cannot cancel, undo, or back out of the operation once it has started.
Given the size of the database, this tool could run for several hours.

Although this is an administrative tool, you run it in ArcMap. Use Customize Mode to add the tool to your toolbar.

To use the Connection Cleanup tool:

Read all the points under the “Important” note above.
Create an Esri Version.

IMPORTANT: Even though you are in a version, there is no way to undo or back out of the operation once it starts. The Connection Cleanup tool saves its changes while they are made.
Click the Connection Cleanup tool.
1. If you have pending edits, you are prompted to save or discard them.
In the confirmation dialog, which states the operation cannot be undone, click Yes.
A dialog appears once complete. Use Windows Event Viewer to see the log file of the items that were processed. Ensure these items match your expected results.
Optionally, you can run the tool again within the same version to validate the results further. If the tool ran successfully, there should not be any new records discovered in the second pass. If new records were discovered, you should investigate them.
After validating the results, discard the version.
If you have not already, back up your database.
Repeat these steps against the default version of the SDE database.