Starting with ArcFM 10.0.3, CU Referencing was introduced to simplify the management of compatible units (CUs) and CU favorites. This changed the process for managing CUs. CUs are now managed in the CU Admininstration Tool. CU favorites are still managed in the ArcFM System Favorites Manager.
Note: Many customers have automated processes and applications to manage CUs in this new environment. Check with your administrator to see if there is an implementation at your site.
Follow the steps in this guide to add new CUs to the library and favorites in this new environment.
1. Add the new CU to MM_CU_LIBRARY and related tables using the CU Administration Tool in ArcCatalog
1. Start ArcCatalog.
2. Connect to the SDE database as the SDE user.
3. Add the CU Administration command to a toolbar if not already present.
4. Select the SDE connection in the Catalog Tree.
5. Click the CU Administration command icon.
6. Select the Manage CUs tab.
7. Click on the Create New button.
8. Choose the feature or object class and subtype for the CU. Enter a unique WMS code for the CU. Select <None> in the Feature/Object Class field to create a non-spatial (or non-GIS) CU.
9. Click Continue.
10. Fill in the fields in the right panel to distinguish this CU from others.
- Name: Name of the CU shown in the CU tab in the Table of Contents and CU Filter in ArcMap.
- Description: Short description that shows in parentheses next to the name in the CU tab, Design tab and CU Filter.
- Available Workfunctions: Work functions that are allowed for this CU. Controls whether the CU is listed when the Work Function in dropdown list is changed.
- Workflow Status: Usually set to None.
- Work Function: Usually left on Install, but can be set to a default such as Remove.
- Units of Measure: Value from the ID column for the units of measure in the MM_WMS_UNITS_OF_MEASURE table in the Workflow Manager database.
- Extended Data: Preset the Site Conditions for the CU. Defined in the Extended Data Manager (EDM) configuration.
- Defining Attributes: Preset the values for fields that were set to be CU Defining Attribute fields in ArcFM Properties.
11. Click Save. The CU will be added to the MM_CU_LIBRARY table, and if configured, Extended Data will be saved to MM_CU_EXTENDED_DATA, and Defining Attributes saved to MM_CU_ATTRIBUTES.
12. Click the red x in the upper right corner to close the Compatible Units Administration window. A Synchronize CU changes dialog will appear. In this case, a new CU was just created so there won't be any favorites to update. Click NO.
Now that the new CU has been created, it could be used in a design. But it will only be available in the CU Filter under Compatible Units. It will not be available in the CU tab of the ArcMap Table of Contents. Everything in the CU tab is a favorite, so the new CU will not be available here until a favorite is created from it. The next section describes how to create a favorite.
2. Create a favorite using the new CU in the ArcFM System Favorites Manager
Now that the new CU is in the library, it can be added to folders and favorites so they will show up in the CU tab of the Table of Contents in ArcMap, and in the CU Filter.
1. Start ArcCatalog.
2. Connect to the SDE database as the SDE user.
3. Right click on the connection and select ArcFM Favorites, or select the heart icon from the ArcFM toolbar.
4. Select the Compatible Units tab in the ArcFM System Favorites Manager dialog.
5. Select an existing folder or create a new folder by right clicking on the root folder or any other folder and selecting Create Favorite Category.
6. Right click on the folder and choose Create Favorite to create a favorite for the CU.
7. Choose the Feature/Object class and subtype that this favorite will create or place on the map to match the CU just created.
8. Give it a name, description and set any attributes to be automatically filled in when this favorite is created or placed on the map.
9. Click Apply.
10. To create a favorite that includes child units:
- Repeat the process by right clicking on the folder and choosing Create favorite.
- Pick the related child unit table and subtype to create child records for. Set attributes to the desired preset values, click Apply, then Create.
- Close the editor window.
- Drag and drop the child favorite under the parent favorite that was just created. To create multiple child favorites with the exact same preset attributes, right click the child favorite and choose Copy. Then right click on the parent favorite and choose Paste. Repeat the Paste process for any additional copies.
- Right click on the same folder this favorite is stored under and choose Add CU. This brings up the entire 10.x library list. Use the search option to find the CU by the name of the CU.
- Select the CU to add and click OK. This adds the CU to the folder. Drag and drop the new 10.x CU to the correct, matching favorite. Copy and paste may also be used if multiple copies of the same CU are required for multiple child favorites.
11. Click Apply and OK to save the edits in the ArcFM System Favorites Manager dialog.
3. Add the CU and labor cost data to the Workflow Manager tables
The CU and labor cost data must be added to the required Workflow Manager tables before the CU can be used in a design. This can be done using SQL insert statements in Microsoft SQL Server or Oracle, or by editing the attached XML file and importing it in the Process Framework Administration Tool. Choose one of the methods below to add the data.
To add the CU using the Import facility in the Process Framework Administration Tool:
- Save the attached wfmcu.xml file to a folder on the local PC.
- Edit the file.
- Change the <WMS_CODE> to the CODE value used to create the CU above.
- Change the <DESCRIPTION> to match the description used when the CU was created above.
- Change the <MATERIAL_COST> and <SCRAP_VALUE> for the CU.
- Change <GIS_SYMBOLIZED> to reflect whether this is a symbolized or non-symbolized CU.
- Set <UNITS_OF_MEASURE> to the CODE and VALUE in MM_WMS_UNITS_OF_MEASURE.
- Add or remove <LABOR_COST> sections to match the required work functions for the CU. These should match the work functions that were set for the CU when it was created in the CU Administration tool. See the MM_WMS_WORK_FUNCTION fields below to set APPLY_SCRAP and APPLY_MATERIAL. Note: If there is a work function in the XML that does not exist in MM_WMS_WORK_FUNCTION yet, it will be added. However, the import of the CU will fail. To work around this, select File > Save, then import the XML again.
- Select File > Save.
To add the CU using SQL statements:
This table contains all of the CUs available in Designer. Add a row in this table with the same information used when the CU was created in the CU Administration tool above. Note: Make sure the CODE field matches the CODE that was used in the new CU that was created above.
A primary key for the CU. This field also acts as a foreign key for the MM_WMS_COMPATIBLE_UNIT table and MM_WMS_LABOR_COST tables.
The code used to identify the CU and its work function (e.g., PW40-1 = pole wood 40ft class 1). This value must exactly match the CODE for the CU as it appears in the CU Administration tool.
A description of the CU (e.g., pole wood class 1 40ft).
The dollar amount associated with purchasing this particular CU.
The dollar amount associated with scrapping the CU when it is longer in use.
This field refers to the ID field of the MM_WMS_UNITS_OF_MEASURE table.
Indicates whether the CU is symbolized or non-symbolized. 0 = not symbolized; any other value = symbolized.
This table is used to calculate the costs associated with a design. Cost is assigned based on the CU and the work function. A separate row is required for each work function for the same CU_ID that you want to have labor costs for. Example: if the CU can be Installed as well as Removed then two rows with the same CU_ID but with different WORK_FUNCTION_ID (one for Install and one for Remove) and a different COST to show the different labor costs of installing that CU vs. removing it.
This field refers to the ID field in the MM_WMS_COMPATIBLE_UNIT_LIBRARY table.
This field refers to the ID field in the MM_WMS_WORK_FUNCTION table.
The dollar amount associated with performing the chosen work function with the given CU.
This table defines the available work functions for CUs. The following work functions are required and may not be removed without causing problems: Install (1), None (0), and Replace (-10). This table will not be updated. It will only be referenced for values to add rows to the labor cost table.
The primary key for the work function.
A numeric identifier that represents the work function.
The name of the work function as it appears in the Workflow Manager user interface.
Indicates whether scrap material will result from the work function. This value is used in determining design cost. 0 = no; any other value = yes.
Indicates whether material will be needed for the work function. This value is used in determining design cost. 0 = no; any other value = yes.
Contains an abbreviation for the work function (e.g., Install = I, Remove = R). The abbreviations in this field should match those in the MM Work Function Abbr domain (visible in ArcCatalog Properties dialog).