Command File Developer OPS

TMOS User Guide

Command Handling Command Command File Dev Develop eloper er (OPS) (OPS)

Chapters: 1

Introduction

5

2

Overview

9

3

Using the Command File Developer

11

4

Task Examples

35

5

Glossary

40

M V / S H E

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

© Ericsson Hewlett-Packard Telecommunications AB 1997 All Rights Reserved

Command Handling Command File Developer (OPS)

The contents of this document are subject to revision without notice due to continued progress in methodology, design, and manufacturing. Ericsson shall have no liability for any errors or damages of any kind resulting from the use of this document.

2 (40)

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

Command Handling Command File Developer (OPS)

1 1.1 1.2 1.3 1.4 1.5 1.5.1 1.5.2

Introduction Prerequisites Related Documents User Interface Conventions Typographic Conventions General Information Help Texts Error Messages

5 5 5 6 6 7 7 8

2 2.1

Overview The Window System

9 10

3 3.1 3.2 3.3 3.4

Using the Command File Developer Starting CFD Run Mode Edit Mode The Upper Control Panel

11 11 12 14 15

3.4.1 3.4.2 3.4.3 3.4.4 3.4.5 3.4.6 3.4.7

3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.16.1 3.16.2 3.16.3 3.16.4 3.16.5 3.16.6 3.16.7

3.17 3.18

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

Network Element The Mode Selector File Menu Vi e w Men u Edit Menu Find Menu The Documentation Menu

Load File Window Save File Window Print File Window View Command File Window Input Output Window Status Window Variable Contents Window Comment Window Text: Find and Replace Window Text: Find Marked Text Window Properties Window The Lower Control Panel Breakpoint Menu T a g M en u Set Position Menu Run Menu Step Button Stop Button Reset Button

Accelerators Icons

15 16 16 18 19 20 21

22 23 24 25 25 25 26 26 27 28 28 30 31 31 32 32 33 33 33

34 34

3 (40)

Command Handling Command File Developer (OPS)

4 (40)

4 4.1 4.2 4.3 4.4 4.4

Task Examples Creating a New Command File Executing an Existing Command File Debugging a Faulty Command File Runn Ru nnin ing g All All But But a Few Few Line Lines s of a Co Comm mman and d File File

35 35 37 38 39

5 5.1 5 .2

Glossary Acronyms and Abbreviations Definitions

40 40 40

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

Command Handling Command File Developer (OPS)

1

Introduction This This docume document nt is inte intende nded d for users users of the Teleco Telecommu mmunic nicati ations ons Manage Managemen mentt and Operations Support (TMOS) Command File Developer Application (CFD). The Command File Developer is an editor and debugger for command files using the CHA command file language.

1.1 1.1

Prer Prereq equ uisit isites es The reader of this document should have the following qualifications:

1.2 1.2

•

Be familiar with workstations and window-based computer interfaces

•

Have knowledge of maintenance of network elements, that is, telephone exchanges

•

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

Rela Re late ted d Docu Docume ment nts s The user documentation for the Command File Developer includes the following documents: Closely Related Documents

[1]

Comman Command d Handl Handling ing,, System System Admini Administr strato ator’ r’ss Guide Guide

[2] [2]

Comm Comman and d Hand Handli ling ng,, User User Guid Guidee

[3]

Command Command Handling Handling,, Programm Programmer’s er’s Guide, Guide, Command Command File Language

[4]

Comman Command d Handl Handling ing,, User User Guide, Guide, Activ Activity ity Manage Manager  r 

[5]

Comman Command d Handl Handling ing,, User User Guide, Guide, Comman Command d Log Search Search

[6]

Command Command Handling Handling,, User Guide, Guide, Spontane Spontaneous ous Reports Reports Manager  Manager 

Other Documents

[7]

On-li On-line ne Docume Document nt Tool, Tool, User User Guide Guide

[8] [8]

Elec Electr tron onic ic Log Log Book Book,, User User Guid Guidee

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

5 (40)

Command Handling Command File Developer (OPS)

The The user user docu docume ment ntat atio ion n is orga organi nize zed d in libr librar ary y modu module less as show shown n in the the figu figure re below. TM O S

TM O S

TM O S

TM O S

TM O S

TM O S

TM O S

A

B

D

G

H

M

O

Installation Manuals

Function Verifications

Programmer’s Guides

User Guides, Procedure Manuals

Introduction Manuals

Figure Figure 1

1.3

System Functional Administrator’s Specifications Guides

Custom Customer er Librar Libraryy Module Moduless

Userr Interf Use Interface ace Conven Conventio tions ns The user interface described in this document conforms to the Open Look  standard.

1.4

Typogra ypographi phic c Conven Conventio tions ns System element names, such as names of commands, programs, and directories are shown in Courier according to the example below. Example 1

Store the file in the $TMOSADMHOME/common_files/cha directory. Text in boldface Courier indicates that the characters are to be typed exactly 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 i s longer than one line in the opened window, the string will continue on the following line. To tell the system that the command string continues over more than one line, the user must add a back-slash “\” at the end of all lines but the last. The principle is shown for a four line command string in the example below. Example 3

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

6 (40)

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

Command Handling Command File Developer (OPS)

Text in boldface, italic Courier represents variables that must be supplied by the user. The principle is shown in the example below, where the hostname is to 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 >. This document does not use the standard notation because it may be confused with UNIX file direction symbols.

Text Text specif specific ic to the operat operation ionss system systemss (HP-UX (HP-UX and Solari Solaris) s) is separa separated ted from from the 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 with Return.”

•

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

1.5 1.5

Gene Genera rall Inf Informa ormati tion on

1.5. 1.5.1 1

Help He lp Tex exts ts Information about all parts of the user interface, like buttons, menu options, and and text text field fields, s, can can be obta obtain ined ed thro throug ugh h the the on-s on-scr cree een n help help text texts. s. To acce access ss the the help text for a certain object, place the arrow pointer on the object and press the 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 is function key F8. Solaris:

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

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

7 (40)

Command Handling Command File Developer (OPS)

1.5.2 1.5 .2

Error Error Messa Messages ges Error messages in the Command File Developer are displayed in the following ways:

8 (40)

•

In the Command File Output Area of the main window

•

In pop-up notices

•

In the footer of the main window

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

Command Handling Command File Developer (OPS)

2

Overview The Command File Developer is an editor and debugger for command files using the CHA command file language, see Reference [3] - Command  Handling, Programmer’s Guide, Command File Language . The Command File Developer may be used separately or be integrated with the Command Handling Application (CHA). The developer displays the contents of a command file in one text pane and output from the command file execution in another text pane. Existing command files can be loaded into the developer through a file browser, and new files can be created. More than one command file can be managed in one session, although only one can be displayed at a time. A separate window for listing all managed command files, and switching between 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 an arbitrary command line. The file execution can be manually stopped at any time. A command file can also be executed step by step. Command lines can be marked as breakpoints, breakpoints, which cause the command file execution to stop. It is also possible to tag command lines that are to be executed as a separate unit, independently of the rest of the file. In Edit mode, new command files can be created and existing command files can be edited. A set of functions for editing and searching for text in a file is provided.

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

9 (40)

Command Handling Command File Developer (OPS)

2.1 2.1

The The Wind Windo ow Syst System em The figure below shows an overview of the Command File Developer window system.

Figure Figure 2

10 (40)

The Command Command File Developer Developer Window System System 3/1553-CRA 114 313 Uen Rev C2 1998-12-14

Command Handling Command File Developer (OPS)

3

Usin Us ing g the the Comm Comman and d File File De Deve velo lope perr The Command File Developer may either be used separately or be i ntegrated with the Command Handling Application (CHA). If CHA is running, the Command File Developer can be started from this application. The document Reference [2] - Command Handling, User Guide and Reference [6] - Command Handling, User Guide, Spontaneous Reports Manager , describes how the Command File Developer is activated from CHA. The appearance and behaviour of the Command File Developer also depends on whether or not the following TMOS applications are installed: Elec Electr tron onic ic Log Log Book Book

If ELB ELB is inst instal alle led, d, the the task task iden identi tifie fiers rs is visi visibl blee in the the header of the main window. In addition, the way to start CFD is affected, see Section 3.1 on page 11.

On-line Document Tool If OLDT is installed, the Documentation menu is visible in the upper control panel.

3.1 3.1

Star Startting ing CFD CFD If the Command File Developer is to be started independently of CHA, the starting procedure depends on whether or not the Electronic Log Book is used. 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 is started from CHA, CHA has first been started from fr om the Electronic Log Book. Guid e for information on how See Reference [8] - Electronic Log Book, User Guide the developer is started from the Electronic Log Book. If the the Elec Electro troni nicc Log Log Book Book is not not used used,, the the Comm Comman and d File File Deve Develo lope perr is star starte ted d by the Command File Developer option in the workspace menu or by the cha_developer_gui shell command. The cha_developer_gui command has a number of parameters that control the way in which the developer is started. For example, a file to be executed may be specified. Enter the man cha_developer_gui comman command d to receiv receivee detail detailed ed inform informati ation on about about the use of the cha_developer_gui command. The parameters of the command are also described in Reference [1] - Command Handling, System Administrator’s Guide . When When the the deve develo lope perr is star starte ted, d, the the Comm Comman and d File File Deve Develo lope perr wind window ow appe appear arss on the screen. This window has two modes, Run and Edit, which are further described in this chapter. If a command file is run r un 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 files that have been loaded into the developer are in this document referred to as managed files.

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

11 (40)

Command Handling Command File Developer (OPS)

3.2

Run Mode The following figure shows an example of the appearance of the Command File Developer window in Run mode. Window Header Upper Control Panel

Command File Area

Line Status Area 

Lower Control Panel

Command File Output Area

Window Footer

Figure Figure 3

The Command Command File Developer Developer Window in Run Mode

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

Select Select the the Send Send OPS Command Command File File option option in the the File File menu. menu. Response: The CH: Send Send OPS Command Command File window opens.

2

Select Select a Network Network Element Element and a command command file.

3

Send the comma command nd file, file, and and wait wait until until the the command command file is is execute executed. d. Response: The CH: Command File File Output window opens. opens.

4

Click on the Debug Debug button button in the the Comma Command nd File File Outpu Outputt window. window. Response: The CH: Command Command File Output Output window will close close and the Command File Developer window opens in Run mode. The file that is being executed is automatically loaded into the upper text pane, the command file area, of the Command File Developer window.

12 (40)

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

Command Handling Command File Developer (OPS)

The file name of the loaded file is shown in the window header, and at the right-hand side of the window footer. The line number of the current position and the total number of lines in the file are also displayed. This function can be turned off by using the Update Pos option in the t he Properties window. See Section 3.15 on page 28. In Run Run mode mode,, the the comm comman and d file file in the the comm comman and d file file area area can can be exec execut uted ed,, but but not be edited. Thus, no insertion pointer is available in this mode. To the left of the t he command file, there are three columns that indicate line status. status. The The symbol symbol indicat indicates es that that the the line has been marked marked as a breakp breakpoint. oint. The command file execution will stop on the line at the breakpoint. The symbols are used used to tag lines. All lines that are tagged can be executed as a separate unit, independently of the rest of the file. The symbol, symbol, which which is always always present, present, indica indicates tes the the curren currentt position position in the the file. Only one line can be marked as current position at a time, and only one of the files currently managed can contain the current position. Note: If the Update Pos function in the Properties window is turned off, the arrow symbol will not move during the execution of a command file or system command file. See Section 3.15 on page 28.

Functions for controlling the line status are provided in menus on the control panel between the upper and the lower text panes. This control panel, which is only available in Run mode, also includes functions for executing the command file. The functions of this panel are described in Section 3.16 on page 30. The upper control panel is described in Section 3.4 on page 15. The The lowe lowerr text text pane pane,, the the Comm Comman and d File File Outp Output ut Area Area,, disp displa lays ys outp output ut from from the the file execution. This is a read-only text pane. The The rela relati tive ve size size betw betwee een n the the uppe upperr and and lowe lowerr pane paness can can be set set usin using g the the Code Code Window Size option in the Properties window. See Section 3.15 on page 28.

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

13 (40)

Command Handling Command File Developer (OPS)

3.3

Edit Mode The following figure shows an example of the appearance of the Command File Developer window in Edit mode.

Figure Figure 4

The Command Command File Developer Developer Window in Edit Mode

In Edit mode, the command file in the command file area can be edited. An insertion cursor is available in this mode. Functions for editing the file are provided in the menus on the upper control panel. This panel is described in Section 3.4 on page 15. In Edit mode, no line-status area is displayed to the l eft of the file. The lower control panel is not available. The The rela relati tive ve size size betw betwee een n the the uppe upperr and and lowe lowerr pane paness can can be set set usin using g the the Code 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 will request you to save or discard the edits.

14 (40)

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

Command Handling Command File Developer (OPS)

3.4 3.4

The The Uppe Upperr Cont Contro roll Panel anel The upper control panel is available both in i n Run mode and in Edit mode, and is shown in the figure below.

Figure Figure 5

The Upper Upper Contro Controll Panel 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 3.4 .1

Netwo Network rk Elemen Elementt The Network Element button on the upper control panel opens a window that lists lists all availa available ble Networ Network k Elemen Elements. ts. Throug Through h this this window window a networ network k elemen elementt name can be selected and connected.

Figure Figure 6

The Networ Networkk Elemen Elementt Window Window

To conn connec ectt to a netw networ ork k elem elemen ent, t, sele select ct the the syst system em in the the scro scroll ll list list.. The The name name will be inserted on the line to the right of the Network Element button in the Command File Developer window. If the name is long, one or two scrolling arrows will appear besides the NE name.

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

15 (40)

Command Handling Command File Developer (OPS)

When a connection is successfully established, the Disconnect button becomes available and the name of the network element is displayed to the right 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, the initial connection is overridden, and a connection to the network element specified by the @CONNECT command is established. Accordingly, you do not have to specify the network element if a file fil e with an @CONNECT command is to be executed. The Network Element window can be configured to show network, network  element and protocol in a distinguished name format. See Reference [1] Command Handling, System Administrator’s Guide .

3.4.2 3.4 .2

The Mode Mode Select Selector or The mode selector in the upper right corner of the Command File Developer window is used to switch between Edit mode and Run mode.

Figu Figure re 7

3.4. 3.4.3 3

Mode Mode Sele Select ctor  or 

File File Me Menu nu The File menu contains basic file handling functions.

Figu Figure re 8

The The File File Menu Menu

Load File

This option is used to load an existing command file into t he command file area of the developer. The option brings up a window with a file browser. See Section 3.5 on page 22.

16 (40)

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

Command Handling Command File Developer (OPS)

Create New File

This option creates a new file, which is named Untitled, followed by a serial number. Save Current File

This option is used to save the file displayed in the t he command file area. Store as New File

This option is used to save the file displayed in the command file area under a new name. The option brings up a window with a file browser. See Section 3.6 on page 23. Save All Files

This option is used to save all files that are currently managed in the developer. Close Current File

This option is used to close the file displayed in the command file area. The option 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 the developer. 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.

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

17 (40)

Command Handling Command File Developer (OPS)

3.4. 3.4.4 4

Vie View Me Men nu The View menu provides access to five fi ve subwindows.

Figu Figure re 9

The The View View Menu Menu

File

This option brings up a window with a list of the files that are currently managed 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. The Input Output window is used to manage those command file commands that require user interaction. Status Info

This This option option opens opens the Status Status window window.. See Sectio Section n 3.10 3.10 on page page 25. The Status Status window is used to view run-time information. Variables

This option opens the Variable Contents window. See Section 3.11 on page 26. The Variable Contents window is used to view the contents of  command file variables. Comment Window

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

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

18 (40)

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

Command Handling Command File Developer (OPS)

3.4. 3.4.5 5

Edit Edit Me Menu nu The Edit menu includes commands that are used to edit the command file in the command file area.

Figure Figure 10

The Edit Edit Menu 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.

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

19 (40)

Command Handling Command File Developer (OPS)

3.4. 3.4.6 6

Find Find Me Men nu The The Find Find menu menu incl includ udes es comm comman ands ds that that are are used used to sear search ch for for text text and and repl replac acee text in the command file.

Expand Next Previous Figure Figure 11

The Find Find Menu Menu

All All func functio tions ns in this this menu menu are are case case sens sensiti itive ve.. The The menu menu incl includ udes es the the follo followi wing ng options: Find and Replace

Opens a pop-up window with functions for searching and replacing text. See Section 3.13 on page 27. Find Selection

The Forward option finds the next occurrence of a selected text item in the file. The Backward option finds the previous occurrence of a selected text item in the file. Find Marked Text

Opens a pop-up window with functions for searching for delimiters, like parentheses and quotation marks. See Section 3.14 on page 28. Replace |>field and the right delimiter and the right delimiter and the t he right delimiter