61
EW/MA Advisory Procedures Manual/ User Guide 7001 Weston Parkway, Suite 200 Cary, North Carolina 27513 © 2017 Railinc Corp. All Rights Reserved. Doc Release 3.1 Last Updated: May 2017

EW/MA Advisory Procedures Manual - Railinc Corporation

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: EW/MA Advisory Procedures Manual - Railinc Corporation

EW/MA Advisory Procedures Manual/ User Guide

7001 Weston Parkway, Suite 200 Cary, North Carolina 27513

© 2017 Railinc Corp. All Rights Reserved.

Doc Release 3.1 Last Updated: May 2017

Page 2: EW/MA Advisory Procedures Manual - Railinc Corporation

Revised May 2017 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Page 3: EW/MA Advisory Procedures Manual - Railinc Corporation

Revised May 2017 i Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Table of Contents Welcome to Early Warning .................................................................................................................. 1

Early Warning/Maintenance Advisory Overview ............................................................................... 1 EW/MA Integrated System ............................................................................................................. 2 Related Documents ......................................................................................................................... 2

Early Warning Web Application Overview ........................................................................................ 3 Process Flow ................................................................................................................................... 3 User Roles ....................................................................................................................................... 4

Changes for This Document Release .................................................................................................. 5 User Guide Structure ........................................................................................................................... 5

System Requirements ..................................................................................................................... 5 Web Browser .................................................................................................................................. 6 PDF Viewer .................................................................................................................................... 6 CSV Format .................................................................................................................................... 6 Web Interface.................................................................................................................................. 6 Early Warning Web Page Layout ................................................................................................... 7 Early Warning Interface Elements .................................................................................................. 8

Getting Started .................................................................................................................................... 13 Register to Use Railinc SSO ............................................................................................................. 13 Requesting Early Warning Access .................................................................................................... 13 Logging In ......................................................................................................................................... 14 Logging Out ...................................................................................................................................... 16

Create Notice ....................................................................................................................................... 17 Create the Basic Notice ..................................................................................................................... 18 Preview the Notice ............................................................................................................................ 21 Assign Equipment ............................................................................................................................. 23 Submit the Notice .............................................................................................................................. 25 Edit the Notice .................................................................................................................................. 26

Assign Equipment after Submitting .............................................................................................. 26 Create a Supplement ..................................................................................................................... 26

Report Inspection ................................................................................................................................ 30 Report Inspections from the Menu .................................................................................................... 30

Enter Equipment IDs .................................................................................................................... 31 Validate Equipment IDs ............................................................................................................... 31 Enter Inspection Data ................................................................................................................... 31 Validate Inspections ...................................................................................................................... 33 Submit Inspections ........................................................................................................................ 33

Report Inspections from a Query ...................................................................................................... 34 Query Notices ...................................................................................................................................... 35

Basic Query ....................................................................................................................................... 35 Notice Query ................................................................................................................................. 36

Attachments .............................................................................................................................. 38 Adding Attachments ............................................................................................................ 39 Viewing Attachments ........................................................................................................... 41 Removing Attachments ........................................................................................................ 41

Equipment Query .......................................................................................................................... 43 Advanced Query ............................................................................................................................... 46

Query Trans Log ................................................................................................................................. 48 Back Out Inspection .......................................................................................................................... 49 View Transaction Log Query Details ................................................................................................ 50

Page 4: EW/MA Advisory Procedures Manual - Railinc Corporation

Revised May 2017 ii Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Configure Ticklers .............................................................................................................................. 51 References ............................................................................................................................................ 52 Glossary ................................................................................................................................................ 53 Index ..................................................................................................................................................... 54

List of Exhibits Exhibit 1. EW/MA Integrated System .................................................................................................... 2 Exhibit 2. Early Warning Business Process Flow ................................................................................... 3 Exhibit 3. Early Warning Computer Requirements ................................................................................ 5 Exhibit 4. Early Warning Web Application Page Layout ....................................................................... 7 Exhibit 5. Highlighted (focused) Hyperlink ............................................................................................ 8 Exhibit 6. Text Boxes .............................................................................................................................. 8 Exhibit 7. Drop-Down List...................................................................................................................... 8 Exhibit 8. Checked Check Box ............................................................................................................... 9 Exhibit 9. Scroll Bar/Button and Usage .................................................................................................. 9 Exhibit 10. Fixed Field Scroll Arrow ...................................................................................................... 9 Exhibit 11. Browser Back and Forward Buttons ................................................................................... 10 Exhibit 12. Command Buttons - Validate and Back buttons focused ................................................... 10 Exhibit 13. Command Buttons .............................................................................................................. 10 Exhibit 14. Error Message Example ..................................................................................................... 11 Exhibit 15. Confirmation Message Example ........................................................................................ 11 Exhibit 16. Icons ................................................................................................................................... 11 Exhibit 17. Table ................................................................................................................................... 12 Exhibit 18. Early Warning Request Permission Form for New Users .................................................. 13 Exhibit 19. Welcome Page for standard query user .............................................................................. 14 Exhibit 20. Early Warning Main Menu for Regular Users ................................................................... 15 Exhibit 21. Early Warning Menu for Company/Admin Authorized Users ........................................... 15 Exhibit 22. Early Warning Application Menu Functions ...................................................................... 15 Exhibit 23. Create Notice ...................................................................................................................... 18 Exhibit 24. Basic Create Notice Fields ................................................................................................. 19 Exhibit 25. Severity Codes .................................................................................................................... 19 Exhibit 26. Sample MA Notice prior to Preview .................................................................................. 20 Exhibit 27. Sample Preview Notice ...................................................................................................... 21 Exhibit 28. Preview Processing Options ............................................................................................... 22 Exhibit 29. Assign Equipment .............................................................................................................. 23 Exhibit 30. Assign Equipment with IDs entered ................................................................................... 23 Exhibit 31. Assign Equipment after Validation .................................................................................... 23 Exhibit 32. Create Notice Letter Preview with Equipment IDs appended to bottom ............................ 24 Exhibit 33. Preview Processing Options after Assigning Equipment ................................................... 24 Exhibit 34. Create Notice Confirmation after Submission .................................................................... 25 Exhibit 35. Equipment assigned to Notice ............................................................................................ 26 Exhibit 36. Create Supplement Notice .................................................................................................. 27 Exhibit 37. Create Supplement Notice Preview .................................................................................... 28 Exhibit 38. Notice View Processing Options ........................................................................................ 29 Exhibit 39. Supplement Submission Confirmation ............................................................................... 29 Exhibit 40. Report Inspections .............................................................................................................. 30 Exhibit 41. Report Inspections after entering Equipment ID ................................................................ 31 Exhibit 42. Report Inspection after Validation ..................................................................................... 31 Exhibit 43. Report Inspections ready for inspection data entry ............................................................ 31 Exhibit 44. Report Inspections after validation ..................................................................................... 33

Page 5: EW/MA Advisory Procedures Manual - Railinc Corporation

Revised May 2017 iii Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 45. Report Inspections after successful submission ................................................................. 33 Exhibit 48. Basic Query with defaults................................................................................................... 35 Exhibit 49. Basic Query Fields ............................................................................................................. 35 Exhibit 50. Notice Numbers .................................................................................................................. 36 Exhibit 51. Basic Query with Notice View with Notice number entry ................................................. 36 Exhibit 52. Query Processing Options .................................................................................................. 37 Exhibit 53. Query Notices Result .......................................................................................................... 37 Exhibit 54. Notice View <MA or EW-####> - Top Section ................................................................ 37 Exhibit 55. Notice View Processing Options ........................................................................................ 38 Exhibit 56. Count Results for Notice View ........................................................................................... 38 Exhibit 57. Attachments ........................................................................................................................ 39 Exhibit 58. Select a file to upload ......................................................................................................... 39 Exhibit 59. Attachments - selected file to attach ................................................................................... 39 Exhibit 60. Attachments with success message and attached file ......................................................... 40 Exhibit 61. Attachments with a single file attached .............................................................................. 41 Exhibit 62. Confirm Attachment Removal ............................................................................................ 42 Exhibit 63. Attachments with successful attachment removal message ............................................... 42 Exhibit 64. Basic Query for Equipment View ...................................................................................... 43 Exhibit 65. Query Processing Options .................................................................................................. 43 Exhibit 66. Equipment View ................................................................................................................. 44 Exhibit 67. Count Results for Equipment View .................................................................................... 45 Exhibit 68. File Download .................................................................................................................... 45 Exhibit 69. CSV file opened in Excel ................................................................................................... 45 Exhibit 70. Advanced Query Fields ...................................................................................................... 46 Exhibit 71. Mechanical Designations .................................................................................................... 47 Exhibit 72. Transaction Log with default times and Notice Number entry........................................... 48 Exhibit 73. Transaction Log Query Results .......................................................................................... 49 Exhibit 74. Transaction Log Query with selected record for Inspection Backout ................................ 49 Exhibit 75. Backout Inspections ............................................................................................................ 49 Exhibit 76. Transaction Log Query after Inspection Backout ............................................................... 50 Exhibit 77. Transaction Log Detail - Notice ......................................................................................... 50 Exhibit 78. Configure Ticklers .............................................................................................................. 51 Exhibit 79. EW/MA Advisory Procedures Manual/User Guide ........................................................... 52

Page 6: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning

Revised May 2017 1 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Welcome to Early Warning

Early Warning/Maintenance Advisory Overview The Early Warning/Maintenance Advisory (EW/MA) system provides a method for the rail industry to identify mechanical problems on rail equipment which could impact the safe movement or handling of the equipment. The EW/MA system consists of three processes.

The first process is the creation of an EW/MA Notice. The EW/MA notice provides the rail industry a description of the mechanical problem, its severity, and other information applicable to the notice. When the initial notice is updated to provide additional information about the mechanical problem, a supplemental notice is created. Supplemental notices are inclusive and supersede all prior notices. The Association of American Railroads (AAR), Safety & Operations Department is responsible for the creation of EW/MA Notices and Supplemental Notices.

The second process is the assignment of equipment to the EW/MA Notice identified by the industry as having the applicable mechanical problem. The authority to assign equipment to a notice will be determined by the AAR Safety & Operations Department when the EW/MA Notice is created. The AAR Safety & Operations Department personnel may permit equipment owners or specific companies to assign equipment to the notice or restrict the assignments to AAR Safety & Operations Department personnel. The Umler Component Registry can automate the assignment of equipment to component-related notices by associating a Component Registry recall query with an EW/MA notice.

The third process is locating the equipment and performing the work defined in the EW/MA. If the work cannot be done at its present location, a preliminary inspection may be reported to the system. A preliminary inspection provides a ‘movement’ status of the equipment, i.e., car moving to shop. Once the defined work on the equipment is performed, a final inspection is reported to the system and the equipment is removed from the EW/MA Notice.

The EW/MA system provides an Internet application for the creation of the EW/MA Notice, the assignment of equipment to the notice, and the reporting of inspections and repairs performed on the equipment. New to the Internet application is a set of notifications or “ticklers” to alert users when EW/MA Notices have been created, when their equipment has been added to or removed from a Notice, and when a Notice is approaching expiration. Additionally, users now have the ability to interact with the EW/MA system via Web Services, allowing them to perform queries of the system and to report equipment inspections.

The Internet system will also automatically distribute the updated information via TRAIN II outbound messages to rail industry subscribers. A subscriber to these messages may receive all updates to the EW/MA system (known as broadcast messages) or may elect to receive only updates on their equipment (known as direct addressed messages).

In addition to the EW/MA Internet system, there is an EW/MA Batch Message System. The batch message system may be used as an alternative for reporting updates to the EW/MA system. The EW/MA batch message system processes inbound EW/MA assignment and inspection messages and distributes the updated information via TRAIN II outbound messages to rail industry subscribers.

Although the batch message system processes inbound EW/MA assignments and inspections, it does not accept inbound EW/MA Notices. EW/MA Notices can only be created by the AAR using the EW/MA Internet system. However, the Internet system will generate outbound EW/MA Notices.

Page 7: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning

Revised May 2017 2 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Additional processing is required in the EW/MA batch system. The batch processing must edit the inbound message to ensure the message is formatted properly. As part of this process, if errors are found in the inbound message structure, the originator/submitter of the message may elect to receive Envelope Error Messages which identify applicable errors. For example, if the detail count, defined in the summary record did not match with the accumulated system count, an envelope error message would be generated. Although receipt of this message is optional, it is highly recommended that all submitters of inbound messages request receipt of this message to ensure proper handling of the inbound message.

Also, inbound message submitters may elect to receive Acknowledgment Messages. An Acknowledgement Message is returned to the originator of the inbound message acknowledging that the EW/MA system received the inbound message.

EW/MA Integrated System Exhibit 1. EW/MA Integrated System

Related Documents • AAR Field Manual Rule 125 (order via http://www.aarpublications.com/). • Umler Component Registry User Guide • EW/MA Advisory Procedures Manual/User Guide, accessed from References menu item • Early Warning TRAIN II Technical Guide (accessed from the Early Warning System page) • Early Warning Web Services Documentation—contact the Railinc Customer Support Center

(CSC): Call (877) 724-5462 or email [email protected] and request Early Warning Web Services documentation.

Page 8: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning

Revised May 2017 3 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Early Warning Web Application Overview Early Warning is a web-based application that allows authorized users a graphical interface to create Maintenance Advisory (MA) and Early Warning (EW) notices, issue supplements to notices, assign equipment to notices, report inspections and repairs for equipment, and perform queries of notices and equipment.

Process Flow Exhibit 2. Early Warning Business Process Flow

Page 9: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning

Revised May 2017 4 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

User Roles Early Warning allows Standard users to:

• Query existing MAs and EWs (Exhibit 18 ) • View Transaction Logs and details • View Configure Ticklers and edit email addressees • View User documentation

Early Warning allows Inspection Reporter users to:

• Query existing MAs and EWs • View Transaction Logs and details • View Configure Ticklers and edit email addressees • View User documentation • Report Inspections for MAs and EWs (including backouts and equipment unassignments)

Early Warning allows Company Administrators users to:

• Query Existing MAs and EWs. • View Transaction Logs and details • Report Inspections for MAs and EWs (including backouts and equipment unassignments) • View Configure Ticklers and edit email addressees • View User documentation • Assign other SSO users within their company (except themselves) Early Warning tasks in

SSO: – Query (shown for new users only) – Assigning Equipment to notices – Reporting Inspections (includes backing out inspections and unassigning equipment

via inspection reporting interface) – Creating Notices (includes creating supplements and working with attachments, but

does NOT include assigning equipment to those notices) – Create other Company Admins (e.g., a company admin backup)

Early Warning allows Railinc Application Administrators to:

• Assign any other user advanced Early Warning tasks in SSO, including internal Railinc application admin (e.g., an application admin backup)

• Query Existing MAs and EWs. • Create new MAs or EWs • Assign Equipment to MAs and EWs • Submit Supplements to MAs and EWs • Attach documents to MAs and EWs • Report Inspections for MAs and EWs • Unassign equipment from notices via inspection reporting interface • View Transaction Logs and details • Back Out inspections • View Configure Ticklers and edit email addressees • View User documentation

Page 10: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning Changes for This Document Release

Revised May 2017 5 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Changes for This Document Release Most functions and steps to complete them remain the same, but the interface look and feel has changed. The following menu item names have changed:

• Notifications has been renamed Configure Ticklers

• Documentation has been renamed References

User Guide Structure This document has been organized to reflect the application menu order of Early Warning. It describes use and interpretation of interface elements in Early Warning.

The EW/MA Advisory Procedures Manual/User Guide is in an “offset” style. Dictionary-like retrieval text is used in the header.

Railinc Single Sign-On (SSO) information is included, and references to the Railinc Single Sign-On User Guide added. SSO information for Early Warning administrators is also in the Railinc Single Sign-On User Guide.

Whenever possible the term “select” is used to indicate making a choice using either the mouse or keyboard. Left-clicking generally activates a control or selects an item. Where a double-click is required, it is specified. Typical keyboard selection equivalents are described in Early Warning Interface Elements.

Underlined blue links are functional links to go to another location in the user guide.

System Requirements Here are some basic computer requirements for Early Warning.

Exhibit 3. Early Warning Computer Requirements

Supported Browser Types: Internet Explorer, Mozilla Firefox, Google Chrome

Browser Versions: • Internet Explorer 9 or later • Mozilla Firefox 29 or later • Google Chrome 35 or later

Screen Resolution: 1024 × 768 or larger (optimal)

Page 11: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 6 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Web Browser Early Warning requires a web browser to display its data. Most computers have Internet Explorer or Mozilla Firefox installed. To ensure optimum performance of Early Warning, use a recommended version of Internet Explorer or Firefox. Here are the two download sites:

• Internet Explorer: https://www.microsoft.com/en-us/download/internet-explorer.aspx

• Mozilla Firefox: https://www.mozilla.org/en-US/firefox/new/

• Google Chrome: https://www.google.com/chrome/

To enable the download function:

• Adobe Flash Player version 10.0.42.34 (or later): http://get.adobe.com/flashplayer/

PDF Viewer Some functions of Early Warning require Adobe Acrobat Viewer to view Portable Document Format (PDF) documents. For example, updates to this manual are available in PDF. Here is the download site for a free and current version of Acrobat Reader: https://get.adobe.com/reader/

CSV Format Early Warning download functions use Comma Separated Value (CSV) file format. This format is supported by Microsoft Excel versions 97 and higher. Users that do not have Excel 97 or higher installed on their machine or have a compatible spreadsheet application may download a free Microsoft Excel Viewer from Microsoft Corporation: https://www.microsoft.com/en-us/download/details.aspx?id=10

Web Interface The Early Warning interface provides the same navigational tools found in most Windows applications and Internet sites. This section provides basic explanations of the elements and components that assist in moving through the various pages of the application to complete tasks. Mouse and keyboard equivalents are discussed for each element.

Page 12: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 7 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Early Warning Web Page Layout Each page in Early Warning has the same structure.

Exhibit 4. Early Warning Web Application Page Layout

1 Logo—Railinc logo.

2 Application Title—Name of the application.

3 Sign-On Information—Shows the currently logged on user.

4 Navigational Links—Links for the following functions:

• Sign Out—logs out of all SSO applications and returns to the Railinc SSO Login page.

• Launch Pad—opens a new window with user’s Launch Pad page.

• Contact Us—opens a page of contact information for Railinc Customer Support.

5 Main Menu—The options on this menu allow user to perform the various functions of the application. For users this can include Create Notice, Report Inspection, Query Notices, Query Trans Log, Configure Ticklers, and References. Selecting opens the function in the content area. Selecting References opens this guide in a new tab.

6 Page Title—The name of the specific content page.

7 Page content area—The area of the page where data is displayed and tasks are executed (shown outlined with red dashes). These vary and may include a number of different elements, which are described in the next sections.

Page 13: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 8 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

8 Executables—Filters and command buttons for the displayed content. Standard (query only) users do not have as many executable options.

Early Warning Interface Elements Application Menu The Early Warning application menu can include Create Notice, Report Inspection, Query Notices, Query Trans Log, Configure Ticklers and References. Selecting opens the function in the content area.

Hyperlinks Hyperlinks appear in the application as white highlighted text. Selecting a hyperlink displays a page related to that subject (frequently additional details) or a tool to perform the indicated task.

Exhibit 5. Highlighted (focused) Hyperlink

Click to select a hyperlink.

Text Boxes Text boxes are empty fields that allow you to enter text. For example, the User ID and Password fields are text boxes (Exhibit 6). When entering a password the characters are encrypted and appear as a series of dots.

Exhibit 6. Text Boxes

Text boxes may have limits for the type of data to be entered (i.e., alpha, numeric, special characters), and/or the amount of characters entered (e.g., 255 characters), and the formatting allowed (e.g., date and time, use of hyphens/slashes).

Drop-Down List Some fields have an arrow located on the right side. This arrow indicates that predetermined options are available for you to select. Selecting the arrow displays a list of the available data entry options. Alternatively, press Shift + ↓ (down arrow key) to move up and down inside the list. Use the up and down key movement (↑↓) to navigate through the choices. Click to select one of the available choices, or press Enter when the item is highlighted.

Exhibit 7. Drop-Down List

Page 14: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 9 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Longer Drop down list may have a scroll bar at the right. Longer lists may offer first letter navigation, where typing a letter or number scrolls to that part of the list. Scrolling using the scroll bar and button is described in Scroll Bars/Buttons.

Check Boxes Select a check box by clicking on the check box or pressing the spacebar when the check box is focused while tabbing between fields. A selected check box contains a check mark. Select as many check boxes as applicable. To uncheck, click the check box again.

Exhibit 8. Checked Check Box

To perform an action on records, first check them and then select the desired command button, for example: Save.

Scroll Bars/Buttons Many Early Warning pages and elements have scroll bars and buttons. Some pages may have multiple scroll bars (page scroll bars and list scroll bars). These can be very close, so make sure to navigate using the correct scroll bar.

Exhibit 9. Scroll Bar/Button and Usage

Note: Some Early Warning Input fields have fixed dimensions and offer up and down scroll arrows without a button in between them (Exhibit 10).

Exhibit 10. Fixed Field Scroll Arrow

Use the up and down arrows to move toward the top of the entered text or the bottom of the text.

Page 15: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 10 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Browser Back and Forward Buttons Using the browser back and forward buttons (Exhibit 11) is not recommended. Use the menu items at the top when no navigation is provided. Caution should be observed when trying to navigate back to a screen viewed several screens previously. Once a transaction has been submitted to the system, it is not possible to reverse or undo the transaction by using the back button.

Exhibit 11. Browser Back and Forward Buttons

Command Buttons Command buttons are used to execute tasks throughout the Early Warning application. Command buttons are generally at the bottom of Early Warning content areas. To activate a command button, select the button with a left mouse click for focused buttons (see Exhibit 12). Grayed out buttons cannot be used. They will become focused buttons when certain information is entered or task is completed.

Exhibit 12. Command Buttons - Validate and Back buttons focused

Exhibit 13 contains general descriptions of buttons found throughout the Early Warning interfaces.

Exhibit 13. Command Buttons Name Function

Attachments Opens the Attachments panel to attach, view, or remove files for an MA or EW.

Back Causes the system to return to the previous page in the workflow. Work is discarded on some pages.

Back out Inspection Used to back out incorrectly entered inspections.

Continue Select after successful validation to keep processing. Create Supplement Select to modify body of existing notice.

Default Sort Restores a sorted table to its original order.

Done The system returns to the page representing the beginning of the current task or subtask.

OK Confirms an action or acknowledges an action has taken place. Preview Previews a created, edited, or supplemental MA or EW. Reset Resets data to defaults on pages.

Submit Submits entered data changes (e.g., supplements, created notices, inspections reported).

Page 16: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 11 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Messages When an action has been requested and cannot be completed, Early Warning displays a message at the top of the content area (Exhibit 14). Counts are also displayed in this same area (see Exhibit 56 and Exhibit 67).

Exhibit 14. Error Message Example

Confirmation Messages Confirmation messages are displayed after creating notices or supplements. These appear in the center of the content area and can be dismissed by selecting Done.

Exhibit 15. Confirmation Message Example

Icons Icons are graphic images used to display conditions, status, or to invoke secondary searches. Exhibit 16. Icons

Icon Description Executables

Open and close Advance Query section.

Open a search panel.

Opens a calendar date picker.

Item Manipulation

Sort Column Ascending. Arrow appears next to table column headings. Also used to scroll down in fixed-size input fields (Exhibit 17).

Sort Column Descending. Arrow appears next to table column headings. Also used to scroll up in fixed-size input fields (Exhibit 17).

Page 17: EW/MA Advisory Procedures Manual - Railinc Corporation

Welcome to Early Warning User Guide Structure

Revised May 2017 12 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Tables Many web pages use tables to display complex lists, and to organize data. Exhibit 17. Table

• Tables longer than one screen have a scroll bar at the right.

• Heading Links at the top of some table columns provide sorting capability, ascending or descending. Once sorted, the heading shows the appropriate arrow (see Exhibit 16).

Page 18: EW/MA Advisory Procedures Manual - Railinc Corporation

Getting Started Register to Use Railinc SSO

Revised May 2017 13 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Getting Started The Early Warning application is accessed using the Railinc Single Sign-On (SSO), which can be accessed from the Railinc portal at http://www.railinc.com. The SSO login is located at the upper right of the page.

Register to Use Railinc SSO Each Early Warning user must register to use Railinc Single Sign-On. It is beyond the scope of this document to describe the use of Railinc Single Sign On. Refer to Railinc Single Sign-On User Guide.

Once SSO registration is complete, the user must request access to Early Warning within SSO.

Requesting Early Warning Access After authorization to use Railinc SSO is received, the user must request general access to Early Warning with a specified Company ID following instructions in the Railinc Single Sign-On User Guide.

Exhibit 18. Early Warning Request Permission Form for New Users

Once user receives an email notification that access has been granted to Early Warning, then the user can log on and begin using Early Warning.

Page 19: EW/MA Advisory Procedures Manual - Railinc Corporation

Getting Started Logging In

Revised May 2017 14 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Logging In To log into Early Warning:

1. Open the browser.

2. Open the Railinc portal at http://www.railinc.com.

3. Log in to SSO (at upper right). The user’s Launch Pad with authorized Railinc applications is displayed.

Note: For more information about the Launch Pad, refer to the SSO/Launch Pad User Guide.

4. Select Early Warning. The Early Warning Welcome page is displayed as shown below.

Exhibit 19. Welcome Page for standard query user

The main menu is displayed (Exhibit 20 or Exhibit 21). Continue by selecting a menu item (refer to Exhibit 22).

Page 20: EW/MA Advisory Procedures Manual - Railinc Corporation

Getting Started Logging In

Revised May 2017 15 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 20. Early Warning Main Menu for Regular Users

Exhibit 21. Early Warning Menu for Company/Admin Authorized Users

The Early Warning Welcome page can have the following menu items:

Exhibit 22. Early Warning Application Menu Functions Welcome Page Returns to the users Home Page (similar to Exhibit 19.

Welcome Page for standard query user).

Create Notice Opens the Create Notice panel (Exhibit 23).

Report Inspection Opens the Report Inspections panel (Exhibit 40).

Query Notices Opens the Early Warning Query panel (Exhibit 48).

Query Trans Log Opens the Transaction Log page (Exhibit 73).

Configure Ticklers Opens the Configure Ticklers page (Exhibit 78).

References Opens the EW/MA Advisory Procedures/User Guide in a new window (Exhibit 79).

Note: Menu content varies based on role-based permissions granted by the Railinc Application SSO Administrator. See the Company SSO Administrator to request additional permissions beyond Query.

Page 21: EW/MA Advisory Procedures Manual - Railinc Corporation

Getting Started Logging Out

Revised May 2017 16 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Logging Out Select the Launch Pad link to end an Early Warning session. The user returns to the Launch Pad, but is still signed in.

To close one SSO application when multiple applications are open in separate browser windows, close the unwanted session window by selecting the Launch Pad link or X. Do NOT select the Sign Out link—it ends the entire Single Sign On session (and all open SSO applications).

Page 22: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Logging Out | Early Warning Interface Elements

Revised May 2017 17 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Create Notice Only users authorized to create and maintain Early Warning notices in SSO can perform these processes. If authorized, the Create Notices menu item appears on the interface (Exhibit 21).

Authorized users can create Early Warning notices, including the following:

• Create the Basic Notice

• Preview the Notice

• Assign Equipment—This is not required for Component Registry Notices to be associated with a Component Registry Recall Query.

• Submit the Notice

• Edit the Notice

Page 23: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Create the Basic Notice | Early Warning Interface Elements

Revised May 2017 18 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Create the Basic Notice 1. Select Create Notice on the main menu. The Create Notice panel is displayed as shown

below. Exhibit 23. Create Notice

2. Complete the fields for the new notice. Required fields are in red. Fields for the Create Notice are shown in Exhibit 24.

Page 24: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Create the Basic Notice | Early Warning Interface Elements

Revised May 2017 19 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 24. Basic Create Notice Fields Notice Title Up to 80 characters that simply identifies the notice content

Notice Type Select Early Warning (EW) or Maintenance Advisory (MA) Component Registry Notice

Check the box to indicate a component recall will be involved. No manual assignment of Equipment IDs is involved when this box is checked.

Notice Text Comprehensive description of the EW or MA. Parts involvements, restrictive dates, applicability to mechanical designations, etc. Up to 10,000 characters.

Severity Code Valid values are: Exhibit 25. Severity Codes

Effective Date Use calendar picker to select the date the notice become effective. Cannot be

earlier than today. Expiration Date Use calendar picker to select the date the notice expires. Default is today, but

is automatically set to one year when the Effective date is selected. Must be later than the Effective Date.

File Number The users-assigned file number in accordance with company standards. Up to 12 characters and spaces. Cannot contain $ % & * + = ? or /.

Assignment Reporter Marks

Select radio button for AAR only, Equipment Owner, or Specify. If specify is selected, complete the text box also, (1–4 characters separated by spaces, no mark limit).

Inspection Code MC

Check box to allow MC reporting. Date field becomes active. Select the date with the calendar icon.

Final Inspection Marks

Select either the Open or Specify radio button. If specify is selected, also make appropriate entry in the text box (1–4 characters separated by spaces, no mark limit). Additionally, check the appropriate boxes to indicate which final inspection codes can be used—MR, NH, or both (default).

Allowable Final Inspection Codes

MR-Car inspected, return car to service and MH-Car Inspected, return car to services are selected by default.

Mechanical Designations

If known, use the Mechanical Designation field to restrict the notice to those groups. (1–4 characters per designation separated by spaces, no limit). Use the Mechanical Designations search icon to look for Mechanical Designations (Exhibit 72).

Attachments (button)

When creating a notice or supplement, there must be at least one attachment. Use the Attachments button to attach a file.

A sample MA entry is shown in Exhibit 26.

Page 25: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Create the Basic Notice | Early Warning Interface Elements

Revised May 2017 20 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 26. Sample MA Notice prior to Preview

Note: Selecting Back returns to the Welcome page (Exhibit 19). 3. When the fields are completed, select Preview Notice.

a. If errors are found in the fields, the draft notice is not generated. The errors are identified by field at the top of the panel. The user must return to those fields, correct the errors and select Preview Notice again.

b. If no errors are found, the preview letter is shown (Exhibit 27.). Refer to Preview the Notice.

Page 26: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Preview the Notice | Early Warning Interface Elements

Revised May 2017 21 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Preview the Notice When the user selects Preview Notice, and no errors are found, the displayed letter will look similar to Exhibit 27..

Exhibit 27. Sample Preview Notice

Page 27: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Preview the Notice | Early Warning Interface Elements

Revised May 2017 22 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

1. Read the notice thoroughly for accuracy and then choose a processing option (Exhibit 28).

Exhibit 28. Preview Processing Options Submit Notice Submits the notice for publication as is shown. Edit Notice If errors or omissions have been identified and the user wants to correct,

returns the user to the Create Notice panel (Exhibit 23) to make corrections and preview again.

Assign Equipment

Not required for Component Registry Notices. Allows the user to assign specified equipment IDs to the notice. If done before submitting, the assigned equipment is included on the notice. Refer to Assign Equipment. Assign Equipment selected after a notice is already submitted appends equipment to the notice without creating a supplement. Automatically assigned equipment from an associated Component Registry recall query also does not create a supplement.

Back Returns the user to the Create Notice panel (Exhibit 23) to make corrections and preview again.

Page 28: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Assign Equipment | Early Warning Interface Elements

Revised May 2017 23 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Assign Equipment Note: Users must have the Assign Equipment permission in SSO to perform this task. If

authorized, the Assign Equipment button appears on the interface. This step is not required for Component Registry notices being associated with a Component Registry Recall Query which will automatically assign affected equipment. Refer to the Umler Component Registry Administrator Guide (available to authorized users).

When a notice Preview is satisfactory, the authorized user can choose to Assign Equipment to it. To assign equipment:

1. On the Letter Preview, select Assign Equipment. The Assign Equipment panel is displayed as shown below.

Exhibit 29. Assign Equipment

Note: Selecting Back returns to the Preview panel (Exhibit 27). 2. Enter or paste equipment numbers in the field at left, separated by spaces or commas. When

equipment IDs have been entered in the field, the command buttons become active as shown below.

Exhibit 30. Assign Equipment with IDs entered

3. Select Validate. The system validates the Equipment IDs against Umler and posts the results

in the columns in the table as shown below. Exhibit 31. Assign Equipment after Validation

Page 29: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Assign Equipment | Early Warning Interface Elements

Revised May 2017 24 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Note: Selecting Back returns to the Preview panel (Exhibit 27).

4. If any IDs entered are eligible for assignment, select Assign Equipment. The Create Notice Preview Letter is redisplayed. Scroll to the bottom where the equipment IDs that have been assigned appears (Exhibit 32).

Note: If Equipment IDs are assigned after a notice is published, the user sees a confirmation panel (Exhibit 35) to indicate the notice had equipment added. Select OK to close the panel. Scroll to the bottom of the Notice View letter to confirm the equipment ID addition.

Exhibit 32. Create Notice Letter Preview with Equipment IDs appended to bottom

5. Choose a processing option (Exhibit 33):

Exhibit 33. Preview Processing Options after Assigning Equipment Submit Notice Submits the notice for publication as is shown. Continue with Submit the

Notice. Edit Notice If errors or omissions have been identified and the user wants to correct,

returns the user to the Create Notice panel (Exhibit 23) to make corrections and preview again. Cars assigned are deleted.

Assign Equipment

Allows the user to assign specified equipment IDs to the notice. If done before submitting, the assigned equipment is included on the notice. Refer to Assign Equipment. Note: Assign Equipment selected after a notice is already submitted appends equipment to the notice without creating a supplement.

Back Returns the user to the Create Notice panel (Exhibit 23) to make corrections and preview again. Cars assigned are deleted.

Page 30: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Submit the Notice | Early Warning Interface Elements

Revised May 2017 25 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Submit the Notice When the Preview notice appears correct and has the appropriate Equipment IDs added, the user selects Submit Notice to publish. A Confirmation panel is displayed for the published notice as shown below.

Exhibit 34. Create Notice Confirmation after Submission

Select Done to return to the Welcome page (Exhibit 19).

To edit an existing notice after submission, the user must do a query to locate the new notice, and then refer to Edit the Notice.

Page 31: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Edit the Notice | Assign Equipment after Submitting

Revised May 2017 26 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Edit the Notice The Edit Notice button can only be used during the Create Notice process. Currently, the Back and Edit Notice buttons have the same function for unsubmitted notices.

Once the notice has been submitted (published), the user must use either of two editing functions:

• Assign Equipment after Submitting

• Create a Supplement

Assign Equipment after Submitting The Assign Equipment button allows the authorized user to add equipment IDs to a submitted notice without changing the body of the notice itself. This action does NOT create a supplement.

1. Find the existing notice using a query. Refer to Query Notices.

2. After locating the notice, select the row to open the notice view panel (similar to Exhibit 54).

3. Select Assign Equipment and continue as described in Assign Equipment. The following confirmation is shown when adding equipment to an existing notice as shown below.

Exhibit 35. Equipment assigned to Notice

4. Select OK to return to the Notice View panel, scroll to the bottom to verify the additions.

Create a Supplement The Create Supplement button allows the user to create a supplement that supersedes the original notice (or previous supplement). Assigned Equipment IDs do not change. Effective Date and Notice Type remain the same. This can be used to alter the expiration date, or other remaining fields. Assigning additional Equipment IDs must be done separately, either before or after a supplement is created.

To create a supplement:

1. Find the existing notice using a query. Refer to Query Notices.

2. After locating the notice, select the row and click the Notice # to open the notice view panel (similar to Exhibit 54).

Page 32: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Edit the Notice | Create a Supplement

Revised May 2017 27 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

3. Select Create Supplement. The Create Supplement Notice panel is displayed with the body of the notice displayed in editable fields as shown below.

Exhibit 36. Create Supplement Notice

4. Make the required changes. Refer to Create the Basic Notice for information on the fields. Then select Preview Notice. The Create Supplement Notice Preview is displayed (Exhibit 37).

Page 33: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Edit the Notice | Create a Supplement

Revised May 2017 28 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 37. Create Supplement Notice Preview

Page 34: EW/MA Advisory Procedures Manual - Railinc Corporation

Create Notice Edit the Notice | Create a Supplement

Revised May 2017 29 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

5. Review the changes and select a processing option (Exhibit 37).

Exhibit 38. Notice View Processing Options Submit Notice Submits the changes and displays a confirmation message (Exhibit 39). Edit Notice Returns to the Create Supplement Notice panel (Exhibit 36) to make changes. Assign Equipment

Opens the Assign Equipment panel (Exhibit 29). User must be authorized to add equipment.

Back Returns the user to the Create Supplement Notice panel (Exhibit 36).

Exhibit 39. Supplement Submission Confirmation

6. Select Done to return to Supplement Notice View. Then select Back to return to the Query Notices Result table (similar to Exhibit 53). The new supplement is identified in the table.

Page 35: EW/MA Advisory Procedures Manual - Railinc Corporation

Report Inspection Report Inspections from the Menu

Revised May 2017 30 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Report Inspection The Report Inspection function is restricted to authorized users as established by each Company Early Warning or SSO Administrator and is not displayed to unauthorized users. Inspection updates may also be further restricted to specific equipment marks, as determined by the associated EW/MA Notice. Refer to Exhibit 24, for more information on inspection authorizations.

Reporting Inspections can be done directly from the menu as described below or from a query (Report Inspections from a Query).

Report Inspections from the Menu Select Report Inspections on the main menu. The Report Inspections panel is displayed as shown below.

Exhibit 40. Report Inspections

Reporting Inspections has multiple steps:

1. Enter Equipment IDs

2. Validate Equipment IDs

3. Enter Inspection Data

4. Validate Inspections

5. Submit Inspections

Page 36: EW/MA Advisory Procedures Manual - Railinc Corporation

Report Inspection Report Inspections from the Menu

Revised May 2017 31 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Enter Equipment IDs 1. On the blank Report Inspections panel type or paste the Equipment IDs from a spreadsheet or

list. Exhibit 41. Report Inspections after entering Equipment ID

Note: Selecting Back returns to the Welcome page (Exhibit 19 ). 2. Select Validate and continue with Validate Equipment IDs.

Validate Equipment IDs When the user has entered Equipment IDs and selected Validate, the panel is redisplayed with the validation results. Exhibit 42. Report Inspection after Validation

Note: Selecting Back returns to the Welcome page (Exhibit 19 ). If equipment is identified in the Eligible for Inspection column, select Continue. Continue with Enter Inspection Data.

Enter Inspection Data When the Equipment ID(s) validate successfully and the user selects Continue, the Report Inspection panel displays a table of Equipment IDs, with their related notice types and numbers as shown below.

Exhibit 43. Report Inspections ready for inspection data entry

Note: Selecting Back returns to the post-equipment validation page (Exhibit 42).

Page 37: EW/MA Advisory Procedures Manual - Railinc Corporation

Report Inspection Report Inspections from the Menu

Revised May 2017 32 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

1. For each occurrence of the equipment ID, select the following:

a. Inspection Code. Valid values and definitions are listed in the table below.

Activity Code Definition EW

Status

MC • Car inspected • Return car to service • Continued inspections required

Open

ME • Car inspected and moving to shop Open

MF • The final inspection MH or MR was reported in error • Revert car to prior severity code • MF can only be reported by the reporter of the prior activity

code or the AAR

Open

MP • The prior preliminary inspection ME/MC was reported in error • Revert car to prior severity code • MP can only be reported by the reporter of the prior activity

code or the AAR

Open

MW • Car moving on AAR-approved owner’s instructions • Also includes move to scrap • Requires Transportation Code SX

Open

MZ • Car inspected • Moving unrepaired for unloading

Open

MB • EW cancelled by AAR Final

MH • Car repaired • Return to service

Final

MI • Car deleted from Umler file • Reported by the AAR

Final

MN • Car incorrectly added to EW or upgraded to another EW • Reported by AAR

Final

MR • Car inspected • Return car to service • No continued inspection required

Final

MY • Car moved from MA to EW • Can only be reported by AAR • See MA’s

Final

Note: When all cars have the same code as the first entry, use the Inspection Code Copy Down button to choose the same for the remainder.

b. Inspection Date. Select the calendar icon to select the correct date of inspection. The date cannot be in the future.

Note: When all cars have the same inspection date as the first entry, use the Inspection Date Copy Down button to choose the same for the remainder.

2. When all entries have been made, select Validate Inspection. Continue with Validate Inspections.

Page 38: EW/MA Advisory Procedures Manual - Railinc Corporation

Report Inspection Report Inspections from the Menu

Revised May 2017 33 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Validate Inspections After the user selects Validate Inspections, the system compares the Inspection Code selected to the requirements of the related notice, and displays the results in the Message column as shown below.

Exhibit 44. Report Inspections after validation

Note: Selecting Back returns to the post-equipment validation page (Exhibit 42).

If all validate properly, continue with Submit Inspections.

Note: If validation is not possible, view the notice to see what restrictions might have been involved in the notice for the car.

Submit Inspections When inspections have validated successfully, select Submit Inspection, and the panel redisplays with a successful submission message.

Exhibit 45. Report Inspections after successful submission

Note: If the inspection was submitted incorrectly, it can be “backed out” using the Query Trans Log task. See Back Out Inspection.

Select Done to return to the Home page.

Page 39: EW/MA Advisory Procedures Manual - Railinc Corporation

Report Inspection Report Inspections from a Query

Revised May 2017 34 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Report Inspections from a Query Note: The Report Inspections button is only displayed in query results to users authorized in

SSO to report inspections. For additional information about queries, refer to Query Notices.

To report inspections from a query:

1. Select Query Notices on the main menu.

Exhibit 46. Query Notices Menu Item

2. Select Equipment View.

3. Select the Notice Type (MA, EW, or Both).

4. Complete one of the following:

a. Enter Notice Numbers. Use the search icon to view a multiple selection pick list (Exhibit 50).

b. Enter known Equipment IDs. A paste from a spreadsheet can also be done.

5. Unless the results might be greater than 1000, leave the Output set to Browser. A sample query is shown in Exhibit 64.

6. Select Search. The Query Results are shown in Equipment View (similar to Exhibit 66).

7. Select the rows with the equipment ID. Select the equipment ID rows desired. Use the Ctrl key while selecting nonadjacent rows, or use the Shift key to select a block of IDs.

Exhibit 47. Equipment View table

8. Select Report Inspections.

Note: When the inspections have been successfully submitted, select Done to return to the Query Results page—not the Welcome page. If no other results exist, select Done to return to the Welcome Page (Exhibit 19).

Page 40: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query

Revised May 2017 35 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Query Notices Early Warning has a query function that allows users to search for notices and equipment using:

Basic Query—in Notice or Equipment View

Advanced Query—in Notice or Equipment View

Task available to users from the query results panels vary with user permissions.

Basic Query When the user selects Query Notices, the Early Warning Query panel is displayed for a basic query as shown below. Exhibit 48. Basic Query with defaults

Fields for the Basic Query are shown below: Exhibit 49. Basic Query Fields View (toggle) Notice View—Results are shown by notice, and the notice details can be viewed

(default). Equipment View—Results are shown by Equipment ID. When selecting this option, the user must specify at least one Notice number or Equipment ID. Actions can then be performed against selected pieces of equipment.

Notice Type Select Early Warning (EW) to only view EWs, Maintenance Advisory to only view MAs, or Both (default).

Notice Numbers Enter known notice numbers separated by a space. Use the search icon to view a multiple selection pick list (Exhibit 50).

Equipment IDs Enter known Equipment IDs separated by commas or a space. Ranges are supported (e.g., RAIL301-RAIL305). End wildcard (*) is also supported (RAIL00000003*).

Partial Title/Text Enter a string of text that is part of the title or text within notices. Output Browser (up to 1000) is default. CSV (commas separated values) for results over

1,000 (refer to CSV Download)

Continue with: • Notice Query • Equipment Query

Page 41: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 36 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Notice Query This section shows a basic default notice query. To do a notice query:

1. Select Query on the main menu.

2. Use the default Notice View.

3. Select Both for Notice Types.

4. Type in a known Notice Number. Or use the Search icon to view a multiple selection pick list of available numbers as shown below.

Exhibit 50. Notice Numbers

5. Leave the Output set to Browser. A sample query is shown below.

Exhibit 51. Basic Query with Notice View with Notice number entry

6. Choose a processing option (Exhibit 52).

Page 42: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 37 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 52. Query Processing Options Search Executes the search. Count Counts the number of records a search would produce. Always a good choice

if the numbers might exceed 1000 and require a CSV download instead. See Exhibit 56 and Exhibit 68.

Reset Resets the Search panel to its defaults. Back Returns the user to the Welcome page without processing

Results are displayed in the Query Results panel (Exhibit 53). When Count is selected, a message is displayed at the top of the Early Warning panel (Exhibit 56).

Exhibit 53. Query Notices Result

Actions allowed on this page include:

a. Select the Search Criteria tab at the top to return to the Early Warning Query page (Exhibit 51)

b. Sort the data. See Tables.

c. View the Notice details by selecting the Notice # link. The Notice View <MA or EW-####> panel is displayed as shown below.

Exhibit 54. Notice View <MA or EW-####> - Top Section

Page 43: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 38 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

7. Select a Notice View processing option (Exhibit 55): Exhibit 55. Notice View Processing Options Assign Equipment

Opens the Assign Equipment panel. Refer to Assign Equipment after Submitting. Note: User must be authorized to add equipment.

Create Supplement

Opens the Create Supplement Notice panel (Exhibit 36) to adjust the notice content creating a supplement to the notice. Refer to Create a Supplement.

Attachments Opens the Attachments window so the user can view existing, attach new, or remove unneeded files for the notice. Refer to Attachments.

Back Returns the user to the Query Notices Result table (Exhibit 53).

Count Results Count results for Notice View are generally quite low, as seen in (Exhibit 56). Equipment counts are higher (see Exhibit 68).

Exhibit 56. Count Results for Notice View

Attachments

Note: Users must be authorized in SSO to Create Notices to work with attachments. When the user selects Attachments in a Notice View, an Attachments panel opens (Exhibit 57). This notice shows no attachments. This page allows the user to:

• Add Attachments • View Attachments • Remove Attachments

Page 44: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 39 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 57. Attachments

Adding Attachments

Attachments up to 1 MB can be uploaded to the Early Warning system. Accepted file formats include DOC, PDF, JPG, PNG, BMP, XLS, CSV, and TXT. To attach a file:

1. While in Notice View, select Attachments.

2. On the Attachments panel (Exhibit 57), select Browse. The Select file to upload panel is displayed as shown below.

Exhibit 58. Select a file to upload

3. Locate the file and select Open. The Attachment panel shows the selected file as shown

below.

Exhibit 59. Attachments - selected file to attach

4. Write a comment to explain the attached file. This is optional.

5. Select Attach. The page is redisplayed with a success message and shows the newly attached file (Exhibit 60).

Page 45: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 40 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 60. Attachments with success message and attached file

Each attached file has attachment information (file name, size, User ID, date, and entered comments). The file name is a link used to view the attachment. The Remove link at the end of the row is used to delete the attachment.

6. Select Close or X to close the panel.

Page 46: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 41 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Viewing Attachments

Attachments are viewed in the appropriate application available in the user environment.

1. While in Notice View, select Attachments. If attachments exist, the Attachments panel shows attached files in the table as shown below.

Exhibit 61. Attachments with a single file attached

2. Select the File Name link to view the attachment. The user can choose to Open or Save the attachment (similar to Exhibit 68).

a. When Open is selected, the attachment launches the appropriate application to view the file.

b. When Save is selected, user can save the downloaded file to a specified local directory.

3. When finished viewing or saving the attached file, select Close or X to close the Attachments panel.

Removing Attachments

Attachments that are no longer needed, or added accidently, can be removed.

1. While in Notice View, select Attachments. If attachments exist, the Attachments panel shows attached files in the table (Exhibit 61).

2. Select the Remove link at the far right. A confirmation panel is displayed (Exhibit 62).

Page 47: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Notice Query

Revised May 2017 42 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 62. Confirm Attachment Removal

3. If unsure about the removal, select Cancel. Otherwise, select Ok. The Attachments panel is redisplayed with a successful removal message as shown below.

Exhibit 63. Attachments with successful attachment removal message

4. Select Close or X to close the panel.

Page 48: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Equipment Query

Revised May 2017 43 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Equipment Query Equipment queries show the equipment assigned to MAs and EWs, or from directly entered Equipment IDs. To do an equipment query:

1. Select Query Notices on the main menu.

2. Select Equipment View.

3. Select the Notice Type (MA, EW, or Both).

4. Complete one of the following:

a. Enter Notice Numbers. Use the Search icon to view a multiple selection pick list (Exhibit 50).

b. Enter known Equipment IDs. A paste from a spreadsheet can also be done.

5. Unless the results might be greater than 1000, leave the Output set to Browser. A sample query is shown below.

Exhibit 64. Basic Query for Equipment View

In this example, one Notice number has been entered.

6. Choose a processing option (Exhibit 65).

Exhibit 65. Query Processing Options Search Executes the search. Count Counts the number of records a search would produce. Always a good choice

if the numbers might exceed 1000 and require a CSV download instead. See Exhibit 56 and Exhibit 67.

Reset Resets the Search panel to its defaults. Back Returns the user to the Welcome page without processing.

7. In this example, select Search.

Page 49: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Equipment Query

Revised May 2017 44 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Results are displayed in the Equipment View panel is displayed below. If Count had been selected, a message is displayed at the top of the Early Warning panel as shown below.

Exhibit 66. Equipment View

Actions allowed on this page include:

a. Select Back to return to the Early Warning Query page (Exhibit 51).

b. Sort the data. See Tables.

c. Report Inspections for listed equipment (authorized users only):

• Select the equipment ID rows desired. Use the Ctrl key while selecting nonadjacent rows, or use the Shift key to select a “block” of IDs.

• Select Report Inspections. Refer to Report Inspection for instructions.

Page 50: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Basic Query | Equipment Query

Revised May 2017 45 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Count Results Count results for Equipment View can be quite large, as shown below. When results for any query number over 1000 records, a CSV download is required for Output. Refer to CSV Download.

Exhibit 67. Count Results for Equipment View

CSV Download When results for a Count are over 1000 records, the user must download the results to see the details. Execute the query and select CSV for Output. Then select Search. The File Download panel is displayed as shown below.

Exhibit 68. File Download

If the user selects Open, the file downloads to a temporary directory and then opens in the local spreadsheet application (e.g., Excel) for immediate viewing. Select Save to save the downloaded file to a specified local directory. Save is recommended for files with large counts.

Note: When a spreadsheet is opened directly, users must intentionally save the output file while in the spreadsheet before exiting.

Exhibit 69. CSV file opened in Excel

Page 51: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Advanced Query

Revised May 2017 46 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Advanced Query An advanced query can be used to incorporate some of the search criteria used in Umler to find specific notices. Processing occurs as described in the Basic queries section. The additional criteria can help restrict equipment lists for further processing.

When the user clicks the Show Advanced Query icon , additional fields are displayed below. Click on it again to hide these additional fields.

Exhibit 70. Advanced Query Fields

• The Umler Data fields are described in the Umler User Guide.

These include:

– Mechanical Designations – EINs – Maint Parties (Maintenance Parties) – Mark Owners (Stenciled Mark Owner) – Umler Owners – Lessees – Equip Status (Equipment Status)—Active, Inactive, Pre-Registered

The Mechanical Designations field has a search icon . Click on it to open a list of available designations (Exhibit 71). Select those that apply by clicking inside the checkboxes. Use the Ctrl key while selecting nonadjacent IDs, or use the Shift key to select a “block” of IDs. Select Submit to add the selected designations to the field.

Page 52: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Notices Advanced Query

Revised May 2017 47 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 71. Mechanical Designations

• Equipment Assigned – Enter From: and To: dates or use the calendar icons to select a range of dates the equipment was added/assigned to the notice.

• Equipment Inspected – Enter From: and To: dates or use the calendar icons to select a range of dates when the equipment was inspected.

• The Inspection Status can be set using the drop-down. Valid values are:

Page 53: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Trans Log

Revised May 2017 48 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Query Trans Log The Query Trans Log function is used to view the transaction log of activity over a specified period of time. It can also be used by authorized users to back out incorrectly reported inspections or to see what had changed for a notice supplement. To view a transaction log:

1. Select Query Trans Log. The Transaction Log page is displayed as shown below.

Exhibit 72. Transaction Log with default times and Notice Number entry

2. Enter criteria:

a. Default time period is one week from the current date/time. Change as appropriate.

b. Select the Notice Type (MA, EW, or both, the default).

c. (Optional) Enter Notice numbers. Use the Search icon to view a multiple selection pick list (Exhibit 50).

d. (Optional) Enter known Equipment IDs. A paste from a spreadsheet can also be done.

e. (Optional) Enter Advanced criteria. Select the Show Advanced Query. Only Umler Data can be specified (refer to Exhibit 70).

3. When criteria are set, select Search. The Transaction Log Query page displays a list of records matching the input (Exhibit 73).

Page 54: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Trans Log Back Out Inspection

Revised May 2017 49 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 73. Transaction Log Query Results

Content can be sorted, selected, unselected, and details viewed. For selected records, inspections can be backed out by users with SSO Report Inspections permission.

Back Out Inspection

Exhibit 74. Transaction Log Query with selected record for Inspection Backout

4. To back out an inspection, select the record, and then select Backout Inspections. The Backout Inspections panel is displayed as shown below.

Exhibit 75. Backout Inspections

5. Select Submit Inspection to finalize the back out. The Inspection Backout Confirmation is displayed with the latest recorded events (Exhibit 76).

Page 55: EW/MA Advisory Procedures Manual - Railinc Corporation

Query Trans Log View Transaction Log Query Details

Revised May 2017 50 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Exhibit 76. Transaction Log Query after Inspection Backout

6. Click Done to return to the Transaction Log Query.

View Transaction Log Query Details Transaction Log Query details can be used to determine exactly what had changed in a supplement. To view Transaction Log Query details:

1. Select Search on a Transaction Log Query as described previously in Exhibit 72.

2. From the Transaction Log Search Results (Exhibit 73), click a link in Log ID column to select a record. The Transaction Log Detail - Notice or Transaction Log Detail – Inspection page is displayed as shown below.

Exhibit 77. Transaction Log Detail - Notice

3. Select Back to return to the Transaction Log Query results.

Page 56: EW/MA Advisory Procedures Manual - Railinc Corporation

Configure Ticklers

Revised May 2017 51 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Configure Ticklers The Configure Ticklers function is used to view a list of notification configurations used by Early Warning. To set up users to receive tickler emails:

1. Select Configure Ticklers. The Configure Ticklers page is displayed as shown below.

Exhibit 78. Configure Ticklers

Notifications for these events are sent via email to the recipients shown at the right. All users with access to configure ticklers can modify the Email Addresses field.

2. To edit the Email Addresses field:

a. Select the field.

b. Overtype the data, add, or remove email addresses. Addresses must be separated by semicolons.

3. Select Save. A confirmation message is displayed.

Page 57: EW/MA Advisory Procedures Manual - Railinc Corporation

References

Revised May 2017 52 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

References When the user selects References on the main menu, the EW/MA Advisory Procedures Manual/User Guide opens in a new window as shown below.

Exhibit 79. EW/MA Advisory Procedures Manual/User Guide

The EW/MA Advisory Procedures Manual/User Guide PDF has step-by-step instructions for using Early Warning. To exit, close the document window by clicking the X in the top right corner.

Page 58: EW/MA Advisory Procedures Manual - Railinc Corporation

Glossary

Revised May 2017 53 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Glossary Term Description

AAR American Association of Railroads Car Hire Car Hire is a usage charge paid to car owners by railroads for the use

of freight cars and appurtenances Early Warning System References the new web-based version of the Early Warning and

Maintenance Advisory system. EMIS/Umler Equipment Management Information System (formerly the

Universal Machine Language Equipment Register [UMLER]) EW/MA Status The code used to represent the current status of the EW/MA

equipment. These codes will be indicative of the severity and inspection codes currently used in the TC/TCC fields of the Umler master record.

EW Early Warning letter. Will eventually prohibit equipment from being allowed in interchange.

MA Maintenance Advisory. Allows equipment to continue through interchanges until the needed maintenance is performed.

Mark 2–4 character abbreviation for a railroad, shipper, lease agent, shop, etc.

Pool Assignment Transaction

The Umler transaction set used for assigning equipment to an equipment pool, as qualified by a pool header transaction.

Pool Header Transaction

The Umler transaction set used to establish an equipment pool, usually for a specific type of equipment or equipment utilization.

SCAC Standard Carrier Alpha Code. Uniform alphabetic code for railroad identification.

SPLC Standard Point Location Code TC/TCC Transportation Code/ Transportation Condition Code

Alphabetic codes used in Umler master record indicating type of car loading and interchange restrictions, respectively.

Umler Railinc’s equipment asset system that serves as the industry’s database for equipment management and inspection information.

Umler Administrator The individuals within Railinc responsible for providing business support services for the Umler system.

Page 59: EW/MA Advisory Procedures Manual - Railinc Corporation

Index

Revised May 2017 54 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Index add

attachments to notice, 39 equipment IDs to notice, 23

Adobe Acrobat Viewer download, 6 used to view PDFs, 6

advanced query Equipment Status, 46 Mechanical Designations, 46 overview, 46 Umler Data, 46

Application Administrator user role (Railinc), 4 application title, 7 area (content), 7 Assign Equipment

after validation, 24 automatic assignment from Component Registry, 23 create notice, 22 from Notice View, 38 in existing notice, 26 in preview notice, 23 validation, 23

assignment reporter mark, 19 Attachments

accepted formats, 39 add, 39 button, 38, 41 remove, 41 view, 41

Attachments button, 10 automatic equipment assignment, 23 Back button, 10

create notice, 22 description, 10

back out inspection, 49 Backout Inspection button

description, 10 in Transaction Log, 49

basic query, 35 browser, 6 button

Back, 10 command, 10 scroll, 9

calendar icon in advanced query, 47 in query, 32

Cancel button in Query, 37

check box Component Registry Notice, 19 selection, 9

command button, 10 company admin user role, 4 Component Registry

automatic equipment assignment, 23 checkbox, 19

Component Registry Notice, 19 computer requirements, 5 confirmation

Equipment Assigned, 26 message, 42 panel, 11

Contact Us link, 7 content area, 7 Continue button

description, 10

in Report Inspection, 31 count

results in equipment query, 45 results in notice query, 38

Count button in equipment query, 43 in notice query, 37

Create Notice assign equipment, 23 fields, 18 functions, 17 preview draft, 20 preview letter, 21 preview notice, 20 start draft, 18 submit notice, 25

Create Supplement notice view processing option, 38

Create Supplement button description, 10 usage in Notice View, 26

CSV download, 45 CSV format, 6 Default Sort button

description, 10 delete attachment, 41 documentation

User Guide, 52 Done button, 10 download

Acrobat Viewer, 6 Excel Viewer, 6

drop-down text box, 8

Early Warning computer requirements, 5 icons, 11 log in, 14 log out, 16 menu items, 15 overview, 1 permissions, 15 Report Inspections, 30 SSO permissions, 13 web application overview, 3

edit draft notice, 24 existing notice, 26

Edit Notice button availability, 26 processing option, 22

effective date, 19 e-mail

Configure Ticklers, 51 Early Warning access, 13

Equipment Assigned confirmation, 26 in Advanced Query, 47

Equipment ID in Assign equipment, 23 in basic query, 35 in Report Inspections, 31

Equipment Inspected in advanced query, 47 Equipment View, 35 executables area, 8 expiration date, 19 fields

Page 60: EW/MA Advisory Procedures Manual - Railinc Corporation

Index

Revised May 2017 55 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

Create Notice:, 18 in Advanced Query, 46 in Report Inspection, 32

file number, 19 final inspection mark, 19 Flash Player, 6 format

CSV, 6 for Attachments, 39

hyperlink appearance, 8 selecting, 8

icon calendar, 32, 47 Early Warning, 11 Mechanical Designations lookup, 46

inspection back out, 49 report, 30

Inspection Code MC, 19 inspection reporter user role, 4 Inspection Status, 47 Internet Explorer, 6 Launch Pad link, 7 link

attachment, 40 Contact Us, 7 Launch Pad, 7 navigational, 7 Remove, 41 Sign Out, 7

log in, 14 log out, 16 logo, Railinc, 7 mark

assignment reporter, 19 final inspection, 19

Mechanical Designations in Advanced Query, 46 in Create Notice, 19 lookup icon, 46

menu application, 8 company admin users, 15 Configure Ticklers, 51 for regular users, 15 Main, 7 permission-based, 15 Query Notices, 35 References, 52 Report Inspections, 30

message area, 11 confirmation, 42 confirmation, 11 count, 11 error, 11

Microsoft Excel Viewer, 6 Mozilla Firefox, 6 navigational link, 7 notice

add equipment to existing, 26 create supplement, 26 edit existing, 26

Notice Number, 35 notice text, 19 notice title, 19 notice type, 19 Notice Type, 35 Notice View, 35

notification configuration, 51 editing, 51 e-mail addresses, 51

OK button, 10 Output, 35 page title, 7 PDF

for reference documentation, 52 viewer download, 6

Preview button, 10 preview notice

for draft notice, 21 for existing notice, 27 processing options, 22 processing options after equipment assign, 24

processing options create notice preview, 22 equipment query, 43 notice query, 37

query CSV download, 45 equipment view, 43 equipment view processing options, 43 notice view, 36 notice view processing options, 38 processing options, 37 transaction log, 48 view notice details, 37

Query advanced, 46 basic, 35 Equipment View, 35 fields, 35 Notice View, 35

Query Notices overview, 35

Query Trans Log overview, 48

Railinc logo, 7 References, 52 remove

attachments to notice, 41 Remove link, 41 Report Inspections

add inspection data, 31 Equipment ID, 31 from menu, 30 from query, 34 inspection code, 32 inspection date, 32 overview, 30 Submit inspection, 33 Validate, 31 validate inspection, 32, 33

Reset button description, 10 in Query, 37

scroll arrow, 9 bar, 9 button, 9

severity code, 19 Show Advanced Query button, 46 Sign Out link, 7 Sign-On Information, 7 Single Sign On, 13 SSO

Early Warning permissions, 13 registration, 13

Page 61: EW/MA Advisory Procedures Manual - Railinc Corporation

Index

Revised May 2017 56 Release 3.1 EW/MA Advisory Procedures Manual/User Guide

standard user role, 4 Submit button, 10 Submit Inspection button, 33 Submit Notice for Create Notice, 25 system requirements, 5 table, 12 terminology, 5 text box

drop-down, 8 simple, 8

Ticklers, 51 title (application), 7 transaction log

back out inspection, 49 overview, 48 query, 48 query results, 49 view query details, 50

Umler Data for advanced query, 46 User Guide, 52 user role

Company Admin, 4 Inspection Reporter, 4 Railinc Application Administrator, 4 Standard, 4

Validate in Assign Equipment, 23 in Report Inspections, 31

Validate Inspection button, 32 view

attachments to notice, 41 notice details in query, 37 Trans Log query details, 50

viewer CSV (Excel), 6 PDF, 6

web browser, 6 web interface

Early Warning elements, 8 page layout, 7

Welcome page, 14