Vous êtes sur la page 1sur 13

BugFix

EWSD
Introduction to EWSD Documentation

Introduction Structure of the operating documentation Information Operation Help System Maintenance and Nonstandard Maintenance Man-machine language Version-specific and project-specific documentation Presentation forms SGML Documentation HTML Documentation PDF Documentation Hard-Copy Documentation Electronic documentation Navigation

Benefits This introduction to the EWSD operating documentation outlines the structure of the operating documentation denes the various types of documentation describes the different presentation forms of the operating documentation shows how to navigate through the operating documentation.

The scope of the documentation provided for a EWSD project is laid down in the contractual stipulations. In particular, the contract specifies the components of the operating documentation and whether and to what extent any product documentation and specific documentation is to be provided.

The operating documentation forms part of the EWSD customer documentation. Alongside the hardware and the software, the customer documentation is an integral component of the EWSD product itself. The operating documentation consists of the sections operation and maintenance (O&M) and information. In addition to the O&M documentation, the EWSD customer documentation also includes: product documentation specic documentation The product documentation comprises a range of detailed documents from the areas of development, project planning, production and service. Additional specific documentation may be necessary on a project-specific basis.

Customer documentation Operating documentation Standard: Maintenance, Operation, Information Product documentation Hardware: Circuit diagrams, wiring diagrams, etc. Software: Listings, etc. Configuration documents Specific documentation Release documentation: APS release documentation

Service: Installation, Network integration, Expansion

Project documentation:

Standards The development process for the EWSD hardware and software follows the development process plan, with its phases of analysis, design, implementation, system integration test and system test. The development process is certified in accordance with ISO 9001. The processes and procedures involved in the creation of the documentation also comply with ISO 9001. In awarding its quality certificate, the DQS (German Society for the Certification of Quality Management Systems) has approved the quality of the documentation creation processes. The documentation is drawn up in accordance with the following standards applicable to information and communication technology: ITU-T, Series B, in particular B.10 and B.17 (Blue book I.3) ETSI ETS 300 834, ETR 313, EG 201 103 (for Retrieval) ETS 300 498-1, ETS 300 498-2, ETR 081 (for Open Document Architecture) ETSI T/CS 01-10 (Montpellier 1984) Document Requirements for Digital Switching Systems The terminology used is in keeping with the requirements of ITU-T, ETSI and GSM. Product safety The EWSD telecommunications installations have been designed in accordance with the safety regulations specified in the standards EN 60950/IEC 60950. Any other devices hooked up to the system must also comply with the relevant safety regulations. Moreover: The safety regulations applicable to telecommunications installations must be observed for all work being performed on the system and on any devices hooked up to the system. In electrical installations, certain parts of the appliances are always live. In addition, some parts may heat up to a very high operating temperature. Non-observance of this situation and of the warnings can result in bodily injury and damage to the system. Therefore, correct handling of the technical installations must be ensured. All safety notes and the instructions for working with electrostatic-sensitive components must be observed. See also the document entitled Safety Notes for Personnel and for Products EN 60950/IEC60950. The safety notes are repeated where relevant in the manuals and supplemented by additional instructions in case of dangerous operations. It is assumed that the system is accessed and maintained only by trained and suitably qualified personnel.

Conformity The EWSD products conform to the CE requirements. This CE conformity is confirmed by the CE sticker on the product. The product is only approved for CE marking if the structure and cabling are in keeping with the specifications in the manual and the documents to which it refers, e.g. assembly instructions, cable lists, etc. Any project-specific documents that may exist must also be observed. The tests for CE conformity are performed in conjunction with the relevant surrounding infrastructure (e.g. cabling). The system is installed on the customers premises as in the test installation. Deviations from the specifications or any individual modifications made during installation, e.g. utilization of cable types with a lower shielding rate, may be in violation of the CE safety requirements. In such cases, the declaration of conformity shall become invalid. The individual responsible for making the change shall be held responsible for any subsequent damage or interference with operation. A warranty shall only apply insofar as the procedures outlined in the corresponding manuals have been correctly followed. Any deviation or change in a procedure shall result in cancellation of the warranty. Service concept The quality and reliability of a system is only proven through its many years of uninterrupted availability and trouble-free and efficient operation. The operation and maintenance of EWSD can be performed by the operating companies themselves. Siemens supports the trouble-free operation of EWSD through its worldwide service logistics. Siemens has set up an organization of technical service centers (TSC). Within the TSC, technical support is divided among the technical assistance centers (TAC), each of which is divided into three levels: TAC 1, the network operators service center TAC 2, the regional representatives service center TAC 3, the diagnostics center at the service for public communication networks in Munich The technical service centers can be called upon in cases of complicated service. The central service management and the regional service centers throughout the world are linked up to each other via a communications network. This ensures short response times for problem solving. A 24-hour stand-by service at all three service levels ensures the required support, regardless of the time zone.

Training For the personnel dealing with EWSD, Siemens offers application-specific and target-group-oriented training courses in the operation and maintenance of EWSD. The training programs are designed in keeping with the various activities on the system. The EWSD courses are held with the O&M documentation for the customers personnel and the service personnel. Special training is required for efficient operation of the network node with the help of the operation manuals (OMN) and the task manual (TML); these courses inform the EWSD administrator of the system fundamentals and its interrelations. For maintenance and service, the courses use the maintenance and nonstandard maintenance manuals (MMN, NM) to provide a basic outline of the system as well as specialized knowledge of the system components.
Prerequisite Task Knowledge of call processing Training in Operation Training in Maintenance Training for TSC1 Experts

Printing, layout or production errors that should be removed in the interest of the overall correctness of the document are initially noted and, unlike top-priority errors, are corrected not immediately but in the next version of the document.

Languages The operating documentation is available in English, German and Spanish.

Structure of the operating documentation


The operating documentation consists of informative parts, the descriptions (in some cases also product sheets), and instructional parts, the manuals. The O&M documentation is divided into the following sections, in accordance with the most important functions for EWSD operation: Information Operation Help System Maintenance and nonstandard maintenance Man-machine language Each document within the operating documentation is assigned to one of these sections, as briefly described in the following: Information

Information Operation Maintenance Nonstandard maintenance

X X X X (X) X X X X

Modifications The EWSD service at Siemens provides information on the modification of hardware, firmware and software in the EWSD system. New developments are always accompanied by new documents. In case of changes made to the system parts and functions, the operating companies receive the associated modified documents from the relevant documentation center. Errors affecting normal operation of the network node can be quickly recorded, reported and eliminated by means of a computer-aided error reporting system maintained by Siemens. The errors reported are recorded in a centralized error reporting catalog. In case of errors in the operating documentation, the relevant documentation department receives the error report and removes the error in accordance with the applicable quality regulation. The urgency of the correction is determined on the basis of the priority assigned. Documentation errors that could affect the operational safety of a network node are treated as top priority. Within a few days, customers receive an initial report with a suggestion for removing or preventing the error.

The information section of the operating documentation provides basic knowledge to EWSD products. The descriptive documents provide information on: Signaling IN services Operation and maintenance Voice processing Network management Trafc routing System software Central system hardware Peripheral system hardware Trafc data administration Subscriber features (ISDN, analog, CENTREX) The descriptions are divided into the following types: Sub-system descriptions General system descriptions Feature descriptions

The Sub-system descriptions give Information about individual system components:


Chapter Introduction Contents Provides a general overview of the sub-system, indicating its position within the system, its characteristics, structure, external and internal interfaces. Describes the sub-system functions. Describes the structure of the sub-system hardware, the functional units and hardware modules. Describes the structure of the sub-system software. This chapter is optional. Describes the specific safeguarding functions for the sub-system. This chapter is optional. Describes the specific administrative functions for the sub-system. This chapter is optional. Contains a table showing a summary of the technical data.

A service or a function comprises several features. The Feature descriptions provide detailed information on the individual features:
Chapter Definition Contents Describes the purpose, applicability (applications, users), the standards, the advantages for the operating company and the advantages for the user and indicates the market segment affected. Describes the functions of the features in the system and its capacity (maximum number of simultaneous users). Describes the application, the possibilities for subscriber-controlled input and the responses to subscriber-controlled input. This chapter is optional. Describes the possible means of charging for the feature. This chapter is optional. Describes the possible applications and the administration of each individual feature by the network operator or the user, if relevant for the feature in question. This includes authorizations, traffic measurement possibilities and references to operation manuals. This chapter is optional. Describes the system prerequisites for the feature in question. This includes signaling, line types, as well as the software and hardware requirements. This chapter is optional. Describes all the relevant compatibilities of the feature with other features as well as any peculiarities concerning the interaction of features. This chapter is optional.

Function Hardware structure Software

Mode of operation Subscriber procedure

Safeguarding

Call charge registration Administration

Administration

Technical data

If a system component exists in several variants (e.g. for peripheral hardware), a separate sub-system description exists for each variant.

System requirements

Compatibility

General system descriptions explain the interrelations between the individual services and functions of EWSD and provide information on the: Scope of functions Area of application As a rule, a general system description exists for each service or system function. However, depending on the scope of the information to be provided, the functions and the complexity of the topic, one subject area may have more than one general system description and additional feature descriptions.

Operation The operation manuals are used for administration of the network node or individual EWSD system applications. They are divided into: Operation manuals (OMN) for the network node User manuals (UMN) on software applications Successful administration of the EWSD network node and its software applications with the manuals listed here requires the following: an operational network node all hardware requirements for the database modications and expansion must be met The procedures to be followed for hardware expansion and for the preventive and corrective maintenance of hardware are not included in the OMN; these can be found in the relevant expansion and maintenance manuals.

Operation Manuals (OMN): Operation of the network node or of the networks is divided up according to the individual subject areas. A separate manual exists for each subject area, as follows: Subscriber administration (SU) Additional subscriber administration for toll-free service (TFS) Routing (RO) SS7 signaling (SS7) Network administration (NT) Charging (TA) Trafc data administration (TR) System administration (SY) The operation manuals (OMN) are uniform in their structure:
Chapter Introduction (IN) Contents The introduction describes the interrelations between system functions and provides examples of the more complex administrative tasks within the particular subject area. The task list contains all the tasks in the subject area, thereby forming an initial entry into the administrative tasks. The task summary lists are general, sequential lists of tasks with no cross-references or reverse links. The task procedures are non-sequential lists of tasks using sub-procedures. The feature procedures describe the function and contain a sequential list of tasks for the creation and administration of each feature.

Task List (TL)

Task Summary Lists (TS) Task Procedures (TP) Feature Procedures (FTP), optional

Task complex TC, if the task to be executed is complex and concerns a number of administrative areas. A task complex is basically a sequence of commands with the parameters and identiers from various manuals (e.g. SU, RO, SY) required for performing the tasks, though not all the mandatory parameters. Identical parameters are highlighted in each case. Comments following the procedure title or certain command inputs refer to any particular characteristics. Command in the command manual, if the task can be performed by executing a command. The cross-reference from the task list to a command can contain parameters and identiers. However, not all the mandatory parameters for the command are given, just those parameters of relevance to the task in question. Feature procedure (FTP). Feature procedures are peculiar to the subscriber administration manual. They rst describe the service and/or the functions as well as the prerequisites for creating, modifying and canceling. This is followed by the procedure, a sequence of commands with the parameters and identiers required for performing the tasks, though not all the mandatory parameters.

The OMN is entered via the task list (TL). The TL makes reference to the following sub-points: Task summary list (TS), if the task sequence to be executed can be performed without any cross-references and reverse links. The TS themselves can contain further references to task summary lists, procedures or commands. Task procedure (TP), which works through the task sequence step by step. A procedure is basically a sequence of commands with the parameters and identiers required for performing the tasks, though not all the mandatory parameters (these can be found in the task manual, TML). In case where conguration of the network node can differ, prerequisites are checked and the corresponding cases are distinguished. Comments following the procedure title or certain command inputs refer to any particular characteristics.

User Manuals (UMN) for Software Applications: The user manuals on software applications provide an outline of the application as well as information on the following tasks: Installation of hardware and software Operation/administration Maintenance For example, UMNs are available for the following software applications: Multifunctional attendant console (MAC) for the use and administration of GeoCENTREX Multifunctional switching board (MSB) for the use and administration of ADMOSS EWSD Net Manager for the administration of an EWSD network node and for the administration of a network The user manuals presuppose a certain level of knowledge about call processing and the fundamentals and interrelations of the system. Basic knowledge of PCs and the Windows environment is also assumed. The user manual describes only the most important processes. The user manuals are supplemented by the applications own help system, which provides context-sensitive help on the functions. For instance, this includes details on the menus and editing windows and on the keyboard commands for the softwares help system.

Help System The help system provides all information needed in the context of a software application: step-by-step instructions on how to carry out the tasks of the application information about this application context-sensitive help on items on your screen help on using help The help system consists of the following main sections: Overview This section provides some background information for the application. Tasks This section provides step-by-step instructions on how to perform each task. Reference Pages This section provides a description of particular functional sections of the application (detailed informations, examples etc.). These sections can be accessed by selecting Help menu, Help Topics item. As well as this, additional buttons are provided for a glossary and a shortcuts page. The help information available depends on the context and can be called by different methods To display help topics: In the Help menu, click Help Topics. The Help Topic dialog box is displayed, giving you access to the table of contents and index of the Centrex Manager help. The table of contents provides you with an overview of the tasks you can perform with the application. To display What's This? Help: Click the toolbar button, and then click the item to be queried or: Press SHIFT+F1, and then click the item to be queried or: Click <bitmap> in the title bar of the dialog box, and then click the item to be queried or Click the item to be queried or - for example in the case of pushbuttons - move the insertion point using the keyboard to the item and then press F1 You receive a brief explanation of the selected item. To display help on the current dialog box: Click Help You receive help on the current dialog box To display help on help: In the Help menu, click How to Use Help You receive the Windows NT help, which explains how to use the help system

To display information on this application: In the Help menu, click About You receive information on the name and version of the application

Maintenance and Nonstandard Maintenance The maintenance and nonstandard maintenance manuals support the troubleshooting of EWSD and the reactivation of the network node. The maintenance manuals (MMN) are organized according to the various hardware components. Manuals are available for the maintenance and nonstandard maintenance of the following individual hardware components: Maintenance manuals (MMN) . Thanks to the modular construction of the EWSD components, the maintenance personnel can remove faults caused by defective modules. The maintenance manuals contain procedures for troubleshooting on the basis of module replacement as well as procedures for preventive maintenance. In general, such troubleshooting procedures are sufcient for locating the suspected modules of a local or a remote EWSD network node. The module suspected of being faulty is then replaced by another module, according to the instructions in the maintenance manual (MMN). After the replaced module has been successfully tested, the original operating state is restored. nonstandard maintenance manuals (NM) Other faults, e.g. cable defects, are removed with the help of the nonstandard maintenance manuals (NM). Emergency manual (EMCYMN) The emergency manual (EMCYMN) contains information on how to reactivate an EWSD network node that has broken down completely or is operating only in part. Construction manual contains all hardware components In the event of difficult cases or emergency cases, help should be requested from the technical assistance center (TAC) in the technical service center.

Maintenance Manuals (MMN): The Maintenance Manuals (MMN) are uniform in their structure (see Table):
Chapter Introduction Procedures Contents The Introduction provides maintenance-specific information on the system components. Procedures for step-by-step troubleshooting of the inactive unit (modules are replaced and not repaired). The tables contain fault lists, allocation lists and references to construction sections.

The nonstandard maintenance manuals (NM) are uniform in their structure (see Table):
Chapter Introduction Contents The Introduction provides information on the system components as well as information specific to nonstandard maintenance. The Fault Description explains the results of the diagnosis and the system outputs. The Replacement Instructions contain information on replacing frames, modules and cables.

Fault Descriptions Replacement Instructions

Tables

The following steps are a summary of the general procedure for locating and removing faults with the help of a maintenance manual: The routine tests or the systems supervisory circuits discover a fault and send an alarm to the alarm surveillance of the network node. The alarm surveillance of the NetManager extracts the fault number and, with the aid of the unambiguous procedure number in the documentation, can refer to the correct fault clearance procedure. The corresponding procedure is must executed. The procedure can be executed locally, remotely or centrally from the O&M terminal. The procedure continues step-by-step through the task Locate fault. The on-site maintenance personnel locate the inactive module and replace it. The appropriate procedure is then used to reactivate the replaced unit. The faulty module is marked in accordance with the guidelines for electrostatic-sensitive components, packed and sent to the repair service. As a rule, the troubleshooting procedures are sufficient for removing most faults that can occur in the hardware component in question. However, if all suspected modules have already been replaced and the fault is still occurring, or the diagnostics test has not been able to find the reason for the fault, the next higher-ranking troubleshooting level must be called in (TAC1 -> TAC2 -> TAC3,). This will call for additional information and means for fault location and troubleshooting. Nonstandard Maintenance Manuals (NM): Module faults can generally be cleared up by using the procedures in the MMN. However, if the procedures in the MMN do not provide a successful outcome, troubleshooting should be continued in accordance with the nonstandard maintenance manual (NM). The nonstandard maintenance manuals contain additional information on each type of fault.

For each possible fault listing, the NM contains a section MMN:UUxxx-zzzz, arranged according to the full MMN number. Fault listings without MMN numbers are grouped together in separate sections. The nonstandard maintenance manual (NM) contains: Interpretations of hexadecimal additional information from the fault listing output Descriptions of the function of the defective system component Outline of the procedure leading to the system reactions within the safeguarding Information on suspect hardware included only partially in the troubleshooting procedures Explanations of the procedure and the function of the diagnosis Interpretations of the results of the diagnosis Additional troubleshooting notes for the various fault patterns Instructions for replacing modules, voltage transformers, module frames and cables Illustration of the racks and module frames Illustration of the standard cabling The nonstandard maintenance manual (NM) is entered by means of cross-references from the maintenance manuals (MMN). Emergency Manual (EMCYMN): The emergency manual (EMCYMN) contains emergency information on how to reactivate an EWSD network node that has broken down completely or is only partially functioning. The operating company is supported in this task by the technical assistance centers (TAC1 -> TAC 2 -> TAC 3 ). The emergency manual (EMCYMN) contains troubleshooting procedures for: Restoring normal system operation Safeguarding data (e.g. semipermanent inputs, charges, indices, etc.) The emergency manual (EMCYMN) is entered by means of cross-references from the maintenance manuals (MMN) or via alarms.

Construction Manual: The Construction Manual outlines and explains all the constructional parts of the EWSD product. Other documents refer to this manual whenever an explanation of the construction is required. The construction manual contains: Illustrations of all racks Illustrations of all module frames Illustrations of all modules, if the modules contain control elements Man-machine language The man-machine language (MML) of the EWSD network node is divided into two manuals: Task manual (TML) Output manual (OML) The system outputs pertaining to the commands are shown in a cross-reference list. Task Manual (TML): The Task Manual (TML) is a reference document which contains all tasks needed to operate the system including those tasks intended only for system specialists with special authorization. Technological advances have led to changes in the way the switch is addressed. There are new interfaces via which communication with the switch is possible. As a result some tasks communicate with the switch via traditional commands, others via a slightly different input format When entering parameter values, therefore, it is important to write them as they are shown in the manuals (lowercase or uppercase). For the sake of continuity all of these elements will be called tasks in future and will be described in this document. As in the past, the reader accesses the required information from the TML Table of Contents, or if task access is made from one of the manuals, through links in those documents Care has been taken to make input format representation as accurate as possible. There are however differences which the user must be aware of. For example, the output masks for traditional commands are described in an independent document (OML). However, if further clarification is required, the outputs of the new task formats are described in the relevant task itself. Another example is that the length of the input parameters is not limited to 8 characters in the new tasks: instead, the parameter names may be up to 20 characters long.

The structure of the Task Manual (TML) is as follows: Overview and Index of issues The TML overview makes up the administration section. The overview contains all tasks in tabular order. All entries contain an issue report and, if necessary, a change designation. The overview also contains a list of the other TML sections, for example Introduction. It contains links which allow the user to jump to the information in the other TML section. Introduction The Introduction contains specic instructions for using the TML including the differences relevant to operation between traditional commands (MML tasks) and the newer tasks. Where the information is valid for all tasks, it appears only once. Where there are differences it is clearly stated for which type of task the information is intended. Task descriptions The task descriptions are the main part of the TML and reect the set of tasks relevant to a specic APS. Task descriptions include information about the syntax, parameters, and, where applicable, paths and parameter values. Task descriptions are structured as follows: Task short and long name Task helptext Task syntax Parameter information including general parameter information, and, where applicable, subparameter and parameter value information Input syntax This section provides an overview of the input format for tasks and the syntax. The syntax is displayed in Backus-Naur Notation: Input format
Graphic display of parameters DEMO= [,DEMO=] {,DEMO1=|, DEMO2=} [{,DEMO1=|, DEMO2= }] [DEMO1=,DEMO2=] Comment Mandatory parameter Optional parameter Entering exactly one parameter is mandatory Entering exactly one parameter is optional Entering all parameters or none entered Possible combinations: All parameters are entered Possible combinations: All parameters are entered Enter only DEMO1 Enter both parameters (DEMO2 may not be entered alone) At least one parameter must be entered.

[DEMO1=[DEMO2=]]

<,DEMO1=,DEMO2=, DEMO3=>

The syntax diagrams contain links which allow direct access to the individual parameter descriptions.

MML task-specic remarks MML tasks which can be used for different purposes are split into different input formats (paths). This applies particularly in cases where the above mentioned syntax is not able to represent all the dependencies among parameters, parameters and parameter values, or among parameter values. An overview of the input formats is given at the beginning of each command description. Example: The MML task has the following paths:
1. 2. 3. 4. 5. 6. 7. 8. 9. CR TEQ - ATCL CR TEQ - ATE CR TEQ - ATEMAN CR TEQ - ATESELF CR TEQ - TEMLE CR TEQ - TESTSET CR TEQ - RBSI CR TEQ - TLFI CR TEQ - ADDATE ACCESS TEST CIRCUIT SUB LINE AUTOMATIC TEST EQUIPMENT ATE FOR TESTING AND MEASURING ATE FOR SELFTEST TEST MODULE LEVEL TEST SET RING BACK SERVICE INTEGRATED TRANSLATION SERVICE INTEGRATED ADDITIONAL ATE PORT

Under certain circumstances a parameter may have up to four subparameters. Subparameters are also called information units; they must be separated by a hyphen. In the Task Manual, information units are symbolized by the lowercase letters a, b, c and d. Example:
PARD3 PARAMETER DEMONSTRATION 3 =a-b-c-d a: FIRST INFORMATION UNIT= 0...7, range of decimal numbers b: SECOND INFORMATION UNIT = etc.

The old and new parameters are also represented by lowercase letters. Example:
DIGIT DIGITS = The parameter specifies the prefix digits for test multiple. n/o n/ /o 1...8 hexadecimal number where B is interchangeable with * and C is interchangeable with #

The paths also contain links which allow direct access to the individual input descriptions. Input parameters The description of the input parameters explains the syntax of the individual parameters. In the simplest cases, parameters are described by the parameter short and long name and the parameter value range. The parameter value range may be a range of decimal numbers, for example, or it may be dened by a specic character set as shown below:
Alphanumeric sym- A...Z 0...9. + * % # bolic names: Alphanumeric text A...Z 0...9 . + * % # < ( & ! $ ) ; - / , _ > ? : @ ' strings: = <enter> <line feed>

In this case, new and old have a very general meaning. Example:
MOD TEQ: DIGITS= MOD TEQ: DIGITS= MOD TEQ: DIGITS= newvalue/oldvalue newvalue/ /oldvalue Changes the prefix value newvalue/oldvalue Enters new prefix digit Deletes old prefix digit

Text strings must be enclosed in quotation marks ("), If a quotation mark has to included in a text string, it must be doubled (""). The maximum length of a text string including the quotation marks is 72 characters. Example:
PARDM1 PARAMETER DEMONSTRATION 1 = 5...8 characters from the symbolic name character set

In certain cases, however, mnemonic abbreviations may be entered for a parameter. These abbreviations are also called identiers. Identiers have short and long names and may be supplemented by a helptext. Example:
PARD2 PARAMETER DEMONSTRATION 2 = IDF1 LONGNAME IDENTIFIER NO. 1 IDF2 LONGNAME IDENTIFIER NO. 2

Default values If the syntax allows omission of a parameter or subparameter, the key word Default in the parameter helptext describes how the system will respond. The following cases are possible: Default value: <value> <value> is a parameter value within the permissible range that is automatically used if the parameter is omitted. Default behavior: <value> Values given are added to the default value. This combination indicates that one can add other values to default values. Default behavior <text> <text> describes the behavior of the system if the parameter is omitted. This option is selected if it is not possible to specify a default value. Examples: Optional parameter DATE Default value: current date. The current date is used.

Optional selection parameter for DISP and STAT commands Default behavior: no restriction of output. Output is not restricted by omission of the parameter. Optional control parameter for CR, ENTR, CAN and MOD commands Default behavior: no effect on the database. The database is not modied. Optional control parameter for ACT, DACT, DIAG and TEST commands Default behavior: no effect on the process. The process is not affected by omission of the parameter.

Version-specic and projectspecic documentation


Version-specific documentation: The operation and maintenance documentation provides a complete description of the structure and the functions of EWSD. The contents of each document apply to a particular EWSD version, i.e. the documents supplied outline the complete range of services for that EWSD version. Project-specific documentation: The scope of the documentation and the composition of the documents themselves can be adapted to meet the needs of a particular operating company or a particular project. The type and the number of documents are determined by the configuration of the individual project; the documents are then put together in accordance with the contract (volume, language, medium). The operation and maintenance documentation supplied describes the hardware and the software of the project. In principle, it also only describes the application and administration of those functions for which the operating company has obtained authorization. However, as the selection criteria are not clearly defined, the O&M documentation supplied may also possibly include: Functional sections for which the operating company has not obtained authorization Application and administration of functions not created in the corresponding EWSD network node for example, subscriber administration in transit network nodes. The sections specified in the manuals as project-specific or provider-specific are subject to separate agreements and contracts with Siemens and may only be used in the project in question. The operating manuals and the maintenance manuals are version-specific and not project-specific.

Output manual (OML) Like the TML, the output manual (OML) is also generated on a version- and projectspecific basis and contains all command outputs applicable for the project in question. The output manual (OML) describes the system outputs of EWSD. The output masks are arranged in numerical order. For each mask, the output format is shown and the individual output parameters are explained. Table shows the structure of the OML:
Chapter Introduction (IN) Masks (MSK) Reference Lists (TAB) Contents Structure of the command description, command syntax Description of the MML output masks (project-specific scope) Relationship between the output masks and the possible commands

The table part of the output manual contains a reference list arranged according to: Mask number, leading to the mask variant, message group and command name. Message group, leading to the mask number, mask variant and command name.

10

Presentation forms
The EWSD operation and maintenance documentation is created with an editor from the FrameMaker product range. From this basis, it is then made available in the following formats: SGML Documentation (structured generalized markup language) HTML Documentation PDF Documentation (portable document format) Hard-Copy Documentation Each of these formats has its own specific applications and advantages. SGML Documentation SGML is a platform-independent markup language used for structuring documents with respect to their contents (ISO 8879 standard). The underlying document type definition (DTD) is CTD V1.0 in accordance with the EFTI3 recommendation from 18 April 1997 in Stockholm. SGML is a clearly structured markup language which itself contains no page layout definition. However, suitable stylesheets can be used to specify a user-specific layout for the documentation from all suppliers. DynaText is the browser preferred by Siemens for the presentation of electronic documentation. DynaText comes standard with NetManager versions V3.2 and V4N. With the NetManager, it is also possible to communicate interactively with EWSD. All commands prepared for execution on the network node can be sent directly from the corresponding SGML documents to the network node and then executed. HTML Documentation This is the format currently in use for the presentation of information in the World Wide Web (Intranet/Internet). The documentation in HTML is derived from the SGML format. Using the product DynaWeb (from the same product range as DynaText), DynaText books can be converted into HTML on the fly and displayed by Internet browsers. This technology can be used to set up an Intranetbased information system. PDF Documentation PDF is a platform-independent format. This format is derived from PostScript, and this explains why its layout is oriented towards hard-copy documentation. However, with its hypertext and retrieval functions, it is also suitable for displaying documentation on screen. The viewer required for on-screen display is the Adobe Acrobat Reader.

Hard-Copy Documentation The PDF format is used for generating hard-copy documentation.

Electronic documentation
The NetManager is the platform for user software for operation and maintenance of the EWSD network node. Depending on the demand, and in accordance with the growing operational requirements, the NetManager can be configured in the following ways: in stand-alone conguration consisting of one NetManager client in work group conguration consisting of several NetManager clients in client-server conguration consisting of communication server, NetManager client, le server The main functions provided by the NetManager are as follows: graphical OA&M applications local/remote and centralized operation and maintenance automation of the administrative tasks by means of scenarios The operating documentation is available in electronic form on the NetManager. The manual data is stored separately from the applications. As a result, the manual data can be updated independently of the applications, or new versions of the operating documentation can be installed. At present, the operating documentation is made available electronically in Dynatext format on the NetManager client with the Interactive Document Browser application. The user can thereby navigate within the operating documentation and obtain the required information. In the event of an error, the Alarm Surveillance application will directly start the viewer and jump to the corresponding maintenance procedure with which the user can perform the necessary troubleshooting. Meanwhile, the Interactive Document Browser also starts the Workbench function of the NetManager. The Workbench function makes it possible to communicate interactively with EWSD. All commands prepared for execution on the network node can thereby be sent directly to the network node.

11

Navigation Each of the product descriptions and manuals is an independent and self-contained document. As a rule, the individual information units are not duplicated, i.e. they occur just once in the entire documentation. Therefore, whenever additional information is necessary, reference is made to the information that is required to supplement the existing information. In the electronic presentation forms of the documentation, such cross-references are in the form of hyperlinks. Cross-referencing in feature descriptions: The feature descriptions refer to the task list (TL) of the operation manual describing the administration of this feature (in the case of subscriber features, a direct reference is made to the corresponding procedure).

Cross-referencing in sub-system descriptions To supplement the information they contain, the sub-system descriptions refer to: Other sub-system descriptions with a related subject matter The construction manual for illustrating the constructional parts described Cross-referencing in general system descriptions: The general system descriptions refer to: The corresponding section in the operation manuals (OMN) dealing with the subject matter Sub-system descriptions for detailed information Feature descriptions

Information Introduction to EWSD documentation

Operation Introduction 1st topic (example) nth topic (example) Task list (TL)

1st Feature 1.st nth Feature)

NetManager General section

Subscriber features

1st. Thema nnth. Thema

Command interface

nth feature Task summary list (TS) nth nth feature Task procedures (TP) Task complexes (TC) Interactive to node

General system descriptions

12

Cross-referencing in the OMN: The introductory section of an operation manual outlines certain administrative tasks as a example and refers to the background information in descriptions. The task list (TL) of the OMN is divided according to topics and forms the point of entry to the administrative tasks. The TL refers to: the introduction to documentation task summary lists procedures task complexes commands in the command manual the introduction in the same manual The procedures in the OMN refer to: other procedures (with sub-procedures) commands in the command manual introduction in the same manual

Cross-referencing in the MMN: System faults requiring maintenance result in an alarm with a defined fault output, including the fault number. The alarm output of the NetManager uses the fault number to call up the associated troubleshooting procedure from the corresponding manual. The NetManager provides an interface to the network node, thereby enabling the user to send the commands contained in the procedures to the network node and have them executed there. The introductory section of the MMN refers to: introduction to documentation sub-system descriptions The procedures refer to: other procedures tables the construction manual the nonstandard maintenance manual, in case of complex errors

Maintenance MMN

Nonstandard maintenance NM

NetManager

Introduction

NetManager

Alarm Surveillance

Task list (optional) Procedures

Command interface

Interactive from node

Tables

Interactive to node

Fault tables

Construction part

Information Higher-ranking documentation

Sub-system description

Construction manual

Copyright (C) Siemens AG 2002 Issued by Information and Communications Group Hofmannstrae 51 D-81359 Mnchen Technical modifications possible. Technical specifications and features are binding only insofar as they are specifically and expressly agreed upon in a written contract. Order Number: A30828-X1160-A100-2-7618

Visit our Website at: http://www.siemens.com

13

Vous aimerez peut-être aussi