ArcFM Desktop Developer Guide
Workflow Manager Tables

Resource Center Home

The following tables are added to the existing Process Framework and Session Manager tables. These tables are specific to the Workflow Manager extension. This page defines the Workflow Manager tables and their fields. Other pages in this section discuss customizations to extended data, work functions, and menus in the user interface.

MM_WMS_ADDRESS

MM_WMS_ADMINISTRATIVE_AREA

MM_WMS_APPROVED_DESIGNS

MM_WMS_COMPATIBLE_UNIT

MM_WMS_COMPATIBLE_UNIT_LIBRARY

MM_WMS_COST_FACTOR

MM_WMS_COST_FACTOR_TYPE

MM_WMS_CUSTOMER

MM_WMS_CU_COST_FACTOR

MM_WMS_DB_VERSION

MM_WMS_DESIGN

MM_WMS_DESIGN_PRODUCT_TYPE

MM_WMS_DESIGN_STATUS

MM_WMS_DESIGN_TYPE

MM_WMS_DN_COST_FACTOR

MM_WMS_GIS_COMPATIBLE_UNIT

MM_WMS_GIS_DESIGN

MM_WMS_GIS_FACILITY_TYPE

MM_WMS_GIS_WORK_LOCATION

MM_WMS_GIS_WORK_REQUEST

MM_WMS_LABOR_COST

MM_WMS_RATE_CODE

MM_WMS_UNITS_OF_MEASURE

MM_WMS_WL_COST_FACTOR

MM_WMS_WORK_FUNCTION

MM_WMS_WORK_LOCATION

MM_WMS_WORK_REQUEST

MM_WMS_WR_TYPE

MM_WMS_WR_USERS

MM_MOBILE_STORED_DISPLAY

 

MM_WMS_ADDRESS

This table holds the work request (WR) address information entered by the user on the Location and Customer tabs. The ID field acts as a primary key for each entry and is a foreign key for the MM_WMS_CUSTOMER and MM_WMS_WORK_REQUEST tables.

Return to Top

MM_WMS_ADMINISTRATIVE_AREA

This table holds the values that appear in the Administrative Area field on the Location tab for a WR. Modify this table to add and remove selection options on the Administrative Area pulldown menu.

ID

A primary key for the administrative area.

VALUE

The name as it appears in the Administrative Area field’s pulldown menu.


Figure 1

Return to Top

MM_WMS_APPROVED_DESIGNS

A work request and its approved design are added to this table when an Approval officer approves the design.

WORK_REQUEST_ID

This field refers to the ID field in the MM_WMS_WORK_REQUEST table.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

Return to Top

MM_WMS_COMPATIBLE_UNIT

This table stores the CUs that have been added to a design. Many of these field values appear on the Compatible Unit tab when a CU is selected in Workflow Manager.

ID

A primary key for the compatible unit and a foreign key for the MM_WMS_CU_COST_FACTOR table.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

WORK_LOCATION_ID

This field refers to the ID field in the MM_WMS_WORK_LOCATION table.

CU_LIBRARY_ID

This field refers to the ID field in the MM_WMS_COMPATIBLE_UNIT_LIBRARY and MM_WMS_LABOR_COST tables.

WORK_FUNCTION_ID

This field refers to the ID field in the MM_WMS_WORK_FUNCTION table.

LENGTH

If the CU is a linear feature, its length may appear in this field.

QUANTITY

Indicates the number of CUs.

CU_NAME

Identifies the CU. The value in this field appears in the CU Code field on the Compatible Unit tab.

Return to Top

MM_WMS_COMPATIBLE_UNIT_LIBRARY

This table holds a complete list of CUs available in your network.

ID

A primary key for the CU. This field also acts as a foreign key for the MM_WMS_COMPATIBLE_UNIT and MM_WMS_LABOR_COST tables.

CODE

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 ArcFM Favorites Manager.

DESCRIPTION

A description of the CU (e.g., pole wood class 1 40ft).

MATERIAL_COST

The dollar amount associated with purchasing this particular CU.

SCRAP_VALUE

The dollar amount associated with scrapping the CU when it is longer in use.

UNITS_OF_MEASURE_ID

This field refers to the ID field of the MM_WMS_UNITS_OF_MEASURE table.

GIS_SYMBOLIZED

Indicates whether the CU is symbolized or non-symbolized. 0 = not symbolized; any other value = symbolized.

Return to Top

MM_WMS_COST_FACTOR

Various environmental factors impact the cost necessary to perform the work. For example, work done in a high traffic area is more costly than work performed in a low traffic area. This table provides the multiplier for each environmental factor.

ID

The primary key for the cost factor. This field also acts as a foreign key for the MM_WMS_CU_COST_FACTOR and MM_WMS_DN_COST_FACTOR tables.

TYPE_ID

This field refers to the ID field in the MM_WMS_COST_FACTOR_TYPE field.

CODE

A numeric code that identifies the value of the cost factor (or site condition).

VALUE

The name of the cost factor as it appears in the Workflow Manager user interface.

MULT

This field holds the multiplier that is used to determine the cost of the design.

Return to Top

MM_WMS_COST_FACTOR_TYPE

This table breaks the various cost factors into types. For instance, Low Traffic and High Traffic would fall into the Traffic Condition cost factor type. Soft Soil and Hard Soil are in the Soil Condition cost factor type.

ID

The primary key for the cost factor type. This field is also the foreign key for the MM_WMS_COST_FACTOR table.

NAME

Internal name for the site condition type. This name is used in the Design XML.

DISPLAY_NAME

The name of the cost factor type as it appears in the Workflow Manager user interface.

DEFAULT_ID

The default cost factor ID for that type. This field points to a row in the MM_WMS_COST_FACTOR table.


Figure 2

Return to Top

MM_WMS_CUSTOMER

This table provides a list of customers, their contact information, and billing address (Figure 3). This information appears on the Customer tab for the work request in Workflow Manager.

ID

A primary key for the customer. This field is also a foreign key for the MM_WMS_WORK_REQUEST table.

ADDRESS_ID

This field refers to the ID field in the MM_WMS_ADDRESS table.

ACCOUNT_NUMBER

The account number associated with this customer.

The remaining fields contain the values entered by the user in the contact information fields (first and last name, phone, fax, etc.).


Figure 3

Return to Top

MM_WMS_CU_COST_FACTOR

This table holds the cost factors associated with specific CUs.

CU_ID

This field refers to the MM_WMS_COMPATIBLE_UNIT_LIBRARY table.

FACTOR_ID

This field refers to the MM_WMS_COST_FACTOR table.

Return to Top

MM_WMS_DB_VERSION

This table is for Schneider Electric internal use only. It holds the Workflow Manager database version.

Return to Top

MM_WMS_DESIGN

This table holds information about designs created by the user. Many of these fields appear on the Design tab in Workflow Manager (Figure 4).

ID

Primary key for the design. This field is also a foreign key for the MM_WMS_APPROVED_DESIGNS, MM_WMS_COMPATIBLE_UNIT, MM_WMS_DN_COST_FACTOR, MM_WMS_GIS_DESIGN, and MM_WMS_WORK_LOCATION tables.

WORK_REQUEST_ID

This field refers to the ID field in the MM_WMS_WORK_REQUEST table.

DESIGN_NUMBER

Each design assigned to a work request is assigned an ID unique to that WR.

NAME

The user-assigned name of the design as it appears in the Design Name field on the Design tab in Workflow Manager.

COMMENTS

Comments relating to the design.

TOTAL_COST

The total cost of the design.

DESCRIPTION

The user-entered description for the design as it appears in the Description field on the Design tab in Workflow Manager.

CREATE_DATE

The date that the design was created. This field is populated automatically.

COST_DESCRIPTION

A description of the cost.

CURRENT_OWNER_ID

The name of the current owner.

APPROVED_BY_ID

If the design has been approved, this field will be automatically populated with the name of the user who approved the design.

APPROVED_DATE

If the design has been approved, this field will be automatically populated with the date of the approval.

AS_BUILT_DN_ID

The ID of the as-built design from which a copy was made.

COPY_FROM_ID

The ID of the design from which a copy was made.

COPY_SAVED

Contains a boolean value indicating whether the design has been saved since being copied. 0 = false; any other value = true.

HIDDEN

This field allows you to determine whether the design is visible to the user. 0 = visible, any other value = hidden.

NON-POSTABLE

This field allows you to determine whether the user may post the design to the geodatabase. 0 = postable, any other value = non-postable.

NON-DELETABLE

This field allows you to determine whether the user may delete the design from the geodatabase. 0 = can delete, any other value = cannot delete.

COPY_TYPE

Indicates the combination of options chosen by the user as criteria for making the copy. This field uses the mmWmsDnCopyType enumeration, which includes the following valid values:

mmWmsDnCopyTypeNormal = 0

mmWmsDnCopyTypeAlternate = 1

mmWmsDnCopyTypeIncremental = 2

DESIGN_TYPE_ID

This field refers to the ID field in the MM_WMS_DESIGN_TYPE table.

DATABASE_ID

A unique identifier for Process Framework database from which the design originated. This value matches the value in the DATABASE_ID field of the MM_PX_DB_VERSION table. This is used only by Mobile.

WORKSPACE_DB_PROPERTIES

This field holds the login properties for the SDE database used to edit the design.

ENTERPRISE_ID

A unique identifier for the enterprise database. This field is used only by Mobile Designer.


Figure 4

Return to Top

MM_WMS_DESIGN_PRODUCT_TYPE

This table holds the product type associated with the design.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

ENUM_VAL

This field uses the mmWmsDesignerProductType enumeration to indicate the type of product (e.g., Designer, Designer Express, Designer Staker) associated with the design. This enumeration contains the following valid values:

mmDesigner = 0

mmExpress = 1

mmStaker = 2

Return to Top

MM_WMS_DESIGN_STATUS

This table holds the status associated with specific designs.

ID

This field refers to the ID field in the MM_WMS_DESIGN table.

VALUE

This field refers to the STATE field in the MM_PX_STATE table.

Return to Top

MM_WMS_DESIGN_TYPE

This table holds a list of the possible types of designs that may be created. Values provided in the sample data are: Electric, Gas, Water.

ID

The primary key for the design type and a unique identifier for each possible design type.

DESIGN_TYPE

The name of the design type as displayed in the Design Type menu.

Return to Top

MM_WMS_DN_COST_FACTOR

This table holds the cost factors associated with specific designs.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

FACTOR_ID

This field refers to the ID field in the MM_WMS_COST_FACTOR table.

Return to Top

MM_WMS_GIS_COMPATIBLE_UNIT

This table stores the information required by the GIS for each compatible unit.

COMPATIBLE_UNIT_ID

This field refers to the ID field in the MM_WMS_COMPATIBLE_UNIT table.

OBJECTID

This field links the CU to a feature in the GIS geodatabase.

Return to Top

MM_WMS_GIS_DESIGN

This table stores the information required by the GIS for each design.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

OBJECTID

This field links the CU to a feature in the GIS geodatabase.

VERSION_BASE

Parent or base version from which the design was created.

VERSION_NAME

Name of the design’s version.

VERSION_STATUS

Status of the version (e.g., never been opened, marked for deletion, etc.).

VERSION_ACCESS

Type of access assigned to the version (e.g., private, protected, or public).

Return to Top

MM_WMS_GIS_FACILITY_TYPE

This table holds the facility types available in the Feature Type field on the Location tab (Figure 5).

ID

The primary key for the facility type.

VALUE

The equipment represented on the map (e.g., pole, transformer, valve).

FEATURE_CLASS_NAME

The feature class that represents the equipment (e.g., SupportStructure, Transformer, GasValve).

MODEL_NAME

The class model name assigned to the feature class (e.g., STRUCTURE, TRANSFORMER, VALVE). This value assists in locating the correct feature class. This can be a model name that is already assigned or one created for this purpose.


Figure 5

Return to Top

MM_WMS_GIS_WORK_LOCATION

This table stores the information required by the GIS for each work location.

WORK_LOCATION_ID

This field refers to the ID field in the MM_WMS_WORK_LOCATION table.

OBJECTID

This field links the CU to a feature in the GIS geodatabase.

Return to Top

MM_WMS_GIS_WORK_REQUEST

This table stores the information required by the GIS for each work request.

WORK_REQUEST_ID

This field refers to the ID field in the MM_WMS_WORK_REQUEST table.

OBJECTID

This field links the CU to a feature in the GIS geodatabase.

VERSION_BASE

Parent or base version from which the work request was created.

VERSION_NAME

Name of the work request’s version.

VERSION_STATUS

Status of the version (e.g., never been opened, marked for deletion, etc.).

VERSION_ACCESS

Type of access assigned to the version (e.g., private, protected, or public).

Return to Top

MM_WMS_LABOR_COST

This table is used to calculate the costs associated with a design. Cost is assigned based on the CU and the work function.

CU_ID

This field refers to the ID field in the MM_WMS_COMPATIBLE_UNIT_LIBRARY table.

WORK_FUNCTION_ID

This field refers to the ID field in the MM_WMS_WORK_FUNCTION table.

COST

The dollar amount associated with performing the chosen work function with the given CU.

Return to Top

MM_WMS_RATE_CODE

This table is not currently used by Workflow Manager.

Return to Top

MM_WMS_UNITS_OF_MEASURE

This table holds the available units of measure for a CU’s quantity and length values. For example, a support structure CU may have a quantity of three and a units of “each” - meaning three poles. While a guy rope may have a quantity of four, a length of 300 and units of “feet” - meaning 4 x 300 feet of guy rope.

ID

The primary key for the unit of measure.

CODE

A numeric identifier that represents the value.

VALUE

The unit of measure value (e.g., feet, meters, each).

Return to Top

MM_WMS_WL_COST_FACTOR

This table assigns a cost factor to a work location.

WORKLOCATION_ID

This field refers to the ID field in the MM_WMS_WORK_LOCATION table.

FACTOR_ID

This field refers to the ID field in the MM_WMS_COST_FACTOR table.

Return to Top

MM_WMS_WORK_FUNCTION

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) 

ID

The primary key for the work function.

CODE

A numeric identifier that represents the work function.

NAME

The name of the work function as it appears in the Workflow Manager user interface.

APPLY_SCRAP

Indicates whether scrap material will result from the work function. This value is used in determining design cost. 0 = no; any other value = yes.

APPLY_MATERIAL

Indicates whether material will be needed for the work function. This value is used in determining design cost. 0 = no; any other value = yes.

ABBREVIATION

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).

Return to Top

MM_WMS_WORK_LOCATION

This table holds information about the work location.

ID

The primary key for the work location.

DESIGN_ID

This field refers to the ID field in the MM_WMS_DESIGN table.

WORKLOCATION_NUMBER

The number assigned to the work location by the Designer CU to WL Assignment tool.

DESCRIPTION

This field holds the description of the WL. It can be edited by opening the design in ArcMap, select the WL on the Design tab and edit the Description field in the Attribute Editor.

COMMENTS

This field holds any comments relating to the work location.

LENGTH

This field is not currently used.

Return to Top

MM_WMS_WORK_REQUEST

When a work request is created, it is assigned a unique identifier that appears on the Work Request tab. Many of the values in this table are entered or appear on the Work Request tab (Figure 6).

ID

The primary key for the work request. This field is also the foreign key for the MM_WMS_GIS_WORK_REQUEST, MM_WMS_DESIGN, and MM_WMS_WR_TYPE tables.

PARENT_WR_ID

The ID of the parent work request.

NAME

The user-entered name of the WR.

DESCRIPTION

The user-entered description for the WR.

ADDRESS_ID

This field refers to the ID field in the MM_WMS_ADDRESS table.

CUSTOMER_ID

This field refers to the ID field in the MM_WMS_CUSTOMER table.

START_DATE

The user-entered start date for the WR.

END_DATE

The user-entered end date for the WR.

COMMENTS

The user entered comments relating to the WR.

CURRENT_OWNER_ID

The name of the user who created the WR.

WR_TYPE_ID

This field refers to the ID field in the MM_WMS_WR_TYPE table.

ADMINISTRATIVE_AREA_ID

This field refers to the ID field in the MM_WMS_ADMINISTRATIVE_AREA table.

FACILITY_DISPLAY_FIELD

The value of the ArcFM display field for the feature selected in the Feature Type field.

FACILITY_TYPE_ID

The value of the Facility ID field.

DESIGN_SEQUENCE

This field determines the sequence generator to be used to create the Work Request ID. It refers to the MM_PX_SEQUENCE table.

HIDDEN

This field allows you to determine whether the work request is visible to the user. 0 = visible, any other value = hidden.

ENTERPRISE_ID

A unique identifier for the enterprise database. This field is used only by Mobile Designer.

UNIQUE_ID

This field is currently not used.


Figure 6

Return to Top

MM_WMS_WR_TYPE

This table defines the types of work requests available (e.g., residential, commercial). Modify this table to add and remove selection options from the Work Request Type pulldown menu (Figure 6).

ID

A primary key for the work request type.

VALUE

The display named visible in the Work Request Type field in Workflow Manager.

CODE

A numeric identifier for the value.

Return to Top

MM_WMS_WR_USERS

This table assigns users to work requests.

WORK_REQUEST_ID

This field refers to the ID field in the MM_WMS_WORK_REQUEST table.

USER_ID

This field refers to the ID field in the MM_PX_USER table.

Return to Top

MM_MOBILE_STORED_DISPLAY

This table contains values that correspond with specific types of backdrop databases (gas, electric, or water and ArcFM or Designer).

ID

A unique identifier for the stored display type.

STORED_DISPLAY

The type of stored display.

Return to Top

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com