Configure Forecast Signatures - Hazard Services

Purpose:

Tasks:

Override Note: This file requires a full override; it does not support incremental or class overrides.

1. In the Localization Perspective, navigate to the Utilities sub-directory under the Hazard Services folder.
2. Find and double-click on ForecasterInitials.py to show the available versions
3. Create a user override version if none exists (user override is best practice for testing changes):
   1. If there is only a BASE version: right click on BASE and select Copy To, then select User
   2. If there is another version (e.g. SITE) you wish to use: right click on that file and select Copy To, then select User
   3. NOTE: The reason we are using "Copy To" instead of "Create Override" in this case is because this file is very short, so copying the whole file is appropriate. 
4. Double click on the User version of ForecasterInitials.py to open it for editing
5. To add a new entry, click on the END of the last entry before the "}" symbol (which closes the forecasterInitials dictionary), and hit ENTER to insert a blank line
6. Set the proper indentation by hitting TAB at least twice (or 6 times to match commented examples)
7. Enter a line for a new forecaster as follows:
   1. Type a quotation mark, then the forecaster's username on the awips workstation (without spaces), then a closing quotation mark (e.g. "jsmith")
   2. Type a colon
   3. Type a quotation mark, then the forecaster's desired pseudonym for products (full name, initials, ID, or anything else), then a closing quotation mark (e.g. "JS")
   4. Type a comma at the end of the line (this prepares the dictionary for another entry on the next line)
   5. (No action in this step) An example entry is shown below for a user "jsmith"...

              "jsmith":"JS",

   6. FOCAL POINT WORKSHOP: If you would like to test this in the workshop, you will need to use username "forecasterXX" where XX represents your workstation number. For example, if you are on workstation 1, you would use: "forecaster1": "name", 
8. Double-check for Python syntax mistakes . Use the following tips:
   1. Indentation: At least two tabs-width before the entry (to properly nest in the forecasterInitials dictionary)
   2. Quote Marks: There is an opening and closing quotation mark around both the username   and psuedonym, and that the opening and closing marks are identical (don't use a double-quote " mark to open, and a single-quote ' to close, or vice versa)
   3. Colons/Commas: There is a colon (:) between the name and pseudonym, and a comma (,) at the end of the line
9. Repeat steps 7 and 8 for each forecaster you wish to add. It may be helpful to open forecasterName.vm from the WarnGen folder in your localization (under the D2D folder) for a username/initials reference for each forecaster. 
10. [OPTIONAL] Add a default signature string (e.g. your WFO) to be used when no forecaster initials are found
    1. In the final "return" statement, alter what appears in the empty ' ' quotes (example for LWX below) to use a default signature if none is found

               return forecasterInitials.get(currentUser, 'LWX')

       This illustrates a useful Python syntax for accessing dictionary values, specifically the "get" method, where myDictionary.get(key, defaultValue) allows a defaultValue to be returned when the key is not matched in myDictionary
    2. Note, you could alternately use a string like '|* Signature Required *|' as the default value, which will enforce the use of signatures before a product can be issued
11. When finished, save the file by hitting Ctrl+S, or selecting Save from the File menu
    1. If a "File Version Conflict" is encountered, click OK to accept merge
    2. In the two-panel "Merge" tab that opens, make no changes and once again save the file by hitting Ctrl+s
    3. When a "File Changed" message appears,  click Yes.
    4. This behavior will only be encountered each time a new override file that did not exist before is created and saved
12. Review, test, and (if desired) promote the file to the appropriate localization level.

To see changes implemented:

• No restarts needed, except for closing Product Editor, if open, and reloading via Preview button on HID. You will see the new signature in the "Initials" field of the Hazard Data Editor tab.