ArcFM Engine Developer Guide
Process Framework Tables

Version: 10.2.1c and 10.2.1c SP3

Resource Center Home

The Process Framework Administration tool provides a user-friendly means for manipulating the tables associated with your process management module (e.g., Session Manager, Workflow Manager). These tables should not be modified manually. Make all changes using the Process Framework Administration tool. This section discusses the tables provided with Process Framework. The MM_PX_CONFIG table is discussed separately.

 

MM_PX_CURRENT_STATE

MM_PX_DB_VERSION

MM_PX_FILTER_ROLE

MM_PX_FILTERS

MM_PX_HISTORY

MM_PX_NODE_TYPE

MM_PX_ROLE

MM_PX_SEQUENCE

MM_PX_STATE

MM_PX_STATE_ROLE

MM_PX_SUBTASKS

MM_PX_SUBTASKS_PARAMETERS

MM_PX_SUPPORTED_EXTENSIONS

MM_PX_TASK_ROLE

MM_PX_TASKS

MM_PX_TRANSITION

MM_PX_TRANSITION_FROM_STATE

MM_PX_TRANSITION_ROLE

MM_PX_TRANSITION_TO_STATE

MM_PX_USER

MM_PX_USER_ROLE

MM_PX_VERSIONS

MM_MOBILE_DB_VERSION

MM_MOBILE_STATE

 

MM_PX_CURRENT_STATE

Every node in Session Manager and Workflow Manager must have a current state assigned to indicate where it is in the process flow. The current state for an individual node (Session, Design, or Work Request) will change as it moves through the process flow.

SOID

A unique identifier for the Session, Design, or Work Request.

STATE_ID

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

LOCKED

This field indicates whether a design is locked and unavailable for editing. 0 = unlocked, any value other than 0 = locked. For example, a Session with a state of Complete should not be edited further. Therefore, the Complete state will be locked.

Return to Top

MM_PX_DB_VERSION

This table is primarily for Schneider Electric internal use. It holds the Session Manager database version. The only field in this table the user will have need to edit is the DATABASE_ID field. This field is used only for Mobile.

DATABASE_ID

A unique identifier for Process Framework database. All designs and sessions created in the database will carry this value in a corresponding DATABASE_ID field.

The value in this table must be set when the database is created and never modified. The value must be less than 64 characters in length. If the value is not set up, the user will receive an error message when attempting to login to the database.

Return to Top

MM_PX_FILTER_ROLE

Filters may be assigned to specific roles. So a user must have a particular role assigned to access to a specific filter. For example if the AllSessionsFilter has been assigned to the Approval Officer role, a user must have the Approval Officer role assigned to her in order to view the filter.

The primary keys for the filter and the role are linked in the table below to make the assignment.

FILTER_ID

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

ROLE_ID

This field refers to the ROLE_ID field in the MM_PX_ROLE table.

Return to Top

MM_PX_FILTERS

Once you have created your custom filter, it must be added to this table.

ID

The primary key for the filter.

PROGID

This field points to the control that defines the user control on the right side of the window. For example, when you select the top node in Session Manager, the right-side displays a grid.

DESCRIPTION

A brief description of the filter.

STATE_ID

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

Return to Top

MM_PX_HISTORY

This table stores history information.

NODE_TYPE_ID

This field refers to the NODE_TYPE_ID field in the MM_PX_NODE_TYPE table. It indicates the type of node to which the history applies.

NODE_ID

A unique identifier for the node.

SERVER

The database on which the action was taken.

DATE_TIME

The date and time the information was added to the history.

DESCRIPTION

A description of the action taken.

EXTRA_DATA

All extraneous data associated with the history. For example, a new owner or new state.

USER_ID

This field refers to the USER_ID field in the MM_PX_USER table. This is the user who performed the action.

USER_NAME

This field refers to the USER_NAME field in the MM_PX_USER table. This is the user who performed the action.

Return to Top

MM_PX_NODE_TYPE

When an administrator adds a new node type, the MM_PX_NODE_TYPE table is affected.

NODE_TYPE_ID

The primary key for the node type. This field is also the foreign key for the MM_PX_STATE table.

NAME

The name of the node type.

DISPLAY_NAME

The name of the node type as it may appear in the Session Manager or Workflow Manager user interface.

DESCRIPTION

The user-defined description of the node type.

HIDDEN

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

DELETER_PROGID

This field specifies the Deleter object to be used for the node type.

VERSION_NAMER_PROGID

This field specifies the Version Namer object to be used for the node type.

EXTENSION_ID

The field refers to the ID field in the MM_PX_SUPPORTED_EXTENSIONS table.

INITIAL_STATE

This field allows you to set a number that corresponds to a node's initial state. Previously, if the initial state wasn't 1, errors would occur. This field allows you to set the initial state to any value (e.g., 5).

Return to Top

MM_PX_ROLE

An administrator may assign a specific role to a user that limits the states or transitions to which the user has access. When a new role is added, it appears in this table.

ROLE_ID

The primary key for the role. This field acts as a foreign key for the MM_PX_USER_ROLE, MM_PX_STATE_ROLE, MM_PX_TRANSITION_ROLE, and MM_PX_FILTER_ROLE tables.

NAME

The user-assigned name for the role.

DISPLAY_NAME

The role’s name as it appears in the Session Manager or Workflow Manager user interface.

DESCRIPTION

A brief description of the role.

EXTENSION_ID

Creates a relationship between a role and supported extension. This field is used to filter roles during an export.

Return to Top

MM_PX_SEQUENCE

This table is the sequence-generator for table rows. This is the only table in the process framework database that you have to access manually to make changes. All other modifications must be made using the Process Framework Administration tool.

NAME

This field holds the name of the ID for which it is generating a sequence (e.g., Px_UserID, SessionID, WMS_DesignID).

SEQUENCE_VALUE

This is the value of the ID last created.

INCR

The increment by which IDs are generated. For example, if the SEQUENCE_VALUE is 215 and the increment is 10, the next ID generated will be 226.

Return to Top

MM_PX_STATE

When new states are created, this table is modified.

STATE_ID

The primary key for the state. This field is also a foreign key for the MM_PX_CURRENT_STATE, MM_PX_TRANSITION, MM_PX_TRANSITION_FROM_STATE, and MM_PX_TRANSITION_TO_STATE fields.

STATE

A unique identifier for the state that may be used within the code.

NODE_TYPE_ID

This field refers to the NODE_TYPE_ID field in the MM_PX_NODE_TYPE table. It indicates the type of node that may have the state assigned. For example, the default process flow dictates that only a Session node may have a state of In Progress assigned.

NAME

The name of the state as it appears in the Session Manager or Workflow Manager user interface.

DESCRIPTION

A brief description of the state.

CONTROL_PROGID

This field points to the control that determines the user control on the right side of the form.

NODE_BITMAP

A bitmap may be assigned to appear with a node when it is in a particular state. Enter the path to the bitmap in this field.

Return to Top

MM_PX_STATE_ROLE

States may be assigned to specific roles. So a user must have a particular role to be able to modify a session, design, or work request that has a specific state. For example if the In Progress state has been assigned to the Editor role, a user must have the Editor role assigned to him in order to modify sessions that are In Progress. The primary keys for the state and the role are linked in this table to make the assignment.

STATE_ID

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

ROLE_ID

This field refers to the ROLE_ID field in the MM_PX_ROLE table.

Return to Top

MM_PX_SUBTASKS

This table is used to store information about Subtasks.

TASK_ID

The primary key for the task.

DESCRIPTION

A description of the subtask.

SUBTASK_ORDER

The order that the subtasks execute.

SUBTASK_OBJECT

The ProgID of the subtask class.

SUBTASK_ID

A unique identifier for the subtask.

Return to Top

MM_PX_SUBTASKS_PARAMETERS

This table is used to store parameters associated with Subtasks.

SUBTASK_ID

The primary key for the subtask.

PARAMETER_NAME

Display name for the parameter.

PARAMETER_VALUE

Value associated with the parameter.

Return to Top

MM_PX_SUPPORTED_EXTENSIONS

This table holds the names of the available Process Framework extensions.

ID

The primary key for the extension.

NAME

The name of the extension.

Return to Top

MM_PX_TASK_ROLE

This table assigns the role to the task by using their primary keys.

TASK_ID

The primary key for the task.

ROLE_ID

The primary key for the role.

Return to Top

MM_PX_TASKS

This table is used to store information about Tasks.

TASK_ID

The primary key for the task.

NAME

A user-defined name for the task.

DESCRIPTION

A description of the task.

TRANSITION_ID

The primary key for the transition assigned to the task.

NODE_TYPE_ID

The primary key for the node type assigned to the task.

DISPLAY_ORDER

Allows you to order the tasks in the Task List on the Node Types tab of the Process Framework Admin Tool. This order will affect the order in which tasks appear in the Task tool.

VISIBLE

This field holds the value entered in the checkbox on the Task Properties dialog available on the Node Types tab. This determines whether the task is visible in the Task tool.

Return to Top

MM_PX_TRANSITION

When an administrator adds new transitions, this table is affected.

TRANSITION_ID

A unique identifier for the transition.

NAME

The name of the transition.

DISPLAY_NAME

The name of the transition as it appears in the Session Manager or Workflow Manager user interface.

DESCRIPTION

A brief description of the transition.

NODE_TYPE_ID

This field is used during export to filter based on extension. This field is set to the same node type as the "to" state. If no "to" state exists for a transtion, then this field is set to -1.

Return to Top

MM_PX_TRANSITION_FROM_STATE

A Transition moves a node from one state to another. An administrator must indicate between which states the transition is moving the node.

TRANSITION_ID

This field refers to the TRANSITION_ID field in the MM_PX_TRANSITION table.

STATE_ID

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

Return to Top

MM_PX_TRANSITION_ROLE

Transitions may be assigned to specific roles. So a user must have a particular role to be able to perform a specific transition. For example if the Approve transition has been assigned to the Approval Officer role, a user must have the Approval Officer role assigned to her in order to perform the Approve transition.

The primary keys for the transition and the role are linked in this table to make the assignment.

TRANSITION_ID

This field refers to the TRANSITION_ID field in the MM_PX_TRANSITION table.

ROLE_ID

This field refers to the ROLE_ID field in the MM_PX_ROLE table.

Return to Top

MM_PX_TRANSITION_TO_STATE

A Transition moves a node from one state to another. An administrator must indicate between which states the transition is moving the node.

TRANSITION_ID

This field refers to the TRANSITION_ID field in the MM_PX_TRANSITION table.

STATE_ID

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

Return to Top

MM_PX_USER

When an administrator adds a user to the Process Framework Administration tool, that information is entered into this table.

USER_ID

The primary key for the user. This field acts as a foreign key for the MM_PX_USER_ROLE table.

USER_NAME

The SDE login name for the user.

DISPLAY_NAME

The user’s name as it appears in the Session Manager or Workflow Manager user interface.

DESCRIPTION

A brief description of the user. Name and title, for example.

Return to Top

MM_PX_USER_ROLE

This table assigns the role to the user by using their primary keys.

USER_ID

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

ROLE_ID

This field refers to the ROLE_ID field in the MM_PX_ROLES table.

Return to Top

MM_PX_VERSIONS

This table contains version information.

NODE_TYPE_ID

This field refers to the NODE_TYPE_ID field in the MM_PX_NODE_TYPE table.

NODE_ID

A unique identifier for the node.

BASE

The base or parent version from which this version was created.

NAME

This field holds the name of the SDE version.

DESCRIPTION

A description of the SDE version.

STATUS

Indicates the status of the version. This field is populated using the mmSessionVersionStatus enumeration (for sessions) or the mmWmsVersionState enumeration (for designs). The values in these enumerations are listed below.

mmSessionVersionStatus

mmSessionVerStatusNothing = 0 

mmSessionVerStatusExists = 1

mmSessionVerStatusPosted = 2

mmWmsVersionState

mmWMSVStatusNone = -1

mmWMSVStatusNonExistent = 0

mmWMSVStatusExists = 1

mmWMSVStatusPosted = 2

mmWMSVStatusToDelete = 4

mmWMSVStatusDeleteVersionOnly = 5

VER_ACCESS

Indicates the access type of the version (e.g., private, protected, or public).

USER_NAME

The SDE login of the user who created the version.

HAS_EDITS

Indicates whether the version has been saved at least once.

Return to Top

MM_MOBILE_DB_VERSION

This table is for Schneider Electric internal use only. It holds the version of the Mobile Designer tables.

Return to Top

MM_MOBILE_STATE

This table contains values associated with Mobile Designer.

NODE_TYPE_ID

This field refers to the NODE_TYPE_ID field in the MM_PX_NODE_TYPE table.

NODE_ID

A unique identifier for the node.

PACKET_ID

A unique ID for the design packet.

IMPORT_STATE

This field contains a value that indicates the state of a packet's import. It uses the mmImportStateType enumeration which includes the following values: 

mmImportStateNotImported = 0  

mmImportStateSuccess = 1  

mmImportStateWithConflicts = 2 

mmImportStateArchived = 3

TIME_STAMP

This field tracks the times of operations for the node history.

PACKET_STATE

This field indicates whether a packet is set to be deleted. It uses the mmPacketStateType enumeration which includes the following values:

mmPacketStateNormal = 0

mmPacketStateToDelete = 1

Return to Top

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com