Table of Contents
1 General
The man-machine communication is executed by means of command and confirmation. A command is an instruction from an authorized maintenance operator, and a confirmation is the system's response to a command.
For every command the system checks the syntax and format of the entered characters.
2 Logon
In order to connect to the system, a logon must be performed by sending characters to the system from a terminal. Guided by the speed with which the characters are sent, the system determines the speed of transmission. The string of characters to be sent to the system consists of the capital letter S. When the system has decided the transmission speed, the letter S is echoed back to the terminal and printed. The string of S is terminated by a semi colon followed by carriage return (<CR>), <ENTER>, or the SEND key.
If a terminal with low speed has been connected to the system, and the connection is changed to a terminal with higher speed, it can be difficult to log on. In this case the break key shall be keyed one time and then logon with S is to be executed as usual. (When the break key is pushed, the terminal transmits a pulse which lasts until the key is released.)
At this point, the system will ask for an operator identity. When a valid identity has been entered, the system will respond by printing out the maintenance operator's authority class, copyright, the station identity, date, time and the equipment position to which the terminal is connected. See section User name and password for further details regarding identity.
The system is now ready to accept commands.
If the system receives an invalid identity, it will prompt the operator to try again. After three consecutive invalid logon attempts from the same terminal, the logon procedure must be started again. To prevent unauthorized logon the system will reject further logon attempts for the next 20 minutes. If the maintenance operator tries to logon at anytime within the next 20 minutes the system will reset the time to 20 minutes again.
The maintenance operator will automatically be logged off if the terminal will be disconnected after having been logged on. If the terminal was disconnected during execution of a command, new logon attempts will be rejected until the execution of the command is finished.
The logon and logoff events may be logged to a log file.
3 User Name and Password
The maintenance operator must enter an identity to log on to the system. The identity can be a user name and password, or just a password, depending on the type of I/O board being used to log on. Each identity is assigned an authority class from 0 through 7, where 0 is the lowest and 7 the highest.
Each command also is assigned an authority class from 0 through 7. In order to execute a command, the maintenance operator must log on using an identity with authority class higher than or equal to that of the command.
After initial start-up the maintenance operator can log on to the system using the default user name and password. The default user name is MDUSER (if the NIU/NIU2 board is used) and the default password is HELP.
If both user name and password are required to log on, the system will prompt the maintenance operator to change the password at the very first log on.
For security reason it is recommended that the maintenance operator changes the default password. It is also possible to change the default user name.
4 Command execution
Commands are in MML (man-machine language) format.
Commands can be entered via different methods:
- From I/O terminal or modem via V.24 interface or network connection.
- From a command file on the hard disk. See section Reading a command file.
- From within the system, e.g. from the PABX operator's console set.
If the command is entered from the I/O terminal the I/O board stores the entered characters until carriage return and linefeed are entered. Then the string is sent to the PLEX part of the command administration.
A syntax check is performed of the entered command. If no error is discovered, the first two letters of the command code is used to identify the program units that may handle the command.
The complete command code is then sent to the identified program units, one at a time, until the program unit that shall handle the command is found. The command parameters are then sent to that program unit to be analysed.
When the analysis of the parameters has been successful the command is executed.
The commands and their execution results can be logged to a log file.
5 Reading a command file
A command file can be stored on the hard disk. By command or system initiated this command file can be read into the system and be executed.
One example when this can be used is when a command file shall be transferred from an operation and maintenance centre to the site. The command file is then stored on the hard disk and read into the system with one command. This means faster handling of the command file because the normal echo protocol does not have to be used during the transmission, it is possible to use XMODEM protocol.
6 Command syntax
A command consists of a command code which may be followed by one or more parameters.
|
The maximum number of characters for a command is 200, i.e. two rows. All characters belong to the ACSII code set.
| [ ] | Indicates that this part is optional (may be omitted). |
| { } | Indicates that one of the alternatives must be specified. |
| ... | Indicates that one or more values can be specified for this parameter, i.e. the parameter may contain one or several of the following &, && or ALL. |
7 Characters
The language used for man-machine communication in the system comprises the following characters.
7.1 Command characters
| A-Z | Capital letters |
| 0-F | Hexadecimal digits |
7.2 Editing characters
During communication with the system, the following characters are also used:
| - | Used, e.g., to denote sub-element in hardware equipment positions. |
| , | Separates parameters. |
| & | Separates parameter values, e.g. 100&200, meaning that the values 100 and 200 can be used, but not the values in between. |
| && | Separates beginning and end values for a consecutive series of parameter values. Example: 100&&200 means that all values from 100 up to and including 200 can be used. |
| ! | If a command is terminated by an exclamation mark instead of a semicolon, the command will be executed and thereafter the command code without parameters is automatically printed out by the system. The maintenance operator adds the needed parameters and parameter values. The function is used when the same command is to be keyed several times in a row. |
| : | Separates command code and parameter part. |
| ; | Terminates a command string. |
| = | Ties a value to a parameter. |
| /* | Indicates beginning of comment. |
| */ | Indicates end of comment. |
| H' | Hexadecimal notation. |
| O' | Octal notation. |
| B' | Binary notation. |
| ' | The next character is not to be checked. |
| " | Indicates beginning and end of a parameter value which consists of a text string. |
8 Command validity
Besides the syntax check, each command is further checked with respect to:
- validity of each character
- validity of command code
- whether the command is free
- if the command is to change exchange data, a check is performed to ensure that no other such command is in the process of being executed
- number of parameters
- whether parameter values conform with the type of command
- whether the parameter values are within the boundaries
9 Command structure
A command consists of five characters.
XXYYZ
| XX | Indicates the command group to which the command belongs. |
| YY | Indicates the function the command is to perform. |
| Z | Indicates the operation code. |
The following operation codes exist:
| C | Change |
| E | End |
| I | Initiate |
| L | Load |
| P | |
| R | Remove |
| S | Set, allocate |
| T | Transfer |
10 Interrupting a command
During transmission of data in either direction, authorized maintenance operators have the possibility to send a break signal to the system, which causes it to be immediately ready to receive commands.
The break of the command is initiated by pressing the CTRL and X keys at the same time. The system will confirm by sending the characters:
?
<
When the break signal has been initiated the following possibilities are available:
| B; <CR> | to interrupt a printout. |
| ; <CR> | to continue a printout. |
| F; <CR> | to interrupt a command that has been already accepted. If the command has been partly executed, changes in exchange data that may have been performed will remain. |
11 Command authorization codes
Any command that can be executed from a terminal is assigned to one of the authorization codes 0 through 7.
Commands that are initiated from a PABX operator console will not be given any authorization code since a PABX operator will be authorized to execute any commands that can be initiated from the PABX operator console.
12 Dangerous commands
A command is classified as DANGEROUS if it affects the function of the system, e.g. removal of an extension. Dangerous commands are echoed to the maintenance operator and followed by the printout:
SURE?(YES/NO)
<
For the command to be executed, the maintenance operator must now answer Y (ES); followed by <CR> . If the maintenance operator answers N (O); followed by <CR> the command will not be executed.
13 Commands that change exchange data
On certain occasions it is impossible to execute commands that are changing or copying exchange data. If the maintenance operator keys a command when this is the case, the system can answer with any of the following printouts:
NOT ACCEPTED
followed by any of:
| OTHER COMMAND THAT CHANGES | Dump to backup media is in progress |
| PROGRAM CODE IS NOW | |
| EXECUTING | |
| RELOAD IS EXECUTING | Reload is in progress |
| RESTART IS EXECUTING | Restart is in progress |
| OTHER COMMAND THAT CHANGES | Another command that is changing or |
| RELOAD DATA IS NOW | copying exchange data is executing |
| EXECUTING |
The maintenance operator must wait to key a command in the above cases.
14 Commands that change program code
On certain occasions in the system it is not possible to execute commands that are changing or copying program code. If the maintenance operator keys a command when this is the case, the system can answer with any of the following printouts:
NOT ACCEPTED
followed by any of:
| OTHER COMMAND THAT CHANGES | Dump to backup media is in progress |
| PROGRAM CODE IS NOW | or another command that is changing |
| EXECUTING | or copying program code is executing |
| RELOAD IS EXECUTING | Reload is in progress |
| RESTART IS EXECUTING | Restart is in progress |
The maintenance operator must wait to key a command in the above cases.
15 Multi-line commands
When a command with its parameters exceeds one line in length, the line is terminated by a complete parameter value followed by a comma (,). After pressing the <CR> key the command can be continued.
No command may exceed two lines (200 characters) in length.
16 Comments
A comment begins with the characters /* and ends with the characters */. A comment must not exceed two lines and must not be mixed with commands on the same line.
The following are examples of comments in a command file:
/* Initiate individual PABX operator number series */
NANSI :NUMTYP=OI,NUMSE=500&&502;
/* Initiate PABX operators 500 and 501 */
OPERI :DIR=500&&501,EQU=1-0-41-0,TRAF=1515,OPC=00,PRG=1;
17 System messages
17.1 Restart
When a system requested restart occurs in the system, the following message is sent to all terminals with users logged on:
MESSAGE FROM OPERATING SYSTEM:
RESTART REQUESTED
SYSTEM INITIATED
If a command that is changing or copying program code or exchange data is executing while the system carries out a restart, the following message is sent to all terminals with users logged on:
MESSAGE FROM OPERATING SYSTEM:
RESTART AND RELOAD REQUESTED
SYSTEM INITIATED
The maintenance operator must find out what is relevant to do in this situation as it depends on the command that was executing when the restart occurred.
17.2 Reload
A reload of the system, a LIM or a data reload can be initiated by the maintenance operator or by the system. In these cases the following message is sent to all terminals with users logged on:
At system initiated LIM reload
MESSAGE FROM OPERATING SYSTEM:
RELOAD REQUESTED
SYSTEM INITIATED LIM
At system initiated data reload
MESSAGE FROM OPERATING SYSTEM:
RELOAD REQUESTED
SYSTEM INITIATED DATA
If a command that is changing or copying exchange data is executing while the system carries out a restart, in all of the cases above the following message is sent to all terminals with users logged on:
MESSAGE FROM OPERATING SYSTEM:
RESTART AND RELOAD REQUESTED
SYSTEM INITIATED DATA
All changes of exchange data that have been made since last dump are lost when reload is performed. The maintenance operator has to enter the commands that have been given since last dump.
17.3 Side change
If a side change occurs, system requested or maintenance operator requested, the following message is sent to all terminals with users logged on:
MESSAGE FROM OPERATING SYSTEM:
RESTART REQUESTED
SYSTEM INITIATED
And when data reload after the side change is initiated, the following message is sent to all terminals with users logged on:
MESSAGE FROM OPERATING SYSTEM
RELOAD REQUESTED
SYSTEM INITIATED DATA
18 Printouts
18.1 General
The system has four different types of printouts:
- Verification printouts
- Procedure printouts
- Immediate response printouts
- Result printouts (spontaneous printouts)
18.2 Verification printouts
A verification printout consists of a command being echoed back to the terminal if the command is classified as dangerous to the system. See section Dangerous command.
18.3 Procedure printouts
Procedure printouts are used to inform the maintenance operator whether a command has been executed, partly executed or not executed at all. If the command has been accepted, the following printouts may occur
| EXECUTED | The command has been fully executed. |
| ORDERED | The command has been accepted by the system but not yet executed. The result of the command will be printed to the terminal when the requested operation has been completed. For example, consider a demand for testing of units. The system will confirm the demand by printing ORDERED. The terminal can now be logged off without missing any result printout of the test. When the test is completed, the system will request access to the terminal from which the command was initiated and print out the result of the test. If the terminal is busy, the system will wait until it is free, and then print out the result. See also section Result printouts. |
Error detected during execution:
| NOT ACCEPTED | The command is erroneously specified. No action has been taken. |
| PARTLY EXECUTED | The action specified has been partly executed but detection of an error has interrupted the execution. |
The messages NOT ACCEPTED and PARTLY EXECUTED will be followed by a printout specifying the error.
For reload-data-changing commands it is possible to have a sequence number printed out in addition to the printout. The sequence number is incremented with each command and is used for tracking purpose.
18.4 Immediate response printouts
This kind of printouts are given as soon as the system has accepted a command. If the response time to printout is long, WAIT will be printed.
Immediate response printouts terminate with END.
18.5 Result printouts (spontaneous printouts)
Printouts of this type are those that do not appear immediately when a command has been initiated.
Result printouts may appear after the maintenance operator has logged off.
The printout may also appear in connection with some other command if the requested job has been finished.
Result printouts start with SPONTANEOUS PRINTOUT and terminate with END.
19 Log-off
Logging off can be performed manually or automatically.
Manual log-off
Press simultaneously the keys CTRL and X in order to terminate the command handling.
The system responds with:
?
<
Key in O; <CR>, whereupon the system responds with:
LOGGED OFF
Automatic log-off
If no command has been given for a period of 10 minutes the following printout appears:
TIME OUT WARNING
If no command is given within the following 10 minutes the terminal will automatically be logged off and the following printout appears:
LOGGED OFF
