Using The Connected Services Framework Administration Tool
Collapse the table of content
Expand the table of content

Connected Services Framework Administration

Connected Services Framework
This section describes using Connected Services Framework Administration.

The Administration tool currently consists of three components: a shell, an OH-SBE Snap-In, a Session Snap-In, and a Session Cluster Configuration Snap-In. The shell consists of four areas: a menu, a status bar, a left navigation pane, and the snap-in area. The Load Snap-In command on the File menu allows the user to load additional snap-ins that are not in the Snap-Ins directory.


OH-SBE Snap-In

Figure 1 is an overview of the shell and the OH-SBE Snap-In. The numbers below relate to the red numbers in Figure 1.

  1. Left navigation pane—Snap-ins are loaded into this pane. A snap-in can consist of a complete custom navigation tree which will be displayed here under the Snap-Ins entry. Each navigation entry must be associated with an assembly and class to be displayed.

  2. The area where snap-ins are loaded—For the OH-SBE, this area consists of eight components. The initial screen is the current list of orders that have been sent to Session for processing. Each column of the data grid is sortable.

  3. List to view drop-down box—This drop-down box allows the user to see the current list of orders in Session or the request history of orders that have returned from Session in one of the possible states or has been terminated.

  4. State drop-down box—This is a list of all possible states an OH-SBE order may be in. The data grid will display only the orders in the state selected from the list.

  5. Status bar—The Status bar is not used by the OH-SBE Snap-In.

  6. Refresh button—The Refresh button will query the database for updated information based on the List to view (3) and the State (4). The OH-SBE Snap-In does not poll the database. The only non-user-initiated query is a query on load and that only happens when you activate the snap-in by selecting it from the left navigation pane.

  7. Terminate button—The Terminate button will terminate the currently selected order by setting a request for termination state for the requestUUID in the database. The SbeMonitor will pick up the request and process it. A confirmation dialog box will appear to confirm termination of the order.

  8. Order Details tab—When a row is selected on the data grid, a complete details for that order are requested from the database and displayed on the Order Details tab. The Order Details tab is depicted in Figure 2.

  9. Specific Field View tab—When an item is selected on the Order Details tab, its full value (up to 32767 characters) are displayed on the Specific Field View tab. The Specific Field View tab is depicted in Figure 3.

(Figure 1: OH-SBE Order Handling)


(Figure 2: Order Details tab)


(Figure 3: Specific Field View tab)


Session Snap-In

The Session Snap-In, shown in the shell in Figure 5, allows the user to see the current list of sessions and terminate them. The snap-in consists of the following ten components (which correspond to the red numbers in Figure 5):

  1. List of Session IDs—These are sorted in descending order by Time In Session. Clicking on a row will populate the Session Details tab by retrieving the Session Manifest from Session.

  2. Request State drop-down box—The list of sessions can be filtered by the Request State drop-down box. The State drop-down box lists all possible states in Session, but only Active, Hibernated, and Failed will ever be shown because all others are transition states and are internal to Session. The All and Terminated states are added by the snap-in.

  3. Status bar—Because Session is asynchronous and the user interface will not be updated as fast as a user may be expecting, the Session Snap-In makes extensive use of the status bar to display all incoming and outgoing messages to Session.

  4. Refresh button—The Refresh button will get the latest list of Sessions from each Session server in the cluster. Given the asynchronous nature and the unknown number of Session servers in the cluster, there is no way of keeping track of which Sessions are new and which have been terminated, so the snap-in merges all responses into the current list, keeping all data until the Clear button is pressed.

  5. Clear button—The Clear button removes all sessions from memory. The Refresh button must be pressed to get the latest list of Sessions.

  6. Reset Session Management Credentials—The Reset Session Management Credentials button opens a Login dialog box (see Figure 4) and retrieves the user name and password that will be used for all calls to Session.

(Figure 4: Login dialog box)

  1. Terminate button—The Terminate button will terminate the currently selected Session. A confirmation dialog box will appear.

  2. Session Details tab—The Session Details tab will be populated when a Session is selected. Figure 6 depicts the Session Details tab.

  3. Specific Field View tab—The Specific Field View tab will be populated when a cell on any of the data grids is selected.

  4. Session to use— The Session to use drop-down will set the session the next refresh will be sent to. When selected the list of session id's will be cleared and the user will need to press the refresh button to get a new list from the selected session.

(Figure 5: Session Snap-In)

The full Session Manifest is displayed on the Session Details tab in Figure 6. The numbers below relate to the red numbers in Figure 6.

  1. Participants list—The participants list consists of all the participants for this Session.

  2. Routing Table—The Routing Table for the Session Manifest (displayed in Figure 7).

  3. Terminate button—The Terminate button will terminate the displayed Session and a confirmation dialog box will appear.

  4. Non-list-type data—The non-list-type data that is in the Session Manifest.

(Figure 6: Session Manifest on Session Details tab)


(Figure 7: Routing Table in the Session Manifest)

Session Cluster Configuration

This Snap-In allows the administrator to configure session clustering. Once session is clustered the only way to un-cluster the session is to set the IsClusteringEnabled flag to false, do an IISReset, then remove the machine from the cluster with the admin tool. The box will give an error that it cannot remove itself from the cluster when the IsClusteringEnabled flag is set to true. A session that has the IsClusteringEnabled flag set to false can remove all boxes from the cluster irregardless of the value of IsClusteringEnabled on the box in question.

The following image gives an overview of how cluster configuration works:

  1. This Dropdown list allows you to select the session that the configuration requests will be sent to.

  2. This editbox allows you to type in the DNS address of the session box to add to the cluster. You must set the IsClusteringEnabled flag on this session box to true.

  3. Contains the list of sessions in the current cluster. As you add DNS addresses they are added here until Apply Changes button is pressed. If the Refresh Configuration button is pressed this list will be replaced with what is in Session.

  4. Adds what is typed in the editbox(2) to the list(3).

  5. Updates the selected item in the list(3) with what is in the editbox(2).

  6. Removes the selected item from the list(3).

  7. Makes a request to the session in the dropdown(1) for the session cluster configuration. The reply to this call also populates the dropdown in Session Management Snap-In.

  8. Submits a request to the session in the dropdown(1) with the current list(3). This requests that the new cluster configuration is set to what is in the list.

(Figure 8: Session Cluster Configuration)

Copying the Administration tool to another computer

  • Install Microsoft Enterprise Instrumentation Framework on the destination computer.

  • Install WSE 2.0 sp3 on the destination computer.

  • Copy the Admin directory from the Tools directory to the destination computer.

  • Copy the Common.config, Session.config, and EnterpriseInstrumentation.config files from the Configuration directory to the destination computer.

  • On the destination computer, edit the CSFSnap-InShell.exe.config file that is in the Admin directory.

  • Fix all paths in this file to point to the appropriate locations. There may be more paths than the following list.

    • <add key="Common" value="C:\CSF\Main\Dev\Server\Configuration\Common.config" />
    • <add key="Session" value="C:\CSF\Main\Dev\Server\Configuration\session.config" />
    • <add key="instrumentationConfigFile" value="C:\CSF\Main\Dev\Server\Configuration\EnterpriseInstrumentation.config" />
  • Make sure the user has all necessary permissions for each Snap-In


© 2016 Microsoft