Professional Documents
Culture Documents
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
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.
Thedefaultvalueofstoringtimeanddiskspaceconsumptionischangedfrom3
daysto30days.
Theexecutionprintoutisupdated.
BlockingorunblockingacalendartaskinMML(6.8)
Theexecutionprintoutisupdated.
8 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands
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
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:
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 .
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
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:
Asemanticerrormessageisdisplayedwhenparametervalueshavebeengiven
incorrectly,forexample,inthewrongorder.Somemessagesarecommand-specificand
somecanapplytoseveralcommands.Informationonmessagesoftheformerkindis
giveninthecommanddescriptionofthecommandinquestion.Messagesofthelatter
kindarelistedinGeneralNoticeMessagesofMMLSession.Belowisanexampleofa
semanticerrormessage:
12 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC OverviewofMMLcommands
Asyntaxerrormessageappearswhenthestructureofacommanddoesnotfollowthe
syntacticrulesofthecommand.SyntaxerrormessagesarelistedinGeneralNotice
MessagesofMMLSession.Belowisanexampleofasyntaxerrormessage:
GeneralerrormessagesarelistedinGeneralErrorMessagesofSystem.Belowisan
exampleofageneralerrormessage:
Guidance messages
GuidancemessagesgiveinformationonthevariousphasesofanMMLsession.They
describe,forexample,themeaningofparametersandthesyntacticstructureofa
command.GeneralguidancemessagesarelistedinGeneralNoticeMessagesofMML
Session.
Notice messages
NoticemessagesgiveinformationonthevariousphasesofanMMLsession.Notice
messagesarelistedinGeneralNoticeMessagesofMMLSession.Belowisanexample
ofanoticemessage:
COMMAND EXECUTED
Related topics
Descriptions
MMLcommandexecution
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
Diskcommandfile ExecutingMMLcommandsequences
MMLmacro ExecutingcomplicatedMMLcommandsequences
Commandcalendar ExecutinganMMLcommandoradiskcommandfileonceorrepeatedly
atapredeterminedmoment(timeoralarm)
Commandlog Storinginformationofcommandsyouhaveexecuted
Related topics
Descriptions
DiskcommandfilesinMML
MMLcommandcalendar
MMLcommandexecution
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.
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.
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
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
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(;).
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.
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
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
Table 3 Examplesofthegroupingofsingleparameterarguments
1&2 1and2
3&&5 3,4and5
Differentcharacterscanbeusedtogroupargumentswithinthesameparametervalue.
Forexample,1&3&&6meansarguments1,3,4,5and6.
& Groupstwocombinationparameterargumentswithinthesame
parametervalue.
&- Groupscombinationparameterargumentswhenagroupof
parametersdiffersonlyintheirlastinformationunit.Thefirstargument
iscompletelyspecified,whereastheothersarerepresentedonlyby
theirlastinformationunits.
&&- Groupsargumentswhenagroupofargumentsdiffersonlyintheirlast
informationunitandconstitutesaconsecutivesequence.The
argumentsareindicatedbywritingthelowerandupperinformation
units.Thelastinformationunitisincrementedbyone.
Seetheexamplesinthefollowingtable.
Table 4 Groupingcompoundparameterarguments
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).
ZIWX::WS:MMDIRE:%,CMD;
Syntaxofthecommand:
ZIWX::<drive>:<subdir>:<filename>,<extension>;
Related topics
Descriptions
MMLcommandexecution
TheeditorisoperatedfromthekeyboardoftheMMLterminal.Youcanuseavarietyof
keysandkeycombinationstosearchandeditMMLcommandsandcharacters.Youdo
nothavetostarttheeditor:itisavailablewhenyouaretypingMMLcommands.
Belowisalistoflineeditorkeyscategorizedaccordingtotheirfunctions.
Issue:09 DN02143068 21
OverviewofMMLcommands ExecutingMMLCommandsinIPA-RNC
OR
OR
? + '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.
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:
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
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.
Related topics
Instructions
MMLcommandexecution
CTRL-T Printsamaximumof2048characters(forexample,MMLcommands,
executionprintoutsandguidancemessages)thatweredisplayed
duringtheMMLsessiononaprinter.Iftheprintingsucceeds,the
messagePRINTEDisdisplayed.Ifitdoesnotsucceed,themessage
PRINTER ERRORisdisplayed.
24 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC UsingMMLcommands
Related topics
Descriptions
MMLcommandexecution
Thescreeneditorfunctionsareusedforreadingcharactersandforeditingcharacters
whichareonthescreen.Thetextcanbeeditedusingthespecialandcommand
characters.
Special characters
CTRL-Y Terminatescommandexecution.
Command characters
CTRL-A SwitchestheeditorfromtheINSERTmodetotheOVERSTRIKE
mode,orviceversa.IntheOVERSTRIKEmode,thenewcharacters
youtypeareplacedontopoftheoldcharacters,replacingthem.In
theINSERTmode,theoldcharactersaremovedforwardmaking
roomforthenewones,ifthereisroomattheendoftheline.
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 + CTRL-R
Movesthecursortothetoplefthandcornerofthefile.
CTRL-W Movesthecursortothebottomlefthandcornerofthescreen.Ifthe
cursorisalreadyinthebeginningofthelastline,itismovedtothe
endofthefile,thatis,tothebeginningofthefile'slastline.
CTRL-W + CTRL-W
Movesthecursortothebottomlefthandcornerofthefile.
CTRL-X Deletesthelinethecursorpointto.
Related topics
Descriptions
MMLcommandexecution
SpecialtextfilesusedinthesystemarecommandfilesandMMLmacros.Command
filesarerunwiththeIDEcommandorasataskofthecommandcalendar.
26 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC UsingMMLcommands
Thecommandfilemustalwaysstartwithacommentline.Thecommentistraditionally
markedwiththe/**/characterpair.Thegroupoftasksperformedbythecommandfile
shouldbedescribedonthecommentline.
Afterthecommentline,thecommandshavebeenlistedonseparatelinesinthe
commandfile.Thecommandsareintheorderofexecution.Eachlineisendedwiththe
semicolon,whichalsoendsanMMLcommand.
TheextensionpartofthecommandfilemustbeCMD.Otherwise,thecommandfilerun
willnotsucceedwiththeIDEcommand.Thecommandcalendaralsoassumesthe
extensionpartofthefiletobeCMD.
TheIEEcommandinitiatesascreeneditorwherethecommandandspecialcharacters
describedaboveareinuse.Thefiletobeeditedhassomerestrictionsonthenameand
directory,andtheseareexplainedinthecommanddescription.
Related topics
Descriptions
MMLcommandexecution
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.
g Passwordsarecasesensitive.Youmustusethecorrectupperorlower
caseasdefinedinyouruserID.
1. EnterZandasemi-colon(Z;)atthemainlevel
Tomovetothemainlevel,enterZandasemi-colon(Z;).
g Itisnotrecommendedtousethisprocedureinnormalcircumstances.Itis
bettertoclosetheMMLsessioninsteadofterminatingit.
1. PressBREAK
ToterminatetheMMLsessionpress BREAK .Youcanalsopress CTRL-Y :this
keycombinationterminatesthesessionwhenyouareenteringyouruseridentity
orpasswordortypingacommandatthemainlevel;orwhenyouhaveentered
thecommandclassletterordisplayedthecommandclassmenu.
Expected outcome
Atthetopofthescreentherearethetypeandthenameofthenetworkelementaswell
asthedateandthetime.Thebottomofthescreenindicatesthatyouareatthemain
level.
Thesessionisclosedwhenthefollowingmessageisdisplayed:
28 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC UsingMMLcommands
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.
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
30 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC UsingMMLcommands
/* PARAMETERS:
LISTING PARAMETER:
LISTING FORM;
*/
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:
Entertheexecutiontime,forexample:
ICL:DATE=2000-01-01,HOURS=1&&3
Enterthefollowingparametersofthecommandinthesamemanner.Enteracolonif
youwishtogivethedefaultvalue.
Afteryouhaveenteredthelastparameterthatthecommandrequires,theexecution
determinationblockisdisplayed:
ICL:DATE=2000-01-01,HOURS=1&3::
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
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.
ThisproceduregivesinstructionsonhowtoenterMMLcommandswithoutusingthe
onlinehelp.Whentheuserisexperiencedenough,hecangivethecommandsdirectly
withoutusingthemenuselectionorguidances.Thismakestheworkingefficientand
quick.
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
1. Pressthe'up'arrowtosearchforacommand
Searchthecommandyouwishtorepeatbypressingthe'up'arrow.
2. Executethecommand
ExecutethecommandbypressingENTERwhenthecommandisdisplayedafter
theprompt.
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
Youcanusecommandmenustomovefromthemainleveltothecommandclasslevel
and,finally,tosomeofthecommandgroupsinthatcommandclass(forexample,from
themainleveltotheUcommandclassand,finally,totheUScommandgroup).
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.
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.
Separatetheparameterfromotherparameters(,)
Ifotherparametersmustbeenteredbeforetheparameterblockends,entera
comma(,)toseparatetheparameterfromtheotherparameters.
Separatetheparameterfromthefollowingparameterblock(:)
Iftheparameterblockendsaftertheparameter,enteracolon(:)toseparatethe
parameterfromthefollowingparameterblock.
Omitthevaluesoftheparametersandthecommathatwouldfollowoneofthese
parameters:
ZIDL:WDU,0,COMMANDS:;
Expected outcome
Defaultvalueisgivensuccesfully.
Issue:09 DN02143068 37
UsingMMLcommands ExecutingMMLCommandsinIPA-RNC
ThisproceduregivesinformationonhowtochangethelanguageofMMLcommand
menus.
1 Press CTRL-K
Ifseverallanguagesareinuse,youcanchangethelanguageofcommandmenus
pressing CTRL-K .
Expected outcome
ThelanguageofMMLcommandmenusischanged.
g OnlyfortheuseofMMLprogramdesigners.
Theseinstructionsarenotrelevantinnormaloperationoftheexchange.
1 Press CTRL-4
TosetanMMLprogramintheteststateandtodisplaythehelpprintoutsthatare
usedinthetestingoftheprogram,press CTRL-4 .
Expected outcome
TheMMLprogramissetintheteststate.
38 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC UsingMMLcommands
YoucandefineanidletimelimitforMMLsessionsafterwhichtimethesessionisclosed
automaticallyifthereisnointeractionorcommandexecution.Youcanchangetheidle
timevaluewithtwoMMLcommands,theIAXcommandandtheIAAcommand.The
timelimitcanbedefinedindividuallyforeachuserprofile.Thechangetakesimmediate
effectonyourcurrentsession;otherusersmustreloginbeforethechangeiseffective.
ThevaluerangeoftheMMLsessionidletimelimitis1to60minutes.Thedefaultvalue
is15minutes.
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
YoucancreateandeditMMLmacros.CertainMMLmacrotypesaresuppliedbyNokia
SiemensNetworksandcannotbeeditedbyusers.
TheplanningofamacroisusuallystartedbygivingitanMMLmacroname.
MMLmacrosareuseful,forexample,whenexecutingcommandsequencesthatneedto
beexecutedrepeatedly.Theycanbeusedtocarryoutmorecomplicatedtasksthandisk
commandfilesbecausetheycontainbothMMLcommandsandprogrammablelogic.
However,unlikediskcommandfiles,theycannotbeexecutedinthecommandcalendar.
MMLmacrosarestoredindiskfiles.SeebelowanexampleofanMMLmacrothat
copiestheneededfilefromthesourcedirectorytothedestinationdirectoryonboth
disks.Notethatthemacrocontainsadescriptiononwhatthemacrodoes.
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
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.
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
Figure 6 MMLmacronames
TheMMLmacroscreatedbyNokiaSiemensNetworksarenamedinaslightlydifferent
manner.Donotchooseasthenameofyourmacrothecombinationofthefourth,fifth,or
sixthcharacterofanexistingNokiaMMLmacroname.Alsoavoidchoosingthe
combinationofthefourthandfifthcharacterofanalreadyexistingNokiaMMLmacro
name.Inotherwords,avoidputtingyourMMLmacrointhesameMMLgroupwiththe
NokiaMMLmacros.
Related topics
Descriptions
MMLmacros
Issue:09 DN02143068 43
MMLmacros ExecutingMMLCommandsinIPA-RNC
anidentificationstring
amenu
aheader,declarationandexecutionpart.
Thethreesectionsareseparatedbymeansofasemicolon(;).
OnthefirstlineoftheMMLmacro,therehastobeanidentifiercharacterstringasa
comment.
TheheaderpartalwayscontainsthenameoftheMMLmacro,eitherwithorwithoutan
extension.Ifthemacrousesparameters,theyarepresentedintheheader.Thedefinition
sectioncontainsthedefinitionsfortheparametersandvariables.Theexecutionpartis
madeupofcommandlanguagestatements.
Related topics
Descriptions
MMLmacros
StructuralpartsofthecommandlanguageinMMLmacros
MenutextsinMMLmacros
HeaderinMMLmacros
DeclarationandexecutionpartsinMMLmacros
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
AmenutextonalineofitsowncorrespondstothreecharactersoftheMMLmacroshort
start-upmethodcommand.Thecommandcharactersarethesameascharacters4-6of
theMMLmacro.Themenulinestartswiththe($)characterwhichisfollowedbya
commandcharacter.
ExampleofanMMLmacromenutext:
Related topics
Descriptions
MMLmacros
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
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 */
?SOURCE "
/* GIVE SOURCE DIRECTORY */", /* string length 40 */
/* Variables */
Execution part
ItisthefunctionoftheexecutionpartofanMMLmacrotoprocessdataandtoexecute
tasksorseriesoftasksbymeansofacommandlanguagetranslator.Theexecutionpart
containscommandlanguagestatements,whichcanbesimpleorstructured.The
statementsendinasemicolon(;).Emptystatementswhichonlyincludeasemicolonare
notallowed.
Related topics
Descriptions
MMLmacros
Issue:09 DN02143068 49
MMLmacros ExecutingMMLCommandsinIPA-RNC
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
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;
:
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;
:
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
ThedelaystatementstopstheexecutionofanMMLmacroforagivenperiodoftime.
Thestatementbeginswiththekeyword'delay',whichisfollowedbythedtimein
brackets:anintegerconstantindicatingamultipleof10ms.
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
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:
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:
Related topics
Descriptions
MMLmacros
54 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLmacros
anoperand(ifany)precedingthenot-operator
operand,operatorandoperand
libraryroutine.
Theoperandcanbeavariableoraconstant.
Related topics
Descriptions
MMLmacros
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
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
ExampleofanMMLcommandinanMMLmacroisasfollows:
:
IBC:,,?FILENAME,?EXTENSION;
if error then;
:
Related topics
Descriptions
MMLmacros
Issue:09 DN02143068 57
MMLmacros ExecutingMMLCommandsinIPA-RNC
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);
Thefunctionstartswithacharacterstringtypeofvariable,followedbytheplacement
operator(=),thekeywordnum_to_dstr,andfinally,inbrackets,theobjectofthe
conversion,theintegervariableorconstant.
Exampleofnum_to_dstrisasfollows:
?NUM_VAR = 25;
?STR_VAR = num_to_dstr(?NUM_VAR);
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);
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);
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
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;
60 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLmacros
Theuseoftheroutinestartswiththekeywordcurrentstr,followed,inbrackets,bythe
requestedcharacter-stringconstant,oracharacterstringvariablecontainingthestringin
question.
TheexampleinthefollowingfigureisofasearchforthefirstFLTYstringinanexecution
messageoftheUSIcommand.
Exampleofcurrentstrisasfollows:
USI:DMCU;
currentstr("FLTY");
Whentheroutineisused,thestatementonlycontainsthekeywordcurrentln.
Inthefollowingexample,thestringOMUissearchedforandthebuffer'spointerissetto
thebeginningofthelinethatcontainsthesaidstring.
Exampleofcurrentlnisasfollows:
currentstr("OMU");
currentln;
Theroutinebeginswiththekeywordprevlnwhichisfollowedbyapairofbrackets
containingthenumberoflinesasanintegerconstant,orgivenbymeansofaninteger
variable.
Exampleofprevlnisasfollows(thestringDMCUissearchedandthepointerismoved
twolinesback):
?LINE_COUNT = 2;
currentstr("DMCU");
prevln(?LINE_COUNT);
Theroutinebeginswiththekeywordnextlnwhichisfollowedbyapairofbrackets
containingthenumberoflinesasanintegerconstant,orgivenbymeansofaninteger
variable.
Issue:09 DN02143068 61
MMLmacros ExecutingMMLCommandsinIPA-RNC
ThefollowingisanexampleofhowanexecutionmessageoftheUSIcommandis
handledbythevariouslibraryroutines:thestateoftheOMUisreadintothevariable
OMU_STATE,thenameofthenextreadintothevariableUNIT2,andfinallythestateof
theunitthatisbottomontheunitlistisreadintothevariableLAST_STATE,andthe
pointeristhenmovedtothestartofthelineinquestion.
ExampleofanexecutionmessagefortheUSIcommand.
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
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
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.
Related topics
Descriptions
Shortstart-upmethodforMMLmacros
Longstart-upmethodforMMLmacros
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
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:
TheuserentersontheMMLterminal
eithertheentirecommandonce:
Related topics
Instructions
ExecutinganMMLmacro
Descriptions
ExecutionofMMLmacros
Issue:09 DN02143068 65
MMLmacros ExecutingMMLCommandsinIPA-RNC
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.
Expected outcome
AnMMLmacroistested.
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.
ThisproceduregivesinstructionsonhowtolistMMLmacros.
Example:
AstheextensionofMMLmacrosisEMMandastheyarestoredintheMMDIRE
directory,thefollowingcommanddisplaysalltheMMLmacrosinthesystem:
ZIWX::WS:MMDIRE:%,EMM;
Expected outcome
TheMMLmacrosarelisted.
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:
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
ThisproceduregivesinstructionsonhowtodisplaythecontentsofanMMLmacro.
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
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
removaltimeofoldlogfiles:
AlltheotherinformationexceptforMMLcommandsiswrittenbetweenthecomment
tokens/*and*/.However,ifcommandsthatcannotbeexecutedusingacommandfile
areprintedtothefile,thefilewillnotbeexecuted.
ThemeaningoftheMMLcommandloginformationondifferentlinesisasfollows:
Firstlinedisplaysthenameofthenetworkelementyouareusing,itstype,youruserID,
thedateandtimewhentheoutputwascreated.
Otherlinescontaincommandlogrecords.Theserecordsgiveinformationonthestarting
orendingofeitheranMMLsessionorMMLcommand.Therearefourtypesoflog
records:
Issue:09 DN02143068 71
MMLcommandlogs ExecutingMMLCommandsinIPA-RNC
1. MMLsessionstartrecord,markedwithnumberone(1)
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.
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
Tomodifythestoringtime,usethePRFILEparameter1/38(parameter1inparameter
class38).Thedefaultstoringperiodisthecurrentdayplus3days.Thevaluerangeis3
to30days.
Expected outcome
ThestoringtimeoftheMMLcommandlogismodified.
74 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLcommandlogs
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.
Expected outcome
ThediskspaceconsumptionoftheMMLcommandlogismodified.
Theoldlogfilesaredeletedonceaday.Sincethisoperationplacesratherheavyaload
ontheOMU,itisrecommendedthatotheroperationsincreasingtheloadshouldnotbe
carriedoutatthesametime.
Tochangethetimewhentheoldcommandlogsareremoved,usethePRFILE
parameters3/38and4/38.Theformersetsthehourandthelattertheminutes.The
defaulttimeis1:25a.m..Thevaluerangesare00to23hoursand00to59minutes.
Issue:09 DN02143068 75
MMLcommandlogs ExecutingMMLCommandsinIPA-RNC
Expected outcome
TheMMLcommandlogremovaltimeischanged.
YoucandecreasetheloadinducedbythediskupdatingbymodifyingthePRFILE
parameter0/38.Theloaddecreaseswhenthevalueisincreased.Todisplaythecurrent
value,usetheWOIcommandandtomodifythevalue,usetheWOCcommand.Thevalue
showsthelengthoftimethelogisintheinternalwritecacheinseconds.Ifyoumodify
thevalue,thatis,lengthenthetime,moreloginformationmaybelostinerrorsituations.
Expected outcome
ThediskupdatingloadofMMLcommandlogisdecreased.
ThisproceduregivesinformationonhowtodisplayMMLcommandloginformation.
76 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLcommandlogs
ThefollowingcommanddisplaystheloginformationconcerningyourMMLsessions
onJune15th2000from12pmto4pmintextform.
ZIGO:2000-06-15,12-00,,16-00;
Expected outcome
MMLcommandloginformationisdisplayed.
Notethatifyoucreateasemipermanentlogicalfileinstep3,youcanstartfromstep5
laterinotherMMLsessions.Theinformationisprintedtothesamefileyoucreatedin
step1.
Purpose
YoucanprintinformationstoredintheMMLcommandlogtodiskfileusingthe
filenameparameteroftheIGOcommand.Ifyouwanttousethefileasadisk
commandfile,youmustcopyittotheMMDIREdirectoryandnameitsothatthe
extensionisCMD.Ifyouwanttoeditthefile,usetheIEEcommand.
Issue:09 DN02143068 77
MMLcommandlogs ExecutingMMLCommandsinIPA-RNC
Expected outcome
TheMMlcommandloginformationisprintedtoadiskfile.
Afterclosingalogfile,anewoneisopened.Thiscommandcanbeused,forexample,
whenyoubackupcopythesoftwarebuildandwanttoincludetheexactcopyofthelog
madebeforeaparticulartime.
Expected outcome
Thecommandlogfileisclosed.
78 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLcommandlogs
YoucanmonitorthestartingandendingofMMLcommandexecutionbyprintingthe
informationtoafileoranoutputdevice(nottheMMLterminal).
g DonotconnectMMLLOGtothealarmprinter.
Expected outcome
Informationisprintedtoafileoranoutputdevice.
WhenusingFTPorSFTP,IPmustbeconfiguredbothinthenetworkelementandthe
otherpostprocessingsystem.
Purpose
MMLcommandloginformationcanbetransferredfromanetworkelementtothe
postprocessingsystemusingFTPorSFTPandanappropriatecommandofthe
postprocessingsystem.
Expected outcome
MMLcommandloginformationistransferredtothepostprocessingsystem.
Issue:09 DN02143068 79
MMLcommandlogs ExecutingMMLCommandsinIPA-RNC
ThisproceduregivesinstructionsonhowtoprintMMLcommandloginformationviaa
logicalfile.
g Ifyoucreateasemipermanentlogicalfileinstep3,youcanstartformstep5
laterinotherMMLsessions.Theinformationisprintedtothesamefileyou
createdinstep1.
80 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLcommandlogs
Expected outcome
MMLcommandloginformationisprintedviaalogicalfile.
Issue:09 DN02143068 81
MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC
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:
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
Whenexecutingdiskcommandfiles,theonlyobligatoryparameterisfile name,which
identifiesthefile.Youcanusetheotherparameterstodothefollowing:
Related topics
Instructions
ListingMMLdiskcommandfilesinthesystem
DisplayingthecontentsofadiskcommandfileinMML
Creatingadiskcommandfileusingthesystem'sdiskfileeditorinMML
Issue:09 DN02143068 83
MMLdiskcommandfiles ExecutingMMLCommandsinIPA-RNC
ExecutingdiskcommandfilesinMML
InterrogatingoutputdevicesofexecutionprintoutsinMML
GivingparametervaluestoMMLcommandsinadiskcommandfile
StoppingtheexecutionofadiskcommandfileinMML
DirectingtheexecutionprintoutsofMMLcommandcalendartasks
PreventingthesavingofexecutionprintoutsofadiskcommandfileinadiskfileinMML
ThisproceduregivesinstructionsonhowtolistMMLdiskcommandfilesinthesystem.
ThefilesshouldbestoredintheMMDIREdirectoryofthesystemdisk.Their
extensionisCMD.
ZIWX::WS:MMDIRE:%,CMD;
Expected outcome
TheMMLdiskcommandfilesarelisted.
Thisproceduregivesinstructionsonhowtodisplaythecontentsofadiskcommandfile
inMML.
84 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles
Thefollowingexampledisplayscommands2-20inadiskcommandfilenamed
COMMANDS,whichislocatedinthefloppydiskunit1(FDU1)ofitsownunit:
ZIDL:FDU,1,COMMANDS:START=2,STOP=20;
Expected outcome
Thecontentsofadiskcommandfilearedisplayed.
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>;
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.
TheMMDIREdirectorymustexistonthedisk.Ifthisdirectorydoesnotexistonthedisk,
youcancreateitusingtheIWLcommand.
Purpose
ThisproceduregivesinstructionsonhowtoexecutediskcommandfilesinMML.
Expected outcome
Adiskcommandfileisexecuted.
Related topics
Descriptions
DiskcommandfilesinMML
86 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles
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.
ZIID::PRINTER0;
Expected outcome
Theinterrogationofoutputdevicesofexecutionprintoutsissuccessful.
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).
Expected outcome
Theparametervaluesaregiven.
Thisproceduregivesinstructionsonhowtostoptheexecutionofadiskcommandfile.
Expected outcome
Theexecutionofadiskcommandfileisstopped.
88 DN02143068 Issue:09
ExecutingMMLCommandsinIPA-RNC MMLdiskcommandfiles
ItisrecommendedthatyoulinkthePRINTER0logicalfiletoaringfile,becauseringfiles
donotfillup;instead,whenthereisnomorespaceinthefile,thenewestdatareplaces
theoldest.
Purpose
Thisproceduregivesinstructionsonhowtosaveexecutionprintoutsofadiskcommand
fileinadiskfileinMML.
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.
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
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
EachuserisauthorisedtodisplayallthetasksinthecalendarusingtheICLcommand.
Thedefaultwilldisplayallthetasks.Bygivingspecificvaluestocertainparametersof
thiscommand,youcanselectthetypesoftasksthatyouwanttodisplay.
Youcanproduceeitheracompleteoralimitedoutput:thedefaultproducesalimited
output.Toproduceacompleteoutputwithmoredetailedinformation,giveCOMasthe
valueofthelisting formparameter.
Thecommandsinthediskcommandfilesthatareinthecalendarcanalsobedisplayed.
Todisplaythesecommands,givethenamesofthecommandfilesasthevalueofthe
command file nameparameter.
Thefollowingcommandproducesacompleteoutputoftaskswithidentifiersranging
from1to6.
ZICL:ID=1&&6:COM;
Theexecutionprintoutofthecommandisasfollows:
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
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
Example:
ThefollowingcommanddisplaystheoutputdevicestowhichCOMCALisconnected:
ZIID::COMCAL;
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;
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
Calendartasksareexecutedonlyiftheirexecutionprintoutsaredirectedtoanoutput
devicethatisfunctioning.
Whenyouaddacommandtoadiskcommandfilethatisinthecalendar,youcannot
givevaluestotheexecutionparametersofthefileatthesametime;youcanonlyenter
theparametersofthecommandyouareaddingtothefile.
Purpose
Thisproceduregivesinstructionsonhowtoaddanewtasktothecommandcalendar.
Youcancheckwhetheryousucceededinaddingatasktothecalendarbydisplayingthe
contentsofthecalendar.
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:
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.
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.
Thisproceduregivesinstructionsonhowtotesttheexecutionofacalendartask.
Thefollowingcommandimmediatelystartsthetaskthathasano.2identifier.
ZICT:2;
Expected outcome
Theexecutionofacalendartaskistested.
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.
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.
ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar
Thesystemdisplaysthetimeyouhavetoenterthecommand,theparameter
guideofthecommandyouareediting(notifyoueditacommandthatisina
commandfile)andthethreecommandlettersofthecommandyouwantto
editorsubstituteforthecommandfile.Seethefollowingexampleofthe
printout:
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
Whenyoudeleteacommandfile,thefileisremovedfromthecalendar,butnotfromthe
systemdiskanditcanbeusedagain.
MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC
Thefollowingcommanddeletesthecalendartaskthathasano.32identifier.
ZICD:32;
Expected outcome
Thecalendartaskisdeleted.
Related topics
Descriptions
MMLcommandcalendar
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.
Tocheckwhetherthetaskisblocked,displaytheblockedcalendartasks(ICL)
ZICL:QUE=BLC;
Tocheckwhetherthetaskisunblocked,displaythecommandcalendarqueue
(ICL)
ZICL
Thefollowingprintoutisdisplayed:
ID USER
CMND CFILE QUE DATE TIME NBR PNBR PTYPE ALARM
=======================================================================
1 SYSTEM
ExecutingMMLCommandsinIPA-RNC MMLcommandcalendar
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.
Thefollowingcommandblocksataskwithidentifier11.
ZICB:11;
Thefollowingcommandunblocksataskwithidentifier11.
ZICB:11:UNBLOCK;
Expected outcome
Acalendartaskisblockedorunblocked.
MMLcommandcalendar ExecutingMMLCommandsinIPA-RNC
Theexecutionofthefilestopsafterthecommandthatisbeingexecutedatthemoment
hasbeenexecuted.
Ifthiscommandfailstostoptheexecutionofacommandfile,seetheinstructionsgiven
inTerminationofanMMLcalendartaskthatisacommandfilefails.
ThefollowingcommandstopstheexecutionofacommandfilenamedCOPYDIR.
ZICS:COPYDIR;
Expected outcome
Theexecutionofthefileisstopped.
ExecutingMMLCommandsinIPA-RNC MMLcommandtroubleshooting
Alarm1432issetandthetaskisblockedandtransferredtotheblockedcommands
queue.Anexceptionaretasksthataremeanttobeexecutedmorethanonceandwhose
executionisnotterminatedevenifoneofthecommandsinthefilefails:suchtasksare
notblocked.
Symptoms
Thealarm1432isset.
Recovery procedures
Checking why execution of a calendar task fails
Steps
g Youarerecommendedtodirecttheexecutionprintoutsofcalendartasks
alsototheBBU-0.Forinstructions,see
DirectingtheexecutionprintoutsofMMLcommandcalendartasks.Ifthe
printoutsaredirectedtotheBBU-0,thecommandcalendarfunctionsevenif
theactualoutputdeviceisnotfunctioning.
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.
Symptoms
Thetaskisintheexecutionqueueanditsexecutioncannotbeterminatednormally.
ExecutingMMLCommandsinIPA-RNC MMLcommandtroubleshooting
Recovery procedures
Terminating a calendar task that is a command file
Steps
1. Enterthefollowingserviceterminalcommand:
ZODR:97
where97istheprocessIDoftheCommandCalendarDiskInterfaceProgram
Block.
2. Enterthefollowingserviceterminalcommand:
ZOS:*,*,97,,,,,1,,,,,,,
3. Thetaskistransferredtotheblockedcommandsqueue.Thecommandcalendar
startstofunctioninoneminute.
3 Return to MML
ReturntoMML:
ZE;
Formoreinformation,seeOpeningandclosingMMLsessions
MMLcommandtroubleshooting ExecutingMMLCommandsinIPA-RNC
Symptoms
OpeninganMMLsessiontotheactiveOMUfails.
Recovery procedures
Opening an MML session via spare OMU
Steps
g Passwordsarecasesensitive.Youmustusethecorrectupperorlowercase
asdefinedinyouruserID.
Thesystemdisplaysawarningtextwhichsaysthatyouhaveopenedthesessionvia
thespareOMU.
ThewelcomedialogueandtheMAIN LEVEL COMMANDpromptaredisplayed.This
meansthatyouhaveopenedanMMLsessionandyoucanenterMMLcommands.