Sie sind auf Seite 1von 6

Government of Newfoundland and Labrador

Office of the Chief Information Officer

Application Build Book


Purpose: The Application Build Book will be used as an install and base configuration guide for
Applications. This guide will assist in creating and installing an application in the event that the application
were to fail and had to be rebuilt and installed from scratch.

Application Portfolio
Number

Project Name

Project Number << DTC Number >>

Project Sponsor

Project Manager

(name) (email) (phone number)

Project Description << Provide a short description of the project. >>

Important Notes for Completing this Document


Each section of the Application Build Book must be completed in full. If a particular section is not applicable
to this project, then you must write Not Applicable and provide a reason.
Important Note: No sections are to be deleted from this document. Text contained within << >> provides
information on how to complete that section and can be deleted once the section has been completed.

Application Build Book Page 1 of 6

Template Version 2.5, 2013-11-18 High Sensitivity


Government of Newfoundland and Labrador
Office of the Chief Information Officer

TABLE OF CONTENTS
OVERVIEW ............................................................................................................................................................. 3
APPLICATION DEPENDENCIES .......................................................................................................................... 4
APPLICATION COMPONENT LOCATION ............................................................................................................ 4
APPLICATION ASSEMBLY/COMPILING ............................................................................................................. 5
APPLICATION INSTALLATION/CONFIGURATION ............................................................................................. 5
APPLICATION START-UP PROCEDURES .......................................................................................................... 5
IMPORTANT NOTES .............................................................................................................................................. 5
APPROVALS ..............................................................................................ERROR! BOOKMARK NOT DEFINED.

Application Build Book Page 2 of 6

Template Version 2.6, 2013-11-13 High Sensitivity


Government of Newfoundland and Labrador
Office of the Chief Information Officer

OVERVIEW
Contact Information << A Chart of Authorities will be completed for each application/project.
The Chart of Authorities is the primary source for all authorization.

Important Note: Contact information can also be found in the Application


Portfolio for this application. The Application Portfolio Number can be found
on the title page of this document. >>

<< Identify the location and name of the Chart of Authorities in TRIM. >>

Infrastructure Prerequisites

Description << Identify specific hardware (server, ram etc.) and software (operating
system, tools to build the application, IIS, Tomcat etc.) requirements to build
the application.

Important Note: Information required for this section can be found in the
following sections of the Detailed Architecture Design (DAD) per project:
Technical Architecture and Solution Stack. It is not necessary to include
architectural diagrams, but simply provide a list of components.

Note: For further information on detailed server configurations see the TRIM
link for the Server Build Book below: >>

<< Identify the location and name of the Server Build Book via the TRIM
link. >>

Component Requirement

Hardware

RAM

Operating System

Disk Space

Other (Provide a description


in the column to the right)

Software

Web server

Application Build Book Page 3 of 6

Template Version 2.6, 2013-11-13 High Sensitivity


Government of Newfoundland and Labrador
Office of the Chief Information Officer

DBMS

Application Server

Other (Provide a description


in the column to the right)

APPLICATION DEPENDENCIES
Description << Provide documentation relating to any dependencies that may exist
within the application. These dependencies can include
integration/interfacing with other pre-existing applications (e.g. FMS) and
also dependencies on other software components (e.g. Crystal Reports
may be required for the application to run its report module). As well,
indicate version numbers of pre-existing applications in the description
fields below. >>

Dependency Description

Interface with <<appN>>

Integration with <<appN>>

Dependant on <<appN>>

APPLICATION COMPONENT LOCATION


Description << Provide detailed information regarding the location of the application
components (Ex: Source code, software repository, batch files etc.).

Important Note: This information may be obtained from application services


by the Project Manager.

Note: Additional lines can be added if necessary. >>

Application Component Component Location Details


Name

Source Code

Software Repository

Batch Files

Other (Provide description


to the right)

Application Build Book Page 4 of 6

Template Version 2.6, 2013-11-13 High Sensitivity


Government of Newfoundland and Labrador
Office of the Chief Information Officer

APPLICATION ASSEMBLY/COMPILING
Description << Detail the steps necessary to assemble and build/re-build the
application. When assembling, it is important to document the Order of
Operations in order for the application to run successfully. For example:
Application Code will need to be assembled and compiled first etc.

Important Note: When documenting these steps for application assembly,


provide as much detail as possible to assist those personnel who are not
familiar with the application. >>

Assembly Assembly Instructions Application Component


Component Name Function/Description
Step#

APPLICATION INSTALLATION/CONFIGURATION
Description << Provide detailed installation/configuration steps necessary for installing the
application. Include items such as DLL registration, shared library installation etc.
>>

Installation Instructions
Step#

APPLICATION START-UP PROCEDURES


Description << Detail the steps for starting the application, documenting the “order of
operations” that various application components/services must be started in
chronological order. >>

Start-up Procedure Application Component/Services Notes


name

IMPORTANT NOTES
Description << Provide noteworthy information pertaining to any aspect of the
Application build process. These notes will inform and assist those
Application Build Book Page 5 of 6

Template Version 2.6, 2013-11-13 High Sensitivity


Government of Newfoundland and Labrador
Office of the Chief Information Officer

personnel who are not familiar with the application during the build/re-build
phase. >>

Notes

PREPARED BY
<< Title>>

(Print name) (signature) (date)

REVIEWED BY
Project Manager

(Print name) (signature) (date)

Delivery Manager

(Print name) (signature) (date)

APPROVED BY
Application & Information
Management Services
Manager (Print name) (signature) (date)

Application Build Book Page 6 of 6

Template Version 2.6, 2013-11-13 High Sensitivity

Das könnte Ihnen auch gefallen