NAME

newsar − submit a Harris Software Action Report (SAR)

SYNOPSIS

newsar [ −op ]

DESCRIPTION

newsar accepts user input, validates the input, and then generates an SAR load file suitable for entry in the Harris SAR database.  A Software Action Report is used only to report a bug or error in some piece of Harris software!  It should be used with the Harris Customer Information Services (HCIS) e-mail interface to submit an SAR to Harris from any remote system.  An SAR should not be used to ask a question on user code, instead, newcall should be used to open a Support call in the Harris Software Support Center. 

Although a load file is created by newsar, it will not be loaded into the database until the next business day.  Only after your SAR is loaded will it be assigned an official Harris SAR number.  At that time, you will receive an SAR confirmation message containing the SAR number.  Thereafter, you will receive customer SAR update letters (via the postal service) whenever a change is made to your SAR. 

Help may be requested by using program options.  When options are used only the help information will be returned, and the SAR will not be submitted.  Valid options are as follows:

−o When newsar is run with this option, a list of valid operating system names will be displayed.  The values of the operating-system and system input parameters will limit the list output. 

−p This option will cause newsar to generate a list of valid operating system, product, subproduct combinations.  Output is dependent on the values given for the operating system, product, and subproduct input parameters.  This option takes precedence over the -o option.  As input to newsar a product, customer key, Harris customer site-id, operating system name, operating system release number, analyst, SAR submitter, SAR class, SAR technical priority, SAR abstract, and full SAR description are required before an SAR will be accepted.  At present, the Harris customer site-id, SAR class, SAR priority, operating system name, product, and subproduct (if entered) are validated against values in the database. 

newsar expects a stream of input after its invocation.  The input that follows the command line is a series of lines containing all of the information required to submit an SAR.  Each parameter is specified by first entering a keyword, followed by an ’=’ and then the desired value.  The input stream is terminated by an end-of-file (eof).

All keywords on input parameter lines may be abbreviated to their first two characters.  Following is the list of acceptable keywords:

an[alyst]=xxxx(required)
This is either the name or employee number of your local analyst.  This is a contact at Harris that is aware of, or has verified, the problem.  Please enter "unknown" if you do not know the name of your local analyst or the problem has not been verified by someone at Harris.

si[te-id]=site-id(required)
Any valid Harris customer site-id (up to 10 characters) may be specified.  A site-id can be found on your distribution tape from Harris.

su[bmitter]=submitter(required)
This parameter must contain the name of the person submitting the SAR.  A maximum of 35 characters will be accepted.

cu[st-key]=cust-key(required)
A customer key is a user-defined name, or keyword, that can be used at your site to identify the SAR for tracking purposes.  This is primarily used for your record keeping.  It will have a sequential number appended to it when the SAR is accepted by Harris to ensure that it is unique.  It can be up to 10 characters long.

pr[oduct]=product,subproduct(required)
A valid product and optional subproduct must be entered.  The product and subproduct can each be up to 24 characters in length.  Database wild card characters may be used in product and subproduct values when requesting help.  Valid database wild card characters are:

% (percent)Matches any number of (any) characters.
_ (underbar)Matches any single character in that position.

sy[stem]=xxx/xxx(required)
This parameter matches a specific 3 character operating system release number and 3 character operating system name—e.g., 6.1/88K.  Database wild cards can also be used with this parameter when requesting help.

te[chnical-priority]=n(required)
An SAR technical priority is required (1,2,3,4,5).  Compare the symptoms of your problem to the definitions provided below.  Find the definition that applies to your situation, and use the corresponding priority number for the priority of your SAR. PriorityDescription

1 CRASHES SYSTEM: Has caused the entire system(s) to crash or to hang more than once. If the product runs on other systems, the crash also occurs on all/some of the other systems.  The product is one that is frequently used and is of critical importance. 

2 DISABLES ENTIRE PRODUCT: The product aborts or does not function as advertised, without any available workaround.  As a result, the product which is normally used cannot be used at all. 

3 DISABLES MAJOR FEATURE: A major feature of the product is disabled, resulting in impaired functionality.  The product is frequently used, and is of importance to the user community.  A workaround may or may not be available. 

4 DOCUMENTATION OR GENERAL SOFTWARE PROBLEM: A general feature of the product is disabled, resulting in impaired functionality.  Documentation errors and general features that do not work as advertised are typical.  A workaround may or may not be available. 

5 ENHANCEMENT REQUESTS: Requests for additional features and/or functionality with the intent to enhance the current product offering (not to fix a problem). 

cl[ass]=x(required)
This is the Harris SAR Classification.  Valid classes are: S (software), D (documentation), E (enhancement request), and I (Harris internal use only).

ab[stract]=(required)
The lines following this keyword should contain a (brief) abstract on your problem.  No information will be accepted on the same line as the keyword.  The abstract must be entered on the lines immediately following the keyword specification and is limited to 240 total characters.  It is terminated by either an eof or a line with two periods (..) starting in column one.  Entering an eof here will also terminate the program input stream. 

de[scription]=(required)
Following this keyword is the full description of the problem being reported.  The keyword line itself does not have any data on it like the other keyword lines.  Instead, the description is entered on the lines immediately following and is terminated by either an eof or a line with two periods (..) starting in column one.  Entering an eof here will also terminate the program input stream.  The description can be an arbitrary length and should include all information needed for Harris personnel to work on the problem. 

op[erating-system]=xxx(optional)
This matches any valid operating system name—e.g., vos (H-series), hcx (2000 series), ecx (1200 series), gcx (3800 series), 88k (4000/5000 series), or sx (secure).  Database wild cards are also available with this parameter when requesting help.

re[lease]=xxxxxx(optional)
This indicates the product release level.  For instance, a problem regarding Ada should probably have a product release level specified—e.g., 5.1.1.  This parameter can be 7 characters long.

co[mment]=(optional)
After this keyword, the submitter may enter a comment about the problem or specific situation that should be included with the SAR.  A comment should be any additional information that is not really part of the description of the problem.  It too can be an arbitrary length and is terminated by either an eof or a line with two periods (..) starting in column one.  If the comment is terminated by an eof, the program input stream will be terminated. 

au[xfile]=(optional)
This keyword marks the beginning of any auxiliary data that should be included with the SAR.  The data actually begins on the line following the keyword line and is ended by entering an eof, or a line with two periods (..) starting in column one.  For example an auxfile may contain program source (to reproduce the problem) or command output that shows the problem.  It can be any number of lines long.  If the auxfile is ended by an eof program input is terminated. 

All of the examples in this man page are for use with the HCIS e-mail interface.  Each example lists an input file that should be sent to an electronic mailer on your system.  If we call the input file in each example "sar_input", then your request might be submitted to Harris using mailx as follows:

mailx -s"submit an SAR" remotecust@csd.harris.com < sar_input

After your request has been processed, you will receive an e-mail response (using your return e-mail address) indicating the SAR status.  If any errors were detected, the program input will be echoed in your return mail.  This should allow you to easily resubmit the SAR.  However, the echoed description, comment, and auxfile text is limited to only 5 lines because they can be rather lengthy.  For this reason, you may want to keep a copy of this text on hand.  Although the text is truncated in your return e-mail response, all input lines will be recorded at Harris.  The Harris system address used in the mailx command above should only be used if you are connected to the Internet.  If you are not connected (or cannot get connected) to the Internet, then you may be able to use UUCP to send e-mail to Harris.  If you desire a UUCP connection into Harris, please call the Harris Software Support Center at 1-800-245-6453 and ask to speak with the HCIS administrator to be assigned a unique UUCP address. 

EXAMPLES

>>submit newsar -o
re=%x
pr=ada
< eof >

∗ This example will generate a list of valid operating system names that match the pattern specified.  All operating system names that end with the letter "x" will be listed.  In this example, the specified product name is ignored.  The HCIS e-mail processor requires the first input line to start with ’>>submit’ in column one, followed by the program name and any options.

>>submit newsar -po
op=%x
pr=a__
< eof >

∗ This example will generate a list of valid operating system, product, subproduct combinations that match the patterns specified.  The combinations in the list will contain only operating system names that end with the letter "x" and have products that start with the letter "a" followed by any two characters.   The "o" option is ignored. 

>>submit newsar
su=John Doe
si=T146521
cu=testsar
cl=e
sy=6.1/88k
pr=kernel,networking
te=5
analyst=Eric Lund
abstract=
This is the abstract for the sample SAR.  It is limited to
240 total characters.
..
description=
The full problem description must be entered here.  The problem
should be described in detail to aid Harris personnel in recreating
and resolving the problem.  If a detailed description is not entered, a
resolution may not be attainable.
..
comment=
Any comments that pertain to the current situation or problem can
be recorded here.  These comments are used only for additional
remarks about the SAR.  Any problem details should be documented in
the SAR description.  Only one comment is allowed per SAR.
..
auxfile=
The auxfile should contain output from commands, sample or test
program source codes, or any text that can demonstrate the problem
being reported.  This should be used to supply additional information
to aid Harris in resolving the reported problem.  Because the auxfile
can be any number of lines long, please include any information here
that you think may even remotely help resolve the problem.
< eof >

∗
This example (input file) shows all required input for submitting an SAR.
An e-mail response will be returned indicating that the SAR was accepted by
Harris.  The customer key listed in the response may be used for tracking on
the SAR until it is loaded into our database and assigned an SAR number.

∗∗∗ NOTES ∗∗∗

∗
Limited to one Software Action Report per e-mail request.

∗
To ensure accurate record keeping, please limit each SAR to
only one problem.  Problems dealing with different topics/areas
should be recorded by submitting additional SAR(s).

∗
All input lines are limited to 77 characters.  Any lines greater
than 77 characters will be truncated.  Only auxfile input lines
can be any number of characters long.

∗
Program input lines (not part of the abstract, description, comment, or
auxfile) that begin with a dollar sign ($) or a space/blank
are considered comment lines.