Professional Documents
Culture Documents
Page 2
SYSTEM ADMINISTRATION MANUAL
REVISION HISTORY.............................................................................................................................................. 5
INTRODUCTION.................................................................................................................................................. 6
Introduction and Purpose..........................................................................................................................................6
Project References.....................................................................................................................................................6
Glossary......................................................................................................................................................................6
SYSTEM OVERVIEW............................................................................................................................................. 6
System Application.....................................................................................................................................................6
System Organization..................................................................................................................................................6
Information Inventory................................................................................................................................................6
Resource Inventory................................................................................................................................................6
Report Inventory...................................................................................................................................................7
Processing Overview..................................................................................................................................................7
Communications Overview........................................................................................................................................7
Security.......................................................................................................................................................................7
SITE PROFILE(S)................................................................................................................................................... 7
Site Location(s)...........................................................................................................................................................7
Primary Site................................................................................................................................................................7
SYSTEMS ADMINISTRATION................................................................................................................................ 7
User and Group Accounts..........................................................................................................................................7
Adding/Deleting Users..........................................................................................................................................8
Setting User Permissions.......................................................................................................................................8
Adding/Deleting User Groups...............................................................................................................................8
Setting User Roles/Responsibilities.......................................................................................................................8
Server Administration................................................................................................................................................8
Creating Directories..............................................................................................................................................8
Building Drive Mappings.......................................................................................................................................8
System Backup Procedures........................................................................................................................................8
Maintenance Schedule (Daily, Weekly)................................................................................................................8
Off-Site Storage Procedures..................................................................................................................................8
Maintaining Backup Log.......................................................................................................................................9
Printer Support...........................................................................................................................................................9
Maintenance.........................................................................................................................................................9
PRINT JOBS............................................................................................................................................................9
System Maintenance..................................................................................................................................................9
Monitoring Performance and System Activity......................................................................................................9
Installing Programs and Operating System Updates............................................................................................9
Maintaining Audit Records of System Operation.................................................................................................9
Maintenance Reports............................................................................................................................................9
Security Procedures...................................................................................................................................................9
Page 3
SYSTEM ADMINISTRATION MANUAL
Issuing IDs and Passwords..................................................................................................................................10
License Agreements............................................................................................................................................10
Network Maintenance.............................................................................................................................................10
LAN Design..........................................................................................................................................................10
Communications Equipment...............................................................................................................................10
Inventory Management...........................................................................................................................................10
Maintaining Hardware and Software Configurations........................................................................................10
Maintaining Floor Plans......................................................................................................................................10
Installing Software/Hardware (New, Upgrades)................................................................................................10
Maintaining Lists of Serial Numbers...................................................................................................................10
Maintain Property Inventory..............................................................................................................................11
Training Backup Administrator................................................................................................................................11
End-User Support - Procedures for Support and Contract Information..............................................................11
Escalation Procedures.........................................................................................................................................11
Documentation........................................................................................................................................................11
Troubleshooting Issues........................................................................................................................................11
Database Maintenance............................................................................................................................................11
Database User/Group Access.............................................................................................................................11
Adding/Deleting Users to Database...................................................................................................................11
Setting User Permissions for Database...............................................................................................................11
Adding/Deleting Groups for Database...............................................................................................................12
Re-indexing Database.........................................................................................................................................12
Packing/Compressing Database.........................................................................................................................12
Data Entry/Modification/ Deletion.....................................................................................................................12
Database Reporting............................................................................................................................................12
Database Backup and Restore............................................................................................................................12
Application Maintenance.........................................................................................................................................12
Application User/Group Access...........................................................................................................................12
Adding/Deleting Application users.....................................................................................................................12
Setting User Application Permissions..................................................................................................................12
Adding/Deleting Application Groups..................................................................................................................12
Procedures to Start and Stop the Application.....................................................................................................13
Application Flow Chart........................................................................................................................................13
Description of Major Program or Sub-program Modules...................................................................................13
Page 4
SYSTEM ADMINISTRATION MANUAL
REVISION HISTORY
REVISION NUMBER DATE COMMENT
1.0 August 14, 2007 Original DoIT PMO Document
Page 5
SYSTEM ADMINISTRATION MANUAL
INTRODUCTION
A System Administration Manual serves the purpose of an Operations Manual in distributed
(client/server) applications.
PROJECT REFERENCES
This section lists, at a minimum, the User Manual, Maintenance Manual, and other
pertinent available systems documentation.
GLOSSARY
This section lists all definitions or terms unique to this document or computer operation
and subject to interpretation by the user of this document.
SYSTEM OVERVIEW
SYSTEM APPLICATION
This section provides a brief description of the system, including its purpose and uses.
SYSTEM ORGANIZATION
This section describes the organization of the system by the use of a chart depicting
components and their interrelationships.
INFORMATION INVENTORY
This section provides information about data files, and the databases that are produced or
referenced by the system.
RESOURCE INVENTORY
This section lists all permanent tiles and databases that are referenced, created, or updated
by the system.
Page 6
SYSTEM ADMINISTRATION MANUAL
REPORT INVENTORY
This section lists all reports produced by the system, including each report name and the
software that generates it.
PROCESSING OVERVIEW
This section provides information that is applicable to the processing of the system. It
includes system restrictions, waivers of operational standards, and interfaces with other
systems.
COMMUNICATIONS OVERVIEW
This section describes the communications functions and process of the system.
SECURITY
This section describes the security considerations associated with the system.
SITE PROFILE(S)
This section contains information pertaining to the site(s) where the application is running.
That information includes the information contained in the subsequent sections.
SITE LOCATION(S)
This is the official address(es) of the site(s).
PRIMARY SITE
For the site(s) designated as primary, this section describes the essential personnel names
and phone numbers for the automated data processing site contacts.
SYSTEMS ADMINISTRATION
This section introduces the responsibilities of the System Administrator, as discussed in the
subsequent sections.
Page 7
SYSTEM ADMINISTRATION MANUAL
ADDING/DELETING USERS
This section describes procedures to create/delete user logins and password accounts.
SETTING USER PERMISSIONS
This section describes procedures to give users/restrict access to certain files.
ADDING/DELETING USER GROUPS
This section contains procedures to create/delete user groups.
SERVER ADMINISTRATION
This section describes procedures to setup servers, including naming conventions and
standards.
CREATING DIRECTORIES
This section describes procedures to create server directories, and a complete description
of the existing directories.
BUILDING DRIVE MAPPINGS
This section describes procedures to create server drive mappings, and a complete
description of the existing drive mappings.
Page 8
SYSTEM ADMINISTRATION MANUAL
PRINTER SUPPORT
This section discusses procedures for installing, operating, and maintaining printers.
MAINTENANCE
This section describes maintenance contracts, procedures to include installation and
configuration of printer drivers, and equipment information.
PRINT JOBS
This section describes procedures to monitor, delete, and prioritize print jobs.
SYSTEM MAINTENANCE
This section discusses procedures for maintaining the file system.
MONITORING PERFORMANCE AND SYSTEM ACTIVITY
This section contains procedures to monitor system usage, performance, and activity.
This may include descriptions of system monitoring tools, the hours of peak demand, a
list of system maintenance schedules, etc
INSTALLING PROGRAMS AND OPERATING SYSTEM UPDATES
This section includes procedures on how to install and test operating system updates.
Once tested, instructions are to be provided to move/install the operating system updates
to the operational environment
MAINTAINING AUDIT RECORDS OF SYSTEM OPERATION
This section describes procedures for the setup and monitoring of the operating system
and application audit trails.
MAINTENANCE REPORTS
This section includes procedures to create and update maintenance reports.
SECURITY PROCEDURES
This section describes the process for obtaining identifications (IDs) and passwords. It
includes information concerning network access and confidentiality requirements.
Page 9
SYSTEM ADMINISTRATION MANUAL
NETWORK MAINTENANCE
This section describes procedures to maintain and monitor the data communications
network.
LAN DESIGN
This section contains a layout of the network.
COMMUNICATIONS EQUIPMENT
This section contains a layout of the telecommunications equipment.
INVENTORY MANAGEMENT
This section contains a complete hardware and software inventory to include make, model,
version numbers, and serial numbers.
MAINTAINING HARDWARE AND SOFTWARE CONFIGURATIONS
This section describes procedures for maintaining the configuration information for the
hardware and software actually installed.
MAINTAINING FLOOR PLANS
This section describes procedures for maintaining floor plans showing the location of all
installed equipment and how to add/delete/modify the plans.
INSTALLING SOFTWARE/HARDWARE (NEW, UPGRADES)
This section describes procedures for installing new or upgrading hardware and software.
MAINTAINING LISTS OF SERIAL NUMBERS
This section describes procedures for maintaining all serial number lists required at the
site.
Page 10
SYSTEM ADMINISTRATION MANUAL
DOCUMENTATION
This section describes the documentation required of System Administrators as they
perform system administration.
TROUBLESHOOTING ISSUES
This section describes how to conduct and document troubleshooting activities.
DATABASE MAINTENANCE
This section introduces the responsibilities as they relate to the database and software
application maintenance.
DATABASE USER/GROUP ACCESS
Describe who provides database access and the procedures for granting access.
ADDING/DELETING USERS TO DATABASE
Provide the responsible person who adds and deletes users to the database. Include the
procedures for adding/deleting users.
SETTING USER PERMISSIONS FOR DATABASE
Provide the responsible person who sets the permissions for users on the database.
Page 11
SYSTEM ADMINISTRATION MANUAL
APPLICATION MAINTENANCE
APPLICATION USER/GROUP ACCESS
Describe who provides application access and the procedures for granting access.
ADDING/DELETING APPLICATION USERS
Provide the responsible person who adds and deletes users to the application. Include the
procedures for adding/deleting users.
SETTING USER APPLICATION PERMISSIONS
Provide the responsible person who sets the permissions for users of the application.
ADDING/DELETING APPLICATION GROUPS
Provide the procedures and responsible person for adding/deleting application groups.
Page 12
SYSTEM ADMINISTRATION MANUAL
Page 13