You are on page 1of 108

RU50 updating check

Executing MML Commands


in IPA-RNC
DN02143068
Issue 09
Approval Date 2014-02-16

ExecutingMMLCommandsinIPA-RNC

Theinformationinthisdocumentissubjecttochangewithoutnoticeanddescribesonlytheproduct
defined in the introduction of this documentation. This documentation is intended for the use of
NokiaSolutionsandNetworkscustomersonlyforthepurposesoftheagreementunderwhichthe
documentissubmitted,andnopartofitmaybeused,reproduced,modifiedortransmittedinany
formormeanswithoutthepriorwrittenpermissionofNokiaSolutionsandNetworks.Thedocumen-
tationhasbeenpreparedtobeusedbyprofessionalandproperlytrainedpersonnel,andthecus-
tomerassumesfullresponsibilitywhenusingit.NokiaSolutionsandNetworkswelcomescustomer
commentsaspartoftheprocessofcontinuousdevelopmentandimprovementofthedocumenta-
tion.

The information or statements given in this documentation concerning the suitability, capacity, or
performanceofthementionedhardwareorsoftwareproductsaregiven"asis"andallliabilityaris-
inginconnectionwithsuchhardwareorsoftwareproductsshallbedefinedconclusivelyandfinally
in a separate agreement between Nokia Solutions and Networks and the customer. However,
NokiaSolutionsandNetworkshasmadeallreasonableeffortstoensurethattheinstructionscon-
tained in the document are adequate and free of material errors and omissions. Nokia Solutions
and Networks will, if deemed necessary by Nokia Solutions and Networks, explain issues which
maynotbecoveredbythedocument.

NokiaSolutionsandNetworkswillcorrecterrorsinthisdocumentationassoonaspossible.INNO
EVENT WILL Nokia Solutions and Networks BE LIABLE FOR ERRORS IN THIS DOCUMENTA-
TION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDI-
RECT,INCIDENTALORCONSEQUENTIALORANYLOSSES,SUCHASBUTNOTLIMITEDTO
LOSSOFPROFIT,REVENUE,BUSINESSINTERRUPTION,BUSINESSOPPORTUNITYORDA-
TA,THATMAYARISEFROMTHEUSEOFTHISDOCUMENTORTHEINFORMATIONINIT.

Thisdocumentationandtheproductitdescribesareconsideredprotectedbycopyrightsandother
intellectualpropertyrightsaccordingtotheapplicablelaws.

NSN is a trademark of Nokia Solutions and Networks. Nokia is a registered trademark of Nokia
Corporation.Otherproductnamesmentionedinthisdocumentmaybetrademarksoftheirrespec-
tiveowners,andtheyarementionedforidentificationpurposesonly.

CopyrightNokiaSolutionsandNetworks2014.Allrightsreserved

f Important Notice on Product Safety


Thisproductmaypresentsafetyrisksduetolaser,electricity,heat,andothersourcesof
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.

ThesafetyinformationisprovidedintheSafetyInformationsectionintheLegal,Safety
andEnvironmentalInformationpartofthisdocumentordocumentationset.

NokiaSolutionsandNetworksiscontinuallystrivingtoreducetheadverseenvironmentaleffectsof
itsproductsandservices.Wewouldliketoencourageyouasourcustomersanduserstojoinusin
working towards a cleaner, safer environment. Please recycle product packaging and follow the
recommendationsforpoweruseandproperdisposalofourproductsandtheircomponents.

IfyoushouldhavequestionsregardingourEnvironmentalPolicyoranyoftheenvironmentalser-
vicesweoffer,pleasecontactusatNokiaSolutionsandNetworksforanyadditionalinformation.

2 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC

Table of Contents
Thisdocumenthas108pages

1 Summaryofchanges..................................................................... 8

2 OverviewofMMLcommands.........................................................9
2.1 MMLcommandexecution.............................................................. 9
2.2 OnlinehelpduringMMLsession....................................................9
2.3 System'soutputduringanMMLsession......................................11
2.4 ToolsforexecutingMMLcommands............................................13
2.5 StructureofMMLcommands....................................................... 14
2.6 SpecialcharactersinMMLcommands........................................ 19
2.7 LineeditorofMMLcommands:searchingandeditingofMML....21

3 UsingMMLcommands................................................................ 24
3.1 ControllingoftheoutputofcharactersdisplayedontheMML
terminal........................................................................................ 24
3.2 PrintingoutofcharactersdisplayedontheMMLterminal.......... 24
3.3 ScreeneditorofMMLcommands:readingandeditingcharacters
onscreen..................................................................................... 25
3.4 EditingtextfilesofMMLcommands............................................ 26
3.5 OpeningandclosingMMLsessions........................................... 27
3.6 EnteringMMLcommandsstepbystep.......................................29
3.7 EnteringMMLcommandswithoutusingtheonlinehelp.............33
3.8 RepeatingorcancellingMMLcommands.................................... 34
3.9 Movingfromonecommandleveltoanother................................ 35
3.10 Enteringdefaultvaluestoparameters........................................ 36
3.11 ChangingthelanguageofMMLcommandmenus..................... 38
3.12 SettinganMMLprogramintheteststate................................... 38
3.13 SettinganMMLsessiontime-out................................................39

4 MMLmacros................................................................................ 40
4.1 MMLmacros................................................................................ 40
4.2 MMLmacronames...................................................................... 43
4.3 MMLmacrostructure................................................................... 44
4.4 StructuralpartsofthecommandlanguageinMMLmacros.........44
4.5 MenutextsinMMLmacros.......................................................... 47
4.6 HeaderinMMLmacros................................................................47
4.7 DeclarationandexecutionpartsinMMLmacros......................... 48
4.8 CommandlanguageexpressionsandstatementsinMMLmacros.
50
4.9 DirectivesinMMLmacros............................................................ 50
4.10 StopstatementsinMMLmacros..................................................53
4.11 InputandoutputstatementinMMLmacros.................................54
4.12 PlacementstatementinMMLmacros..........................................55
4.13 If-statementinMMLmacros.........................................................55

Issue:09 DN02143068 3
ExecutingMMLCommandsinIPA-RNC

4.14 While-statementinMMLmacros..................................................56
4.15 MMLcommandsinMMLmacros................................................. 57
4.16 LibraryroutinesinMMLmacros...................................................58
4.17 ExitstatementsinMMLmacros................................................... 62
4.18 ExecutionofMMLmacros............................................................63
4.19 Shortstart-upmethodforMMLmacros....................................... 63
4.20 Longstart-upmethodforMMLmacros........................................ 64
4.21 TestingMMLmacros.................................................................... 66
4.22 InstallingMMLmacros................................................................. 66
4.23 ListingMMLmacros.................................................................... 67
4.24 ExecutinganMMLmacro............................................................ 67
4.25 DisplayingthecontentsofanMMLmacro................................... 68

5 MMLcommandlogs.....................................................................70
5.1 MMLcommandlog.......................................................................70
5.2 ModifyingstoringtimeofMMLcommandlog..............................74
5.3 ModifyingMMLcommandlogdiskspaceconsumption...............75
5.4 ChangingMMLcommandlogremovaltime................................75
5.5 DecreasingdiskupdatingloadofMMLcommandlog................. 76
5.6 DisplayingMMLcommandloginformation.................................. 76
5.7 PrintingMMLcommandloginformationtodiskfile......................77
5.8 ClosingtheMMLcommandlog....................................................78
5.9 MonitoringofthestartingandendingofMMLcommandexecution.
79
5.10 TransferringMMLcommandloginformationtothepostprocessing
systemusingFTPorSFTP.......................................................... 79
5.11 PrintingMMLcommandloginformationviaalogicalfile............. 80

6 MMLdiskcommandfiles..............................................................82
6.1 DiskcommandfilesinMML......................................................... 82
6.2 ListingMMLdiskcommandfilesinthesystem........................... 84
6.3 DisplayingthecontentsofadiskcommandfileinMML.............. 84
6.4 Creatingadiskcommandfileusingthesystem'sdiskfileeditorin
MML............................................................................................. 85
6.5 ExecutingdiskcommandfilesinMML......................................... 86
6.6 InterrogatingoutputdevicesofexecutionprintoutsinMML.........87
6.7 GivingparametervaluestoMMLcommandsinadiskcommand
file.................................................................................................87
6.8 StoppingtheexecutionofadiskcommandfileinMML............... 88
6.9 Savingexecutionprintoutsofadiskcommandfileinadiskfilein
MML............................................................................................. 89
6.10 Preventingthesavingofexecutionprintoutsofadiskcommand
fileinadiskfileinMML................................................................ 89

7 MMLcommandcalendar..............................................................91
7.1 MMLcommandcalendar..............................................................91
7.2 DisplayingthecontentsofthecommandcalendarinMML..........93

4 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC

7.3 DirectingtheexecutionprintoutsofMMLcommandcalendartasks
..................................................................................................... 95
7.4 AddingatasktothecommandcalendarinMML......................... 97
7.5 TestingcalendartaskexecutioninMML...................................... 99
7.6 ModifyingacalendartaskinMML................................................99
7.7 DeletingacalendartaskinMML................................................101
7.8 BlockingorunblockingacalendartaskinMML......................... 102
7.9 StoppinganMMLcommandfileexecution................................ 104

8 MMLcommandtroubleshooting.................................................105
8.1 Executionofacalendartaskfails...............................................105
8.2 TerminationofanMMLcalendartaskthatisacommandfilefails...
106
8.3 OpeninganMMLsessionfails................................................... 107

Issue:09 DN02143068 5
ExecutingMMLCommandsinIPA-RNC

List of Figures
Figure1 ThecommandclassofIGO...............................................................15
Figure2 ThecommandgroupofIGO...............................................................15
Figure3 Anexampleofargumentsgroupedbyanampersand........................19
Figure4 Anexampleofacombinationparameter...........................................19
Figure5 Howtomovefromonecommandleveltoanother............................. 36
Figure6 MMLmacronames.............................................................................43
Figure7 AnexampleofthestructureofanMMLmacroheader...................... 48
Figure8 Displayingtheoutputdevicesofexecutionprintouts.........................96

6 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC

List of Tables
Table1 ToolsforexecutingMMLcommands.................................................. 14
Table2 PunctuationmarksinMMLcommands.............................................. 17
Table3 Examplesofthegroupingofsingleparameterarguments................. 20
Table4 Groupingcompoundparameterarguments........................................20
Table5 PRFILEparametersaffectingtheMMLcommandlog........................71
Table6 Informationgivenineachcommandlogrecord..................................72

Issue:09 DN02143068 7

Summaryofchanges ExecutingMMLCommandsinIPA-RNC

1 Summary of changes
Changesbetweendocumentissuesarecumulative.Therefore,thelatestdocument
issuecontainsallchangesmadetopreviousissues.

Notethatourissuenumberingsystem,safetyinformation,andproductnamingpractice
arechanging.Formoreinformation,seeGuide to WCDMA RAN Operating
Documentation.

Changes between Issues 08C (2011-11-07, RU30) and 09 (2014-02-16,


RU50)
A2SUandA2SPrelatedinformationisremovedfromthedocument.

Changes between Issues 08B (2011-02-18, WCDMA RAN RU30) and


08C (2011-11-07, WCDMA RAN RU30)
MMLcommandlog

Thedefaultvalueofstoringtimeanddiskspaceconsumptionischangedfrom3
daysto30days.

Changes between Issues 08A (2010-10-22, WCDMA RAN RU30) and


08B (2011-02-18, WCDMA RAN RU30)
DisplayingthecontentsofthecommandcalendarinMML(6.2)

Theexecutionprintoutisupdated.

BlockingorunblockingacalendartaskinMML(6.8)

Theexecutionprintoutisupdated.

8 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

2 Overview of MML commands

2.1 MML command execution


FirstyoumustenterauserIDandapassword.Atthecommandenteringstage,startthe
desiredfunctionsbyenteringtherequiredcommandsbymeansofthemenuselection
technique.

AnMMLsessionisendedbygivingthecommandZ;onthemainlevel.

Thecommandsaregivenstepbystepbyfirstselectingthecommandclass(charging
administration,trafficadministration,routingadministration,andsoon),thenacommand
groupwithintheclass,andfinallytheindividualcommand(forexample,displaycharging
data).Ateachstepyouwillhaveacommandlist(amenu)onthescreenofyourterminal
showingthealternativestoselectfromatthatparticularstage.Themenuscanalsobe
bypassedforrapidselectionofthedesiredoperation.

Related topics
Instructions

OpeningandclosingMMLsessions

EnteringMMLcommandsstepbystep

EnteringMMLcommandswithoutusingtheonlinehelp

RepeatingorcancellingMMLcommands

Movingfromonecommandleveltoanother

Enteringdefaultvaluestoparameters

ChangingthelanguageofMMLcommandmenus

SettinganMMLprogramintheteststate

SettinganMMLsessiontime-out

2.2 Online help during MML session


Theonlinehelpprovidesyouwithcommandmenusandaparameterguide.Ithelpsyou
enterMMLcommandsandguidesyouwhenyouopenorcloseanMMLsession.During
thevariousphasesoftheMMLsession,guidancemessagesaredisplayed.

Issue:09 DN02143068 9

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

Command menus
Commandmenusincludemenusofcommandclasses,commandgroupsand
commands.Belowisanexampleofacommandclassmenu:

MAIN LEVEL
? ..... DISPLAY MENU
A ..... ALARM SYSTEM ADMINISTRATION
C ..... ROUTING STATE ADMINISTRATION
D ..... SYSTEM SUPPORT AND COMMUNICATION
E ..... CELLULAR RADIO NETWORK ADMINISTRATION
I ..... I/O SYSTEM ADMINISTRATION
L ..... BROADBAND ADMINISTRATION
N ..... SS7 NETWORK ADMINISTRATION
O ..... SUPPLEMENTARY SS7 NETWORK ADMINISTRATION
Q ..... O&M NETWORK ADMINISTRATION
R ..... ROUTING ADMINISTRATION
T ..... TRAFFIC ADMINISTRATION
U ..... UNIT ADMINISTRATION
W ..... SYSTEM CONFIGURATION ADMINISTRATION
Y ..... SYSTEM SUPERVISION
Z; .... END DIALOGUE (:)

Todisplaythecommandmenuinthecommandlevelatwhichyouare,enteraquestion
mark(?).

Parameter guide
Theparameterguidegivesinformationontheenteringofparameters.Forexample,it
indicatestheparametersthatcanormustbeentered.Belowisanexampleofthe
parameterguideoftheICLcommand:

/* 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 */

Todisplaytheparameterguide,press ENTER afteryouhavetypedthecommandletters


oroneormoreparameters.

Notethatwhenyouusenetworkelementsthathavedifferentconfigurations,youmay
havetoenterdifferentvaluestothesameparameter.Thisisbecausepartofthe
informationintheparameterguidenormallydependsontheconfigurationofthenetwork
element.Thisinformationincludes,forexample,thevaluerangeoftheparameterand
therelationbetweenparameters.

10 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

Key combinations
Youcandisplayalistofkeysthatcanbeused,forexample,toeditMMLcommandsand
tocontroltheiroutputontheMMLterminalbypressing CTRL-W .

LINE EDITOR COMMANDS

CTRL A = INSERT/REPLACE
CTRL B = EDIT PREV CMND
CTRL D = CURS LEFT
CTRL E = CURS END OF LINE
CTRL F = CURS RIGHT
CTRL G = CURS DOWN
CTRL H = CURS HOME
CTRL I = CURS UP
CTRL K = CHANGE LANGUAGE
CTRL L = DEL CHAR
CTRL N = CURS BEGINNING OF PARAM BLOCK
CTRL O = HARDCOPY
CTRL P = PAGE MODE ON/OFF
CTRL Q = CONT OUTPUTTING
CTRL R = CURS BEGINNING OF PARAM
CTRL S = PAUSE OUTPUTTING
CTRL T = OUTPUT RINGBUFFER
CTRL U = EMPTY EDIT BUFF
CTRL V = DEL PREV CHAR
CTRL X = JUMP TO CMD GROUP LEVEL
CTRL Y = INTERRUPT
CTRL Z = DEL CHARS IN EDIT BUFF
BREAK = END OF DIALOG
CTRL 4 = MML TEST MODE ON/OFF
CTRL 7 = DX ERROR DESCRIPTION
? AND <UP ARROW> = LIST OF PREVIOUS COMMANDS
<NUMBER> and <UP ARROW> = EDIT CERTAIN PREVIOUS COMMAND
<STRING> and <UP ARROW> = EDIT PREVIOUS COMMANDS CONTAINING GIVEN STRING

2.3 System's output during an MML session


DuringanMMLsession,thesystemcanproduce

executionprintoutsand
messages.

Themessagesareofthefollowingtypes:

executionerrormessages
semanticerrormessages
syntaxerrormessages
generalerrormessages
guidancemessages
noticemessages

Issue:09 DN02143068 11

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

Execution printouts
AnexecutionprintoutisusuallydisplayedafteryouhaveenteredanMMLcommand.
Theprintoutindicatesthatacommandisbeingexecuted.However,somecommandsdo
notproduceexecutionprintouts.Theonlymessagethatisdisplayedaftersucha
commandhasbeenenteredisthemessageindicatingtheresultofcommandexecution:
ifthecommandsucceeded,themessageCOMMAND EXECUTEDisdisplayedandifthe
commandfailed,anerrormessageisdisplayed.

BelowisanexampleoftheexecutionprintoutoftheIGOcommand.Theprintoutofthe
commandlogliststhecontentsoftheuser'sownsessionsduringthecurrentday.

WQO;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:28:06 */
/* 4 WQO; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:28:13 */
IID::MMLLOG;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:28:57 */
/* 4 IID::MMLLOG; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:28:58 */
IGO:;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:29:04 */
/* 4 IGO:; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:29:05 */
USC:OMU:TE,:;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:32:47 */
/* 4 USC:OMU:TE,:; */
/* 4c COMMAND ABORTED *//*** ERROR: 795 ***/
/*** TRANSITION NOT CONTROLLED ***/
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:32:49 */

Error messages
Anexecutionerrormessageisdisplayedwhenanerroroccursduringtheexecutionofa
command.Itindicatesthatthecommandcannotbeexecuted.Thesemessagesare
listedinthecommanddescriptionofthecommandinquestion.Belowisanexampleof
anexecutionerrormessage:

/*** ADDITION NOT POSSIBLE ***/


/*** OBJECT LIST IS USED BY ACTIVE MEASUREMENT ***/

Asemanticerrormessageisdisplayedwhenparametervalueshavebeengiven
incorrectly,forexample,inthewrongorder.Somemessagesarecommand-specificand
somecanapplytoseveralcommands.Informationonmessagesoftheformerkindis
giveninthecommanddescriptionofthecommandinquestion.Messagesofthelatter
kindarelistedinGeneralNoticeMessagesofMMLSession.Belowisanexampleofa
semanticerrormessage:

/*** SEMANTIC ERROR ***/


/*** NONEXISTENT UNIT TYPE ***/

12 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

Asyntaxerrormessageappearswhenthestructureofacommanddoesnotfollowthe
syntacticrulesofthecommand.SyntaxerrormessagesarelistedinGeneralNotice
MessagesofMMLSession.Belowisanexampleofasyntaxerrormessage:

/*** SYNTAX ERROR ***/


/*** MISSING ":" OR ";" ***/

GeneralerrormessagesarelistedinGeneralErrorMessagesofSystem.Belowisan
exampleofageneralerrormessage:

56: NO SUCH FILE

Displaying the explanation of the latest general error message


Todisplaytheexplanationofthelatestgeneralerrormessageandthepossible
instructionsonhowtoproceed,press CTRL-7 .Tofindoutthereasonforanerror,you
canalsousetheMRSTREserviceterminalextension.

Guidance messages
GuidancemessagesgiveinformationonthevariousphasesofanMMLsession.They
describe,forexample,themeaningofparametersandthesyntacticstructureofa
command.GeneralguidancemessagesarelistedinGeneralNoticeMessagesofMML
Session.

Notice messages
NoticemessagesgiveinformationonthevariousphasesofanMMLsession.Notice
messagesarelistedinGeneralNoticeMessagesofMMLSession.Belowisanexample
ofanoticemessage:

COMMAND EXECUTED

Related topics
Descriptions

MMLcommandexecution

2.4 Tools for executing MML commands


InadditiontoindividualMMLcommands,othertoolsareavailablefortheoperationofthe
system:diskcommandfilesandMML macroscanbeusedtoexecuteMMLcommand
sequences.Thecommand calendarcanbeusedtoexecuteMMLcommandsanddisk
commandfilesatapredefinedmoment.

MMLmacroscanbeusedtoexecutecomplicatedcommandsequences.Theyareuseful
whenexecutingcommandsequencesthatneedtobeexecutedrepeatedly.MMLmacros
canbecreatedbytheusers.

Issue:09 DN02143068 13

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

Diskcommandfilescanbeusedtocarryoutroutinetasksthatdonotneedtobe
supervised.Theyareuseful,forexample,whencarryingouttasksthatneedtobe
executedrepeatedly.Diskcommandfilescanbecreatedbytheusers.Ifyouwantto
executethesamecommandsorsomeofthecommandsthatyouhaveexecutedduring
aparticularMMLsession,youcanuseyourMMLcommandlogasabasisofadisk
commandfile.

ThecommandcalendarenablestheexecutionofMMLcommandsanddiskcommand
filesatapredefinedmoment:eitheratacertaintimeorwhenacertainalarmoccurs.The
tasksinthecommandcalendarcanbeexecutedonceorrepeatedlyatcertainintervals.
Thecommandcalendarcanbeusedtocarryoutroutinetasksthatdonotneedtobe
supervised.

Table 1 ToolsforexecutingMMLcommands

TOOL WHAT THE TOOL IS USED FOR

Diskcommandfile ExecutingMMLcommandsequences

MMLmacro ExecutingcomplicatedMMLcommandsequences

Commandcalendar ExecutinganMMLcommandoradiskcommandfileonceorrepeatedly
atapredeterminedmoment(timeoralarm)

Commandlog Storinginformationofcommandsyouhaveexecuted

Related topics
Descriptions

DiskcommandfilesinMML

MMLcommandcalendar

MMLcommandexecution

2.5 Structure of MML commands


MMLcommandsconsistofacommandpartand,ingeneral,aparameterpart.The
commandpartconsistsofthreecommandlettersthatdefinethefunctionyouwantthe
systemtoperform.Theparameterpartconsistsofparametersthatcontaininformation
necessaryfortheexecutionofacommand.SeethefollowingexampleoftheICL
command:

ZICL:DATE=2000-01-01,HOURS=1&&3;

Inthisexample,ICLcomprisesthecommandpartand
DATE=20000101,HOURS=1&&3;theparameterpart.

14 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

MMLcommandsaresubjecttocertainpunctuationrules.Parametersareseparatedfrom
oneanotherandfromthecommandpartbypunctuationmarksandthecommandis
completedbyasemi-colon(;).

EachMMLcommandhasafixedstructure,whichisdefinedbysyntacticrules.The
syntaxofacommanddetermines,forexample,theparametersthatmustbegiven
specificvaluesandtheorderofthevariouselementsinthecommand.Syntacticrules
arepresentedinthecommand-specificinstructions,andtheonlinehelpoffersguidance
whenyouenterthecommand.

Command part of MML commands


Thecommandpartusuallyconsistsofthreeletters.Forexample,thecommandpartofa
commandthatdisplaysoneorseveralMMLcommandlogs,consistsofthelettersIGO.

Thefirstletterofacommandidentifiesthecommandclasstowhichthecommand
belongs.Forexample,theIGOcommandbelongstothecommandclassI,which
comprisesallthecommandgroupsrelatedtotheI/Osystemadministration.

Figure 1 ThecommandclassofIGO

Thefirsttwolettersofacommandidentifythecommandgrouptowhichthecommand
belongs.Forexample,theIGOcommandbelongstotheIGcommandgroup,which
comprisesallthecommandsforhandlinganMMLcommandlog.

Figure 2 ThecommandgroupofIGO

Thelastletteristhecommandletter.Thethreelettersthusformacommand.

g Numbersfromzero(0)tonine(9)canalsobeusedatthecommandgroup
level.(Forexample,commandslikeA1CorB2Darepossible.

Youcanenterthecommandlettersbymakinguseofmenusofcommandclasses,
commandgroupsandcommandsorwithoutusingthesystem'shelp.

Punctuation marks in MML commands


CertainelementsofanMMLcommandmustbeseparatedfromoneanotherby
punctuationmarks(separators)andthecommandmustbecompletedbyasemi-colon.
Thefollowingpunctuationmarkscanbeused:

SPACE Thespacehasnosyntacticsignificance.Itisoftenusedinthe
examplestoclarifythestructure,butitcanbeomittedwhengivinga
command.

Issue:09 DN02143068 15

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

COMMA Thecommaisused

toseparateparametersfromoneanotherwhentypingthemin
togivethedefaultvaluetoposition-definedparameters.Writing
commasoneafteranothercorrespondstogivingthedefaultvalue
totheparameterbetweenthecommas.Ifthenumberofcommas
givenexceedsthenumberofparameters,thesyntaxanalyzer
givesanerrormessage.
togivethedefaultvaluetoname-definedparameters.Typinga
commaafteran'equals'sign(=)givesthenamedparameterits
defaultvalue.

Thecommaisnotneededif

youpress ENTER aftertypingtheparameter.Inthiscase,the


syntaxanalyzeraddsthecommaitself.

COLON Thecolonisused

afteracommandcode,beforetypingtheparameters.
asadelimiterofparameterblocks.

Thecolonisnotneededif

aparameterblockandthecommandareendedsimultaneously
withasemicolon.
youhavetypedthelastparameterofaparameterblockcontaining
position-definedparametersandpressed ENTER .Inthiscase,
thesyntaxanalyserknowsthattheparameterblockends,and
addsthecolon.

Thecoloncanbegivenif

inaparameterblock,therestoftheparametershavethedefault
value.Inthiscase,thesyntaxanalysermovestothenext
parameterblock,acceptingthecolonintothecharacterstring.

SEMI-COLON Thesemi-colonisusedtoendacommand.Thesemi-coloncanbe
givenif

allthecommandparametersnotyetgivenhavethedefaultvalue.
thecommandhasnoparameters.

Thesemi-colonmustnotbegiven

if,forsomereason,youwanttostoptheenteringofthecommand
inthephasewheretheparametershavebeenchecked.This
couldbethecase,forexample,inparameterenteringexercises,
testsituations,andsoon.

16 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

Unlikewiththecommaorthecolon,thesyntaxanalyseritselfnever
addsthesemicolontoacommand.

QUESTION MARK
Thequestionmarkdisplaystheguidancereferringtothecurrent
commandenteringphase.Theguidancecanbeamenuorsome
parameterguidance.

Table 2 PunctuationmarksinMMLcommands

PUNCTUATION MARK FUNCTION IN THE COMMAND

Space Nosyntacticsignificance

Comma(,) Separatesparametersfromoneanother

Givesthedefaultvaluetoposition-definedandname-definedparameters

Colon(:) Separatesthecommandpartfromtheparameterpart

Separatesparameterblocksfromoneanother

Semi-colon(;) Completesandexecutesthecommand

Questionmark(?) Displaysguidancewhenenteringacommand(guidancecanbeeithera
menuorsomeparameterguidance)

Notethatseparatorsdonotalwayshavetobeentered.Instead,afteryouhavetypedin
aparameter,youcanpress ENTER and,inmostcases,thesystemaddsthecorrect
separator.Alsonotethatifaparameterblockcontainsname-definedparameters,you
mayhavetoenteracolontomovetothefollowingparameterblock.Thesystemnever
addsthesemi-colon(;).

Parameter part of MML commands


Theparameterpartconsistsofparameters,whichcontainpiecesofinformation
necessaryfortheexecutionofanMMLcommand.However,somecommandsdonot
containparameters.Theparameterpartisseparatedfromthecommandpartbyacolon
(:).Forexample,theparameterpartoftheICLcommandisasfollows(seeaboveforthe
entirecommandincludingthecommandpartICL:):

DATE=2000-01-01,HOURS=1&&3;

Inthiscommand,theparametersidentifythecommandcalendartasksthatthe
commandlists:theyindicatethatthedateofthecalendarexecutionisthefirstof
January,2000between1:00and3:00.Theexecutiondateisindicatedbythedate
parameter,whichisDATE=20000101.Theexecutiontimeisindicatedbythehours
parameter,whichisHOURS=1&&3.

Issue:09 DN02143068 17

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

Youcanenterparametersbymakinguseoftheparameterguideorwithoutusingthe
system'shelp.

Parameter blocks

Theparameterpartconsistsofoneormoreparameter blocks.Parameterblocks
containeitheroneparameterorparametersthatarecloselyassociatedwithoneanother.
Parameterblocksareseparatedfromoneanotherbyacolon(:).Forexample,intheICL
commandpresentedabove,DATE=20000101,HOURS=1&&3comprisesone
parameterblock.Parameterblocksmustbeenteredinthespecificorderdeterminedby
thesyntaxofthecommand.Theparameter guidehelpsyouentertheblocksinthe
correctorder.

Aparameterblockcancontaineitherposition-definedorname-definedparameters.
Position-definedparametersmustbeenteredinapredeterminedorderwithina
parameterblock.

Name-defined and position-defined parameters

Parameterscanbeeitherposition-definedorname-defined.Aposition-defined
parameterconsistsofaparametervalue.Forexample:

ZIDL:WDU,1,XYZ:START=2,STOP=20:;

IntheIDLcommand,1isaposition-definedparameterasitconsistsonlyofthevalueto
beentered.

g Position-definedparametersmustbegiveninapredeterminedorderwithina
parameterblock.Theorderisdeterminedbythesyntaxofeachcommand.The
parameterguidehelpsyoutoentertheparametersinthecorrectorder.

Aname-definedparameterconsistsofaparameternamewhichisalwaysfollowedbya
parametervalue.Theparametervalueisseparatedfromtheparameternamebyan
equalsign(=).IntheIDLcommandabove,startisaname-definedparameterasitis
followedbythevaluetwopresentedas=2,thatis,START=2.Name-definedparameters
canbegiveninanarbitraryorderwithinaparameterblock.

Related topics
Descriptions

MMLcommandcalendar

MMLcommandexecution

MMLcommandlog

SpecialcharactersinMMLcommands

18 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

2.6 Special characters in MML commands


Character for grouping parameter arguments: ampersand (&)
Thissectiondealswiththeampersand(&)andcharactercombinations&-,&&and&&-.
Theyareusedforgroupparameterarguments,whichcontaininformationspecifyingthe
parametervalue.Aparametercancontaineitheroneorseveralparameterarguments.If
severalargumentsofaparameterneedtobeentered,theargumentsmustbegrouped
usingtheabovementionedcharacters.Belowisanexampleofaparameterandits
arguments1and3groupedbyanampersand(&):

Figure 3 Anexampleofargumentsgroupedbyanampersand

Forexample,inthefollowingcommand,thisvalueindicatesthattheICLcommandlists
thecommandcalendartaskstobeexecutedon20000101at1:00and3:00:

ZICL:DATE=2000-01-01,HOURS=1&3;

Theampersand(&)canbeusedtogroupalltypesofparameterarguments.However,
theuseofcharactercombinations&&,&-and&&-isdeterminedbythetypeofthe
parameter.Therearetwotypesofparameters:singleparametersandcombination
parameters.Theargumentsofsingleparametersconsistofoneinformationunit(for
example,3inthefigureabove).

Theargumentsofcombinationparametersconsistofseveralinformationunits,whichare
separatedfromoneanotherbyahyphen().Combinationparametersareoftheform
123,inwhich123isaparameterargumentand1,2and3areinformationunits.
Seethefollowingexampleofacombinationparameter,inthiscasedateinformation:

Figure 4 Anexampleofacombinationparameter

Issue:09 DN02143068 19

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

Usage of the ampersand to group single parameter arguments

Table 3 Examplesofthegroupingofsingleparameterarguments

Grouped arguments Arguments indicated by grouping

1&2 1and2

3&&5 3,4and5

Differentcharacterscanbeusedtogroupargumentswithinthesameparametervalue.
Forexample,1&3&&6meansarguments1,3,4,5and6.

Usage of the ampersand to group combination parameter arguments


Whenmorethanoneargumentofacombinationparameterneedstobegiven,
characters&,&-and&&-areused.Belowareexplanationsofthesecharacters:

& Groupstwocombinationparameterargumentswithinthesame
parametervalue.

&- Groupscombinationparameterargumentswhenagroupof
parametersdiffersonlyintheirlastinformationunit.Thefirstargument
iscompletelyspecified,whereastheothersarerepresentedonlyby
theirlastinformationunits.

&&- Groupsargumentswhenagroupofargumentsdiffersonlyintheirlast
informationunitandconstitutesaconsecutivesequence.The
argumentsareindicatedbywritingthelowerandupperinformation
units.Thelastinformationunitisincrementedbyone.

Seetheexamplesinthefollowingtable.

Table 4 Groupingcompoundparameterarguments

Grouped arguments Arguments indicated by grouping

2000-11-01&2000-12-07 2000-11-01and2000-12-07

2000-11-01&-07 2000-11-01and2000-11-07

2000-11-01&&-03 2000-11-01,2000-11-02and2000-11-03

Differentcharacterscanbeusedtogroupargumentswithinthesameparametervalue.
Forexample:

20 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

20001005&20001101&04&10&&12

meansthefollowingarguments:

20001005,
20001101,
20001104,aswellas
20001110,20001111and20001112(from20001110to20001112).

Wild card character: percent sign (%)


Thepercentsign(%)representsoneormorecharacters.Forexample,inthefollowing
command,thepercentsignisthevalueofthefile nameparameteranditrepresents
fileswithanyname.Thiscommandlistsallcommandfiles,thatis,fileswiththeCMD
extension,intheMMDIREdirectoryofsystemandbackupdisks:

ZIWX::WS:MMDIRE:%,CMD;

Syntaxofthecommand:

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

Related topics
Descriptions

MMLcommandexecution

2.7 Line editor of MML commands: searching and


editing of MML
Theline editorletsyousearchandeditthecommandsyouhaveenteredduringthe
currentMMLsession,andeditthecommandyouaretyping.Ifyouhaveenteredthe
exactsamecommandmorethanonce,youcanonlyhandlethelastinstanceofthat
command.

TheeditorisoperatedfromthekeyboardoftheMMLterminal.Youcanuseavarietyof
keysandkeycombinationstosearchandeditMMLcommandsandcharacters.Youdo
nothavetostarttheeditor:itisavailablewhenyouaretypingMMLcommands.

Belowisalistoflineeditorkeyscategorizedaccordingtotheirfunctions.

Keys for searching commands


Arrowkeys:

'Up' arrow Displaysthecommandyouenteredbeforetheonethatiswrittenafter


theprompt.Ifyouhaveenteredexactlythesamecommandmore
thanonce,onlytheoneyoulastenteredcanbedisplayed.

Issue:09 DN02143068 21

OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC

OR

Number of command + 'Up' arrow


SearchesacommandyouhaveenteredduringanMMLsession.Type
thenumberidentifyingthecommandandpressthe'up'arrow(for
example,press4andthearrow).Thiscommandmustbeentered
immediatelyaftertheprompt.Youcanlistthenumbersbypressing
? andthe'up'arrow.

OR

Characters in command + 'Up' arrow


SearchesacommandyouhaveenteredduringanMMLsession.Type
acharacterstringincludedinthecommandandpressthe'up'arrow
(forexample,pressICLandthearrow).Ifyoupressthearrowagain,
thepreviouscommandwiththesamestringissearched.

'Down' arrow Displaysthecommandenteredaftertheonewrittenaftertheprompt.

? + 'up' arrow
ListsthecommandsyouhaveenteredduringanMMLsessionand
thenumbersidentifyingthem.Thenumberingstartsfromthe
commandyouenteredlast.Ifyouhaveenteredexactlythesame
commandmorethanonce,onlytheonelastenteredisdisplayed.

Keysthatfunctionlike'up'and'down'arrows:

CTRL-B Functionslikethe'up'arrow.

CTRL-G Functionslikethe'down'arrow.

CTRL-I Functionslikethe'up'arrow.

Keys for editing commands


SwitchfromINSERTtoOVERSTRIKEmode:

CTRL-A SwitchesfromtheINSERTmodetotheOVERSTRIKEmodeorvice
versa.IntheOVERSTRIKEmode,thecharacteryoutypereplaces
thecharacterthatthecursorpointsto.IntheINSERTmode,the
characteryoutypeinisinsertedinfrontofthecharacterthecursor
pointsto.

Movetocommandgrouplevel:

CTRL-X Movestothecommandgroupofthecommandthatyouareentering
orthatyouhavejustentered.Ifyouareenteringacommand,thiskey
functionsonlyifyouhaveenteredatleastthethreecommandletters
ofthecommand.

22 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands

Movethecursor:

Arrowkeys:

Right arrow Movestotheright.

Left arrow Movestotheleft.

Keysthatfunctionlike'right'and'left'arrows:

CTRL-D Movescursortotheleft.

CTRL-F Movescursortotheright.

Otherkeys:

CTRL-E Movescursortotheendoftheline.

CTRL-H Movescursortothebeginningoftheline.

CTRL-N Movescursortothebeginningofthenextparameterblock.

CTRL-R Movescursortothebeginningofthenextparameter.

Deletecharacters:

BACKSPACE Deletesthecharactertotheleftofthecursor.

CTRL-L Deletesthecharacterthecursorpointsto.

CTRL-U Deletesallcharactersinthebufferthatstoresthecommandsgiven
duringanMMLsession.

CTRL-V Deletesthecharactertotheleftofthecursor.Functionslike
BACKSPACE .

CTRL-Z Deletesthecharacterthatthecursorpointstoandthosewrittenafter
thecursor.

Related topics
Descriptions

MMLcommandexecution

Issue:09 DN02143068 23

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

3 Using MML commands

3.1 Controlling of the output of characters displayed


on the MML terminal
ThefollowingkeyscanbeusedtocontroltheoutputofcharactersontheMMLterminal
youareusing:

CTRL-P Determineswhethercharactersaredisplayedonthescreenone
screenatatime(PAGEMODE)orwithoutinterruptions
(CONTINUOUSMODE).Todisplayonescreenofcharactersata
time,press CTRL-P beforeyouenterthecommandthatdisplays
characters.Afteronescreenisdisplayed,press ENTER todisplay
anotherscreen.Todisplaycharacterswithoutinterruptions,press
CTRL-P again:youcanswitchfromthePAGEmodetothe
CONTINUOUSmodebeforeyouenterthecommandthatdisplays
charactersandevenwhencharactersarebeingdisplayedonthe
screen.

CTRL-Q Continuetheoutputifyouhaveinterrupteditbypressing CTRL-S .

CTRL-S Interruptsoutput.Theoutputcontinueswhenyoupress CTRL-Q .

Related topics
Instructions

MMLcommandexecution

3.2 Printing out of characters displayed on the MML


terminal
ThefollowingkeyscanbeusedtoprintoutthecharactersdisplayedontheMML
terminalyouareusingduringanMMLsession:

CTRL-T Printsamaximumof2048characters(forexample,MMLcommands,
executionprintoutsandguidancemessages)thatweredisplayed
duringtheMMLsessiononaprinter.Iftheprintingsucceeds,the
messagePRINTEDisdisplayed.Ifitdoesnotsucceed,themessage
PRINTER ERRORisdisplayed.

CTRL-O Functionslike CTRL-T ,butinsteadof2048characters,thiskeyprints


thescreenofcharactersdisplayedduringtheMMLsessionona
printer.

24 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

Related topics
Descriptions

MMLcommandexecution

3.3 Screen editor of MML commands: reading and


editing characters on screen
ThescreeneditorisavailablewithsomeMMLcommands.

Thescreeneditorfunctionsareusedforreadingcharactersandforeditingcharacters
whichareonthescreen.Thetextcanbeeditedusingthespecialandcommand
characters.

Quitting the screen editor


Youcanquitthescreeneditorbytyping CTRL-Z orthecharacter^.Thescreenis
emptied,andthecursormovestothebeginningofthefirstlineonthescreen.Thisalso
terminatestheexecutionoftheIEEcommand.

Special characters
CTRL-Y Terminatescommandexecution.

DEL (CTRL-V) Deletesthecharactertotheleftofthecursor.

Command characters
CTRL-A SwitchestheeditorfromtheINSERTmodetotheOVERSTRIKE
mode,orviceversa.IntheOVERSTRIKEmode,thenewcharacters
youtypeareplacedontopoftheoldcharacters,replacingthem.In
theINSERTmode,theoldcharactersaremovedforwardmaking
roomforthenewones,ifthereisroomattheendoftheline.

CTRL-C Functionslike CTRL-Z .Terminatescommandexecutionandexitsthe


editor.

CTRL-D Movesthecursoronecharactertotheleft.Ifthecursorisalreadyin
thebeginningoftheline,itisnotmovedtothenextline.

CTRL-E Movesthecursortotheendoftheline,orontothelastcharacterifthe
line,bufferorlinebufferends.

CTRL-F Functionslikethe'left'arrow.Movesthecursoronecharactertothe
right.Doesnotmovethecursortothenextlinebutstopsatthelast
characteroftheline.

CTRL-H Movesthecursortothetoplefthandcornerofthescreen.

Issue:09 DN02143068 25

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

CTRL-I Functionslikethe'up'arrow.Movesthecursoronelineup.

CTRL-J Refreshesthescreen.

CTRL-K Functionslikethe'down'arrow.Movesthecursoronelinedown.

CTRL-L Deletesthecharacterthecursorpointsto.

CTRL-O Displaysthepreviousscreenandmovesthecursortoitsfirstline.

CTRL-P Displaysthenextscreenandmovesthecursortoitsfirstline.

CTRL-R Functionslike CTRL-H .Movesthecursortothetoplefthandcorner


ofthescreen.Ifthecursorisalreadyinthebeginningofthebuffer,it
ismovedtothebeginningofthefile'sfirstline.

CTRL-R + CTRL-R
Movesthecursortothetoplefthandcornerofthefile.

CTRL-W Movesthecursortothebottomlefthandcornerofthescreen.Ifthe
cursorisalreadyinthebeginningofthelastline,itismovedtothe
endofthefile,thatis,tothebeginningofthefile'slastline.

CTRL-W + CTRL-W
Movesthecursortothebottomlefthandcornerofthefile.

CTRL-X Deletesthelinethecursorpointto.

CTRL-Z Functionslike CTRL-C .Terminatescommandexecutionandexitsthe


editor.

Related topics
Descriptions

MMLcommandexecution

3.4 Editing text files of MML commands


Textfilescanbeeditedinthewaysintroducedbelow.Thestructureoftextfilesisalso
explainedbriefly.

SpecialtextfilesusedinthesystemarecommandfilesandMMLmacros.Command
filesarerunwiththeIDEcommandorasataskofthecommandcalendar.

26 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

Structure of text files


Ingeneral,thestructureoftextfilesisfree.However,specialattentionshouldbepaidto
thecommandfile,sinceitsstructureisstrictlydefined.

Thecommandfilemustalwaysstartwithacommentline.Thecommentistraditionally
markedwiththe/**/characterpair.Thegroupoftasksperformedbythecommandfile
shouldbedescribedonthecommentline.

Afterthecommentline,thecommandshavebeenlistedonseparatelinesinthe
commandfile.Thecommandsareintheorderofexecution.Eachlineisendedwiththe
semicolon,whichalsoendsanMMLcommand.

TheextensionpartofthecommandfilemustbeCMD.Otherwise,thecommandfilerun
willnotsucceedwiththeIDEcommand.Thecommandcalendaralsoassumesthe
extensionpartofthefiletobeCMD.

Editing text files with MML commands


EditingandcreatingtextfilestakesplacewiththeIEEcommand.

TheIEEcommandinitiatesascreeneditorwherethecommandandspecialcharacters
describedaboveareinuse.Thefiletobeeditedhassomerestrictionsonthenameand
directory,andtheseareexplainedinthecommanddescription.

Related topics
Descriptions

MMLcommandexecution

3.5 Opening and closing MML sessions


Before you start

BeforeyoucanenterMMLcommands,youhavetoopenanMMLsession.Youcanopen
anMMLsessiononlyifyouhaveauseridentity.

NotethatwhenopeninganMMLsessionviatheEMMMIWindow,thesystemasksfor
yourusernameandpasswordwhenopeningtheElementManagerbutdoesnotaskyou
toentertheminthebeginningoftheMMLsession.However,theEMusermustbe
mappedtoanMMIuser.

IfopeninganMMLsessionfails,seeOpeninganMMLsessionfails.

Purpose

CommunicationwiththesystemtakesplaceinanMMLsession:whileyouoperatethe
systembyenteringMMLcommands,thesystemproducesoutputanddisplaysdifferent
kindsofmessages.MMLcommandsareenteredfromthekeyboardoftheMMLterminal,
whileprintoutsandmessagesareusuallydisplayedonthescreenoftheMMLterminal
youareusing.

Issue:09 DN02143068 27

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

TheMMLterminalisconnectedtotheexchangeusingTelnetorSSH.

1 Open an MML session

1. EnteryouruserIDwhenthesystemasksyouto(ENTER USERNAME <).


2. Enteryourpasswordwhenthesystemasksyouto(ENTER PASSWORD <).

g Passwordsarecasesensitive.Youmustusethecorrectupperorlower
caseasdefinedinyouruserID.

2 Close an MML session

1. EnterZandasemi-colon(Z;)atthemainlevel
Tomovetothemainlevel,enterZandasemi-colon(Z;).

3 Terminate an MML session

g Itisnotrecommendedtousethisprocedureinnormalcircumstances.Itis
bettertoclosetheMMLsessioninsteadofterminatingit.

1. PressBREAK
ToterminatetheMMLsessionpress BREAK .Youcanalsopress CTRL-Y :this
keycombinationterminatesthesessionwhenyouareenteringyouruseridentity
orpasswordortypingacommandatthemainlevel;orwhenyouhaveentered
thecommandclassletterordisplayedthecommandclassmenu.

Expected outcome

ThesessionisopenedwhenthewelcomedialogueandtheMAIN LEVEL COMMAND


promptaredisplayed.ThismeansthatyoucanenterMMLcommands.Seethefollowing
example:

WELCOME TO THE IPA2800 SERIES DIALOGUE

MAIN LEVEL COMMAND <___>


<

Atthetopofthescreentherearethetypeandthenameofthenetworkelementaswell
asthedateandthetime.Thebottomofthescreenindicatesthatyouareatthemain
level.

Thesessionisclosedwhenthefollowingmessageisdisplayed:

END OF DIALOGUE SESSION

28 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

3.6 Entering MML commands step by step


Before you start

Tobeabletooperatethesystem,youneedauseridentity.Eachuser IDisassociated
withaprofilethatdeterminesthecommandstheuserisauthorisedtoexecute.

Purpose

ThesystemismostlyoperatedbymeansofMML commands.WhenyouenterMML
commands,thesystemproducesexecutionprintoutsofthecommandsandvarious
messages.MMLcommandsareenteredfromthekeyboardofthe MML terminalandthe
printoutsandmessagesarenormallydisplayedonthescreenofthisterminal.
CommunicationwiththesystemtakesplaceinanMML session.

Thesystemhasanonlinehelpwithcommandmenusandaparameterguide.Youcan
enterMMLcommandsstep-by-stepusingcommandmenusandtheparameterguideor
simplytypetheminwithoutusingthehelp.WhileyoutypeinMMLcommands,youcan
editthecommandsusingtheline editor.Thiseditoralsoletsyousearchforthe
commandsyouhaveenteredduringanMMLsession.

TheMMLcommandsthatareexecutedduringaparticularMMLsessionarewrittentoan
MML command log,whichalsocontainsotherinformationontheMMLsession.The
commandlogcanbeused,forexample,tolistthecommandsthatweregivenbeforean
erroroccured.Itcanalsobeusedasabasisofadiskcommandfile.

g UseuppercaseletterswhenyoutypetheMMLcommands.

Youcaneditthecommandyouaretypingorthecommandsthatyouhave
alreadyentered.

1 Display the command menu (?)


Displaythemenuofthecommandclassesbyenteringaquestionmark(?)whenyou
areatthemainlevel;thatis,whentheMAIN LEVEL COMMANDpromptisdisplayed.
Expected outcome
Forexample,thefollowingmenucanbedisplayed:

MAIN LEVEL
? ..... DISPLAY MENU
A ..... ALARM SYSTEM ADMINISTRATION
C ..... ROUTING STATE ADMINISTRATION
D ..... SYSTEM SUPPORT AND COMMUNICATION
E ..... CELLULAR RADIO NETWORK ADMINISTRATION
I ..... I/O SYSTEM ADMINISTRATION
L ..... BROADBAND ADMINISTRATION
N ..... SS7 NETWORK ADMINISTRATION
O ..... SUPPLEMENTARY SS7 NETWORK ADMINISTRATION
Q ..... O&M NETWORK ADMINISTRATION
R ..... ROUTING ADMINISTRATION
T ..... TRAFFIC ADMINISTRATION

Issue:09 DN02143068 29

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

U ..... UNIT ADMINISTRATION


W ..... SYSTEM CONFIGURATION ADMINISTRATION
Y ..... SYSTEM SUPERVISION
Z; .... END DIALOGUE (:)

MAIN LEVEL COMMAND <___>


<

2 Display the menu of the command class


TodisplaythemenuoftheIcommandclass,forexample,enterI?.
Expected outcome
Forexample,thefollowingmenucanbedisplayed:

I/O SYSTEM ADMINISTRATION


? ..... DISPLAY MENU
A ..... MMI SYSTEM AUTHORITY HANDLING
B ..... I/O FILE BACKUP
C ..... COMMAND CALENDAR HANDLING
D ..... DISK COMMAND FILE EXECUTION
E ..... DISK FILE OPERATIONS
F ..... VIRTUAL DATA STORING DEVICE HANDLING
G ..... MML COMMAND LOG HANDLING
H ..... I/O UNIT OPERATING STATE HANDLING
I ..... I/O CONFIGURATION HANDLING
P ..... BATCH COPY HANDLING
R ..... SECURITY REPORTING HANDLING
W ..... DISK FILE AND DIRECTORY HANDLING
X ..... DISK FILE COMPRESSION HANDLING
Z; .... RETURN TO MAIN LEVEL
I/O SYSTEM ADMINISTRATION COMMAND <I__>
<

3 Display the menu of the command group


TodisplaythemenuoftheICcommandgroup,forexample,enterC?.
Expected outcome
Forexample,thefollowingmenucanbedisplayed:

COMMAND CALENDAR HANDLING COMMANDS


? ..... DISPLAY MENU
I:...... ADD NEW COMMAND CALENDAR TASK
M: ..... MODIFY COMMAND CALENDAR TASK
D: ..... DELETE COMMAND CALENDAR TASK
L: ..... LIST CALENDAR
T: ..... TEST COMMAND CALENDAR TASK EXECUTION
B: ..... BLOCK OR UNBLOCK COMMAND CALENDAR TASK
S: ..... STOP COMMAND FILE EXECUTION
Z; ..... RETURN TO MAIN LEVEL

COMMAND CALENDAR HANDLING COMMAND <IC_>


<

30 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

4 Enter the command


Completethecommandpartbyenteringthethirdletterofthecommand,forexample
L.
Expected outcome
Theparameterguideandthethreecommandlettersaredisplayed.Belowisthe
parameterguideoftheICLcommand:

/* PARAMETERS:
LISTING PARAMETER:
LISTING FORM;
*/

5 Display parameter guide of the command


Press ENTER todisplayinformationontheparameters.
Expected outcome
Aguidancetextisdisplayedonthescreen,helpingyoutogivetheparameters
correctly.Thefollowingguidegivesinformationontheparametersinthefirst
parameterblockoftheICLcommand:

/* 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 */

6 Enter the parameters


Entertheparameters.

Example:

Forexample,todisplayalltasksinthecommandcalendaronthefirstofJanuary,
2000,enterthedateparameterintheformatYYYY-MM-DD(thesystemguidesyou
asregardstheformifyoupress ENTER ):

ICL:DATE=2000-01-01

Afteryouhaveenteredtheparameter,thesystemnormallyaddsaseparatorand
displaystheparameterguideofthefollowingparameter.Ifthesystemdoesnotadd
theseparator,entertheseparator.Forexample,whenyouareenteringtheICL
command,movetothefollowingparameterblockbyenteringacommaafteryou
haveenteredavaluetothedateparameter.

Issue:09 DN02143068 31

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

Enternowtheexecutiontimesofthecommandcalendartasksyouwishtolist.After
typingHOURS=,press ENTER andthesystemguidesyouasregardsthecorrect
formbydisplayingthefollowingtext:

/* IDENTIFY LISTING EXECUTION TIME:


DECIMAL NUMBER HH ( &,&& )
DEFAULT IS ANY TIME */

Entertheexecutiontime,forexample:

ICL:DATE=2000-01-01,HOURS=1&&3

Enterthefollowingparametersofthecommandinthesamemanner.Enteracolonif
youwishtogivethedefaultvalue.

Afteryouhaveenteredthelastparameterthatthecommandrequires,theexecution
determinationblockisdisplayed:

/* SELECT EXECUTION DETERMINATION OR


SYSTEM NAME OF OUTPUT DEVICE
EXECUTION DETERMINATION:
; .. COMMAND EXECUTION
N .. NO EXECUTION
SYSTEM NAME OF OUTPUT DEVICE:
1 ... 11 CHARACTERS
DEFAULT IS CURRENT DEFINITION */

ICL:DATE=2000-01-01,HOURS=1&3::

7 Execute or cancel the command


Toexecutethecommand,enterasemi-colon(;).
Expected outcome
Executionprintouts,ifthecommandhasany,aredisplayedontheMMLterminalyou
areusing.Afterthecommandisexecuted,thefollowingmessageisdisplayed:

COMMAND EXECUTED
Thesystemmovesyoutothecommandgrouplevel.
Tocancelthecommand,enterNwhentheexecutiondeterminationblockis
displayed.
Thefollowingmessageisdisplayed:

COMMAND IGNORED
Thesystemmovesyoutothecommandgrouplevel.

g Ifyouhavealreadyenteredthesemi-colon(;)toexecutethecommand,you
canattempttoterminatecommandexecutionbyquicklyentering CTRL-Y .

32 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

8 Return to the main level


Toreturntothemainlevel,proceedasfollows:

Ifyouareatthecommandclassorcommandgrouplevel,enterZandasemi-
colon(Z;).
Ifyouhavealreadyenteredoneormoreparameters,firstpress CTRL-X (the
systemmovesyoutothecommandgrouplevel)andthenenterZandasemi-
colon(Z;).

Expected outcome

AfteryouhaveenteredanMMLcommand,anexecutionprintoutisusuallydisplayed,
whichindicatesthatthecommandisbeingexecuted.Theprintoutisnormallydisplayed
onthescreenoftheMMLterminalyouareusing.Iftheexecutionofthecommand
succeeds,themessageCOMMAND EXECUTEDisdisplayed.

Unexpected outcome

Shouldanerroroccur,anerrormessageisdisplayedindicatingthecauseoftheerror.In
addition,aguidanceisdisplayed,tellinghowtheerroneouspartofthecommandshould
bewritten.Youdonothavetore-entertheentirecommand.Insteadyoucancontinue
fromtheerroneouspointonwards.

3.7 Entering MML commands without using the online


help
Purpose

ThisproceduregivesinstructionsonhowtoenterMMLcommandswithoutusingthe
onlinehelp.Whentheuserisexperiencedenough,hecangivethecommandsdirectly
withoutusingthemenuselectionorguidances.Thismakestheworkingefficientand
quick.

1 Enter the command letters and parameters


Whenyouareatthemainlevel,simplytypethethreecommandletters.Ifthe
commandhasparameters,enterthevalues.Forexample:
ICL:DATE=2000-01-01,HOURS=1&&3::
Whenyouareatthecommandclassorcommandgrouplevel,typeZinfrontofthe
command.(YoucanalsotypetheZwhenyouareatthemainlevel,thatis,always
whenyouenteracommand).Forexample:
ZICL:DATE=2000-01-01,HOURS=1&&3::

2 Execute the command


Executethecommandbyenteringasemi-colon(;).

Issue:09 DN02143068 33

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

Expected outcome

AfteryouhaveenteredanMMLcommand,anexecutionprintoutisusuallydisplayed,
whichindicatesthatthecommandisbeingexecuted.Theprintoutisnormallydisplayed
onthescreenoftheMMLterminalyouareusing.Iftheexecutionofthecommand
succeeds,themessageCOMMAND EXECUTEDisdisplayed.

Unexpected outcome

Ifthereisanerrorinthegivencommand,anerrormessageandaguidanceare
displayed,afterwhichtheusercanre-enterthepartthatwaserroneous.

Related topics
Descriptions

MMLcommandexecution

3.8 Repeating or cancelling MML commands

1 Repeat an MML command

1. Pressthe'up'arrowtosearchforacommand
Searchthecommandyouwishtorepeatbypressingthe'up'arrow.
2. Executethecommand
ExecutethecommandbypressingENTERwhenthecommandisdisplayedafter
theprompt.

2 Cancel an MML command


Selectoneofthefollowingalternatives:

InterruptMMLcommandexecution
Whenthesemicolonhasnotbeengiven,butallthecommandparametershave
beentyped,typetheletter'N'.Thusthecommandwillnotbeexecuted,andthe
commandenteringprocedurereturnstothebeginningofthecommandgroupin
question.
Terminatecommandexecution
Toterminatecommandexecution,press CTRL-Y .

Expected outcome

Acommandissuccesfullyrepeatedorcancelled.

34 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

3.9 Moving from one command level to another


Purpose

Youcanusecommandmenustomovefromthemainleveltothecommandclasslevel
and,finally,tosomeofthecommandgroupsinthatcommandclass(forexample,from
themainleveltotheUcommandclassand,finally,totheUScommandgroup).

1 Move from one command level to another


Selectoneofthefollowingalternatives:

Movetothemainlevel
Tomovetothemainlevel,enterZ;.
Movetoacommandclass
Tomovetoanycommandclass,enterZandtheletterofthecommandclassin
question.Forexample,ifyouwanttomovetotheUcommandclass,enterZU.
Movetoacommandgroup
Tomovetoanycommandgroup,enterZandthetwolettersofthecommand
groupinquestion.Forexample,ifyouwanttomovetotheUScommandgroup,
enterZUS.

Further information
Thefollowingfigureillustrateshowtomovefromonecommandleveltoanother.

Issue:09 DN02143068 35

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

Figure 5 Howtomovefromonecommandleveltoanother

Youcanalsomovetothecommandgroupofthecommandthatyouareenteringor
thatyouhavejustenteredbypressing CTRL-X .Ifyouareenteringacommand,this
keyfunctionsonlyifyouhaveenteredatleastthethreecommandlettersofthe
command.

Expected outcome

Youmovesuccesfullytoanothercommandlevel.

3.10 Entering default values to parameters


Purpose

Adefaultvalueisthevaluethesystemgivestoaparameterwhenyoudonotgivea
specificvaluetoit.Someparametersdonothavedefaultvalues,buttheymustalways
begivenaspecificvalue;theseparametersareobligatory.Theparameterguideandthe
syntacticrulesofeachcommandindicatewhichparametersareobligatory.

Adefaultvaluecanalsobeindicatedbyenteringaspecificvaluetoaparameter.Thisis,
ofcourse,amorecomplicatedwaytoindicateadefaultvalue.

Ifyouusetheparameterguide,whentheparameterguideindicatesthatadefaultvalue
canbegiventoaposition-definedparameter,enteracomma(,).

36 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

Ifyoudonotusetheparameterguide,inordertoindicateadefaultvalueofaposition-
definedparameterwhenyoutypeinacommandwithoutusingtheparameterguide,omit
theparametervalue,butleavetheappropriateseparator.

1 Enter default values to position-defined parameters


Selectoneofthefollowingalternatives:

Separatetheparameterfromotherparameters(,)
Ifotherparametersmustbeenteredbeforetheparameterblockends,entera
comma(,)toseparatetheparameterfromtheotherparameters.
Separatetheparameterfromthefollowingparameterblock(:)
Iftheparameterblockendsaftertheparameter,enteracolon(:)toseparatethe
parameterfromthefollowingparameterblock.

Example:Entering default value by giving comma


Omitthevalueofthefirstparameterinthefirstparameterblockbygivingcomma:
ZIID:,OMU:COMCAL;
Example:Entering default value by omitting the values
Omitthevaluesofbothparametersinthefirstparameterblockandleavethe
separator(thecolon):
ZIID::COMCAL;

2 Enter default values to name-defined parameters


Toindicateadefaultvalueofaname-definedparameter,enterthenameofthe
parameter,anequalsignandacomma(forexample,DATE=,).Somecommandslet
youomittheparametername,theequalsignandthecommathatfollowsthe
parameter.
Example:Entering default value by giving comma
Givethedefaultvalues(START=1andSTOP=65000)bygivingcomma:
ZIDL:WDU,0,COMMANDS:START=,STOP=;

Example:Entering default value by omitting the parameters and comma

Omitthevaluesoftheparametersandthecommathatwouldfollowoneofthese
parameters:

ZIDL:WDU,0,COMMANDS:;

Expected outcome

Defaultvalueisgivensuccesfully.

Issue:09 DN02143068 37

UsingMMLcommands ExecutingMMLCommandsinIPA-RNC

3.11 Changing the language of MML command menus


Purpose

ThisproceduregivesinformationonhowtochangethelanguageofMMLcommand
menus.

1 Press CTRL-K
Ifseverallanguagesareinuse,youcanchangethelanguageofcommandmenus
pressing CTRL-K .

Expected outcome

ThelanguageofMMLcommandmenusischanged.

3.12 Setting an MML program in the test state


Purpose

g OnlyfortheuseofMMLprogramdesigners.

Theseinstructionsarenotrelevantinnormaloperationoftheexchange.

1 Press CTRL-4
TosetanMMLprogramintheteststateandtodisplaythehelpprintoutsthatare
usedinthetestingoftheprogram,press CTRL-4 .

2 Press ENTER after each printout

3 Press CTRL-4 for the second time


Whenyoupress CTRL-4 again,theprintoutsofthesemanticscheckaredisplayed.

4 Press CTRL-4 for the third time


Whenyoupress CTRL-4 forthethirdtime,theMMLprogramissetinthenormal
state.

Expected outcome

TheMMLprogramissetintheteststate.

38 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC UsingMMLcommands

3.13 Setting an MML session time-out


Purpose

YoucandefineanidletimelimitforMMLsessionsafterwhichtimethesessionisclosed
automaticallyifthereisnointeractionorcommandexecution.Youcanchangetheidle
timevaluewithtwoMMLcommands,theIAXcommandandtheIAAcommand.The
timelimitcanbedefinedindividuallyforeachuserprofile.Thechangetakesimmediate
effectonyourcurrentsession;otherusersmustreloginbeforethechangeiseffective.
ThevaluerangeoftheMMLsessionidletimelimitis1to60minutes.Thedefaultvalue
is15minutes.

1 Changing the idle time limit


Selectoneofthefollowingalternatives:

Changingtheidletimelimitofyourownprofile(IAX)
ZIAX:<mml_session_idle_time_limit>;
Changingtheidletimelimitofacertainprofile(IAA)
ThelimitischangedusingtheTLIMITparameter.
ZIAA:<profile>::,,,:TLIMIT=<mml_session_idle_time_limit>;

Expected outcome

AnMMLsessiontime-outisset.

Issue:09 DN02143068 39

MMLmacros ExecutingMMLCommandsinIPA-RNC

4 MML macros

4.1 MML macros


AfeatureoftheMMI systemisitsextendedcommand languagewhichenablesthe
usertoprogramcomplexconsecutivetasksbyusingtheexistingMMLcommands.A
taskentity,programmedusingthecommandlanguage,constitutesanMML macro
whichcomprisesprogrammablelogicandMMLcommandsthatareusedinseriesof
specifickinds.MMLmacrosaredisk files,runinteractivelybytheuserinthesystem
andbymeansoftheMMIsystem.

YoucancreateandeditMMLmacros.CertainMMLmacrotypesaresuppliedbyNokia
SiemensNetworksandcannotbeeditedbyusers.

TheplanningofamacroisusuallystartedbygivingitanMMLmacroname.

MMLmacrosareuseful,forexample,whenexecutingcommandsequencesthatneedto
beexecutedrepeatedly.Theycanbeusedtocarryoutmorecomplicatedtasksthandisk
commandfilesbecausetheycontainbothMMLcommandsandprogrammablelogic.
However,unlikediskcommandfiles,theycannotbeexecutedinthecommandcalendar.

MMLmacrosarestoredindiskfiles.SeebelowanexampleofanMMLmacrothat
copiestheneededfilefromthesourcedirectorytothedestinationdirectoryonboth
disks.Notethatthemacrocontainsadescriptiononwhatthemacrodoes.

/* @(#)MID: TSTI1OGE.EMM 1.1-0 00/06/01 */


$I ..... I/O SYSTEM ADMINISTRATION
$1 ..... TEST MACROS
$O ..... COPY FILE FROM SOURCE TO DESTINATION DIR

TSTI1OGE( ?FILENAME, ?EXTENSION, ?SOURCE, ?DEST );

declaration
?FILENAME(10)"
/* GIVE FILENAME TO BE COPIED */
",
?EXTENSION(3)"
/* GIVE EXTENSION OF FILENAME */
",
?SOURCE(10)"
/* GIVE SOURCE DIRECTORY */
",
?DEST(10)"
/* GIVE DESTINATION DIRECTORY */
";

/****************************************************************
*
* This MML macro copies needed file from source directory to
* destination directory on both disks.
*
*****************************************************************
*

40 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

* 1 In case of error continue executing macro


* 2 Only MML macro output's are shown
* 3 When MML requires confirmation automatically use 'Y'
* 4 Set source directory
* 5 Set destination directory
* 6 Copy file from source to destination directory
* 7 If copying fails then output error text
* 8 If copied successfully output text
*
****************************************************************/

on_error continue; /* 1 */
output_off; /* 2 */
on_confirm continue; /* 3 */

IWY:S:PATH=?SOURCE; /* 4 */

IWY:D:PATH=?DEST,DRIVE=WDU-S; /* 5 */

IBC:,,?FILENAME,?EXTENSION; /* 6 */

if error then;
write_term(
NL,
"/*** CANNOT COPY FILE, CHECK INPUT ***/",
NL ); /* 7 */
else;
write_term(
NL,
"/* ",
?FILENAME,
".",
?EXTENSION,
" COPIED SUCCESSFULLY FROM ",
?SOURCE,
" TO ",
?DEST,
" */",
NL ); /* 8 */
fi;

exit;

MMLmacroscanbecreatedandeditedbytheusersofthesystem.Certaintypesof
macrosaresuppliedbyNokiaSiemensNetworks.Thesemacroscannot,however,be
editedbyusers.

MMLmacrosarestoredintheMMDIREdirectoryofsystemandbackupdisks.The
extensionofMMLmacrosisalwaysEMM.

Running MML macros


TheMMLmacrorunmeansthattheuserstartstheMMLmacroontheMMLterminal.

Issue:09 DN02143068 41

MMLmacros ExecutingMMLCommandsinIPA-RNC

TheMMLmacrocanberuninteractivelyonanMMLterminalwhenanMMLsessionis
active.TherearetwobasicwaystorunanMMLmacro:shortstart-upmethodandlong
start-upmethod.Theshortstart-upmethodissimpler.Itcanbeusedasanadditionto
thelongstart-upmethod.

Notethatifyoudonotwriteasemicolon(;)asthelastcharacterinthestartcommand,
theMMIsystemasksyouwhetheryouwishtostarttheMMLmacro.

WhentheMMLmacroisrun,valueshavetobeenteredfortheparametersshownin
headerpartoftheMMLmacroinquestion(seeHeaderinMMLmacros).Thevalues
havetocorrespondtotheparameterdefinitionsintheMMLmacro,whichisnormalor
blockparameter.Theyalsohavetocorrespondtotheparametertype,whichischaracter
stringoraninteger.Entertheparametervaluesintheparameterpresentationorder.

Iftheparameterispresentedasablockparameterinthemacro,besidescharactersthat
areacceptedasvaluesfornormalparameters,acomma(,).

Ifyouentertheparametersinthestartcommand,thefollowingrulesalsoapply:

Whenthelongstart-upmethodisused,theparametervaluesareinbrackets.
Thenormalparametervaluesareseparatedbyacomma.
Asemicolonisusedtoseparateblocks.
Forablockparameter,acolonisusedtoseparatethevalues.
Positiondefinedparametersareenteredintheirblockintheorderindicatedinthe
headerpart.

Differenttypesofparametervaluesareenteredasfollows.Thecharacterstringconstant
isgiveneitherinquotationmarksorwithoutthem.Inacharacter-stringconstantthatis
markedoffwithquotationmarks,allcharactersfromaspacetotherightbracket(ASCII
codevalues20H-7DH),excludingthebracketsitself(22H),areallowed.Ifquotation
marksarenotusedtomarkoffcharacterstrings,aquotationmarkisallowedin
characterstringconstant.However,insuchacase,aspaceandcharacterstring
delimitersforparametervaluesarenotallowed.Anintegerconstantisgivenasan
unsigneddecimal.

TorunanMMLmacrobyusingtheshortstart-upmethod,seetheShortstart-upmethod
forMMLmacros.TorunanMMLmacrobyusingthelongstart-upmethod,seetheLong
start-upmethodforMMLmacros.

Related topics
Instructions

ExecutinganMMLmacro

TestingMMLmacros

InstallingMMLmacros

ListingMMLmacros

DisplayingthecontentsofanMMLmacro

Descriptions

42 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

MMLmacronames

MMLmacrostructure

CommandlanguageexpressionsandstatementsinMMLmacros

ExecutionofMMLmacros

StructuralpartsofthecommandlanguageinMMLmacros

4.2 MML macro names


Thefourth,fifthandsixthcharactertogetherspecifytheMMLmacrosothatitis
unambiguous.ThefourthcharacterindicatestheMMLcommandclassinwhichtheMML
macro groupislocated.ThefifthcharacteristheidentifierfortheMMLmacrogroup.
Theidentifierisanumberbetween1and9.ThesixthcharacterisacommandletterA-Y
whichcanbechosenaccordingtotheMMLmacrotask,forexample,deletionD=delete.

Figure 6 MMLmacronames

TheMMLmacroscreatedbyNokiaSiemensNetworksarenamedinaslightlydifferent
manner.Donotchooseasthenameofyourmacrothecombinationofthefourth,fifth,or
sixthcharacterofanexistingNokiaMMLmacroname.Alsoavoidchoosingthe
combinationofthefourthandfifthcharacterofanalreadyexistingNokiaMMLmacro
name.Inotherwords,avoidputtingyourMMLmacrointhesameMMLgroupwiththe
NokiaMMLmacros.

MML macro group


AgroupofthoseMMLmacroswhosenameshavethesamefourthandfifthlettersand
areshowninthesameMMLmenucompriseanMMLmacrogroup.Normally,macrosin
thesamegrouphavesimilarkindsoftasks.

Related topics
Descriptions

MMLmacros

Issue:09 DN02143068 43

MMLmacros ExecutingMMLCommandsinIPA-RNC

4.3 MML macro structure


Atthehighestorganisationallevel,anMMLmacroiscomposedofthreesections:

anidentificationstring
amenu
aheader,declarationandexecutionpart.

Thethreesectionsareseparatedbymeansofasemicolon(;).

OnthefirstlineoftheMMLmacro,therehastobeanidentifiercharacterstringasa
comment.

/* @(#)MID: OMBI1DGE.EMM 1.1-0 00/01/11 */

TheheaderpartalwayscontainsthenameoftheMMLmacro,eitherwithorwithoutan
extension.Ifthemacrousesparameters,theyarepresentedintheheader.Thedefinition
sectioncontainsthedefinitionsfortheparametersandvariables.Theexecutionpartis
madeupofcommandlanguagestatements.

Related topics
Descriptions

MMLmacros

StructuralpartsofthecommandlanguageinMMLmacros

MenutextsinMMLmacros

HeaderinMMLmacros

DeclarationandexecutionpartsinMMLmacros

4.4 Structural parts of the command language in MML


macros
Thefollowingstructuralpartsbelongtothecommandlanguage:

linestructure
characters
identifiers
keywords
constants
operators
comments

44 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Line structure
Thelinestructureofcommandlanguageisfree.Thereneedbenocorrespondence
betweenthelogicalstructureofthelanguageandthestructureoftheline.However,it
wouldbesensibletomodelthestructureafterthedifferentpartsoftheprogramby
employinglinefeeds,emptylines,blankspacesandindentations.Thecommand
languagespecificationsdonotsetanupperlimitforlinelength,butwerecommendthat
alinecontainnomorethan70characters.

Characters
Thecommandlanguageusesthefollowingcharacters:

capitallettersfromAtoZ
lower-caselettersfromatoz
cardinalnumbersfrom0to9
emptyspace,tabulator,linefeed
thespecialcharacters()+-*/=<>,:;"?$_

Inaddition,character-stringconstantsmayalsocontainothercharactersthatarefound
inthecharactersetofacomputer.

Identifiers
ThefollowingrulesgoverntheuseofidentifiersthatareemployedasnamesforMML
macros,parameters,variables,subprogramsandreferences:

Anidentifiermaycontaincapitalletters(A-Z),underlinecharacters(_)andnumbers
(0-9).
Anidentifieralwaysstartswithaletter.
ThemaximumlengthofidentifiersotherthanthenamesofMMLmacrosis10
characters,allofwhicharesignificant.
TheidentifiersusedinanMMLmacrowhicharenotMMLmacronamesarespecific
tothemacroinquestion.
AnMMLmacromustnotcontaintwoormoreidenticalidentifiersthatareusedfor
differentpurposes.
Theremustalwaysbeaquestionmark(?)infrontoftheidentifierforaparameteror
variable.

Keywords
Anunaccompaniedkeywordcanonlybeusedincontextsandwithmeaningspresented
inthespecificationsofthecommandlanguage.Keywordsarewritteninlower-case
lettersandtheyare(pleasenotethatallkeywordsarenotnecessarilyinuse,instead,
theyarereservedforapossiblefutureuse):

if and
then xor
else or
fi not

Issue:09 DN02143068 45

MMLmacros ExecutingMMLCommandsinIPA-RNC

while
end declaration
numeral
goto
label on_error
gosub on_confirm
subrou ask
retsub continue
call exit
return error
dstr_to_num echo_on
num_to_dstr echo_off
hstr_to_dstr output_on
output_off
read_term trace_on
write_term trace_off

currentstr readstr
currentln partstr
prevln
nextln delay
set_def_buffer wait

Constants
Thecommandlanguagerecognisesinteger-stringandcharacter-stringconstants.

Anintegerconstantiswrittenasanunsignedstringofnumbers,whichmeansthatthe
constantisalwayspositive.Theintegerrangeis0...4294967295.Theintegermaybe
givenasaconstanteitherintheformofadecimalnumber,suchas17,orahexadecimal
number,inwhichcasethefigurealwaysbeginswithazero(0)andendswiththeletter
H,asin01BH.Inahexadecimalnumber,onlycapitallettersareallowed.

Thecharacter-stringconstantsaremadeupofcharactersgivenbetweenquotation
marks("),e.g."0B&12".Thecharactersallowedintheconstantsrangefromthespace
(20H)totherightbracket(7DH),excludingthequotationmark(22H)itself.Themaximum
lengthofthecharacter-stringconstantisthemaximumlengthofthecharacter-string
variable.

Operators
Thecommandlanguageusesarithmetic,logical,andcomparativeoperators.

Thearithmeticoperatorsare:+(addition),-(subtraction),*(multiplication),and/
(division).Arithmeticoperatorsareonlyapplicabletopositiveintegeroperands,andthe
resultisalwaysaninteger.Thereisoneexception:anadditionwherebothoperandsare
characterstrings,forexample,theresultoftheexpression"A"+"BC"is"ABC".Also,it
shouldbenotedthatadivisionoperatorbreaksofftheinteger,forexample,thevaluefor
theexpression7/3is2.

Thelogicaloperatoris'not'(NOoperation).Theoperandsoflogicaloperatorsmustbe
positiveintegers.

46 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Thecomparativeoperatorsare:<(lessthan),<=(lessthanorequalto),>(greaterthan),
>=(greaterthanorequalto),<>(doesnotequal),and=(equals).Theoperandsof
comparativeoperatorsmustbepositiveintegers;however,incomparisonsinvolvingthe
lasttwooperators('doesnotequal','equals'),theoperandscanalsobecharacter
strings.

Comments
Acommentstartswiththecharacterpair/*andendswiththepair*/.Acommentmaybe
continuedfromonelinetoanother,butinsideofacommentnoothercommentis
allowed.

Related topics
Descriptions

MMLmacros

4.5 Menu texts in MML macros


IftheMMLmacroisnotmeantforapackagewhichcontainsspecificoldprogram
versionsandyouwishtorunthemacrowith,whatisknownas,theshortstart-up
method,themenutextshavetoberightatthebeginningoftheMMLmacro.

AmenutextonalineofitsowncorrespondstothreecharactersoftheMMLmacroshort
start-upmethodcommand.Thecommandcharactersarethesameascharacters4-6of
theMMLmacro.Themenulinestartswiththe($)characterwhichisfollowedbya
commandcharacter.

ExampleofanMMLmacromenutext:

$X .... MML COMMAND CLASS X MENU TEXT


$N .... MML COMMAND GROUP N MENU TEXT
$Y .... MML MACRO COMMAND Y MENU TEXT
MML MACRO HEADER
...

Related topics
Descriptions

MMLmacros

4.6 Header in MML macros


Structure
TheheaderofanMMLmacroiscomposedofthemacro'sidentifier-itsnamewithout
theextension-andoftheparameters,ifany,presentedinbrackets(theparameterlist).
Theheaderendswithasemicolon(;).

Issue:09 DN02143068 47

MMLmacros ExecutingMMLCommandsinIPA-RNC

Allparametersareposition-defined.Parametersareseparatedbyacomma(,),while
parameterblocksaredelimitedbymeansofacolon(:).Ifonlyoneparameteris
presentedinaparameterblock,theparameteroftheblockinquestionisinterpretedasa
blockparameter.ThefollowingfigurepresentsanexampleofthestructureofanMML
macroheader.

Figure 7 AnexampleofthestructureofanMMLmacroheader

Position-defined parameters
Thepresentationofaposition-definedparameterbeginswithaquestionmark(?),
followedimmediatelybytheparameter'sidentifier(parametername).Thepresentation
endswithacomma,colon,orrightbracket.

Block parameter
Ifthepresentationofaparameterendswithacolonorrightbracket,andifitistheonly
parameterintheblock,itisablockparameter.Thedifferencebetweenanormalanda
blockparameteristhatthelatteralwaysacceptsacomma(,)asacharacter,inaddition
toalltheothercharactersthatnormalparametersacceptastheirvalues.Thisiswhy
greatcareshouldbetakenwhenusingblockparameters,inordertoavoidentering
invalidparametervalues.Ablockparametercanonlybeofcharacterstringtype.

Related topics
Descriptions

MMLmacros

4.7 Declaration and execution parts in MML macros


Declaration of parameters and variables
AllparametersandvariablestobefoundinanMMLmacromustbespecifiedinthe
declarationpart,whichissituatedinthemacroaftertheheaderandbeforetheexecution
part.Thedeclarationpartbeginswiththekeyword'declaration'andendswitha
semicolon(;).Thepartconsistsofdeclarativestatements,eachofwhichdefinesone
parameterorvariable.Thestatementsareseparatedwithcommas(,).Parametersare
declaredbeforevariables.

48 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Inthedeclarativestatement,theparameterorvariableidentifierisimmediatelypreceded
byaquestionmark(?).Aftertheidentifier,theparameterorvariabletypemayfollowin
brackets.Astypedefinition,thechoiceisbetweenthekeyword'numeral'andaninteger
constant.

Ifthekeyword'numeral'isplacedinbrackets,theparameterorvariableisoftheinteger
type(DWORD),witharangeof0...4294967295.If,however,thebracketscontainan
integerconstantwithinarangeof1...223,thentheparameterorvariableisdeclaredto
beoftypecharacterstring,andtheconstantindicatesthestring'smaximumlength.The
defaultparameterandvariabletypeisacharacterstringupto40characterslong.

Finally,theremaybeinaparameterdeclaration,inparentheses("),aninstructionwitha
maximumlengthof2000characters.Ifnoinstructionhasbeendefinedforaparameter,it
isreplacedbytheparameter'sidentifier.Noinstructionsaredefinedforvariables.

declaration
/* Parameters */

?FILE_NAME( 15 ) "/* FILE NAME, MAX 15 MARKS */", /* string length 15 */

?SOURCE "
/* GIVE SOURCE DIRECTORY */", /* string length 40 */

?DEC_NUMBER( 30 ), /* string length 30 */

/* Variables */

?INDEX1( numeral ), /* numeral dword */


?VALUE1, /* string length 40 */
?VALUE2( 50 ); /* string length 50 */

Execution part
ItisthefunctionoftheexecutionpartofanMMLmacrotoprocessdataandtoexecute
tasksorseriesoftasksbymeansofacommandlanguagetranslator.Theexecutionpart
containscommandlanguagestatements,whichcanbesimpleorstructured.The
statementsendinasemicolon(;).Emptystatementswhichonlyincludeasemicolonare
notallowed.

Related topics
Descriptions

MMLmacros

Issue:09 DN02143068 49

MMLmacros ExecutingMMLCommandsinIPA-RNC

4.8 Command language expressions and statements in


MML macros
Commandlanguageisalanguagemadeupofstatementswithanunambiguous
structureandmeaning,readbytheMMIsystem'sinternalinterpreter,anddevelopedby
NokiaSiemensNetworks.IntheMMLsession,itsisalsopossibletorunMMLmacrosby
usingtheextendedcommandlanguage.

Acommandlanguageexpressionisaformula.Whenthevaluefortheformulais
calculated,thetruevalues,atthetimeofexecution,ofalltheconstantsandvariablesin
theformulaareused.Thevaluesforthevariablesdonotchangeduringthecalculation
asatthatpointtheirvaluesareonlyretrieved.

Anexpressionmaybenothingmorethanaconstantorvariable.Inexpressions,no
bracketcharactersareallowed.

Thedifferentoperandtypesallowedindifferentcommandlanguageexpressionsandthe
variousoperatorsareasfollows:directives,stopstatements,inputandoutput
statements,placementstatements,if-statements,while-statements,MMLcommand,
libraryroutinesandexitstatements.

Related topics
Descriptions

MMLmacros

4.9 Directives in MML macros


Commandlanguagedirectivesareinstructionsforthebenefitofthetranslator,indicating
adeviationintheexecutionpartofanMMLmacrofromthenormalprocedure,ora
returntoit.Directivesareusedtocontrolerrors,MMLcommandconfirmationrequests,
toadministrateexecutionmessagesandtofacilitatethetestingoftheMMLmacros.

Errors
Whenerrorsoccuranon_errordirectiveandanerrorflagareused.Whentheerrorflag
isset,themacroexecutionends,orcontinuesaccordingtothevaluefortheon_error
directive.Iftheon_errordirectivehasnovalue,themacroexecutionends.

Theon_errordirectivemustcontainaparameter.Thefollowingkeywords(values)are
usedassuchparameters:

exit theexecutionoftheMMLmacroisdiscontinuedandtheprocess
returnstothecalllevelofthemacroinquestion.

continue theexecutionofthemacroisresumed.

50 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

ask theuserisaskedwhethertheexecutionoftheMMLmacrois
continued(continue)ordiscontinued(exit).

Thedefaultvaluefortheon_errordirectiveisexit.Theuseofthedirectivestartswiththe
directiveon_erroritself,followedbyatleastonespaceandoneparameter.

Theerrorflagisset(to1)whentheoutputstatement,acertaincommandlanguage
routine,oranMMLcommandexecutionfails,otherwiseitsvalueis0aftertheexecution
ofacommandlanguagestatement.Thesettingoftheerrorflagisascertainedbeforethe
executionofeverycommandlanguagestatement;iftheflagisset,thenthecurrentvalue
fortheon_errordirectivedictateswhatfollows.

Exampleoftheuseoftheon_errordirectiveisasfollows:

on_error continue;
:
IBC:,,?FILENAME,?EXTENSION;
if error then;
write_term(NL,"/*** CANNOT COPY FILE ***/");
fi;
:

MML command confirmation


Theon_confirmdirectiveisusedtohandleMMLcommandswhichrequestaconfirm
beforethecommandexecution.Theon_confirmrequiresaparameter.Thefollowing
keywords(values)areusedasparameters:

ask Theprogramaskstheuserforaconfirmationofthecommand
execution(YorN):

thecommandisconfirmed(Y),inwhichcasetheuserisasked
whethertheprogramshouldstopateveryfollowingconfirmation
request,orwhethertherequestsareautomaticallyansweredY.
thecommandhasnotbeenconfirmed(N)sothatwhen
confirmationisrequested,theproceduresforvalue'ask'are
followed.

continue Thecommandisautomaticallyconfirmed(Y)withoutstoppingor
echoingtheconfirmationrequest.

Bydefault,thevaluefortheon_confirmdirectiveis'ask'.Theuseofthedirectivestarts
withthedirectiveon_confirm,whichisfollowedbyatleastonespaceandaparameter.

Exampleoftheuseoftheon_confirmdirectiveisasfollows:

on_confirm ask;
:
IWI::F0,DRIVENAME,,,PR:;
:

Issue:09 DN02143068 51

MMLmacros ExecutingMMLCommandsinIPA-RNC

Execution message
Thedirectivesoutput_onandoutput_offareusedtocontroltheexecutionmessagesof
theMMLcommandsandtheirdisplayontheterminal.Withtheoutput_ondirective,the
messagesaredisplayedontheterminal,whilewiththeoutput_offdirective,theyarenot.
Thedefaultisoutput_on.Bothdirectivesareusedwithoutparameters.

Exampleoftheoutput_onandoutput_offdirectivesisasfollows:

output_off;
USI:ALL;
:
output_on;
IBC:,,?FILENAME,?EXTENSION;
:

Echoing
Thedirectivesecho_onandecho_offareusedtoechocommandlanguagestatements.
Echoingisactivatedwiththeecho_onanddeactivatedwiththeecho_offdirective,the
latterbeingthedefault.Bothdirectivesareusedwithoutparameters.

Exampleoftheecho_onandecho_offdirectivesisasfollows:

:
echo_on;
set_def_buffer(2);
currentstr("AS.");
if error then;
?VALUE = "";
else;
?VALUE = readstr(4);
?VALUE = "AS=" + ?VALUE;
?VALUE = ?VALUE + ",";
fi;
echo_off;
:

Echoing and stopping


Thetrace_onandtrace_offdirectivesareusedbothtoechocommandlanguage
statementsandtostoptheirexecutionaftereachstatement.Thisfacilityisactivated
usingthetrace_ondirective,anditisdeactivatedusingthetrace_offdirective,whichis
alsothedefault.

Exampleofthetrace_onandtrace_offdirectivesisasfollows:

:
trace_on;
IAI:PROFILE=:;
?EXIT = "0";
while ?EXIT = "0";
set_def_buffer( 1 );
nextln( 4 );
currentstr( "PROFILE NAME:" );

52 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

if error then;
?EXIT = "1";
else;
?TEMP_STR = readstr( 2 );
?P_NAME = partstr( 1,10, ?TEMP_STR );
set_def_buffer( 2 );
IAA:?P_NAME:::TLIMIT=15;
fi;
end;
trace_off;
:

Related topics
Descriptions

MMLmacros

4.10 Stop statements in MML macros


TheexecutionofMMLmacroscanbestoppedbyusingeitherthedelayorthewait
statement.

ThedelaystatementstopstheexecutionofanMMLmacroforagivenperiodoftime.
Thestatementbeginswiththekeyword'delay',whichisfollowedbythedtimein
brackets:anintegerconstantindicatingamultipleof10ms.

ThewaitstatementproducesthetextCR,LF,"PRESS ANY KEY TO


CONTINUE",CR,LF,CR,LFandtheexecutionoftheMMLmacroisstoppeduntilthe
userpressesanykey.Thestatementonlycontainsthekeyword'wait'.

Exampleoftheuseofstopstatementsisasfollows:

:
IBC:,,?FILENAME,?EXTENSION;
if error then;
write_term( NL, "/*** CANNOT COPY FILE ***/", NL );
wait;
fi;
:

Related topics
Descriptions

MMLmacros

Issue:09 DN02143068 53

MMLmacros ExecutingMMLCommandsinIPA-RNC

4.11 Input and output statement in MML macros


Theread_termandwrite_termkeywordsarereservedfortheinputandoutputfunctions.
Thevalueforavariableisreadbymeansoftheread_termstatement,whilethe
write_termstatementisusedtooutputthevaluesforconstantsorvariables.

Theinputstatementbeginswiththekeywordread_termwhichisfollowedbythe
variables,placedinbracketsandseparatedonefromtheotherbyacomma.The
variablesareofthecharacterstringtype,andinoneinputstatementtheremaybeupto
fivevariables.

Exampleofaninputstatementisasfollows:

:
write_term( NL, "GIVE SOURCE DIRECTORY: " );
read_term( ?SOURCE );
write_term( NL, "GIVE DESTINATION DIRECTORY: ", NL );
read_term( ?DEST );
:
Which produces the text:

GIVE SOURCE DIRECTORY: MMDIRE


GIVE DESTINATION DIRECTORY:
BLCODE

Write_termbeginsanoutputstatement.Thenfollow,inbrackets,theparametersthatare
tobedisplayed:character-stringvariables,characterstringconstants,orpairsofthe
charactersNL.One"NL"pairwillgenerateacarriagereturn(CR)andalinefeed(LF)in
theoutput.Atleastoneparameterisrequired,andparametersareseparatedwitha
comma.Oneoutputstatementiscapableofoutputtingupto511characters.Ifanerror
occursintheexecutionoftheoutputstatement,anerrorflagissetandtheexecutionof
theMMLmacroisinterruptedunlessotherwisedefinedwiththeon_errordirective.

Exampleofanoutputstatementisasfollows:

?VARIABLE1 = "NUMBER ANALYSIS";


:
write_term(NL,"/*** ERROR IN CREATING ",?VARIABLE1," ***/",NL);
if error then;
:
which produces the text:

/*** ERROR IN CREATING NUMBER ANALYSIS ***/

Related topics
Descriptions

MMLmacros

54 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

4.12 Placement statement in MML macros


Acommandlanguageplacementstatementhasthreeparts:thefirstisalwaysavariable,
thentheplacementoperator,thatis,the"equals"sign(=),thenanexpression.Thevalue
fortheexpressioniscalculatedpriortoplacement.Theplacementstatementcancontain
thefollowingitems:

anoperand(ifany)precedingthenot-operator
operand,operatorandoperand
libraryroutine.

Theoperandcanbeavariableoraconstant.

Related topics
Descriptions

MMLmacros

4.13 If-statement in MML macros


Anif-statementisusedinMMLmacroswhenadecisionneedstobemadeconcerninga
certainaction,orwhenachoicehastobemadebetweentwoalternativefunctions.The
if-statementisstructured,anditconsistsofthefollowingcomponents:the'if'part,
statement(s),the'else'part(ifany),andtheendpartoftheif-statement.

Theif-statementbeginswiththekeyword'if',followedbyanexpression,andthenthe
keyword'then'.Thiswholeconstitutesthe'if'partoftheif-statement,anditendswitha
semicolon.Theexpressionsofthe'if'partaretheoperand,thecomparativeoperandand
operand.Theoperandcanbeavariableoraconstant.Theexpressionofthe'if'partcan
alsobeanerrorflag(seeDirectivesinMMLmacros)withthevalue1(errorflagset)or0.
Afterthe'if'part,therefollowsastatementorstatements(a),whichinturncanbe
followedbythekeyword'else'andasemicolon.Ifthe'else'isnotinuseintheifclause
concerned,theifclauseisended.If'else'isused,itisfollowedbyastatementor
statements(b),andthencomestheendingoftheif-statement.Anif-statementendswith
thekeyword'fi'andasemicolon.

Theif-statementfunctionsasfollows.Ifthevaluefortheexpression(theifcondition)is
true,thenthestatements(a)followingthekeywordareexecutedbeforemovingtothe
statementthatfollowsthe'fi'keyword.If,however,thevaluefortheconditionisfalse,
whatfollowsdependsonwhethertheif-statementcontainsan'else'part.Ifitdoes,the
statements(b)followingthe'else'wordareexecutedandtheprocessmovestothe
statementfollowingthe'fi'word.Ifitdoesnot(containanelsepart),thentheprocess
goesdirectlytothestatementafter'fi'.

Notethatinnestedif-statements,the'else'and'fi'keywordsalwaysrefertothenearest,
preceding'if'wordthatisyettofindan'else'or'fi'partforitself.Inonenestedstructure,
theremaybeupto20if-statementsandwhile-statements.

Issue:09 DN02143068 55

MMLmacros ExecutingMMLCommandsinIPA-RNC

Exampleofanif-statementisasfollows:

:
IBC:,,?FILENAME,?EXTENSION;
if error then;
write_term( NL, "/*** CANNOT COPY FILE ***/", NL );
else;
if ?EXTENSION = "TXT" then;
?TMP_STR = "TEXTFILE ";
else;
if ?EXTENSION = "IMG" then;
?TMP_STR = "IMAGE ";
else;
?TMP_STR = "FILE ";
fi;
fi;
write_term( NL, "/* ", ?TMP_STR, ?FILENAME, ".", ?EXTENSION,
" IS COPIED SUCCESSFULLY FROM ", ?SOURCE, " TO ",
?DEST, " */", NL );
fi;
:

Related topics
Descriptions

MMLmacros

4.14 While-statement in MML macros


Awhile-statementisused,inanMMLmacro,forprogrammingloopsthatrepeatthe
executionofapartstatement.Awhile-statementisstructuredandconsistsofacondition
part,partstatements,andanending.

Thewhile-statementbeginswiththekeyword'while',followedbyanexpressionanda
semicolon:thisistheconditionpart.Theexpressionsofthe'if'partareoperand,
comparativeoperandandoperand.Theoperandcanbeavariableoraconstant.After
theconditionpartcomesastatementorstatements(a),followedbythekeyword'end'
andasemicolon.

Awhile-statementfunctionsasfollows.Thevaluefortheconditionpart'sexpressionis
calculatedfirst.Ifthevaluefortheexpression(condition)istrue(otherthanzero),the
statementsdelimitedbytheconditionpartanditsnearestsubsequentendwordare
executed;thissequenceisrepeateduntilthevaluefortheconditionisfalse.Whenthe
valueisfalse(zero),thestatements(a)arenotexecuted,andthestatementcomingafter
thekeyword'end'istakenupnext.

Notethatinnestedwhile-statements,the'end'wordalwaysreferstothenearest
preceding'while'wordthathasyettofindanendtoitswhile-statement.Inonenested
structure,theremaybeupto20if-statementsandwhile-statements.

56 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Exampleofawhile-statementisasfollows:

IAI:PROFILE=:;
?EXIT = "0";
while ?EXIT = "0";
set_def_buffer( 1 );
nextln( 4 );
currentstr( "PROFILE NAME:" );
if error then;
?EXIT = "1";
else;
?TEMP_STR = readstr( 2 );
?P_NAME = partstr( 1,10, ?TEMP_STR );
set_def_buffer( 2 );
IAA:?P_NAME:::TLIMIT=15;
fi;
end;

Related topics
Descriptions

MMLmacros

4.15 MML commands in MML macros


TheMMLcommandscontainedintheMMLmacrosmustbecommandsinuseinthe
targetsystem.TheMMLcommandparameterblocks,parameters,orpartsof
parametersmaybesubstitutedwithparametersorvariablesdefinedfortheMMLmacro
inquestion.IfanerroroccursintheexecutionofanMMLcommand,anerrorflagisset,
andbydefault,themacroexecutionisinterrupted.Thefollowingisanexampleofan
MMLcommandwhichisusedtooutputthenumberdataonasubscriberasahidden
remotesessioninthesystemidentifiedbythevalueforthe?HOST_NAMEparameter.

ExampleofanMMLcommandinanMMLmacroisasfollows:

:
IBC:,,?FILENAME,?EXTENSION;
if error then;
:

Related topics
Descriptions

MMLmacros

Issue:09 DN02143068 57

MMLmacros ExecutingMMLCommandsinIPA-RNC

4.16 Library routines in MML macros


Thecommandlanguagelibrarycontainsroutinesthatareusedforbothmodifyingand
readingtheMMLmacroparametersandvariables,andforcontrollingandreadingthe
executionmessagesofMMLcommands.TheroutinesareinuseinallMMLmacros
withoutanyspecificpredefinitions.

From character string to integer


Thefunctiondstr_to_numisusedtoconverttheASCIIcodednumbersinacharacter
stringtoanintegerinavariableofthenumeraltype.Thecharacterstringisavariableor
aconstant,anditisunderstoodtocontainadecimal-codedfigurethatmayendinthe
letterD.Ifanerroroccursintheexecutionoftheroutine,anerrorflagissetand,by
default,themacroexecutionisendedunlessotherwisespecifiedwiththeon_error
directive.

Thefunctionstartswithanumeraltypevariablewhichisfollowedbytheplacement
operator(=),thenthekeyworddstr_to_num,then,insidebrackets,comesthetargetof
theconversion,acharacter-stringconstant,oracharacterstringvariablefoundinsidea
characterstring.

Exampleofdstr_to_numisasfollows:

?STR_VAR = "25";
?NUM_VAR = dstr_to_num(?STR_VAR);

From integer to character string


Thefunctionnum_to_dstrisusedtoconvertanintegertoanASCIIcodeddecimalfigure
inavariableofthecharacterstringtype.

Thefunctionstartswithacharacterstringtypeofvariable,followedbytheplacement
operator(=),thekeywordnum_to_dstr,andfinally,inbrackets,theobjectofthe
conversion,theintegervariableorconstant.

Exampleofnum_to_dstrisasfollows:

?NUM_VAR = 25;
?STR_VAR = num_to_dstr(?NUM_VAR);

From hexadecimal character string to decimal string


Thefunctionhstr_to_dstrisusedtoconvertanASCIIcodedhexadecimalfiguretoan
ASCIIcodeddecimalfigureinavariableofthecharacterstringtype.Thestringtobe
convertedmayonlycontainnumbersinhexadecimalcodeanditmayendintheletterH.
Ifanerroroccurs,anerrorflagissetand,bydefault,themacroexecutionendsunless
otherwisedefinedwiththeon_errordirective.

Theuseofthefunctionbeginswithacharacterstringtypeofvariable,followedbythe
placementoperator(=),thenthekeywordhstr_to_dstr,thenthetargetoftheconversion,
acharacter-stringvariableorconstant,placedinbrackets.

58 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Exampleofhstr_to_dstrisasfollows:

?HEX_STR = "1A";
?DEC_STR = hstr_to_dstr(?HEX_STR);

Part of character string into character-string variable


Thefunctionpartstrisusedtoreadacertainpartofacharacterstringfortheuseofa
character-stringvariable.

Theuseofthefunctionbeginswithavariableofthecharacterstringtype,afterwhich
followstheplacementoperator(=),thenthekeywordpartstr,followedbytheparameters,
inbracketsandseparatedbycommas.Therearealwaysthreeparameters:theindexof
thefirstcharacterofthecharacter-stringvariabletoberead,givenasanintegerconstant
orvariable(1=firstcharacter,2=secondcharacteretc.),anintegerconstantorvariable
indicatingthenumberofcharacterstoberead,andthecharacter-stringvariableor
constantthatistoberead.Iftheindexforthefirstcharacterisgreaterthanthelengthof
thecharacterstringtoberead,thenthefunctiondoesnothing.If,ontheotherhand,the
numberofcharacterstobereadoutstripsthelengthofthecharacterstringtoberead,
thenthereadingstopsonthelastcharacterofthestringinquestion.Thefunctiondoes
notcheckthelengthofthecharacter-stringvariableforwhichthecharactersareread.

Exampleofpartsrtrisasfollows(thecharacterstringLMNOisreadforthevariable
MARKS):

?CHAR_COUNT = 4;
?WHOLE_STR = "ABCDEFGHIJKLMNOPQ";
?MARKS = partstr(12,?CHAR_COUNT,?WHOLE_STR);

Setting the output buffer


Theroutineset_def_buffersetsthedefaultbufferintowhichthenceforththeexecution
messagesoftheMMLcommandsarewritten,andwhichistheobjectofallofthebuffer's
readfunctions.

Thedefaultisthatoutputbuffernumber1isvisible,i.e.thereisnoneedforthisroutineif
thereisnoneedtosavetheexecutionmessageofanentireMMLcommand.Theset
defaultbufferremainsvisibleuntilthisroutineisusedtosetanotheroutputbufferasthe
default.ThemaximumnumberofbuffersinuseinanyoneMMLmacroistwo,numbers
1and2,whichmeansthatitispossibletosavethemessagesofoneMMLcommand.

Theoutputbuffershavetheirownpointers,pointingtothestartoftheMMLmacro's
outputbufferswhenthestatementofthatmacro'sfirstexecutionpartisbeingrealised.
Thevaluesforthepointersaremodifiedwhenthelibraryroutinesareusedthathandle
bufferpointers(seethedescriptionsofsaidroutines).

Theroutineisusedbyfirstenteringthekeywordset_def_buffer,followed,inbrackets,by
thenumberofthebufferasanintegerconstant,ortheintegervariablecontainedinthe
numberofthebuffer.

Exampleofset_def_bufferisasfollows:

?BUFF_NRO = 1;
set_def_buffer(2); /* store execution printout of */
USI:ALL; /* USI-command */

Issue:09 DN02143068 59

MMLmacros ExecutingMMLCommandsinIPA-RNC

set_def_buffer(?BUFF_NRO);
IBC:,,?FILENAME,?EXTENSION;
:
set_def_buffer(2); /* USI printout is handled in */
/* next statements

Reading the output buffer


Thefunctionreadstrisusedtoreadacertaincharacterstringfromtheoutputbuffer,
whichistobeplacedinacharacterstringtyperoutinemovesthepointerforwardthe
numberofcharactersindicatedbyagivenparameter,thenstartstoreadthecurrent
characterstringpointedtobythebuffer'spointer,provideditisnotaseparatorof
characterstrings.Aspace,atabulator,andalinefeedaresuchseparators.Whenthe
functioniscompleted,thepointerofthebufferpointstothebeginningofthecharacter
stringjustread.Ifanerroroccurs,anerrorflagissetand,bydefault,themacro
executionendsunlessotherwisespecifiedbytheon_errordirective.

Sincetheseparatorsdonotbelongtothereadablecharacterstrings,forexample,the
linefeedidentificationintheMMLmacrohastobeplannedseparately,ifrequired.

Thefunctionisstartedwithacharacter-stringvariable,followedbyaplacementoperator
(=),thenthekeywordreadstrandanintegerconstantorvariable,inbrackets.

Inthefollowingexample,thereisasearchforthestringDMCU,startingfromtheposition
pointedtobytheoutputbuffer'spointer,andwhenfound,thenextcharacterstringis
readasthevaluefortheSTR_VARvariable.

Exampleofreadstrisasfollows:

currentstr("DMCU");
?STR_VAR = readstr(1);

Notealsotheexampleofnextln,whichisasfollows:

currentstr("OMU-0");
?OMU_STATE = readstr(3);
nextln(1);
?UNIT2 = readstr(0);
currentstr("TOTAL");
prevln(2);
?LAST_STATE = readstr(2);
currentln;

Buffer pointer to start of character string


Theroutinecurrentstrisusedtosetthepointerofanoutputbuffersothatitpointstothe
startofagivencharacterstring,ifthebuffercontainssuchastring.Theroutinesearches
forthestring,enteredasaparameter,beginningfromthecurrentpositionpointedtoby
theoutputbuffer'spointer,andendingwiththelastcharacterinthebuffer,ifnotsooner.If
thegivenstringisnotfound,thepointerremainsstationary.Ifanerroroccursinthe
executionoftheroutine,anerrorflagissetand,bydefault,themacroexecutionends
unlessotherwisedefinedbytheon_errordirective.

60 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Theuseoftheroutinestartswiththekeywordcurrentstr,followed,inbrackets,bythe
requestedcharacter-stringconstant,oracharacterstringvariablecontainingthestringin
question.

TheexampleinthefollowingfigureisofasearchforthefirstFLTYstringinanexecution
messageoftheUSIcommand.

Exampleofcurrentstrisasfollows:

USI:DMCU;
currentstr("FLTY");

Buffer pointer to start of line


Theroutinecurrentlnsetsthepointerofanoutputbuffertopointtothebeginningofits
currentline.

Whentheroutineisused,thestatementonlycontainsthekeywordcurrentln.

Inthefollowingexample,thestringOMUissearchedforandthebuffer'spointerissetto
thebeginningofthelinethatcontainsthesaidstring.

Exampleofcurrentlnisasfollows:

currentstr("OMU");
currentln;

Buffer pointer back


Theroutineprevlnmovesthepointeroftheoutputbufferfromitscurrentlinebackwards
asmanylinesasspecifiedbyaparameterandleavesitatthestartofthenewline.An
errorflagisset,ifanerroroccursand,bydefault,themacroexecutionendsunless
otherwisedefinedbytheon-errordirective.

Theroutinebeginswiththekeywordprevlnwhichisfollowedbyapairofbrackets
containingthenumberoflinesasanintegerconstant,orgivenbymeansofaninteger
variable.

Exampleofprevlnisasfollows(thestringDMCUissearchedandthepointerismoved
twolinesback):

?LINE_COUNT = 2;
currentstr("DMCU");
prevln(?LINE_COUNT);

Buffer pointer forward


Theroutinenextlnisusedtomovetheoutputbuffer'spointerfromitscurrentlineforward
asmanylinesasspecifiedbyaparameterandleaveitatthestartofthenewline.Ifan
erroroccurs,anerrorflagissetand,bydefaultexecutionendsunlessotherwisedefined
bytheon_errordirective.

Theroutinebeginswiththekeywordnextlnwhichisfollowedbyapairofbrackets
containingthenumberoflinesasanintegerconstant,orgivenbymeansofaninteger
variable.

Issue:09 DN02143068 61

MMLmacros ExecutingMMLCommandsinIPA-RNC

ThefollowingisanexampleofhowanexecutionmessageoftheUSIcommandis
handledbythevariouslibraryroutines:thestateoftheOMUisreadintothevariable
OMU_STATE,thenameofthenextreadintothevariableUNIT2,andfinallythestateof
theunitthatisbottomontheunitlistisreadintothevariableLAST_STATE,andthe
pointeristhenmovedtothestartofthelineinquestion.

ExampleofanexecutionmessagefortheUSIcommand.

WORKING STATES OF UNITS


UNIT PHYS LOG STATE INFO
OMU-0 0000H 4002H WO-EX -
OMU-1 0001H 4002H TE-EX -
DMCU-0 > WO-EX -
DMPG-0 > 0002H 4012H WO-EX -
DSP-0 WO-EX -
DSP-1 WO-EX -
TBU-0 WO-EX RBAN
TOTAL OF 7 UNITS
FAULTY UNIT 0
INCORRECT STATES 0

Exampleofnextlnisasfollows:

currentstr("OMU-0");
?OMU_STATE = readstr(3);
nextln(1);
?UNIT2 = readstr(0);
currentstr("TOTAL");
prevln(2);
?LAST_STATE = readstr(2);
currentln;

Related topics
Descriptions

MMLmacros

4.17 Exit statements in MML macros


TheexecutionofanMMLmacroisterminatedwithastatementthatonlycontainsthe
keyword'exit'.Thisstatementneednotbethelaststatementoftheexecutionpartofthe
MMLmacroinquestion.AnMMLmacromustcontainatleastoneexitstatement.

Exampleofanexitstatementisasfollows:

:
IBC:,,?FILENAME,?EXTENSION;
if error then;
write_term( NL, "/*** CANNOT COPY FILE, CHECK INPUT ***/", NL );
wait;
fi;

62 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

:
exit;

Related topics
Descriptions

MMLmacros

4.18 Execution of MML macros


ToexecuteanMMLmacro,startthemacrobyenteringitsnameandparameters.
Parametervaluesmustbegiveninthesameorderinwhichtheyarepresentedinthe
headerofthemacro.Theparameterguidehelpsyoutoentertheparametersinthe
correctorder.Confirmtheexecutionofthecommandsinthemacroifthesystemasksfor
aconfirmation.

TheexecutionprintoutsmaybedisplayedonthescreenoftheMMLterminalyouare
using(theprintoutsarecontrolledbycommandlanguagedirectives,whichareincluded
inthemacros).Afterthemacroisexecuted,theMAIN LEVEL COMMANDpromptis
displayed.TheMMLcommandsexecutedbythemacroarewrittentotheMML
commandlog.Thelogcontainsboththecommandsthatsucceededandthosethat
failed.

TherearetwomethodsthatcanbeusedtoexecuteanMMLmacro:theshortstart-up
methodandthelongstart-upmethod.Theshortstart-up-methodletsyouusecommand
menusand,insteadofthewholenameofthemacro,youcanidentifythemacrobya
partofitsname.

Error situations with MML macros


ShouldanerroroccurduringtheexecutionofanMMLmacro,theexecutioneither
terminatesorcontinues,orthesystemasksyouwhetheryouwanttheexecutionofthe
macrotocontinueornot.AnerrormessagemaybedisplayedonthescreenoftheMML
terminal.Theseactionsaredeterminedbythecommandlanguagedirectives.

Related topics
Descriptions

Shortstart-upmethodforMMLmacros

Longstart-upmethodforMMLmacros

4.19 Short start-up method for MML macros


Youcanstartthemacroeitherstep-by-stepusingcommandmenusandtheparameter
guideorwithoutusingthesystem'shelp.

Issue:09 DN02143068 63

MMLmacros ExecutingMMLCommandsinIPA-RNC

Identifythemacrobythreecharactersinitsname:theidentifiersofthecommandclass
andtheMMLmacrogroup,andthecommandletter(thatis,thefourth,fifthandsixth
characters).Theselettersareincludedinthecommandmenus.Forexample,amacro
namedTSTI1OGEisidentifiedbycharactersI1O.

Theparameterscanbeenteredasfollows:

Allparametersonthesamelineaftercommandcharactersandacolon(:).
Allparametersafterthecommandcharacterline,onlinesoftheirownasindicatedin
theparameterguide.
Someonthefirstlineandtherestonlinesoftheirownasindicatedintheparameter
guide.

Endeachpartthatisenteredinalineofitsown,bypressingthe CR (carriagereturn).

g AstheMMLcommandgroupcanalsobepresentedasanumber,anMML
commandandanMMLmacrowiththesamecommandgroupnumbermay
exist.InthiscaseonlytheMMLcommandisshowninthecommandmenuand
onlytheMMLcommandisexecuted.TheMMLmacrocanbeexecutedonly
usingthelongstart-upmethod.

YoucanstarttheMMLmacrointheMMLsessioninthesamewayastheMML
command,byusingcommandcharactersshowninthemenu,orstraightattheMAIN
LEVELCOMMANDlevelbywritingallthreeMMLmacrocommandcharactersoneafter
another.

Related topics
Instructions

ExecutinganMMLmacro

Descriptions

ExecutionofMMLmacros

4.20 Long start-up method for MML macros


Inthelongstart-upmethod,runtheMMLmacroattheMMLsessionMAINLEVEL
COMMANDlevel.Thestartcommandstartswith@characterandisfollowedbythe
MMLmacronameandparameters.

Theparameterscanbeenteredintwoways:

aftertheMMLmacroname,inbrackets
aftertheMMLmacroname,ondifferentlines,everyparameteronalineofitsownas
indicatedintheparameterguide.

64 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Youcanalsoenteronlysomeoftheparametersonthesamelinewiththemacroname
andtherestoftheparametersonlinesoftheirown.

Endeachlinebypressingthe CR (carriagereturn).Ifallparametersarewrittenonthe
samelineastheMMLmacroname,asemicolon(;)canbewrittenasthelastcharacter
ontheline,beforethe CR .

Ifthereisnoextensionpart,theMMLsystemsearchesthediskforamacrowiththe
extensionEMM.

Belowisanexampleofalongstart-upmethodfortheMMLmacro.

InanMMLmacro,theheaderpartandparameterdefinitionareinform:

KCHI1CGE( ?SYSTEM: DIG1=?OLD_SUB, DIG2=?NEW_SUB: ?OLD_DP, ?NEW_DP );


declaration
?SYSTEM "/* IDENTIFY SYSTEM */",
?OLD_SUB "/* OLD SUBSCRIBER NUMBER, DIG1= */",
?NEW_SUB "/* NEW SUBSCRIBER NUMBER, DIG2= */",
?OLD_DP,
?NEW_DP "/* NEW DECIMAL POSITION NUMBER */";

TheuserentersontheMMLterminal

eithertheentirecommandonce:

MAIN LEVEL COMMAND <___>


< @KCHI1CGE(LAB: DIG1=70005, DIG2=80005: 5, 45 ); <CR>
TheMMLmacrostartsrunning.
ortheparametersseparately:

MAIN LEVEL COMMAND <___>


< @KCHI1CGE <CR>
/* IDENTIFY SYSTEM */
LAB <CR>
/* OLD SUBSCRIBER NUMBER, */
70005 <CR>
/* NEW SUBSCRIBER NUMBER, */
80005 <CR>
OLD_DP?
5 <CR>
/* NEW DECIMAL POSITION NUMBER */
45 <CR>
:
TheMMLmacrostartsrunning.

Related topics
Instructions

ExecutinganMMLmacro

Descriptions

ExecutionofMMLmacros

Issue:09 DN02143068 65

MMLmacros ExecutingMMLCommandsinIPA-RNC

4.21 Testing MML macros


Purpose

WhentestingMMLmacros,thegeneralprocedureforfunctionaltestingisfollowed.
SpecialattentionshouldbepaidtothesyntaxandsemanticsoftheMMLcommands
usedinthemacros,andtothedynamicsoftheresponses.

Asthecommand languageusedintheMMLmacrosisaprogramminglanguage,the
conventionalprogramcodeproblemareasshouldbecheckedcarefully:uninitialised
variables,inadequatestopconditionsforloops,overflowsinarithmeticoperations,and
soon.OtherpotentialtroubleareasincludetheMMLcommands(syntaxandsemantics),
andthecommandroutinesthathandletheresponses.

Thecommandlanguagehasafewcommandstooffertoaidtesting.Thedirectives
relatedtoechoing(echo_on,echo_off,trace_onandtrace_off)aredesignedfortesting
macros,asaretheMMLmacrostopstatements(delayandwait).Inaddition,theoutput
statement(write_term)canbeusedfortheinterimoutputsofatest,andtheyarethen
removedfromtheMMLmacrowhentestinghasbeencompleted.

1 Follow the general procedure for functional testing

Expected outcome

AnMMLmacroistested.

4.22 Installing MML macros


Purpose

AnMMLmacroissettothesystembycopyingthemain macroandsubmacros,ifany,
totheMMDIREdirectoryonthesystemdiskandsparediskoftheOMUfunctionalunit.

Iftheuserwishestoruntheshortstart-upmethodinthefuture,theMEN*.MIFfile
menushavetobedeletedfromtheMMDIRdirectoryonthesystemandsparedisk,and
thefunctionalunithastoberestarted.Shortlyafterthestartuphasended,theMMI
systeminthefunctionalunithascreatednewmenufilesthatincludethenewMML
macro.

ThemacrosareASCIIfilessothattheycanbeoutputinthesystembyusingtheIWX
commandandeditedbyusingtheIEEcommand.However,theMMLmacroscreatedby
NokiaSiemensNetworkscannotbeeditedbyusingtheIEEcommand.

1 Copy the main macro (and the submacros) to the MMDIRE directory

Expected outcome

66 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

MMLmacrosareinstalled.

4.23 Listing MML macros


Purpose

ThisproceduregivesinstructionsonhowtolistMMLmacros.

1 List the MML macros in the system (IWX)


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

Example:

AstheextensionofMMLmacrosisEMMandastheyarestoredintheMMDIRE
directory,thefollowingcommanddisplaysalltheMMLmacrosinthesystem:

ZIWX::WS:MMDIRE:%,EMM;

Expected outcome

TheMMLmacrosarelisted.

4.24 Executing an MML macro

1 Execute an MML macro


Selectoneofthefollowingalternatives:

ExecuteanMMLmacrowithoutusingthesystem'shelp(shortstart-upmethod)

1. Typethethreecharactersthatidentifythemacro,acolon(:)andthe
parameters
2. Completethecommandbyenteringasemi-colon(;)

UsetheparameterguidetoexecuteanMMLmacro(longstart-upmethod)

1. Enter@andthewholenameofthemacroatthemainlevel
Forexample,enter@TSTI1OGE.
Themacrousedintheexamplescopiestheneededfilefromthesource
directorytothedestinationdirectoryonbothdisks.
Theparameterguideisdisplayed.Forexample,thefollowingguidecanbe
displayed:

/* GIVE FILENAME TO BE COPIED */


2. Entertheparametersthattheparameterguideasksyoutoenter

Issue:09 DN02143068 67

MMLmacros ExecutingMMLCommandsinIPA-RNC

3. Enterasemi-colon(;)tocompletethecommandwhenthesystemasksyou
toexecutethemacro.Tonottoexecutethemacro,enterNinsteadofthe
semi-colon.

ExecuteanMMLmacrowithoutusingthesystem'shelp(longstart-upmethod)

1. Enter@,themacroname,theparameters,andasemi-colonatthemain
level
Entertheparametersinparentheses.

Example:
Forexample,tostarttheTSTI1OGEmacrothatcopiestheneededfileHILTON
fromthesourcedirectorytothedestinationdirectory,enter:
@TSTI1OGE(HILTON,TXT,MMDIRE,BLCODE);

Expected outcome

AnMMLmacroisexecuted.

Related topics
Descriptions

DirectivesinMMLmacros

MMLmacros

4.25 Displaying the contents of an MML macro


Purpose

ThisproceduregivesinstructionsonhowtodisplaythecontentsofanMMLmacro.

1 Define the directory in which the macro is located (IWY)


MMLmacrosarestoredintheMMDIREdirectory.
ZIWY:S:PATH=MMDIRE;

2 Display the contents of the macro (IBT)


DisplaythecontentsofthemacroinASCIIform.
ZIBT:<source unit identifier>,<source unit number>,<file
name>, <file name extension>,,,,<type mode>;

Example:

ThefollowingexampledisplaysthecontentsoftheTSTI1OGEmacro:

ZIBT:WDU,S,TSTI1OGE,EMM,,,,A;

68 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLmacros

Expected outcome

ThecontentsofanMMLmacroaredisplayed.

Issue:09 DN02143068 69

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

5 MML command logs

5.1 MML command log


TheMMLcommandsthatareexecutedduringaparticularMMLsessionarewrittentoan
MMLcommandlog,whichalsocontainsotherinformationontheMMLsession.The
commandlogcanbeused,forexample,tolistthecommandsthatweregivenbeforean
erroroccurred.Itcanalsobeusedasabasisofadiskcommandfile.

TheMMLcommandlogconsistsoffilesthatcontaininformation(forexamplethe
executionresult)ontheMMLcommandswhoseexecutionhasstarted,theMML
session,thenetworkelement,andtheuseridentityofthepersonwhoexecutedthe
commands.Thisinformationisnetworkelementspecific.Thecommandsexecutedby
thecommandcalendarorusingdiskcommandfilesorMMLmacrosarealsowrittento
thelog.

YoucanusetheMMLcommadlog:

toexaminewhatMMLcommandsyouexecutedduringacertainperiodoftime,for
example,beforeanerroroccurredorbeforeyouhadabreak.Thecommandsalso
includethoseyouaddedtothecommandcalendarandthoseyouexecutedusinga
commandfileoranMMLmacro.Thelogalsoshowsthestartingandendingtimeof
commandexecution,itsresult,theMMLsessioninwhichthecommandwas
executedandseveralotherthings.
Eachuserisauthorisedtodisplayhisorhercommandlog.Someuserscanalsobe
authorisedtoexamineothers'commandlogs.
totransfercommandloginformationinCSV(CommaSeparatedValues)formatto
otherapplications(forexample,spreadsheetanddatabaseprograms).
tocreateacommandfile.Ifyouneedtoexecutethesamecommandsyouhave
executedduringacertainperiodoftime,aneasywaytocreateacommandfileisto
outputthecommandsfromtheMMLcommandlogtoafileandtousethefileasa
basisofacommandfile.

YoucanusePRFILEparameterstomodifytheMMLcommandlog,thatis,itsstoring
time,diskspaceconsumption,removaltimeanddiskupdatingload.Alltheparameters
areinparameterclass38(MMLcommandlog).

Ifyoudonotenteranyparameters,thecommanddisplaysalltheinformationconcerning
thecommandsyouhaveexecutedduringthecurrentdayintextformat.

Usetheparameterstospecifyinmoredetail:

thetimeperiodincludedintheprintout.
thekindofinformationincludedintheprintout.Youcanspecify:

1. MMLcommandsandcommandgroups.
2. typesoflogrecords.Therecordsgiveinformationeitheronthestartingorending
ofanMMLsessionoranMMLcommand.

70 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

3. theexecutionresultthecommandshavetohaveinordertobeincludedinthe
printout.Youcanincludecommandsthatwereexecuted,aborted,ignored,
commandsthatwereexecutedandthatstartedafunction,commandsthatwere
notauthorisedorcommandsthatfailed.
4. theusernamesorusergroupswhoseloginformationisdisplayedifyouare
authorisedtodisplaytheirloginformation.Theusergroupsareformedonthe
basisoftheusernameprofiles.

Table 5 PRFILEparametersaffectingtheMMLcommandlog

Purpose Parameter in Value range Default


class 38

storingtime,diskspaceconsump- 1 3to30days 30days


tion

numberoffilesstored,diskspace 2 5to30000files 30000files


consumption

removaltimeofoldlogfiles:

removalhour 3 00to23hours 01a.m.

removalminutes 4 00to59minutes 25minutespastthe


hour.

timethelogisintheinternalwrite 0 10to600seconds 60seconds


cache,diskupdatingload

Printout in text form


Comment tokens /* and */

AlltheotherinformationexceptforMMLcommandsiswrittenbetweenthecomment
tokens/*and*/.However,ifcommandsthatcannotbeexecutedusingacommandfile
areprintedtothefile,thefilewillnotbeexecuted.

ThemeaningoftheMMLcommandloginformationondifferentlinesisasfollows:

Firstlinedisplaysthenameofthenetworkelementyouareusing,itstype,youruserID,
thedateandtimewhentheoutputwascreated.

/* RNC007 RNC SYSTEM 2000-05-20 20:33:35 */

Otherlinescontaincommandlogrecords.Theserecordsgiveinformationonthestarting
orendingofeitheranMMLsessionorMMLcommand.Therearefourtypesoflog
records:

Issue:09 DN02143068 71

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

1. MMLsessionstartrecord,markedwithnumberone(1)

/* 1 RNC007 RNC VTP-1 SESSION=00001 USERID=USER27


STARTED 2000-05-20 20:27:40 */
2. MMLsessionendrecord,markedwithnumbertwo(2)

/* 2 RNC007 RNC VTP-1 SESSION=00001 USERID=USER27


ENDED 2000-05-20 20:33:45 */
3. MMLcommandexecutionstartrecordstartsfromthebeginningofaline.Itisnot
markedwithanycharacters.Therecordconsistsoftwolines:thefirstlineindicates
theMMLcommandandthesecondlinetheMMLsession,userID,dateandtime.

WQO;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:28:06 */
4. MMLcommandexecutionendrecord,markedwithnumberfour(4)ornumberfour
andthelowercasec(4c),whichstandsforcontinuationline.

/* 4 WQO; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:28:13 */

Thefollowingtableindicatesthekindofinformationineachrecord:

Table 6 Informationgivenineachcommandlogrecord

Information Session starts (1) Session ends (2) Command starts Command ends
(two lines) (4 or 4c)

typeoflogrecord + + + +

username + + + +

terminalname + + - -

sessionnumber + + + +

dateandtime(yyyy- + + + +
mm-dd)

MMLcommand - - + +

executionresult - - - +

executionfailure - - - +
code

executionfailure - - - +
text

72 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

Belowisanexampleoftheprintout.

/* RNC007 RNC SYSTEM 2000-05-20 20:33:35 */


/* 1 RNC007 RNC VTP-1 SESSION=00001 USERID=USER27
STARTED 2000-05-20 20:27:40 */
WQO;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:28:06 */
/* 4 WQO; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:28:13 */
IID::MMLLOG;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:28:57 */
/* 4 IID::MMLLOG; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:28:58 */
IGO:;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:29:04 */
/* 4 IGO:; */
/* 4c COMMAND EXECUTED */
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:29:05 */
USC:OMU:TE,:;
/* 3 SESSION=00001 USERID=USER27 2000-05-20 20:32:47 */
/* 4 USC:OMU:TE,:; */
/* 4c COMMAND ABORTED *//*** ERROR: 795 ***/
/*** TRANSITION NOT CONTROLLED ***/
/* 4c SESSION=00001 USERID=USER27 2000-05-20 20:32:49 */
/* 2 RNC007 RNC VTP-1 SESSION=00001 USERID=USER27
ENDED 2000-05-20 20:33:45 */

Printout in CSV form


TheCSVprintoutcontainstwokindsofrecords:startandendrecords.Thestartrecord
ismarkedwithSandtheendrecordwithE.Bothrecordscontainthefollowing
information:

typeofrecord,S=startrecord,E=endrecord
nameofnetworkelement
typeofnetworkelement
userID
nameofterminal
numberofMMLsession
dateinformat:D.M.YYYY
timeinformatHH:MM:SS
MMLcommand
MMLcommandexecutionstatus(S=succeededcommand,F=failedcommand)

Belowisanexampleoftheprintout.

S;RNC007;RNC;USER27;VTP-1;00001;5.3.2000;12:35:16;"IAL;";;
E;RNC007;RNC;USER27;VTP-1;00001;5.3.2000;12:35:17;"IAL;";S;

Issue:09 DN02143068 73

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

Related topics
Instructions

ModifyingstoringtimeofMMLcommandlog

ModifyingMMLcommandlogdiskspaceconsumption

ChangingMMLcommandlogremovaltime

DecreasingdiskupdatingloadofMMLcommandlog

DisplayingMMLcommandloginformation

PrintingMMLcommandloginformationtodiskfile

ClosingtheMMLcommandlog

MonitoringofthestartingandendingofMMLcommandexecution

TransferringMMLcommandloginformationtothepostprocessingsystemusingFTP

PrintingMMLcommandloginformationviaalogicalfile

5.2 Modifying storing time of MML command log


Purpose

Tomodifythestoringtime,usethePRFILEparameter1/38(parameter1inparameter
class38).Thedefaultstoringperiodisthecurrentdayplus3days.Thevaluerangeis3
to30days.

1 Display the parameters in parameter class 38 (WOI)


ZWOI:38;

2 Modify the value of parameter 1 in parameter class 38 (WOC)


ZWOC:38,1,<value>;

Expected outcome

ThestoringtimeoftheMMLcommandlogismodified.

74 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

5.3 Modifying MML command log disk space


consumption
Purpose

Tomodifythecommandlog'sdiskspaceconsumption,modifyitsstoringtimeusingthe
PRFILEparameter1/38.Youcanalsomodifythenumberoflogfilesstoredusingthe
PRFILEparameter2/38,butitisrecommendedthatonlythestoringtimeshouldbe
modified.Thedefaultnumberoffilesstoredis30000.Thevaluerangeis5to30000
files.

ThediskspaceconsumptionoftheMMLcommandlogdependsonitsstoringtime.The
logtakesupaminimumof400kBaday(itrequiresthespaceimmediatelyafterithas
beencreated).Sincetheminimumstoringtimeis4days,thelogwilltakeupatleast4x
400kB,ie.1.6MB.Ifwritingtothelogfailsbecausethesystemisoutofdiskspace,the
alarm2683isset.

g Becausetheparameter value parameterfortheWOCcommandisa


hexadecimal,thedecimalvalue,forexample60,canbeenteredasD'60.

1 Display the parameters in parameter class 38 (WOI)


ZWOI:38;

2 Modify the value of parameter 1 in parameter class 38 (WOC)


ZWOC:38,1,<value>;

Expected outcome

ThediskspaceconsumptionoftheMMLcommandlogismodified.

5.4 Changing MML command log removal time


Purpose

Theoldlogfilesaredeletedonceaday.Sincethisoperationplacesratherheavyaload
ontheOMU,itisrecommendedthatotheroperationsincreasingtheloadshouldnotbe
carriedoutatthesametime.

Tochangethetimewhentheoldcommandlogsareremoved,usethePRFILE
parameters3/38and4/38.Theformersetsthehourandthelattertheminutes.The
defaulttimeis1:25a.m..Thevaluerangesare00to23hoursand00to59minutes.

Becausetheparameter value parameterfortheWOCcommandisahexadecimal,


thedecimalvalue,forexample10,canbeenteredasD'10.

Issue:09 DN02143068 75

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

1 Display the parameters in parameter class 38 (WOI)


ZWOI:38;

2 Set the hour by modifying the value of parameter 3 in parameter class 38


(WOC)
ZWOC:38,3,<value>;

3 Set the minutes by modifying the value of parameter 4 in parameter class 38


(WOC)
ZWOC:38,4,<value>;

Expected outcome

TheMMLcommandlogremovaltimeischanged.

5.5 Decreasing disk updating load of MML command


log
Purpose

YoucandecreasetheloadinducedbythediskupdatingbymodifyingthePRFILE
parameter0/38.Theloaddecreaseswhenthevalueisincreased.Todisplaythecurrent
value,usetheWOIcommandandtomodifythevalue,usetheWOCcommand.Thevalue
showsthelengthoftimethelogisintheinternalwritecacheinseconds.Ifyoumodify
thevalue,thatis,lengthenthetime,moreloginformationmaybelostinerrorsituations.

1 Display the parameters in parameter class 38 (WOI)


ZWOI:38;

2 Modify the value of parameter 0 in parameter class 38 (WOC)


ZWOC:38,0,<value>;

Expected outcome

ThediskupdatingloadofMMLcommandlogisdecreased.

5.6 Displaying MML command log information


Purpose

ThisproceduregivesinformationonhowtodisplayMMLcommandloginformation.

76 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

1 Display information stored in the command log (IGO)


Forexample,todisplaytheloginformationconcerningtheMMLsessionsyouhave
openedtodayintextform,enter:
ZIGO;

Example:Displaying the log information concerning the MML sessions opened


during a certain time period

ThefollowingcommanddisplaystheloginformationconcerningyourMMLsessions
onJune15th2000from12pmto4pmintextform.

ZIGO:2000-06-15,12-00,,16-00;

Expected outcome

MMLcommandloginformationisdisplayed.

5.7 Printing MML command log information to disk file


Before you start

Notethatifyoucreateasemipermanentlogicalfileinstep3,youcanstartfromstep5
laterinotherMMLsessions.Theinformationisprintedtothesamefileyoucreatedin
step1.

Purpose

YoucanprintinformationstoredintheMMLcommandlogtodiskfileusingthe
filenameparameteroftheIGOcommand.Ifyouwanttousethefileasadisk
commandfile,youmustcopyittotheMMDIREdirectoryandnameitsothatthe
extensionisCMD.Ifyouwanttoeditthefile,usetheIEEcommand.

1 Create MMDIRE/MLOGS directory (IWL)


ZIWL::WS,:MMDIRE:MLOGS;

2 Create a disk file (IWC)


Thesizeofthefiledependsonthesizeofthelog:forexample,inmostnetwork
elements,acommandlogcreatedduringadaymaycontainupto100000
characters.
ThefollowingcommandcreatesafilecalledCOMNDLOGintheMMDIRE/MLOGS
directory.Thefileisstoredonthesystemdisks,itsextensionisLOG.
ZIWC::WS:MMDIRE,MLOGS:COMNDLOG,LOG;

Issue:09 DN02143068 77

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

3 Create a logical file (IIF)


IfyouonlyprintviathislogicalfileduringthecurrentMMLsession,createa
temporarylogicalfile:itwillbedeletedafterthesession(orareset).Ifyouwantto
printviathislogicalfilelaterinotherMMLsessions,createasemipermanentlogical
file.Tospecifywhetherthefileistemporaryorsemipermanent,usethelogicalfile
classparameter(T=temporary,S=semipermanent).
ThefollowingcommandcreatesasemipermanentlogicalfilenamedPRINTLOG.
ZIIF::PRINTLOG,S:DEV=WDU-S;

4 Link the logical file to the disk file (III)


ThefollowingcommandlinksthePRINTLOGlogicalfiletotheCOMNDLOGfile.
ZIII::PRINTLOG:,MMDIRE,MLOGS:COMNDLOG,LOG;

5 Print log information to file (IGO)


Givethenameofthelogicalfileasthevalueofthefilenameparameter.
ZIGO::::OUTPUT=PRINTLOG;
Ifthefilehasbeenusedearlier,youcanemptyitusingtheIWEcommand.

Expected outcome

TheMMlcommandloginformationisprintedtoadiskfile.

5.8 Closing the MML command log


Purpose

Afterclosingalogfile,anewoneisopened.Thiscommandcanbeused,forexample,
whenyoubackupcopythesoftwarebuildandwanttoincludetheexactcopyofthelog
madebeforeaparticulartime.

1 Close the current command log file (IGK)


ZIGK;

Expected outcome

Thecommandlogfileisclosed.

78 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

5.9 Monitoring of the starting and ending of MML


command execution
Purpose

YoucanmonitorthestartingandendingofMMLcommandexecutionbyprintingthe
informationtoafileoranoutputdevice(nottheMMLterminal).

g DonotconnectMMLLOGtothealarmprinter.

1 Print the information to a file or an output device


Toprinttheinformation,linktheMMLLOGlogicalfiletoafileorconnectittoanoutput
device.Forinstructionsonhowtolinkandconnectlogicalfiles,seeInterrogating
connections by a logical file

Expected outcome

Informationisprintedtoafileoranoutputdevice.

5.10 Transferring MML command log information to the


postprocessing system using FTP or SFTP
Before you start

WhenusingFTPorSFTP,IPmustbeconfiguredbothinthenetworkelementandthe
otherpostprocessingsystem.

Purpose

MMLcommandloginformationcanbetransferredfromanetworkelementtothe
postprocessingsystemusingFTPorSFTPandanappropriatecommandofthe
postprocessingsystem.

1 Print the log information to a file


Forinstructions,seePrintingMMLcommandloginformationviaalogicalfile.

2 Transfer the information to a postprocessing system


WhenusingFTPorSFTP,useanappropriatecommandoftheotherpostprocessing
system.

Expected outcome

MMLcommandloginformationistransferredtothepostprocessingsystem.

Issue:09 DN02143068 79

MMLcommandlogs ExecutingMMLCommandsinIPA-RNC

5.11 Printing MML command log information via a


logical file
Purpose

ThisproceduregivesinstructionsonhowtoprintMMLcommandloginformationviaa
logicalfile.

g Ifyoucreateasemipermanentlogicalfileinstep3,youcanstartformstep5
laterinotherMMLsessions.Theinformationisprintedtothesamefileyou
createdinstep1.

1 Create MMDIRE/MLOGS directory (IWL)


ZIWL::WS,:MMDIRE:MLOGS;

2 Create a file in the MMDIRE/MLOGS directory (IWC)


Thesizeofthefiledependsonthesizeofthelog:forexample,inmostnetwork
elements,acommandlogcreatedduringadaymaycontainupto100000
characters.
ThefollowingcommandcreatesafilecalledCOMNDLOGintheMMDIRE/MLOGS
directory.Thefileisstoredonthesystemdisks,itsextensionisLOG.
ZIWC::WS:MMDIRE,MLOGS:COMNDLOG,LOG;

3 Create a logical file (IIF)


IfyouonlyprintviathislogicalfileduringthecurrentMMLsession,createa
temporarylogicalfile:itwillbedeletedafterthesession(orareset).Ifyouwantto
printviathislogicalfilelaterinotherMMLsessions,createasemipermanentlogical
file.Tospecifywhetherthefileistemporaryorsemipermanent,usethelogicalfile
classparameter(T=temporary,S=semipermanent).Thefollowingcommandcreates
asemipermanentlogicalfilenamedPRINTLOG:
ZIIF::PRINTLOG,S:DEV=WDU-S;

4 Link the logical file to the file you created (III)


ThefollowingcommandlinksthePRINTLOGlogicalfiletotheCOMNDLOGfile.
ZIII::PRINTLOG:,MMDIRE,MLOGS:COMNDLOG,LOG;

5 Print the desired log information to the file (IGO)


Givethenameofthelogicalfileyoucreatedasthevalueofthefilenameparameter.
ZIGO::::OUTPUT=PRINTLOG;
Ifthefilehasbeenusedearlier,youcanemptyitusingtheIWEcommand.

80 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandlogs

6 Transfer the file


WhenusingFTPorSFTP,usetheappropriatecommandoftheotherapplication.

Expected outcome

MMLcommandloginformationisprintedviaalogicalfile.

Issue:09 DN02143068 81

MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC

6 MML disk command files

6.1 Disk command files in MML


DiskcommandfilesletyouexecuteMMLcommandsequences.Youcanusethemto
automateroutinetasksthatdonotneedtobesupervised.Diskcommandfilesareuseful
incarryingouttasksthataretime-consuming.

Diskcommandfilescanbeexecutedimmediatelyoratapredefinedmoment.Ifyouwant
toexecuteafileimmediately,usetheIDEcommand.Ifyouwanttoexecuteafileata
predefinedmoment,eitheratacertaintimeorwhenanalarmoccurs,addittothe
commandcalendar.Onlyonediskcommandfilecanbeexecutedatatime.Thesame
filecanbeexecutedmorethanonce.

AdiskcommandfilecontainsalistofMMLcommandsandpossiblyalsoremarks.By
executingacommandfile,youcanexecutealltheMMLcommandsinthefile;the
commandsareexecutedoneatatime,startingfromtheoneatthetopofthefile.
Commentscanbewrittenanywhereinthefile,aslongastheyarewrittenbetween
commenttokens/*and*/.

Thecommandscancontainparameterstowhichyoucangivevalueswhenyouexecute
thefile.Suchparametersareindicatedbyanasterisk(*)andanumberrangingfrom1to
8,forexample,*1(seetheUSIcommandintheexamplebelow).Thesamenumbercan
onlybeusedonceinthesamefiletorepresentaparametervalue.Informationonthe
commandswhoseexecutionhasstartediswrittentotheMMLcommandlog.Belowisan
exampleonthecontentsofadiskcommandfile:

IID:;/*displays information on logical files*/


DCD:;
USI:*1;
IHI:;

Diskcommandfilescanbecreatedandeditedusingthesystem'sdiskfileeditor.Ifyou
wanttoexecutethesamecommandsorsomeofthecommandsthatyouexecuted
duringaparticularMMLsession,youcanusetheMMLcommandlogasabasisofa
commandfile.

CommandsforhandlingdiskcommandfilesareintheIDcommandgroup.Byusing
thesecommandsyoucan:

executeadiskcommandfile(IDE).
stopcommandfileexecution(IDS).
displaythecontentsofadiskcommandfile(IDL).

UnlikemostMMLcommands,thedefaultoutputdeviceoftheexecutionprintoutsofthe
IDEcommandisnotalwaystheMMLterminal.TheMMLterminalisthedefaultoutput
deviceonlyifyouchosetoconfirmtheexecutionofthecommandsinthecommandfile
bygivingVDUasthevalueoftheoutput connectionparameter.Ifyoudidnotgivea
valuetothisparameter,thedefaultoutputdeviceisthePRINTER0logicalfile,whichis
normallyconnectedtotheprinterVPP-0;thatis,thedefaultoutputdeviceinsuchacase

82 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles

isthisprinter.Byusingtheoutput connectionandlogical output file


parametersoftheIDEcommand,youcandirecttheprintoutseithertotheMMLterminal,
toaprinterortobothofthem.Youcanalsosavetheprintoutsinadiskfile.

Whenexecutingdiskcommandfiles,theonlyobligatoryparameterisfile name,which
identifiesthefile.Youcanusetheotherparameterstodothefollowing:

Identify I/O device


IdentifytheI/Odeviceonwhichthefileisstoredusingparameters
I/O device typeandI/O device index.

Determine the commands to be executed


Youcanexecuteallthecommandsinadiskcommandfileoronly
someofthem;toidentifythefirstandthelastcommandsyouwantto
execute,useparametersstart command indexandstop
command index.Thedefaultvalueisthatallthecommandsare
executed

Terminate command file execution when a command fails


Ifyouwanttheexecutionofthefiletoterminateincaseoneofthe
commandsinthefilefails,giveINT(whichstandsforinterruptable)as
thevalueofthecommand file typeparameter.Thedefaultvalue
isthattheexecutionofthefiledoesnotterminate.

Determine that command execution is confirmed by you


DiskcommandfilescancontainMMLcommandswhoseexecution
hastobeconfirmed.Forexample,beforetheIBCcommandis
executed,thefollowingtextisdisplayed:CONFIRM COMMAND
EXECUTION: Y/N ?Whensuchacommandisinadiskcommand
file,itsexecutioncanbeconfirmedeitherbytheuserorbythe
system.Thedefaultvalueisthatthesystemconfirmscommand
executionbyresponsingpositively(Y).Ifyouwanttoconfirm
commandexecution,giveVDUasthevalueoftheoperation mode
parameter.

Determine that command to be printed to output device


Bydefault,commandsarenotprintedtooutputdevice.Toprint
commandstooutputdevice,youcansetthecommands to output
parameter(CMNDS)toYESwhenyouexecutecommandfile.When
commandexecutionfailsorthegivencommandisincorrect,error
informationandnoticemessagewillbeprinted.

Related topics
Instructions

ListingMMLdiskcommandfilesinthesystem

DisplayingthecontentsofadiskcommandfileinMML

Creatingadiskcommandfileusingthesystem'sdiskfileeditorinMML

Issue:09 DN02143068 83

MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC

ExecutingdiskcommandfilesinMML

InterrogatingoutputdevicesofexecutionprintoutsinMML

GivingparametervaluestoMMLcommandsinadiskcommandfile

StoppingtheexecutionofadiskcommandfileinMML

DirectingtheexecutionprintoutsofMMLcommandcalendartasks

PreventingthesavingofexecutionprintoutsofadiskcommandfileinadiskfileinMML

6.2 Listing MML disk command files in the system


Purpose

ThisproceduregivesinstructionsonhowtolistMMLdiskcommandfilesinthesystem.

1 List disk command files in the system (IWX)


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

Example:Listing disk command files in the MMDIRE directory

ThefilesshouldbestoredintheMMDIREdirectoryofthesystemdisk.Their
extensionisCMD.

ZIWX::WS:MMDIRE:%,CMD;

Expected outcome

TheMMLdiskcommandfilesarelisted.

6.3 Displaying the contents of a disk command file in


MML
Purpose

Thisproceduregivesinstructionsonhowtodisplaythecontentsofadiskcommandfile
inMML.

1 Display the contents of a disk command file (IDL)


ZIDL:<I/O device type>,<I/O device index>,<command file name>,
START=<start command index>,STOP=<stop command index>;

Example:Displaying commands in a disk command file

84 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles

Thefollowingexampledisplayscommands2-20inadiskcommandfilenamed
COMMANDS,whichislocatedinthefloppydiskunit1(FDU1)ofitsownunit:

ZIDL:FDU,1,COMMANDS:START=2,STOP=20;

Expected outcome

Thecontentsofadiskcommandfilearedisplayed.

6.4 Creating a disk command file using the system's


disk file editor in MML
Before you start

IfyouneedtoexecutethesamecommandsthatyouexecutedduringaparticularMML
session,aneasywaytocreateadiskcommandfileistouseanMMLcommandlogas
thebasisofthefile.

Diskcommandfilescanalsobecreatedandmodifiedbyusingthecommandsfor
handlingthecommandcalendar.Ifyouwanttocreateadiskcommandfilethatcontains
oneMMLcommandandadditatthesametimetothecommandcalendar,usetheICI
command.Ifyouwanttomodifyadiskcommandfilethatisalreadyinthecommand
calendar,usetheICMcommand.

Thenameofadiskcommandfilecancontainamaximumofelevencharacters.Thefirst
charactermustbealphabeticandtheotherscanbealphabeticornumerical.The
extensionofthefilemustalwaysbeCMD.Thenamecanonlycontainuppercaseletters.
Thenamecanbe,forexample,TESTFILE.CMD.

DiskcommandfilesmustbestoredintheMMDIREdirectoryofthesystemdiskiftheyare
tobeexecutedfromthecommandcalendar;otherwise,theycannotbeexecuted.The
filescanbestoredintheMMDIREdirectoryiftheyareonlytobeexecutedusingtheIDE
command.

Purpose

Thisproceduregivesinstructionsonhowtousethesystem'sdiskfileeditortocreatea
diskcommandfile.

1 Create a disk command file using the system's disk file editor (IEE)
Afterthecommandisentered,thediskfileeditorstarts.
ZIEE:<disk>:<subdir>:<file name>,<file name extension>;

2 Exit the editor


Whennomorecharacterscanbewrittentothefile,youhearasound.Toexitthe
editor,pressCTRL-Z.Afterthat,youareaskedwhetheryouwanttosavethe
changes.Tosavethechanges,enterY.Ifyoudonotwanttosavethem,enterN.

Issue:09 DN02143068 85

MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC

Notethatevenifyoudonotsavethechanges,thefileiscreated.Ifyoueditafile
thatwascreatedearlierandsavethechanges,theoriginalfileisalsosaved,butits
extensionischangedtoOLD.Youcanalsoquiteditingbypressing CTRL-Y .
Further information
Example:Creating a disk command file
ThefollowingcommandcreatesadiskcommandfilenamedDKFILEandstoresitin
theMMDIREdirectory.
ZIEE:WS:MMDIRE:DKFILE,CMD;

Expected outcome

Adiskcommandfileiscreated.

6.5 Executing disk command files in MML


Before you start

TheMMDIREdirectorymustexistonthedisk.Ifthisdirectorydoesnotexistonthedisk,
youcancreateitusingtheIWLcommand.

Purpose

ThisproceduregivesinstructionsonhowtoexecutediskcommandfilesinMML.

1 Execute a disk command file (IDE)


ZIDE:<file name>;
Further information
Example:Executing a command file
ThefollowingcommandexecutestheBACKUPcommandfile,whichislocatedonthe
harddisk(WDU)oftheOMU.Commandexecutionisterminatedifoneofthe
commandsinthefilefails,whichisindicatedbythecommand file type
parameter(CTYPE=INT).Thefirstcommandtobeexecutedisthe10thcommandin
thefileandthelastisthe15th.Thedefaultvalueisthatexecutionprintoutsare
directedviathePRINTER0logicalfiletoanoutputdevice.Commandsareprintedto
outputdeviceifthecommands to outputparameter(CMNDS)issettoYES.
ZIDE:WDU,,BACKUP:CMNDS=YES:CTYPE=INT,START=10,STOP=15;

Expected outcome

Adiskcommandfileisexecuted.

Related topics
Descriptions

DiskcommandfilesinMML

86 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles

6.6 Interrogating output devices of execution printouts


in MML
Purpose

Thisproceduregivesinstructionsonhowtointerrogateoutputdevicesofexecution
printouts.

Whenyouexecuteadiskcommandfile,youcandirectitsexecutionprintoutsusingthe
output connectionandlogical output fileparametersoftheIDEcommand.
Theprintoutscanbedirectedto:

theMMLterminal
thePRINTER<N>(where<N>isadigit)logicalfile
Theprintoutsaredirectedviathislogicalfiletotheoutputdeviceorfiletowhichthe
logicalfileisconnected.Normally,theprintoutsaredirectedtoaprinter.Youcanalso
directtheprintoutstosomeotheroutputdevice:forexample,youcansavethemina
diskfile.
boththeMMLterminalandthePRINTER<N>(where<N>isadigit)logicalfile.

1 Display printer connections (IID)


ZIID::<logical file name>;

Example:Displaying information on the PRINTER0 logical file

ZIID::PRINTER0;

Expected outcome

Theinterrogationofoutputdevicesofexecutionprintoutsissuccessful.

6.7 Giving parameter values to MML commands in a


disk command file
Purpose

Thecommandsinadiskcommandfilecancontainparameterstowhichyoucangivea
valuewhenyouexecutethefile.Suchparametersarerepresentedbyanasteriskanda
number(forexample,*1)inthecommandfile.Togiveavaluetothistypeofaparameter,
givethevaluetothereplacing parameteroftheIDEcommand.Forexample,a
commandfilemaycontainthefollowingcommand:

USI:*1;

Issue:09 DN02143068 87

MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC

Thiscommandinterrogatesunitstateinformationand*1representsthevalueofthe
unit typeparameter.Whenyouexecutethefile,givethevalueofthisparameterto
thereplacing parameteroftheIDEcommand.Forexample,tointerrogatethe
statesoftheOMU,giveOMUasthevalueofreplacing parameter(PAR1="OMU").
Notethatthevalueofthereplacing parametermustbegiveninparenthesesand
thatthenumberintheparametername(forexample,PAR1)mustbethesameasthe
onerepresentingtheparameterinthecommandfile(forexample,*1).

1 Give parameter values (IDE)


ZIDE:<I/O device type>,<I/O device index>,<command file
name>:PRTNR=<logical output file>,PAR1=<replacing parameter>;
Further information
Example:Executing a command file on the hard disk of OMU and directing the
printouts
ThefollowingcommandexecutestheCOMMANDScommandfileontheharddisk0
(WDU0)oftheOMU.Theparametervaluerepresentedby*1inthecommandfileis
replacedbyOMU;thisvalueisgiventothereplacing parameterparameter
(PAR1="OMU").Theexecutionprintoutsaredirectedtoanoutputdeviceviathe
PRINTER1logicalfile.
ZIDE:WDU,0,COMMANDS:PRTNR=1:PAR1="OMU";

Expected outcome

Theparametervaluesaregiven.

6.8 Stopping the execution of a disk command file in


MML
Purpose

Thisproceduregivesinstructionsonhowtostoptheexecutionofadiskcommandfile.

1 Stop the execution of a command file (IDS)


ZIDS:<file name>;
Further information
Example:Stop the execution of command file TESTFILE
ZIDS:TESTFILE;

Expected outcome

Theexecutionofadiskcommandfileisstopped.

88 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles

6.9 Saving execution printouts of a disk command file


in a disk file in MML
Before you start

ItisrecommendedthatyoulinkthePRINTER0logicalfiletoaringfile,becauseringfiles
donotfillup;instead,whenthereisnomorespaceinthefile,thenewestdatareplaces
theoldest.

Purpose

Thisproceduregivesinstructionsonhowtosaveexecutionprintoutsofadiskcommand
fileinadiskfileinMML.

1 Link the PRINTER<N> logical file to a disk file

1. Createadiskfiletowhichtheexecutionprintoutsaredirected(IWC)
ThefollowingcommandcreatesadiskfilenamedCFILE.Thefileisstoredinthe
MMDIREdirectoryonbothsystemandbackupdisks.Theextensionofthefileis
LOG.
ZIWC::WS:MMDIRE:CFILE,LOG;
2. ConnectharddiskandbackupdiskstothePRINTER<N>logicalfile(IIS)
Addtheharddiskofthesystemandbackupdisksasanobjecttothe
PRINTER<N>logicalfile.
ZIIS::PRINTER<N>::DEV=WDU-S;
3. LinkthePRINTER<N>logicalfiletothediskfile(III)
ThefollowingexamplelinksPRINTER<N>totheCFILEdiskfileintheMMDIRE
directory.TheextensionofthefileisLOGandthefileisaringfile.
ZIII::PRINTER<N>:,MMDIRE:CFILE,LOG,,RF;

2 Direct execution printouts to the disk file via PRINTER<N> logical file (IDE)
WhenyouexecutetheIDEcommand,usetheoutput connectionandlogical
output fileparameterstodeterminethattheexecutionprintoutsaredirectedto
thediskfileviathePRINTER<N>logicalfile.

Expected outcome

Theexecutionprintoutsofadiskcommandfilearesavedinadiskfile.

6.10 Preventing the saving of execution printouts of a


disk command file in a disk file in MML
Before you start

ThelinkbetweenthePRINTER<N>logicalfileandadiskfilehasbeencreatedearlier.

Issue:09 DN02143068 89

MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC

1 Remove the link between PRINTER<N> logical file and the disk file (III)
ThefollowingcommandremovesthelinkbetweenPRINTER<N>andtheCFILEdisk
file.
ZIII::PRINTER<N>;

2 Remove the connection between the PRINTER<N> logical file and the hard disk
(IIS)
ThefollowingexampleremovestheconnectionbetweenPRINTER0andthehard
disk.
ZIIS::PRINTER0:DEV=WDU-S;

Expected outcome

Thesavingofexecutionprintoutsofadiskcommandfileinadiskfileisprevented.

90 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

7 MML command calendar

7.1 MML command calendar


MMLcommandsanddiskcommandfilesthatareaddedtothecommandcalendar,
togetherwiththeirexecutionparameters,formcalendartasks.

Executionparametersdeterminefactorsrelatedtotheexecutionofacalendartask:for
example,theexecutiontimeorthealarmthatcausestheexecutionofataskandthe
numberofexecutionsofatask.Bymodifyingtheseparameters,youcan,forexample,
changetheexecutiontimeofatask.

EachuserisauthorisedtodisplayallthetasksinthecalendarusingtheICLcommand.
Thedefaultwilldisplayallthetasks.Bygivingspecificvaluestocertainparametersof
thiscommand,youcanselectthetypesoftasksthatyouwanttodisplay.Theprintout
canincludetasksthat:

containacommandfile
areexecutedataparticulartime
areexecutedataparticulardate
areexecutedwhenaparticularalarmoccurs
areinaparticularqueue.

Ifyoudisplayacommandfilethatisbeingexecutedatthemoment,theprintoutalso
includesthecommandthatthefileisexecuting.

Theexecutionofacalendartaskmaysometimesstartlate.Thisisbecausethecalendar
needsanMMLsessiontoexecuteataskand,ifnoMMLsessionsareavailable,the
executionstartslate.IfnoMMLsessionsbecomeavailabledespitetheattemptsofthe
calendartoexecutethetask,thetaskisblocked.Blockedtasksmustbeunblocked
beforetheycanbeexecuted.

Calendartasksareexecutedoneatatime.Therefore,theexecutionofataskstartslate
ifanothertaskisbeingexecutedwhentheexecutionofthetaskinquestionshouldstart.

Thecommandsexecutedbythecommandcalendar,includingthoseincommandfiles,
arewrittentotheMMLcommandlog.

UnlikemostMMLcommands,thedefaultoutputdeviceoftheexecutionprintoutsof
calendartasksisnottheMMLterminalbutprinterVPP-0.

ThecommandcalendarletsyouexecuteMMLcommandsanddiskcommandfilesata
predefinedmoment,eitheronceorrepeatedly.Whenaddedtothecommandcalendar,
commandsanddiskcommandfilesareexecutedeitheratacertaintimeorwhena
certainalarmoccurs;youdonotneedtobepresentduringtheirexecution.

Ifataskisnotexecutedattherightmoment,youcancheckwhetherthecalendaris
attemptingtoexecuteitbyexaminingthequeueinwhichthetaskis.Ifthetaskisinthe
executionqueue(EXE),thetaskisbeingexecutedorthecalendarisattemptingto
executeit.

Issue:09 DN02143068 91

MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

Thequeueinwhichacalendartaskisdependsonthephasethatisbeingcarriedout.By
examiningthequeues,youcancheckwhetheratask:

isbeingexecutedorgoingtobeexecutedsoon
hasbeenexecuted
isblocked
isunblocked.

Whenataskisaddedtothecalendar,itisputeitherin:

thetimequeueor
theeventqueue.

Theformercontainstime-initiatedtasksandthelattercontainsalarm-initiatedtasks
waitingfortheirexecution.

Whentheexecutionofataskstarts,thetaskistransferredtotheexecutionqueue;this
queuecontainsthetaskthatisbeingexeuctedandthosethatthecommandcalendaris
attemptingtoexecute.

Thesetasksaretransferredtothewaitqueueaftertheirlastexecution.

Iftheexecutionofataskfails,thetaskistransferredtotheblockedcommandsqueue.
Theonlyexceptionherearecommandfilesthataremeanttobeexecutedmorethan
onceandwhoseexecutiondoesnotterminatewhensomeofthecommandsinthefile
fails:suchtasksarenotblocked.ThesetypesofcommandfilesaremarkedwithNOINT
intheCFTYPEcolumnoftheprintoutproducedbytheICLcommand.

Thecommandcalendarcanbeusedtocarryoutroutinetasksthatdonotneedtobe
supervised,suchassafecopyingoffiles,producingoutputrecurrentlyatacertaintime
andmakingcertainchanges(forexample,changingthechargingratesofacharging
zone).Thecommandcalendarisuseful,forexample,whencarryingouttasksrepeatedly
atacertainmomentorincarryingouttasksataninconvenienttime.

Theexecutionprintoutsofcalendartasksmustbedirectedtoafunctioningoutput
device.Formoreinformation,seeDirectingtheexecutionprintoutsofMMLcommand
calendartasks.

YoucannotusetheICIcommandtoaddcommandsthatyouarenotauthorisedto
executetothecalendar;norcanyouaddcommandsthatcannotbeexecutedbythe
calendar(forexample,theIEEcommand,whichstartsthediskfileeditor).Ifyouattempt
toaddsuchcommands,anerrormessageisdisplayed.Thecalendarletsyou,however,
addacommandfilethatcontainsthistypeofacommand,butitdoesnotexecutethe
command:theothercommandsinthefileareexecutednormallyunlessotherwise
defined.

YouareauthorisedtousetheothercommandsintheICcommandgrouptohandlethe
tasksthatyouhaveaddedtothecalendar.

Related topics
Instructions

92 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

DisplayingthecontentsofthecommandcalendarinMML

AddingatasktothecommandcalendarinMML

TestingcalendartaskexecutioninMML

ModifyingacalendartaskinMML

DeletingacalendartaskinMML

BlockingorunblockingacalendartaskinMML

StoppinganMMLcommandfileexecution

7.2 Displaying the contents of the command calendar


in MML
Purpose

EachuserisauthorisedtodisplayallthetasksinthecalendarusingtheICLcommand.
Thedefaultwilldisplayallthetasks.Bygivingspecificvaluestocertainparametersof
thiscommand,youcanselectthetypesoftasksthatyouwanttodisplay.

Youcanproduceeitheracompleteoralimitedoutput:thedefaultproducesalimited
output.Toproduceacompleteoutputwithmoredetailedinformation,giveCOMasthe
valueofthelisting formparameter.

Thecommandsinthediskcommandfilesthatareinthecalendarcanalsobedisplayed.
Todisplaythesecommands,givethenamesofthecommandfilesasthevalueofthe
command file nameparameter.

1 Display the contents of a command calendar (ICL)


ZICL: <calendar task identifier>:<listing form>;

Example:Displaying a complete output of tasks with a certain identifier

Thefollowingcommandproducesacompleteoutputoftaskswithidentifiersranging
from1to6.

ZICL:ID=1&&6:COM;

Theexecutionprintoutofthecommandisasfollows:

ID USER CMND CFILE QUE DATE TIME NBR PNBR


PTYPE ALARM CFTYPE AUNIT DSTUN ASTATE DAYS
COMMAND
=======================================================================
1 SYSTEM IID - BLC 2000-02-01 19:00 1 -
- - - - - - MO&WE&FR
IID;
----------------------------------------------------------------------------
2 SYSTEM - BACKUPFILES TIM 2000-02-01 19:10 1 -

Issue:09 DN02143068 93

MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

- - NOINT - - - -
-

----------------------------------------------------------------------------
3 SYSTEM - BACKUPFILES TIM 2000-02-04 20:00 FOREV 1
WEEK - NOINT - - - FR
-
-----------------------------------------------------------------------------
6 SYSTEM - ALASTATUS EVE - - - -
- 2692 NOINT OMU - ALARM -
-
-----------------------------------------------------------------------------

COMMAND EXECUTED

Theexplanationsoftheheadingspresentedonthefirstthreelinesareasfollows:

ALARM alarmnumber

AUNIT unitthatdetectedthealarm

CFILE nameofthediskcommandfile

CFTYPE indicateswhethertheexecutionofacommandfileterminates
whenoneofthecommandsinthefilefails

CMND commandlettersofthecommand

COMMAND commandlettersandparametersofthecommand

DATE executiondate

DAYS weekdayswhentheexecutionofacalendartaskisallowed

DSTUN destinationunitofthealarm

ID taskidentifier

NBR numberofexecutions

PNBR numberofperiods

PTYPE typeofperiod

QUE queue

BLC blockedcommandsqueue:containstasksthatare
blocked

94 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

EVE eventqueue:containsalarm-initiatedtasks

EXE executionqueue:containsthetaskthecalendaris
executingandthetasksthecalendarisattemptingto
executebutwhichhavenotyetstarted

HOL waitqueue:containstaskswithnoinputthatwould
triggertheirexecution

TIM timequeue:containstime-initiatedtasks

TIME executiontime

USER useridentityofthepersonwhoaddedthetasktothecalendar

Expected outcome

Thecontentsofthecommandcalendararedisplayed.

Related topics
Descriptions

MMLcommandcalendar

7.3 Directing the execution printouts of MML command


calendar tasks
Purpose

ThedefaultoutputdeviceoftheexecutionprintoutsofcalendartasksisprinterVPP-0.
TheprintoutsaredirectedtotheoutputdeviceviatheCOMCALlogicalfile.Ifyouwantto
storetheprintoutsinanelectronicform,savetheminadiskfile.Bydefault,commands
arenotprintedtooutputdevice.Toprintcommandstooutputdevice,youcansetthe
commands to outputparameter(CMNDS)toYESwhenyouexecutecommandfile.
Whencommandexecutionfailsorthegivencommandisincorrect,errorinformationand
noticemessagewillbeprinted.

Calendartaskscanonlybeexecutediftheprintoutsaredirectedtoanoutputdevicethat
isfunctioning.Iftheoutputdevicebecomesfaulty,alarm1432(disturbanceincommand
calendar)issetandthetaskisblocked.Beforethetaskcanbeexecuted,theprintouts
mustbedirectedtoafunctioningoutputdeviceandthetaskmustbeunblocked.An
exceptionarecommandfileswhoseexecutiondoesnotterminatewhenoneormore
commandsinthesefilesfails:thesetasksarenotblocked.Suchcommandfilesare
markedwithNOINTintheCFTYPEcolumnoftheprintoutproducedbytheICL
command.

Issue:09 DN02143068 95

MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

g IfyoudirecttheprintoutsalsototheBBU-0,theexecutionofacalendartask
doesnotterminatewhentheoutputdevicebecomesfaulty.Theprintoutsmust
bedirectedviaasemi-permanentlogicalfile.

ItisrecommendedthatyoudirecttheprintoutsalsototheBBU-0.

Figure 8 Displayingtheoutputdevicesofexecutionprintouts

1 Display the output devices of execution printouts


Displaytheoutputdevicestowhichtheexecutionprintoutsofcalendartasksare
directed(IID).
ZIID::<logical file name>;

Example:

ThefollowingcommanddisplaystheoutputdevicestowhichCOMCALisconnected:

ZIID::COMCAL;

2 Check whether an output device is functioning (IHI)


TointerrogatetheoperatingstateofallI/Ounitsinallcomputerunits,givethe
followingcommand:
ZIHI:;

3 Direct execution printouts to the BBU-0

1. Createasemi-permanentlogicalfileandconnectittoBBU-0(IIF)
Thefollowingcommandcreatesasemi-permanentlogicalfilenamed
BYTEBASKETintheOMUoftheuser'sownsystemandconnectsittotheBBU-0:
ZIIF::BYTEBASKET,S:DEV=BBU-0;
2. Addthesemi-permanentlogicalfileasanobjecttoCOMCALlogicalfile(IIS)
ThefollowingcommandaddsBYTEBASKETasanobjecttoCOMCAL:
ZIIS::COMCAL::LF=BYTEBASKET;

4 Save execution printouts in a disk file

1. Createthediskfiletowhichyouwanttodirecttheprintouts(IWC)

96 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

ThefollowingcommandcreatesadiskfilenamedCCALENDAR.Thefileisstored
intheMMDIREdirectory.TheextensionofthefileisLOG.
ZIWC::WS:MMDIRE:CCALENDAR,LOG;
2. AddtheharddiskofthesystemandbackupdisksasanobjecttotheCOMCAL
logicalfile(IIS)
ZIIS::COMCAL::DEV=WDU-S;
3. LinktheCOMCALlogicalfiletothediskfileyoucreated(III)
ThefollowingexamplelinksCOMCALtoadiskfilenamedCCALENDARthatis
locatedintheMMDIREdirectory.TheextensionofthefileisLOGandthefileisa
ringfile.
ZIII::COMCAL:,MMDIRE:CCALENDAR,LOG,,RF;

Expected outcome

Theexecutionprintoutsofcalendartasksaredirectedtotheoutputdevice.

Related topics
Descriptions

MMLcommandcalendar

7.4 Adding a task to the command calendar in MML


Before you start

Calendartasksareexecutedonlyiftheirexecutionprintoutsaredirectedtoanoutput
devicethatisfunctioning.

Whenyouaddacommandtoadiskcommandfilethatisinthecalendar,youcannot
givevaluestotheexecutionparametersofthefileatthesametime;youcanonlyenter
theparametersofthecommandyouareaddingtothefile.

Purpose

Thisproceduregivesinstructionsonhowtoaddanewtasktothecommandcalendar.

Youcancheckwhetheryousucceededinaddingatasktothecalendarbydisplayingthe
contentsofthecalendar.

1 Enter the ICI command


Selectoneofthefollowingalternatives:

EntertheICIcommandasanormalMMLcommandwhenaddingacommandfile
createdearlier
Ifyouaddacommandfilethatwascreatedearlier,entertheICIcommandin
thesamewayasMMLcommandsarenormallyentered.
EntertheICIcommandwhencreatingacommandfile
Ifyou

Issue:09 DN02143068 97

MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

addacommand
createacommandfileandadditatthesametimetothecalendaror
addacommandtoacommandfilethatisinthecalendar

givethecommandasfollows:

1. Addacommandtothecalendar(ICI)
ZICI:<mml command code>,<semantics>::DATE=<execution
date>, TIME=<execution time>;
Thefollowingtextisdisplayed:

YOU HAVE 5 MINUTES TO GET COMMAND READY


COMMAND EXECUTED
VERSION 3.3-0
### INPUT TO COMMAND CALENDAR ###
/* PARAMETERS:
COUNTER GROUP, STATISTICS: COUNTERS */

GCU:
2. EntertheparametersoftheMMLcommandyouareaddingtothecalendar
Youhavefiveminutestoentertheparameters.Youcanenterthemby
makinguseoftheparameter guide.Afteryouhaveenteredtheparameters,
theoutputcontrolblockisdisplayed.
3. Enterasemi-colon(;)tocompletethecommand
TheGCUcommandisaddedtothecalendarandtheidentifierofthe
calendartask(TASKID)isdisplayed.Seethefollowingexample:

INPUT STARTED
COMMAND ADDED TO CALENDAR
TASK ID = 2
COMMAND EXECUTED
TheTASKIDistheidentifierthatyouneedtoidentifythetaskwhenyou
handleitusingcommandsICM,ICD,ICL,ICT,andICB:itisthevalueofthe
calendar task identifierparameter.

Example:Adding the GCU command to the calendar


Semanticsarecheckedduringcommandexecution(NOSEM).Thecommandis
executedonceonSeptember14th2000,at12.50.
ZICI:GCU,NOSEM::DATE=2000-9-14,TIME=12-50;
Example:Adding the CMDFILE command file to the calendar
Sincethefilehasbeencreatedearlier,thevalueofthecommandfileindex
parameteris0.Ifanyofthecommandsinthefilefails,theexecutionofthefile
terminates(INT).ThecommandisexecutedonJune15th(NBR=10)2000,at00:00.
Thetaskisexecutedonceaday(PTYPE=DAandPNBR=1)tentimes.Afteritslast
execution,thetaskremainsinthecalendar(SAVE=Y).
ZICI::CMDFILE,0,INT:DATE=2000-06-15,TIME=00-00,
PTYPE=DA,PNBR=1,NBR=10,SAVE=Y;
Example:Creating a new command file and printing commands to output
device

98 DN02143068 Issue:09

ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

ThefollowingcommandcreatesanewcommandfilenamedBACKUP;writesone
command(IWD)toitandaddsittothecommandcalendar.Command(IWD)is
printedtooutputdevicewhenitisexecuted.Ifthecommandinthefilefails,the
executionofthefileisterminated.ThecommandisexecutedonAugust16th2000,
at00.00.
ZICI:IWD:BACKUP,,INT:DATE=2000-08-16, TIME=00-00,CMNDS=YES;
Example:Adding the IBC command to the end of the command file in the
calendar
Thefollowingexampleaddsthecommand(IBC)totheendoftheBACKUP
commandfilethatisinthecalendar.
ZICI:IBC:BACKUP;
Example:Adding the IID command to the calendar
Thetaskisexecutedeachtimealarm2600isdetectedandsetbytheOMU.
ZICI:IID::ALARM=2600,AUNIT=OMU,ASTATE=ALARM,NBR=255;

Expected outcome

Anewtaskisaddedtothecommandcalendar.

7.5 Testing calendar task execution in MML


Purpose

Thisproceduregivesinstructionsonhowtotesttheexecutionofacalendartask.

1 Test the execution of a calendar task (ICT)


ZICT:<calendar task identifier>;

Example:Starting a task with a certain identifier

Thefollowingcommandimmediatelystartsthetaskthathasano.2identifier.

ZICT:2;

Expected outcome

Theexecutionofacalendartaskistested.

7.6 Modifying a calendar task in MML


Purpose

Withthisprocedure,youcan:

Issue:09 DN02143068 99

MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

changetheexecutionparametersofacalendartask.Forexample,youcanchange
theexecutiontimeofataskorgiveanewexecutiontimetoataskthatwasleftinthe
calendarafteritslastexecution.
editanMMLcommandthatisinthecalendar,includingMMLcommandsindisk
commandfilesthatareinthecalendar.
replaceonetypeofataskbyanothertypeofatask,thatis,replaceacommandbya
commandfile,oracommandfilebyacommand.

Notethatwhenyoueditacommandorreplaceonetypeofataskbyanothertypeofa
task,youcanalsochangetheexecutionparametersofthetask.

Whenyouaddacommandtoadiskcommandfilethatisinthecalendar,youcannot
givevaluestotheexecutionparametersofthefileatthesametime;youcanonlyenter
theparametersofthecommandyouareaddingtothefile.

1 Identify the type of modification (ICM:<modify task>)


Toidentifythetypeofthemodification,usethemodify taskparameteroftheICM
command.
Ifyoudonotsupplytheparameter,themodificationonlyconcernstheexecution
conditions(COND)ofthecalendartask.

2 Identify the task to be modified (ICM:<calendar task identifier>)


Ifyoumodifyacommandthatisinacommandfile,youalsoneedtoidentifythe
commandbythecommand file indexparameter.Ifneeded,displaythetask
identifiersandthecommandindexesusingtheICLcommand.
Theidentifieristhenumberthatisgiventothetaskafterithasbeenaddedtothe
calendarusingtheICIcommand.
ZICM:<calendar task identifier>,<modify task>::ALARM=<alarm
number>, AUNIT=<alarm unit name>,ASTATE=<alarm state>,
NBR=<number of execution>;

3 Change the execution parameters of the file


Selectoneofthefollowingalternatives:

EntertheICMcommandasanormalMMLcommand,ifyouonlymodifythe
executionparametersofacalendartaskorreplaceacommandbyacommand
file.
Modifyacommandinthecalendar(ICM)
ZICM:<calendar task identifier>,<modify task>::ALARM=<alarm
number>, AUNIT=<alarm unit name>,ASTATE=<alarm state>,
NBR=<number of execution>;

1. Confirmcommandexecution
AnswerYtoconfirmtheexecutionofthecommandwhenthesystemasksfor
aconfirmation.

100 DN02143068 Issue:09


ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

Thesystemdisplaysthetimeyouhavetoenterthecommand,theparameter
guideofthecommandyouareediting(notifyoueditacommandthatisina
commandfile)andthethreecommandlettersofthecommandyouwantto
editorsubstituteforthecommandfile.Seethefollowingexampleofthe
printout:

YOU HAVE 5 MINUTES TO GET COMMAND READY


COMMAND EXECUTED
VERSION 3.3-0
### INPUT TO COMMAND CALENDAR ###
/* PARAMETERS:
COUNTER GROUP, STATISTICS: COUNTERS */

GCU:
2. EntertheparametersoftheMMLcommand
EntertheparametersoftheMMLcommand.Or,iftheparametersare
displayed,editthem.
Youhavefiveminutestohandletheparameters.Youcanenterthemby
makinguseoftheparameterguide.Afteryouhaveenteredtheparameters,
theexecutiondeterminationblockisdisplayed.
3. Completethecommandbyenteringasemi-colon(;)

Further information
Example:Changing the execution parameters of a calendar task
Thefollowingcommandchangestheexecutionparametersofacalendartaskwith
identifier47.Thetaskisexecutedwhenalarm1635isset.Commandsarenot
printedtooutputdevice.
ZICM:47,::ALARM=1635,AUNIT=,ASTATE=ALARM,NBR=255,CMNDS=NO;
Example:Editing a command and changing its execution time
Thefollowingcommandeditsacommandwithidentifier4andchangesitsexecution
time.Theexecutionofthecommandstartsat13:30.Thesemanticsofthecommand
arecheckedduringitsexecution.
ZICM:4,EDIT:CHECK=NOSEM:TIME=13-30;

Expected outcome

Thetaskismodifiedandthetaskidentifier(TASKID)isdisplayed.

INPUT STARTED
COMMAND ADDED TO CALENDAR
TASK ID = 2
COMMAND EXECUTED

7.7 Deleting a calendar task in MML


Purpose

Whenyoudeleteacommandfile,thefileisremovedfromthecalendar,butnotfromthe
systemdiskanditcanbeusedagain.

Issue:09 DN02143068 101


MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

1 Delete a calendar task (ICD)


ZICD:<task identifier>,<command file index>;

Example:Deleting a calendar task with a certain identifier

Thefollowingcommanddeletesthecalendartaskthathasano.32identifier.

ZICD:32;

Expected outcome

Thecalendartaskisdeleted.

Related topics
Descriptions

MMLcommandcalendar

7.8 Blocking or unblocking a calendar task in MML


Purpose

Ifataskcannotbeexecuted,alarm1432(disturbanceincommandcalendar)issetand
thetaskisusuallyblocked.Blockedtasksareintheblockedcommandsqueue(BLC).
Anexceptionarecommandfilesthataremeanttobeexecutedmorethanonceand
whoseexecutiondoesnotterminatewhensomeofthecommandsinthefilefails:such
commandfilesaremarkedwithNOINTintheCFTYPEcolumnoftheprintoutproduced
bytheICLcommand.Whentheexecutionofsuchataskfails,thetaskisnotblocked
butthetaskremainseitherinthetimequeueortheeventqueue.Tocheckwhethersuch
ataskhassuccesfullybeenexecuted,examinetheMMLcommandlog.

Beforeablockedtaskcanbeexecuted,thefaultmustbecorrectedandthetaskmustbe
unblocked.Forinformationonthepossiblefaults,seeExecution of a calendar task fails.

1 Check whether a task is blocked


Selectoneofthefollowingalternatives:

Tocheckwhetherthetaskisblocked,displaytheblockedcalendartasks(ICL)
ZICL:QUE=BLC;
Tocheckwhetherthetaskisunblocked,displaythecommandcalendarqueue
(ICL)
ZICL
Thefollowingprintoutisdisplayed:
ID USER
CMND CFILE QUE DATE TIME NBR PNBR PTYPE ALARM
=======================================================================
1 SYSTEM

102 DN02143068 Issue:09


ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar

IID - BLC 2000-02-01 19:00 1 - - -

2 SYSTEM
- BACKUPFILES TIM 2000-02-01 19:00 1 - - -

3 SYSTEM
- BACKUPFILES TIM 2000-02-04 20:00 FOREV 1 WEEK -

6 SYSTEM
- ALASTATUS EVE - - - - - 2692

COMMAND EXECUTED
Ataskthatisexecutedonceisunblockedifitisinthewaitqueue(HOL).The
taskisleftinthecalendar,butitisnotexecutedunlessyouchangeitsexecution
parameters.
Ataskthatisexecutedmorethanonceisunblockedifitiseitherin

thetimequeue(TIM)or
theeventqueue(EVE).

Thetaskisexecutedthenexttimeatthemomentdeterminedbyitsexecution
parameters.

2 Block a calendar task (ICB)


Ifataskdoesnotneedtobeexecutedforawhileandyoudonotwanttochangeits
executionparametersorremoveitfromthecalendar,blockthetask.Ablockedtask
isnotexecuteduntilyouunblockit.
ZICB:<task identifier>;

Example:Blocking a task with a certain identifier

Thefollowingcommandblocksataskwithidentifier11.

ZICB:11;

3 Unblock a calendar task (ICB)


ZICB:<task identifying>:<task>;
Youcancheckwhethertheunblockingwassuccesfullbyexaminingthequeuein
whichthetaskis.

Example:Unblocking a task with a certain identifier

Thefollowingcommandunblocksataskwithidentifier11.

ZICB:11:UNBLOCK;

Expected outcome

Acalendartaskisblockedorunblocked.

Issue:09 DN02143068 103


MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC

7.9 Stopping an MML command file execution


Purpose

Theexecutionofthefilestopsafterthecommandthatisbeingexecutedatthemoment
hasbeenexecuted.

Ifthiscommandfailstostoptheexecutionofacommandfile,seetheinstructionsgiven
inTerminationofanMMLcalendartaskthatisacommandfilefails.

1 Stop the execution of a command file (ICS)


ZICS:<command file name>;

Example:Stopping the execution of COPYDIR command file

ThefollowingcommandstopstheexecutionofacommandfilenamedCOPYDIR.

ZICS:COPYDIR;

Expected outcome

Theexecutionofthefileisstopped.

104 DN02143068 Issue:09


ExecutingMMLCommandsinIPA-RNC MMLcommandtroubleshooting

8 MML command troubleshooting

8.1 Execution of a calendar task fails


Description
Ifalarms1432DISTURBANCEINCOMMANDCALENDARand2430ERRORIN
COMMANDCALENDARaregiven,refertotheirinstructions.Thefollowingare
instructionsforthemostcommonerrorsthatsetoffthealarm1432.

Alarm1432issetandthetaskisblockedandtransferredtotheblockedcommands
queue.Anexceptionaretasksthataremeanttobeexecutedmorethanonceandwhose
executionisnotterminatedevenifoneofthecommandsinthefilefails:suchtasksare
notblocked.

Symptoms
Thealarm1432isset.

Recovery procedures
Checking why execution of a calendar task fails
Steps

1 If execution printouts of calendar tasks are directed to printer, check the


printer and correct the possible faults.
a) Check printer (IHI).
TointerrogatetheoperatingstateofallI/Ounitsinallcomputerunits,givethe
followingcommand:
ZIHI:;
b) Correct printer fault.
Iftheprinterisnotfunctioning,checkthestateoftheLPDdeviceasinstructedin
Printing tasks are not output.
c) Unblock the calendar task (ICB)
Forinstructions,seeBlockingorunblockingacalendartaskinMML.

g Youarerecommendedtodirecttheexecutionprintoutsofcalendartasks
alsototheBBU-0.Forinstructions,see
DirectingtheexecutionprintoutsofMMLcommandcalendartasks.Ifthe
printoutsaredirectedtotheBBU-0,thecommandcalendarfunctionsevenif
theactualoutputdeviceisnotfunctioning.

Issue:09 DN02143068 105


MMLcommandtroubleshooting ExecutingMMLCommandsinIPA-RNC

2 If execution printouts of calendar tasks are directed to disk file, Check the
disks and correct the possible faults.
a) Check disks (IHI).
Checkwhetherthedisksaredamaged.Forexample,todisplayinformationon
thestateoftheharddiskunit,usethefollowingcommand:
ZIHI::WDU;
b) Block the calendar task, if the disks are damaged (ICB).
Ifthedisksaredamaged,replacethem.Forinstructions,seeHard disk is faulty.
UnblockthetaskusingtheICBcommand(seeBlockingorunblockingacalendar
taskinMML).
c) Check file space, if the disks are not damaged (IWX).
Ifthedisksarenotdamaged,checkwhetherthefilehasfreespace.For
example,tocheckwhetheradiskfilenamedCCALENDAR(extensionLOG)thatis
storedintheMMDIREdirectoryofthesystemdiskhasfreespace,usethe
followingcommand:
ZIWX::WS:MMDIRE:CCALENDAR,LOG;
d) If there is no free file space, direct the printouts to another file and unblock
the calendar task.
Ifthefilehasnofreespace,directtheprintoutstoanotherfile,preferablytoa
ringfile.Forinstructions,seeDirectingtheexecutionprintoutsofMMLcommand
calendartasks.Forinstructionsonunblockingatask,seeBlockingorunblocking
calendartasksinMML.

g Youarerecommendedtodirecttheexecutionprintoutsofcalendartasks
alsototheBBU-0.Forinstructions,see
DirectingtheexecutionprintoutsofMMLcommandcalendartasks.Ifthe
printoutsaredirectedtotheBBU-0,thecommandcalendarfunctionsevenif
theactualoutputdeviceisnotfunctioning.

8.2 Termination of an MML calendar task that is a


command file fails
Description
TerminationofanMMLcalendartaskthatisacommandfilefails.

Symptoms
Thetaskisintheexecutionqueueanditsexecutioncannotbeterminatednormally.

106 DN02143068 Issue:09


ExecutingMMLCommandsinIPA-RNC MMLcommandtroubleshooting

Recovery procedures
Terminating a calendar task that is a command file
Steps

1 Restart the Command Calendar Program Block (ODR)


TakearemoteserviceterminalsessiontotheworkingOMUunit:
ZDDS;
RestarttheCommandCalendarProgramBlockfromtheserviceterminalbyentering
thefollowingserviceterminalcommand:
ZODR:AB
whereABistheprocessIDoftheCommandCalendarProgramBlock.

2 Restart the Command Calendar Disk Interface Program Block


RestarttheCommandCalendarDiskInterfaceProgramBlockfromtheservice
terminal.Proceedasfollows:

1. Enterthefollowingserviceterminalcommand:
ZODR:97
where97istheprocessIDoftheCommandCalendarDiskInterfaceProgram
Block.
2. Enterthefollowingserviceterminalcommand:
ZOS:*,*,97,,,,,1,,,,,,,
3. Thetaskistransferredtotheblockedcommandsqueue.Thecommandcalendar
startstofunctioninoneminute.

3 Return to MML
ReturntoMML:
ZE;

4 Unblock the calendar task (ICB)


Forinstructions,seeBlockingorunblockingacalendartaskinMML.

8.3 Opening an MML session fails


Description
IfopeninganMMLsessiontotheactiveOMUfails,usethisproceduretoopenthe
sessionviathespareOMU.Thisprocedureshouldnotbeusedinnormalcircumstances.

Formoreinformation,seeOpeningandclosingMMLsessions

Issue:09 DN02143068 107


MMLcommandtroubleshooting ExecutingMMLCommandsinIPA-RNC

Symptoms
OpeninganMMLsessiontotheactiveOMUfails.

Recovery procedures
Opening an MML session via spare OMU
Steps

1 Enter spare OMU IP address


ChangetheIPaddressoftheconnectiontobetheIPaddressofthespareOMU.The
waytodothisdependsonyourTelnetorSSHapplication.

2 Enter your user ID


EnteryouruserIDwhenthesystemasksyouto(ENTER USERNAME <).

3 Enter your password


Enteryourpasswordwhenthesystemasksyouto(ENTER PASSWORD <).

g Passwordsarecasesensitive.Youmustusethecorrectupperorlowercase
asdefinedinyouruserID.

Thesystemdisplaysawarningtextwhichsaysthatyouhaveopenedthesessionvia
thespareOMU.
ThewelcomedialogueandtheMAIN LEVEL COMMANDpromptaredisplayed.This
meansthatyouhaveopenedanMMLsessionandyoucanenterMMLcommands.

108 DN02143068 Issue:09