Open topic with navigation

Modify a Custom Module

A custom module's properties can be edited, the custom module can be removed, and custom facility types can be added to, modified in, or removed from the module. A custom module must have at least one facility type and supports up to ten (10) custom facility types. These instructions start with the assumption that the correct pipeline segments have been selected. For information detailing how to select pipeline segments, refer to Select ROWs.

Complete the following steps to modify a custom module:

1. Select Custom Module Management from the Modules menu.

2. Select the module you wish to modify in the Custom Modules pane on the left and do any of the following:

   • Edit the Module Information. Change the following module information as needed:

     • Type a new name for the module in the Name field. The field accepts up to 50 alphanumeric characters including spaces and special characters.

     • Type the module's acronym in the Acronym field. This field accepts up to four (4) alpha characters. It does not support numeric or special characters.

     • Change the color to the module from the Color dropdown. To switch to a color that does not exist in the dropdown, select Advanced in the Color dropdown and create a custom color by doing any of the following:

       • Select a color with the color slider and color field.

       • Enter a hexadecimal value in the field provided.

       • Enter Red (R), Green (G), Blue (B), and Alpha (A) values in the field provided.

     Click Save to save the module properties.

   • Modify the Module's Facility Types. Add new facility types, edit existing facility types, or delete facility types as necessary:

     • Add new facility types — Click Add in the Custom Facilities pane on the right to add a new custom facility.

       1. Type the facility type's name in the Name field. The field accepts up to 30 alphanumeric characters including spaces and special characters.

       2. Type a longer name for the user defined facility in the Long Name field. This field accepts up to 40 alphanumeric characters including spaces and special characters.

       3. Type an acronym for the user defined field in the Short Name field. The field accepts up to four (4) alpha characters. It does not support numeric or special characters.

       4. If you want the facility type available for selection when setting up a schedule, click to select the Is Schedulable check box.

       5. Click to select the Is Routable check box to have the facility type available for selection when setting up a route.

       6. Click to select the Is Range Data check box to allow pipeline segments in this facility type to be defined based on a starting and ending milepost range regardless of series definitions.

       7. Click Save to save the current facility type's properties.

       8. If additional facility types are needed, click Add and repeat these steps.

     • Delete existing facility types — Locate the facility type you wish to modify and delete the facility type by doing the following:

       1. Click in the facility type's box.

       2. Review the confirmation dialog to ensure you still want to delete the custom facility type and click Delete to delete the facility type or Cancel to cancel the operation.

     • Modify existing facility types — Locate the facility type you wish to modify and change its properties as needed by doing the following:

       • Type the facility type's name in the Name field. The field accepts up to 30 alphanumeric characters including spaces and special characters.

       • Type a longer name for the user defined facility in the Long Name field. This field accepts up to 40 alphanumeric characters including spaces and special characters.

       • Type an acronym for the user defined field in the Short Name field. The field accepts up to four (4) alpha characters. It does not support numeric or special characters.

       • If you want the facility type available for selection when setting up a schedule, click to select the Is Schedulable check box.

       • Click to select the Is Routable check box to have the facility type available for selection when setting up a route.

       • Click Save to save the current facility type's properties.

   • Delete the Module. If the entire module should be deleted, do the following:

     1. Click Delete in the Module Information pane.

     2. Review the confirmation dialog to ensure you still want to delete the custom module and click Delete to delete the module or Cancel to cancel the operation.

3. Click to close Custom Module Management.