DataMuseum.dk

Presents historical artifacts from the history of:

CR80 Wang WCS documentation floppies

This is an automatic "excavation" of a thematic subset of
artifacts from Datamuseum.dk's BitArchive.

See our Wiki for more about CR80 Wang WCS documentation floppies

Excavated with: AutoArchaeologist - Free & Open Source Software.


top - download

⟦5818f241b⟧ Wang Wps File

    Length: 37856 (0x93e0)
    Types: Wang Wps File
    Notes: CPS/SDS/007               
    Names: »1090A «

Derivation

└─⟦b3a67856d⟧ Bits:30006040 8" Wang WCS floppy, CR 0065A
    └─ ⟦this⟧ »1090A « 

WangText




…02…CPS/SDS/007

…02…RIM/810801…02……02…
STORAGE AND RETRIEVAL
…02……02…CAMPS








                    T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲



   1  GENERAL .......................................
     10

     1.1  PURPOSE ...................................
       10
     1.2  APPLICABLE DOCUMENTS AND PROJECT
          REFERENCES ................................
           10
       1.2.1  Applicable Documents ..................
         10
       1.2.2  Project References ....................
         11

     1.3  TERMS AND ABBREVIATIONS ...................
       11
       1.3.1  Terms .................................
         11
       1.3.2  Abbreviations .........................
         12

   2  SUMMARY OF REQUIREMENTS .......................
     13

     2.1  PACKAGE DESCRIPTION .......................
       13
       2.1.1  General Concept .......................
         13
         2.1.1.1  Online Storage ....................
           13
         2.1.1.2  Offline Storage ...................
           14
         2.1.1.3  Subject to Storage ................
           14
         2.1.1.4  Storage and Retrieval Keys ........
           14
         2.1.1.5  Retrieval .........................
           14
           2.1.1.5.1  Online Retrieval ..............
             15
           2.1.1.5.2  Offline Retrieval .............
             15

     2.2  PACKAGE FUNCTIONS .........................
       15
       2.2.1  Main Functions ........................
         15
         2.2.1.1  Online Storage ....................
           15
         2.2.1.2  Offline Storage (Dump) ............
           18
         2.2.1.3  Retrieval .........................
           20
           2.2.1.3.1  Online Retrieval ..............
             20
           2.2.1.3.2  Offline Retrieval .............
             21

       2.2.2  Functional Responsibilities ...........
         23
         2.2.2.1  Initialization, Close Down and 
                  Restart ...........................
                   23
           2.2.2.1.1  Initialization ................
             23
           2.2.2.1.2  Close Down ....................
             24
           2.2.2.1.3  Restart .......................
             24

         2.2.2.2  Checkpointing and Recovery ........
           24
           2.2.2.2.1  Checkpointing .................
             24
           2.2.2.2.2  Recovery ......................
             24


         2.2.2.3  Error Detection and 
                  Error Handling ....................
                   25
           2.2.2.3.1  Error Detection ...............
             25
           2.2.2.3.2  Error Handling ................
             25
         2.2.2.4  Integrity of Operation ............
           26
         2.2.2.5  Data Collection ...................
           26
         2.2.2.6  Security ..........................
           26

     2.3  CHARACTERISTICS  ..........................
       26
       2.3.1  Timing ................................
         26
         2.3.1.1  Response Time to Queries ..........
           27
         2.3.1.2  Response Time to Dump .............
           28
         2.3.1.3  Priorities Related to Input .......
           28
         2.3.1.4  Traffic Load ......................
           29
         2.3.1.5  Interleaving STP ..................
           30

       2.3.2  Throughput ............................
         30
       2.3.3  Flexibility ...........................
         30
       2.3.4  Accuracy of Input Data ................
         30

   3  ENVIRONMENT ...................................
     31

     3.1  EQUIPMENT ENVIRONMENT .....................
       31
     3.2  SOFTWARE ENVIRONEMT .......................
       31
       3.2.1  System Software .......................
         31
       3.2.2  Development Software ..................
         31

     3.3  INTERFACES ................................
       32
       3.3.1  External Interfaces ...................
         32
       3.3.2  Package Interfaces ....................
         32
         3.3.2.1  Storage Interface .................
           32
         3.3.2.2  On-Line Retrieval Interface .......
           32
         3.3.2.3  Off-Line Retrieval Interface ......
           33
         3.3.2.4  Dump Retrieval Interface ..........
           33
         3.3.2.5  Supervisor Command Interface ......
           33

     3.4  FUNCTIONS MAINTAINED BY OTHER PACKAGES ....
       35

   4  PACKAGE DESIGN ................................
     36

     4.1  PACKAGE OVERVIEW ..........................
       36
       4.1.1  Functional Specifications .............
         36
         4.1.1.1  Storage of Messages ...............
           38
         4.1.1.2  On-Line Retrieval .................
           38
         4.1.1.3  Off-Line Retrieval ................
           38
         4.1.1.4  Dump ..............................
           39
         4.1.1.5  Perform Supervisor Commands .......
           39



       4.1.2  Software Structure ....................
         40
       4.1.3  Data Flow and Control Logic ...........
         42
         4.1.3.1  Package Control Data Elements .....
           42
         4.1.3.2  Data Flow Logic ...................
           46

       4.1.4  Common Data Elements (Internal) .......
         48
         4.1.4.1  On-Line Catalogue .................
           48
         4.1.4.2  Off-Line Catalogue ................
           51
         4.1.4.3  Volume Table ......................
           53

       4.1.5  External Data Elements ................
         56
         4.1.5.1  Storage Keys During Storage .......
           56
         4.1.5.2  Retrieval keys During Retrieval ...
           56
         4.1.5.3  Return Data After a Retrieval .....
           56
           4.1.5.3.1  Return Code ...................
             57
           4.1.5.3.2  Catalogue Information .........
             57

         4.1.5.4  Supervisor Command Data ...........
           57
           4.1.5.4.1  Volume File Entry .............
             57
           4.1.5.4.2  Volume File Entry .............
             57

         4.1.5.5  Printer Data Elements .............
           57

       4.1.6  Interfaces ............................
         57
         4.1.6.1  External Interfaces ...............
           57
         4.1.6.2  Package Interfaces ................
           58
           4.1.6.2.1  SAR/TEP Interface .............
             58
           4.1.6.2.2  SAR/MDP Interface .............
             59
           4.1.6.2.3  SAR/THP Interface .............
             59
           4.1.6.2.4  SAR/LOG Interface .............
             59

         4.1.6.3  Sub-Package Interfaces ............
           60
           4.1.6.3.1  Storage Sub-Package Interfaces 
             60
           4.1.6.3.2  On-Line Retrieval Sub-Package
                      Interfaces ....................
                       60
           4.1.6.3.3  Off-Line Retrieval Sub-Package
                      Interfaces ....................
                       60
           4.1.6.3.4  Dump Sub-Package Interfaces ...
             61
           4.1.6.3.5  Supervisor Command Sub-Package
                      Interfaces ....................
                       61


       4.2.1  On-Line Storage Specification..........
         67
         4.2.1.1  Functional Specification ..........
           67
           4.2.1.1.1  Reception of Storage Requests .
             69
           4.2.1.1.2  Retrieval Key Pick-Up .........
             69
           4.2.1.1.3  Emptying Collect Area .........
             69
           4.2.1.1.4  Update On-Line Catalogue ......
             70
           4.2.1.1.5  Complete Storage ..............
             70

         4.2.1.2  Sub-Package Software Structure ....
           70
         4.2.1.3  Data Flow and Control Logic .......
           73
         4.2.1.4  Sub-Package Data ..................
           79
           4.2.1.4.1  Control Area ..................
             79
           4.2.1.4.2  Data Area .....................
             79

         4.2.1.5  Sub-Package Interfaces ............
           81
         4.2.1.6  Sub-Package Initialization ........
           81

       4.2.2  On-Line Retrieval Specifications ......
         81
         4.2.2.1  Functional Specificaion ...........
           81
           4.2.2.1.1  Receive Retrieval Requests ....
             83
           4.2.2.1.2  On-Line/Off-Line Retrieval
                      Separation ....................
                       83
           4.2.2.1.3  On-Line/Catalogue Consult .....
             84
           4.2.2.1.4  Access Check ..................
             86
           4.2.2.1.5  Retrieval of CIF ..............
             86
           4.2.2.1.6  Delivery of Retrieval Result ..
             87

         4.2.2.2  On-Line Retrieval Software
                  Structure .........................
                   87
         4.2.2.3  Data Flow and Control Logic .......
           89
         4.2.2.4  Sub-Package Data ..................
           92
         4.2.2.5  Sub-Package Interfaces ............
           93
         4.2.2.6  On-Line Retrieval Initialization ..
           93

       4.2.3  Off-Line Retrieval Specifications .....
         94
         4.2.3.1  Functional Specification ..........
           94
           4.2.3.1.1  Activate Off-Line Retrieval ...
             96
           4.2.3.1.2  Off-Line Volume Determination .
             96
           4.2.3.1.3  Test of Mounted Volume ........
             96
           4.2.3.1.4  Volume Mount ..................
             97
           4.2.3.1.5  Off-Line Catalogue Consult ....
             97
           4.2.3.1.6  Access Check ..................
             97
           4.2.3.1.7  Retrieve CIF ..................
             97
           4.2.3.1.8  Delivery of Retrieval Result ..
             98
             4.2.3.1.8.1  Volume Mount Refusal ......
               98


             4.2.3.1.8.2  Access Check Failure ......
               98
             4.2.3.1.8.3  CIF Not Found .............
               99
             4.2.3.1.8.4  CIF Found .................
               99

         4.2.3.2  Software Structure ................
           99
         4.2.3.3  Data Flow and Control Logic .......
          101
           4.2.3.3.1  Control Elements ..............
            101
           4.2.3.3.2  Control Logic .................
            101

         4.2.3.4  Sub-Package Data ..................
          104
         4.2.3.5  Sub-Package Interfaces ............
          104
           4.2.3.5.1  Off-Line-Count ................
            104
           4.2.3.5.2  Off-Line-Disk-Lock ............
            104
           4.2.3.5.3  Lock-Table ....................
            104
           4.2.3.5.4  Off-Line-Retrieval-Susp. ......
            105

         4.2.3.6  Sub-Package Initialization ........
          105

       4.2.4  Dump Specifications ...................
        105
         4.2.4.1  Functional Specification ..........
          105
           4.2.4.1.1  Receive Dump Requests .........
            107
           4.2.4.1.2  Check Mounted Volume ..........
            107
           4.2.4.1.3  Volume Mount Procedure ........
            107
           4.2.4.1.4  Dump Procedure ................
            108

         4.2.4.2  Software Structure ................
          108
         4.2.4.3  Data Flow and Control Logic .......
          110
           4.2.4.3.1  MMS Main Control ..............
            110
           4.2.4.3.2  TEP Main Control ..............
            110
           4.2.4.3.3  Dump Control...................
            110
             4.2.4.3.3.1  Perform Dump on Usual
                          Volume Control ............
                    113
             4.2.4.3.3.2  Perform Dump on New 
                          Volume Control ............
                      117

         4.2.4.4  Sub-Package Data ..................
          118
         4.2.4.5  Sub-Package Interfaces ............
          118
           4.2.4.5.1  Off-Line-Disk-Lock ............
            118
           4.2.4.5.2  Lock-Table ....................
            118
           4.2.4.5.3  Lock-Cat ......................
            118

       4.2.5  Supervisor Command Specifications .....
        118
         4.2.5.1  Functional Specification ..........
          118
           4.2.5.1.1  Receive and Detect Command ....
            122
           4.2.5.1.2  Off-Line Retrieval Off ........
            122
           4.2.5.1.3  Off-Line Retrieval On .........
            122
           4.2.5.1.4  Off-Line Retrieval Suspended ..
            122


           4.2.5.1.5  Request Volume Table Entry ....
            122
           4.2.5.1.6  Request Volume Table Contents .
            123
           4.2.5.1.7  Delete Volume Table Entry .....
            123
           4.2.5.1.8  Start-Up Command ..............
            123
           4.2.5.1.9  Close Down Command ............
            123

         4.2.5.2  Software Structure ................
          124
         4.2.5.3  Data Flow and Control Logic .......
          126
           4.2.5.3.1  Main Module Control Logic .....
            126
           4.2.5.3.2  Command Control Logic .........
            128
             4.2.5.3.2.1  Off-Line Retrieval Off
                          Control Logic .............
                          128
             4.2.5.3.2.2  Off-Line Retrieval On
                          Control Logic .............
                          128
             4.2.5.3.2.3  Off-Line Retrieval Susp.
                          Control Logic .............
                          128
             4.2.5.3.2.4  Volume Table Entry Control
                          Logic .....................
                          128
             4.2.5.3.2.5  Volume Table Contents
                          Control Logic .............
                          128
             4.2.5.3.2.6  Delete Volume Entry
                          Control Logic .............
                          128
             4.2.5.3.2.7  Start-Up Command Control
                          Logic .....................
                          129
             4.2.5.3.2.8  Close-Down Command Control
                          Logic .....................
                          129

         4.2.5.4  Sub-Package Data ..................
          138
         4.2.5.5  Sub-Package Interfaces ............
          138
           4.2.5.5.1  Lock-Table Interface ..........
            139
           4.2.5.5.2  Off-Line-Retrieval-Susp.
                      Control Logic .................
                      139
           4.2.5.5.3  Off-Line-Retrieval-On/Off
                      Control Logic .................
                      139

     4.3  MEMORY LAYOUT .............................
      139
       4.3.1  Program Area ..........................
        139
       4.3.2  Main Memory Data Area .................
        140
       4.3.3  On-Line Disk Data Area ................
        140
       4.3.4  Off-Line Disk Data Area ...............
        140




   APPENDIX A .......................................
    144

     A.1  SPECIFIC STORAGE AND RETRIEVAL KEYS .......
      144
       A.1.1  Incoming Message After Analysis .......
        144
       A.1.2  Incoming Message After Selection
              of Nominal Distribution List ..........
              144
       A.1.3  First Draft ...........................
        145
       A.1.4  Comments ..............................
        145
       A.1.5  Release Notification ..................
        145
       A.1.6  Released Messages .....................
        145
       A.1.7  Released Messages after Assignment of
              Transaction Keys ......................
            146
       A.1.8  Log Items .............................
        146


                        1̲ ̲ ̲G̲E̲N̲E̲R̲A̲L̲



1.1      P̲U̲R̲P̲O̲S̲E̲ ̲A̲N̲D̲ ̲S̲C̲O̲P̲E̲

         The Package Specification for Storage and Retrieval
         Package (SAR) CPS/SDS/007 is written to fulfil the
         following objectives:

         1)  To provide detailed definition of the package function
             and software architecture.

         2)  To provide user operational and development personnel
             details of the ongoing analysis.

         3)  To define in detail the interfaces with other packages
             and to describe their facilities.

         The specification contains a description of the package
         to a level of a few software statements as lowest detail.

         Higher level design specification can be found in the
         document system design listed in the next section,
         applicable documents.

         All interfaces and data are described in this specification
         and contained in the software Interface Control Document
         and Database Design Document respectively.



1.2      A̲P̲P̲L̲I̲C̲A̲B̲L̲E̲ ̲D̲O̲C̲U̲M̲E̲N̲T̲S̲ ̲A̲N̲D̲ ̲P̲R̲O̲J̲E̲C̲T̲ ̲R̲E̲F̲E̲R̲E̲N̲C̲E̲S̲



1.2.1    A̲p̲p̲l̲i̲c̲a̲b̲l̲e̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲s̲

         The following documents represent a baseline for this
         specification:

         -   CPS/210/SYS/0001
             CAMPS System Requirements

         -   CPS/SDS/001
             CAMPS System Design Specification


1.2.2    P̲r̲o̲j̲e̲c̲t̲ ̲R̲e̲f̲e̲r̲e̲n̲c̲e̲s̲

         Reference documents are as follows:

         -   CPS/230/ICD/0001
             User Procedures and Associated Formats

         -   CPS/230/ICD/002
             Supervisor Commands and Procedures



1.3      T̲E̲R̲M̲S̲ ̲A̲N̲D̲ ̲A̲B̲B̲R̲E̲V̲I̲A̲T̲I̲O̲N̲S̲



1.3.1    T̲e̲r̲m̲s̲

         Dump:             Transferring messages and transactions
                           from on-line disk to off-line disk.

         Off-Line Disk:    Disk volume used for storage of messages
                           and transactions.

         Item:             Messages and transactions stored
                           and retrieved by SAR.

         Cross Office
         Delay:            Time from the creation of a message
                           to the departure from the site or
                           time of reception on the site until
                           presentation on terminal position.

         Interleaving:     Interruption at ordinary SAR functions
                           i.e. on-line storage, on-line retrieval,
                           off-line retrieval, dump and supervisor
                           commands.





1.3.2    A̲b̲b̲r̲e̲v̲i̲a̲t̲i̲o̲n̲s̲

         ISQ               Incoming Storage Queue
         RRQ               Retrieval request Queue
         FIFO              First In First Out
         SFM               Storage and File Management Package
         QEL               Queue Element
         OROF              Off-Line Retrieval Off
         ORON              Off-Line Retrieval On
         ORSU              Off-Line Retrieval Suspended
         VOCL              Volume Control List
         VOIL              Volume Identification List
         VONM              Volume Naming
         VODL              Volume Deletion
         SCQ               Supervisor Command Queue
         MAQ               Mount Acknowledge Queue
         DCQ               Dump Command Queue
         CIF               CAMPS Information Field
         ISTOQ             Incoming Storage Time-Out Queue
         APP               Application
         TD                Terminal Designator
         RC5               Return Code 5
         PD                Preliminary Design
         SP.PD             Sub-Package Preliminary Design
         MMS               Message Management System
         IS                Intermediate Storage





                2̲ ̲ ̲S̲U̲M̲M̲A̲R̲Y̲ ̲O̲F̲ ̲R̲E̲Q̲U̲I̲R̲E̲M̲E̲N̲T̲S̲



         This chapter includes the requirements pertinent to
         SAR at package level.



2.1      P̲A̲C̲K̲A̲G̲E̲ ̲D̲E̲S̲C̲R̲I̲P̲T̲I̲O̲N̲



2.1.1    G̲e̲n̲e̲r̲a̲l̲ ̲C̲o̲n̲c̲e̲p̲t̲

         SAR provides functional capabilities for on-line storage
         of all incoming and outgoing messages in an intermediate
         storage (up to a few days depending on traffic and
         assigned disk space and allowed fill rate). After that,
         the CIFs are kept for a period of at least 30 days
         on offline disk volumes (long term storage).

         SAR supports retrieval of CIFS from the intermediate
         storage within a specified time limit.

         Retrieving off-line is possible within a time limit
         to be specified measured from when off-line volume
         is mounted. The functions carried out by SAR are then:

         -   Retrieve on-line
         -   Store on-line
         -   Store off-line
         -   Retrieve off-line



2.1.1.1  O̲n̲-̲L̲i̲n̲e̲ ̲S̲t̲o̲r̲a̲g̲e̲

         The on-line CIFs handled by SAR are on-line resident
         for at least 24 hours.  On-line storage is characterized
         by the fact that no mounting of physical media is required
         to retrieve the CIF. Actual time span for on-line storage
         is in the order of days.





2.1.1.2  O̲f̲f̲-̲L̲i̲n̲e̲ ̲S̲t̲o̲r̲a̲g̲e̲

         An off-line storage process is carried out by dumping
         CIF to an off-line volume, when they have been on-line
         resident for at least 24 hours.  Off-line storage may
         require, that a media must be loaded prior to retrieval.



2.1.1.3  S̲u̲b̲j̲e̲c̲t̲ ̲t̲o̲ ̲S̲t̲o̲r̲a̲g̲e̲

         Data for storage and retrieval are operational and
         service messages except for the categories: security
         classification CTS, special handling ATOMAL and any
         encrypted message. Further data messages are stored
         only for reruns.  The CIFs for on-line storage are
         as follows:  

         First draft, Released messages, Incoming analysed +
         possible corrected messages, Release notifications
         and Comment submitted.



2.1.1.4  S̲t̲o̲r̲a̲g̲e̲ ̲a̲n̲d̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲ ̲K̲e̲y̲s̲

         The CIFs for storage are catalogued under a combination
         of the keys: TOC (time of occurrence), TOC window,
         DTG (release), ORIG. HQ., ITEM REF ID, CHANNEL ID,
         CHANNEL SERIAL NUMBER, STATION ID, STATION SERIAL NUMBER,
         FILE TIME, SICs. Retrieval of the CIFs is achieved
         by combining the search keys depending on the category
         of CIF.



2.1.1.5  R̲e̲t̲r̲i̲e̲v̲a̲l̲

         Retrieval of stored CIF using a combination of the
         previous mentioned key can be achieved from both on-line
         or off-line storage media.





2.1.1.5.1    O̲n̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         The on-line disk contains the on-line CIFs which can
         be retrieved to a terminal position which has already
         gained knowledge of the CIF by either having prepared
         it or previously received. Exception is that the supervisor
         can retrieve all stored information.



2.1.1.5.2    O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         The off-line CIFs reside on a number of off-line volumes
         which are mounted when an off-line retrieval process
         is in progress.



2.2      P̲A̲C̲K̲A̲G̲E̲ ̲F̲U̲N̲C̲T̲I̲O̲N̲S̲

         The next two sub-sections 2.2.1 and 2.2.2 contain a
         functional description under normal operations and
         special circumstances respectively.



2.2.1    M̲a̲i̲n̲ ̲F̲u̲n̲c̲t̲i̲o̲n̲s̲

         Main functions included in SAR are:

         -   on-line storage
         -   on-line retrieval
         -   off-line retrieval
         -   off-line storage (dump)



2.2.1.1  O̲n̲-̲L̲i̲n̲e̲ ̲S̲t̲o̲r̲a̲g̲e̲

         Storage on-line means storage on intermediate storage
         of CIFs which have completed processing. The five categories
         of items for storage are stored according to the events
         listed below:

         Incoming Messages.

         Storage after succesful passing analysis including
         possible correction by message service.



         Released Messages

         Storage when the positive release decision has been
         given by the releasing officer.

         First Draft

         Storage after completion of new message preparation
         format A.

         Comments

         Storage after completion of new comment preparation
         format G1.

         Release Notifications

         Storage after completion of the release decision

         Log CIFs

         Storage after completion of a log CIF, i.e. every 10
         minutes

         The packages responsible for the above mentioned actions
         initiate a storage process as described next.

         During step 1a-d, the application modules request SAR
         to initiate a storage process by queuing a request
         in the incoming storage queue (ISQ).  The on-line catalogue
         is updated for each storage process with a new entry
         (2) and upon this completion, SAR requests MMS to store
         the respective item by issuing a STORE ITEM command
         (3) with input parameter View Reference. Application
         is acknowledged of storage completion (4). The on-line
         storage process is depicted overleaf in figure 2.2.1.1-1.

















































                      Fig. 2.2.1.1-1


2.2.1.2  O̲f̲f̲-̲L̲i̲n̲e̲ ̲S̲t̲o̲r̲a̲g̲e̲ ̲(̲D̲u̲m̲p̲)̲

         The communication during an off-line dump is carried
         out as shown on figure 2.2.1.2-1. Incarnation is achieved
         by either MMS (1a) or Supervisor operator (2). MMS
         sends an intermediate storage warning to SAR. Supervisor
         (TEP) sends a perform dump command until time specified
         to SAR. The on-line catalogue is consulted to determine
         which CIFs to dump (3a) (3b) according to the TOC field
         in each CIF entry.  Dumping the CIFs are carried out
         sectionwise through the following sequence of actions:

         -   Dump CIF command for MMS (3c)
         -   Dump CIF completion code for SAR (3d)
         -   Update off-line catalogue (3e)
         -   Update on-line catalogue (3f)
         -   Clear item command for MMS (3g)

         Total completion of the dump process is acknowledged
         to TEP (supervisor) report printer (3h).










                     figure 2.2.1.2-1




2.2.1.3  R̲e̲t̲r̲i̲e̲v̲a̲l̲

         Refer figure 2.2.1.3-1.

         Retrieval of the previously stored information takes
         place from either on-line volume or off-line by placing
         a retrieve command in the retrieve request queue (RRQ)
         of SAR, which then returns one out of three things
         to the requesting application.

         a)  A view ref. referencing the retrieved CIF

         b)  Completion code telling the reason for improper
             completion

         c)  Catalogue information for display



2.2.1.3.1    O̲n̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         a)  R̲e̲t̲u̲r̲n̲i̲n̲g̲ ̲a̲ ̲V̲i̲e̲w̲ ̲R̲e̲f̲.̲

             After reception and detection of an on-line retrieval
             command (1a), the on-line catalogue is consulted
             to determine the CIF-id and view-id corresponding
             to the retrieval key parameters (1b).  A RETRIEVE
             CIF command with CIF-id and view-id as input parameter
             is delivered to MMS (1c).  MMS returns a view ref.
             referencing the generated temporary CIF (1d) which
             is handled further on by SAR to requestor after
             security and access check (1e).

         b)  R̲e̲t̲r̲i̲e̲v̲a̲l̲ ̲C̲o̲m̲p̲l̲e̲t̲i̲o̲n̲ ̲C̲o̲d̲e̲s̲

             Improper completion of a retrieval procedure can
             be caused by:

             -   Not found referenced CIF

             -   Retrieval intermediately impossible

             Completion code is returned through step 1e.

         c)  C̲a̲t̲a̲l̲o̲g̲u̲e̲ ̲D̲i̲s̲p̲l̲a̲y̲

             In case that a catalogue display is required the
             on-line catalogue is consulted. The entries fulfilling
             the retrieval key parameters are returned through
             step 1e.



2.2.1.3.2    O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         According to the TOC retrieval parameter an off-line
         retrieval process is initiated. This is serviced at
         a lower priority level than on-line retrieval and will
         result in three different actions.

         a)  O̲r̲d̲i̲n̲a̲r̲y̲ ̲O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

             Ordinary off-line retrieval is carried out by requesting
             the supervisor to mount a specified  volume (2a).
             Determination of volume is done by consulting a
             table containing information about time intervals
             on off-line volumes. As for off-line storage a
             completion code is returned (2b) telling whether
             the volume is mounted or cannot intermediately
             be mounted.

             When mounted MMS is asked to open the off-line
             volumes directory and CIF area by the command GET
             MMS CATALOGUE (2c).  SAR consults the directory
             for determination of view-ref of wanted CIF (2d).
              A RETRIEVE CIF command is handed by SAR to MMS
             (2e), which returns the previously mentioned view
             ref. (2f).  This again is passed to the calling
             application via its delivery queue (2g) by SAR.

         b)  O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲ ̲C̲o̲m̲p̲l̲e̲t̲i̲o̲n̲ ̲C̲o̲d̲e̲s̲

             If the off-line volume cannot intermediately be
             mounted, the application is acknowledged by a completion
             code in its delivery queue (2h).

             This completion code can as well tell that referenced
             CIF not found or off-line retrieval intermediately
             impossible. The need for a reduction in time interval,
             because interval covers 2 volumes, is also acknowledge
             back via completion codes.

         c)  O̲f̲f̲-̲L̲i̲n̲e̲ ̲C̲a̲t̲a̲l̲o̲g̲u̲e̲ ̲D̲i̲s̲p̲l̲a̲y̲

             As for on-line retrieval the catalogue entries
             corresponding to the retrieval search keys are
             returned (2g).







                     Figure 2.2.1.3-1



2.2.2    F̲u̲n̲c̲t̲i̲o̲n̲a̲l̲ ̲R̲e̲s̲p̲o̲n̲s̲i̲b̲i̲l̲i̲t̲i̲e̲s̲

         Functional responsibilities included in the storage
         and retrieval package are specified in the next paragraphs.



2.2.2.1  I̲n̲i̲t̲i̲a̲l̲i̲z̲a̲t̲i̲o̲n̲,̲ ̲C̲l̲o̲s̲e̲ ̲D̲o̲w̲n̲,̲ ̲a̲n̲d̲ ̲R̲e̲s̲t̲a̲r̲t̲



2.2.2.1.1    I̲n̲i̲t̲i̲a̲l̲i̲z̲a̲t̲i̲o̲n̲

         Initialization procedure performs the initiation of
         main memory collect area catalogue files, semaphores
         and status information.

         Main memory is initiated by loading the control area
         with initial values. The three locations shall be loaded:

         PRI ̲AREA:       pri ̲area start address
         DTG ̲AREA:       dtg ̲area start address
         no ̲of-PRI ̲ENT   0

         On-line catalogue files are created during initialization.
         The TOC ̲FILE ̲ON locations in information area are all
         set to 0, except for TOC start time which is set upon
         first storage.

         Off-Line catalogue files are created and initiated
         when dump is incarnated. Volume table is initialized
         as an empty table with no entries.

         The following semaphores are initiated:

         -   lock ̲cat to neutral stage
         -   off-line ̲disk ̲lock to neutral stage
         -   lock ̲table to neutral stage
         -   off-line ̲retrieval ̲susp to neutral stage

         Status information is initiated as follows:

         -   off-line ̲retrieval ̲on/off is reset to the value
             on
         -   off-line ̲count to 0



         Further the filling rate of intermediate storage is
         set by the MMS command SET INTERMEDIATE STORAGE THRESHOLD.



2.2.2.1.2    C̲l̲o̲s̲e̲-̲D̲o̲w̲n̲

         Close-down of SAR is performed this way. SAR will operate
         normally until close-down command from SSC is received.
         Detailed close-down action is described in 4.2.5.1.9.



2.2.2.1.3    R̲e̲s̲t̲a̲r̲t̲

         Start-up command from SSC causes SAR to take the following
         actions. Checkpointed ISQ is re-established so all
         pending storage requests are queued again. Main memory
         control area is initialized as described under initialization.
         Semaphore and status information is set to the values
         as contained in the initialization section.



2.2.2.2  C̲h̲e̲c̲k̲p̲o̲i̲n̲t̲i̲n̲g̲ ̲a̲n̲d̲ ̲R̲e̲c̲o̲v̲e̲r̲y̲



2.2.2.2.1    C̲h̲e̲c̲k̲p̲o̲i̲n̲t̲i̲n̲g̲

         Storage requests for SAR are checkpointed i.e. ISQ
         QELs are checkpointed at their arrival to queue and
         released when storage procedure has terminated.



2.2.2.2.2    R̲e̲c̲o̲v̲e̲r̲y̲

         Recovery of SAR is requested by SSC. SSC specifies
         which kind of recovery to be performed. Recovery actions
         performed are described in CPS/SDS/001 figure 5.10.1.2.1.3-1.





2.2.2.3  E̲r̲r̲o̲r̲ ̲D̲e̲t̲e̲c̲t̲i̲o̲n̲ ̲a̲n̲d̲ ̲E̲r̲r̲o̲r̲ ̲H̲a̲n̲d̲l̲i̲n̲g̲



2.2.2.3.1    E̲r̲r̲o̲r̲ ̲D̲e̲t̲e̲c̲t̲i̲o̲n̲

         Errors detected by SAR are of the following types:

         -   Errors in storage keys during storage of messages
             and transactions

         -   Error code received during CSF section dump

         -   QMON delivery error

         -   Software errors



2.2.2.3.2    E̲r̲r̲o̲r̲ ̲H̲a̲n̲d̲l̲i̲n̲g̲

         The previous mentioned detected errors (refer 2.2.2.3.1)
         are handled in the following way, described in the
         same order as they are detected.

         -   Storage request and retrieval keys are delivered
             to SSC error queue.

         -   Error handling, caused by failure in volume name
             in CSF section dump command is to complete dump
             as normal with a report to supervisors report printer.
             Refer to 4.2.4.4 for details.

         -   Failure in delivery of CIF via QMON (security access
             failure) will have the effect that delivery of
             CIF is cancelled.

         -   Detection of a software error cause SAR to report
             this to SSC. Subsequent reply acknowledge SAR what
             to do. Following actions may be taken depending
             of answer:

             -   initialization subsequent to a switch-over

             -   continuing in dummy mode





2.2.2.4  I̲n̲t̲e̲g̲r̲i̲t̲y̲ ̲o̲f̲ ̲O̲p̲e̲r̲a̲t̲i̲o̲n̲

         Input parameters are checked for max. length. This
         is performed to prevent access of other main memory
         areas as the allowed ones, during collection of retrieval
         key. During catalogue update, boundary and syntax check
         is performed to ensure integrity of catalogues.



2.2.2.5  D̲a̲t̲a̲ ̲C̲o̲l̲l̲e̲c̲t̲i̲o̲n̲

         SAR performs data collection of the storage keys used
         as entries in the catalogues. The storage request QEL
         contains a reference to the CIF where the actual key
         are fetched from.



2.2.2.6  S̲e̲c̲u̲r̲i̲t̲y̲

         SAR security is related to the retrieval function.
         The classification check of delivered classification
         against CIF classification is performed by SAR. Failure
         in security validation results in not found completion
         code returned to requestor.

         During catalogue search entries are filtered according
         to classification delivered by the request. Entries
         fulfilling retrieval key search are appended to a CIF.
         CIF is sent with classification corresponding to highest
         classification of the appended entries.



2.3      C̲H̲A̲R̲A̲C̲T̲E̲R̲I̲S̲T̲I̲C̲S̲



2.3.1    T̲i̲m̲i̲n̲g̲





2.3.1.1  R̲e̲s̲p̲o̲n̲s̲e̲ ̲T̲i̲m̲e̲ ̲t̲o̲ ̲Q̲u̲e̲r̲i̲e̲s̲

         Response time for TEP requesting storage of first draft,
         released messages, new comments and release notifications
         is less than 100 msec. TOC is returned during these
         storage procedures.

         Retrieval response time is for return of on-line/off-line
         indicator:

         -   100 msec for TOC/TOC-window retrieval

         -   4 sec (maybe up to 30 sec) for DTG retrieval.

         For TOC/TOC-window, this response time consits of the
         following components:

         -   SAR reception of request                 20msec

         -   MMS transfer of volume table to main
             memory                                   50msec

         -   SAR consultation of volume table
             and until QEL send                       30msec

         For DTG retrieval, this response time
         consists of the following components:

         -   SAR reception at request                 50msec

         -   MMS transfer of volume table to
             main memory max.                         28 sec

         -   SAR consultation of volume table
             and until QEL send                       1,5 sec

         Return of on-line retrieval results:

         -   General: less than 30 sec

             SAR max                                  20 sec

             MMS                                      1 sec



         -   TOC-window search: 30 sec + 1 min. per busy hour
             traffic scan

         -   Pending requests: time as specified above + time
             to complete other requests.

         Return of off-line retrieval results:

         -   General: less than 4 min.

         -   Pending requests: time as specified above + time
             to complete other retrievals, on-line or off-line.



2.3.1.2  R̲e̲s̲p̲o̲n̲s̲e̲ ̲T̲i̲m̲e̲ ̲t̲o̲ ̲D̲u̲m̲p̲

         Response time from intermediate threshold is exceeded
         or the supervisor initiation of dump to dump completed
         consists of following components:

         -   SAR detection of request, 
             MMS or supervisor, until
             possible disk mount request              50 m sec

         -   physical disk mount                      10 min

         -   check of mounted volume                   5 m sec

         -   section dump SAR part                   100 m sec
                          MMS part                    11 sec

         -   complete SAR and MMS
             dump, 24 hour traffic, max               45 min

         -   terminate dump                          100 m sec



2.3.1.3  P̲r̲i̲o̲r̲i̲t̲i̲e̲s̲ ̲R̲e̲l̲a̲t̲e̲d̲ ̲t̲o̲ ̲I̲n̲p̲u̲t̲

         Storage requests are serviced independently of other
         SAR operations in a FIFO manner.

         Retrieval Request



         On-line retrieval requests are treated with higher
         priority than off-line retrieval requests. On-line
         requests are serviced as FIFO.

         Off-line retrievals are serviced FIFO. Dump and off-line
         retrievals are serviced in the order in which requests
         are issued.



2.3.1.4  T̲r̲a̲f̲f̲i̲c̲ ̲L̲o̲a̲d̲

         Traffic load related to each of the sub-packages are:

         S̲t̲o̲r̲a̲g̲e̲

         Main memory data size:                    3k words
         CPU time one storage:                     2 m sec
         I/Os:                                     2 per storage

         O̲n̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         On-line catalogue size per day:              1 mega
                                                   byte
         CPU time per retrieval:                    100 m sec
         I/Os per per retrieval max:                 10

         O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲

         Off-line catalogue size per day:             1 mega
                                                   byte
         CPU time per retrieval:                    300 m sec
         I/Os per retrieval max:                     20

         D̲u̲m̲p̲

         CPU time per dump:                           5 min
         I/Os per dump:                              10

         S̲u̲p̲e̲r̲v̲i̲s̲o̲r̲ ̲C̲o̲m̲m̲a̲n̲d̲

         CPU time per command max:                    2 m sec
         I/Os per command max:                        1

         Max. numbers of CIFs dumped covering a 24 hours period
         are 4500 messages and transactions.





2.3.1.5  I̲n̲t̲e̲r̲l̲e̲a̲v̲i̲n̲g̲ ̲S̲A̲R̲

         Interleaving storage has no effect as storage queue
         is checkpointed and fully recovered.

         On-line or off-line retrievals pending and ongoing
         are cancelled if SAR is interleaved.

         Interleaving dump will have the effect that last section
         procedure in progress shall be re-initiated.

         Interleaving supervisor commands cause the command
         to be re-incarnated.

2.3.2    T̲h̲r̲o̲u̲g̲h̲p̲u̲t̲

         The throughput of storage requests is in the order
         of 50 per busy minute traffic load.



2.3.3    F̲l̲e̲x̲i̲b̲i̲l̲i̲t̲y̲

         The requirements and limitations upon introducing new
         storage key and types are:

         A new record description shall be included. The length
         shall be limited to two entries of length 42 bytes
         each.



2.3.4    A̲c̲c̲u̲r̲a̲c̲y̲ ̲o̲f̲ ̲I̲n̲p̲u̲t̲ ̲D̲a̲t̲a̲

         Input data delivered in conjunction with an on-line
         storage are validated. Each retrieval key parameter
         is checked for boundaries in case of integer. Character
         strings are checked for syntax and length.





                      3̲ ̲ ̲E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲



3.1      E̲Q̲U̲I̲P̲M̲E̲N̲T̲ ̲E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲

         The Storage and Retrieval Package is fully on-line
         resident in CAMPS processing units. One process includes
         all SAR functions.

         Main memory data area size is 3 k words.

         On-line disk catalogue area size is 1 mega byte.

         Off-line disk catalogue area size per volume is 8 mega
         bytes.

         Detailed memory layout can be found in 4.3.



3.2      S̲O̲F̲T̲W̲A̲R̲E̲ ̲E̲N̲V̲I̲R̲O̲N̲M̲E̲N̲T̲



3.2.1    S̲y̲s̲t̲e̲m̲ ̲S̲o̲f̲t̲w̲a̲r̲e̲

         SAR's system software environment consists of the following
         components:

         -   DAMOS
         -   CAMPS System Function
         -   Message Management System
         -   Storage and File Management



3.2.2    D̲e̲v̲e̲l̲o̲p̲m̲e̲n̲t̲ ̲S̲o̲f̲t̲w̲a̲r̲e̲

         Development software is standard DAMOS and TOS (Terminal
         Operating System) resident in a single CR80D configuration.





3.3      I̲N̲T̲E̲R̲F̲A̲C̲E̲S̲



3.3.1    E̲x̲t̲e̲r̲n̲a̲l̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲s̲

         Not applicable to SAR.



3.3.2    P̲a̲c̲k̲a̲g̲e̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲s̲

         Package interfaces are described next according to
         function performed by SAR. Detailed description of
         interface can be found in paragraph 4. Figure 3.3.2-1
         shows the interface overview diagram. Numbers refer
         to sub-sections below.



3.3.2.1  S̲t̲o̲r̲a̲g̲e̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲

         Applications contributing with storage keys during
         storage of message and transactions are:

         -   traffic handling package (THP)
         -   terminal package (TEP)
         -   message distribution package (MDP)

         Further log issues storage requests for storage of
         log CIFs, so 4th contributer:

         -   log package (LOG)



3.3.2.2  O̲n̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲

         During on-line retrieval terminal package (TEP) issues
         retrieval requests and receive the retrieval result.





3.3.2.3  O̲f̲f̲-̲L̲i̲n̲e̲ ̲R̲e̲t̲r̲i̲e̲v̲a̲l̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲

         TEP issues off-line retrieval requests and receive
         the result again. In between a possible disk mount
         communicaton has taken place. During this, SAR sends
         mount request to TEP's report printer. Upon mount completion
         or mount refuse, SAR is acknowledged by TEP.



3.3.2.4  D̲u̲m̲p̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲

         The dump interface is to MMS CSF and TEP. MMS and TEP
         initiate the dump procedure automatically or manually
         respectively. During section dump communication to
         MMS is achieved. CSF interface (time-out function)
         is active during disk mount. A disk mount communication
         to TEP may be carried out, as described under off-line
         retrieval.

         TEP receives the dump completed report for the report
         printer when dump is terminated.


3.3.2.5  S̲u̲p̲e̲r̲v̲i̲s̲o̲r̲ ̲C̲o̲m̲m̲a̲n̲d̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲

         Supervisor commands are received from TEP. A possible
         answer is returned to TEP. SSC start-up and close-down
         information is interchanged too via this interface.











                      Figure 3.3.2-1



3.4      F̲U̲N̲C̲T̲I̲O̲N̲S̲ ̲M̲A̲I̲N̲T̲A̲I̲N̲E̲D̲ ̲B̲Y̲ ̲O̲T̲H̲E̲R̲ ̲P̲A̲C̲K̲A̲G̲E̲S̲

         The following functions are maintained by other packages
         than SAR.

         -   Security classification check by QMON upon delivery
             of retrieved CIF

         -   Checkpointing of storage requests by CSF

         -   Recovery functions by SSC upon restart

         -   Report collection or error report by SSC

         -   Error handling by SSC