21
MML User Interface DN0946529 Issue 2-0 Confidential Nokia Siemens Networks is continually striving to reduce the adverse environmental effects of its products and services. We would like to encourage you as our customers and users to join us in working towards a cleaner, safer environment. Please recycle product packaging and follow the recommendations for power use and proper disposal of our products and their compo- nents. If you should have questions regarding our Environmental Policy or any of the environmental services we offer, please contact us at Nokia Siemens Networks for any additional information.

MML User Interface

Embed Size (px)

DESCRIPTION

MML User Interface

Citation preview

Page 1: MML User Interface

MML User Interface

DN0946529

Issue 2-0

Confidential

Nokia Siemens Networks is continually striving to reduce the adverse environmental effects of its products and services. We would like to encourage you as our customers and users to join us in working towards a cleaner, safer environment. Please recycle product packaging and follow the recommendations for power use and proper disposal of our products and their compo-nents.

If you should have questions regarding our Environmental Policy or any of the environmental services we offer, please contact us at Nokia Siemens Networks for any additional information.

Page 2: MML User Interface

2 DN0946529

MML User Interface

Id:0900d8058088f100Confidential

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 2012. All rights reserved

f Important Notice on Product SafetyThis product may present safety risks due to laser, electricity, heat, and other sources of danger.

Only trained and qualified personnel may install, operate, maintain or otherwise handle this product and only after having carefully read the safety information applicable to this product.

The safety information is provided in the Safety Information section in the “Legal, Safety and Environmental Information” part of this document or documentation set.

The same text in German:

f Wichtiger Hinweis zur Produktsicherheit Von diesem Produkt können Gefahren durch Laser, Elektrizität, Hitzeentwicklung oder andere Gefahrenquellen ausgehen.

Installation, Betrieb, Wartung und sonstige Handhabung des Produktes darf nur durch geschultes und qualifiziertes Personal unter Beachtung der anwendbaren Sicherheits-anforderungen erfolgen.

Die Sicherheitsanforderungen finden Sie unter „Sicherheitshinweise“ im Teil „Legal, Safety and Environmental Information“ dieses Dokuments oder dieses Dokumentations-satzes.

Page 3: MML User Interface

DN0946529 3

MML User Interface

Id:0900d8058088f100Confidential

Table of contentsThis document has 21 pages.

Summary of changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1 MML command execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.1 Prerequisites for executing MML commands. . . . . . . . . . . . . . . . . . . . . . 81.2 MML command syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3 MML session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.4 Online help during an MML session. . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.5 Line editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.5.1 Keys for searching and editing MML commands . . . . . . . . . . . . . . . . . . 141.5.2 Keys for controlling the character output on the MML terminal . . . . . . . 151.5.3 Keys for printing out characters displayed on the MML terminal . . . . . . 161.6 Screen editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.6.1 Characters for reading and editing on screen . . . . . . . . . . . . . . . . . . . . 161.7 Editor functions for text files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.8 Special characters in MML commands . . . . . . . . . . . . . . . . . . . . . . . . . 181.8.1 Character for grouping parameter arguments: ampersand (&) . . . . . . . 181.8.2 Wild card character: percent sign (%) . . . . . . . . . . . . . . . . . . . . . . . . . . 191.9 System output during an MML session . . . . . . . . . . . . . . . . . . . . . . . . . 201.9.1 Execution printouts during an MML session . . . . . . . . . . . . . . . . . . . . . 201.9.2 Messages of the system during an MML session . . . . . . . . . . . . . . . . . 20

Administrator
Text Box
MML命令执行
Administrator
Text Box
执行MML命令的先决条件
Administrator
Text Box
MML命令语法
Administrator
Text Box
MML会话
Administrator
Text Box
MML会话中在线帮助
Administrator
Text Box
行编辑器
Administrator
Text Box
屏幕编辑器
Administrator
Text Box
编辑器文本文件编辑功能
Administrator
Text Box
MML命令中特殊字符
Administrator
Text Box
MML会话系统输出
Page 4: MML User Interface

4 DN0946529

MML User Interface

Id:0900d8058088f100Confidential

List of figuresFigure 1 Example of a command menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Figure 2 Key combination help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Figure 3 Key map of line editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Figure 4 Arrow keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Page 5: MML User Interface

DN0946529 5

MML User Interface

Id:0900d8058088f100Confidential

List of tablesTable 1 MMI system hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Page 6: MML User Interface

6 DN0946529

MML User Interface

Id:0900d8058088f100Confidential

Page 7: MML User Interface

DN0946529 7

MML User Interface Summary of changes

Id:0900d8058088e5deConfidential

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

Changes made between issues 2-0 and 1-0The printout text in section Execution printouts during an MML session has been updated. New printout text now includes IP address information.

Page 8: MML User Interface

8 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

1 MML command executionThe MML interface allows you to execute

• individual MML commands. • MML macros. • MML command files. • command calendar tasks.

Macros are often used to execute complicated command sequences repeatedly, and command files to execute routine tasks which do not require supervision. By means of a command calendar, individual MML commands or command sequences can be executed at a certain time.

The MMI system has an online help with command menus and a parameter guide. When typing in a command, you can edit it in a line editor.

Information about MML sessions is stored to MML command logs.

1.1 Prerequisites for executing MML commandsTo be able to open an MML session, you need a user ID and password. Different user’s rights to execute commands in a session are dictated by the authority level defined in the user profile. The authority level always applies to an entire command class.

Authority levels are defined also for the MML terminals. If the user’s authority level is dif-ferent from the terminal’s, the MMI system automatically restricts the execution rights according to the lower level.

For a description of different types of users, and instructions for creating user profiles and command calendar tasks, see SECURITY AND USER MANAGEMENT.

1.2 MML command syntaxAn MML command consists of three letters: The first letter indicates the command class, the first and second together form a command group, and the third one indicates the command.

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

Table 1 MMI system hierarchy

IGO

command class

IGO

command group

Administrator
Text Box
单个MML命令
Administrator
Text Box
MML宏
Administrator
Text Box
MML命令文件
Administrator
Text Box
命令日程任务
Administrator
Rectangle
Administrator
Rectangle
Administrator
Line
Administrator
Line
Administrator
Rectangle
Administrator
Rectangle
Administrator
Text Box
命令等级
Administrator
Text Box
命令组
Administrator
Text Box
扩展的巴科斯 -诺尔范式
Administrator
Text Box
括号:必选
Administrator
Text Box
方括号:可选
Page 9: MML User Interface

DN0946529 9

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

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.

Punctuation marksCertain elements of an MML command must be separated from one another by punctu-ation marks (separators) and the command must be completed by a semicolon. The fol-lowing punctuation marks can be used:

SPACE Space has no syntactic significance. It is often used in the examples to clarify the structure, but it can be omitted when giving a command.

COMMA Use a comma

• to separate parameters from one another when typing them in, • to give the default value to position-defined parameters. Writing

commas one after another corresponds to giving the default value to the parameter between the commas. If the number of commas given exceeds the number of parameters, the syntax analyser gives an error message.

• to give the default value to name-defined parameters (see definition under 'Selection of parameters'). Typing a comma after an 'equals' sign (=) gives the named parameter its default value.

• you press ENTER after typing the parameter. In this case, the syntax analyser adds the comma itself.

Comma is not needed if

• you press ENTER after typing the parameter. In this case, the syntax analyzer adds the comma there.

COLON Use a colon

• after a command code, before typing the parameters, and • as a delimiter of parameter blocks. • a parameter block and the command are ended simultaneously with

a semicolonor

Colon is not needed if

• you have typed the last parameter of a parameter block containing position-defined parameters and pressed ENTER. In this case, the

Administrator
Text Box
括号及点号:重复必选项
Administrator
Text Box
方括号及点号:重复可选项
Administrator
Text Box
竖线:二选一
Administrator
Text Box
点号:重复选择
Administrator
Text Box
标点符号
Administrator
Text Box
分号
Administrator
Text Box
空格
Administrator
Text Box
逗号
Administrator
Text Box
冒号
Page 10: MML User Interface

10 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

syntax analyser knows that the parameter block ends, and adds the colon.

You can use a colon

• in a parameter block, the rest of the parameters have the default value. In this case, the syntax analyser moves to the next parameter block, accepting the colon into the character string.

SEMICOLON Use a semicolon to end a command. You can give a semicolon if

• all the command parameters not yet given have the default value, or • the command has no parameters.

Semicolon can be given

• if you want to define the output device with a separate parameter block added to the command by the syntax analyser. This parame-ter block is not shown in the command descriptions, or

• if you want to stop entering the command in the phase where the parameters have been checked.

Unlike with commas or colons, the syntax analyser itself never adds a semicolon to a command.

QUESTION MARK Question marks display the guidance referring to the current command entering phase. The guidance can be a menu or some parameter guidance.

1.3 MML sessionThe MML terminal can be a local or a virtual terminal. The local terminal is connected to the exchange via a RS232C connection. The virtual terminal is connected via a VT con-nection, either Telnet, ISO-VT or PAD.

Both types of terminals can be used for local and remote sessions alike. In a local session, the user is directly connected to the system. Remote sessions are set via the proprietary operation and maintenance network.

You can change destinations during an MML session. You do not, however, always have to open a remote session to execute an MML command in another system: the IDX command allows you to execute a remote command in one or several systems from a local system.

MML session idle timeYou can define that an MML session is closed automatically if there is no interaction or command execution during a certain period of time.

To improve information security, the idle time can be defined for each user profile indi-vidually and it can be set so low that the session is ended almost immediately after user interaction stops. The drawback of very strict idle time limits is that they reduce the flex-ibility of operation.

MMI disclaimer display and confirmation questionWhen an MML session is opened, the system may first display an informative disclaimer text.

The system can also ask for confirmation before continuing to establish the MML session. If you reply Y (yes), establishing the session continues normally; otherwise the

Administrator
Text Box
分号
Administrator
Text Box
问号
Administrator
Text Box
MML会话停机时间
Page 11: MML User Interface

DN0946529 11

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

session is ended. The session is also ended, if you do not reply within the idle time limit. Note that your confirmation must always be given in the format Y (yes) or N (no), regard-less of the language of the question.

If the disclaimer text and confirmation question have been activated but the text files cannot be found in the system, the following text is output:

"DISCLAIMER TEXT/QUESTION FILE CANNOT BE FOUND."

The establishing of the MML session will continue normally thereafter.

The disclaimer text is displayed only once, even if your user ID and password are requested several times. The text is not displayed again if you change destinations during an MML session and establish a new session in another network element using Z and a colon (Z:).

1.4 Online help during an MML sessionThe online help provides you with command menus and a parameter guide. It helps you enter MML commands and guides you when you open or close an MML session or change destinations. During the various phases of the MML session, guidance messages are displayed.

Command menusCommand menus include menus of command classes, command groups and com-mands. Below is an example of a command class menu:

MAIN LEVEL? ..... DISPLAY MENUA ..... ALARM SYSTEM ADMINISTRATIONC ..... ROUTING STATE ADMINISTRATIOND ..... SYSTEM SUPPORT AND COMMUNICATIONG ..... CHARGING ADMINISTRATIONI ..... I/O SYSTEM ADMINISTRATIONN ..... SS7 NETWORK ADMINISTRATIONO ..... SUPPLEMENTARY SS7 NETWORK ADMINISTRATIONQ ..... O&M NETWORK ADMINISTRATIONR ..... ROUTING ADMINISTRATIONS ..... SUBSCRIBER ADMINISTRATIONT ..... TRAFFIC ADMINISTRATIONU ..... UNIT ADMINISTRATIONW ..... SYSTEM CONFIGURATION ADMINISTRATIONY ..... SYSTEM SUPERVISIONZ; .... END DIALOGUE/DESTINATION SELECTION (:)

Figure 1 Example of a command menu.

To display the command menu in the command level at which you are, enter a question mark (?).

Parameter guidesThe parameter guide gives information on entering parameters. For example, it indi-cates the parameters that can or must be entered. Below is an example of the parameter guide of the ICL command:

Administrator
Text Box
MML会话中在线帮助
Administrator
Text Box
命令菜单
Administrator
Text Box
参数指南
Page 12: MML User Interface

12 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

/* COMMAND CALENDAR LISTING PARAMETERS PARAMETER NAMES:

ID ....... TASK IDENTIFIER QUE ...... QUEUE NAME CFILE .... COMMAND FILE NAME ALARM .... EXECUTION ALARM NUMBER DATE ..... DATE OF EXECUTION HOURS .... TIME OF EXECUTION */

To display the parameter guide, press ENTER after you have typed the command letters or one or more parameters.

t When you use network elements that have different configurations, you may have to enter different values for the same parameter. This is because part of the information in the parameter guide normally depends on the configuration of the network element. This information includes, for example, the value range of the parameter and the relation between parameters.

Key combinationsYou can display a list of keys that can be used, for example, to edit MML commands and to control their output on the MML terminal by pressing CTRL-W.

LINE EDITOR COMMANDS:CTRL A = INSERT/REPLACECTRL B = EDIT PREV CMNDCTRL D = CURS LEFTCTRL E = CURS END OF LINECTRL F = CURS RIGHTCTRL G = CURS DOWNCTRL H = CURS HOMECTRL I = CURS UPCTRL K = CHANGE LANGUAGECTRL L = DEL CHARCTRL N = CURS BEGINNING OF PARAM BLOCKCTRL O = HARDCOPYCTRL P = PAGE MODE ON/OFFCTRL Q = CONT OUTPUTTINGCTRL S = PAUSE OUTPUTTINGCTRL T = OUTPUT RINGBUFFERCTRL U = EMPTY EDIT BUFFCTRL X = JUMP TO CMD GROUP LEVELCTRL Y = INTERRUPTCTRL Z = DEL CHARS IN EDIT BUFFBREAK = END OF DIALOGCTRL 4 = MML TEST MODE ON/OFFCTRL 7 = DX ERROR DESCRIPTION

Figure 2 Key combination help

Administrator
Text Box
组合键
Administrator
Rectangle
Administrator
Rectangle
Page 13: MML User Interface

DN0946529 13

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

1.5 Line editorThe line editor lets you search and edit the commands you have entered during the current MML session, and edit the command you are typing. If you have entered exactly the same command more than once, you can only handle the last instance of that command.

The editor is operated from the keyboard of the MML terminal. You do not have to start the editor: it is available when you are typing MML commands.

Figure 3 Key map of line editor

BREAK CTRL K

CTRL + Y CTRL L

CTRL + V OR DEL CTRL N

CTRL + A INSERT/REPLACE CTRL P PAGE/CONTINUOUS MODE

CTRL + B CTRL Q CONTINUATION OF OUTPUT

CTRL + D CTRL S STOPPING OUTPUT

CTRL + E CTRL T OUTPUT TO PRINTER

CTRL + F CTRL U

CTRL + G CTRL X

CTRL + H CTRL O

CTRL + I CTRL Z

CTRL + 7 CTRL 4

CTRL + R CTRL + W HELP-TEXT

INTERRUPTION OF MMLSESSION

INTERRUPTION OF MMLCOMMAND EXECUTION

DELETIONOF PREVIOUSCHARACTER

SEARCH OF PREVIOUSCOMMAND FOR EDITING

MOVING CURSORTO THE LEFT

MOVING CURSOR TOTHE END OF BUFFER

MOVING CURSORTO THE RIGHT

MOVING CURSOR TOTHE NEXT LINE

MOVING CURSOR TO THEBEGINNING OF BUFFER

MOVING CURSOR TOPREVIOUS LINE

OUTPUT OF ERRORMESSAGE

CURSOR TO THEBEGINNING OF THENEXT PARAMETER

KEY FOR CHANGINGLANGUAGE

DELETION OF THE CHA-RACTER UNDER THE CURSOR

CURSOR TO THE BEGINNINGOF THE NEXT PARAMETERBLOCK

EMPTYING LINEBUFFER AND DISPLAY

INTERRUPTION OFCOMMAND INPUT

20 LINES OF LATESTOUTPUT TO PRINTER

DELETION OF CHA-RACTERS AFTER THE LINEBUFFER CURSOR

SETTING MML PROGRAMTO TEST STATE

+

+

+

+

+

+

+

+

+

+

+

+

Administrator
Text Box
行编辑器
Administrator
Rectangle
Page 14: MML User Interface

14 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

Figure 4 Arrow keys

1.5.1 Keys for searching and editing MML commands

Arrow keys'Up' arrow Displays the command you entered before the one that is written after

the prompt. If you have entered exactly the same command more than once, only the one you last entered can be displayed.

OR

Searches a command you have entered during an MML session. Type the number identifying the command and press the 'up' arrow (for example, press 4 and the arrow). This command must be entered immediately after the prompt. You can list the numbers by pressing ? and the 'up' arrow

OR

Searches a command you have entered during an MML session. Type a character string included in the command and press the 'up' arrow (for example, press ICL and the arrow). If you press the arrow again, the previous command with the same string is searched.

'Down' arrow Displays the command entered after the one written after the prompt.

? + 'up' arrow Lists the commands you have entered during an MML session and the numbers identifying them. The numbering starts from the command you entered last. If you have entered exactly the same command more than once, only the one last entered is displayed.

:

Keys that function like ‘up’ and ‘down’ arrowsCTRL-B Functions like the 'up' arrow.

CTRL-G Functions like the 'down' arrow.

CTRL-I Functions like the 'up' arrow.

? +

MOVING CURSORTO THE RIGHT

rightarrow

uparrow

uparrow

CHAR-ACTER +STRING

uparrow

DISPLAY THE COMMANDENTERED BEFORE THE ONEWRITTEN AFTER THE PROMPT

LIST COMMANDS ENTERED NUMBER +DURING MML SESSION ANDNUMBERS IDENTIFYING THEM

SEARCH A COMMAND ENTEREDDURING MML SESSIONACCORDING TO CHAR. STRING

leftarrow

downarrow

uparrow

MOVING CURSORTO THE LEFT

DISPLAY THE COMMANDENTERED AFTER THE ONEWRITTEN AFTER THE PROMPTCOMMAND

SEARCH A COMMANDENTERED DURING MMLSESSION ACCORDING TOCOMMAND NUMBER

Administrator
Rectangle
Administrator
Text Box
搜索及编辑MML命令按键
Administrator
Text Box
方向键
Page 15: MML User Interface

DN0946529 15

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

1.5.2 Keys for controlling the character output on the MML terminal

Keys for editing commandsSwitch from INSERT to OVERSTRIKE mode:

CTRL-A Switches from the INSERT mode to the OVERSTRIKE mode or vice versa. In the OVERSTRIKE mode, the character you type replaces the character that the cursor points to. In the INSERT mode, the character you type in is inserted in front of the character the cursor points to.

Move to command group level:

CTRL-X Moves to the command group of the command that you are entering or that you have just entered. If you are entering a command, this key func-tions only if you have entered at least the three command letters of the command.

Move the cursor (arrow keys):

Right arrow Moves to the right.

Left arrow Moves to the left.

Move the cursor (keys that function like 'right' and 'left' arrows):

CTRL-D Moves cursor to the left.

CTRL-F Moves cursor to the right.

Move the cursor (other keys):

CTRL-E Moves cursor to the end of the line.

CTRL-H Moves cursor to the beginning of the line.

CTRL-N Moves cursor to the beginning of the next parameter block.

CTRL-R Moves cursor to the beginning of the next parameter.

Delete characters:

BACKSPACE Deletes the character to the left of the cursor.

CTRL-L Deletes the character the cursor points to.

CTRL-U Deletes all characters in the buffer that stores the commands given during an MML session.

CTRL-V Deletes the character to the left of the cursor. Functions like BACK-SPACE.

CTRL-Z Deletes the character that the cursor points to and those written after the cursor.

Use the following keys to control the output of characters on the MML terminal you are using:

CTRL-P Determines whether characters are displayed on the screen one screen at a time (PAGE MODE) or without interruptions (CONTINUOUS

Administrator
Text Box
MML终端控制字符输出按键
Administrator
Text Box
编辑命令按键
Page 16: MML User Interface

16 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

MODE). To display one screen of characters at a time, press CTRL-P before you enter the command that displays characters. After one screen is displayed, press ENTER to display another screen. To display characters without interruptions, press CTRL-P again: you can switch from the PAGE mode to the CONTINUOUS mode before you enter the command that displays characters and even when characters are being displayed on the screen.

CTRL-Q Continue the output if you have interrupted it by pressing CTRL-S.

CTRL-S Interrupts output. The output continues when you press CTRL-Q.

1.5.3 Keys for printing out characters displayed on the MML terminalUse the following keys to print out the characters displayed on the MML terminal you are using during an MML session:

CTRL-T Prints a maximum of 2048 characters (for example, MML commands, execution printouts and guidance messages) that were displayed during the MML session on a printer. If the printing succeeds, the message PRINTED is displayed. If it does not succeed, the message PRINTER ERROR is displayed. Note that if the printouts are directed to the MML terminal you are using, the characters are not printed; instead, the following message appears on the screen:

/*** HARDCOPY DEVICE RESERVED FOR CURRENT MML SESSION CHANGE CONNECTED DEVICE AND TRY AGAIN ***/

CTRL-O Functions like CTRL-T, but instead of 2048 characters, this key prints the screen of characters displayed during the MML session on a printer.

1.6 Screen editorThe screen editor functions are used for reading characters and for editing characters which are on the screen. The text can be edited using the special and command char-acters.

The screen editor is available with some MML commands.

1.6.1 Characters for reading and editing on screen

Quitting the screen editorYou can quit the screen editor by typing the ̂ character. The screen is emptied, and the cursor moves to the beginning of the first line on the screen. The ^ character also termi-nates the execution of the IEE command.

Special charactersCTRL-Y Terminates command execution.

DEL (CTRL-V) Deletes the character to the left of the cursor.

Command charactersCTRL-A Switches the editor from the INSERT mode to the OVERSTRIKE mode,

or vice versa. In the OVERSTRIKE mode, the new characters you type are placed on top of the old characters, replacing them. In the INSERT

Page 17: MML User Interface

DN0946529 17

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

mode, the old characters are moved forward making room for the new ones, if there is room at the end of the line.

CTRL-D Moves the cursor one character to the left. If the cursor is already in the beginning of the line, it is not moved to the next line.

CTRL-E Moves the cursor to the end of the line, or onto the last character if the line, buffer or line buffer ends.

CTRL-F Functions like the 'left' arrow. Moves the cursor one character to the right. Does not move the cursor to the next line but stops at the last char-acter of the line.

CTRL-H Moves the cursor to the top left hand corner of the screen.

CTRL-I Functions like the 'up' arrow. Moves the cursor one line up.

CTRL-J Refreshes the screen.

CTRL-K Functions like the 'down' arrow. Moves the cursor one line down.

CTRL-L Deletes the character the cursor points to.

CTRL-O Displays the previous screen and moves the cursor to its first line.

CTRL-P Displays the next screen and moves the cursor to its first line.

CTRL-R Functions like CTRL-H. Moves the cursor to the top left hand corner of the screen. If the cursor is already in the beginning of the buffer, it is moved to the beginning of the file's first line.

CTRL-R + CTRL-R Moves the cursor to the top left hand corner of the file.

CTRL-W Moves the cursor to the bottom left hand corner of the screen. If the cursor is already in the beginning of the last line, it is moved to the end of the file, that is, to the beginning of the file's last line.

CTRL-W + CTRL-W Moves the cursor to the bottom left hand corner of the file.

CTRL-X Deletes the line the cursor point to.

CTRL-Z Functions like CTRL-C. Terminates command execution and exits the editor.

1.7 Editor functions for text filesText files can be edited in the ways introduced below. The structure of text files is also explained briefly.

Special text files used in the system are command files and MML macros. Command files are run with the IDE command or as a task of the command calendar.

Structure of text filesIn general, the structure of text files is free. However, special attention should be paid to the command file, since its structure is strictly defined.

The command file must always start with a comment line. The comment is traditionally marked with the /* */ character pair. The group of tasks performed by the command file should be described on the comment line.

After the comment line, the commands have been listed on separate lines in the command file. The commands are in the order of execution. Each line is ended with the semicolon, which also ends an MML command.

Page 18: MML User Interface

18 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

The extension part of the command file must be CMD. Otherwise, the command file run will not succeed with the IDE command. The command calendar also assumes the extension part of the file to be CMD.

Editing text files with MML commandsEditing and creating text files takes place with the IEE command.

The IEE command initiates a screen editor where the command and special characters described above are in use. The file to be edited has some restrictions on the name and directory, and these are explained in the command description.

1.8 Special characters in MML commands

1.8.1 Character for grouping parameter arguments: ampersand (&)The ampersand (&) and character combinations &-, && and &&- are used to group parameter arguments, which contain information specifying the parameter value.

For example, in the following command, this value indicates that the ICL command lists the command calendar tasks to be executed on 2002–10–01 at 1:00 and 3:00:

ZICL:DATE=2002–10–01,HOURS=1&3;

The ampersand (&) can be used to group all types of parameter arguments. However, the use of character combinations &&, &- and &&- is determined by the type of the parameter.

There are two types of parameters: single parameters and combination parameters. The arguments of single parameters consist of one information unit, like in the following example:

When more than one arguments of single parameters must be grouped, characters & and && can be used. For example:

1&3 1 and 3

3&&5 3, 4, and 5

1&3&&6 1, 3, 4, 5, and 6

The arguments of combination parameters consist of several information units, which are separated from one another by a hyphen (-). Combination parameters are of the

parameter value

1&3

argument argument

Page 19: MML User Interface

DN0946529 19

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

form 1–2–3, in which 1–2–3 is a parameter argument and 1, 2 and 3 are information units, like in the following example:

When more than one argument of a combination parameter needs to be given, charac-ters &, &- and &&- are used.

& Groups two combination parameter arguments within the same param-eter value.

&- Groups combination parameter arguments when a group of parameters differs only in their last information unit. The first argument is completely specified, whereas the others are represented only by their last informa-tion units.

&&- Groups arguments when a group of arguments differs only in their last information unit and constitutes a consecutive sequence. The argu-ments are indicated by writing the lower and upper information units. The last information unit is incremented by one.

For example:

2002-11-01&2002-12-07 2002-11-01 and 2002-12-07

2002-11-01&-07 2002-11-01 and 2002-11-07

2002-11-01&&-03 2002-11-01, 2002-11-02 and 2002-11-03

Different characters can be used to group arguments within the same parameter value. For example:

2002–10–05&2002–11–01&—04&—10&&—12

means the following arguments:

• 2002–10–05, • 2002–11–01, • 2002–11–04, as well as • 2002–11–10, 2002–11–11 and 2002–11–12 (from 2002–11–10 to 2002–11–12).

1.8.2 Wild card character: percent sign (%)The percent sign (%) represents one or more characters. For example, in the following command, the percent sign is the value of the file name parameter and it represents files with any name. This command lists all command files, that is, files with the CMD exten-sion, in the MMDIRE directory of system and backup disks: ZIWX::WS:MMDIRE:%,CMD;

Syntax of the command:

ZIWX::<drive>:<subdir>:<filename>,<extension>;

parameter value

2000-11-01&&-30

argument argument

Page 20: MML User Interface

20 DN0946529

MML User Interface

Id:0900d8058088f10fConfidential

MML command execution

1.9 System output during an MML sessionDuring an MML session, the system can produce

• execution printouts and • messages.

The messages are of the following types:

• execution error messages • semantic error messages • syntax error messages • general error messages • guidance messages • notice messages.

1.9.1 Execution printouts during an MML sessionAn execution printout is usually displayed after you have entered an MML command. The printout indicates that a command is being executed. However, some commands do not produce execution printouts. The only message that is displayed after such a command has been entered is the message indicating the result of command execution: if the command succeeded, the message COMMAND EXECUTED is displayed and if the command failed, an error message is displayed.

Below is an example of the execution printout of the IGO command. The printout of the command log lists the contents of the user's own sessions during the current day.

/* 3 SESSION=00003 USERID=SYSTEM IP=10.140.89.12 2011-04-12 11:50:14+02:00 *//* 1 MSS-DXTEBE MSCi VTP-18 SESSION=00004 USERID=SYSTEM IP=10.140.17.107 STARTED 2011-04-12 11:57:16+02:00 */WQO:CR;/* 3 SESSION=00004 USERID=SYSTEM IP=10.140.17.107 2011-04-12 11:57:19+02:00 *//* 4 WQO:CR; *//* 4c COMMAND EXECUTED */ /* 4c SESSION=00004 USERID=SYSTEM IP=10.140.17.107 2011-04-12 11:57:19+02:00 *//* 2 MSS-DXTEBE MSCi VTP-18 SESSION=00004 USERID=SYSTEM IP=10.140.17.107 ENDED 2011-04-12 11:58:16+02:00 *//* 1 MSS-DXTEBE MSCi VTP-19 SESSION=00005 USERID=SYSTEM IP=10.140.88.228 STARTED 2011-04-12 11:58:31+02:00 */IGO;/* 3 SESSION=00005 USERID=SYSTEM IP=10.140.88.228 2011-04-12 11:58:33+02:00 */

1.9.2 Messages of the system during an MML session

Error messagesAn execution error message is displayed when an error occurs during the execution of a command. It indicates that the command cannot be executed. These messages are listed in the command description of the command in question. Below is an example of an execution error message:

/*** ADDITION NOT POSSIBLE ***//*** OBJECT LIST IS USED BY ACTIVE MEASUREMENT ***/

Page 21: MML User Interface

DN0946529 21

MML User Interface MML command execution

Id:0900d8058088f10fConfidential

A semantic error message is displayed when parameter values have been given incor-rectly, for example, in the wrong order. Some messages are command-specific and some can apply to several commands. Information on messages of the former kind is given in the command description of the command in question. Messages of the latter kind are listed in General Notice Messages of MML Session.. Below is an example of a semantic error message:

/*** SEMANTIC ERROR ***//*** NONEXISTENT UNIT TYPE ***/

A syntax error message appears when the structure of a command does not follow the syntactic rules of the command. Syntax error messages are listed in General Notice Messages of MML Session.. Below is an example of a syntax error message:

/*** SYNTAX ERROR ***//*** MISSING ":" OR ";" ***/

General error messages are listed in General Error Messages of System. Below is an example of a general error message:

56: NO SUCH FILE

Displaying the explanation of the latest general error messageTo display the explanation of the latest general error message and the possible instruc-tions on how to proceed, press CTRL-7. To find out the reason for an error, you can also use the MRSTRE service terminal extension.

Guidance messagesGuidance messages give information on the various phases of an MML session. They describe, for example, the meaning of parameters and the syntactic structure of a command. General guidance messages are listed in General Notice Messages of MML Session..

Notice messagesNotice messages give information on the various phases of an MML session. Notice messages are listed in General Notice Messages of MML Session. . Below is an example of a notice message:

COMMAND EXECUTED