BugFix

1

EWSDIntroduction to EWSD Documentation

Introduction

The operating documentation forms part of the EWSDcustomer documentation. Alongside the hardware andthe software, the customer documentation is an integralcomponent of the EWSD product itself. The operatingdocumentation consists of the sections operation andmaintenance (O&M) and information.

In addition to the O&M documentation, the EWSD cus-tomer documentation also includes:– product documentation– specific documentation

The product documentation comprises a range of de-tailed documents from the areas of development,project planning, production and service. Additionalspecific documentation may be necessary on aproject-specific basis.

The scope of the documentation provided for a EWSDproject is laid down in the contractual stipulations. Inparticular, the contract specifies the components of theoperating documentation and whether and to what ex-tent any product documentation and specific documen-tation is to be provided.

Structure of the operating documentationInformationOperationHelp SystemMaintenance and Nonstandard MaintenanceMan-machine language

Version-specific and project-specific documenta-tionPresentation forms

SGML DocumentationHTML DocumentationPDF DocumentationHard-Copy Documentation

Electronic documentationNavigation

This introduction to the EWSD operatingdocumentation– outlines the structure of the operating

documentation– defines the various types of documentation– describes the different presentation forms

of the operating documentation– shows how to navigate through the

operating documentation.

Benefits

Customer documentation

Operatingdocumentation

Productdocumentation

Specificdocumentation

Releasedocumentation:APS releasedocumentation

Projectdocumentation:

Configurationdocuments

Standard:

Maintenance,Operation,Information

Service:

Installation,Networkintegration,Expansion

Software:

Listings, etc.

Hardware:

Circuitdiagrams,wiringdiagrams, etc.

2

Standards

The development process for the EWSD hardware andsoftware follows the development process plan, with itsphases of analysis, design, implementation, system in-tegration test and system test. The development pro-cess is certified in accordance with ISO 9001.

The processes and procedures involved in the creationof the documentation also comply with ISO 9001. Inawarding its quality certificate, the DQS (German Soci-ety for the Certification of Quality Management Sys-tems) has approved the quality of the documentationcreation processes.

The documentation is drawn up in accordance with thefollowing standards applicable to information and com-munication 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 require-ments of ITU-T, ETSI and GSM.

Product safety

The EWSD telecommunications installations havebeen designed in accordance with the safety regula-tions specified in the standards EN 60950/IEC 60950.Any other devices hooked up to the system must alsocomply with the relevant safety regulations.

Moreover: The safety regulations applicable to tele-communications installations must be observed for allwork being performed on the system and on any devic-es hooked up to the system. In electrical installations,certain parts of the appliances are always live. In addi-tion, some parts may heat up to a very high operatingtemperature. Non-observance of this situation and ofthe warnings can result in bodily injury and damage tothe system.

Therefore, correct handling of the technical installationsmust be ensured. All safety notes and the instructionsfor working with electrostatic-sensitive componentsmust be observed. See also the document entitled“Safety Notes for Personnel and for ProductsEN 60950/IEC60950”.

The safety notes are repeated where relevant in themanuals and supplemented by additional instructionsin case of dangerous operations. It is assumed that thesystem is accessed and maintained only by trained andsuitably qualified personnel.

Conformity

The EWSD products conform to the CE requirements.This CE conformity is confirmed by the CE sticker onthe product.

The product is only approved for CE marking if thestructure and cabling are in keeping with the specifica-tions in the manual and the documents to which it re-fers, e.g. assembly instructions, cable lists, etc. Anyproject-specific documents that may exist must also beobserved. The tests for CE conformity are performed inconjunction with the relevant surrounding infrastructure(e.g. cabling). The system is installed on the customer’spremises as in the test installation.

Deviations from the specifications or any individualmodifications made during installation, e.g. utilization ofcable types with a lower shielding rate, may be in viola-tion of the CE safety requirements. In such cases, thedeclaration of conformity shall become invalid. The in-dividual responsible for making the change shall beheld responsible for any subsequent damage or inter-ference with operation.

A warranty shall only apply insofar as the proceduresoutlined in the corresponding manuals have been cor-rectly followed. Any deviation or change in a procedureshall result in cancellation of the warranty.

Service concept

The quality and reliability of a system is only proventhrough its many years of uninterrupted availability andtrouble-free and efficient operation. The operation andmaintenance of EWSD can be performed by the oper-ating companies themselves. Siemens supports thetrouble-free operation of EWSD through its worldwideservice logistics.

Siemens has set up an organization of technical ser-vice centers (TSC). Within the TSC, technical supportis divided among the technical assistance centers(TAC), each of which is divided into three levels:– TAC 1, the network operator’s service center– TAC 2, the regional representative’s service center– TAC 3, the diagnostics center at the service for pub-

lic communication networks in Munich

The technical service centers can be called upon incases of complicated service. The central service man-agement and the regional service centers throughoutthe world are linked up to each other via a communica-tions network. This ensures short response times forproblem solving. A 24-hour stand-by service at all threeservice levels ensures the required support, regardlessof the time zone.

3

Training

For the personnel dealing with EWSD, Siemens offersapplication-specific and target-group-oriented trainingcourses in the operation and maintenance of EWSD.The training programs are designed in keeping with thevarious activities on the system. The EWSD coursesare held with the O&M documentation for the custom-er’s personnel and the service personnel.

Special training is required for efficient operation of thenetwork node with the help of the operation manuals(OMN) and the task manual (TML); these courses in-form the EWSD administrator of the system fundamen-tals and its interrelations. For maintenance and service,the courses use the maintenance and nonstandardmaintenance manuals (MMN, NM) to provide a basicoutline of the system as well as specialized knowledgeof the system components.

Modifications

The EWSD service at Siemens provides information onthe modification of hardware, firmware and software inthe EWSD system. New developments are always ac-companied by new documents. In case of changesmade to the system parts and functions, the operatingcompanies receive the associated modified documentsfrom the relevant documentation center.

Errors affecting normal operation of the network nodecan be quickly recorded, reported and eliminated bymeans of a computer-aided error reporting systemmaintained by Siemens. The errors reported are re-corded in a centralized error reporting catalog. In caseof errors in the operating documentation, the relevantdocumentation department receives the error reportand removes the error in accordance with the applica-ble quality regulation. The urgency of the correction isdetermined on the basis of the priority assigned.– Documentation errors that could affect the opera-

tional safety of a network node are treated as toppriority. Within a few days, customers receive an ini-tial report with a suggestion for removing or pre-venting the error.

– Printing, layout or production errors that should beremoved in the interest of the overall correctness ofthe document are initially noted and, unlike top-pri-ority errors, are corrected not immediately but in thenext version of the document.

Languages

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

Structure of the operatingdocumentationThe operating documentation consists of informativeparts, the descriptions (in some cases also productsheets), and instructional parts, the manuals. The O&Mdocumentation is divided into the following sections, inaccordance with the most important functions forEWSD operation:• Information• Operation• Help System• Maintenance and nonstandard maintenance• Man-machine language

Each document within the operating documentation isassigned to one of these sections, as briefly describedin the following:

Information

The information section of the operating documentationprovides basic knowledge to EWSD products. The de-scriptive documents provide information on:– Signaling– IN services– Operation and maintenance– Voice processing– Network management– Traffic routing– System software– Central system hardware– Peripheral system hardware– Traffic data administration– Subscriber features (ISDN, analog, CENTREX)

The descriptions are divided into the following types:• Sub-system descriptions• General system descriptions• Feature descriptions

Prerequisite Knowledge ofcall

processing

Trainingin

Opera-tion

Trainingin

Mainte-nance

Trainingfor TSC1ExpertsTask

Information X

Operation X X

Maintenance X X

Nonstandardmaintenance

X (X) X X

4

The Sub-system descriptions give Information aboutindividual system components:

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

General system descriptions explain the interrela-tions between the individual services and functions ofEWSD and provide information on the:– Scope of functions– Area of application

As a rule, a general system description exists for eachservice or system function. However, depending on thescope of the information to be provided, the functionsand the complexity of the topic, one subject area mayhave more than one general system description andadditional feature descriptions.

A service or a function comprises several features. TheFeature descriptions provide detailed information onthe individual features:

Operation

The operation manuals are used for administration ofthe network node or individual EWSD system applica-tions. They are divided into:• Operation manuals (OMN) for the network node• User manuals (UMN) on software applications

Successful administration of the EWSD network nodeand its software applications with the manuals listedhere requires the following:– an operational network node– all hardware requirements for the database modifi-

cations and expansion must be met

The procedures to be followed for hardware expansionand for the preventive and corrective maintenance ofhardware are not included in the OMN; these can befound in the relevant expansion and maintenance man-uals.

Chapter Contents

Introduction Provides a general overview of the sub-system,indicating its position within the system, itscharacteristics, structure, external and internalinterfaces.

Function Describes the sub-system functions.

Hardwarestructure

Describes the structure of the sub-systemhardware, the functional units and hardwaremodules.

Software Describes the structure of the sub-systemsoftware.This chapter is optional.

Safeguarding Describes the specific safeguarding functionsfor the sub-system.This chapter is optional.

Administration Describes the specific administrative functionsfor the sub-system.This chapter is optional.

Technicaldata

Contains a table showing a summary of thetechnical data.

Chapter Contents

Definition Describes the purpose, applicability (applications,users), the standards, the advantages for theoperating company and the advantages for theuser and indicates the market segment affected.

Mode ofoperation

Describes the functions of the features in thesystem and its capacity (maximum number ofsimultaneous users).

Subscriberprocedure

Describes the application, the possibilities forsubscriber-controlled input and the responsesto subscriber-controlled input.This chapter is optional.

Call chargeregistration

Describes the possible means of charging forthe feature.This chapter is optional.

Administration Describes the possible applications and theadministration of each individual feature by thenetwork operator or the user, if relevant for thefeature in question. This includes authorizations,traffic measurement possibilities and referencesto operation manuals.This chapter is optional.

Systemrequirements

Describes the system prerequisites for the featurein question. This includes signaling, line types, aswell as the software and hardware requirements.This chapter is optional.

Compatibility Describes all the relevant compatibilities of thefeature with other features as well as any pecu-liarities concerning the interaction of features.This chapter is optional.

5

Operation Manuals (OMN) : Operation of the networknode or of the networks is divided up according to theindividual subject areas. A separate manual exists foreach subject area, as follows:– Subscriber administration (SU)

Additional subscriber administration for toll-freeservice (TFS)

– Routing (RO)– SS7 signaling (SS7)– Network administration (NT)– Charging (TA)– Traffic data administration (TR)– System administration (SY)

The operation manuals (OMN) are uniform in theirstructure:

The OMN is entered via the task list (TL). The TLmakes reference to the following sub-points:– Task summary list (TS), if the task sequence to be

executed can be performed without any cross-refer-ences and reverse links. The TS themselves cancontain further references to task summary lists,procedures or commands.

– Task procedure (TP), which works through the tasksequence step by step.A procedure is basically a sequence of commandswith the parameters and identifiers required for per-forming the tasks, though not all the mandatory pa-rameters (these can be found in the task manual,TML).In case where configuration of the network nodecan differ, prerequisites are checked and the corre-sponding cases are distinguished. Comments fol-lowing the procedure title or certain commandinputs refer to any particular characteristics.

– Task complex TC, if the task to be executed is com-plex and concerns a number of administrative ar-eas.A task complex is basically a sequence of com-mands with the parameters and identifiers from var-ious manuals (e.g. SU, RO, SY) required forperforming the tasks, though not all the mandatoryparameters.Identical parameters are highlighted in each case.Comments following the procedure title or certaincommand inputs refer to any particular characteris-tics.

– Command in the command manual, if the task canbe performed by executing a command.The cross-reference from the task list to a com-mand can contain parameters and identifiers. How-ever, not all the mandatory parameters for thecommand are given, just those parameters of rele-vance to the task in question.

– Feature procedure (FTP). Feature procedures arepeculiar to the subscriber administration manual.They first describe the service and/or the functionsas well as the prerequisites for creating, modifyingand canceling. This is followed by the procedure, asequence of commands with the parameters andidentifiers required for performing the tasks, thoughnot all the mandatory parameters.

User Manuals (UMN) for Software Applications: Theuser manuals on software applications provide an out-line of the application as well as information on the fol-lowing tasks:– Installation of hardware and software– Operation/administration– Maintenance

For example, UMNs are available for the following soft-ware 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 anetwork

The user manuals presuppose a certain level ofknowledge about call processing and the fundamentalsand interrelations of the system. Basic knowledge ofPCs and the Windows environment is also assumed.

The user manual describes only the most importantprocesses.

The user manuals are supplemented by the applica-tion’s own help system, which provides context-sensi-tive help on the functions. For instance, this includesdetails on the menus and editing windows and on thekeyboard commands for the software’s help system.

Chapter Contents

Introduction (IN) The introduction describes the interrelationsbetween system functions and providesexamples of the more complex administrativetasks within the particular subject area.

Task List (TL) The task list contains all the tasks in the subjectarea, thereby forming an initial entry into theadministrative tasks.

Task SummaryLists (TS)

The task summary lists are general, sequentiallists of tasks with no cross-references or reverselinks.

Task Proce-dures (TP)

The task procedures are non-sequential lists oftasks using sub-procedures.

FeatureProcedures(FTP), optional

The feature procedures describe the functionand contain a sequential list of tasks for thecreation and administration of each feature.

6

Help System

The help system provides all information needed in thecontext 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 sec-tions:• Overview

This section provides some background informa-tion for the application.

• TasksThis section provides step-by-step instructions onhow to perform each task.

• Reference PagesThis section provides a description of particularfunctional sections of the application (detailed infor-mations, examples etc.).

These sections can be accessed by selecting Helpmenu, Help Topics item.

As well as this, additional buttons are provided for aglossary and a shortcuts page.

The help information available depends on the contextand 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 youaccess to the table of contents and index of theCentrex Manager help. The table of contents pro-vides you with an overview of the tasks you can per-form with the application.

• To display What's This? Help:Click the toolbar button, and then click the item tobe queriedor:Press SHIFT+F1, and then click the item to bequeriedor:Click <bitmap> in the title bar of the dialog box, andthen click the item to be queriedorClick the item to be queried or - for example in thecase of pushbuttons - move the insertion point us-ing the keyboard to the item and then press F1You receive a brief explanation of the selected item.

• To display help on the current dialog box:Click HelpYou receive help on the current dialog box

• To display help on help:In the Help menu, click How to Use HelpYou receive the Windows NT help, which explainshow to use the help system

• To display information on this application:In the Help menu, click AboutYou receive information on the name and version ofthe application

Maintenance and Nonstandard Maintenance

The maintenance and nonstandard maintenance man-uals support the troubleshooting of EWSD and the re-activation of the network node.

The maintenance manuals (MMN) are organized ac-cording to the various hardware components. Manualsare available for the maintenance and nonstandardmaintenance of the following individual hardware com-ponents:• Maintenance manuals (MMN) .

Thanks to the modular construction of the EWSDcomponents, the maintenance personnel can re-move faults caused by defective modules. Themaintenance manuals contain procedures for trou-bleshooting on the basis of module replacement aswell as procedures for preventive maintenance. Ingeneral, such troubleshooting procedures are suffi-cient for locating the suspected modules of a localor a remote EWSD network node. The module sus-pected of being faulty is then replaced by anothermodule, according to the instructions in the mainte-nance manual (MMN). After the replaced modulehas been successfully tested, the original operatingstate is restored.

• nonstandard maintenance manuals (NM)Other faults, e.g. cable defects, are removed withthe help of the nonstandard maintenance manuals(NM).

• Emergency manual (EMCYMN)The emergency manual (EMCYMN) contains infor-mation on how to reactivate an EWSD networknode that has broken down completely or is operat-ing only in part.

• Construction manual contains all hardware com-ponents

In the event of difficult cases or emergency cases, helpshould be requested from the technical assistance cen-ter (TAC) in the technical service center.

7

Maintenance Manuals (MMN) : The MaintenanceManuals (MMN) are uniform in their structure (see Ta-ble):

The following steps are a summary of the general pro-cedure for locating and removing faults with the help ofa maintenance manual:– The routine tests or the system’s supervisory cir-

cuits discover a fault and send an alarm to thealarm surveillance of the network node.

– The alarm surveillance of the NetManager extractsthe fault number and, with the aid of the unambigu-ous procedure number in the documentation, canrefer to the correct fault clearance procedure.

– The corresponding procedure is must executed.The procedure can be executed locally, remotely orcentrally from the O&M terminal. The procedurecontinues step-by-step through the task “Locatefault”.

– The on-site maintenance personnel locate the inac-tive module and replace it.

– The appropriate procedure is then used to reacti-vate the replaced unit.

– The faulty module is marked in accordance with theguidelines for electrostatic-sensitive components,packed and sent to the repair service.

As a rule, the troubleshooting procedures are sufficientfor removing most faults that can occur in the hardwarecomponent in question. However, if all suspected mod-ules have already been replaced and the fault is still oc-curring, or the diagnostics test has not been able to findthe reason for the fault, the next higher-ranking trouble-shooting level must be called in (TAC1 -> TAC2 ->TAC3,). This will call for additional information andmeans for fault location and troubleshooting.

Nonstandard Maintenance Manuals (NM): Modulefaults can generally be cleared up by using the proce-dures in the MMN. However, if the procedures in theMMN do not provide a successful outcome, trouble-shooting should be continued in accordance with thenonstandard maintenance manual (NM). The non-standard maintenance manuals contain additional in-formation on each type of fault.

The nonstandard maintenance manuals (NM) are uni-form in their structure (see Table):

For each possible fault listing, the NM contains a sec-tion MMN:UUxxx-zzzz, arranged according to the fullMMN number. Fault listings without MMN numbers aregrouped together in separate sections. The nonstand-ard maintenance manual (NM) contains:– Interpretations of hexadecimal additional informa-

tion from the fault listing output– Descriptions of the function of the defective system

component– Outline of the procedure leading to the system re-

actions within the safeguarding– Information on suspect hardware included only par-

tially 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 trans-

formers, module frames and cables– Illustration of the racks and module frames– Illustration of the standard cabling

The nonstandard maintenance manual (NM) is enteredby means of cross-references from the maintenancemanuals (MMN).

Emergency Manual (EMCYMN): The emergency man-ual (EMCYMN) contains emergency information on howto reactivate an EWSD network node that has brokendown completely or is only partially functioning. The op-erating company is supported in this task by the techni-cal assistance centers (TAC1 -> TAC 2 -> TAC 3 ).

The emergency manual (EMCYMN) contains trouble-shooting procedures for:– Restoring normal system operation– Safeguarding data (e.g. semipermanent inputs,

charges, indices, etc.)

The emergency manual (EMCYMN) is entered bymeans of cross-references from the maintenance man-uals (MMN) or via alarms.

Chapter Contents

Introduction The Introduction provides maintenance-specificinformation on the system components.

Procedures Procedures for step-by-step troubleshooting ofthe inactive unit (modules are replaced and notrepaired).

Tables The tables contain fault lists, allocation lists andreferences to construction sections.

Chapter Contents

Introduction The Introduction provides information on thesystem components as well as information specificto nonstandard maintenance.

FaultDescriptions

The Fault Description explains the results of thediagnosis and the system outputs.

Replace-mentInstructions

The Replacement Instructions contain informationon replacing frames, modules and cables.

8

Construction Manual : The Construction Manual out-lines and explains all the constructional parts of theEWSD product. Other documents refer to this manualwhenever an explanation of the construction is re-quired.

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 net-work node is divided into two manuals:• Task manual (TML)• Output manual (OML)

The system outputs pertaining to the commands areshown in a cross-reference list.

Task Manual (TML): The Task Manual (TML) is a ref-erence document which contains all tasks needed tooperate the system including those tasks intended onlyfor system specialists with special authorization.

Technological advances have led to changes in theway the switch is addressed. There are new interfacesvia which communication with the switch is possible. Asa result some tasks communicate with the switch viatraditional commands, others via a slightly different in-put format When entering parameter values, therefore,it is important to write them as they are shown in themanuals (lowercase or uppercase). For the sake ofcontinuity all of these elements will be called tasks in fu-ture and will be described in this document. As in thepast, the reader accesses the required information fromthe TML Table of Contents, or if task access is madefrom one of the manuals, through links in those docu-ments

Care has been taken to make input format representa-tion as accurate as possible. There are however differ-ences which the user must be aware of. For example,the output masks for traditional commands are de-scribed in an independent document (OML). However,if further clarification is required, the outputs of the newtask formats are described in the relevant task itself.Another example is that the length of the input param-eters is not limited to 8 characters in the new tasks: in-stead, the parameter names may be up to 20characters long.

The structure of the Task Manual (TML) is as follows:• Overview and Index of issues

The TML overview makes up the administrationsection. The overview contains all tasks in tabularorder. All entries contain an issue report and, if nec-essary, a change designation.The overview also contains a list of the other TMLsections, for example Introduction. It contains linkswhich allow the user to jump to the information inthe other TML section.

• IntroductionThe Introduction contains specific instructions forusing the TML including the differences relevant tooperation between traditional commands (MMLtasks) and the newer tasks. Where the informationis valid for all tasks, it appears only once. Wherethere are differences it is clearly stated for whichtype of task the information is intended.

• Task descriptionsThe task descriptions are the main part of the TMLand reflect the set of tasks relevant to a specificAPS. Task descriptions include information aboutthe 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 param-

eter information, and, where applicable,subparameter and parameter value information

Input syntaxThis section provides an overview of the input for-mat for tasks and the syntax. The syntax is dis-played in Backus-Naur Notation:Input format

The syntax diagrams contain links which allow di-rect access to the individual parameter descrip-tions.

Graphic display ofparameters

Comment

DEMO= Mandatory parameter

[,DEMO=] Optional parameter

{,DEMO1=|, DEMO2=} Entering exactly one parameter ismandatory

[{,DEMO1=|, DEMO2= }] Entering exactly one parameter isoptional

[DEMO1=,DEMO2=] Entering all parameters or noneenteredPossible combinations:All parameters are entered

[DEMO1=[DEMO2=]] Possible combinations:All parameters are enteredEnter only DEMO1Enter both parameters (DEMO2 maynot be entered alone)

<,DEMO1=,DEMO2=,DEMO3=>

At least one parameter must beentered.

9

MML task-specific remarksMML tasks which can be used for different purpos-es are split into different input formats (paths). Thisapplies particularly in cases where the above men-tioned syntax is not able to represent all the depen-dencies among parameters, parameters andparameter values, or among parameter values. Anoverview of the input formats is given at the begin-ning of each command description.Example: The MML task has the following paths:

The paths also contain links which allow direct ac-cess to the individual input descriptions.Input parametersThe description of the input parameters explainsthe syntax of the individual parameters. In the sim-plest cases, parameters are described by the pa-rameter short and long name and the parametervalue range. The parameter value range may be arange of decimal numbers, for example, or it may bedefined by a specific character set as shown below:

Text strings must be enclosed in quotation marks("), If a quotation mark has to included in a textstring, it must be doubled (""). The maximum lengthof a text string including the quotation marks is 72characters.Example:

In certain cases, however, mnemonic abbreviationsmay be entered for a parameter. These abbrevia-tions are also called identifiers. Identifiers haveshort and long names and may be supplementedby a helptext.Example:

Under certain circumstances a parameter mayhave up to four subparameters. Subparameters arealso called information units; they must be separat-ed by a hyphen. In the Task Manual, informationunits are symbolized by the lowercase letters a, b,c and d.Example:

The old and new parameters are also representedby lowercase letters.Example:

In this case, new and old have a very generalmeaning.Example:

Default valuesIf the syntax allows omission of a parameter or sub-parameter, the key word Default in the parameterhelptext describes how the system will respond.The following cases are possible:– Default value: <value>

<value> is a parameter value within the permis-sible range that is automatically used if the pa-rameter is omitted.

– Default behavior: <value>Values given are added to the default value. Thiscombination indicates that one can add othervalues to default values.

– Default behavior <text><text> describes the behavior of the system if theparameter is omitted. This option is selected if itis not possible to specify a default value.

Examples:• Optional parameter DATE

Default value: current date.The current date is used.

1. CR TEQ - ATCL ACCESS TEST CIRCUIT SUB LINE

2. CR TEQ - ATE AUTOMATIC TEST EQUIPMENT

3. CR TEQ - ATEMAN ATE FOR TESTING AND MEASUR-ING

4. CR TEQ - ATESELF ATE FOR SELFTEST

5. CR TEQ - TEMLE TEST MODULE LEVEL

6. CR TEQ - TESTSET TEST SET

7. CR TEQ - RBSI RING BACK SERVICE INTEGRATED

8. CR TEQ - TLFI TRANSLATION SERVICE INTEGRAT-ED

9. CR TEQ - ADDATE ADDITIONAL ATE PORT

Alphanumeric sym-bolic names:

A...Z 0...9. + * % #

Alphanumeric textstrings:

A...Z 0...9 . + * % # < ( & ! $ ) ; - / , _ > ? : @ '= <enter> <line feed>

PARDM1 PARAMETER DEMONSTRATION 1 =

5...8 characters from the symbolic name characterset

PARD2 PARAMETER DEMONSTRATION 2 =

IDF1 LONGNAME IDENTIFIER NO. 1

IDF2 LONGNAME IDENTIFIER NO. 2

PARD3 PARAMETER DEMONSTRATION 3 =a-b-c-d

a: FIRST INFORMATION UNIT= 0...7, range of decimal numbers

b: SECOND INFORMATION UNIT = etc.

DIGIT DIGITS =

The parameter specifies the prefix digits fortest multiple.

n/o

n/

/o

1...8 hexadecimal number where B isinterchangeable with * and C is inter-changeable with #

MOD TEQ: DIGITS= newvalue/oldval-ue

Changes the prefix val-ue newvalue/oldvalue

MOD TEQ: DIGITS= newvalue/ Enters new prefix digit

MOD TEQ: DIGITS= /oldvalue Deletes old prefix digit

10

• Optional selection parameter for DISP and STATcommandsDefault behavior: no restriction of output.Output is not restricted by omission of the parame-ter.

• Optional control parameter for CR, ENTR, CAN andMOD commandsDefault behavior: no effect on the database.The database is not modified.

• Optional control parameter for ACT, DACT, DIAGand TEST commandsDefault behavior: no effect on the process.The process is not affected by omission of the pa-rameter.

Output manual (OML) Like the TML, the output man-ual (OML) is also generated on a version- and project-specific basis and contains all command outputs appli-cable for the project in question.

The output manual (OML) describes the system out-puts of EWSD. The output masks are arranged in nu-merical order. For each mask, the output format isshown and the individual output parameters are ex-plained.

Table shows the structure of the OML:

The table part of the output manual contains a refer-ence list arranged according to:– Mask number,

leading to the mask variant, message group andcommand name.

– Message group,leading to the mask number, mask variant and com-mand name.

Version-specific and project-specific documentationVersion-specific documentation: The operation andmaintenance documentation provides a complete de-scription of the structure and the functions of EWSD.The contents of each document apply to a particularEWSD version, i.e. the documents supplied outline thecomplete range of services for that EWSD version.

Project-specific documentation: The scope of thedocumentation and the composition of the documentsthemselves can be adapted to meet the needs of a par-ticular operating company or a particular project. Thetype and the number of documents are determined bythe configuration of the individual project; the docu-ments are then put together in accordance with thecontract (volume, language, medium).

The operation and maintenance documentation sup-plied describes the hardware and the software of theproject. In principle, it also only describes the applica-tion and administration of those functions for which theoperating company has obtained authorization. How-ever, as the selection criteria are not clearly defined,the O&M documentation supplied may also possibly in-clude:– Functional sections for which the operating compa-

ny has not obtained authorization– Application and administration of functions not cre-

ated in the corresponding EWSD network node forexample, subscriber administration in transit net-work nodes.

The sections specified in the manuals as project-specif-ic or provider-specific are subject to separate agree-ments and contracts with Siemens and may only beused in the project in question.

The operating manuals and the maintenance manualsare version-specific and not project-specific.

Chapter Contents

Introduction(IN)

Structure of the command description, commandsyntax

Masks(MSK)

Description of the MML output masks(project-specific scope)

ReferenceLists (TAB)

Relationship between the output masks and thepossible commands

11

Presentation formsThe EWSD operation and maintenance documentationis created with an editor from the FrameMaker productrange. From this basis, it is then made available in thefollowing 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 applicationsand advantages.

SGML Documentation

SGML is a platform-independent markup languageused for structuring documents with respect to theircontents (ISO 8879 standard). The underlying docu-ment type definition (DTD) is CTD V1.0 in accordancewith the EFTI3 recommendation from 18 April 1997 inStockholm.

SGML is a clearly structured markup language which it-self contains no page layout definition. However, suit-able stylesheets can be used to specify a user-specificlayout for the documentation from all suppliers.

DynaText® is the browser preferred by Siemens for thepresentation of electronic documentation. DynaTextcomes standard with NetManager versions V3.2 andV4N.

With the NetManager, it is also possible to communi-cate interactively with EWSD. All commands preparedfor execution on the network node can be sent directlyfrom the corresponding SGML documents to the net-work node and then executed.

HTML Documentation

This is the format currently in use for the presentationof information in the World Wide Web (Intranet/Inter-net). The documentation in HTML is derived from theSGML format.

Using the product DynaWeb® (from the same productrange as DynaText), DynaText books can be convertedinto HTML ‘on the fly’ and displayed by Internet brows-ers. This technology can be used to set up an Intranet-based information system.

PDF Documentation

PDF is a platform-independent format. This format isderived from PostScript, and this explains why its lay-out is oriented towards hard-copy documentation. How-ever, with its hypertext and retrieval functions, it is alsosuitable for displaying documentation on screen.

The viewer required for on-screen display is the AdobeAcrobat Reader.

Hard-Copy Documentation

The PDF format is used for generating hard-copy doc-umentation.

Electronic documentationThe NetManager is the platform for user software foroperation and maintenance of the EWSD networknode.

Depending on the demand, and in accordance with thegrowing operational requirements, the NetManagercan be configured in the following ways:– in stand-alone configuration

consisting of one NetManager client– in work group configuration

consisting of several NetManager clients– in client-server configuration

consisting of communication server, NetManagerclient, file server

The main functions provided by the NetManager are asfollows:– graphical OA&M applications– local/remote and centralized operation and mainte-

nance– automation of the administrative tasks by means of

scenarios

The operating documentation is available in electronicform on the NetManager. The manual data is storedseparately from the applications. As a result, the man-ual data can be updated independently of the applica-tions, or new versions of the operating documentationcan be installed.

At present, the operating documentation is made avail-able electronically in Dynatext format on the NetMan-ager client with the Interactive Document Browserapplication. The user can thereby navigate within theoperating documentation and obtain the required infor-mation.

In the event of an error, the “Alarm Surveillance” appli-cation will directly start the viewer and jump to the cor-responding maintenance procedure with which the usercan perform the necessary troubleshooting. Mean-while, the Interactive Document Browser also starts the“Workbench” function of the NetManager. The “Work-bench” function makes it possible to communicate in-teractively with EWSD. All commands prepared forexecution on the network node can thereby be sent di-rectly to the network node.

12

Navigation

Each of the product descriptions and manuals is an in-dependent and self-contained document. As a rule, theindividual information units are not duplicated, i.e. theyoccur just once in the entire documentation. Therefore,whenever additional information is necessary, refer-ence is made to the information that is required to sup-plement the existing information.

In the electronic presentation forms of the documenta-tion, such cross-references are in the form of hyper-links.

Cross-referencing in feature descriptions: The fea-ture descriptions refer to the task list (TL) of the opera-tion manual describing the administration of this feature(in the case of subscriber features, a direct reference ismade to the corresponding procedure).

Cross-referencing in sub-system descriptions Tosupplement the information they contain, the sub-sys-tem descriptions refer to:– Other sub-system descriptions with a related sub-

ject matter– The construction manual for illustrating the con-

structional parts described

Cross-referencing in general system descriptions:The general system descriptions refer to:– The corresponding section in the operation manu-

als (OMN) dealing with the subject matter– Sub-system descriptions for detailed information– Feature descriptions

Operation

NetManagerTask list (TL)

Task summary list (TS)

Task complexes(TC)

Task procedures (TP)

Introduction

Commandinterface

Interactiveto node

Information

1st Feature

1.st nth Feature)

General systemdescriptions

Introduction toEWSD

documentation

Subscriber features

nth feature

nth nth feature

General section

1st. Thema

nnth. Thema

nth topic (example)

1st topic (example)

13

Cross-referencing in the OMN: The introductory sec-tion of an operation manual outlines certain administra-tive tasks as a example and refers to the backgroundinformation in descriptions.

The task list (TL) of the OMN is divided according totopics and forms the point of entry to the administrativetasks. 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 requir-ing maintenance result in an alarm with a defined faultoutput, including the fault number. The alarm output ofthe NetManager uses the fault number to call up the as-sociated troubleshooting procedure from the corre-sponding manual. The NetManager provides aninterface to the network node, thereby enabling theuser to send the commands contained in the proce-dures to the network node and have them executedthere.

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

NetManager

Information

MaintenanceMMN

Higher-rankingdocumentation

Sub-systemdescription

Constructionmanual

Interactivefrom node

AlarmSurveil-

lance

Interactiveto node

Commandinterface

Introduction

Task list(optional)

Tables

Fault tables

Constructionpart

Procedures

NetManager

Nonstandardmaintenance

NM

Copyright (C) Siemens AG 2002

Issued by Information and Communications Group • Hofmannstraße 51 • D-81359 München

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