Web Safety provides Stand Alone Safety Documents for recording tagging operations outside of a switching plan. Web Safety is not a substitute for safety documents created in switching plans and, therefore, does not support the use of aggregate actions when recording tag points. Web Safety limits asset associations to those not involved in Open and Close operations.
Understanding the Stand Alone Safety Document Window
Stand Alone Safety Documents windows share many features and behaviors of switching sheet windows. Like switching sheets, Stand Alone Safety Documents cannot be moved outside of the confines of the NMS workspace. Stand Alone Switching Document windows open in the lower right quadrant of the workspace, but may be moved anywhere within the workspace or maximized to the full workspace dimensions.
Each open safety document has its own tabbed window, which is labeled with a combination of the safety document type and the number. Multiple safety documents and switching sheets are typically docked together and displayed as a tab group. Double-click any tab (or the empty area to the right of the tabs) to maximize the tab group; double-click again to restore the size.
Right-click a tab to access the context menu, which provides the following:
Note: For simplicity, the term sheet will be used to mean either a stand alone safety document or switching sheet.
• Maximize: maximizes the window.
• Restore: restores the maximized window to its original size and position.
• New Tab Group: displays the sheet separately.
• Collapse Tab Groups: regroups separate windows into tab groups.
• Windows...: opens a dialog box that lists all open sheets, which you can then:
• Activate (that is, bring to front in a tab group) a single sheet.
• Close selected sheets.
• Close: closes the sheet.
• Close All: closes all open sheets.
• Close Others: closes all open sheets except the sheet that was right-clicked.
Menu and Toolbar Features
File Menu
The table below describes the options available on the File menu.
Menu Option
Description
Toolbar Icon
Save
Saves the Safety Document.
Copy As...
Opens the Safety Document Types dialog box that allows you to create a new safety document with the current document's data. See Copying a Safety Document for more details.
--
Associate...
Display the Switching Sheet Association dialog box. From the dialog box you can associate the safety document to a switching sheet. See Switching Sheet Associations for more details. Once the safety document is associated, it is no longer a stand alone safety document and when viewed the document takes on the look of a switching sheet associated safety document.
Delete
Transition the document to the Deleted state and remove it from any of the safety document lists. This option is only available while the document is in the New state.
--
Print Preview...
Opens the Report Format dialog box that allows you to choose the criteria for previewing a safety document report.
Print...
Opens the Report Format dialog box that allows you to choose the criteria for printing a safety document report.
Email...
Opens the Report Format dialog box that allows you to choose the criteria for emailing a safety document report.
Exit
Closes the active safety document.
--
Help Menu
Option
Description
Toolbar Icon
Web Safety Help
Opens online help content for safety documents.
--
About Web Safety
Opens a window with environment and software information.
--
Toolbar Buttons
• The / buttons allow you to toggle Control Tool related recording on or off, respectively.
• The Paste button () allows you to add a step cut from the Miscellaneous Log or copied from another Safety document. See Adding Assets to a Non-Execute Safety Document for more information.
• The Place Condition button () is used to apply conditions when the condition actions were recorded in study mode through the Control Tool.
• The Issue button () issues the selected safety document. A record of the transition is added to the Audit Log. Selecting this button will cause the Unissue and Release buttons to be enabled.
• The Unissue button () is used to place an Issued safety document or a Released safety document into an Unissued (edit) state where the asset lists can be altered. While in the Unissued state, you can add assets to the lists and mark assets already in the list for removal. Only when the safety document transitions back to the Issued state will the changes be applied. Selecting this button will cause the Issue button to be enabled.
• The Release button() releases the selected safety document. This button is only enabled if the safety document has been issued. Selecting this button will cause the Issue and Complete button to be enabled.
• The Complete button () completes the selected safety document.
• The Abort button () allows you to set the status of the safety document to Aborted. The system prompts you to confirm the action before aborting. This button is only available in real-time mode and only for safety documents that are in the New state.
• The Confirm Model Changes button () becomes available when model changes have occurred that impact one or more assets in the safety document.
The Web Switching service checks all the active safety documents after a model edit has occurred. If a safety document has an asset that matches an asset that was directly impacted by a model change, that asset will be marked as needing verification. When the safety document is displayed, these assets will be highlighted in yellow. You can either verify each asset in the document or verify the entire document.
Note: While the safety document has verifications pending, safety state transitions cannot be performed within the document.
Any asset related field values that are pulled from model or attribute data will be dynamically updated after the model change. This includes the Pressure Zone and Lift Station fields.
Individual Verification
To check off each asset individually, right-click the highlighted asset and select Model Verify.
Whole Safety Document Verification
To verify all of the assets in a sheet, click the verify (check mark) button () to confirm all model changes. All highlighted assets will be marked as verified.
Once the assets have been verified, safety state transitions can continue for the document.
• The Reset Study Session () allows you reset your study session to a copy of either Real Time or Nominal conditions.
• The Real Time button () switches the document to real time mode.
• The Study Session button () switches the document to study mode.
• The Step Actions button () toggles the actions view at the bottom of the safety document. The actions are identical to switching steps found in switching sheets. The actions list includes the tag and safety state transition actions associated to the document.
Safety Document Fields
The Stand Alone Safety Document dialog box displays the following fields:
• Tag Points display the assets that the safety document is associated with.
• Table Columns
• Edit State: an iconic representation of the edited state of the asset in the Unissued state. The edits will be applied when the document is issued. When working in Study mode, the edit state indicators will remain visible until the document is issued in real time.
• : The asset has been marked for removal.
• : The asset has been added to the asset list and will be used as a boundary point the next time the document is issued.
• Asset: the asset used to define the area or point of coverage of the safety document.
• Toolbar Buttons
• The / buttons allow you to toggle recording of assets on or off, respectively. The Tag Points list allows you to record assets by selecting them in the Viewer. To enable this feature, turn on recording and select assets in the Viewer.
• The Add Asset... button () allows you to manually add an asset to the list.
• The Undo Asset Edit button () allows you to undo an addition or removal of an asset from the list. This option is only available when making asset modifications in the Unissued state.
• The Remove Asset button () allows you to remove a selected asset from the Tag Points asset list.
• The Object Focus button () focuses the Viewer 1 window on the selected asset.
• Other Assetsis a text field that allows you to enter a list of non-modeled assets.
Note: An entry is required in at least one of these fields: Tag Points, or the Other Assets.
• Nominal Pressure Zonesfield allows you to enter pressure zone values and can also be automatically populated with nominal pressure zones associated to the assets listed in the Tag Points list. The following button is displayed to the right of the Pressure Zones field:
• The Update button () is used to populate the NominalPressure Zones field with the list of pressure zones associated with assets listed on the safety document.
• Nominal Lift Station displays the nominal lift stations for the assets listed in the Tag Points list. To alter this value, enter your new value into the field.
• The Update button () is used to populate the Nominal Lift Station field with the list of lift stations associated to the assets listed on the safety document.
• Current Pressure Zonesdisplays the current pressure zones for the assets listed in the Tag Points list. This value is read-only and will dynamically update as long as the safety document is loaded.
• Current Lift Station displays the current lift stations for the assets listed in the Tag Points list. This value is read-only and will dynamically update as long as the safety document is loaded.
• Asset displays the asset being worked on (not necessarily the asset being switched). This asset is also used to identify what control zone the document is found in. If you do not have authority over the zone the document is associated to the document will not show up in the Open Safety Document list. The following buttons are displayed to the right of the Asset field:
• The Assets Lookup button () is used to search for and select an asset.
• The LinkAsset button () to link an asset selected from the Viewer to the switching sheet. Select the asset in the Viewer, and then click the LinkAsset button (). The Asset field is populated with the selected asset's name.
• The UnlinkAsset button () clear a linked asset from the Asset field.
• The Object Focus button () focuses the Viewer 1 window on the selected asset.
• Assigned Crews displays a table list of the Crew IDs of the crews that the safety document has been issued to, as well as each crew's mobile number, mobile carrier, alternate number, alternate number type, pager number, and crew type. A crew is required in this list before the document can be issued.
• To select a crew to assign to this safety document, click the Select Crew... () button to open the Select Safety Crew dialog box. See Assigning Crews to a Safety Document.
• To change a crews position, click the Crew Issued/Clear () button and select either Issued or Clear from the context menu.
• To delete crews from this list, click the crews and then click the Clear Crews button (). When the document is in the Issued state, all but the last crew can be cleared from the list. At least one crew must remain assigned while the document is in the Issued state.
• Description is a text field that allows you to enter notes for the safety document.
• Audit Log contains the following information:
• Table Fields:
• Date: the date and time of each entry.
• Description: a description of the state change or asset operation.
• Asset: the asset associated with the step.
• User: the name of the user who recorded the action.
• Crews: the crew identifiers pertaining to the audit log entry.
• The Comment section of the Audit Log pane allows you to add a comment to the log.
• The Edit Log tracks the changes made to the entry fields of the document. It contains the following information:
• Date: the date and time of each entry.
• User: the name of the user who recorded the action.
• State: the state of the safety document when the entry was added.
• Field: The name of the field that was updated.
• Previous Value: The previous value of the field before the update.
• The Steps section contains all of the step actions associated with the safety document.
Creating New Stand Alone Safety Documents
Creating a Safety Document from the Web Workspace
To create a new Stand Alone Safety Document from the Web Workspace, from the File menu, select New, and then select Safety Document... The New Safety Document window will open.
Note: You may click the toolbar button () rather than the File menu.
From the New Safety Document window, you may create a safety document based on a blank template or from a pre-existing safety document.
Create a New Blank Safety Document
To create a blank safety document from the New Safety Document dialog box, do the following:
1. Select a safety document type from the Safety Document Type list.
2. Click Create; the new safety document will open.
Create a New Safety Document with Existing Safety Document Data
You may want to create a new safety document with data from an existing safety document; for example, creating multiple safety documents types to be used in a multi-step switching operation.
1. Select a safety document type from the Safety Document Type table.
2. From the Pre-Created Safety Documents table, select an existing safety document that has the data you need for the new document.
3. Click Create a Copy; the new safety document will open and be populated with asset data from the pre-created safety document. The Create a Copy button will only be visible after you have selected a safety document type and a safety document within the pre-created safety document list.
Creating a New Safety Document from the Control Tool
To create a new Stand Alone Safety Document from the Control Tool, do the following:
1. Make sure the Viewer is in Real Time mode. The safety document creation options are only available in Real‑Time mode.
2. Open the Control Tool for the asset to be associated with a new safety document.
3. Click the Safety Documents... button and then select the option to create the new safety document type:
• Create HOLD Document
• Create Clearance Document
• Create Information Document
• Create Warning Document
• Create Delegated Control Document
A new safety document will be created with the Tag Points list automatically populated with the originating asset's id and full set of phases. The safety document's Asset field will be automatically populated with the source asset used to bring up the Control Tool.
Using Stand Alone Safety Documents
Record Tag Operations
1. Create a new stand-alone safety document.
Note: The new document will open in Real-Time mode with Control Tool action and Viewer asset selection recording on.
2. Turn Tag Points Viewer asset selection recording off.
3. Double-click an asset in the Viewer to launch its Control Tool.
4. Click Tag... and choose a place tag operation associated to that document type. (For example, select Place HOLD Tag for a HOLD document.)
The asset is displayed in the Tag Points list.
5. Click the Step Actions toggle button () and note that the operations are recorded there as well. This is the source list and this list feeds the Asset list found on the document's main form.
Record Ground Operations
1. Create a stand-alone safety document.
2. Turn Tag Points Viewer asset selection recording off.
3. In real-time mode, with Control Tool action recording on, select an asset in the Viewer and Place Tag operation associated to that document type. (For example, select a Place HOLD for a HOLD document.) The asset is displayed in the Tag Points list.
4. Click the Step Actions toggle button () and note that the operations are recorded there as well. This is the source list and this list feeds the Asset list found on the document's main form.
Remove an Asset from a Safety Document
1. Create a stand-alone safety document.
2. Record tagging operations in real-time.
3. Select one of the assets in the Tag Points list and click the Delete button () to remove the asset.
Note: The Remove option is only available when the document is in the New or Unissued state.
4. Open the Miscellaneous Log and note that it now lists the Place Tag operation step that was removed from the safety document.
The associated action step will only show up in the Miscellaneous Log, after being removed, if the action was recorded from the Real‑Time Control Tool. If the asset was recorded as a selection from the Viewer, then the asset will simply be removed and no action steps will be moved to the Miscellaneous Log.
Issuing, Releasing, and Completing a Safety Document
1. Create a stand-alone safety document.
2. Record some tagging operations in Real Time.
3. From the document, assign a crew to the document.
4. Issue the document. The conditions in the Viewer will change to indicate that they are under the control of a safety document by displaying a padlock symbol on top of the condition symbol. The status of the document is updated in the status bar, which is found at the bottom of the document. An audit log entry is created for the state transition.
5. Release the document. The conditions in the Viewer will change to indicate that they are no longer under the control of the safety document. The status of the document is updated in the status bar, which is found at the bottom of the document. An audit log entry is created for the state transition.
6. From the Viewer, remove the tagging operations while recording is on in the safety document. The actions are recorded in the Audit Log of the safety document.
7. Complete the document. The safety document status is updated and unlocked and placed into View Only mode. All the toolbar options are desensitized except Copy As..., Print, Email, Help, Exit, and Focus.
Loading a Safety Document
1. From the Open Safety Document list, load a safety document not associated to a switching sheet.
Deleting a Safety Document
1. Create a stand-alone safety document.
2. From the document's File menu, select Delete. The document will be marked as Deleted and will no longer be listed in the Safety Document List. Safety documents can only be deleted when no Real‑Time tags are associated and listed in the Tag Points list.
Copying a Safety Document
Option 1
1. From the New Safety Document dialog box, refresh the pre-created safety document list.
2. Select a pre-created safety document and a target document type.
3. Click Create a Copy. A new safety document is created. This new document will have the same list of asset as the original document. The Audit Log of the new document will have one entry describing when the document was created.
Option 2
1. From the stand alone safety document's File menu, select Copy As....
2. Select a document type from the list.
3. Click Create a Copy. A new safety document is created. This new document will have the same list of assets as the original document. The Audit Log of the new document will have one entry describing when the document was created.
Create a Safety Document in Study Mode
1. From the New Safety Document dialog box, select a safety document type and click Create. The new document is created and by default goes into Real-Time mode.
2. Click the Study Mode button ().
3. Verify that Control Tool action recording is on and Viewer asset selection recording is off.
4. Open the Viewer in Study Mode.
5. Add appropriate tags to assets. As the actions are recorded by the safety document, the assets show up in the Tag Points lists.
6. Once all of the tags have been applied, issue the safety document, and release it to test in Study mode.
7. Reset the study session from the safety document.
8. Select the Tag Points and place the tag points in the model. This can be done by selecting the asset and clicking the Place Condition button ().
9. Click the Focus button (). The Viewer will display the appropriate conditions on the assets.
10. Issue the safety document. The conditions displayed in the Viewer will change to indicate that they are under the control of a safety document. This is indicated by displaying a padlock symbol on top of the condition symbol in the Viewer. The status of the document is updated in the status bar, which is found at the bottom of the document.
Associate an Existing Place Tag Action to a Safety Document
1. With no switching sheet or safety document in record mode, find an asset that can have a HOLD condition.
2. Double-click the asset to launch the Control Tool.
3. Select Place Hold Tag from the Tag... menu's Hold Tags submenu. A Hold Tag step is recorded into the Miscellaneous Log.
4. Create a HOLD safety document.
5. Load the Miscellaneous Log and refresh the list so that the Place Hold Tag step is displayed.
6. Select the Place Hold Tag step. Click the Cut Step button () to cut the step.
7. Go back to the newly created Hold Safety document and click the Paste button (). The asset associated to the Place Hold Tag step is displayed in the safety document's Tag Points list. The safety document can now be issued.
Note: If you attempt to add a step action association that is not valid for the safety document type, an error message will be displayed. For example, you would get an error if you attempted to add a step action for a Place Hold Tag into a Clearance document.