Distribute ArcFM Viewer Customizations

Commands, Controls and Dockable Windows

Once you've developed a customization (e.g., command, dockable window), it may be distributed by an administrator to other users. The ArcFM Engine Administrator makes this task easy. This tool allows you to add commands, dockable windows and extensions. Adding these customizations are discussed in the individual sections for each. Once you've added your custom tools, you can distribute the Master.custom.layout file to distribute the changes to other users.

If you've created a custom MDI tab or toolbar, follow the steps at the end of this section.

Open the ArcFM Engine Administration tool and add custom tools on the Layout and Licenses tab.
Click Apply to save changes.
Click Export to save a Master.custom.layout file. This file contains all commands, dockable windows and extensions loaded into your ArcFM Engine application (not just your custom tools), as well as login and licensing information.
Copy this exported Master.custom.layout to the ArcFM Solution\Bin\Addons\ArcFMViewer directory for every computer to which you want to distribute the changes. It is a good idea to first archive the existing Master.custom.layout file before copying the new version.
Copy your custom DLL files into the ArcFM Solution\Bin directory for each computer to which you want to distribute the changes.

MDI Tabs and Toolbars

Custom MDI tabs and toolbars cannot be distributed using the ArcFM Engine Administrator. Instead they must be distributed using custom layout XML files. You may create a single custom layout file or multiple files. However every custom layout file MUST have a file name that ends with ".custom.layout" (e.g., ArcFMViewer.custom.layout).

Instructions for adding your custom MDI tab or toolbar to your custom layout XML are described in the MDI tab and toolbar sections.

Once your custom layout file(s) are created, you may place them in one of the following locations depending on how you want to implement the tools.

ArcFM Solution\Bin\Addons: The elements in custom layout files placed in this directory are available to all ArcFM Engine applications (.exe) that reside in the Bin directory (e.g., ArcFM Viewer, any custom applications built with ArcFM Engine). You may have to create this directory if it doesn't exist.
ArcFM Solution\Bin\Addons\ArcFMViewer: The elements in custom layout files stored in this directory are available only in ArcFM Viewer for ArcGIS Engine. You may have to create this directory if it doesn't exist.

It is wise to retain back-up copies of all custom layout files. You may append future customizations to a single custom layout file.