Trailing-Edge
-
PDP-10 Archives
-
BB-H311C-RM
-
swskit-documentation/kfs.mem
There are 6 other files named kfs.mem in the archive. Click here to see a list.
| DOCUMENT: RAB-77-001-02-S
|
| DATE: 30-JUN-77
PROJECT: RSX-20F KLINIK LINK
| CHARGE NUMBER: 63-08507
|
| PRODUCT ID: QT010
| REVISED FUNCTIONAL SPECIFICATION FOR THE
RSX-20F KLINIK LINK
AUTHOR: Roland Belanger
ISSUED BY: __________________________________
Supervisor
__________________________________
Project Leader
APPROVED BY: __________________________________
Development Manager
__________________________________
Product Manager
__________________________________
Product Manager
REVIEWED BY: __________________________________
Software Documentation Manager
__________________________________
Software Reliability Manager
__________________________________
HOSS Manager
Revised Functional Specification for the RSX-20F KLINIK LINK Page 2
| COPYRIGHT (C) 1976, 1977, 1978 DIGITAL EQUIPMENT CORPORATION
The software described in this document, including but not
limited to instruction execution times and operating speeds, is
for information purposes only. All such material is subject to
change without notice. Consequently, DIGITAL makes no claim and
shall not be liable for its accuracy.
The software described is furnished to the purchaser under a
license for use on a single computer system and can be copied
(with the inclusion of DIGITAL's copyright notice) only for use
in such system, except as otherwise may be provided in writing by
| DIGITAL. Ownership of, or title to, the software described in
| this document is not transferred.
DIGITAL assumes no responsibility for the use or reliability of
its software on equipment that is not supplied by DIGITAL.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 3
1.0 PRODUCT OVERVIEW
1.1 PRODUCT DECSRIPTION
The RSX-20F KLINIK LINK will provide secure, reliable,
privileged, limited access into a DECsystem-20 system or a KL10
CPU based DECsystem-10 system. This access is intended for use
by DEC personnel either as a maintenance aid or to provide
customer assistance. The RSX-20F KLINIK LINK will provide the
option to be accessed either as a dedicated timesharing terminal
line, or as a remote parallel to the console terminal line.
The RSX-20F KLINIK LINK will communicate via a DL11E Single
Asynchronous Serial Line Interface with Modem Control, connected
to a Bell 103A modem, and will use all applicable ANSI and DEC
Standards and protocols.
This Functional Specification is based upon and takes its
direction from the following controlling documents:
1. Memo, KLINIK SPEC REVIEW AND SIGNOFF, Mike Robey, FSMEG, ______ ____ ______ ___ _______
25-OCT-76
2. Memo, KLINIK USER MODE SPECIFICATION, Mike Robey, FSMEG, ______ ____ ____ _____________
04-NOV-76
1.2 MARKETS
1.3 COMPETITIVE ANALYSIS
1.4 PRODUCT AUDIENCE
The RSX-20F KLINIK LINK is intended for use by DEC personnel
only. The customer is not seen as an end-user of the RSX-20F
KLINIK LINK, but as the beneficiary of improved
price / performance of both hardware and software support
services. Field Service personnel at the Branch, District,
Regional and Product Support levels will use the RSX-20F KLINIK
LINK for the remote diagnosis of hardware malfunctions. Software
Support personnel at any of these levels will use the RSX-20F
KLINIK LINK to provide customer assistance. Further, Field
Service Product Support and HOSS will use the RSX-20F KLINIK LINK
for remote performance data collection and analysis.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 4
2.0 GOALS
2.1 PERFORMANCE
The RSX-20F KLINIK LINK will provide a reliable, secure, limited
access, dedicated dial-up port into a DECsystem-10 or
DECsystem-20. With only the few exceptions detailed below, the
KLINIK LINK will present no differences in appearance from a
normal operator console or user terminal line dependent on mode
to the KLINIK user.
2.1.1 SECURITY
The implementation of the RSX-20F KLINIK package affords the
customer some excellent advantages at the expense of incurring
some loss of system security. All attempts will be made to
render the RSX-20F KLINIK package as secure as reasonably
possible. We must, however, acknowledge the risk involved, as
well as the consequences of the improper use of this feature,
deliberate or otherwise.
2.1.1.1 USER KLINIK MODE SECURITY
In the case in which the RSX-20F KLINIK LINK is used to access
the system as a normal user timesharing line, the only
requirements are that the KLINIK user know a specific phone
number and that KLINIK access is enabled when the KLINIK user
dials in. System security then becomes the responsibility of the
normal security mechanisms of the TOPS timesharing executive.
Once KLINIK access has been gained, there shall be no obvious
differences between the KLINIK line and a normal timesharing
line.
2.1.1.2 REMOTE KLINIK MODE SECURITY
When the RSX-20F KLINIK LINK is used to access the system as a
remote operator console line, the KLINIK user will be required to
supply a predetermined password. This password will be assigned
in real-time by the local operator, and communicated to the
KLINIK user via the telephone or other suitable means. Should
the KLINIK user fail to supply the proper password within a
certain period of time, the access attempt will be aborted by the
system. At this point, the KLINIK user may redial and make a
further attempt to gain access.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 5
In all cases, there will be a finite time window during which
KLINIK access will be granted. All attempts to gain KLINIK
access during any other time periods will be acknowledged and
rejected. Further, neither the remote nor the local console will
be allowed to raise the capabilities of either terminal above a
prespecified level without going through an entire KLINIK LINK
disconnect sequence. When the RSX-20F KLINIK LINK is being used
as an operator console, all input from and output to either
terminal will appear on both. While the KLINIK LINK disconnect
sequence may be initiated at either terminal, only the local
operator terminal will be allowed to initiate the (re)connect
sequence.
Once KLINIK Access has been granted, the RSX-20F KLINIK LINK will
remain active beyond the window close time. The access window
shall have no effect on an active line, nor shall the fact that
the line goes inactive have any effect in the access window.
When the RSX-20F KLINIK LINK is being accessed as a user
timesharing line, input from and output to that terminal will not
appear on the local operator console, and vice-versa.
It is a goal to record certain significant events in the KLINIK
access and disconnect processes via the SYSERR mechanism as a
consideration for system security.
2.1.2 HUMAN ENGINEERING
A high level of Human Engineering is absolutely essential to the
RSX-20F KLINIK package. All communication to the KLINIK user
from all modules in the RSX-20F KLINIK package will be clear,
concise, non-cryptic, and in plain English. All prompts to the
KLINIK user will be as clear and as self-explanatory as possible.
The user will be informed of all significant events which are of
concern to him. The system will inform the KLINIK user of any
action it is to take toward him, before it takes that action.
The goal is not to leave the KLINIK user guessing.
2.1.3 CPU TO CPU KLINIK
It is a goal not to preclude the possibility of remote data
collection facility access to the RSX-20F KLINIK LINK
architecture. This facility would be restricted in that the
accessing computer must present input to and accept output
fromthe RSX-20F KLINIK LINK in exactly the same manner as a
normal remote operator would.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 6
2.1.4 GENERALIZED DL11E SERVICE
It is a goal to develop a Functional Specification for a
Generalized DL11E Service which will be based on this document.
2.2 SUPPORT OBJECTIVES
The RSX-20F KLINIK LINK feature will be a standard part of the
RSX-20F system released to all KL10 customers. As such, there
are no additional installation procedures required specifically
for KLINIK. The customer does have a requirement to fully
understand the KLINIK architecture and the implications of this
architecture, especially with respect to security. Because of
this consideration we must plan detailed KLINIK documentation for
both the Operator's Guide and the System Manager's Guide.
Further, we must plan a pre-release orientation for DEC Support
Specialists, as well as comprehensive KLINIK training to be
incorporated into the applicable programs for both DEC personnel
and customer personnel.
The required documentation will be produced by the Software
Documentation Group and the Field Service Documentation Group,
and will consist of, but not be limited to the following items:
1. KLINIK User's Guide
| 2. KLINIK section in the TOPS-20 System Manager's Guide
3. KLINIK section in both the TOPS-10 and TOPS-20 Operator's
Guide
The required training programs will be developed by Course
Development and administered by both Field Service and Customer
Training Groups.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 7
2.3 ENVIRONMENTS
2.3.1 HARDWARE ENVIRONMENT
The minimum hardware required to operate the RSX-20F KLINIK LINK
is:
1. PDP-11 / 40 Front-end CPU
2. DL11E Asynchronous Serial Line Interface w / Modem Control
3. BELL 103A3 Modem
4. DF01 mod A242 (or equivalent) Acoustic Coupler
5. Two (2) LA36 hard-copy terminals
2.3.2 SOFTWARE ENVIRONMENT
2.3.2.1 TOPS-20
The minimum software required to operate the RSX-20F KLINIK LINK
on a TOPS-20 system is:
1. RSX-20F Executive with DL11E support
2. RSX-20F KLINIK Validation Task
3. RSX-20F KLINIK Termination Task
4. RSX-20F CONSOLE COMMAND LANGUAGE with KLINIK support
Commands
5. RSX-20F CONSOLE COMMAND LANGUAGE with Time and Date entry
Commands
6. RSX-20F Task to update the Time of Day across midnight.
7. TOPS-20 SYSERR with KLINIK event support.
8. TOPS-20 Executive which handles user console input from the
Front-End
9. TOPS-20 Executive with a KLINIK Parameter save/restore
facility
Revised Functional Specification for the RSX-20F KLINIK LINK Page 8
The implementation of the RSX-20F KLINIK LINK on TOPS-20 systems
is directly contingent upon these last three requirements,
requirements 7, 8, and 9. These last three requirements are
external dependencies.
2.3.2.2 TOPS-10
The minumum software required to operate the RSX-20F KLINIK LINK
on a TOPS-10 system is:
1. RSX-20F Executive with DL11E support
2. RSX-20F KLINIK Validation Task
3. RSX-20F KLINIK Termination Task
4. RSX-20F CONSOLE COMMAND LANGUAGE with KLINIK support
Commands
5. RSX-20F CONSOLE COMMAND LANGUAGE with Time and Date entry
Commands
6. RSX-20F Task to update the Time of Day across midnight.
7. TOPS-10 Executive which handles user console input from the
Front-End
8. TOPS-10 SYSERR with KLINIK event support.
9. TOPS-10 Executive which has a KLINIK Parameter save/restore
facility
The implementation of the RSX-20F KLINIK LINK on TOPS-10 systems
is directly contingent upon these last three requirements,
requirements 7, 8, and 9. These last three requirements are
external dependencies.
2.4 RELIABLITY GOALS
Each module in the RSX-20F KLINIK package will be extensively
tested both as a separate part and as an integrated part of the
system in as many different environments as possible. The
RSX-20F KLINIK package will have the ability to maintain its
integrity during and / or to recover from such event types as:
1. Front-End crash
2. TOPS (KL10) system crash
Revised Functional Specification for the RSX-20F KLINIK LINK Page 9
3. DL11E Carrier loss
2.5 NON GOALS
The following items are specifically not to be included in the
implementation of the RSX-20F KLINIK package:
1. Development of multiple Front-End RSX-20F KLINIK Support.
2. Development of any type of down-line, alternate path, or
cross-CPU program loading schemes.
3. Development of any type of networking support within the
RSX-20F KLINIK package.
4. Development of any support which would reroute program
output to a different medium.
5. Development of any specialized capabilities specific to the
future possibilities addressed by a remote CPU to CPU data
collection operation.
6. Development of a partitioning scheme which would allow the
use of the RSX-20F Command Parser, or any other PDP-11
program normally resident in the GEN partition, during
KLINIK Access Validation and Termination.
7. Development of a facility for the logging of KLINIK activity
while the KL10 is down.
8. Development of any specialized terminal synchronization
schemes.
3.0 FUNCTIONAL DEFINITION
3.1 OPERATIONAL DESCRIPTION
Revised Functional Specification for the RSX-20F KLINIK LINK Page 10
3.1.1 KLINIK ENABLE
The RSX-20F KLINIK LINK is enabled by issuing a "SET KLINIK"
Command to the RSX-20F Command Parser from the local console.
The RSX-20F Command Parser will then collect and validate the
following parameters in the indicated sequence.
The RSX-20F Command Parser will request the KLINIK mode desired
by typing the prompt:
KLINIK MODE:
The acceptable responses to this prompt are either of the
following:
REMOTE
USER
Where "USER" indicates that the RSX-20F KLINIK LINK is to be used
as a timesharing terminal line, and "REMOTE" indicates that the
RSX-20F KLINIK LINK is to be used as a remote console line.
There are NO default responses to this prompt. If any other
response is supplied, the local operator will receive one of the
following error messages:
PAR -- [SET] NSK - NO SUCH KEYWORD "XXX"
PAR -- [SET] ILC - ILLEGAL CHARACTER "C"
Where "XXX" and "C" are the offending keyword and character,
respectively. The Command will then be aborted.
The RSX-20F Command Parser will then accept the KLINIK ACCESS
WINDOW parameters by printing the following four prompts and
accepting responses in sequence:
ACCESS WINDOW OPEN DATE:
ACCESS WINDOW OPEN TIME:
ACCESS WINDOW CLOSE DATE:
ACCESS WINDOW CLOSE TIME:
Since both dates and times have exactly the same formats, we will
discuss the dates and times separately, noting the differences
which exist between open and close.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 11
The format for the dates are as follows:
DD-MMM-YY
DD-MMM-YYYY
DD MMM YY
DD MMM YYYY
Where "DD" is the decimal day, "MMM" is the alphabetic
representation of the month, and "YY" or "YYYY" is the decimal
year in which the KLINIK WINDOW is to open or close. The default
response to either date prompt is a <CARRIAGE-RETURN>, and will
set the Window Open Date to TODAY, and the Window Close Date to
the Window Open Date + 1 day.
NOTE
"TODAY" is the current date obtained from the RSX-20F
Executive.
The day specified must be in the range 1 <= DD < 32, and date
within months having less than 31 days will be validated, to
include a special check for February in a Leap-Year. The month
must be a least unique match for the alphabetic month. The year
| may be specified either as a Gregorian year, 19XX, or as a year
| relative to 1900, 00 thru 99, where the first two digits are
| assumed to be the first two digits of the current year. Failure
| to adhere to this syntax will cause one of the following error
| messages to be printed and the command to be aborted.
If the day specified does not exist in the month specified:
PAR -- [SET] DOR - DAY OUT OF RANGE
If the keyword specified for the month cannot be matched:
PAR -- [SET] NSK - NO SUCH KEYWORD "XXX"
or, if that keyword is ambiguous:
PAR -- [SET] AMB - AMBIGUOUS KEYWORD "XXX"
where "XXX" is the offending keyword.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 12
If the year has been improperly specified:
PAR -- [SET] YOR - YEAR OUT OF RANGE
| If the access window open or close date is prior to TODAY:
PAR -- [SET] DBT - DATE BEFORE TODAY
Where "TODAY" is defined as the date obtained from the RSX-20F
Executive.
Both the Window Open and Window Close time may be specified in
either of the following formats:
HHMM
HH:MM
where "HHMM" is a concatenated decimal representation of the hour
and minute. In both formats, "HH" is the hour and must be in the
range 00 <= HH < 24, and "MM" is the minute and must be in the
range 00 <= MM < 60. The default response is a <CARRIAGE-RETURN>
and will set the Window Open Time time to NOW, and the Window
Close Time to the Window Open Time.
NOTE
"NOW" is the current time of day obtained from the
RSX-20F Executive.
Specifying a time which does not conform to this syntax will
cause the command to abort after the following error message is
typed:
PAR -- [SET] TOR - TIME OUT OF RANGE
Finally, when the complete specifications for both the Window
Open and Window Close times and dates have been accepted, the
Window Open time and date will be checked to insure that it does
| precede the Window Close time and date. If this is not the case,
the Command will abort with the following error message:
PAR -- [SET] KWE - KLINIK WINDOW ERROR
Revised Functional Specification for the RSX-20F KLINIK LINK Page 13
If the KLINIK MODE specified earlier was "USER", the dialogue
will terminate at this point, as all necessary parameters have
been input. The Command Parser will display the parameters which
have been passed to the RSX-20F Executive as described below. If
the specified KLINIK MODE was "REMOTE", two more parameters will
be solicited from the operator.
The RSX-20F Command Parser will then request a password with the
prompt:
PASSWORD:
and will expect at least 1 and up to 6 numeric or upper case
alphabetic characters, with no imbedded or trailing blanks, as a
response; there are NO default responses. The operator's
response to this prompt will be echoed on the local console.
Failure to provide a password in this form will cause the command
to abort after one of the following error messages is typed:
If no password was specified:
PAR -- [SET] NPI - NULL PASSWORD ILLEGAL
If more than 6 characters were typed:
PAR -- [SET] PTL - PASSWORD TOO LONG
If a non-alphanumeric character was typed as a password
character:
PAR -- [SET] IPC - ILLEGAL PASSWORD CHARACTER "C"
Where "C" is the offending character.
The local operator must communicate this password to the remote
KLINIK user in order that he be allowed access to the RSX-20F
KLINIK LINK.
The RSX-20F Command Parser will then request that the operator
specify the highest RSX-20F Command Parser Console mode to be
allowed while the RSX-20F KLINIK LINK is active with the prompt:
HIGHEST CONSOLE MODE:
Revised Functional Specification for the RSX-20F KLINIK LINK Page 14
The acceptable responses to this prompt are any one of the
following:
MAINTENANCE
OPERATOR
PROGRAMMER
While the RSX-20F KLINIK LINK is active, the RSX-20F Command
Parser will not allow neither the remote nor the local console to
raise the Command Parser Console Mode, via the "SET CONSOLE"
Command, to a level higher than that specified in response to the
prompt. There is NO default response to this prompt. Refer to
the RSX-20F Command Parser Functional Specification for details
about Console Modes. Failure to provide the proper response to
this prompt will cause the Command to abort after the following
error message is typed:
PAR -- [SET] NSK - NO SUCH KEYWORD "XXX"
where "XXX" is the offending keyword.
If all parameters have been properly input and validated, the
RSX-20F Command Parser will return to command level after
displaying the KLINIK enable parameters in the following format:
KLINIK [<ACTIVE> <INACTIVE> <DISABLED>]
ACCESS WINDOW OPEN: DD-MMM-YY HH:MM
ACCESS WINDOW CLOSED: DD-MMM-YY HH:MM
KLINIK MODE: [<REMOTE> <USER>]
If the KLINIK MODE is "REMOTE", one additional line will be
displayed, which describes the highest Parser Console Mode to be
allowed:
| HIGHEST CONSOLE MODE: [<MAINTENANCE> <OPERATOR> <PROGRAMMER>]
This identical display will also be available from the
"WHAT KLINIK" Parser Command. The "WHAT KLINIK" Command will be
| independent of the "SET KLINIK" Command. The exception case of
| the RSX-20F KLINIK being active on reboot with no Primary
| Protocol restart or receipt of KLINIK Parameters will cause the
| "WHAT KLINIK" command to type the following message in the
| consoles:
|
| KLINIK ACTIVE FROM REBOOT
| KLINIK MODE: REMOTE
| HIGHEST CONSOLE MODE: MAINTENANCE
NOTE
If the RSX-20F KLINIK LINK is "DISABLED", i.e., no KLINIK
parameters have been specified, only the first line of _____
the display will be printed by the "WHAT KLINIK" Command.
"ACTIVE" is defined as the case where the KLINIK user is
connected to the RSX-20F KLINIK LINK.
"INACTIVE" is defined as the case where the KLINIK
parameters have been set, but access has not yet been
| allowed.
"DISABLED" is defined as the case where no KLINIK
parameters have been set.
Upon receipt of these parameters, the RSX-20F Executive will log
the "SET KLINIK" Command and the parameters which were accepted.
Further, the RSX-20F Executive will pass these parameters to the
KL10 Executive, to facilitate KLINIK recovery from an -11 Reboot.
3.1.2 KLINIK DISABLE
The RSX-20F KLINIK LINK is disabled via the "CLEAR KLINIK"
Command Parser Command. This Command does not accept arguments
and simply clears the KLINIK WINDOW. If the KLINIK LINK is
ACTIVE, this Command will cause the RSX-20F Executive to print
the following message on both the local and the remote consoles:
KLD -- KLINIK ACCESS TERMINATED BY OPERATOR
In all cases, the current KLINIK enable parameters will be reset
and passed to the KL10 Executive, and the KLINIK ACCESS WINDOW
closed. The RSX-20F Executive will then log the KLINIK MODE
termination. While the modem will not be hung up, all input from
and output to the remote console will be ignored and all
subsequent calls made to the KLINIK LINK will be acknowledged and
rejected until such time as a new KLINIK WINDOW is set by the
local operator. The rejection message will be of the following
format:
KLR -- KLINIK RING - KLINIK WINDOW CLOSED
This rejection message will appear on both the local and remote
consoles. The RSX-20F Executive will then log the unsuccessful
access attempt.
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 16
|
|
3.1.3 KLINIK ACTIVATION
NOTE
In the following sections, the term "LOGON" is used in
reference to gaining access to the RSX-20F KLINIK LINK.
This term is not to be confused with the term "LOGIN",
which refers to gaining access to a TOPS-10 or a TOPS-20
timesharing system.
|
The RSX-20F Executive will always answer the DL11E when it rings,
and will behave according to the KLINIK MODE which was specified
in the last "SET KLINIK" Command. In the case of "USER" KLINIK
MODE, route the terminal line to the KL10 Executive after logging
the access and mode allowed, and typing the following message on
both the local and the remote consoles:
KLR -- KLINIK LINE CONNECTED TO TOPS-XX
Where "XX" is either "10" or "20".
If "REMOTE" KLINIK MODE is to be allowed, the RSX-20F Executive
will print the following message and prompt on the remote
console:
KLR -- KLINIK RING -- VALIDATING ACCESS
PASSWORD:
At the same time, the following message will be printed on the
local console:
KLR -- KLINIK RING -- VALIDATING ACCESS
At this point the KLINIK user on the remote terminal must type
the password which matches that which was specified in the last
"SET KLINIK" Command and select the KLINIK MODE within the next
two minutes of wall clock time. During this period of time, the
RSX-20F Command Parser will not be available to either the remote
console or the local console. Attempting to invoke the RSX-20F
Command Parser at either console will cause the RSX-20F Executive
to queue the request and proceed with the validation process.
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 17
|
|
The KLINIK user will have up to 5 attempts within 2 minutes to
supply the correct password. Echo suppression will occur while
the password is being input. Each occurrence of an incorrect
password will cause the following message and prompt to be
printed on the remote console, after a 10 second pause:
KLR -- INCORRECT PASSWORD -- TRY AGAIN
PASSWORD:
All I/O to the DL11E during the 10 second pause will be ignored
in an attempt to preclude access by an "unfriendly" remote
computer or user.
| If the KLINIK user is unable to supply the correct password
within 5 attempts in the 2 minute time limit, the RSX-20F
Executive will log the password timeout, and print the following
message on both the local and the remote terminals:
KLR -- KLINIK LOGON TIMEOUT -- LOGON ABORTED
KLD -- KLINIK LINE DISCONNECTED
log the unsuccessful LOGON, hang up the modem, and log the modem
hang-up. The remote KLINIK user may then repeat the dial-in and
validation sequence. The local operator may issue a
"CLEAR KLINIK" Command at this point to disallow further attepmts
to gain access.
If the LOGON is successful to this point, the RSX-20F Executive
will log the successful LOGON, and the following prompt will be
printed on the remote console:
KLINIK MODE:
The last prompt will allow the user to select whether or not he
wishes to use the RSX-20F KLINIK LINK as a user console or as a
remote console by specifying either "USER" or "REMOTE" as a
response. There are NO default responses to this prompt. If the
KLINIK user specifies "USER", the RSX-20F Executive will reroute
the remote console line to the KL10 Executive and print the
following message on both the remote and local consoles:
KLR -- KLINIK LINE CONNECTED TO TOPS-XX
where "XX" is either "10" or "20".
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 18
|
|
If the KLINIK user specifies "REMOTE", the following message will
be printed on both the local and remote consoles:
KLR -- KLINIK LINE CONNECTED TO RSX-20F MODE LIMIT [<MODE>]
Where "MODE" may be any one of the following:
MAINTENANCE
OPERATOR
PROGRAMMER
In both cases the mode selection is logged by the RSX-20F
Executive.
| Should the remote KLINIK user type a Control-Z (^Z) during any
| part of the KLINIK access validation sequence, or should the
| modem be hung up during this period, either event will be
| declared equivalent to a "DISCONNECT" Command, and the system
| will behave exactly as in Section 3.1.4, below.
3.1.4 KLINIK TERMINATION
"USER" KLINIK MODE may be terminated by issuing a "CLEAR KLINIK"
Command from the local console as in Section 3.1.2, above.
"REMOTE" KLINIK MODE may be terminated in the same manner, except
that the "CLEAR KLINIK" Command may be issued from either the
remote or local console. In either case, in order to fully
terminate KLINIK ACCESS, a "DISCONNECT" Command must be issued to
the RSX-20F Command Parser. The RSX-20F Command Parser will
communicate the DISCONNECT to the RSX-20F Executive and exit.
The RSX-20F Executive will then log the disconnect and print the
following message on both consoles:
KLD -- KLINIK DISCONNECT
hang up the modem and log the modem hang-up.
NOTE
While the "CLEAR KLINIK" Command does not hang up the
modem, the "DISCONNECT" Command does not clear any KLINIK
parameters. A modem hang up under any circumstances is
exactly equivalent to a "DISCONNECT" Command, except for
the fact that a modem hangup without a "DISCONNECT"
Command is flagged as an error. To fully clear KLINIK
access, the local console must issue both a
"CLEAR KLINIK" and a "DISCONNECT" Command in sequence.
The motivation for this is to provide a means by which
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 19
|
|
the current KLINIK user may terminate activity, without
precluding the possibility of the resumption of activity
at a later point in the KLINIK Access Window.
| 3.1.5 KLINIK RECOVERY
3.1.5.1 -10 OR -20 REBOOT
Should the KL10 Executive be rebooted, the RSX-20F Executive will
simply pass the KLINIK parameters to the KL10 Executive and
continue operations in sequence. The RSX-20F KLINIK LINK will
maintain its integrity over a KL10 crash.
3.1.5.2 -11 REBOOT
Should the RSX-20F Executive be rebooted, the integrity of the
RSX-20F KLINIK LINK will be maintained over the -11 Reboot. Upon
being reloaded, the RSX-20F Executive will request that the KL10
Executive pass it the current KLINIK parameters, thus restoring
the KLINIK data base. It will not be considered an error if the
RSX-20F Executive is unable to obtain the KLINIK parameters from
the KL10 Executive, as the KL10 Executive may not be resident at
this time.
If the KLINIK LINK was active prior to the -11 Reboot it will
remain active. "Active" is defined as finding "CARRIER DETECT"
present when the RSX-20F Executive interrogates the DL11E after
| an -11 Reboot.
|
| If the RSX-20F Front-End was rebooted in such a manner that
| Primary Protocol can be reinitiated between the Processors, the
| RSX-20F Front-End will wait 45 seconds for both of the following
| to take place:
|
| 1. Primary Protocol reinitialization
|
| 2. Receipt of valid KLINIK Parameters from the TOPS-10 or
| TOPS-20 Executive
|
| Should the RSX-20F Executive find "CARRIER DETECT" present in the
| DL11E and be unable to obtain the KLINIK parameters from the KL10
| Executive, the RSX-20F Executive will assume that the KLINIK LINK
| was enabled by KLDCP, the KL10 Diagnostic Console Program, and
| will consider the KLINIK Line to be acknowledged, verified
| (logged in) and active, with a Parser Console Mode Limit of
| "MAINTENANCE".
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 20
|
|
| If the RSX-20F Front-End can obtain the KLINIK Parameters from
| the KL Executive, the RSX-20F KLINIK Link will be enabled
| according to those Parameters.
|
| All other cases of the RSX-20F Front-End being reloaded while the
| KLINIK Link is active will default to the KLINIK Line being
| forced to "REMOTE" mode with a Console Mode Limit of
| "MAINTENANCE".
| NOTE
|
| The 45 second wait is totally arbitrary, and the desired
| effect is not guaranteed, as the passing of KLINIK
| Parameters is a normally scheduled, unsolicited process
| on the part of both the RSX-20F Front-End and the TOPS-10
| or TOPS-20 Executive. However, it is felt that this wait
| period will be sufficient for the large majority of
| cases.
|
|
|
| The following messages will be printed on the Consoles for the
| indicated cases:
|
| If the RSX-20F Front-End is rebooted with the KLINIK line active
| in "REMOTE" KLINIK mode:
|
| SAV -- *DIAG* -- KLINIK LINE ACTIVE IN REMOTE MODE
| SAV -- *DIAG* -- KLINIK LINE CONNECTED TO SYSTEM CONSOLE
|
| If The RSX-20F Front-End is rebooted with the KLINIK link active
| in user mode:
|
| SAV -- *DIAG* -- KLINIK LINE ACTIVE IN USER MODE
|
| Should either the Primary (Queued) or Secondary Protocols cease
| during the wait for KLINIK Parameters, the following will be
| printed on the local console:
|
| SAV -- *FATAL* -- PROTOCOLS NOT RUNNING
|
| and the Protocol recovery initiated. Such an occurrence
| indicates a failure on the part of the TOPS-10 or TOPS-20
| Executive to execute the Protocol restart, and usually requires a
| reload of the TOPS-10 or TOPS-20 System.
|
|
|
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 21
|
|
3.1.6 TIME SPECIFICATION FACILITY
A faciliity to set the RSX-20F Executive date and time variables
will be provided in order to allow the local operator to specify
KLINIK ACCESS window dates and times which correspond to the true
current date and time during periods when the KL10 Executive is
not active. This facility is required because the RSX-20F
Executive is passed the date and time from the KL10 executive at
system load time. If the KL10 Executive has not been active
since the last -11 boot, the RSX-20F date and time default to the
RSX-20F SYSGEN time.
The operator will not be allowed to utilize this facility when a
viable TOPS-10 or TOPS-20 Executive is active.
|
|
| NOTE
|
| A viable, active TOPS-10 or TOPS-20 is deemed to exist if
| the RSX-20F Front-End is running the Primary (Queued)
| Protocol.
The operator will specify the desired date and time by issuing a
| "SET DATE" Command to the RSX-20F COMMAND PARSER. The RSX-20F
COMMAND PARSER will then prompt the operator for the date by
typing the following:
DATE:
The acceptable responses to this prompt are any one of the
following:
DD-MMM-YY
DD-MMM-YYYY
DD MMM YY
DD MMM YYYY
Where "DD" is the decimal day, "MMM" is the alphabetic
representation of the month, and "YY" or "YYYY" is the decimal
representation of the year. There are NO default responses to
this prompt. the day specified must be in the range
1 <= DD < 32, and must exist in the month specified. The month
must be a least unique match for the alphabetic month. The year
| may be specified as either a Gregorian year, 19XX, or as a year
| relative to 1900, 00 thru 99 where the first two digits of the
| year are assumed to be the first two digits of the current year.
| If the date supplied does not conform to these criteria, the
| Command will abort after one of the following error messages is
| printed on the console:
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 22
|
If the day specified does not exist in the month specified:
PAR -- [SET] DOR - DAY OUT OF RANGE
If the keyword for the month cannot be matched:
PAR -- [SET] NSK - NO SUCH KEYWORD "XXX"
or, if that keyword is ambiguous:
PAR -- [SET] AMB - AMBIGUOUS KEYWORD "XXX"
where "XXX" is the offending keyword
If the year has been improperly specified:
PAR -- [SET] YOR - YEAR OUT OF RANGE
| If the date specified is before the RSX-20F SYSGEN date:
PAR -- [SET] DBS - DATE BEFORE SYSTEM DATE
The RSX-20F COMMAND PARSER will then prompt the operator for the
time by typing the following on the console:
TIME:
The time may be specified in either of the following formats:
HHMM
HH:MM
where "HHMM" is the concatenated decimal representation of the
hour and minute. In the both formats, "HH" specifies the hour,
and must be in the range 00 <= HH < 24, and "MM" specifies the
minute which must be in the range 00 <= MM < 60. failure to
adhere to this syntax will cause the Command to abort after the
following error message is printed on the console:
PAR -- [SET] TOR - TIME OUT OF RANGE
| If the date has been properly input, the RSX-20F Command Parser
| will return to command level after displaying the date in the
| following format:
|
| CURRENT SYSTEM DATE: DD-MMM-YY HH:MM
| VALIDITY FLAG IS: [<ON> <OFF>]
|
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 23
|
|
| This display will also be available from the "WHAT DATE" Command,
| which will be independent of the "SET DATE" Command.
|
| Once the DATE has been set by the RSX-20F Command Parser, the
RSX-20F Executive will then continually update it. See Section
3.1.7, below.
3.1.7 DAYTIME MAINTENANCE FACILITY
The current version of the RSX-20F, as noted above, is dependent
upon the KL10 Executive for Time-of-Day data. The RSX-20F
Executive requests this data on two occasions:
1. At RSX-20F startup
2. At Midnight
The request is made at midnight because the RSX-20F Executive
cannot maintain the date and time of day internally across
midnight. If the Time of Day has been supplied to the RSX-20F
| Executive by a "SET DATE" Command, maintenance will cease at
midnight.
Thus a supporting task must be created which will perform the
Midnight date and time maintenance in the case where the KL10
Executive is not active.
3.1.8 PICTORIAL REPRESENTATION
The following diagram is a pictorial representation of the
modules in the RSX-20F KLINIK package and their interconnections.
RSX-20F _______
EXECUTIVE _________
----------- --------- -----------
! RSX-20F !<------------>! !<------------->! TOPS-10 !
! COMMAND ! ! ! ! EXEC !
! PARSER !<============>! !<=============>! !
----------- ! ! -----------
! !
! !
----------- ! ! -----------
! KLINIK !<------------>! !<------------->! TOPS-20 !
! ACCESS ! ! ! ! EXEC !
! CONTROL !<============>! !<=============>! !
----------- ! ! -----------
! !
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 24
|
|
! !
-------------- ! ! ----------- -----------
! KLINIK !<--------->! !<----->! DL11E !<--->! REMOTE !
! DISCONNECT ! ! ! ! MODEM ! ! CONSOLE !
! CONTROL !<=========>! !<=====>! CONTROL !<===>! !
-------------- --------- ----------- -----------
DATA PATHS ARE DENOTED BY THE SYMBOL: "<====>"
CONTROL PATHS ARE DENOTED BY THE SYMBOL: "<---->"
| In the previous diagram, the following modules provide the listed
functions:
1. RSX-20F CONSOLE COMMAND LANGUAGE:
A. "SET KLINIK" Command
B. "CLEAR KLINIK" Command
C. "DISCONNECT" Command
| D. "SET DATE" Command
|
| E. "WHAT date" Command
|
| F. "WHAT klinik"Command
2. KLINIK ACCESS CONTROL:
A. KLINIK Password validation
B. KLINIK MODE selection
C. KLINIK ACCESS Logging
3. KLINIK DISCONNECT CONTROL:
A. Disconnect logging and handling
4. DL11E MODEM CONTROL:
A. DL11E Hardware Driver
5. RSX-20F EXECUTIVE:
A. System-wide event handling
B. Inter-module interface and control
C. Inter-exec interface and control
D. KLINIK event logging
Revised Functional Specification for the RSX-20F KLINIK LINK Page 25
|
|
E. Daytime maintenance across midnight
| 3.2 RESTRICTIONS
The RSX-20F KLINIK LINK is restricted in the following manner:
3.2.1 CONSOLE I / O
While the RSX-20F KLINIK LINK is active in REMOTE MODE, all input
from and output to either the remote or local console will be
or'ed and appear on both consoles. It will be possible to
execute RSX-20F Parser Commands which are input by alternate
characters from each console. In the case where the remote and
local consoles operate as different line speeds, both consoles
will be driven at the lower of the two baud rates.
3.2.2 CARRIER LOSS
Upon detection of modem Carrier loss in the DL11E, the RSX-20F
Executive will wait 10 to 20 seconds, and, if "CARRIER DETECT"
has not appeared at that time, will declare the event as a DL11E
hang-up. The RSX-20F Executive will then perform exactly as
described in Section 3.1.4, above.
3.2.3 RSX-20F CONSOLE COMMAND PARSER
The RSX-20F Command Parser, or any PDP-11 task normally resident
in the GEN partition, will not be available to the local console
while access is being validated until one of the following events
occurs:
1. The remote user has supplied a correct password and KLINIK
Mode.
2. The remote user has made 5 unsucessful attempts to supply
the correct password.
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 26
|
|
3. Two (2) minutes of wall-clock time has expired.
If a PDP-11 task is already occupying the GEN partition when the
ring occurs on the KLINIK line, the ring will be answered, but
access validation and connection to the proper system will be
queued until the GEN partition is free.
| 3.2.3.1 SET KLINIK COMMAND
A "SET KLINIK" Command is specifically not to be allowed while
the RSX-20F KLINIK LINK is active, as a security consideration.
Attempting to do so will cause the command to abort with the
following error message:
PAR -- [SET] SKI - SET KLINIK ILLEGAL WHILE KLINIK ACTIVE
In order to issue a "SET KLINIK" Command under these
circumstances, the operator must first issue a "CLEAR KLINIK"
Command.
3.2.3.2 SET CONSOLE COMMAND
While the RSX-20F KLINIK LINK is active in REMOTE MODE, neither
the local nor the remote console will be allowed to exceed the
Console Mode Limit specified in the previous "SET KLINIK" Command
| by using the "SET CONSOLE" Command. Attempting to do so will
leave the current Parser Console Mode unchanged, and abort the
Command with the following error message
PAR -- [SET] CLE - CONSOLE LIMIT EXCEEDED
3.2.4 LOGGING FACILITY
The SYSERR error / event logging facility described in Section
6.3, below, is totally dependent on the presence of an active,
viable KL10 Executive.
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 27
|
|
3.2.5 CPU TO CPU KLINIK
If the RSX-20F KLINIK LINK is used by one computer to call and
access another computer, the calling computer must present input
to and accept output from the KLINIK LINK in exactly the same
manner as does a remote console.
| 4.0 COMPATABILITY
The RSX-20F KLINIK package will be compatible with the following
software releases:
1. RSX-20F V 010
2. TOPS-10 6.03 Release
3. TOPS-20 Release 3
The RSX-20F KLINIK package will not conform to the DEC Command
Language standard. There are no applicable external standards
involved.
5.0 EXTERNAL INTERACTIONS AND IMPACT
All applicable interactions and impacts have been decribed in
section 3.0. Refer to the RSX-20F Command Parser Functional
Specification for more information about Parser commands.
6.0 RELIABILITY / AVAILABILITY / SERVICEABILITY (RAS)
6.1 CODING CONVENTIONS
All modules for the RSX-20F KLINIK package will be written to
conform to all appliacable DEC RSX-11M Coding Standards.
Further, all code for each module will be reviewed at least once
in the development cycle by the Project Leader. If time allows,
all code for all modules will be reviewed by another member of
the Comm / Nets group.
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 28
|
|
6.2 TESTING
Each module in the RSX-20F KLINIK package will be individually
tested prior to integration into the complete package. The
entire package will ne thoroughly tested in a variety of systems
and environments, to include the simulation of as many error
conditions as possible. Further, it is our intent to submit the
RSX-20F KLINIK package to testing by Field Service and Software
Support prior to release.
|
6.3 LOGGING FACILITY
If the KL10 executive is capable of supporting error logging, the
RSX-20F Executive will record, via the SYSERR mechanism, the
events and errors which are significant to the RSX-20F KLINIK
package.
6.3.1 ERROR / EVENT LOGGING
The following asynchronous events and errors will be logged by
the RSX-20F Executive via the SYSERR logging mechanism:
1. Each occurrence of a "SET KLINIK" Command, as well as the
KLINIK parameters specified.
2. Each occurrence of a "CLEAR KLINIK" Command.
3. Each occurrence of a "DISCONNECT" Command or a DL11E hang
up.
4. Each occurrence of a successful LOGON with the mode
selected.
5. Each occurrence of an unsuccessful logon, including the
number of attempts.
6.4 ERROR RECOVERY
The RSX-20F and KL10 Executives will both maintain the current
KLINIK ENABLE parameters in core in order to facilitate the
preservation of the integrity of the RSX-20F KLINIK LINK over a
crash. The details of this mechanism are contained in Section
3.1.5, above.
Revised Functional Specification for the RSX-20F KLINIK LINK Page 29
7.0 PACKAGING AND SYSTEM GENERATION
No special packaging or system generation requirements exist for
the RSX-20F KLINIK package.
| 8.0 DOCUMENTATION
8.1 END-USER DOCUMENTATION
In order to provide support for both customer and DEC personnel,
the following documentation and training activities are planned
around the RSX-20F KLINIK LINK:
1. A comprehensive RSX-20F KLINIK LINK customer training
program, with emphasis on security.
2. A pre-release orientation of selected Field Service and
Software Support specialists (regional level), again with
emphasis on security.
3. Incorporation of comprehensive RSX-20F KLINIK LINK training
into current Field Service and Software Support training
programs.
4. Development of a complete set of user, operator, customer,
and support documentation for the RSX-20F KLINIK LINK.
8.2 INTERNAL DOCUMENTATION
FILE: KFS.RND
LAST EDIT: 02-DEC-76
EDIT BY: R. Belanger
|
Revised Functional Specification for the RSX-20F KLINIK LINK Page 30
|
|
9.0 REFERENCES
RSX-20F KLINIK LINK Project Plan (200-205-039-00).
RSX-20F Command Parser Functional Specification.
Memo, KLINIK SPEC REVIEW AND SIGNOFF, Mike Robey, 25-OCT-76. ______ ____ ______ ___ _______
Memo, KLINIK USER MODE SPECIFICATION, Mike Robey, 04-NOV-76. ______ ____ ____ _____________
Memo, KLINIK COMMANDS AND VARIABLES, R. Belanger, 20-OCT-76. ______ ________ ___ _________
Memo, SOFTWARE DEVELOPMENT GUIDELINES, F. Howell, 02-DEC-76. ________ ___________ __________
|
10.0 INDEX
Page Index-1
INDEX
-11 Reboot . . . . . . . . . . 19
10 Reboot . . . . . . . . . . . 19
20 Reboot . . . . . . . . . . . 19
| Carrier Loss . . . . . . . . . 25
| Coding Conventions . . . . . . 27
| Command Parser . . . . . . . . 25
| Compatability . . . . . . . . . 27
| Competitive Analysis . . . . . 3
| Console I / O . . . . . . . . . 25
| CPU to CPU Klinik . . . . . . . 5
|
| Daytime Maintenance . . . . . . 23
| Documentation . . . . . . . . . 29
|
| End-User Documentation . . . . 29
| Environment . . . . . . . . . . 7
| Error Logging . . . . . . . . . 28
| Error Recovery . . . . . . . . 28
| Event Logging . . . . . . . . . 28
| External Interactions . . . . . 27
Functional Definition . . . . . 9
Generalized DL11E Service . . . 6
Goals . . . . . . . . . . . . . 4
Hardware . . . . . . . . . . . 7
Human Engineering . . . . . . . 5
| Impact . . . . . . . . . . . . 27
| Internal Documentation . . . . 29
|
| Klinik Activation . . . . . . . 16
Klinik Enable . . . . . . . . . 10
Klinik Recovery . . . . . . . . 19
Klinik Termination . . . . . . 18
| Logging Facility . . . . . . . 26
Markets . . . . . . . . . . . . 3
Non Goals . . . . . . . . . . . 9
Operational Description . . . . 9
Page Index-2
| Packaging . . . . . . . . . . . 29
| Performance . . . . . . . . . . 4
| Pictorial Representation . . . 23
Product Description . . . . . . 3
Product Overview . . . . . . . 3
| RAS . . . . . . . . . . . . . . 27
| Reboot . . . . . . . . . . . . 19
| References . . . . . . . . . . 30
| Reliablity Goals . . . . . . . 8
| Remote Mode Security . . . . . 4
| Restrictions . . . . . . . . . 25
|
| Security . . . . . . . . . . . 4
| SET CONSOLE Command . . . . . . 26
| SET KLINIK Command . . . . . . 26
| Software . . . . . . . . . . . 7
| Support Objectives . . . . . . 6
| System Generation . . . . . . . 29
|
| Testing . . . . . . . . . . . . 28
| Time Specification . . . . . . 21
User Mode Security . . . . . . 4