Office of the Chief Information Officer
/ 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 ApplicationBuildBook 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.
Table of Contents
Overview
Application Dependencies
Application Component Location
Application Assembly/Compiling
Application Installation/Configuration
Application Start-up Procedures
Important Notes
Approvals
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 specifichardware (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
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 servicesby the Project Manager.
Note: Additional lines can be added if necessary. >
Application Component Name / Component Location Details
Source Code
Software Repository
Batch Files
Other (Provide description to the right)
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
Step# / Assembly Instructions / Application Component Name / Component Function/Description
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 Step# / Instructions
ApplicationStart-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 name / Notes
Important Notes
Description / Provide noteworthy information pertaining to any aspect of the Application build process. These notes will inform and assist those 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 1 of 6
Template Version 2.6, 2013-11-13 / High Sensitivity