GUI Configuration Overview

The bulk of the Web Switching and Web Safety GUI configuration can be found in the jconfig/ops/webswitching directory. The configuration is spread across many files. This allows projects to customize bits and pieces of the configuration without having to define a custom version of the entire tool configuration. If at all possible, projects should inherit from Product as much as possible so that upgrades and patch installations are more easily applied to a project. The following tables describe the main modules used to configure the applications. Each of the configuration modules has an xml and properties file associated to it.

Web Switching

Name	Description
SwmanEntities.inc	This file includes a number of XML entities that are used throughout the Web Switching xml configuration files. The entities are used to give state key numbers readable names so that the configuration can be more easily followed. Instead of displaying a number in the configuration, a name is displayed. Changing the states and such to reference one entity also makes updating the configuration easier. If your project has defined a different switching sheet state for instance, then the single entity will only need to be altered instead of each instance where the entity is referenced.
SwmanBaseProperties	This module defines all the imports, datastores and dialogs used by each of the switching sheet types.
SwmanEmergencyTool SwmanPlannedTool SwmanMiscLogTool SwmanTemplateTool SwmanOutageCorrectionTool SwmanTrainingTool SwmanVoltVarTool SwmanLoadShedTool	Each of these modules defines the tool behavior for each of the switching sheet types. The modules also include all of the other modules used to build the GUI configuration for each of the switching sheet types.
SwmanToolBar	The switching sheet Menu/Toolbar configuration.
SwmanRequest	The switching sheet's Request tab configuration.
SwmanSteps	The switching steps Table configuration. Each of the step columns are defined in this module.
SwmanStepsPopupMenu	The right click switching Steps table context menu configuration.
SwmanStepsHeader	The switching steps toolbar button definitions.
SwmanHeader	The switching steps Event List and Crew List configuration.
SwmanEventsPopupMenu	The right click Events List table context menu configuration.
SwmanCrewsPopupMenu	The right click Crew List table context menu configuration.
SwmanImpactedCustomers	The switching sheet's Impacted Customers tab configuration.
SwmanImpactedCustomersPopupMenu	The right click Impacted Customers table context menu configuration.
SwmanActions	Add your reusable <Action> elements to this file. Also include any changes to actions used by the code itself, like the ACT_APPLY_SAFETY_FILTERS.
SwmanSheetOverlaps	The switching sheet's Overlaps tab configuration.
SwmanExternalDocuments	The switching sheet's External Documents tab configuration.
SwmanExternalDocumentsPopupMenu	The right click External Documents table context menu configuration.
SwmanViewAreas	The switching sheet's View Areas tab configuration.
SwmanViewAreaPopupMenu	The right click View Areas table context menu configuration.
SwmanSafety	The switching sheet's Safety Documents tab configuration.
SwmanTracking	The switching sheet's tracking panel configuration on the Tracking/Audit Log tab.
SwmanAuditLog	The switching sheet's audit log panel configuration on the Tracking/Audit Log tab.
SwmanStatusBar	The switching sheet's status bar configuration.

Web Safety

Name	Description
SafetyBaseProperties	This module defines all the imports, datastores and dialogs used by each of the safety document types.
SafetyStateTransActions.inc	This file includes a set of actions pertaining to safety state transitions. The action names follow the format of SAFETY_STATE_ACTION_<New State>. These action names are looked up by the code, so the format of the action name has to be as specified. The actions each contain a list of commands that will be initiated when a safety document transitions to a new state. Each of the actions take one parameter called $FROM_SWITCHING$, which indicates whether the request is coming from Web Switching Management or not. See document for command StateTransitionCommand for more information. The file also includes an action defining the actKey to use when recording devices into the Tag Points device lists through view selections. This actKey pertains to the control action used to apply the appropriate tag to the device when the document is issued.
SafetyStateTransValidationRules.inc	This module defines the validation rules for the group name CHECK_FOR_DEVICES_AND_CREWS. This validation group is normally initiated when a safety document transitions to a new state. This can happen when executing steps from a sheet or from a safety document.
SafetyTool	This module defines the tool behavior for each of the safety document types. The modules also include all of the other modules used to build the GUI configuration for each of the safety document types.
SafetyTitle	The title configuration for all the safety document types.
SafetyToolbar	The safety document toolbar configuration.
SafetyBody	The document configuration for each of the safety document types. This module includes conditional checks for each of the safety document types to determine when to display components on the GUI as not all of the safety documents have the exact same GUI layout.
SafetyDeviceListPopupMenu	This is the popup menu in the Tag Points device list. It includes actions to remove, view and model verify the device.
SafetyGroundsListPopupMenu	This is the popup menu in the Grounds device list. It includes actions to remove, undo, view and model verify the device.
SwmanStandAloneSafetyTool	Defines the tool behavior for the stand alone safety documents. This module also includes all of the other modules used to build the GUI configuration for this tool.
SwmanStandAloneSafetyMenuToolBar	Defines the MenuToolbar for the stand alone safety documents. This includes items like the Save and Exit options.
SwmanStandAloneSafetyPopupMenu	This is the popup menu in the Step Actions list. It currently only has one option and that's to verify individual steps when they have been impacted by a model edit.
SwmanStandAloneSafetyProperties	This module defines all the imports, datastores and dialogs used by the stand alone safety documents.
SwmanStandAloneSafetyStatusBar	The stand alone safety document's status bar configuration.
SwmanStandAloneSafetyStepsToolbar	The switching steps toolbar button definitions for the associated steps list.
SwmanStandAloneSafetyToolbar	The stand alone safety document toolbar configuration.