Outpost PMM. and MARS Message Maker. Users Guide. January 2012 Version 1.0

Transcription

1 Outpost PMM and MARS Message Maker January 2012 Version 1.0 1/8/2012

2 Contents 1 ABOUT MARSMM INTRODUCTION BACKGROUND ON MARS WHAT IS MARSMM? MARSMM AND OUTPOST A MARSMM SESSION MARSMM FEATURES NOTES, ASSUMPTIONS, AND DISCLAIMERS FIND AN ERROR? GETTING STARTED THE MAIN MARSMM FORM MENUS AND TOOLBARS MESSAGE FIELDS SETUPS GENERAL SETTINGS ADDRESS BOOK ADDRESS BOOK FILE CREATING OR UPDATING THE ADDRESS BOOK FILE ADDRESS SELECTION FORM CREATING A MARS MESSAGE THE GENERAL MESSAGE CREATION PROCESS PREVIEWING A MESSAGE EEI FORMATTER A MESSAGE EXAMPLE LOCAL POLICIES List of Figures FIGURE 1: THE MARSMM MESSAGE FORM... 2 FIGURE 2: THE MARSMM PREVIEW FORM... 2 FIGURE 3: MAIN SCREEN MENU AND TOOL BAR... 5 FIGURE 4: FIELD DEFAULTS TAB... 9 FIGURE 5: MESSAGE NUMBERS TAB... 9 FIGURE 6: CONTROL TAB FIGURE 7: SAMPLE ADDRESS BOOK DATA FILE FIGURE 8: OPENING THE MARSADDR.DAT FILE FROM THE PROGRAM FIGURE 9: OPENING THE ADDRESS BOOK FIGURE 10: CHOOSING ADDRESSES FIGURE 11: SELECTING DISTRIBUTION LIST ADDRESSES FIGURE 12: MARS MESSAGE PREVIEW FORM FIGURE 13: EEI FORMATTER Revision History Date Revision Release Notes 8 Jan 2012 Original V1.0 1/8/2012 iii

3 1 About MARSmm 1.1 Introduction This guide will introduce you to Outpost s MARS Message Maker program and describe how to create MARS messages that interact with the Outpost Packet Message Manager program. 1.2 Background on MARS MARS is a United States Department of Defense (DoD) sponsored program, established as a separately managed and operated program by the United States Army, Navy, and Air Force. The program is a civilian auxiliary consisting primarily of licensed amateur radio operators who are interested in assisting the military with communications on a local, national, and international basis as an adjunct to normal communications. The expanded MARS mission outlined in the DoD Instruction defines contingency radio communication support as The provision of radio-based transfer or exchange of information to assist with DoD or civilian authorities operations during, or responses to, any major disruption of DoD of other communications networks, such as those associated with official national security or emergency preparedness events or activates. MARSmm, along with Outpost Packet Message Manager, aligns to support this mission. 1.3 What is MARSmm? MARSmm is a computer program that helps get a MARS message formatted and submitted to Outpost for transmission. MARSmm complies with many of the requirements outlined in the U.S. Navy Marine Corp Military Affiliate Radio System (MARS) Communications Instructions NTP 8(D), but is not fully NTP-8(D) compliant as of this first release. It is the authors intent that this will be addressed in future releases. 1.4 MARSmm and Outpost MARS Messaging is designed to improve the message handling efficiency of MARS communications teams. There are two components that make up MARS messaging: MARSmm.exe. This is a standalone program that presents the user with a computer-based fill-in-the-blank form with fields that are required per the NTP- 8(D) specification. It guides the user in creating a message using some predefined message field values or by direct data entry, and then posts the created message to Outpost. It includes several levels of validation so that a completely valid message results when all information is entered. 1/8/2012 1

4 Figure 1: The MARSmm Message form Figure 2: The MARSmm Preview form 1/8/2012 2

5 Outpost. When Outpost is running and a MARSmm message is written to the Outpost message database, a message form automatically opens so that the Outpost packet operator can complete the packet message addressing and send it on its way. Outpost then interacts with the BBS for sending and retrieving packet messages. 1.5 A MARSmm session MARSmm helps the user compose a message and get it sent by packet quickly. Here is what a user needs to do: 1. Start Outpost. 2. From Outpost s main form, select the Reports and Forms menu, and then click on MARS Message Maker. The MARSmm program will start. 3. Check the default field settings (optional). 4. Press New. The program populates the message form with any default field settings and prepares the message fields for editing. 5. Fill in the Addressing, Subject, Body, and Action sections as appropriate. When done, press Save. MARSmm writes the message to the Outpost database. 6. Outpost detects the new message and opens it in a new message form. 1.6 MARSmm Features Some of the key features of Outpost s MARSmm Messaging are: Message Management Message Creation. MARSmm allows messages to be created from scratch, or by cut and pasting from other applications. Text Message Formatting. Messages can be entered in a free-form text area. Simple character-based formatting can be performed, errors corrected, and text can be added and deleted prior to sending the message. Preview and Printing. MARSmm can show what the formatted will look like or print a message for off-line review. Validation. MARSmm will ensure that all necessary fields are filled prior to posting the message to Outpost, thereby ensuring the message is correct the first time. MARS messages outside of Outpost. MARSmm messages sent by Outpost are formatted in a human-readable for retrieval and use by non-outpost users. Configurations and Setups Default fields. Some message fields can be defaulted to predefined values, particularly if they are the same from message to message. For instance, the Originating Station: and From: fields can be set to the appropriate values and preloaded at message creation time. 1.7 Notes, assumptions, and disclaimers The program attempts to guide the user through the process of creating, reviewing and sending MARS messages. If you observe obvious problems, please let me know Error handling will continue to evolve over time. Most of the errors are properly trapped and reported, however, it is not 100% foolproof. 1/8/2012 3

6 1.8 Find an Error? If you find an error or unsure how Outpost s MARS Message Maker is supposed to work, post a message to the MARS Users Group or send me at kn6pe@arrl.net. 1/8/2012 4

7 2 Getting Started All MARS Messaging activities are managed and controlled by the MARSmm.exe program. This section provides an overview of the program. 2.1 The main MARSmm form When you start the program, you will see the main window letting you know that MARSmm.exe is ready. 2.2 Menus and Toolbars The Program Controls portion of the User Interface controls the operation and execution of all program tasks. Figure 3: Main Screen Menu and Tool Bar 1/8/2012 5

8 The MARSmm menus provide different options for setting up and controlling the application. NOTE: Some of the more common menu items are also implemented as Tool Bar buttons. See the associated menu item below for their description. Menus File Description New: Increments and loads the message number and the current Date/time value. Save: Checks that all required fields are filled in. If any are missing, the field is highlighted in Yellow. If the message is complete, it formats the message and saves the message to the Outpost message database. Once saved to Outpost, the Close form on Save option is checked and program exits according to this setting. Preview. Checks that all required fields are filled in. If any required field value is missing, the field is highlighted in Yellow. If the message is complete, it formats the message and opens the Preview form showing the formatted message. Exit: Exits the program. Edit Cut: Copies and deletes any highlighted text from any text area on the form. The text is placed in the MS- Windows clipboard. Copy: Copies any highlighted text in any from any text area on the form. The text is placed in the MS-Windows clipboard. Paste: Inserts text from the MS-Windows clipboard in the field at the position where the cursor is located. Clear All: Clear text from all fields. Setup General Settings: Opens a form to set various parameters to control the behavior of the program: Field Defaults. Sets specific fields that are loaded at startup. Message Numbers. Sets the next message number as well as the format in which it will be presented. Controls. An option that lets you close the program on saving the message to Outpost. See Section3 Setting for more information. Address Book: Opens Notepad.exe to edit the Address Book data file. See Section 4 for more information. 1/8/2012 6

9 Menus Action Description Reset Message Number: Sets the next message number. View Data Directory: Opens a Windows Explorer form Help About: Lists information about MARSmm. The following are other controls found on the main form. Controls New Description Same as File > New; Increments and loads the message number and the current Date/time value. Preview Same as File > Preview; Checks that all required fields are filled in. Save Same as File > Save; Checks that all required fields are filled in, and saves the message to the Outpost database. Clear Same as Edit > Clear All. Clear text from all fields Exit Same as File > Exit. EEI Formatter 2.3 Message Fields Field Originating Station This control is located above the Message Body, opens the EEI Formatter form, and prompts for more information required to complete a formal EEI message. Description The station from which a message was originally transmitted. Default: Blank, or on pressing New, loads the value defined from Setup > General Settings, first tab. Message Num The number assigned to this message. Default: On pressing New, loads the value defined from Setup > General Settings, second tab. Precedence Precedence designations indicate the relative order in which a message is handled with respect to all other precedence designators Default: R (Routine). Date / Time The time the message was created. Default: On pressing New, loads the current date and time per the MARS specification. From Originator of message. Default: Blank, or on pressing New, loads the value 1/8/2012 7

10 Field Description defined from Setup > Properties, first tab. To Destination addressee(s) designation(s). These recipients are where the message is received for action. Default: Blank Info Optional, Information addressee(s) designation(s). These recipients also receive this message for their information. Default: Blank Subject The subject for this message. This field will also be used in Outpost s Subject line when it sends this as a packet message. Special Instructions Optional, Special handling instructions that cannot be properly indicated in the HEADING section may be included after the subject line and before the references or message text. Default: Blank References Optional, a list of references referred to in the message. Default: Blank Message This is a free-form text field for creating the message to be sent to the recipient. This message can also be formatted as an EEI message using the EEI Formatter. Default: Blank Final Instructions Optional, additional instructions not captured in the message. Default: Blank. Ending sign Optional, The ending sign is to indicate the end of the message and contains the proword OVER or OUT (prosigns K and AR, respectively) Default: Blank 1/8/2012 8

11 3 Setups 3.1 General Settings The Setup > General Settings menu option sets up certain parameters used by the program. The form is divided into three tabs. Tab 1 Field Defaults Figure 4: Field Defaults Tab These values set in these fields are typically common from one message to the next. If these fields are filled in, then their contents are loaded into their corresponding fields on the main MARSmm form when the user presses the New button. Tab 2 Message Numbers Figure 5: Message Numbers Tab 1/8/2012 9

12 This tab controls how message numbers are assigned to MARS messages. Fields Next Number Description Displays or sets the next message number to be assigned to a message. Format This field defines the number of digits for the message number. Valid entries for this field are one or more zeros (0 s). For instance: Next Message Number Format What is displayed Tab 3 Controls Figure 6: Control Tab Right now, there is only one control available. Control Close form on save Description Checked: On pressing the Save button and the message is written to Outpost, the form is closed. Unchecked: On pressing the Save button and the message is written to Outpost, a pop-up appears for 2 seconds, and the form is left open. Default: Checked When done, Press OK to accept these changes and close the form. 1/8/

13 4 Address Book Addressing is critical to the MARS mission. As a result, MARSmm provides the means for setting up an address book that can be referenced when creating a message. The components of the address book are: 1. Address Book data file. An ASCII file containing a list of addresses that could be used in a message. 2. Address selector. A form that lets the user select one or more address entries for the To or Info message fields. The rest of this section describes how to use the address book. 4.1 Address Book File The Address data file MarsAddr.dat is an ASCII file that can be created using any text editor, such as Notepad.exe, Wordpad.exe, or any other editor PROVIDED it produces an ASCII file output. The program allows you to set up logical groups of addresses as well as define distribution lists. An address book can be as simple as a list of addresses like this: NNN0JAC VA NNN0EDX VA NNN0PBF VA NNN0EMG VA Or more complex with addresses placed under organizational headers or in distribution lists, and with comments, like this: / ***************************************************************** / File: MARS Address Book / Description: Contains the listing of local addresses or lists. / / ***************************************************************** / >> Virginia NMC MARS MEMBERS NNN0JAC VA NNN0EDX VA NNN0PBF VA NNN0EMG VA >> Organizational Stations NNN0ASA VA NNN0ASI PA NNN0GCB VA NNN0GCB ONE VA -- EEI Distribution List AAN3EEI VA NNN0ASA VA NNN0ASI PA NNN0ASI ONE NNY NNN0ASI TWO NNY NNN0AS3 VA NNN0AS3 TWO WV NNN0GCB VA NNN0GCB ONE VA NNN0GCB TWO VA NNN0GCB TWO TWO VA NNN0ASZ GA Figure 7: Sample Address Book Data File 1/8/

14 4.2 Creating or Updating the Address Book file The easiest way to view and/or update the address book is to open it from MARSmm from the Settings > Address Book menu. If the Address book file does not exist, you will be prompted to create a blank text file. If the Address book file does exist, it is opened in Notepad.exe. Figure 8: Opening the MarsAddr.dat file from the program Address Book Components The address book file consists of individual records in a text file. These records are as follows: Comment Lines Blank Lines Address Entries The address book file can have optional comment lines. Comments must start with a / character in column 1 followed by any text desired. Blank lines may be used to make the data file more readable. Blank lines are ignored when the file is loaded into the Address Selector form. Each selectable address entry will reside on its own line. One Address entry per line. The entry will consist of standard MARS address attributes. What is entered on each of these lines will be inserted in the intended address field. 1/8/

15 Example NNN0ASI PA NNN0ASI ONE NNY Address Entries are displayed in Regular Black text on the Address Selector form. Organization Header Addresses can be organized under an Organizational Header. Any number of headers and address groups can be created. Organizational Headers must start with a > character in column 1 followed by any text desired. Addresses that are part of this group are entered on subsequent lines. Example >> Virginia NMC MARS MEMBERS NNN0JAC VA NNN0EDX VA NNN0EMG VA Organizational Headers are displayed in BOLD BLUE text on the Address Selector. At address select time, Headers are not selectable and are only present for grouping addresses logically per the users needs. Distribution Header Addresses can be grouped in Distribution Lists under a Distribution Header. Distribution Headers must start with a - character in column 1 followed by any text desired. Addresses that are part of this distribution list are entered on subsequent lines. Example -- EEI Distribution List AAN3EEI VA NNN0ASA VA NNN0ASI PA NNN0ASI ONE NNY Distribution Headers are displayed in BOLD BLACK text on the Address Selector form. Distribution Headers are selectable. When doyble-clicking on a Distribution Header, all address entries immediately below the selected header down to the next Distribution Header are copied to the Recipient List. When done making changes, on the Notepad.exe main form, press File > Save to save the changes, an then File > Exit to close Notepad.exe 1/8/

16 4.3 Address Selection Form Address book entries can be selected and placed into the TO: and INFO: fields on the MARSmm form. The To and Info labels are actually buttons. NOTE: the following example is based on the Address data file shown in Figure 7. Figure 9: Opening the Address Book When pressing the To button, the Address Selector form opens and displays the list of addresses and distribution lists available to the user. NOTE: This also applies when pressing the Info button. Figure 10: Choosing addresses The Field on the LEFT shows the list of addresses that were set up in the Address Book File (see the example in Figure 7). The field on the RIGHT shows the addresses that were selected. In this example, there are 2 Organization Headers listed (in BLUE). Note the selectable addresses below these 2 headers: o o >> Virginia NMC MARS Members >>Organizational Stations There is one Distribution List shown with addresses that are part of that List located below this header: 1/8/

17 o EEI Distribution List Double-clicking on any address on the LEFT regardless where it is located will put a copy of that address into the Recipients list on the RIGHT. Double-clicking on any Organizational Header is ignored. Organizational Headers are for creating logical groupings of related addresses. Double-clicking on any Distribution Header will cause all addresses below the selected header to be copied into the Recipients list on the RIGHT. Figure 11: Selecting Distribution List addresses When done with selecting your addresses, press OK, and the addresses are placed in the associated field (To or Info). A couple of things to note: 1. Addresses listed on the LEFT cannot be edited here. If you need to make a change or addition, go back to the Main form and select Setup > Address Book. 2. Addresses copied to the Recipients list can be edited here, or on the MARSmm address form after you press OK on this form. 3. The Address selection form is height sizeable. 1/8/

18 1/8/

19 5 Creating a MARS Message 5.1 The General Message Creation Process In general, the process for creating a MARS message starts with defining some initial default settings: 1. From the Outpost main menu, select Forms and Reports > MARS Message Maker or double-click on the MARSmm icon on your desk top. 2. From the MARSmm form, press Setups > General Settings. Check that all defaults and settings are the way you want them. 3. Press Setups > Address Book. Check that all necessary addresses are available for choosing. Note, you can manually type these into the MARSmm form if a new address is identified. 4. Press OK when done. You are now ready to create a MARS message. To create a MARS message, 5. Collect all information needed to create a valid MARS message. 6. From Outpost main menu, select Forms and Reports > MARS Message Maker or double-click on the MARSmm icon on your desk top. 7. Press New. All default fields, the next message number, and the date/time are automatically filled in. 8. Complete the Header Section by selecting the Precedence for this message. 9. Complete the Addressing Section by filling in the To and Info addresses. Use the Address book to quickly find and fill in the necessary addresses. 10. Complete the Subject Section. 11. Complete the Body Section. If this is an EEI Message, check the box for Use EEI Formatter and then press the EEI Formatter button. See the following section on the EEI Formatter. For all other message types, fill in the text of the message. 12. Complete the Actions Section. Refer to your local organizations guidelines for policies and rules for this section. 13. When done, you can optionally press the Preview button to see what this message would look like. 14. Press Save for this message to be saved to the Outpost Message database. 15. At Outpost, a new message form will open with your message loaded. Fill in the destination packet address(es) and press Send to queue this message for transmission. 1/8/

20 5.2 Previewing a message Similar to the Save function, Preview will confirm that all required fields are filled in, formats the message, and then displays it for your review. Figure 12: MARS Message Preview form This form has the following controls: Controls File Description Save As. Lets you save the contents of this message to an existing file just as it appears on this form. You pick the file name. Save. Save the contents of this message to an existing file just as it appears on this form. Print. Prints the contents of this message just as it appears on this form to the selected or default printer. Print Setup. Selects a printer. Exit. Closes the form Edit Copy. Lets you highlight some or all of the text in the message form, and copies this text to the MS-Windows clipboard. You can then open another application and Paste the copied text into it. Select All. Selects all the text in the preview form. 1/8/

21 5.3 EEI Formatter MARSmm uses a different form to collect information needed for an Elements of Essential Information (EEI) Message. On selecting and pressing the EEI Formatter button on the main MARSmm form, the following form is opened: Figure 13: EEI Formatter This form has the following controls: Controls Save Description Formats a valid EEI message body, writes it to the Body field on the MARSmm main form, and then closes the EEI Formatter form Clear Clears all fields on this form. Cancel Closes the form without saving its contents. This form has the following fields: Fields Type: Description Required. Displays or sets the next message number to be assigned to a message. 1/8/

22 Fields State: Description Required. This is the 2 character U.S. State representation where the event occurred. Identifier: Required. This is the set of descriptors used by MARS to identify the nature of the event. A-H Fields: Optional. These fields address the 8 elements of information that is required to be collected. 5.4 A Message Example NOTE: The following is an example of how an EEI message would be created. Call signs and organizations listed here do not exist. 1. After an earthquake in Santa Clara County CA, local MARS teams are asked to originate an EEI message on the immediate situation. NNN0JIM, a member of a local California MARS unit, receives reports and starts filling the MARSmm form. On running MARSmm, he presses New, and the form looks like this: The Originating Station and From fields are automatically filled in based on the settings he previously entered (Setup > General Settings). NNN0JIM sets the message Precedence to Priority. 2. He fills in the To field by pressing the To button to open the Address selector, and double-clicks on the CA NMC EEI DIST LIST. The 6 names found in this distribution list are automatically loaded as recipients. After pressing OK, the 6 names are automatically loaded into the To Field. 1/8/

23 3. He repeats the address selection process to fill in the Info Field. In this case, he double-clicks on 2 single addresses listed in the CA NMC Group list (in Blue). After pressing OK, these 2 recipients are loaded into the Info Field. 4. NNN0JIM enters the subject and a special instructions reference. 5. He also checks the Use EEI Formatter box in the Body Section since this is to be an EEI message. 1/8/

24 6. On pressing the EEI Formatter button, the EEI Message Formatter form opens and he fills in the details. 7. Once he is satisfied that the form is complete, he presses OK. The EEI content is loaded back into the main MARmm form in the Message Body field. 1/8/

25 8. Finally, he selects K as the ending Sign, and then presses Preview to see what the formatted message looks like: 9. The message looks good. He closes the Preview form and presses Save on the MARSmm main form. The message is written to Outpost and an Outpost message form automatically opens displaying the MARSmm message. 1/8/

26 He completes the destination packet address, and presses Send. The message goes out with the next Outpost Send/Receive session. 5.5 Local Policies The above example is not based on any known organization or policies. When using MARSmm, please refer to local organization directives for creating ad-hoc or EEI messages. 1/8/