ArcFM Desktop Configuration Guide
Session Manager Subtasks

Version: 10.2.1c and 10.2.1c SP3

Resource Center Home
ArcFM Desktop > Set Up Process Framework Tools > Session Manager Subtasks

Below is a list of the subtasks available for use with Session Manager, the criteria necessary for them to be enabled, and the steps that are performed when they are executed. Many of these subtasks are named after the task with which they are associated. You may create custom subtasks (see ArcFM Solution Resource Center). Use the Process Framework Admin Tool to group subtasks and create custom tasks.

Change Owner All Session

Changes the owner of a session to any valid user.

Enabled

  • MMSessionManager must be the current extension.
  • The node passed to this subtask must be a session.
  • Determines if there are any other users that have a role that can access the node in its current state.

Execute

  1. Identifies the users with the appropriate roles assigned to own the selected node.
  2. Gets the value of the DefaultUser parameter.
  3. If the AutoChangeOwner value is set to 1 (True), selects the DefaultUser and assigns the node. If no DefaultUser value is set, allows the user to select from a list of valid users.
  4. If the AutoChangeOwner value is set to 0 (False), selects the DefaultUser and allows the user to change the selection from a list of valid users. If no DefaultUser value is set, allows the user to select from a list of valid users.
  5. Assigns the node to the chosen user.

Parameters

  • DefaultUser: takes a user name as a value. The default value is null.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt. The default value is 0 (False).

Change Session Owner

Allows the user to assign the session to another user.

Enabled

  • The user must be an Administrator or the current owner.
  • MMSessionManager must be the current extension.
  • The node passed to this subtask is a Session node.
  • Determines if there are any other users that have a role that can access the node in its current state.

Execute

  1. Checks to see that the node is a session.
  2. Prompts the user to save if the session is open in ArcMap.
  3. Finds a list of users that have the roles necessary to access the current node.
  4. Gets the value of the DefaultUser parameter.
  5. If the AutoChangeOwner value is set to 1 (True), selects the DefaultUser and assigns the node. If no DefaultUser value is set, allows the user to select from a list of valid users.
  6. If the AutoChangeOwner value is set to 0 (False), selects the DefaultUser and allows the user to change the selection from a list of valid users. If no DefaultUser value is set, allows the user to select from a list of valid users.
  7. Attempts to transfer ownership of the session to the selected user.
  8. Closes the session if it is open in ArcMap.

Parameters

  • DefaultUser: takes a user name as a value. The default value is null.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt. The default value is 0 (False).

Change Session Owner Self

Changes the owner of the selected node to the current user.

Enabled

  • MMSessionManager must be the current extension.
  • Determines if there are any other users that have a role that can access the node in its current state.

Execute

Changes the owner of the node to the current user.

Change Session Owner to Mobile

Allows the user to change the owner of a session to a mobile user.

Enabled

  • MMSessionManager must be the current extension.
  • The node passed to this subtask must be a session.
  • Users must exist with the Mobile role assigned.

Execute

  1. Finds a list of users that have the roles necessary to access the current node.
  2. Gets the value of the DefaultUser parameter.
  3. If the AutoChangeOwner value is set to 1 (True), selects the DefaultUser and assigns the node. If no DefaultUser value is set, allows the user to select from a list of valid users.
  4. If the AutoChangeOwner value is set to 0 (False), selects the DefaultUser and allows the user to change the selection from a list of valid users. If no DefaultUser value is set, allows the user to select from a list of valid users.
  5. Assigns session to the chosen user.

Parameters

  • DefaultUser: takes a user name as a value. The default value is null.
  • AutoChangeOwner: takes a value of 0 or 1. 0=False, prompt the user to select owner; 1=True, select default owner without prompt. The default value is 0 (False).

Clear CurrentOpenSession Property

Enabled

The CurrentOpenSession property must contain a value other than Null.

Execute

Sets the CurrentOpenSession property to Null.

Close Session

Closes a session that has been opened in ArcMap.

Enabled

  • MMSessionManager must be the current extension.
  • The node passed to this subtask is a Session node.
  • Session Manager must be open through ArcMap and a session must be open.

Execute

Closes the open session.

Create Session

Adds a new session node.

Enabled

  • MMSessionManager must be the current extension.
  • The selected node must be a filter (top level) node.

Execute

  1. Creates a new session node.
  2. Assigns the TypeID if one has been specified in the parameter.
  3. Adds the node to the TOC.

Parameters

SessionTypeID: Takes a session type (e.g., Electric, Gas, Water).

Delete Session

Removes the session and attempts to remove all of the associated version data from ArcMap. If it cannot remove the version data from ArcMap, the data is marked as orphaned and may be deleted using the Clean Up tool.

Enabled

  • MMSessionManager must be the current extension.
  • The node passed to this subtask is a Session.

Execute

  1. Asks the user to confirm deletion.
  2. If the session is open in ArcMap, it will be closed.
  3. Calls the node’s deleter object.

Does User Own Session Node?

Checks to see if the user is also the current owner.

Enabled

If the user is not the owner, the Enabled method will return false and the subtask will be disabled.

Execute

Always returns true.

Is Session Closed?

Determines if a session has been closed.

Enabled

Disabled if a session is currently opened.

Execute

Always returns true.

Is Session in a Non-Mobile State?

Determines if the session is open.

Enabled

If the state is 8 (Mobile), returns false.

Execute

Always returns true.

Parameters

OverrideDefaultMobileStateNumber: takes a long integer for the number that corresponds with the session's current state. The default is 8 (Mobile).

Is Session Locked?

Checks the session to determine if it is locked.

Enabled

  • Disabled if the session’s node is locked.
  • Disabled if the session has a packet and Mobile is disabled.
  • MMSessionManager must be the current extension.
  • The selected node is a session node.

Execute

Always returns true.

Is Session Open?

Determines if a session is open for editing in ArcMap.

Enabled

Disabled if a session is not currently opened.

Execute

Always returns true.

Mobile Submit Session

Changes the mobile session’s status to Pending Approval and allows the mobile user to assign it to an approval officer.

Enabled

  • MMSessionManager must be the current extension.
  • The node passed to this subtask must be a session.
  • The Submit Session task must be enabled.

Execute

Executes the Submit Session task.

Open Edit Session

Opens the session node for editing in ArcMap.

Enabled

  • A session node must be selected.
  • MMSessionManager must be the current extension.
  • You must NOT have an editing session started.
  • Session Manager must be open from ArcMap (not standalone) and visible.
  • User must have access to the appropriate ArcFM Solution license: ArcFM, Designer or Inspector.
  • User must have access to the appropriate Esri license: Engine Geodatabase, ArcGIS for Desktop Standard (formerly ArcEditor) or ArcGIS for Desktop Advanced (formerly ArcInfo).

Execute

  1. Opens the session as editable.
  2. Sets the PxApplication on the Process Framework Task Tool extension.

Open Graphic Session

Opens the session node for graphic (or redline) editing in ArcMap. This subtask requires Mobile (or Redliner) and creates a Mobile packet for the session when executed.

Enabled

  • A session node must be selected.
  • MMSessionManager must be the current extension.
  • You must NOT have an editing session started.
  • Session Manager must be open from ArcFM Viewer (not standalone) and visible.
  • Session Manager must be open in a field database. This subtask is not available on the Enterprise.

Execute

  1. Gets the session.
  2. Creates a Mobile packet if one does not already exist for the session.
  3. Determines whether the session should be opened as View Only.
  4. Loads the session's stored display (if it exists).
  5. Loads the session's Mobile packet.
  6. Activates the mobile graphics layer.
  7. Sets the PxApplication on the Process Framework Task Tool extension.

Post Session

Posts the session version to the geodatabase.

Enabled

  • MMSessionManager must be the current extension.
  • A session node must be open in ArcMap.
  • If the session is in a versioned database, the session’s version must be postable.

Execute

  1. If the workspace is versioned, the session is posted. If the workspace is not versioned (e.g., Access database), the session is saved and not posted, but the approve actions are still performed.
  2. Closes the session.
  3. If the DoNotDeleteSession subtask parameter is null or set to 0, the session is deleted. If this value is 1, the session is not deleted and its state is set to Pending Approval. The session's version status is set to 2 for "posted."

Parameters

  • DoNotDeleteSession: takes a value of 0 or 1. 0 (or null)=delete session; 1=do not delete session.

Reconcile Session

Reconciles the session’s version with the geodatabase.

Enabled

  • Session Manager must be opened through ArcMap.
  • A session node must be open in ArcMap.
  • The session must be editable.
  • The workspace must be versioned.

Execute

  1. Determines whether the DefineConflictsByColumn configuration value is set in the Process Framework Admin Tool (Configuration tab). If this value is set to 1, conflicts are defined by column. If this value is set to 0 or not set at all, conflicts are defined by row.
  2. Reconciles the session node. If reconcile fails or is cancelled, Execute returns false and the subtask is rolled back along with any subtasks executed prior to it.

Reject Session

Changes the session’s status to In Progress and allows the user to assign it to another user.

Enabled

  • MMSessionManager must be the current extension.
  • The selected node is a session.
  • The session must be editable.
  • If the session is open in ArcMap, the user must be editing.

Execute

  1. Prompts the user to select a new user.
  2. Attempts to transfer ownership.
  3. Tells the builder that the user has changed so it can update the tree if necessary.

Re-Send Session to Field

Executes the "Send Session to Current Field Owner" task if the node’s current owner has the Session ALWAYS Mobile User role assigned.

Enabled

  • MMSessionManager must be the current extension.
  • The selected node is a session.

Execute

  1. Gets the node's owner.
  2. Executes the "Send Session to Current Field Owner" task if the node's owner has the Session ALWAYS Mobile User role assigned.

Save Session

Saves the current session.

Enabled

  • MMSessionManager must be the current extension.
  • A session node must be opened through ArcMap.
  • The user must have an editing session started.

Execute

Saves the session.

Send Session

Identifies whether the user is in the field or on the enterprise and executes the appropriate task: Send Session to Enterprise or Send Session to Field

Enabled

  • A valid PxNode must have been passed into this subtask.
  • That PxNode must be a session node.
  • Field: The "Send Session to Field" task must be enabled.
  • Enterprise: The "Send Session to Enterprise" task must be enabled.

Execute

  1. Checks to see if the user is in the field or on the enterprise.
  2. If the user is in the field, executes Send to Enterprise task.
  3. If the user is on the enterprise, executes the Send to Field task.

Send Session to Enterprise

Takes a session from the mobile environment and puts it back on the enterprise server.

Enabled

  • The MM_Mobile_State table must exist in the current Process Framework database.
  • The Database ID field must have a value. This field is located in the Process Framework Administration Tool on the Extensions tab.
  • MMSessionManager must be the current extension.
  • The selected node must be a session.

Execute

  1. Closes the session if it is open in ArcMap.
  2. Adds the packet to the transporter.
  3. Deletes the session.

Send Session to Field

Takes a session from the enterprise server and puts it in the mobile environment.

Enabled

  • The Database ID field must have a value. This field is located in the Process Framework Administration Tool on the Extensions tab.
  • MMSessionManager must be the current extension.
  • The selected node must be a session.
  • The MM_Mobile_State table must exist in the current Process Framework database.
  • The current session must have not already been imported.

Execute

  1. Closes the session if it is open in ArcMap.
  2. Creates a mobile packet if one does not already exist.
  3. Saves the mobile packet.
  4. Adds the mobile packet to the transporter.

Submit Session

Changes the session’s status to Pending Approval and allows the user to assign it to an approval officer.

Enabled

  • MMSessionManager must be the current extension.
  • The selected node is a session.
  • The session must have been opened in ArcMap at least once.
  • If the session is open in ArcMap, the session must be editable and the user must have an editing session started.

Execute

  1. Prompts the user to save edits.
  2. Prompts the user to select an approval officer.
  3. Attempts to transfer ownership.
  4. Tells the builder that the user has changed so it can update the tree if necessary.
  5. If the session is open in ArcMap, it will be closed when it is submitted to another user.

 

 

Send Comment to ArcFMdocumentation@schneider-electric.com