Ref Manual Client Program

7/31/2019 Ref Manual Client Program

1/50

1997-2005 by SJU BVSuperView Client Program

Reference Manual

Page 1

The SuperViewClient Program

Reference Manualversion 1.0

Software version 4.0


2/50


Reference Manual

Page 2

Table of contents

1. Introduction. ....................................................................................6

2. The connection with a SuperView server. .....................................7

2.1. Defining SuperView servers. ............................................................. 7

2.2. Selection of a SuperView server........................................................7

2.3. Opening a session with the SuperView server. .................................7

2.4. Closing a session with the SuperView server. ...................................8

3. The Menu Dialogue. .......................................................................10

3.1. Activating the menu dialogue...........................................................10

3.2. Keeping the menu dialogue opened. ...............................................10

3.3. Changing the presentation of the options on the menu...................10

3.4. Selecting another menu. ..................................................................11

3.5. Activating a menu option. ................................................................11

3.6. Standard menus and menu options. ...............................................11

3.6.1. Menu 0: The Configuration menu. ......................................................................12

3.6.2. Menu 1: The System Control menu....................................................................13

3.6.3. Menu 2: The Call Handling menu. .....................................................................15

3.6.4. Menu 3: The Exception Information menu..........................................................16

3.6.5. Menu 4: The Planning menu. .............................................................................16

3.7. Permission to access menus...........................................................16


3/50


Reference Manual

Page 3

4. The Configuration Schema dialogue............................................18

4.1. Introduction. .....................................................................................18

4.2. Introduction to Access Methods.......................................................19

4.3. Introduction to Target Systems........................................................19

4.4. Colours indicating the status of the objects. .................................... 19

4.5. Using the Configuration Schema dialogue to control SuperView. ...19

4.5.1. Opening a session with a Target System.............................................................20

4.5.2. Closing a session with a Target System. .............................................................20

4.5.3. Killing a session with a Target System. ............................................................... 20

4.5.4. Opening the Log View . .......................................................................................20

4.5.5. Maintaining message recognition tables and script definitions. ............................ 20

4.5.6. Maintaining the Resource Monitoring tables. .......................................................20

4.6. Options presented on the tool bar and menu bar. ...........................21

5. The Log View dialogue..................................................................22

5.1. Introduction. .....................................................................................22

5.2. Activation of the Log View dialogue................................................. 22


5.4. Use of function keys. .......................................................................24

5.5. Vertical scrolling. ............................................................................. 24

5.5.1. Using the vertical scroll bar. ................................................................................25

5.5.2. Using function keys.............................................................................................25

5.5.3. Using the block scrolling buttons on the toolbar...................................................25

5.6. Horizontal scrolling. ......................................................................... 25

5.7. Changing the width of a column....................................................... 25

5.8. Data selection..................................................................................265.9. Sending commands to a Target System. .........................................26


4/50


Reference Manual

Page 4

5.10. Simulating the reception of a message from a Target System. .......27

5.11. Writing a message in the Central Log file........................................27

5.12. Sending a message to another user of the SuperView Client program. 29

5.13. Printing selected records. ................................................................29

6. The Data Table Dialogue...............................................................30

6.1. Introduction. .....................................................................................30

6.2. Activation of Data Table Dialogue. .................................................. 30


6.4. Use of the keyboard to control the dialogue. ...................................31

6.5. Scrolling. ..........................................................................................32

6.5.1. Vertical scrolling..................................................................................................32

6.5.2. Horizontal scrolling..............................................................................................33

6.6. Data selection..................................................................................34

6.6.1. Selection of rows.................................................................................................34

6.6.2. Selection of columns...........................................................................................35

6.7. Printing............................................................................................. 35

6.8. Searching for words or values. ........................................................36

6.9. Changing the content of the data table............................................36

6.9.1. Changing the value of a single field. ................................................................... 36

6.9.2. Inserting new rows. .............................................................................................37

6.9.3. Deleting the selected row.s. ................................................................................37

6.9.4. Deleting selected rows with all dependent tables. ................................................37

6.9.5. Deleting the whole data table. .............................................................................37

6.9.6. Replacing words or values. .................................................................................38


5/50


Reference Manual

Page 5

6.10. Importing and exporting. ..................................................................39

6.10.1. Introduction......................................................................................................... 39

6.10.2. Explaining "Modules". .........................................................................................39

6.10.3. Selecting an export file........................................................................................40

6.10.4. Exporting rows with their dependent tables.......................................................... 41

6.10.5. Selecting an import file. ......................................................................................42

6.10.6. Importing rows with their dependent tables.......................................................... 42

6.11. Using the clip board. ........................................................................44

6.11.1. Introduction......................................................................................................... 44

6.11.2. Copying selected rows to the clip board. .............................................................44

6.11.3. Pasting rows from the clip board. ........................................................................ 44

6.12. Data presentation. ...........................................................................44

6.12.1. Presenting several rows at the same time. ..........................................................44

6.12.2. Presenting all columns of a single row................................................................. 45

6.12.3. Content of the system columns. .......................................................................... 45

6.12.4. Showing and hiding the system columns.............................................................46

6.12.5. Changing the width of a column. ......................................................................... 46

6.12.6. Changing the height of the rows. ......................................................................... 46

6.13. Returning to the higher level data table...........................................46

6.14. Activating Links................................................................................47

6.14.1. Opening a dependent data table. ........................................................................ 48

6.14.2. Activation of a script............................................................................................48


6/50


Reference Manual

Page 6

SuperView Version 4.0

Client Program Reference Manual

1. Introduction.

The basic SuperView product consists of a Client- and a Serverprogram. The Server program is described in the SuperViewServer manual.

The Client program is used by all SuperView Users to access alldata of the SuperView system. All data is stored within theSuperView server.

If the Basic System version is used, the Client program must berunning on the same system as the SuperView Server does.

The Advances System version offers much more flexibility: TheClient program can be used on any Windows-NT or Windows-95system for which a TCP/IP connection can be opened to the systemon which the Server runs. Using the standard remote access facilityof Windows-NT or Windows-95, the SuperView Client program canbe used on a remote location.

SuperViewSuperView

ClientClient

SuperViewSuperView

ServerServer

SuperViewSuperView

ClientClient

TCP/IP networkTCP/IP network

DataData

SuperView

User

SuperView

User

Controlled and

Monitored systems

ServicePersonnel

problem

calls


7/50


Reference Manual

Page 7

2. The connection with a SuperView server.

2.1. Defining SuperView servers.

After installation of the Client program, the IP address of the SuperView serverhas to be defined in a Server Profile. Multiple Server Profiles can be defined.When the Client program is started for the first time, it automatically asks todefine the IP address of the SuperView server. In case the Client Program runson the same PC as the Server program, you must use the standard IP address127.0.0.1.

In case the Server profiles have to modified later, of if you want to add anotherSuperView Server (e.g. one for testing new scripts), you can open the list ofServer Profiles from the main Window of the Client program by selection themenu options: File > Setup > Server Profiles.

2.2. Selection of a SuperView server.

In case multiple Server Profiles have been defined, you have to select theSuperView server you are going to access.This can be done from the main Window of the Client program by selection themenu option: Select, or by clicking on the following toolbar button in the mainWindow of the Client program:

This opens the dialogue box from where you can select one of the definedservers:

If only one Server profile has been defines, no selection is required.

2.3. Opening a session with the SuperView server.

After selection of the SuperView server, you can open a session to this server.

This can be done from the main Window of the Client program by selection themenu option: Open, or by clicking on the following toolbar button in the mainWindow of the Client program:

The dialogue window on the next page is displayed to enter the parameters forlogging on to the server.


8/50


Reference Manual

Page 8

The following dialogue window is displayed to enter the parameters for loggingon to the server:

If logging on fails, you need to close and reopen the session first before you cantry again.If logging on succeeds, the menu dialogue will be displayed. When logging onlocally, the menu dialogue will apprear within a few seconds. When logging onfrom a remote location via a slower link, the menu dialogue will appearsignificantly later. The duration depends on the speed of the line. This delay iscaused by downloading of menu- and data definitions from the Server to the

Client program.

2.4. Closing a session with the SuperView server.

The session is automatically closed when the Client program is closed. In caseyou want to open a session with another SuperView server, of if you need toreopen the session, you must close the existing session.

This can be done from the main Window of the Client program by selection themenu option: Close, or by clicking on the following toolbar button in the mainWindow of the Client program:


9/50


Reference Manual

Page 9


10/50


Reference Manual

Page 10

3. The Menu Dialogue.

3.1. Activating the menu dialogue.

After opening a session with a SuperView server, the menu dialogue is displayedautomatically. If you need to use the menu dialogue on any other moment (whilethe session with the server is opened), you can click on the menu icon on anytoolbar:

From any dialogue which presents data, you can also type Ctrl-M to open themenu dialogue.After activating the menu dialogue is displayed as the top level window:

3.2. Keeping the menu dialogue opened.

Clicking on the Keep Opened button at the right top corner of the dialoguewindow, will keep the menu dialogue available after activating an option. Clickingon the same Keep Opened button again, will cause the menu dialogue todisappear after the next time an option is activated.

3.3. Changing the presentation of the options on the menu.

Clicking on the Change Style button at the left top corner of the dialoguewindow will select the next out of 4 styles of presentation of the options.


11/50


12/50


Reference Manual

Page 12

3.6.1. Menu 0: The Configuration menu.

The Configuration menu is designed for use by the SuperView

Administrator. Only users of the SPVADMIN (or an equivalent) group canuse the options on this menu.It contains options which are used when configuring and restarting theSuperView server

.

3.6.1.1. Option A: Configuration definitions.

This option opens the list of definedconfigurations. The purpose and maintenance ofconfiguration definitions is explained in the

SuperView Administration and Configurationmanual.

3.6.1.2. Option B: Select configuration.

This option opens a dialogue window by whichthe SuperView Administrator can select thename of the configuration which has to be usedat the next start of the SuperView server.

3.6.1.3. Option C: Restart system (0).

This option causes the SuperView server to shutdown and restart immediately. All openedsessions are killed (closed without performinglog-off scripts) and any Client users aredisconnected.This option allows only the current user to log onto the SuperView server after it has beenrestarted. This user can continue theconfiguration or recovery work without beingdisturbed by other users logging on. The currentuser can open the server for other users usingoptions from the System Control menu (menu 1).

3.6.1.4. Option D: Restart system (1).

This option causes the SuperView server to shutdown and restart immediately. All openedsessions are killed (closed without performinglog-off scripts) and any Client users aredisconnected.This option allows only users of the SPVADMINgroup to log on to the SuperView server after ithas been restarted. The users of the SPVADMIN

group can open the server for other users usingoptions from the System Control menu (menu 1).


13/50


Reference Manual

Page 13

3.6.1.5. Option E: Restart system (2).

This option causes the SuperView server to shutdown and restart immediately. All openedsessions are killed (closed without performinglog-off scripts) and any Client users aredisconnected.This option allows all users to log on to theSuperView server after it has been restarted.

3.6.1.6. Option F: Script areas.

This option opens the table of all script areas

and can be used as a way to access themessage recognition- and script definitions of allscript areas.

3.6.1.7. Option G: New Com. Control Profile.

This option starts a script which defines a newCommunication Control Profile. The purpose anduse of these profiles is explained in theSuperView Administration and Configurationmanual.

3.6.2. Menu 1: The System Control menu.

The System Control menu is designed for use by the SuperViewOperators (users of the SPVOPER group) and by SuperViewAdministrators. Only users of the SPVOPER and SPVADMIN (or anequivalent) groups can use the options on this menu.It contains options which are used to control the operation of theSuperView server.

3.6.2.1. Option A: Configuration Schema.

This option opens a dialogue which shows theschema of the currently used configuration. Thisschema shows the status of the link with thecomputer systems and other destinations liketelephone- and paging systems. The schemaoffers facilities to control and monitor thesesessions. The use of the Configuration Schemadialogue is explained in a later section of thismanual.

3.6.2.2. Option B: Central Log File.


14/50


15/50


Reference Manual

Page 15

This option opens the table of permanent scriptvariables. These variables can be accessedfrom the script language of the SuperViewsystem. This lanuage is explained in theSuperView Script Language manual.

3.6.3. Menu 2: The Call Handling menu.

The Call Handling menu is designed for use by the SuperView Operators(users of the SPVOPER group) and by SuperView Administrators. Onlyusers of the SPVOPER and SPVADMIN (or an equivalent) groups canuse the options on this menu.It contains options which are used to control the way the Call Handler ofthe SuperView server distributes messages to people.Details of the content of these tables are explained in the Call Handlingchapter of the SuperView Administration and Configuration manual.

3.6.3.1. Option A: Pending calls.

This option opens the Pending Calls table. Thistable contains one line for each message to besent.

3.6.3.2. Option B: Call paths.

This option opens the table which contains the

list of paths (names of defined target system)which are available to the Call Handler of theSuperView server to distribute messages topeople. This table usually contains target systemnames like PAGER and PHONE-1, etc.

3.6.3.3. Option C: Group schedules.

This option opens the table that contains allgroups for which a roster can be defined. Such aroster is applied by the Call Handler todetermining the actual destination when sendinga call to the group.

3.6.3.4. Option D: Telephone destinations.

This option opens the table which contains alldetails of destinations which can be reached bytelephone. The group roster (accessed via optionC) may reference these destinations.

3.6.3.5. Option E: Pager destinations.


16/50


Reference Manual

Page 16

This option opens the table which contains alldetails (name, type, number) of all beepers orother (radio) paging destinations. The grouproster (accessed via option C) may referencethese destinations.

3.6.3.6. Option F: E-mail destinations.

This option opens the table which defines all E-mail destinations. The group roster (accessed viaoption C) may reference these destinations.

3.6.4. Menu 3: The Exception Information menu.

The Exception Information menu is designed for use by the SuperViewOperators (users of the SPVOPER group) and by SuperViewAdministrators. Only users of the SPVOPER and SPVADMIN (or anequivalent) groups can use the options on this menu.It contains options which give access to data tables which containinformation about unusual events detected by the SuperView server.Details of the content of these tables are explained in the SuperViewAdministration and Configuration manual. Release 4.0 of the SuperViewsystem only contains the Alarm Table.

3.6.4.1. Option A: The Alarm table.

This option opens the Alarm table. The tablecontains messages which are not distributed bythe Call Handler, but which are reported toSuperView Administrators and -Operators via theClient program.The messages are placed in this table by scriptsrunning in the SuperView server. Any script canuse the ALARM command to place a message inthe Alarm table. The ALARM command isexplained in the SuperView Script Language

manual.

3.6.5. Menu 4: The Planning menu.

The purpose of the options of this menu is explained in the SuperViewPlanning manual.

3.7. Permission to access menus.

The use of the options on the menus is restricted according to the rules in thefollowing table:


17/50


Reference Manual

Page 17

Menu: Can be accessed by users of:

The Configuration menu The SPVADMIN groupThe System Control menu The SPVADMIN and SPVOPER groupsThe Exceptions menu The SPVADMIN and SPVOPER groupsThe Call Handling menu The SPVADMIN and SPVOPER groups


18/50


Reference Manual

Page 18

4. The Configuration Schema dialogue.

4.1. Introduction.

The Configuration Schema is displayed when the menu option 1.A (Menu 1;option A) is activated.

The configuration schema shows:

which access methods are available;

to which Target Systems (computer systems) SuperView is connected;

the current status of the link with the Target Systems;

the general status of the resource monitoring for each of the Target Systems.

The configuration schema is used by the SuperView operator to control thesessions with the Target Systems.

After selecting one of the Target Systems, the SuperView operator can:

Open the session.

Close the session.

Kill the session (closing it without running the log-off script).

Open the log file of the session.

Maintain the message recognition tables and the scripts.

Maintain the resource monitoring data.


19/50


Reference Manual

Page 19

4.2. Introduction to Access Methods.

Access Methods are methods used to access data which exists outsideSuperView. The following Access Methods have been implemented:

TCP/IP communication (used to communicate with computer systems).

Asynchronous communication (also used to send messages to pagers). External file access (for monitoring and creating log files).

Printer communication (for printing from scripts running within the SuperViewServer).

Telephone communication (to perform voice dialogs with a person bytelephone).

Communication with the SuperView operator.

The blue icons in the configuration schema each represent a specific AccessMethod.

For each Access Method, a separate process (thread) runs within the SuperViewserver which handles the communication with the connected Target Systems.Opening or closing an Access Method corresponds to starting or stopping theprocess. The status of an Access Method is visible below the icon in theconfiguration schema.

4.3. Introduction to Target Systems.

Target Systems are symbolic objects which represent an entity SuperView cancommunicate with. Usually, Target Systems can receive messages fromSuperView and can send messages to SuperView. The way SuperView

communicates with a Target System depends on the used Access Method.If the Target System is a computer system, SuperView sends commands to thatsystem and will receive messages from the computer system.

4.4. Colours indicating the status of the objects.

The configuration schema contains a SuperView icon (in the centre), the AccessMethods (connected to the SuperView icon) and the Target Systems (eachconnected to an Access Method icon).The colour of the area in which the name of the object is presented, indicates the

current status of the object.

Black: The object is not available.Red: The object is closed (not operational).Green: The object is opened and operational.Blue: The object is opened, but is not actively used (waiting).

4.5. Using the Configuration Schema dialogue to control SuperView.

The configuration schema is used by the SuperView operator to control thesessions and to open a new dialogue to watch the log file of a session.

Before operations can be activated on SuperView, an Access Method or on aTarget System, the operator has to identify the object. This can be done byclicking on the icon or by typing the two alphabetic characters which aredisplayed at the right side of the icon.


20/50


21/50


22/50


Reference Manual

Page 22

5. The Log View dialogue.

5.1. Introduction.

The Log View dialog is used to watch what is going on in the SuperView systems.The data which is presented, is retrieved from the central log file of theSuperView server. There are three levels at which the Log View dialog can beopened:

SuperView (general) level.

Access Method level.

Target System level.

By clicking on an icon on the configuration schema before choosing the "LogFile" option, the selection is done.

Choosing a level corresponds to setting a selection f ilter:

On the SuperView level, no selection takes place: all records are displayed.

On Access Method level, all records are displayed that carry the AccessMethod name in the "Process" column of the Central Log file.

On Target System level, all records are displayed that carry the TargetSystem name in the "System" column of the Central Log file.

Various options can be used to restrict the messages which are displayed.Please refer to the paragraph "Data Selection" below.

The Log View dialogue is not only intended to watch what is going on. It alsoallows to send commands to the controlled target systems manually (please referto paragraph 5.9).

5.2. Activation of the Log View dialogue.

There a two ways to open a Log View Dialogue:

From the System Control menu: select option B. This opens a Log Viewdialogue on SuperView level.

From the Configuration Schema dialogue. Please refer to paragraph 4.6option 6.

5.3. Options presented on the tool bar and menu bar.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

The buttons of this toolbar have the following function:

1. Open the menu dialogue. The current Log View dialogue is kept open.

2. Return to the menu dialogue. The current Log View dialogue is closed.

3. Print the selected records.

4. Set or reset the auto-scroll feature. When the auto-scroll feature is selected,the Log View always shows the most recent part of the selected records

from


23/50


Reference Manual

Page 23

the Central Log file. When the Log View dialogue is opened, the auto-scrollfeature is set automati-cally.

5. Scroll one block down (direction: to the future). A block is a defined numberof pages. The number is specified in the edit field at the right/bottom corner

of the log View dialogue.

6. Scroll one block up (direction: to the past). A block is a defined number ofpages. The number is specified in the edit field at the right/bottom corner ofthe log View dialogue.

7. Show the first selected record on the screen.

8. Show the last selected record on the screen.

9. Reset the record selection.

10. Set the period from which to retrieve data from the Central Log file. This

avoids that scanning for selected records (until a full page is reached)continues too far into the past.When this option is selected, the following dialogue appears:

This dialogue enables you to select the desired period.

11. Specify all record selection criteria.When this option is selected, the following dialogue appears:

The list shows all columns which exist in the Central Log file.


24/50


25/50


Reference Manual

Page 25

A field at the bottom of the Log View dialogue shows the relative position of thedisplayed records within the Central log fi le. The relative position is expressed asa percentage.

5.5.1. Using the vertical scroll bar.

Dragging the scroll box to a position corresponds to starting the recordselection from that point in the active period (explained in paragraph5.7.2) of the Central Log file.

Clicking on the (down) button at the bottom of the scroll bar scrolls

one selected record down (direction: future). The (up) button at thetop of the scroll bar scrolls one selected record up (direction: past).Clicking on the scroll bar below the caret, scrolls down one page(direction: future). Clicking above this symbol scrolls up one page

(direction: past).

5.5.2. Using function keys.

Page-up Scrolls one page of selected records up (direction: past).Page-down Scrolls one page of selected records down (direction:future).Arrow-up Scrolls one selected record up (direction: past).Arrow-down Scrolls one selected record down (direction: future).Home Scrolls to the first selected record.End Scrolls to the last selected record and f ills the page inupward dir.

5.5.3. Using the block scrolling buttons on the toolbar.

Scroll one block down (direction: to the future). A block is a definednumber of pages. The number is specified in the edit field at theright/bottom corner of the log View dialogue.

Scroll one block up (direction: to the past). A block is a definednumber of pages. The number is specified in the edit field at theright/bottom corner of the log View dialogue.

5.6. Horizontal scrolling.

Horizontal scrolling of the displayed information can be done:

Using the horizontal scroll bar.

Using keys:Arrow-right or Tab one column to the right.Arrow-left or shift-Tab: one column to the left.

5.7. Changing the width of a column.


26/50


Reference Manual

Page 26

By dragging the marked column boundaries with the mouse, the width of thecolumns can be adjusted.

5.8. Data selection.

To selection the records to be presented, please refer to the explanation inparagraph 5.3 option 11.

To select the period to be presented, please refer to the explanation inparagraph 5.3 option 10.

5.9. Sending commands to a Target System.

The Log View dialogue can be used to send commands to each of the connected

computer systems. By clicking on the red "!" button on the toolbar, the commandfields are opened at the bottom of the dialogue.

The Target System The command to be sent

To open thecommand-fields at thebottom ofthe dialogue.


27/50


Reference Manual

Page 27

5.10. Simulating the reception of a message from a Target System.

For the purpose of testing scripts it is useful to be able to simulate that a specificmessage is received from a Target System.

The Target System from The text of the simulated input messagewhere the message came

5.11. Writing a message in the Central Log file.

To open thefields at thebottom ofthe dialogue.

To open thefields at thebottom ofthe dialogue.


28/50


29/50


Reference Manual

Page 29

5.12. Sending a message to another user of the SuperView Client program.

This feature has not been implemented yet.

5.13. Printing selected records.

After selecting the f irst and the last record to be printed, click on the print icon onthe toolbar.


30/50


31/50


Reference Manual

Page 31

6.3. Options presented on the tool bar and menu bar.

The toolbar of the Data Table dialogue contains the following buttons:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

The purpose of these buttons is:1. Open the menu dialogue. The current Data Table dialogue is kept open.2. Return to the menu dialogue. The current Data Table dialogue is closed.3. Save the Data Table in the database.4. Print the selected rows/columns. If no selection specified: print all.5. Present the data in a schema.6. Insert a new row in front of the current row.7. Insert a new row in behind the current row.8. Delete the selected rows (without deleting the dependent tables).9. Delete all rows (without deleting the dependent tables).10. Search for a text string.11. Replace text strings.12. Copy the selected rows to the clip board.13. Cut the selected rows (Copy to the clip board and delete the rows).14. Paste the rows on the clip board behind the current row.15. Show or hide the system columns.16. Change the presentation method (row- or table oriented).

6.4. Use of the keyboard to control the dialogue.

When you have NOT opened a field to edit the value, the keyboard can be usedto:

close the data table (Alt + F4).

scroll vertically (Page-up, Page-down, Arrow-up, Arrow-down, Home, End).

scroll horizontally (Tab, Shift-Tab).

select rows (with or without keeping the Shift key pressed: Arrow-up, Arrow-down).

select all rows (Ctrl+A).

change the selection of the current field (Arrow-left, Arrow-right) on thecurrent row.

activate the buttons at the right/bottom corner of the dialogue (F1 to F12,Ctrl+F1 to Ctrl+F12)to open a dependent data table or to execute a script.

insert a new row (Ins, Ctrl+Ins).

Delete the selected rows (Del).

Delete all rows (Ctrl+Del).

Copy the selected rows to the clip board (Ctrl+C).

Pasting the rows on the clip board behind the current row (Ctrl+V).

Cutting the selected rows (Ctrl+X).

Printing rows (Ctrl+P).

Exporting the selected rows with dependent tables (Ctrl+E).

Importing a module behind the current row (Ctrl+I).

When you have opened a field forediting, the keyboard can be used to:

Close the field without changing the value (Esc).

Close the field with changing the value (Enter).

Select the next (Tab) or prior (Shift-Tab) field for editing.

All other keystrokes are used to edit the content of the field.


32/50


33/50


Reference Manual

Page 33

6.5.1.3. Changing the height of a row.

6.5.2. Horizontal scrolling.

6.5.2.1. Using the horizontal scroll bar.

The horizontal scroll bar can be used to display columns(fields) which are not presented currently.

Select the previous field to be the current field. If thecurrent field is the first visible field, then the previousfield will be presented as the first visible field.If the current field is not visible, the last visible field willbecome the current field.

Select the next field to be the current field. If the currentfield is the last visible field, then the next field will bepresented as the last visible field. If the current field isnot visible, the first visible field will become the currentfield.

The caret of the horizontal scroll bar can be dragged to anotherplace on the scroll bar to indicate which field must be the firstvisible field. Clicking on the horizontal scroll bar in front of thecaret scrolls one column to the left. Clicking on the horizontalscroll bar behind the caret scrolls one column to the right.

Use of the horizontal scroll bar does not affect the selection of

the current field, unless the or buttons are used.

The first column showsthe line numbers.

Vertical dragging of theline below the line num-ber, changes the heightof all rows of the table.


34/50


35/50


36/50


Reference Manual

Page 36

The height of the rows on the screen and the width of the columns on the screenwill also be used for printing.The printing process will automatically scale the picture to be printed to fit on theselected paper type.A monochrome picture is printed.

6.8. Searching for words or values.

Clicking on the Search button on the toolbar or typing Ctrl+F opens the Finddialog:

When clicking on the Find Next button, searching starts from the current row andcontinues in the specified direction until:

A field is found that contains the text to be found.

The top or bottom of the table is reached.The resulting row is selected. If a field is found that contains the text, it isselected and becomes the current field.

6.9. Changing the content of the data table.

6.9.1. Changing the value of a single field.

Changing the values of the fields is only possible if this is not preventedby the access rights definitions.When a table is presented and a current row and field is selected, thevalue of this field sti ll cannot be changed.

It has to be opened for editing by:

double clicking on the field with the right mouse button;

or by pressing the ENTER key.When the field is opened for editing, you can change its value.

The update will be cancelled if the field is closed by pressing the ESCkey. The update is effectuated when you close the field by pressing theENTER, TAB or Shift-TAB keys, or when you click with the mouse onanother field.

The size of the field cannot be adjusted after it has been opened forediting. If necessary, please change the field before you open the fieldfor editing by changing the column width or row height as explainedearlier.

Depending on the type of the field, an edit-field or a drop-list is opened.


37/50


38/50


Reference Manual

Page 38

6.9.6. Replacing words or values.

Clicking on the (red) button on the toolbar opens the Replacedialogue which offers the feature of text- or value replacement.

If columns have been selected (by clicking on the column title field), theReplace dialogue operates only on the values in these columns. If nocolumns have been selected, it operates on all columns.

Replacement starts on the current row and continues in downwarddirection.


39/50


40/50


Reference Manual

Page 40

6.10.3. Selecting an export file.

Before modules can be exported, an export file has to be defined. The"File" option of the menu bar of the Data Table dialogues contains theoption "Select Export file".

Clicking on the "Select Export file" option opens the Dialogue:

Type the name ofthe new export file.

The displayed "Existing export files" are all files which are found in theEXPORT-subdirectory of the installation directory of the SuperViewserver. New export files are created in this directory.


41/50


Reference Manual

Page 41

6.10.4. Exporting rows with their dependent tables.

To export data, the following steps are required:

Open the data table which contains the rows to be exported.

Select the rows.Click with the left mouse button on the "Edit" option on the menu bar, orclick with the left mouse button on the selected rows. The Edit menu isdisplayed:

Select the options "Module Export Module".

A dialogue is displayed to define the name and description of the module:

Define the module name and a description (optional) and click on the OK button.


42/50


Reference Manual

Page 42

The module is now added to the export file. If the export file does notexist, it will be created now. From this moment, the export file will bevisible in the list mentioned below the last dialogue picture of theparagraph " Selecting an export file ".

6.10.5. Selecting an import file.

Before modules can be imported, the right import file must be defined.Import files must be located in the IMPORT sub-directory of theinstallation directory of the SuperView server.

Files which were exported from the current SuperView server and whichneed to be imported, can be copied from the EXPORT sub-directory tothe IMPORT sub-directory. Refer to the paragraph "Selecting an exportfile" on the last dialogue, select the export file from the list and click onthe "Copy to Import" button.

To define the import file, click on the "File" option on the menu bar of theData Table dialogue and select the option "Select Import file". Thisopens the dialogue which shows all files in the IMPORT sub-directory:

Select the right file and click on the OK button.From now on, modules can be imported from this file.

6.10.6. Importing rows with their dependent tables.

Assuming that an import file has been defined (please refer to theprevious paragraph), modules can be imported from this fi le.

Open the data table in which the main rows of the module have to beinserted and determine the place where the imported rows have to beinserted:

If no row of the opened data table is selected, the imported rows areadded at the end of the table.

If a row has been selected, the imported rows are inserted in front of

the selected row.

Click with the left mouse button on the "Edit" option of the menu bar ofthe Data Table dialogue, or click with the right mouse button on theselected row.


43/50


Reference Manual

Page 43

The "Edit" menu appears. Select the "Module Import Module" optionand the following dialogue is opened:

This dialogue shows all modules which can be imported. Modules which

were exported from other types of tables are not displayed in thisdialogue.

Select the right module and click on the "Import" button. You can alsodouble-click on the name of a module that has to be imported.

Repeat this until you have imported all modules you want. The click onthe "Close" button.


44/50


Reference Manual

Page 44

6.11. Using the clip board.

6.11.1. Introduction.

The clip board can be used to copy complete individual rows or a groupof complete rows of a data table.

The toolbar of the Data Table dialogues contain three icons that are usedto activate operations using the clip board:

6.11.2. Copying selected rows to the clip board.

Select the rows that have to be copied to the clip board.If the rows have to be deleted from the data table after being copied, use

the button on the toolbar. The deletion of the rows is performed justlike the original deletion operation that is explained earlier: if dependenttables exist for the rows to be deleted, then the deletion is rejected.

Use the button if the rows just have to be copied to the clipboardand remain in the data table as well.

6.11.3. Pasting rows from the clip board.

Before you paste rows from the clip board, you first have to indicate

where the rows have to be inserted: If you select a row, the rows on the clipboard are inserted behind this

row.

If you have not selected any row, the rows from the clipboard areinserted before the first row of the table.

Use the button on the toolbar to insert the rows from the clip board.

Pasting is only possible when the rows on the clip board originated fromthe same type of data table.

6.12. Data presentation.

Several features exist to change the way a data table is presented on the screen.

6.12.1. Presenting several rows at the same time.

Usually, data tables are presented in a Multiple-row mode. This meansthat as many rows as fit are displayed within the area of the window thatis intended for this purpose.The alternative way is explained in the next paragraph. This alternative

way shows as many columns as possible for only the current row.


45/50


Reference Manual

Page 45

The default way of presentation is specified in the definition of the datatable.

Changing the presentation is achieved by clicking on the button onthe toolbar of the Data table dialogue.

6.12.2. Presenting all columns of a single row.

The presentation of the data table can be changed to Single-row mode toshow as many columns as possible for only the current row.

Changing the presentation is achieved by clicking on the button onthe toolbar of the Data table dialogue.

The following picture shows an example of the Single-row presentation:

6.12.2.1. Use of function keys for scrolling and field selection.

While data is presented in single row mode, scrolling is stillhandled in the same way as in Multi-row mode.

6.12.3. Content of the system columns.

Depending on the definition of each type of data table, the following twosystem columns may be available for the opened data table:

Last update: This system column is maintained automaticallyby the SuperView server and shows: by whom and when the lastmodification of the row has been applied. The content of this columncannot be modified.

Filters: This system column contains the names of

Filters that are applied to the current line. The content of this columncan only be modified by the SuperView Administrator (users of theSPVADMIN group). The purpose and use of Filters is explained in theSuperView Administration and Configuration manual.


46/50


Reference Manual

Page 46

6.12.4. Showing and hiding the system columns.

The visibility of the System columns is turned on and off by clicking on

the button on the toolbar of the Data Table dialogue.

6.12.5. Changing the width of a column.

The way to change the width of a column is explained in paragraph6.5.2.3.

6.12.6. Changing the height of the rows.

The way to change the height of all rows is explained in paragraph6.5.1.3.

6.13. Returning to the higher level data table.

The button on the toolbar of the data Table dialogue can be used to closethe data table and to return to the next higher level data table. If the current datatable is already the highest level data table, then the menu dialogue is displayed(after the current data table is closed).

If modifications have been applied and the data table has not been saved sincethen, a dialogue is displayed:

When you click on the "Yes" button, the SuperView server saves the changeddata table in the database. The changes are distributes to the other users whohave opened the same data table.

When you click on the "No" button, the SuperView server closes the data

table without saving the changes in the database. The changes are lost.

When you click on the "Cancel" button, the request to leave the current datatable is cancelled.


47/50


Reference Manual

Page 47

6.14. Activating Links.

The buttons at the right/bottom corner of the Data Table dialogue, are used toactivate links.Links can be defined for each type of data tables.

There are two types of links:

A link which opens a dependent table;

A link which starts the execution of a script.

Before a links is activated, first the row must be selected on which the link has tooperate.

A link is activated by clicking on a link buttons or by pressing the key(s) whichare displayed on the link buttons (in the top/left corner). Normally, the first twelvelinks are activated with the function keys F1 to F12. The next twelve links areactivated with function keys Ctrl+F1 to Ctrl+F12.

The colour of the text on the link button indicates the type of the link:

Black text is used for a link which opens a dependent data table;

Red text is used for a link which executes a script.

Function key Black text: Red text:Dependent ExecutesTable. a script.

The linkbuttons


48/50


Reference Manual

Page 48

6.14.1. Opening a dependent data table.

When a link button is activated to open a dependent data table,SuperView first verif ies if changes have been applied to the current tablewithout having been saved. If this is the case, the following dialogue is

displayed:

When you click on the "Yes" button, the SuperView server saves thechanged data table in the database. The changes are distributes tothe other users who have opened the same data table.

When you click on the "No" button, the SuperView server closes thedata table without saving the changes in the database. The changesare lost.

When you click on the "Cancel" button, the request to leave thecurrent data table is cancelled.

6.14.2. Activation of a script.

When a link button is activated to execute a script, SuperView firstverifies if changes have been applied to the current table without havingbeen saved. If this is the case, the same dialogue is displayed asexplained in the previous paragraph.

The script is started which has been pre-defined in the definition of thelink. The script receives a start messages which contains:

The name and type of the data table that was opened; The key of the current row.

The identifying value of the current row.

The script can perform all kinds of functions, like:

modification of all data tables;

sending commands to target Systems

opening dialogues for the user of the Client program (to ask forparameters or to give a confirmation).

More details about the execution and features of scripts can be found inthe Script Language Reference manual.

The following pictures are an example of dialogues that can be pre-defined and then used from scripts.


49/50


Reference Manual

Page 49

The sequence of dialogues is displayed when activating the script todefine a new Communication Control Profile. This script can be startedfrom the Configuration Menu:

Option G of the Configuration menu starts a script which performs aseries of dialogues with the user of the Client program:

Click on the Next button.


50/50


Reference Manual

Click on the Next button.

Ref Manual Client Program

Documents

Transcript of Ref Manual Client Program