top - download
⟦7ff25a30f⟧ Wang Wps File
Length: 23475 (0x5bb3)
Types: Wang Wps File
Notes: CMS/AUX/001
Names: »4426A «
Derivation
└─⟦e9ca1be93⟧ Bits:30006183 8" Wang WCS floppy, CR 0382A
└─ ⟦this⟧ »4426A «
WangText
…07……00……00……00……00…E…0a……00……00…E…0b…E D…86…1 …02… …02… …02…
…02…CMS/AUX/001
…02… 840927…02……02…#
SOFTWARE MAINTENANCE USERS MANUAL
GUIDELINES…02…Issue 1…02…CAMPS
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲
1 INTRODUCTION ............................... 4
1.1 APPLICABLE DOCUMENTS ................... 4
2 STRUCTURE OF THE SOFTWARE MAINTENANCE USERS
MANUAL ..................................... 5
3 VOLUME 1 OF THE SOFTWARE MAINTENANCE USERS
MANUAL ..................................... 6
3.1 OUTLINE FOR VOLUME 1 OF THE MANUAL ..... 6
3.2 STRUCTURE OF VOLUME 1 OF THE MANUAL .... 9
3.3 GUIDELINES FOR THE CHAPTERS OF VOLUME 1
OF THE MANUAL .......................... 9
3.3.1 Chapter 1 of the SMUM (General) .... 9
3.3.2 Chapter 2 of the SMUM
(Introduction of the Document) ..... 9
3.3.3 Chapter 3 of the SMUM (ISSC Overview) 9
3.3.4 Chapter 4 of the SMUM
(CAMPS System Description) ......... 10
3.3.5 Chapter 5 of the SMUM
(Configuration Management) ......... 10
3.3.6 Chapter 6 of the SMUM
(CAMPS Software Design Principles) . 10
3.3.7 Chapter 7 of the SMUM
(Security Design) .................. 11
3.3.8 Chapter 8 of the SMUM (CAMPS
Software Coding, Test and Package
Integration) ....................... 12
3.3.9 Chapter 9 of the SMUM
(CAMPS Software Error Correction) .. 12
3.3.10 Chapter 10 of the SMUM
(Man/Machine Interface Correction).. 12
3.3.11 Chapter 11 of the SMUM
(Firmware Corrections) ............. 13
3.3.12 Chapter 12 of the SMUM
(System Integration) ............... 13
3.3.13 Chapter 13 of the SMUM
(System Testing) ................... 13
3.3.14 Chapter 14 of the SMUM
(Software Debugging) ............... 14
3.3.15 Chapter 15 of the SMUM
(Software Extensions) .............. 14
3.3.16 Chapter 16 of the SMUM
(Software Installation at Sites) ... 14
3.3.17 Annexes of the SMUM ................ 14
4 SOFTWARE PACKAGES VOLUMES ................... 15
4.1 SPMV TABLE OF CONTENTS OUTLINE ......... 15
4.2 STRUCTURE OF THE SPMV .................. 17
4.3 GUIDELINES FOR THE CHAPTERS OF THE SPMV 17
4.3.1 Chapter 1 of the SPMV (General) .... 17
4.3.2 Chapter 2 of the SPMV
Configuration Log) ................. 17
4.3.3 Chapter 3 of the SPMV
(Package Configuration Disk) ....... 18
4.3.4 Chapter 4 of the SPMV
(Prefixes and Data Files) .......... 18
4.3.5 Chapter 5 of the SPMV
(Package/Subpackage Procedure Calls) 18
4.3.6 Chapter 6 of the SPMV
(Package Integration Disk) ......... 19
4.3.7 Chapter 7-N of the SPMV
(Package Maintenance Information) .. 19
4.2.8 Annex A (Package Integration
Procedures) ........................ 19
1̲ ̲ ̲I̲N̲T̲R̲O̲D̲U̲C̲T̲I̲O̲N̲
a) Three manuals shall be delivered to the ACE I̲ntegrated
S̲ystem S̲upport C̲entre (ISSC):
1) Database Users, Maintenance and Generation
Manual
2) Software Maintenance Users Manual
3) System Generation Users Manual
b) The Database Users, Maintenance and Generation
Manual shall contain a description of the CAMPS
database, how it is maintained and how a new/changed
database is generated.
c) The Software Maintenance Users Manual shall describe
how to debug/extend/modify the CAMPS Software/CAMPS
Software Packages.
d) The System Generation Users Manual shall describe
how to generate a CAMPS System given a new/changed
database and/or a new/changed Software Package(s).
e) This note presents the general guidelines to be
fulfilled by the Software Maintenance Users Manual.
1.1 A̲P̲P̲L̲I̲C̲A̲B̲L̲E̲ ̲D̲O̲C̲U̲M̲E̲N̲T̲S̲
1) Document Layout Standard SD/STD/002
2) Configuration Change Control Standard SD/STD/003.
2̲ ̲ ̲S̲T̲R̲U̲C̲T̲U̲R̲E̲ ̲O̲F̲ ̲T̲H̲E̲ ̲S̲O̲F̲T̲W̲A̲R̲E̲ ̲M̲A̲I̲N̲T̲E̲N̲A̲N̲C̲E̲ ̲U̲S̲E̲R̲S̲ ̲M̲A̲N̲U̲A̲L̲
a) The Software Maintenance Users Manual consists
of several volumes.
b) Volume 1 is the superior volume, containing all
the general information and references, and serves
as a key document for the rest of the volumes.
c) The remaining volumes each represent a Software
Package and contain all information pertinent to
the package described.
3 V̲O̲L̲U̲M̲E̲ ̲I̲ ̲O̲F̲ ̲T̲H̲E̲ ̲S̲O̲F̲T̲W̲A̲R̲E̲ ̲M̲A̲I̲N̲T̲E̲N̲A̲N̲C̲E̲ ̲M̲A̲N̲U̲A̲L̲
This chapter contains the guidelines for volume 1 of
the Software Maintenance Manual.
3.1 O̲U̲T̲L̲I̲N̲E̲ ̲F̲O̲R̲ ̲V̲O̲L̲U̲M̲E̲ ̲I̲ ̲O̲F̲ ̲T̲H̲E̲ ̲M̲A̲N̲U̲A̲L̲
The table of contents presented may be expanded into
subsections (max. index level is 6).
S̲O̲F̲T̲W̲A̲R̲E̲ ̲M̲A̲I̲N̲T̲E̲N̲A̲N̲C̲E̲ ̲U̲S̲E̲R̲S̲ ̲M̲A̲N̲U̲A̲L̲ ̲V̲O̲L̲U̲M̲E̲ ̲I̲
…01…T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲O̲U̲T̲L̲I̲N̲E̲
1 GENERAL
1.1 PURPOSE AND SCOPE
1.2 APPLICABLE DOCUMENTS AND PROJECT REFERENCES
1.2.1 Applicable Documents
1.2.2 Rererence Documents
1.3 TERMS AND ABBREVIATIONS
1.3.1 Terms
1.3.2 Abbreviations
2 INTRODUCTION TO THE DOCUMENT
3 ISSC OVERVIEW
3.1 CAMPS DEVELOPMENT SYSTEM OVERVIEW
3.2 CAMPS REFERENCE SYSTEM OVERVIEW
3.3 CAMPS TEST DRIVE SYSTEM OVERVIEW
4 CAMPS SYSTEM DESCRIPTION
4.1 CAMPS HARDWARE OVERVIEW
4.2 CAMPS SOFTWARE OVERVIEW
5 CONFIGURATION MANAGEMENT
6 CAMPS SOFTWARE DESIGN PRINCIPLES
6.1 CAMPS SYSTEM SOFTWARE
6.2 CAMPS APPLICATION SOFTWARE
6.3 CAMPS APPLICATION SOFTWARE INTERCOMMUNICATION
6.4 CAMPS APPLICATION SOFTWARE DATABASE ACCESS
7 SECURITY DESIGN
8 CAMPS SOFTWARE CODING, TEST AND PACKAGE INTEGRATION
8.1 CODING PRINCIPLES
8.2 TEST PRINCIPLES
8.3 PACKAGE INTEGRATION PRINCIPLES
9 CAMPS SOFTWARE ERROR CORRECTIONS
9.1 PROBLEM REPORTS
9.2 SOFTWARE UPDATING
9.3 SOFTWARE TESTING
9.4 SOFTWARE RELEASE
10 MAN/MACHINE INTERFACE CORRECTIONS
10.1 PRINTER MMI
10.2 VDU MMI
10.3 OPERATOR MMI
11 FIRMWARE CORRECTIONS
11.1 LTU FIRMWARE
11.2 LTUX FIRMWARE
12 SYSTEM INTEGRATION
12.1 INTEGRATION PRINCIPLES
12.2 INTEGRATION TOOLS
12.3 MESSAGE FLOW VERIFICATION
13 SYSTEM TESTING
14 SOFTWARE DEBUGGING
14.1 INFORMATION NEEDED TO REPRODUCE A FAULT
14.2 HOW TO REPRODUCE A REPORTED FAULT
14.3 ERROR CLASSIFICATION
14.4 DEBUGGING TOOLS
14.5 CAMPS SYSTEM SOFTWARE ERRORS
14.6 CAMPS APPLICATION SOFTWARE ERRORS
15 SOFTWARE EXTENSIONS
15.1 ADDING A NEW PROCESS
15.2 ADDING A NEW COROUTINE
15.3 ADDING A NEW MODULE
16 SOFTWARE INSTALLATION AT SITES
Annex A CAMPS System Software Error Reports
Annex B CAMPS Application Software Error Reports
Annex C QEL/App SW Matrices
Annex D QEL - Request/Reply Interrelations
Annex E CAMPS System Software/DAMOS Proc. Matrices
Annex F CAMPS App. SW/Camps System SW Matrices
Annex G CAMPS System SW/Completion Code Matrices
Annex H Configuration Management Procedures
3.2 S̲T̲R̲U̲C̲T̲U̲R̲E̲ ̲O̲F̲ ̲V̲O̲L̲U̲M̲E̲ ̲I̲ ̲O̲F̲ ̲T̲H̲E̲ ̲M̲A̲N̲U̲A̲L̲
a) The Software Maintenance Users Manual SMUM has
been divided into sixteen chapters and eight Annexes.
The objectives for each chapter and each Annex
are presented in section 3.3.
b) If information already contained in other CAMPS
documents are called for in section 3.3 the kind
of information shall be described in the SMUM section
together with a reference to the document, where
the detailed information is contained.
3.3 G̲U̲I̲D̲E̲L̲I̲N̲E̲S̲ ̲F̲O̲R̲ ̲T̲H̲E̲ ̲C̲H̲A̲P̲T̲E̲R̲S̲ ̲O̲F̲ ̲V̲O̲L̲U̲M̲E̲ ̲I̲ ̲O̲F̲ ̲T̲H̲E̲ ̲M̲A̲N̲U̲A̲L̲
3.3.1 C̲h̲a̲p̲t̲e̲r̲ ̲1̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲G̲e̲n̲e̲r̲a̲l̲)̲
Chapter 1 shall contain a presentation (purpose and
scope) of the manual, identify applicable documents
and reference documents and define terms/abbreviations
used within the manual.
3.3.2 C̲h̲a̲p̲t̲e̲r̲ ̲2̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲I̲n̲t̲r̲o̲d̲u̲c̲t̲i̲o̲n̲ ̲t̲o̲ ̲t̲h̲e̲ ̲D̲o̲c̲u̲m̲e̲n̲t̲)̲
Chapter 2 shall contain an introduction to the manual
describing how the information, the manual contains
are orgainzed and giving guidelines for how to use
the manual to the maintenance personnel.
3.3.3 C̲h̲a̲p̲t̲e̲r̲ ̲3̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲I̲S̲S̲C̲ ̲O̲v̲e̲r̲v̲i̲e̲w̲)̲
Chapter 3 shall contain an overview of the ISSC site,
thereby identifying the three subsystems: the CAMPS
Development System, the CAMPS Reference System, and
the CAMPS Test Drive System, of which it is composed.
a) Section 3.1 shall contain an overview of the CAMPS
Development System, state its purpose, i.e. identify
the tasks which can be performed by it and reference
the related documents.
b) Section 3.2 shall contain information as described
for section 3.1, but for the CAMPS Reference System.
c) Section 3.3 shall contain information as described
for section 3.1, but for the CAMPS Test Drive System.
3.3.4 C̲h̲a̲p̲t̲e̲r̲ ̲4̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲C̲A̲M̲P̲S̲ ̲S̲y̲s̲t̲e̲m̲ ̲D̲e̲s̲c̲r̲i̲p̲t̲i̲o̲n̲)̲
Chapter 4 shall contain a presentation of the CAMPS
System and its functional capabilities. The presentation
shall be on an overview level and contain references
to the CAMPS System Description Manual and the Requirement
Specification Document for CAMPS.
a) Section 4.1 shall contain an overview of the CAMPS
hardware. It shall contain a figure and a description
of the hardware sufficient for the maintenance
personnel to understand the addressed hardware
modules of section 4.2.
b) Section 4.2 shall contain an overview of the CAMPS
Software. Section 6.2 of the CAMPS System Description
Manual shall be used as a baseline, however, all
packages shall be identified within this section.
3.3.5 C̲h̲a̲p̲t̲e̲r̲ ̲5̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲C̲o̲n̲f̲i̲g̲u̲r̲a̲t̲i̲o̲n̲ ̲M̲a̲n̲a̲g̲e̲m̲e̲n̲t̲)̲
Chapter 5 shall present the configuration Management
Control imposed on CAMPS. The presentation shall mainly
be in form of flow overviews with proper references
to Annex H.
3.3.6 C̲h̲a̲p̲t̲e̲r̲ ̲6̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲C̲A̲M̲P̲S̲ ̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲D̲e̲s̲i̲g̲n̲ ̲P̲r̲i̲n̲c̲i̲p̲l̲e̲s̲)̲
Chapter 6 shall describe the software design principles
used on CAMPS. The overall objective of this chapter
shall be to state all the principles used especially
to avoid software errors, so the maintenance personnel
will know where to look for software errors or rather
where not to look for them.
a) Section 6.1 shall describe the design principles
for the CAMPS System Software (i.e. the system
Software developed by the CAMPS TEAM). The principles
for application software interfaces shall be comprehensively
addressed. Reference to ICD/009.
b) Section 6.2 shall describe the Design Principles
for the CAMPS Application Software.
c) Section 6.3 shall describe how application software
packages interfaces, e.g. the use of queues and
queue elements shall be fully described and so
shall the monitor procedures of the LOG and STP
packages. Reference to ICD/009. Interfaces through
database variables shall not be described in this
section.
d) Section 6.4 shall describe the Application Software
access to the database. It shall be highlighted
that even though TMP controls all access to tables
and variables in the database, each application
package has its own responsibilities with respect
to updating. Reference to DBD/001.
3.3.7 C̲h̲a̲p̲t̲e̲r̲ ̲7̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲e̲c̲u̲r̲i̲t̲y̲ ̲D̲e̲s̲i̲g̲n̲)̲
Section 7 shall describe in detail all the security
features imbedded in CAMPS.
The section shall at least include an overview of the
security features and architecture, and a description/
identification of the interfaces which are security
sensitive and must be controlled.
3.3.8 C̲h̲a̲p̲t̲e̲r̲ ̲8̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲C̲A̲M̲P̲S̲ ̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲C̲o̲d̲i̲n̲g̲,̲ ̲T̲e̲s̲t̲
̲a̲n̲d̲ P̲a̲c̲k̲a̲g̲e̲ ̲I̲n̲t̲e̲g̲r̲a̲t̲i̲o̲n̲)̲
Chapter 8 shall contain a description of the CAMPS
Software Coding, Test and Package Integration principles.
The Standards addressing these subjects shall be referenced.
a) Section 8.1 shall contain a description of the
coding principles. The differences between system
and application software shall be mentioned, and
the use of prefix files shall be fully described.
Use of export and import declarations shall be
related to the global variable/local variable procedure/Component
procedure Concepts from the design documents.
b) Section 8.2 shall contain a description of the
test principles used on CAMPS both for system and
application software. The concept of module test
shall be described. It shall be described under
which circumstances other test strategies than
the standardized (bottom up) have been used. And
these strategies shall be fully described. The
use of test stubs by application software shall
be addressed.
c) Section 8.3 shall contain a description of the
package test, state its purpose, and the principles
imposed.
3.3.9 C̲h̲a̲p̲t̲e̲r̲ ̲9̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲C̲A̲M̲P̲S̲ ̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲E̲r̲r̲o̲r̲ ̲C̲o̲r̲r̲e̲c̲t̲i̲o̲n̲s̲)̲
Chapter 9 shall contain a description of how to correct
a software error, when it has been identified to a
module, identifying all CAMPS procedures to be followed
and all development/test programs to be used.
3.3.10 C̲h̲a̲p̲t̲e̲r̲ ̲1̲0̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲M̲a̲n̲/̲M̲a̲c̲h̲i̲n̲e̲ ̲I̲n̲t̲e̲r̲f̲a̲c̲e̲ C̲o̲r̲r̲e̲c̲t̲i̲o̲n̲s̲)̲
Chapter 10 shall contain a description of how to perform
Man/Machine I/F corrections.
a) Section 10.1 shall contain a description of how
to change/correct printer formats. Format Generation
and MMI tables shall be addressed, and references
to the applicable documents shall be given.
b) Section 10.2 shall contain a description of how
to change/correct MMI for VDUs. Command tables,
sequence tables, Format generation, FCP generation,
Syntax procedures, display procedures and semantic
procedures shall be addressed, and references to
the applicable documents shall be given.
c) Section 10.3 shall contain a description of how
to change/correct MMI for the operator.
3.3.11 C̲h̲a̲p̲t̲e̲r̲ ̲1̲1̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲F̲i̲r̲m̲w̲a̲r̲e̲ ̲C̲o̲r̲r̲e̲c̲t̲i̲o̲n̲s̲)̲
Chapter 11 shall contain a description of how to perform
firmware corrections.
a) Section 11.1 shall comprehensivly address how to
correct/modify the LTU Software.
b) Section 11.2 shall Comprehensivly address how to
correct/modify the LTUX firmware.
3.3.12 C̲h̲a̲p̲t̲e̲r̲ ̲1̲2̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲y̲s̲t̲e̲m̲ ̲I̲n̲t̲e̲g̲r̲a̲t̲i̲o̲n̲)̲
Chapter 12 shall contain a description of the System
Integration principles, describe/reference the integration
tools available and specify how a Message Flow verification
may be performed.
3.3.13 C̲h̲a̲p̲t̲e̲r̲ ̲1̲3̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲y̲s̲t̲e̲m̲ ̲T̲e̲s̲t̲i̲n̲g̲)̲
Chapter 13 shall contain a description of system testing
after system integration, e.g. load testing using the
Test Drive System.
3.3.14 C̲h̲a̲p̲t̲e̲r̲ ̲1̲4̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲D̲e̲b̲u̲g̲g̲i̲n̲g̲)̲
Chapter 14 shall contain a description of how to reproduce
a reported error on the CAMPS Reference System and
present the different strategies for isolating the
error to a single package/module.
a) Section 14.1 shall describe the information necessary
to reproduce a discovered fault. The description
shall be in form of a guidance of the kind of information
needed and detailed enough to form the baseline
for construction of a Site Error Report Form.
b) Section 14.2 shall describe how a reported error
may be reproduced at the CSSI. In cases where this
is not straight forward various methods establishing
the same conditions as on the faulty site shall
be mentioned, e.g. getting an exact copy of the
DB from the faulty site, use of log trace information
from the faulty site to regenerate same System
Load.
c) Section 14.3 shall define the error categories
to which an error may belong, e.g. database error,
system data error, Application Software error,
etc. The ways of classifying an error to belong
to a specific category shall be described, references
to the relevant annexes of this manual, to the
DAMOS documentation shall be made. How to classify
an error by means of the VCD and the Requirement
Specification shall be described.
d) Section 14.4 shall identify the debugging tools
available and describe the use of these.
e) Section 14.5 shall describe how to isolate an error
in the CAMPS System Software.
f) Section 14.6 shall describe how to isolate an error
in the CAMPS Application Software.
3.3.15 C̲h̲a̲p̲t̲e̲r̲ ̲1̲5̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲E̲x̲t̲e̲n̲s̲i̲o̲n̲s̲)̲
Chapter 15 shall in detail address all aspects of adding
of new software to CAMPS.
3.3.16 C̲h̲a̲p̲t̲e̲r̲ ̲1̲6̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲ ̲(̲S̲o̲f̲t̲w̲a̲r̲e̲ ̲I̲n̲s̲t̲a̲l̲l̲a̲t̲i̲o̲n̲ ̲a̲t̲ ̲S̲i̲t̲e̲s̲)̲
Chapter 16 shall describe how modified / corrected
/ extended software may be distributed to sites. The
circumstances at which software may be delivered on
floppy and how the actual installation is performed
on the site shall be described. The cases in which
a new system generation disk must be delivered shall
be defined as well.
3.3.17 A̲n̲n̲e̲x̲e̲s̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲M̲U̲M̲
a) Annex A shall contain a full list of the System
Error Reports/Completion Codes.
b) Annex B shall contain a list of CAMPS Application
Software error reports.
c) Annex C shall identify the relation between QEL
Maintype-Subtype and Application SW with QEL Maintype-Subtype
as key.
d) Annex D shall identify request/reply QEL relations,
i.e. the reply for each request defined in ICD/009
shall be identified.
e) Annex E shall identify for each CAMPS System Software
Package the DAMOS procedures/interfaces utilized
on a Package level as well as on a module/procedure
level.
f) Annex F shall identify for each CAMPS Application
package the CAMPS System Software procedures/ interfaces
utilized on a Packabe level/Subpackage level as
well as on a module/procedure level.
g) Annex G shall for each CAMPS System Software Application
Software interface state the possible completion
codes.
h) Annex H shall contain a description of all the
Configuration Management Control procedures imposed
on the CAMPS project.
4̲ ̲ ̲S̲O̲F̲T̲W̲A̲R̲E̲ ̲P̲A̲C̲K̲A̲G̲E̲ ̲V̲O̲L̲U̲M̲E̲S̲
Each CAMPS Software Package shall be represented in
the SMUM by a separate volume.
This chapter presents the general guidelines to be
fulfilled by all Software Package Maintenance Volumes
(SPMV).
4.1 S̲P̲M̲V̲ ̲T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲O̲U̲T̲L̲I̲N̲E̲
The table of content presented in this section may
be further expanded into subsections (max. index level
is 6).
The sections listed are mandatory for all SPMV. Sections
which do not apply to a package shall contain a N/A
(not applicable).
If any information, not contained in the current documentation
(CPS/SDS), is needed to maintain (correct/modify/extend)
a package further chapters shall be added, which contain
this information.
S̲O̲F̲T̲W̲A̲R̲E̲ ̲M̲A̲I̲N̲T̲E̲N̲A̲N̲C̲E̲ ̲U̲S̲E̲R̲S̲ ̲M̲A̲N̲U̲A̲L̲
S̲O̲F̲T̲W̲A̲R̲E̲ ̲P̲A̲C̲K̲A̲G̲E̲ ̲V̲O̲L̲U̲M̲E̲S̲
T̲A̲B̲L̲E̲ ̲O̲F̲ ̲C̲O̲N̲T̲E̲N̲T̲S̲ ̲O̲U̲T̲L̲I̲N̲E̲
1 GENERAL
1.1 PURPOSE AND SCOPE
1.2 APPLICABLE DOCUMENTS AND CONFIGURATION DISKS
1.3 TERMS AND ABBREVIATIONS
1.3.1 Terms
1.3.2 Abbreviations
2 CONFIGURATION LOG
2.x PACKAGE LOG
2.y SUBPACKAGE LOG
3 PACKAGE CONFIGURATION DISK
3.1 CONTENTS AND DIRECTORY STRUCTURE
3.2 JOBFILES
4 PREFIXES AND DATA FILES
4.1 CPS PREFIX FILES
4.2 CPS DATA FILES
4.3 PACKAGE/SUBPACKAGE PREFIX FILES
4.4 PACKAGE/SUBPACKAGE DATA FILES
5 PACKAGE/SUBPACKAGE PROCEDURE CALLS
5.1 COMMON PACKAGE PROCEDURE CALL FORMS
5.x COMMON SUBPACKAGE PROCEDURE CALL FORMS
6 PACKAGE INTEGRATION DISK
6.1 CONTENTS AND DIRECTORY STRUCTURE
6.2 JOBFILES
N PACKAGE MAINTENANCE INFORMATION
ANNEX A PACKAGE INTEGRATION PROCEDURS
4.2 S̲T̲R̲U̲C̲T̲U̲R̲E̲ ̲O̲F̲ ̲T̲H̲E̲ ̲S̲P̲M̲V̲
The SPMV has been divided into six chapters and one
Annex common to all packages. Further chapters shall
be added as chapter 7 to N.
4.3 G̲U̲I̲D̲E̲L̲I̲N̲E̲S̲ ̲F̲O̲R̲ ̲T̲H̲E̲ ̲C̲H̲A̲P̲T̲E̲R̲S̲ ̲O̲F̲ ̲T̲H̲E̲ ̲S̲P̲M̲V̲
4.3.1 C̲h̲a̲p̲t̲e̲r̲ ̲1̲ ̲o̲g̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲G̲e̲n̲e̲r̲a̲l̲)̲
a) Section 1.1 shall describe the purpose of the volume
using the following as a guide:
1) To provide information of the physical location
of software units.
2) To provide information necessary to maintain
the XXX Package.
b) Section 1.2 shall identify all documents describing
the Package Design and all Disks containing software
pertinent to the package.
1) Section 1.2.1 shall include the following documents:
- CPS/SDS/001
- CPS/SDS/xxx
- CPS/ICD/009
- CPS/DBD/001
2) Section 1.2.2 shall include the identification
of the following disks:
- Package Configuration Disk
- Package Integration Disk
4.3.2 C̲h̲a̲p̲t̲e̲r̲ ̲2̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲C̲o̲n̲f̲i̲g̲u̲r̲a̲t̲i̲o̲n̲ ̲L̲o̲g̲)̲
Chapter 2 shall contain the Configuration Log as delivered
to Configuration Management, i.e the release/version
number shall be present.
a) Section 2.x shall contain the Package Log. If a
package has been further subdivided into subpackages,
which each conceptually is thought of as a package
itself, a section 2.x, 2.x.y shall exist for each
such subpackage.
b) Section 2.x.y shall contain the subpackage log.
4.3.3 C̲h̲a̲p̲t̲e̲r̲ ̲3̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲P̲a̲c̲k̲a̲g̲e̲ ̲C̲o̲n̲f̲i̲g̲u̲r̲a̲t̲i̲o̲n̲ ̲D̲i̲s̲k̲)̲
Chapter 3 shall describe the Package Configuration
Disk.
a) Section 3.1 shall identify the contents of the
disk and Directory Structure for the Package Directory.
If doc. CPS/AUX/023 has been strictly followed
a reference to this document together with a figure
as the one presented in CPS/AUX/023 will be sufficient.
b) Section 3.2 shall identify all the jobfiles of
the Package Directory, what they do and how they
are executed (i.e. from which directory shall they
be invoked etc.)
If CPS/AUX/023 has been strictly used a reference
to this document will be sufficient.
4.3.4 C̲h̲a̲p̲t̲e̲r̲ ̲4̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲P̲r̲e̲f̲i̲x̲e̲s̲ ̲a̲n̲d̲ ̲D̲a̲t̲a̲ ̲F̲i̲l̲e̲s̲)̲
Chapter 4 shall for each module/procedure of the package
identify: The CAMPS Prefixes, the CAMPS DATA, Package
Prefixes and Data, the subpackage prefixes and data
utilized/used by the modules/procedures.
4.3.5 C̲h̲a̲p̲t̲e̲r̲ ̲5̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲P̲a̲c̲k̲a̲g̲e̲/̲S̲u̲b̲p̲a̲c̲k̲a̲g̲e̲ ̲P̲r̲o̲c̲e̲d̲u̲r̲e̲
C̲a̲l̲l̲s̲)̲
Chapter 5 shall for each Common Package Procedure and
for each Common Subpackage Procedure identify the Package/Subpackage
modules calling it.
4.3.6 C̲h̲a̲p̲t̲e̲r̲ ̲6̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲P̲a̲c̲k̲a̲g̲e̲ ̲I̲n̲t̲e̲g̲r̲a̲t̲i̲o̲n̲ ̲D̲i̲s̲k̲)̲
Chapter 6 shall contain a description of the Contents
of the Package Integration Disk.
a) Section 6.1 shall identify the contents and describe
the Directory Structure.
b) Section 6.2 shall identify the jobfiles, what they
do and how to execute them.
4.3.7 C̲h̲a̲p̲t̲e̲r̲ ̲7̲ ̲t̲o̲ ̲N̲ ̲o̲f̲ ̲t̲h̲e̲ ̲S̲P̲M̲V̲ ̲(̲P̲a̲c̲k̲a̲g̲e̲ ̲M̲a̲i̲n̲t̲e̲n̲a̲n̲c̲e̲ I̲n̲f̲o̲r̲m̲a̲t̲i̲o̲n̲)̲
These chapters shall contain all information pertinent
for the maintenance of the package, which are not described
in the previous chapters.
4.3.8 A̲n̲n̲e̲x̲ ̲A̲ ̲(̲P̲a̲c̲k̲a̲g̲e̲ ̲I̲n̲t̲e̲g̲r̲a̲t̲i̲o̲n̲ ̲P̲r̲o̲c̲e̲d̲u̲r̲e̲s̲)̲
Annex A shall contain the Package Integration Test
Procedures. If these are defined in files residing
on the integration disk, these files shall be referenced.
