Sample - Add Reference Design

Version 5

    Versions: 9.3 - 10.1

    Product Availability: ArcFM Desktop (Designer)

     

    This cool tool allows you to view a reference design in your map when you have another design open for editing. Once the reference design is open, you can see the features displayed in the map, but the corresponding CUs are not listed on the Design tab. The Design tab displays only the CUs you've added to the currently edited design (not the reference design). The Add Reference Design tool does allow the user to display multiple reference designs. This tool will not work on an Access or file geodatabase.

     

    Step 1: Create Layer Files

    The Add Reference Design tool uses predefined ArcMap layer files that have been created with the appropriate symbology, scale suppression, labeling properties, etc., to show referenced version data.  These files need to be created using the ArcMap application.

    1. Load the desired data into ArcMap. This can be from an existing stored display or by adding feature classes directly. The feature classes need to be from the same geodatabase that will be used by Designer. Also, the data needs to be referencing the SDE.DEFAULT version.
    2. Change the properties of any relevant layers (e.g., symbology, labeling, etc.) to reflect the desired properties of referenced data.
    3. Save these layers to layer files by right-clicking on them in the ArcMap Table Of Contents and selecting Save As Layer File. Multiple layer files may be created, or reference layers may be added into a single group layer and then the group layer saved as a layer file. You can save these layer files in one of two places:
      • Anywhere you'd like, but you'll need to set a configuration value in the Process Framework Administration tool that points to the location of the layer files (step 4). This method should be used if a single set of layer files will be referenced from a location on the network. This path must be navigable by all clients, so if it references a mapped network drive, the same mapping must apply to all clients using the Add Reference Design tool.
      • The Layer Files subdirectory in the Telvent Add Reference Version installation path. For example: C:\Program Files (x86)\Telvent\Telvent Add Reference Version\Layer Files.
    4. Optional. Open the Process Framework Administration tool and select the Configuration tab. Create a value called ReferenceDesignLayerFilePath and set its value to the path to the layer files created in step 3.

    AddReferencePX.png

    The Add Reference Design tool is able to use layer files from three possible locations.  The tool will look for layer files in the following order:

    • The location specified by the ReferenceDesignLayerFilePath configuration value in the Process Framework Administration tool.
    • The Layer Files subdirectory in the Add Reference Version installation. For example: C:\Program Files (x86)\Telvent\Telvent Add Reference Version\Layer Files.
    • If the ReferenceDesignLayerFilePath configuration value doesn’t exist and the Layer Files directory is empty, the Add Reference Design tool will prompt the user to locate the layer files.

    Step 2: Compile the Sample

    Open AddReferenceVersion.sln and compile the solution. A post-build event runs RegX.exe on the DLL. If you wish to distribute the DLL to other machines, place it in the ArcFM Solution\bin directory and run RegX.exe.

    The Add Reference Design tool may be accessed as a command button in ArcMap.  This command may be added to the application using Customize Mode in ArcMap. The Add Reference Design tool resides in the Telvent Add Reference Version category.

    AddReferenceCustomize.png

    Step 3: Configure Subtasks (Optional)

    This  project offers two subtasks that may be used in conjunction with the Add  Reference Design tool.

    • Swizzle Reference Design Layers: This subtask will point the data sources of Reference Design layers that have been saved in a design stored display back to the version of the design that was referenced.  If this subtask is not used, then any Reference Design layers that have been saved into a design stored display will be pointed to the current design version when the design is reopened (these layers will need to be removed and added anew if needed).  This subtask should be configured as the last subtask on the Open Design task (after the Open Design subtask).  If you do not use Design Stored Displays, then this subtask is not necessary.
    • Remove Reference Design Layers: Use this subtask to remove any Reference Design layers when you close the design. This may be useful for returning the ArcMap environment back to a “standard” state.  This will also prevent these layers from being included in any design or session that is subsequently opened. If a design has been saved with the Reference layers present (and you use Design Stored Displays), then the Reference layers will be intact the next time the design is opened. Configure this subtask on the Close Design Task (after the Close Design subtask).

    OpenDesign.png

     

    Step 4: Use the Add Reference Design Tool

    The Add Reference Design tool must be added to a toolbar from the Customize dialog. It resides in the Telvent Add Reference Version category on the Commands tab.

      1. Once you have opened the design you wish to edit, click the Add Reference Design tool.
      2. This displays the Add Reference Design window. In the top portion, select a work request. In the bottom portion, select a design.
      3. Click OK.

    AddReferenceDesign.png