Nokia Siemens Networks GSM/EDGE BSS, rel. RG10(BSS), operating documentation, issue 06

Reading MML Command Descriptions

DN9774175

Issue 9-1

2 DN9774175Issue 9-1

Reading MML Command Descriptions

Id:0900d8058040ef69

The information in this document is subject to change without notice and describes only the product defined in the introduction of this documentation. This documentation is intended for the use of Nokia Siemens Networks customers only for the purposes of the agreement under which the document is submitted, and no part of it may be used, reproduced, modified or transmitted in any form or means without the prior written permission of Nokia Siemens Networks. The documentation has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes customer comments as part of the process of continuous development and improvement of the documentation.

The information or statements given in this documentation concerning the suitability, capacity, or performance of the mentioned hardware or software products are given "as is" and all liability arising in connection with such hardware or software products shall be defined conclusively and finally in a separate agreement between Nokia Siemens Networks and the customer. However, Nokia Siemens Networks has made all reasonable efforts to ensure that the instructions contained in the document are adequate and free of material errors and omissions. Nokia Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues which may not be covered by the document.

Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NO EVENT WILL Nokia Siemens Networks BE LIABLE FOR ERRORS IN THIS DOCUMENTA-TION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDI-RECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA,THAT MAY ARISE FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT.

This documentation and the product it describes are considered protected by copyrights and other intellectual property rights according to the applicable laws.

The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark of Nokia Corporation. Siemens is a registered trademark of Siemens AG.

Other product names mentioned in this document may be trademarks of their respective owners, and they are mentioned for identification purposes only.

Copyright © Nokia Siemens Networks 2010. All rights reserved

f Important Notice on Product Safety Elevated voltages are inevitably present at specific points in this electrical equipment. Some of the parts may also have elevated operating temperatures.

Non-observance of these conditions and the safety instructions can result in personal injury or in property damage.

Therefore, only trained and qualified personnel may install and maintain the system.

The system complies with the standard EN 60950 / IEC 60950. All equipment connected has to comply with the applicable safety standards.

The same text in German:

Wichtiger Hinweis zur Produktsicherheit

In elektrischen Anlagen stehen zwangsläufig bestimmte Teile der Geräte unter Span-nung. Einige Teile können auch eine hohe Betriebstemperatur aufweisen.

Eine Nichtbeachtung dieser Situation und der Warnungshinweise kann zu Körperverlet-zungen und Sachschäden führen.

Deshalb wird vorausgesetzt, dass nur geschultes und qualifiziertes Personal die Anlagen installiert und wartet.

Das System entspricht den Anforderungen der EN 60950 / IEC 60950. Angeschlossene Geräte müssen die zutreffenden Sicherheitsbestimmungen erfüllen.

DN9774175Issue 9-1

3

Reading MML Command Descriptions

Id:0900d8058040ef69

Table of ContentsThis document has 10 pages.

Summary of changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1 MML command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.1 Selection of parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.2 Command syntax in modified EBNF notation . . . . . . . . . . . . . . . . . . . . . 61.3 Repetition of parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3.1 Code conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4 DN9774175Issue 9-1

Reading MML Command Descriptions

Id:0900d8058040ef69

DN9774175Issue 9-1

5

Reading MML Command Descriptions Summary of changes

Id:0900d805802bfb30

Summary of changesChanges between document issues are cumulative. Therefore, the latest document issue contains all changes made to previous issues.

Changes made between issues 9–0 and 9–1Some introductory text removed from the beginning of the chapter MML Command Syntax. Chapters Structure of MML Commands and Syntactic Meaning of Punctuation Marks replaced with links to document Executing MML Commands, where the same information is presented with more details.

Changes made between issues 9–0 and 8–0Section Selection of parameters has been revised.

Changes made between issues 8–0 and 7–0The entire document has been revised throughout. This document now provides instruc-tions on how to read and interpret MML commands in command descriptions.

Changes made between issues 7–0 and 6–0Section Command syntax in modified EBNF notation has been added in chapter Entering of parameters.

Section Repetition of commands has been updated in chapter Entering of parameters.

6 DN9774175Issue 9-1

Reading MML Command Descriptions

Id:0900d80580323c6f

MML command syntax

1 MML command syntaxThese instructions tell you how to read and interpret MML commands in command descriptions. First, you should familiarise yourself with the elements of an MML command, the punctuation marks that are used to separate the elements. For detailed explanation of these areas, see instructions for Executing MML commands, particularly the Structure of MML commands.

1.1 Selection of parametersThe parameters of a command, closely associated with one another, form a parameter block. The parameter blocks are separated by colons. The parameters used in a command can be either name-defined or position-defined. One parameter block can contain parameters of one type only.

A position-defined parameter is identified according to its consecutive number. The position-defined parameters must thus be given in a specific order.

A name-defined parameter is identified according to its name. Therefore, the order of giving these parameters is free. The name of a name-defined parameter is presented in capital letters.

1.2 Command syntax in modified EBNF notationThe command syntax can be presented in a notation based on an Extended Backus-Naur Format (EBNF) type of a notation, that is, a modified EBNF notation. The charac-ters used are as follows:

Brackets ( ) OBLIGATORY SELECTION

Select one.

Square brackets [] OPTIONAL SELECTION

Skip selection or select one.

Brackets and dots ( ) ... OBLIGATORY REPEATED SELECTION

Select one or several alternatives.

Square brackets and dots [] ... OPTIONAL REPEATED SELECTION

Skip selection or select one or several alternatives.

Vertical bar | ALTERNATIVE SELECTION

Separates alternative parameters or parameter values.

Dots ... REPEATED SELECTION

Repeat selection from the previous group. Usage of grouping chracters (&, &&, &-, &&-) is allowed with the parameter that precedes the dot.

Brackets and vertical bar are always used to indicate a selection between two or more parameters. Brackets are also used to indicate that parameter selection can be skipped.

Examples of name-defined parameters in EBNFABC:A=<name>; Obligatory. Give value for parameter name.

ABC:A=<name>...; Obligatory. Give value for parameter name. Grouping characters are allowed.

DN9774175Issue 9-1

7

Reading MML Command Descriptions MML command syntax

Id:0900d80580323c6f

ABC:[A=<name> | <current> def]; Give value for parameter name or else the default value current is valid.

ABC:[A=<name>... | <current> def]; Give value for parameter name or else the default value current is valid. Grouping characters are allowed.

ABC(A=<name> | B=<number>); Obligatory selection. Give either name or number.

The alternative parameters can also be written on different lines. This is recommended if the names are long or in case there are several param-eters.

ABC(A=<name> | B=<number>)...; Optional, repeated selection. Give either name or number or both.

ABC:[[A=<name> | B=<number>] | <current> def]; Optional selection. Give either name or number or skip the selection. In case the selection is skipped, the default value current is valid.

The alternative parameters can also be written on different lines. This is recommended if the names are long or in case there are several param-eters.

ABC:[[A=<name>]... | <current> def]; Optional, repeated selection. Give either name or number, or both, or skip the selection. If the parameter is not given, the default value current is valid for the whole parameter block.

ABC:[A=<name> | <current> def] | [B=<number>|<current> def]; Optional selection. Give either name or number or skip the selection. If the parameter is not given, the default value current is valid.

ABC:[[A=<name> | <current> def] | [B=<number>|<current> def]]...; Optional, repeated selection. Give either name or number or skip the selection. If the parameter is not given, the default value current is valid.

ABC:A=(SW|TR|GN); Obligatory selection between the parameter values.

Examples of position-defined parameters in EBNFABC:<value1>; Obligatory. Give value for parameter value1.

ABC:<value1>...; Obligatory. Give value for parameter value1. Grouping characters are allowed.

ABC:[<value1> | <current> def]; Give value for parameter value1 or else the default value current is used.

ABC:[<value1>... | <current> def]; Give value for parameter value1 or else the default value current is used. Grouping characters are allowed.

ABC:(<value1> | <value2>); Obligatory selection. Give value for either parameter value1 or value2.

ABC:(<value1> | <value2>)...; Obligatory, repeated selection. Give value for either parameter value1 or value2 or both.

ABC:[[<value1> | <value2>] | <current> def]; Optional selection. Give value for either value1 or value2 or skip the selection. In case the selection is skipped, the default value current is valid for the whole parameter block.

ABC:[[<value1> | <value2>]... | <current> def]; Optional, repeated selection. Give value for either value1 or value2, or both, or skip the selection. In case the selection is skipped, the default value current is valid for the whole parameter block.

8 DN9774175Issue 9-1

Reading MML Command Descriptions

Id:0900d80580323c6f

MML command syntax

ABC:[<value1> | <current> def] | [<value2> | <current> def]; Optional selection. Give value for either value1 or value2 or skip the selection. If the parameter is not given, the default value current is valid.

Examples of marking commercial options in EBNFABC:[<parameter1> | <parameter2> | <parameter3> <option>]; Parameter3 is

optional.

ABC:<parameter1>: [<parameter2> | <parameter3>] <option>]; The whole second parameter block (parameter2 and parameter3) is optional.

1.3 Repetition of parametersThe parameters can be roughly divided into two classes: single parameters and combi-nation parameters. The combination parameters are, for example, of the form A-B-C, in which A, B, and C are values given for the parameter.

When giving a command, '&' means repetition and '&&' repetition with automatic incre-mentation. A hyphen (-) added to the characters above (used only with combination parameters) means that the '&' or '&&' operation concerns the last element of the parameter only.

In other words, repetition of parameters is possible without automatic incrementation by using

• the character '&' for single parameters, and • the character pair '&-' for combination parameters. If, in a combination parameter,

only the value of the last element is changed, that alone needs to be given after this character pair. The values or the other elements except the last one will then be repeated as such. If their values are to be changed, too, then '&' is written, and after that the new values of the parameter.

Repetition of parameters with automatic incrementation is possible by using

• the character combination '&&' to mean that the value of the parameter is incre-mented by one, beginning from the value preceding the characters and ending in the value following the characters, including both those values.

• the character combination '&&-' to mean that the value of the combination param-eter is incremented beginning from the value preceding the character combination. If only the values of the last element are given, the characters preceding that are repeated as such. The first part can be changed by typing '&' and the new values of all the elements of the parameter.

Example: Single parameters5 & 7 & 9 && 11 & 15 corresponds to 5, 7, 9, 10, 11, 15

Example: Combination parameters of the form A-B-C3-5-7 &- 10 &- 15 &&- 20 &- 30 corresponds to

3-5-7, 3-5-10, 3-5-15, 3-5-16, 3-5-17, 3-5-18, 3-5-19, 3-5-20, 3-5-30

Example: Change of the first part in the middle of the combination parameter string3-5-6 & 4-5-7 &- 8 &- 10 &&- 12 corresponds to

3-5-6, 4-5-7, 4-5-8, 4-5-10, 4-5-11, 4-5-12

DN9774175Issue 9-1

9

Reading MML Command Descriptions MML command syntax

Id:0900d80580323c6f

1.3.1 Code conversionAlthough the guidances indicate the code of the numerical parameters to be given (dec-imal, hexadecimal, binary), the parameters can be given in another code. In such a case, the syntax analyser is told in which code the given parameter is by using the cor-responding prefix D', H', or B'.

10 DN9774175Issue 9-1

Reading MML Command Descriptions

Id:0900d8058033612b

Glossary

Glossary

ConceptsMML command MML commands are used to operate the system. They are given by using the MML

command language (Man-Machine Language as defined by ITU-T, Recommendations Z.301-Z.341). The commands execute MML programs.

Name-definedparameter

A parameter which is identified by its name. Name-defined parameters can be given in arbitrary order within a parameter block.

Parameter block A set of parameters containing information necessary for the system to perform the function specified in the command.

Position-definedparameter

A parameter which consists of a parameter value. Position-defined parameters must be entered in a predetermined order within a parameter block.