CREATING ALPHANUMERIC PRINTOUT DESCRIPTIONS FOR AXE ERICSSON ///    OPEN INFORMATION DOCUMENT INSTRUCTION  Uppgjord - Prepared ETXCMAR Faktaansvarig - Subject responsibleWilliam Leahy Nr - No3/1013-FCK 114 62 Uen Dokansv/Godk - Doc respons/ApprovedUAB/K/UEC (Henrik Almeida) Kontr - CheckedEEIGCN Datum - Date1996-12-10 RevA File  CREATING ALPHANUMERIC PRINTOUT DESCRIPTIONS FOR AXE Contents 1 Revision Information 2 Application 3 Purpose of this Document Instruction 4 Printout Description 4.1 Purpose of a Printout Description 4.2 Users of a Printout Description 4.3 Identification of a Printout Description 4.3.1 Header Information 4.3.2 Naming Conventions 4.3.3 4.4 Contents of a Printout Description 5 How to Write a Printout Description 5.1 Guidelines and Conventions 5.2 Template and Example Documents 5.3 Section 1, Format 5.3.1 Subsection 1.1, Printout 5.3.2 Subsection 1.2, Parameters 5.4 Section 2, Function 5.4.1 Subsection 2.n, Format n 5.5 Section 3, Action 5.6 Section 4, Printout Type 5.7 Section 5, Printout Block 5.8 Section 6, Glossary 5.9 Section 7, References 5.9.1 Subsection 9.n, Operational Instructions 5.9.2 Subsection 9.n, Command Descriptions 5.9.3 Subsection 9.n, Printout Descriptions 5.9.4 Subsection 9.n, Application Information 5.9.5 Subsection 9.n, Other References 6 Glossary 7 References 1   Revision Information This is a new document that replaces Document Instruction PRINTOUT DESCRIPTION (POD) FOR AXE; 6/1013-FCK 114 19 Uen C. The following changes have been made: Information about file Printout Descriptions has been moved to the document CREATING FILE PRINTOUT DESCRIPTIONS FOR AXE. The document title was changed.References in running text use italics for titles, and the document numbers were removed. Complete references are available in References, section 6.Headings that refer to sections in the Printout Description are written as "Section 1, Format" instead of "1 Format". General changes were made to improve the clarity of the text. The examples were improved. 2   Application This Document Instruction is the only instruction allowed within Ericsson for writing new, or modifying existing Printout Descriptions for AXE 10. If a deviation is required, a request must be made in accordance with the document Handling of Exemptions, ETX/VQ 170 04-6274, and copied to the Central Maintenance AXE (CMAXE) committee and the Handling AXE (HAXE) committee. This is the only exemption procedure approved by Ericsson Quality Management. This Document Instruction cannot answer all the questions that might arise. If further information is required, contact the MAXE. From now on in this instruction, the term Printout Description refers to alphanumeric Printout Descriptions. 3   Purpose of this Document Instruction The purpose of this Document Instruction is to define the structure and contents of a Printout Description. 4   Printout Description 4.1   Purpose of a Printout Description The Printout Description provides information to the technician for interpreting printouts received from the exchange. The Printout Description must be written so that it is clear and easy to understand. The Printout Description describes the contents of a printout in detail and gives information about answer printouts, alarm printouts, and result printous. Each printout requires its own Printout Description. Check printouts and answer printouts that occur in a dialogue are exceptions to this rule. These printouts are described in the Command Description. See Document Instruction CREATING COMMANDS DESCRIPTIONS FOR AXE. Printouts received on a print or display device are called alphanumeric printouts. Printouts to a file are called file printouts. For information on creating or revising file Printout Descriptions, see CREATING FILE PRINTOUT DESCRIPTIONS FOR AXE. If a command produces both a file printout and an alphanumeric printout, a separate Printout Description must be written for each. NoteOnly one version of a Printout Description is permitted for each application system. 4.2   Users of a Printout Description The users of a Printout Description include the following: Customer operation, maintenance, and administration personnel, who support and administer the exchangeEricsson design and test personnel, who design and test the softwareEricsson designers and technical writers, who produce additional customer documentation and marketing material The alphanumeric Printout Description is delivered to the customer as part of the AXE Operation and Maintenance (O&M) Manual. 4.3   Identification of a Printout Description 4.3.1   Header Information The document header must contain information according to the Ericsson Standards document Rules for Writing Documents, which is part of the Office Manual. An interpretation of this document follows (listed according to the labels used in the document header): Document type This is the document type, PRINTOUT DESCRIPTION, written in full capitalization. Prepared This is the corporate initials of the person who prepared the document. Example: ETXGURE Subject responsible This is the company code and office code, separated by a slash, of the design centre responsible for the content of the document. Example: ETX/TX/DZ No. This is the document number for the Printout Description, expressed as n/190 83-xxx nnn nn Uzz where: nPrefix 190 83Decimal class xxx nnn nnProduct number (including ABC class)UzzLanguage code (where zz is the specific language code) Example: 1/190 83-CNT 216 1278 Uen Doc respons/Approved This is the company code and office code of the design office. A dash is placed here until the document is approved. When the document is approved, the company code and office code for the office that has formal responsibility for the document is entered here. The office manager signs the original copy. On the computer stored document, the manager's name is written inside parenthesis to indicate that the document has been approved. Example: ETX/TX/ZZ (G Ericsson) Checked This is the corporate signature of the Local MAXE (LMAXE) who approves the technical content of the document. Example: ETXMALS Date This is the date the document was last revised, expressed as yyyy-mm-dd where: yyyy YearmmMonth dd Day Example: 1997-06-21 Revision This is the revision letter and defines the revision state of the document. Begin with A for a new document. Use capital letters A to Z. Do not use I, O, P, Q, R, U, or W. If the series is not enough when Rev Z has been reached, two letters are used: AA, AB, up to ZZ. If the content of the document is changed, the revision letter must be stepped. Due to customer demand, formal changes are no longer allowed. Example: C is stepped to D, H is stepped to J, and Z is stepped to AA. A preliminary document is indicated by a P before the revision letter, and a numeral, indicating the sequence number, after the revision letter. If a preliminary document must be revised, the sequence number is stepped. Example: PA1 is stepped to PA2. When approved, the P and the number are removed, leaving the new revision letter. Example: PB4 becomes B. 4.3.2   Naming Conventions The title of an alphanumeric printout consists of English and established telephony or AXE terms. The title is in capital letters. Hyphens are only allowed if used consistently as an integral part of the syntax. No characters other than letters, numbers, and hyphens are allowed. The title of the alphanumeric printout is expressed as: "function", "suffix". The "function" is, if possible, closely related to the name of the Function Specification. If this is not possible, the "function" should be related to the name of some other function document, in particular, the Operational Instruction or Function Description. Example: Function Specification title:Data Recording per Call Printout Description title: DATA RECORDING PER CALL RECORDING GROUP DATA The following suffixes are allowed for printout titles: DATAPrintout of data set by command, together with automatically-set dataDETAILSPrintout of a data set by command, together with the automatically-set dataRESULTPrintout of the result of a test or measurement (do not use the plural)STATUSPrintout of the status of an object, for example, idle, blocked, or deblockedSURVEYSurvey printout, a summary of a situation An A1 to A3 A-alarm indicates a fault in the exchange. The following suffixes are allowed: CONGESTION Alarm printout where congestion in allocation of resources occurs FAULTAlarm printout where a fault has occured in a device or group of devices (This is the normal suffix for alarms.)OUTPUT ERROR Alarm printout where an IO device cannot be seized for output (do not use IO FAULT) SUPERVISION Alarm printout where a predefined threshold was passed An alarm Operational Instruction exists for every A-alarm printout. The alarm Operational Instruction title is always identical to the alarm printout. An observation alarm (O1 and O2 alarms) indicates that the technician has done something that may interfere with the working of the exchange. For O-alarms, the suffix MANUALLY BLOCKED is common. Other suffixes must be approved by MAXE. Titles must be less than 72 characters in length and output on one line on the Input/Output (IO) system. 4.3.3   4.4   Contents of a Printout Description The Printout Description has the following contents and levels: 1Format 1.1Printout1.1.nFormat n (optional)1.2 Parameters2Function 2.n Format n (optional)3 Action4Printout Type 5 Printout Block6 Glossary7References 7.nOperational Instructions (optional)7.nCommand Descriptions (optional) 7.nPrintout Descriptions (optional) 7.nApplication Information (optional)7.nOther References (optional) The Reference subsection numbers are not fixed, only the order. 5   How to Write a Printout Description This section explains how to write a Printout Description. The first part contains the following sections: Guidelines and ConventionsTemplate and Example Documents The second part contains information about the contents of each section and subsection of the Printout Description as listed in subsection page 4.4. 5.1   Guidelines and Conventions Style Guidelines Detailed instructions on language and style conventions for O&M documents are found in the Docware Style Manual. Document type names must always be written out in full, that is, do not use an acronym for the document type names: Application InformationCommand DescriptionOperational InstructionPrintout Description Text may not be inserted between a level 1 heading and a level 2 heading. For example, no text is allowed between section 1 and 1.1, section 2 and 2.1, and so on. Keep sentences short and language simple. Avoid long strings of nouns. Expand abbreviations and acronyms at their first occurrence in the text. Example: Central Processor (CP) Use an English dictionary. Do not make up new words. Use standards telecommunication terminology and acronyms, that is, approved by the International Telecommunications Union (ITU) or the European Telecommunications Standards Institute (ETSI). General Guidelines Instructions for including each piece of information in the correct tag in the Printout Description template for Standard Generalized Markup Language (SGML) are found in User Guide How to Write a Printout Description in Text and Graphics. Examples are not permitted in a Printout Description. Graphic Guidelines Graphics are not allowed in a Printout Description for alphanumeric printouts. 5.2   Template and Example Documents When writing a Printout Description, use the current version of the alphanumeric Printout Description template. The project manager is responsible for providing information about the current versions of Document Instructions, example documents, templates, and tools. The following documents are examples of Printout Descriptions: BUSINESS GROUP ATTENDANT NUMBER AND QUEUE LINE DATA (example of an answer printout)FRAME HANDLER DATA LINK CONNECTION DETAILS (example of a printout with more than one format)LONG DURATION CALL SUPERVISION CONGESTION (example of an A-alarm printout)VOLUME LOADED (example of a result printout) 5.3   Section 1, Format This section explains how to write the Format section of an alphanumeric printout. 5.3.1   Subsection 1.1, Printout Include all information printed on the Input/Output (IO) device after the printout slogan. Enter the printout format, including all parameters, as described in Design Rule Printout Format for AXE. Describe the format clearly to avoid misinterpretation. 5.3.1.1   Subsection 1.1.n Format n To reduce the complex use of curly brackets, { }, in printouts with more than one distinct function, present the different formats separately. Use subsections for each format of the printout. Each subsection must have the name "Format n" where "n" is a number. Include the printout title in each subsection. For an example of more than one format, see FRAME HANDLER DATA LINK CONNECTION DETAILS. A printout may have more than one distinct format depending on how the command is specified. For example, a printout that contains information about recording groups (parameter RG) and measuring programs (parameter MP) may have a different format if parameter RG is entered rather than parameter MP. As parameter RG is the object of the printout, it would usually occupy the first column. 5.3.1.2   Layout Arrange columns in logical order (not in alphabetical order) so that parameters for an object are grouped together as much as possible. Consider the maximum length of data when spacing columns. The minimum allowed spacing is 2 spaces. However, when modifying existing printouts, the new layout should maintain backward compatibility (consult MAXE for help with this). Indicate whether the printout consists of several parts, and whether the parts or parameters are mandatory, optional, alternative, or repetitive. When writing new Printout Descriptions, use parameter FAULT to list alphanumeric texts, for example, MANUALLY BLOCKED. For updating existing Printout Descriptions, do not write FAULT CODE as a parameter name, instead, write FCODE. The value for parameter FCODE is a numeral. When working with printouts that contain parameter FCODE, add a parameter REASON that includes additional information describing the reason for the fault code. 5.3.1.3   Optional Strings List all optional strings in logical order (not in alphabetical order), that is, list them in the order in which they would normally be received. This requires some analysis on the part of the designer to make the printout description as user-friendly as possible. Write optional strings in full capitalization. Use optional string NONE to specify that no data exists to be printed. However, if there is no data for an individual, leave the field in the printout blank. NONE is primarily used in tables where data for individuals is printed, but no data for any individual exists. If the printout can be interrupted by the technician, indicate this by including optional string EOT DURING PRINTOUT. If the printout is delayed due to a long execution time, include optional string WAIT so the technician does not think the system is hanging. Ten seconds is considered an unreasonably long period of time to wait for a response from the IO device. 5.3.1.4   Fault Text Fault texts are received with or without interrupting printing. Fault Interrupt The printout may be interrupted by a fault situation that will not allow printing to continue. Indicate this by including the text " FAULT INTERRUPT". The text "fault type" is written below "FAULT INTERRUPT". Example: FAULT INTERRUPT fault type Fault type: FORMAT ERROR UNREASONABLE VALUE details FAULT CODE 20 ALL MEASURING PROGRAMS ARE BUSY Fault codes and slogans must be the same as used in the Command Description. Fault without Interrupt If a fault occurs, but does not interrupt the printout, " Fault type:" must be written on the line after the faulty parameter. Example: DEV fault type Fault type: FAULT CODE 5 DEVICE NOT INITIATED When the fault code is printed, it is always written in the left-most position on the line. The fault code slogan is to be written on the line under the fault code. 5.3.1.5   End Most printouts end with optional string END. State this in the Printout Description. (See Printout Format for AXE, for special cases). Optional string END is not used for answer printouts in dialogue mode. 5.3.2   Subsection 1.2, Parameters If the printout does not have any parameters, insert the following phrase: This printout has no parameters. If the parameter has a default value, include it. The parameters must be listed in alphabetical order within each of the following groups, in the order indicated: Normal parametersOptional stringsFault texts Describe the function and the syntax of each parameter value in detail in the same way as the parameters are described in the Command Description. In other words, it is important that, if a parameter has been loaded by a command, exactly the same parameter value name must be used in the printout. Do not include value ranges since these may be subject to changes that may require an update of the document. Always specify parameter values with symbolic name or a numeral that has a specific meaning. The parameter value list explanation must be concise. 5.3.2.1   Normal Parameters Simple Parameter Value A simple parameter value with its definition is written in the following format: parameter value nameparameter definition Example: dip Digital path Parameter Value with Function A parameter value with its definition and a description of the function is written in the following format: parameter value nameparameter definition  function Example: trg Traffic recording group This parameter lists the incoming and outgoing calls for the traffic recording group. Parameter Value with Constant Values A parameter value with its definition, its function, including constant values is written in the following format: parameter value nameparameter value definition function constant value definition  .. ..  .. constant valuedefinition Example: area Area being analysed OPERATING Operating area NON-OPERATING Non-operating area dico Diagnostic code This parameter indicates the diagnostics status and reason. 0 Diagnostics completed 1 Diagnostics interrupted by time supervision 2 Diagnostics incomplete because CP-SP could not be reached through CPT state Measuring program status DEFINED Measuring program defined RECORDING Recording in progress for measuring program SCHEDULE Time schedule defined for measuring program If the existence of an optional parameter is dependent on the existence of, or value of, another parameter, then specify how. Example: llimit Lower limit This parameter indicates the number of calls in the queue when the status is changed from closed to open. If the type of queue control (parameter qcontrol) is local, the local limit is not printed. Parameter Value with More than One Information Unit A parameter value with more than one information unit is written in the following format: parameter value name parameter definition function syntax for information unit  iu 1definition function additional information iu 2 definition  function  additional information .   . . iu ndefinition function additional information additional information Example:dev Device Expressed as dety-n where: dety Device type n Device number For alternative expressions, see the Application Information for block TRAN. nba Next branching action This parameter indicates that the next analysis step has been determined since the branching condition has been specified in parameter BC. Expressed as mod-id or enda-nn where: enda End of analysis action id Module type This is an identifier to distinguish between modules of the same type. nn IO device number mod Traffic parameter type analysed in branching module For value ranges, see the Application Information for block ACA. Parameter Value with Additional Information A parameter value with additional information is written in the following format: Example:pp Physical port This parameter indicates where the loop test was performed. Expressed as cm-lm-lu-pp where: cm Communication module lm Local modem lu Line interface unit pp Physical port The value for this parameter is application system dependent. "Application system dependent" is used in command parameters to indicate that the enclosed selections are optional in the market. The command, the parameter, and the parameter value can be "application system dependent". 5.3.2.2   Optional Strings Use the following standard phrases when explaining optional strings: EOT DURING PRINTOUT The operator has cancelled the printout. NONE No data existed to be printed. A function may have its own individual optional strings. These should also be listed in alphabetical order, with the other optional strings. 5.3.2.3   Fault Texts Fault texts are received with or without interrupting printing. Fault Interrupt The printout may be interrupted by a fault situation that will not allow printing to continue. Indicate this by including the text " FAULT INTERRUPT". The text "fault type" is written below "FAULT INTERRUPT". Write the text "Fault type:" below " fault type". The fault types are written under " Fault type:". The fault types are the following: FORMAT ERRORUNREASONABLE VALUEFAULT CODE n FAULT SLOGANNoteFORMAT ERROR is restricted and its use must be approved by MAXE. Example: FAULT INTERRUPT A fault interruption occurred fault type during printing. Fault type: FORMAT ERROR The command was incorrectly specified. UNREASONABLE VALUE details The parameter was specified with an unreasonable value. FAULT CODE 20 ALL MEASURING PROGRAMS ARE BUSY All measuring programs are busy. The number of measuring programs is defined by SAE 022. List and explain the fault types in ascending numerical order. Each fault has its own explanation, which is consistent with the explanation in the Command Description. The explanation must be written in complete sentences, with proper punctuation. The fault code slogan must be written in uppercase characters exactly as it appears on the IO device. Because the maximum number of characters that can be inserted in the IO buffer in one insert statement is 45, it is recommended that fault code slogans not exceed 45 characters, although a maximum of 72 characters are allowed. If a fault code slogan exceeds the page boundary, the fault code slogan should be continued on the next line. Using complete sentences, explain the reason for the fault code. Fault without Interrupt If a fault occurs, but does not interrupt the printout, "Fault type:" must be written, followed by the fault code and slogan. Example: Fault type: FAULT CODE 5 DEVICE NOT MANUALLY BLOCKED The specified device is not manually blocked . 5.4   Section 2, Function This section explains how to write the Function section of an alphanumeric printout. Start the function description with one of the following texts: This printout is received as a result printout to command ...This printout is received as an answer printout to command ...This printout is received as an answer printout and result printout to command ...This printout is an alarm printout. Continue the first paragraph with one of the following texts: It lists ...It indicates ... Example: This printout is received as an answer printout to command BGSVP. It lists the subscriber number and the associated extension validation data. If more information is required, keep it consistent with the Command Description. 5.4.1   Subsection 2.n, Format n If the printout has more than one format (see section page 5.3.1), describe the function of each of the formats in a separate, independent subsection. Each subsection must have the name "Format n" where "n" is the format number assigned in the Format section. Each subsection must follow the rules stated in section page 5.4. Do not include any information directly under the Function section heading, include all information about each format in the Format n subsection. Example: Format 1 This printout is received as an answer printout to command ANBSP. It lists the specified number series, or all the number series in the operating or the non-operating area. Format 2 This printout is received as an answer printout to command ANBSP. It lists the number series that have discrepancies. 5.5   Section 3, Action This section contains no information for answer printouts and result printouts. If no information is applicable, insert the following phrase: This printout requires no action. Describe all the actions, both administrative and technical, together with the information required to do the work specified by the printout. This description is particularly important if the printout is recommended as an observation alarm printout (alarm class O1 or O2) for which no corresponding Operational Instruction exists. If the printout is an alarm printout for a fault (alarm class A1, A2, or A3), there must be an alarm Operational Instruction with exactly the same title as the Printout Description. Send the technician to the alarm Operational Instruction. Example: Go to Operational Instruction ACCESS MODULE INSTRUMENT FAULT. If the printout is an O-alarm, tell the technician how to correct the alarm. Example: Change the restriction data for the traffic destinations when the traffic situation permits. This observation alarm will be deleted automatically when destination blocking is no longer activated for any traffic destination. 5.6   Section 4, Printout Type Indicate the printout type and how it is routed by the IO system. The printout types in AXE are indicated as follows: Printout type:Write:Alarm printoutAlarm printout, recommended Alarm Category (ALCAT) = yy, Printout Category (PRCA) = xxAnswer printout Answer printoutResult printout Result printout [, recommended Printout Category (PRCA) = xx] For definition of the printout types, see Design Rule Printout Format for AXE. Some printouts are used both as an answer printout and a result printout. If that is the case, write "Answer printout", and on the next line write "Result printout" together with the Printout Category (PRCA) if applicable. For a result printout, the xx value, in "(PRCA) = xx" above, is the recommended value for symbol PRCAnnn. PRCA is used only for result printouts that are not printed on the ordering IO device or the IO device indicated in the ordering command. PRCA is used normally for printouts that are not requested by command. All result printouts with PRCA have a unique PRCA symbol. All alarm printouts have a unique Alarm Category (ALCAT) symbol. For an alarm printout, the yy value, in "(ALCAT) = yy" above, is the recommended value for symbol ALCATnnn. The PRCA indicated for an alarm printout is normally the PRCA that is associated with the recommended alarm category. However, this is not the case if the PRCA is used to route the alarm printout differently from the normal routing for the alarm category. See Printout Categories in AXE. 5.7   Section 5, Printout Block Write the name of the block that generates the printout, that is, the block that prints the heading. 5.8   Section 6, Glossary If there are no glossary entries in the Printout Description, insert the following phrase: This document contains no glossary entries. Expand acronyms and explain terminology used in the Printout Description here. Use a definition list and insert acronyms and terms in the left column, and expanded acronyms and explanations in the right column. Parameters are never included in the glossary. 5.9   Section 7, References If a Printout Description has no references, insert the following phrase: This document has no references. List all documents referenced in the Printout Description as follows: 5.9.1   Subsection 9.n, Operational Instructions Write alarm Operational Instructions titles using full capitalization. Printout Descriptions can only refer to alarm Operational Instructions. Example: ACCESS MODULE INSTRUMENT FAULT 5.9.2   Subsection 9.n, Command Descriptions Write command codes for the Command Descriptions in full capitalization, followed by the command title (the expanded code) in title capitalization. Example: BUQOE BGC, Attendant Queue, Overload Handler, End 5.9.3   Subsection 9.n, Printout Descriptions Write Printout Description titles using full capitalization. Example: GROUP ADMINISTRATION DATA 5.9.4   Subsection 9.n, Application Information Write only the block names for the Application Information using full capitalization. Example: TRAN 5.9.5   Subsection 9.n, Other References References to documents other than the document coverd above are limited. Contact the MAXE for use of other documents. Write other referenced titles using title capitalization. 6   Glossary ALCATAlarm CategoryCMAXECentral MAXEETSIEuropean Telecommunications Standards InstituteIOInput/Output The IO device is used to enter information into and receive information from the system. ITUInternational Telecommunications UnionLMAXELocal MAXEMAXEMaintenance AXEO&MOperation and MaintenancePRCAPrintout Category 7   References BUSINESS GROUP ATTENDANT NUMBER AND QUEUE LINE DATA 310/1013-FCK 114 62 Uen  CREATING COMMAND DESCRIPTIONS FOR AXE2/1013-FCK 114 62 Uen  CREATING FILE PRINTOUT DESCRIPTIONS FOR AXE6/1013-FCK 114 62 Uen  Docware Style Manual2/198 17-FDD 207 08 Uen  FRAME HANDLER DATA LINK CONNECTION DETAILS 311/1013-FCK 114 62 Uen  Handling of Exemptions ETX/VQ 170 04-6274  How to Write an Alphanumeric Printout Description in Text and Graphics 3/198 17-CAL 151 0020 Uen   LONG DURATION CALL SUPERVISION CONGESTION 308/1013-FCK 114 62 Uen  Office Manual0015-EN/LZB 101 01/1A Uen Printout Categories in AXETX/JE-89:227 Uen  Printout Format for AXETM/JE-91:456 Uen  Rules for Writing Documents 0034-116 Uen VOLUME LOADED 313/1013-FCK 114 62 Uen