evadd
Add a new issue into the ExtraView database. The command can be executed in several ways, depending on the options provided.
SYNOPSIS
evadd [-n]
evadd [-n][-i] [field1=value1 field2=value2 … fieldn=valuen] [q]
evadd [-n] -a
evadd [-n] -e [-v] [-f ]
DESCRIPTION
This command allows a user to insert a new issue into the ExtraView database. All permissions and business rules, including email notification, are implemented the same way through the CLI as they are when issues are added through the GUI. The fields used with this command are those that are placed on the ADD_PROBLEM layout for the current business area and project. This command may be run four different ways.
Interactive Menu
If neither the -a nor the -e command line options are specified, evadd will display a menu of all the fields available for adding a new issue. Each field is identified by a number. After the menu is displayed, the user will see the prompt, “Enter number or q to submit:”. When a field number is entered, evadd will prompt for the value for that field. If the field is a list, the list of available values for that list will be displayed. If the field is a multiple line text field, the user may enter multiple lines of input text. These fields must be terminated by a line containing just a period. In this menu, an asterisk (*) will identify all fields that are required but do not yet have values.
After a value has been entered for a required field, the asterisk will be removed from the display. After all the desired field values have been entered, press q to exit the menu and submit the issue to ExtraView.
Command-line only
If all required fields are included on the command line, and a trailing q ends the command line, the issue will be immediately submitted to ExtraView.
When field values are provided on the command line without a trailing q, the user will go into the interactive menu with those field values already populated.
Prompt Mode
With the -a option, the user will be prompted for a value for each field, in the same order as the fields are displayed with the evaddlist command. If the user tries to skip over a required field, a warning message is shown, “Must provide a value!”, and the user is prompted for that field again.
To go back to a previous field in the list, enter a b at any prompt.
At the end of the list of fields, the issue is submitted to ExtraView. If there are fields which were not initially filled in, which are required as the result of a “required if” field attribute, the user will be notified of those missing values, and will be placed into the interactive menu, with all the field values preserved. In this case, the required fields will not be identified by an asterisk.
Edit Mode
The -e option invokes an editor to perform the data entry. The editor will use a template file as the basis for collecting the field values for adding the issue.
In UNIX / Linux systems, the editor defaults to /bin/vi. In Microsoft Windows environments, the editor defaults to notepad.exe. An alternate editor may be specified by either setting up an EVEDITOR environment variable, by specifying the EDITOR line in the evconfig.txt file, or by using the EDITOR environment variable.
The template file will be created by one of five methods:
- The -f <mytemplate> command line option
- With the EVADD environment variable
- By the existence of the file /.evadd (evadd.txt on Windows)
- By the existence of the file evcli/add.txt
- It will automatically be generated from the list of fields returned by evaddlist
The format of a template file is similar to the following:
Title: Product: Comments: . Attachments: |
The period following the Comments field in the example above signifies that a multiple line input is allowed. Text for multi-line fields should be inserted immediately after the line containing the multi-line field title (Comments in this example). A period on a line by itself terminates a multi-line field. If a multi-line field is not terminated with a period, evadd will treat the rest of the template file as part of the multi-line field, when the issue is submitted to ExtraView.
Similarly, when entering multi-line fields either through the interactive menu, or with the -a option, the field must be terminated with a line containing just a period.
When entering text into a multiple line field, the user may read in the contents of an existing file, as if that file had been typed it directly in, by using the ~r fname command on a line by itself. This is very useful for entering information into fields with display types of Text Area, Log Area, or Print Text.
When adding an attachment (through any of the methods described above, type in the attachment file name, followed by a space, and then the attachment description, on the lines following the keyword ‘Attachments’. Only one attachment may be specified per line.
OPTIONS
-n | suppresses the email notification sent whenever a new issue is created |
-i | indicates that fields will be identified by their fixed database names instead of by their display titles |
-a | runs the command in prompt mode |
-e | runs the command in edit mode |
-v | adds additional field list value information in the initial template file used within edit mode |
-f templatefile | use templatefile as the initial template file |
fieldn=valuen | assigns an initial value to a field. ‘fieldn’ is the Display Title of a field. ‘valuen’ must be a valid value for that field |
q | ends a list of ‘fieldname=value’ pairs, the user will not be prompted for additional input. |
NOTES
Repeating record data may not be added to an issue with the evadd command. First enter the base issue with evadd, and then use evupdate to add the repeating record data.
EXAMPLE 1
Entering an issue with evadd and no parameters –
$ evadd
*1. Title *10. Priority Enter number or q to submit? 1Title? This is the title 1. Title *10. Priority *2. Product 11. Severity 5. Platforms 14. Customer
Title => This is the title Enter number or q to submit? 2 1. Global Interaction 2. Net Transactions 3. SMS Choice for Product? 3 1. Title *10. Priority 2. Product 11. Severity 3. Category 12. Owner 5. Platforms 14. Customer 6. Description 15. Originator 7. Comments 16. View 8. Workaround 17. Test Case ID 9. Release Notes 18. Test Case Location Title => This is the title, Product => SMS Enter number or q to submit? 3
1. Enhancement 2. Hardware 3. Software Choice for Category? 3 1. Title *10. Priority 2. Product 11. Severity 3. Category 12. Owner 4. Component 13. OS 5. Platforms 14. Customer 6. Description 15. Originator 7. Comments 16. View 8. Workaround 17. Test Case ID 9. Release Notes 18. Test Case Location Title => This is the title, Product => SMS Category => SOFTWARE Enter number or q to submit? 6 Multiple Line field. Finish with . or EOF Description? > Here is the long description of the problem. > This is a second line. > And another one. > . 1. Title *10. Priority 2. Product 11. Severity 3. Category 12. Owner 4. Component 13. OS 5. Platforms 14. Customer 6. Description 15. Originator 7. Comments 16. View 8. Workaround 17. Test Case ID 9. Release Notes 18. Test Case Location Title => This is the title, Product => SMS Category => SOFTWARE Description => Here is the long description of the problem This is a second line. And another one. Enter number or q to submit? 10 1. Low 2. Medium 3. High Choice for Priority? 3 1. Title 10. Priority 2. Product 11. Severity 3. Category 12. Owner 4. Component 13. OS 5. Platforms 14. Customer 6. Description 15. Originator 7. Comments 16. View 8. Workaround 17. Test Case ID 9. Release Notes 18. Test Case Location Title => This is the title, Product => SMS Category => SOFTWARE Description => Here is the long description of the problem This is a second line. And another one. Priority => HIGH Enter number or q to submit? q Bug # 12345 added. $ |
EXAMPLE 2
This shows entering all the fields and values at the command line. Note that the field names such as short_descr, owner, status, etc. can be ascertained by using the evfields command.
$ evadd short_descr="This is the title of the problem" owner=username status=OPEN priority=HIGH description="This is the description of the problem" customer=GE
EXAMPLE 3
This example uses the -a option. You are prompted for the value for each field, in the order of fields that appear with the evaddlist command. If you try to skip over a field that is required, you will see a prompt that reminds you that you “Must provide a value!”.
% evadd -a 1. Net Transactions 2. Dev Tools 3. Widget 4. Global Interaction Choice for Product? 3 1. P0 2. P1 3. P2 4. P3 5. P4 6. P5 Choice for Priority? 2 Originator? carl.koppel Owner? jon.bjornstad Choice for Platforms? 1 1. NetBSD 2. LINUX 3. ALL 4. FREEBSD 5. WINDOWS 98 6. WINDOWS NT 7. SOLARIS Choice for OS? 3 Multiple Line field. Finish with . or EOF Description? > This is the description for the item. You can enter many lines for > the description, or even read the description from a file. > . Bug # 12497 added. % |