command file developer ops

8/7/2019 Command File Developer OPS

1/40

EHS/VM

3/1553-CRA 114 313 Uen Rev C2 1998-12-14 Ericsson Hewlett-Packard Telecommunications AB 1997All Rights Reserved

TMOS User Guide

Chapters:

1 Introduction 5

2 Overview 9

3 Using the Command File Developer 11

4 Task Examples 35

5 Glossary 40

Command Handling

Command File Developer (OPS)


2/40

Command Handling Command File Developer (OPS)

2 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

The contents of this document are subject to revision without notice due tocontinued progress in methodology, design, and manufacturing.

Ericsson shall have no liability for any errors or damages of any kind resultingfrom the use of this document.


3/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 3 (40)

1 Introduction 51.1 Prerequisites 51.2 Related Documents 51.3 User Interface Conventions 6

1.4 Typographic Conventions 61.5 General Information 71.5.1 Help Texts 71.5.2 Error Messages 8

2 Overview 92.1 The Window System 10

3 Using the Command File Developer 113.1 Starting CFD 113.2 Run Mode 123.3 Edit Mode 143.4 The Upper Control Panel 15

3.4.1 Network Element 153.4.2 The Mode Selector 163.4.3 File Menu 163.4.4 View Menu 183.4.5 Edit Menu 193.4.6 Find Menu 203.4.7 The Documentation Menu 21

3.5 Load File Window 223.6 Save File Window 233.7 Print File Window 24

3.8 View Command File Window 253.9 Input Output Window 253.10 Status Window 253.11 Variable Contents Window 263.12 Comment Window 263.13 Text: Find and Replace Window 273.14 Text: Find Marked Text Window 283.15 Properties Window 283.16 The Lower Control Panel 30

3.16.1 Breakpoint Menu 313.16.2 Tag Menu 31

3.16.3 Set Position Menu 323.16.4 Run Menu 323.16.5 Step Button 333.16.6 Stop Button 333.16.7 Reset Button 33

3.17 Accelerators 343.18 Icons 34


4/40


4 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

4 Task Examples 354.1 Creating a New Command File 354.2 Executing an Existing Command File 374.3 Debugging a Faulty Command File 38

4.4 Running All But a Few Lines of a Command File 39

5 Glossary 405.1 Acronyms and Abbreviations 405.2 Definitions 40


5/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 5 (40)

1 Introduction

This document is intended for users of the Telecommunications Managementand Operations Support (TMOS) Command File Developer Application(CFD).

The Command File Developer is an editor and debugger for command filesusing the CHA command file language.

1.1 Prerequisites

The reader of this document should have the following qualifications:

Be familiar with workstations and window-based computer interfaces

Have knowledge of maintenance of network elements, that is, telephoneexchanges

Have knowledge of the CHA command file language in order to handlethe command files for network element maintenance

1.2 Related Documents

The user documentation for the Command File Developer includes thefollowing documents:

Closely Related Documents

[1] Command Handling, System Administrators Guide

[2] Command Handling, User Guide

[3] Command Handling, Programmers Guide, Command FileLanguage

[4] Command Handling, User Guide, Activity Manager

[5] Command Handling, User Guide, Command Log Search

[6] Command Handling, User Guide, Spontaneous Reports Manager

Other Documents

[7] On-line Document Tool, User Guide

[8] Electronic Log Book, User Guide


6/40


6 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

The user documentation is organized in library modules as shown in the figurebelow.

Figure 1 Customer Library Modules

1.3 User Interface Conventions

The user interface described in this document conforms to the Open Lookstandard.

1.4 Typographic Conventions

System element names, such as names of commands, programs, anddirectories are shown in Courier according to the example below.

Example 1

Store the file in the $TMOSADMHOME/common_files/chadirectory.

Text in boldface Courier indicates that the characters are to be typedexactly as shown. The principle is shown in the example below.

Example 2

Enter the following command:

cd /usr/local/tmos/tap

When a command string is so long that it is longer than one line in the opened

window, the string will continue on the following line. To tell the system thatthe command string continues over more than one line, the user must add aback-slash \ at the end of all lines but the last. The principle is shown for afour line command string in the example below.

Example 3

7,22,37,52 * * * * SYBASE=/usr/local/sybase; \export SYBASE; TMOSHOME=/usr/local/tmos; export \TMOSHOME; cd /var/tmos_cold_tnm; tnm_trandbload.sh\> /dev/null

FunctionalSpecifications

TMOS

AIntroduction

Manuals

TMOS

GInstallationManuals

TMOS

HFunction

Verifications

TMOS

OUser Guides,

ProcedureManuals

TMOS

MProgrammers

GuidesSystem

AdministratorsGuides

TMOS

B

TMOS

D


7/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 7 (40)

Text in boldface, italic Courier represents variables that must be supplied bythe user. The principle is shown in the example below, where the hostname isto be supplied by the user.

Example 4

The command rlogin has the following command line syntax:

rlogin hostname

Note: In many TMOS documents variables are enclosed in < and >. Thisdocument does not use the standard notation because it may beconfused with UNIX file direction symbols.

Text specific to theoperations systems (HP-UXandSolaris) is separated fromthe generic text with the paragraph tags described in the example below.

Example 5

HP-UX: Text specific to HP-UX systems is tagged like this paragraph.

Solaris: Text specific to Solaris systems is tagged like this paragraph.

The words enter and type are used in the following ways:

Enter means Type the string shown here and end your input withReturn.

Type means Type exactly what is shown here, and nothing else.

1.5 General Information

1.5.1 Help Texts

Information about all parts of the user interface, like buttons, menu options,and text fields, can be obtained through the on-screen help texts. To access thehelp text for a certain object, place the arrow pointer on the object and pressthe help key. The text is presented in a pop-up window.

HP-UX: If the application is run on an HP-UX system, the help key isfunction key F8.

Solaris: If the application is run on a Solaris system, the help key is the keylabelled Help.


8/40


8 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

1.5.2 Error Messages

Error messages in the Command File Developer are displayed in thefollowing ways:

In the Command File Output Area of the main window

In pop-up notices

In the footer of the main window


9/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 9 (40)

2 Overview

The Command File Developer is an editor and debugger for command filesusing the CHA command file language, see Reference [3] - CommandHandling, Programmers Guide, Command File Language.

The Command File Developer may be used separately or be integrated withthe Command Handling Application (CHA).

The developer displays the contents of a command file in one text pane andoutput from the command file execution in another text pane.

Existing command files can be loaded into the developer through a filebrowser, and new files can be created. More than one command file can bemanaged in one session, although only one can be displayed at a time. Aseparate window for listing all managed command files, and switchingbetween them, is provided.

The main window of the developer has two modes, Run and Edit.In Run mode, a command file can be executed from the beginning or from anarbitrary command line. The file execution can be manually stopped at anytime. A command file can also be executed step by step.

Command lines can be marked as breakpoints, which cause the command fileexecution to stop.

It is also possible to tag command lines that are to be executed as a separateunit, independently of the rest of the file.

In Edit mode, new command files can be created and existing command filescan be edited. A set of functions for editing and searching for text in a file is

provided.


10/40


10 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

2.1 The Window System

The figure below shows an overview of the Command File Developerwindow system.

Figure 2 The Command File Developer Window System


11/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 11 (40)

3 Using the Command File Developer

The Command File Developer may either be used separately or be integratedwith the Command Handling Application (CHA).

If CHA is running, the Command File Developer can be started from thisapplication. The document Reference [2] - Command Handling, User Guideand Reference [6] - Command Handling, User Guide, Spontaneous ReportsManager, describes how the Command File Developer is activated fromCHA.

The appearance and behaviour of the Command File Developer also dependson whether or not the following TMOS applications are installed:

Electronic Log Book If ELB is installed, the task identifiers is visible in theheader of the main window. In addition, the way tostart CFD is affected, see Section 3.1 on page 11.

On-line Document ToolIf OLDT is installed, the Documentation menu isvisible in the upper control panel.

3.1 Starting CFD

If the Command File Developer is to be started independently of CHA, thestarting procedure depends on whether or not the Electronic Log Book isused.

If the Electronic Log Book is used, the Command File Developer is either

started from this application or from CHA. If the Command File Developer isstarted from CHA, CHA has first been started from the Electronic Log Book.See Reference [8] - Electronic Log Book, User Guide for information on howthe developer is started from the Electronic Log Book.

If the Electronic Log Book is not used, the Command File Developer is startedby the Command File Developer option in the workspace menu or by thecha_developer_gui shell command. The cha_developer_guicommand has a number of parameters that control the way in which thedeveloper is started.

For example, a file to be executed may be specified. Enter the mancha_developer_guicommand to receive detailed information about theuse of the cha_developer_gui command. The parameters of thecommand are also described in Reference [1] - Command Handling, SystemAdministrators Guide.

When the developer is started, the Command File Developer window appearson the screen. This window has two modes, Run and Edit, which are furtherdescribed in this chapter.

If a command file is run in CHA, this file can be loaded into the developer,which then automatically opens up. When the developer has been started,command files can be loaded into it through a subwindow. Command filesthat have been loaded into the developer are in this document referred to asmanaged files.


12/40


12 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.2 Run Mode

The following figure shows an example of the appearance of the CommandFile Developer window in Run mode.

Figure 3 The Command File Developer Window in Run Mode

The developer can be started from CHA by the following steps:

1 Select the Send OPS Command File option in the File menu.

Response: The CH: Send OPS Command File window opens.

2 Select a Network Element and a command file.3 Send the command file, and wait until the command file is executed.

Response: The CH: Command File Output window opens.

4 Click on the Debug button in the Command File Output window.

Response: The CH: Command File Output window will close and theCommand File Developer window opens in Run mode.

The file that is being executed is automatically loaded into the upper textpane, the command file area, of the Command File Developer window.

Window Header

Upper ControlPanel

Command File Area

Lower ControlPanel

Window Footer

Command FileOutput Area

Line Status Area


13/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 13 (40)

The file name of the loaded file is shown in the window header, and at theright-hand side of the window footer. The line number of the current positionand the total number of lines in the file are also displayed. This function canbe turned off by using the Update Pos option in the Properties window. SeeSection 3.15 on page 28.

In Run mode, the command file in the command file area can be executed, butnot be edited. Thus, no insertion pointer is available in this mode.

To the left of the command file, there are three columns that indicate linestatus. The symbol indicates that the line has been marked as a breakpoint.The command file execution will stop on the line at the breakpoint.

The symbols are used to tag lines. All lines that are tagged can be executedas a separate unit, independently of the rest of the file.

The symbol, which is always present, indicates the current position in thefile. Only one line can be marked as current position at a time, and only oneof the files currently managed can contain the current position.

Note: If the Update Pos function in the Properties window is turned off, thearrow symbol will not move during the execution of a command fileor system command file. See Section 3.15 on page 28.

Functions for controlling the line status are provided in menus on the controlpanel between the upper and the lower text panes. This control panel, whichis only available in Run mode, also includes functions for executing thecommand file. The functions of this panel are described in Section 3.16 onpage 30.

The upper control panel is described in Section 3.4 on page 15.

The lower text pane, the Command File Output Area, displays output from thefile execution. This is a read-only text pane.

The relative size between the upper and lower panes can be set using the CodeWindow Size option in the Properties window. See Section 3.15 on page 28.


14/40


14 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.3 Edit Mode

The following figure shows an example of the appearance of the CommandFile Developer window in Edit mode.

Figure 4 The Command File Developer Window in Edit Mode

In Edit mode, the command file in the command file area can be edited. Aninsertion cursor is available in this mode.

Functions for editing the file are provided in the menus on the upper controlpanel. This panel is described in Section 3.4 on page 15.

In Edit mode, no line-status area is displayed to the left of the file. The lowercontrol panel is not available.

The relative size between the upper and lower panes can be set using the Code

Window Size option in the Properties window. See Section 3.15 on page 28.If you click on the Run Mode Selector after editing a file, a dialog box willrequest you to save or discard the edits.


15/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 15 (40)

3.4 The Upper Control Panel

The upper control panel is available both in Run mode and in Edit mode, andis shown in the figure below.

Figure 5 The Upper Control Panel

This panel provides the following functions and options:

Functions for connecting and disconnecting network elements

Mode selector

File handling functions

Options for accessing subwindows

Text edit functions

Text search functions

Functions for controlling properties of the application

Options for accessing on-line documentation

This section describes all items found on the upper control panel.

3.4.1 Network Element

The Network Element button on the upper control panel opens a window thatlists all available Network Elements. Through this window a network elementname can be selected and connected.

Figure 6 The Network Element Window

To connect to a network element, select the system in the scroll list. The namewill be inserted on the line to the right of the Network Element button in theCommand File Developer window. If the name is long, one or two scrollingarrows will appear besides the NE name.


16/40


16 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

When a connection is successfully established, the Disconnect buttonbecomes available and the name of the network element is displayed to theright of the Connect icon.

To disconnect, click on the Disconnect button.

To reconnect, click on the Connect button.

If a command file that includes an @CONNECT command is executed, theinitial connection is overridden, and a connection to the network elementspecified by the @CONNECT command is established. Accordingly, you donot have to specify the network element if a file with an @CONNECTcommand is to be executed.

The Network Element window can be configured to show network, networkelement and protocol in a distinguished name format. See Reference [1] -Command Handling, System Administrators Guide.

3.4.2 The Mode Selector

The mode selector in the upper right corner of the Command File Developerwindow is used to switch between Edit mode and Run mode.

Figure 7 Mode Selector

3.4.3 File Menu

The File menu contains basic file handling functions.

Figure 8 The File Menu

Load File

This option is used to load an existing command file into the command filearea of the developer. The option brings up a window with a file browser. SeeSection 3.5 on page 22.


17/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 17 (40)

Create New File

This option creates a new file, which is named Untitled, followed by a serialnumber.

Save Current File

This option is used to save the file displayed in the command file area.

Store as New File

This option is used to save the file displayed in the command file area undera new name. The option brings up a window with a file browser. SeeSection 3.6 on page 23.

Save All Files

This option is used to save all files that are currently managed in thedeveloper.

Close Current File

This option is used to close the file displayed in the command file area. Theoption is disabled if a file is currently being executed.

Close All Files

This option is used to close all files that are currently managed in thedeveloper. The option is disabled if a file is currently being executed.

Print

This option opens a window for printing a command file, or a part of it. See.See Section 3.7 on page 24.


18/40


18 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.4.4 View Menu

The View menu provides access to five subwindows.

Figure 9 The View Menu

File

This option brings up a window with a list of the files that are currentlymanaged in the Command File Developer. See Section 3.8 on page 25.Through this window, you can switch between the managed files.

Input Output

This option opens the Input Output window. See Section 3.9 on page 25. TheInput Output window is used to manage those command file commands thatrequire user interaction.

Status Info

This optionopens theStatuswindow. SeeSection 3.10 on page 25.TheStatuswindow is used to view run-time information.

Variables

This option opens the Variable Contents window. See Section 3.11 onpage 26. The Variable Contents window is used to view the contents ofcommand file variables.

Comment Window

This option opens the Comment window. See Section 3.12 on page 26. TheComment window displays output generated by the @COMMENT command.

Current Position

This option updates the current position of the arrow symbol ( ) in theCommand File Area when the Run mode has been selected in the CH:Command File Developer main window and the Stepping Only option hasbeen selected in the Properties window, see Section 3.15 on page 28.


19/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 19 (40)

3.4.5 Edit Menu

The Edit menu includes commands that are used to edit the command file inthe command file area.

Figure 10 The Edit Menu

Again

Repeats the last editing action.

Undo>Undo Last Edit

Undoes the last editing action.

Undo>Undo All Edits

Undoes all editing actions performed since the file was saved.

Copy

Copies selected text to the clipboard.

Paste

Inserts the contents of the clipboard at the insertion pointer.

Cut

Removes selected text and stores it on the clipboard.


20/40


20 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.4.6 Find Menu

The Find menu includes commands that are used to search for text and replacetext in the command file.

Figure 11 The Find Menu

All functions in this menu are case sensitive. The menu includes the followingoptions:

Find and Replace

Opens a pop-up window with functions for searching and replacing text. SeeSection 3.13 on page 27.

Find Selection

The Forward option finds the next occurrence of a selected text item in thefile. The Backward option finds the previous occurrence of a selected textitem in the file.

Find Marked Text

Opens a pop-up window with functions for searching for delimiters, likeparentheses and quotation marks. See Section 3.14 on page 28.

Replace |>field and the rightdelimiter and the right delimiter and the right delimiter


21/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 21 (40)

3.4.7 The Documentation Menu

Note: This menu is only available if the On-line Document Tool applicationis installed.

The Doc menu includes options for accessing on-line documentation.

Figure 12 The Documentation Menu

When an option in the Documentation menu is selected, the DynaText filebrowser is brought up on the screen, if it is not already running. DynaText,(the file browser of the On-line Document Tool) is used to view electronic

books. There is one book for each NE-AS, that is, a certain combination ofnetwork element type and application system version. A more detaileddescription of the On-line Document Tool is provided in Reference [7] -On-line Document Tool, User Guide.

The Select Book option, which displays a list of all available books, is alwaysavailable. The other options correspond to the document categories in anNE-AS book. These options are only available when a connection to anetwork element exists. Each option starts a search for documentation of atext item that is highlighted in the Command File Developer window. If anoption is selected without any relevant text being highlighted, an errormessage is displayed and the table of contents of the book is opened.

The menu includes the following options:

Command Descriptions

If a highlighted text item in the window contains a command, this optiondisplays the Command Description (COD) of the command.

Printout Descriptions

If a highlighted text item in the window contains the title of a response orspontaneous report, this option displays the Printout Description (POD) of the

response or spontaneous report.

Application Information

If a highlighted text item in the window contains the name of a function block,this option displays the Application Information (AI) relevant to the block.

Select Book

This option displays a list of all available books.


22/40


22 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.5 Load File Window

The Load File window is used to load an existing command file into thecommand file area of the Command File Developer window.

Figure 13 The Load File Window

The window is opened by the Load File option in the File menu.

The window contains a file browser, through which files in the file system canbe located.

The name of a file that is selected in the scroll list is shown in the File textfield in the upper part of the window.

The path of the directory that is displayed in the scroll list is shown in theDirectory text field.

The Go To menu includes the following options:

Central Directory Displays the directory where central command filesare stored (default)

Private Directory Displays the directory where private command filesof the current user should be stored

To load a command file into the Command File Developer window, select thefile in the file browser and click on the Load button.


23/40


24/40


24 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.7 Print File Window

The Print File window is used to print a command file, or a part of it.

Figure 15 The Print File Window

The window is opened by the Print option in the File menu.

The window contains a file browser. When the window is opened, the nameof the file that is currently displayed in the command file area of theCommand File Developer window is displayed in the File text field, and thepath of this file in the Directory text field. However, any command file can beselected for printing.

Select one of the Printer Name boxes to specify on which printer the

command file is to be printed. Which printers are available depends on thecurrent system environment.

The Print File menu contains the two following options:

File Orders printing of the complete command file that isspecified in the File text field

Selected Text Orders printingof text that isselected in the commandfile area of the Command File Developer window


25/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 25 (40)

3.8 View Command File Window

The View Command File window lists all files that are currently managed inthe Command File Developer. These files are files that are currently loadedinto the developer.

Figure 16 The View Command File Window

The window is opened by the File option in the View menu.

The path of the file that is selected in the scroll list is shown in the File textfield.

Select the file that you want to display in the Command File Developerwindow, and click on the View button.

3.9 Input Output Window

The Input Output window is used to interact with the following command file

commands:@DRAW

,@MENU

, and@FORM

. When one of these commands isencountered in a command file, the Input Outputwindowautomatically opensup.

The contents of the window when it is opened depend on the command thathas been executed. For information about the commands that make use of theInput Output window, see Reference [3] - Command Handling,Programmers Guide, Command File Language.

The Input Output window can also be manually opened by the Input Outputoption in the View menu.

3.10 Status WindowThe status window is opened by the Status Info option in the View menu. Thewindow displays the current directory.

Figure 17 The Status Window

Click on the Update button to retrieve the current run-time data values.


26/40


26 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.11 Variable Contents Window

The Variable Contents window is used to view the current contents ofvariables in command files.

Figure 18 The Variable Contents Window

Any variable in any of the currently managed command files can be viewed.

The window contains a scroll list with the variables to the left and the contentsof the variables to the right.

If the variable is undefined, the right column will be empty. If the variable isdefined, but contains an empty string, a pair of quotes is shown.

To add a variable to the list, type the variable name in the Variable name textfield in the upper part of the window and click on the Add button. To removea variable from the list, select the variable in the list and click on the Removebutton.

3.12 Comment Window

The Comment window automatically opens up when a @WINDOW commandis encountered in the command file. The window can also be opened by theComment option in the View menu.

The window consists of a scrollable text pane, as shown in the figure below.

Figure 19 The Comment Window

When @WINDOW is in effect, output created by the@COMMENT command willbe directed to the Comment window. Otherwise, output created by the@COMMENT command is displayed in the Command File Output Area.

The Comment window is automatically closed when an @WINDENDcommand is encountered in the command file.


27/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 27 (40)

3.13 Text: Find and Replace Window

This window is used to find and replace text.

Note: To replace text, the Edit Mode in the CFD main window must be

selected.

Figure 20 The Text:Find and Replace Window

The window is opened by the Find and Replace option in the Find menu.

In the upper text field, type the text you want to search for. Start the search byselecting one of the options in the Find menu, Forward or Backward. Whenan occurrence of the specified text is found, this text is highlighted.

In the lower text field, type the text that you want to replace the old text with.Click on the Replace button to replace a highlighted text item.

Click on the Find then Replace button to include the search and thereplacement into one action.

Click on the Replace then Find button to replace a highlighted text and searchfor the next occurrence of the same text.

Click on the Replace All button to replace all occurrences of the specified textin the file.

The search function is set in either of two modes in the pop-up menu:

To End Searches the file from the insertion pointer to the endof the file

All Text Searches the whole file


28/40


28 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.14 Text: Find Marked Text Window

This window is used to search for text surrounded by delimiters.

Figure 21 The Text:Find Marked Text Window

In the upper part of the window, select the type of delimiter pair you want tosearch for, insert, or remove.

Click on the Find Pair button to start a search for text written between thespecified delimiter pair. When an occurrence is found, the text between the

delimiters is highlighted. This search function is set to one of three modes:

Forward Searches the file from the insertion pointer and forward

Backward Searches the file from the insertion pointer and backwards

Expand Used when the insertion pointer is located between thedelimiters

Click on the Insert Pair button to insert the specified delimiter pair at theinsertion pointer.

Click on the Remove Pair button to remove a highlighted pair of delimiters.The text between the delimiters will not be removed.

3.15 Properties Window

This window is used to control properties of the Command File Developer.

Figure 22 The Properties Window

The window is opened by the Props button, and contains four differentproperty settings.

If you change the settings and click on the Apply button, the selectedproperties will remain in effect only during the current session.

If you click the Set Default button, the selected properties take effect in thecurrent session and remain in effect the next time the Command FileDeveloper is started.


29/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 29 (40)

If you click on the Reset button, the properties that were activated the last time(either the Apply button or the Set Default button was clicked) are retrieved.

Code Window Size

This setting allows you to control the size of the code window, that is, therelative size between the upper and lower panes of the Run/Edit window. Fora comparison of the different size options, see Figure 23 on page 29.

Small Choose this option to make the size of the upper paneone third of the lower pane

Medium Choose this option to make the pane sizes equal

Large Choose this option to make the upper pane three timesbigger than the lower pane

Figure 23 Code Window Size Comparison

Update Pos

This setting allows you to change the behaviour of the automatic updating ofthe current position indicator in the Run window.

Always Choose this option to turn the updating of the Runwindow on. The arrow symbol ( ) will always pointat the line that is executing, and the line indicator in

the right hand side of the footer will indicate the linenumber of the executing line.

Stepping Only Choose this option to turn off the updating of the Runwindow. The arrow symbol ( ) will not move andthe indicator in the footer will not change duringexecution. However, by using the Current Positionoption from the View menu, the arrow and lineindicator will be updated anyway.

Small Large


30/40


30 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

Warnings

Always If this option is selected, all pop-up warnings will bedisplayed.

Never If this option is selected, no pop-up warnings will bedisplayed.

Accelerators

By activating the Accelerator check boxes, you turn on the acceleratorfunctions that make it possible to control break points, tags, and currentposition with themouse.These functionsare furtherdescribed in Section 3.17on page 34.

3.16 The Lower Control Panel

The control panel between the two text panes in the Command File Developerwindow is only available in Run mode. The Lower Control Panel is shown inthe figure below.

Figure 24 The Lower Control Panel

The functions of this panel enable the following operations:

Controlling break points

Controlling tags

Controlling current position

Start and stop the execution of a command file

Resetting run-time information

This section describes all items found on the lower control panel.

Some of the options require that you have highlighted a command line. A lineis selected when a part of the line is highlighted. To select a line, double-clicksomewhere on the line. A single click also selects the command line, but itdoes not show since the command file area is not editable in the Run mode.

The fastest way of using the debugger is to use the accelerators, described inSection 3.17 on page 34.


31/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 31 (40)

3.16.1 Breakpoint Menu

By using the options in the Breakpoint menu, you can add breakpoints to a fileand remove breakpoints from the file.

Figure 25 The Breakpoint Menu

The file execution will stop when a breakpoint is encountered, that is, the linemarked as a breakpoint will not be executed. A breakpoint is indicated by the

symbol to the left of the file. See Figure 29 on page 34.


Add Marks one or more selected command lines as breakpoints

Clear Removes the breakpoint symbols from all selected commandlines

Clear All Removes the breakpoints from all managed files

If the Breakpoint accelerator function has been activated in the Propertieswindow, it is also possible to add or remove a breakpoint by clicking in theline-status area to the left of the command line. See Section 3.17 on page 34.

3.16.2 Tag Menu

By using the options in the Tag menu, you can tag command lines and removetags from command lines.

Figure 26 The Tag Menu

When a command line is tagged, a symbol is displayed to the left of thecommand line. See Figure 29 on page 34.

All lines that are tagged are considered as a unit that can be executedindependently of the rest of the file by the Tagged lines only option in the Runmenu.


Add Tags one or more selected command lines

Clear Removes the tags from one or more selected command lines

Clear All Removes the tags from all managed files


32/40


32 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

If the Tag accelerator function has been activated in the Properties window, itis also possible to add or remove a tag by clicking in the line-status area to theleft of the command line. See Section 3.17 on page 34.

3.16.3 Set Position Menu

By using the options in the Set Position menu, you can change the currentposition in the file.

Figure 27 The Set Position Menu

The current position is indicated by the symbol to the left of the command

line. See Figure 29 on page 34.The execution starts from the current position if the From Current Positionoption in the Run menu is selected. If the Step button is clicked, only thecommand line marked as current position is executed.


Set Only Marks a selected command line as current position

Set and Run Starts the execution from the selected command line

If the Set Position accelerator function has been activated in the Propertieswindow, it is also possible to set the current position by clicking in the

line-status area to the left of the command line. See Section 3.17 on page 34.

3.16.4 Run Menu

The Run menu includes start commands for the file execution.

Figure 28 The Run Menu

From Current Position Starts the file execution from the line that is markedas current position (indicated by the symbol).

From Top Resets all run-time information and starts the fileexecution from the beginning of the file displayed inthe command file area of the developer.

Tagged lines only Executes all tagged command lines from the currentposition.


33/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 33 (40)

3.16.5 Step Button

Use the Step button to execute only the command line that is marked ascurrent position. When the command line is executed, the current positionmoves.

3.16.6 Stop Button

Use the Stop button to stop the file execution. When the execution has beenstopped, the symbol (current position) is displayed to the left of thecommand line after the last executed line.

If the NE supports it, this command also cancels all delayed responses thatwould be the results of the stopped file execution. (AXE only)

The execution can be restarted by the From Current Position option in the Runmenu.

3.16.7 Reset Button

Use this button to reset the run-time data to default values. The following datais reset:

Variable contents The contents of each defined variable is cleared.

Call stack The return positions, at which the execution resumeswhen a subroutine (initiated by @GOSUB) has beenexecuted, are cleared.

File stack The return positions in the main file, at which the

execution resumes when an included file (includedby@INCLUDE or @I) has been executed, are cleared.

Function busy retry The function busy retry interval is reset to the defaultvalue (which is configurable).

Input Output window The position in the Input Output window where thenext output will be drawn is reset to (1, 1), and thewindow is closed.

Comment window The Comment window is closed.

@CHECK status The status of the @CHECK command is set to ON.

@ORDERED status The status of the @ORDERED command is set to ON.

Printer The printer log is printed. (This is equivalent toexecuting the @PRINTER(OFF) command.)

Log file Any specified log file is closed.

Error flag The error flag, which indicates if an error hasoccurred since the beginning of execution or since thelast @IFERROR command was executed, is reset.


34/40


34 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

3.17 Accelerators

These features require that the accelerators have been activated in theProperties window, see Section 3.15 on page 28. You can mark a commandline as the current position, as a tag, or as a breakpoint, by clicking with the

mouse in the line-status area to the left of the command line.

To add or remove a breakpoint, click furthest to the left. To add or remove atag, click in the middle. To set current position, click furthest to the right. Thefollowing figure shows the three columns.

Figure 29 Line-status Accelerators

3.18 Icons

When the developer window is iconised, that is, reduced to an icon on thescreen, it is indicating whether or not the command file is executing or not. Inthis way it is possible to start an execution of a command file, iconise thewindow, and work with something else until the icon changes. The twopossible icons are described below.

Figure 30 The Command File Developer Window Icons

Left column -Breakpoint

Middle column -Tag

Right column -Current Position

This icon represents a Command Developer Window withan executing command file.

When the execution of the command file is finished, theicon looks like this.


35/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 35 (40)

4 Task Examples

The aim of this chapter is to describe how the Command File Developer canbe used to perform certain tasks that occur frequently or that are complicatedto perform.

Each example suggests one advisable way to perform a certain task. Note thatalternative ways to perform the same task may exist.

4.1 Creating a New Command File

In this example, a new command file is created and stored in the privatecommand file directory of the current user. The file is also tested. Theexample assumes that the Command Handling Application is used and that anetwork element is available.

1 Start the Command File Developer. See Reference [2] - Command Handling,

User Guide.

Response: The Command File Developer window, the base window of theapplication, appears in Edit mode. See Figure 4 on page 14. A filenamed Untitled is automatically created in the current workingdirectory.

2 Select the Store as New File option in the File menu.

Response: A file browser window appears. See Figure 14 on page 23.

3 Select the Private Directory option in the Go To menu.

Response: The file browser now displays your private command filedirectory.

4 Type the name of the new command file in the File text field in the filebrowser window, and click on the Save button.

Response: The path of the new file appears in the window header of theCommand File Developer window.

5 Write the following command sequence in the command file area of theCommand File Developer window:

@COMMENT("Command File clock check.")

@CONNECT("es_name")

CACLP;

@DISCONNECT

6 As soon as you want to save your work, select the Save Current File option inthe File menu.

7 Set the mode selector in the upper right corner of the Command FileDeveloper window in Run mode.

Response: The Command File Developer window turns into Run mode.


36/40


36 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

8 To test the command file, select the From Top option in the Run menu.

Response: The file is executed from the beginning and output from theexecution is displayed in the Command File Output Area of thewindow.

9 If the file does not work as you intended, debug the file. See Section 4.3 onpage 38.


37/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 37 (40)

4.2 Executing an Existing Command File

In this example, an existing command file, stored in the private command filedirectory of the current user, is loaded into the Command File Developer andexecuted. The example assumes that the Command Handling Application is

used.

1 Start the Command File Developer. See Reference [2] - Command Handling,User Guide.

Response: The Command File Developer window, the base window of theapplication, appears in Edit mode. See Figure 4 on page 14.

2 Select the Load File option in the File menu.

Response: A file browser window appears. See Figure 13 on page 22.

3 Select the Private Directory option in the Go To menu.

Response: The file browser now displays your private command file

directory.4 Select the file that is to be executed, and click on the Load button.

Response: The file is displayed in the command file area of the CommandFile Developer window.

5 Set the mode selector in the upper right corner of the window in Run mode.

Response: The Command File Developer window turns into Run mode.

6 Select the From Top option in the Run menu.

Response: The file is executed. If the command file generates any output, theoutput is displayed in the Command File Output Area of thewindow.


38/40


38 (40) 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

4.3 Debugging a Faulty Command File

In this example, execution of a faulty command file is started from theCommand Handling Application. The Command File Developer is used tocorrect the file and complete the execution. The example assumes that the

Command Handling Application has been started.

1 Send the command file from the Command Handling Application. SeeReference [2] - Command Handling, User Guide.

Response: The Command File Output window appears, see Reference [2] -Command Handling, User Guide, and the commands in thecommand file are executed until the faulty command isencountered.

2 Start the Command File Developer by clicking on the Debug button in theCommand File Output window.

Response: The Command File Output window turns into a Command File

Developer window. The Command File Developer windowappears in Run mode, displaying the command file. Thesymbol that indicates current position points at the command

line that could not be executed.

3 Set the mode selector in the upper right corner of the window in Edit mode.

Response: The Command File Developer window turns into Edit mode.

4 Correct the faulty command line.

5 Select the Save Current File option in the File menu.

6 Set the mode selector in the upper right corner of the window in Run mode.

Response: The Command File Developer window turns into Run mode.Comment: The symbol points at the corrected command line.

7 Click on the Step button to execute only the corrected command line.

Response: If the command line is now correct, it is executed and the messageStep: Successful is displayed in the window footer. The

symbol moves to the next command line.

8 Select the From Current Position option in the Run menu.

Response: The rest of the file is executed. When the execution is completed,the message Run stopped: Normal Program Termination isdisplayed in the Command File Output Area.


39/40


3/1553-CRA 114 313 Uen Rev C2 1998-12-14 39 (40)

4.4 Running All But a Few Lines of a Command File

To tag all but a few command lines, perform the following procedure:

1 Click four times somewhere in the command file area to select the whole file.

2 Select the Add option in the Tag menu to tag all command lines.

3 Select the lines that you want to exclude.

4 Select the Clear option in the Tag menu to remove the tags from the selectedlines.

Comment: If the Tagaccelerator function hasbeen activated in thePropertieswindow, it is also possible to add or remove a tag by clicking inthe line-status area to the left of the command line. SeeSection 3.17 on page 34.

5 To run all tagged lines, select the Tagged Lines Only item in the Run menu.

Response: The tagged lines are executed. If the command lines generateoutput, it is displayed in the Command File Output area of thewindow.


40/40


5 Glossary

5.1 Acronyms and Abbreviations

CHA Command Handling Application

TMOS Telecommunications Management and Operations Support

5.2 Definitions

Breakpoint When a command line is marked as a breakpoint, the file executionwill stop at this line.

Tag Tagged command lines can be executed as a separate unitindependently of the rest of the command file.

Current Position The current position is the command line in a command file that isthe next line to be executed.