ELECTRONIC FLIGHT FOLDER WEB CAM BUILD AND INSTALLER DOCUMENT

convertingtownSoftware and s/w Development

Nov 4, 2013 (4 years and 4 days ago)

91 views


This document and the information contained herein are the proprietary data of
Optimization
Technologies, Inc.
. Neither this document, nor the information contained herein shall be
reproduced, used, or disclosed to

others without the express written consent of
Optimization
Technologies, Inc.
.


Copyright ® 2009
Optimization Tec
hnologies, Inc
.

All rights reserved
.







ELECTRONIC FLIGHT FOLDER WEB CAM

BUILD AND INSTALLER DOCUMENT


Document Number:
OT
-
EFF
-
SRD
-
GND

Supplier CAGE Code:
30GW7

Document Version:
Draft

















Optimization Technologies, Inc.

15236 NW Greenbrier Pkwy

Beaverton, Oregon 97006

503
-
690
-
4475

www.optechsw
.com









2


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

Notice Freedom of Information Act (5 USC 552) and Disclosure of Confidential Information Generally (18 USC 1905)

This document is being furnished in confidence by
Optimization Technologies, Inc
. The
information disclosed falls within exception
(b) (4) of 5 ISC 552 and provisions of 18 USC 1905.

Proprietary Notice

This document was prepared for the
Boeing Company

by
Opt
imization Technologies, Inc
. This document and the information
contained herein are the proprietary data of the
Boeing Company
. Neither this document, nor the information contained herein shall be
reproduced, used,

or disclosed to others without the express written consent of the
Boeing Company
.

Document Preparation

This document was prepared with Microsoft Word 2007 and is stored under the name


EFF Web CAM Build and Installer DRAFT.docx
.”


Version History

Revision

Changes

Date

Authority

Draft

Creation

1/20/2010

Bill Petersen

Released

2/16/2010


Added new installer steps (web services)

5/17/2010

Giang Phan




















3


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

Table

of Contents


1

Build Documentation

................................
................................
................................
...

4

1.1

System Requirements

................................
................................
............................

4

1.2

Development Environment

................................
................................
.....................

4

1.3

Internet Information Server
-

Virtual Web Site Configuration

................................
......

4

1.4

SQL Server Setup

................................
................................
................................
.

7

1.5

CAT Publish Parts Directory

................................
................................
....................

8

2

Electronic Flight Folder Web CAM Installation Documentation

................................
...........

9

2.1

Application Prerequisites

................................
................................
........................

9

2.2

Installer Instructions

................................
................................
.............................

9

2.3

EFF Web CAM Installer Log (OPTIONAL)

................................
................................
.

18

3

Add EFF Web CAM Module to CAT

................................
................................
...............

20

3.1

CAM Module Prerequisites

................................
................................
....................

20

3.2

Add Module Instructions

................................
................................
......................

20

3.3

Assign EFF Web CAM Module

................................
................................
................

22

3.4

Create User Profile and Assign Module to user.

................................
.......................

23

















4


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

1

Build Documentation


The following

documentation covers the
build and installation
details
for running
the
Electronic
Flight Folder Web CAM.

1.1

System Requirements

Minimum System Requirements for Target Deployment Server



Microsoft .NET 3.5 SP1



IIS
5.1, IIS 6.0



SQL Server 2005



EFB Configuration Administration Tool Version 5.2.0000.00011

1.2

Deve
lopment Environment


The following software toolset was used to create the EFF Web CAM.



Visual Studio 2008 SP1



Microsoft .NET 3.5 SP1



IIS 5.1



SQL Server 2008 (Target
SQL Server
Version 2005)



Microsoft Enterprise Library 4.1 October 2008

Release



EFB Configu
ration Administration Tool Version 5.2.0000.00011



The Apache Software Foundation Logging Framewor
k Version 1.2.10.0 (
log4net
DLL only)

1.3

I
nternet Information Server
-

Virtual Web Site

Configuration

The following

IIS

settings
are what the automated installer
sets in IIS when installing the
EFF
Web CAM Virtual web site.


Virtual Directory Alias

=

EFFWeb

Local Path


=

C:
\
inetpub
\
wwwroot
\
EFFWeb
\

Script source access


=

false

Read


=

true

Write


=

false

Directory Browsing


=

false

Log Visits


=

true

Index this resource


=

true

Application Name


=

EFF CAM


Execute Permissions


=

Scripts only

Application Protection


=

Medium



5


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

Default Document

=

default.aspx

Directory Security

=

system default

Set ASP.NET Runtime

=

version 2.0.50272


Note:


Setting t
he ASP.Net runtime
may or may not be required depending on how the IIS
server is
configured (v1.1 or 2.0). The aspnet_regiis.exe tool

is not be used to
register EFFWeb Virtual
Website with the correct .NET runtime
.

1.3.1

Web.
C
onfig

S
ettings

The following

settings in the Web.config file are mostly static
;

however the Installer does
dynamically set the DB connection string based on the
SQL Server Instance Name
captured during the installer.



<
appSettings
>


<
add

key
=
"
ApplicationTitle
"

value
=
"
Electronic

Flight Folder Web CAM
"

/>


<
add

key
=
"
ApplicationModuleName
"

value
=
"
Boeing Electronic Flight Folder
"

/>


<
add

key
=
"
ApplicationModuleVersion
"

value
=
"
0.0.5.1
"
/>


<
add

key
=
"
ApplicationModuleDescription
"

value
=
"
Boeing Electronic Flight Folder EFF Web
CAM Application
"
/>


<
add

key
=
"
ApplicationVersion
"

value
=
"
Version 0.0.5.1
"
/>


<
add

key
=
"
ApplicationPublishDate
"

value
=
"
1
-
11
-
2010
"

/>


<
add

key
=
"
EFFWebCamTempFiles
"

value
=
"
C:
\
TempEFFWebCamFiles
\
"
/>


<
add

key
=
"
EFFWebCamConfigFileName
"

value
=
"
Customer.ini
"
/>


</
appSettings
>


<
log4net
>


<
appender

name
=
"
RollingLogFileAppender
"

type
=
"
log4net.Appender.RollingFileAppender
"
>


<
file

value
=
"
log/EFFWebCam.log
"

/>


<
appendToFile

value
=
"
true
"

/>


<
maxSizeRollBackups

value
=
"
10
"

/>


<
maximumFileSize

value
=
"
100KB
"

/>


<
rollingStyle

value
=
"
Size
"

/>


<
staticLogFileName

value
=
"
true
"

/>


<
layout

type
=
"
log4net.Layout.PatternLayout
"
>


<
header

value
=
"
[Header]
&#xD;&#xA;
"

/>


<
footer

value
=
"
[Footer]
&#xD;&#xA;
"

/>


<
conversionPattern

value
=
"
%date [%thread] %
-
5level %logger
-

%message%newline
"

/>


</
layout
>


</
appender
>


<
appender

name
=
"
ErrorRollingLogFileAppender
"

type
=
"
log4net.Appender.RollingFileAppender
"
>


<
file

value
=
"
log/EFFWebCam_Error.log
"

/>


<
appendToFile

value
=
"
true
"

/>


<
maxSizeRollBackups

value
=
"
10
"

/>


<
maximumFileSize

value
=
"
100KB
"

/>


<
rollingStyle

value
=
"
Size
"

/>


<
staticLogFileName

value
=
"
true
"

/>


<
layout

type
=
"
log4net.Layout.PatternLayout
"
>


<
header

value
=
"
[Header]
&#xD;&#xA;
"

/>


<
footer

value
=
"
[Footer]
&#xD;&#xA;
"

/>


<
conversionPattern

value
=
"
%date [%thread] %
-
5level %logger
-

%message%newline
"

/>


</
layout
>


<
filter

type
=
"
log4net.Filter.LevelRangeFilter
"
>


<
levelMin

value
=
"
ERROR
"

/>


<
levelMax

value
=
"
FATAL
"

/>


</
filter
>


</
appender
>


<
root
>


<
level

value
=
"
ALL
"

/>


<
appender
-
ref

ref
=
"
RollingLogFileAppender
"
/>


<
appender
-
ref

ref
=
"
ErrorRollingLogFileAppender
"
/>


</
root
>


</
log4net
>


<
connectionStrings
>



6


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document


<
clear

/>


<
add

name
=
"
effDBConnectionString
"

connectionString
=
"
Data Source=
localhost
;Initial Catalog=effcam;Persist
Security Info=True;User ID=effcam_user;Password=sql
"

providerName
=
"
System.Data.SqlClient
"

/>


</
connectionStrings
>

1.3.2

effDBConnectionString S
QL Server connection string


The initial catalog, user name and password are static.
The installer
runs SQL scripts to
c
reate

the
EFF Web CAM
SQL credentials to match what is in the Web.Config file.
However, t
he Data Source

Name

is captured

as an installer parameter and is dynamically
set during installation
.





7


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

1.4

SQL Server Setup

The following
SQL
settings are what the automated installer sets
dur
ing installation
.


Database Name



=

effcam

Database User Name


=

effcam_user

Database Password



=

sql


Database Location (MDF/LDF)

=

C:
\
\
Program Files
\
\
Microsoft SQL Server
\
\



MSSQL10.MSSQLSERVER
\
\
MSSQL
\
\
DATA
\
\


Note:

Database directory
location for MDF/LDF files can
be overridden during installation.


Database Physical File Names

=

effcam.mdf







effcam_log.ldf


Installer
Drop
s

&

Create
s

Tables



tblAircraftMajorModel



tblAircraftSigEventRelation



tblAircraftSignatureEvents



tblCamSettings



tblLookupAltSummary



tblLookupAltSummary2



tblLookupETOPSSummary



tblLookupETOPSSummary2



tblLookupFPHeader



tblLookupFPHeader2



tblLookupFuelWeight



tblLookupFuelWeight2



tblLookupGroupCodes



tblLookupTimeSummaryC1



tblLookupTimeSummaryC1T2



tblLookupTimeSummaryC2



t
blLookupTimeSummaryC2T2



tblLookupWaypoint



tblLookupWaypoint2



tblTargetInfo



tblUserInfo


Installer
Drop
s

&

Create
s

Stored Procedures



spqFlightPlanCoreGroupSort



spqGetAltSummaryParameterList



spqGetETOPSSummaryParameterList



spqGetFPHeaderParameterList



spqGetFuelWeightParameterList



spqGetSignatureEventList



spqGetSignatureEventList2



spqGetSingleCamDocument



8


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document



spqGetSingleCamSetting



spqGetTimeSummaryParameterList



spqGetUserCamSettings



spqGetUserInformation



spqGetUserTargetInformation



spqGetWaypointDetailParam
eterList



spqSelectUserTargetInfo



sqdCamUserSettings



sqiCamUserSettings



sqiInsertUserTargetInfo



sqiUser



sqSelectUserTargetInfo



squCamUserSettings



squUser


Installer
Drop
s

&

Create
s

the following
User
Login



User name


=

effcam_user



Password


=

sql



Role

Privileges

=

db_owner


1.5

CAT Publish Parts Directory

The following physical directory is required on the EFF Web CAM hosting server. This directory
must be manually added
after

the install.

The following directory is hard coded in the Web.config
file. Howev
er, the

directory can manually be changed by updating the App.Setting
EFFWebCamConfigFileName Key in the Web.Config file

to a different directory
.


EFF Working Directory for Publishing LSAP Parts to CAT:
C:
\
TempEFFWebCamFiles
\


Note:

The directory
security should be set to allow the ASP.NET
process full read/write access to this directory.




















9


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

2

Electronic Flight Folder Web CAM Installation
Documentation

The following

documentation covers using the automated installer to successfully depl
oy the EFF
Web CAM to the hosting environment.


Note:


Repair / Remove Installer options are NON
-
functional.

The EFF
Web CAM installer must be removed before using the Control
Panel before attempting an EFF Web CAM reinstall.


2.1

Application Prerequisites



Microsoft .NET 3.5 SP1



IIS 5.1, IIS 6.0



SQL Server 2005



Installer requires ADMIN username/password to setup DB



EFB Configuration Administration Tool Version 5.2.0000.00011

2.2

Installer Instructions

1.

Login to target system and login as Administrator of that s
ystem

2.

Double click the MSI installer file (
EFFWebCamInstallerRelease.msi

)






10


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

3.

Click the NEXT button on the Welcome to the EFF CAM Setup Wizard screen.







11


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

4.

Collect the SQL Server Information on the next screen

and click the next button
.




Install
EFF Web CAM Database
Parameter
(s)

Usage Description

SQL Server Named Instance

This is the SQL Server instance that that the
installer is targeting. The SQL Server instance
name entered into this field is used to update
the Data Source portion of the EFF
Web CAM
database connection string.

Web.Config Example:

If you decide to leave LOCALHOST entry as
the default then your connection string would
look as follows:

<
add

name
=
"
effDBConnectionString
"

connectionString
=
"
Data Source=
localhost
;Initial
Catalog=effcam;Persist Security Info=True;User
ID=effcam_user;Password=sql
"

providerName
=
"
System.Data.SqlClient
"

/>

SQL Server Database Admin User

The SQL Server system admin user name. You
can use “SA”, the installer only uses the user
湡m攠e猠a m敡e猠瑯t捲敡瑥t瑨攠䑂ea湤 捲敡瑥t


12


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

all DB objects.

SQL
Server Database Admin Password

The SQL Server system admin password. You
can use the “SA password”, t
he installer only
uses the password as a means to authenticate
to the SQL Server instance for creating the DB
and creating all the database objects.

SQL Server Database Directory Location
for MSF/LDF files

This directory is used when creating the
EFFCAM
database. The physical location of the
MDF/LDF files.

Note: The directory MUST contain double
slashed “C:
\
\
” or the Installer will FAIL.


5.

Enter the CAT web service URLs




6.

Enter the Session Access web service URL and then the name of the module you used
in
the CAT. Make note of the name you use for the Application module as you will need it
later.



13


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document





14


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

7.

Select whether you want to retain user data.




Important
Note:

IF you “Uncheck” this box THEN the EFFCAM database must exist
otherwise the installer will
fail.






15


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

8.

Click next on the following screen.





Important Note:

The Virtual Directory must be named, “EFFWeb”. This is required
based on the CAM XML Module that is uploaded and installed into the
CAT environment
.








16


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

9.

Select the next button on the
C
onfirm
I
nstallation screen.

This will start the automated installer.



10.
The following screen is displayed with then automated installer starts running.



High
-
Level Process Flow Description of the A
utomated
I
nstaller
P
rocedures

o

Create VDIR

o

XCOPY web
files

o

Drop
\
Create Database

o

Drop
\
Create User and User Role

o

Drop
\
Create Tables
\
Stored Procedures

o

Automatically update the Database Connection string in the Web.config with the
SQL Server Instance Name in step 4 above.





17


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

11.
During the installation, a MessageBox(
) will appear indicating that an Installation Log has
been created. The fully qualified path to the installer file is also displayed. Select the OK
button for the installation to continue.





12.
The following screen will display if the EFF Web CAM was succe
ssfully installed



18


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document




2.3

EFF Web CAM Installer Log

(OPTIONAL)

N
avigate to the following VDIR directory (
\
\
EFFWeb
\
\
log
\
\
EFFWebCamInstallLog.txt
).
The EFF
Web CAM installer creates a log file of all the processing steps

that occurred during the install.
This file will be used primarily for technical support purposes.


EFFWebCamInstallLog.txt

Output Example


****************************************************************

EFF Web CAM Installer Log


Target Install: Electro
nic Flight Folder Version 0.0.5.1


DateTime Installer Executed: Wednesday, January 20, 2010, 10:42 AM

****************************************************************


<
-------------------------------------
>

IIS Web Application Install

<
-------------------------------------
>

Base Web Installation Started

Base Web Installation Complete


<
-------------------------------------
>

User Entered Parameters

<
-------------------------------------
>

Target Directory: C:
\
inetpub
\
wwwroot
\
EFFWeb
\

Target

Virtual Directory: EFFWeb

Target Site: /LM/W3SVC/1

SQL Server Name: localhost

SQL Server User Name: sa

SQL Server Password: **********

SQL Server Physical File Path: C:
\
Program Files
\
Microsoft SQL Server
\
MSSQL10.MSSQLSERVER
\
MSSQL
\
DATA
\

EFF User Data Reten
tion: False


<
-------------------------------------
>

Executing SQL Server Scripts

<
-------------------------------------
>



19


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

[Start Script Execution]


Drop/Create Database Script Counter: 33


Drop/Create/Seed Database Script Counter: 194

[End Script E
xecution]


Total # of SQL Server Scripts Executed: 227


<
-------------------------------------
>

Add SQL Connection String to Web.Config

<
-------------------------------------
>

Web.Config Database Connection String 'effDBConnectionString' has been
updated to use Initial Catalog: localhost

Web.Config Database Connection Provider: System.Data.SqlClient


<
-------------------------------------
>

Installer [savedState] Parameters

<
-------------------------------------
>

savedState count : 2

savedState keys

: 2

savedState values : 2

KEY = _reserved_nestedSavedStates || Value = System.Collections.IDictionary[]

KEY = _reserved_lastInstallerAttempted || Value =
-
1


<
-------------------------------------
>

Installer [savedState]
-

Attributes

<
--------------------
-----------------
>

Context Parameters Attributes

Count : 12

Keys : 12

Values : 12


<
-------------------------------------
>

All Available Context Parameter List

<
-------------------------------------
>

ContextKey [assemblypath]=C:
\
inetpub
\
wwwroot
\
EFFWeb
\
bin
\
Boeing.EFFWebCamCustomAction.dll

ContextKey [targetvdir]=EFFWeb

ContextKey [action]=install

ContextKey [sqlserverphysicalfilepath]=C:
\
Program Files
\
Microsoft SQL Server
\
MSSQL10.MSSQLSERVER
\
MSSQL
\
DATA
\

ContextKey [sqlservername]=localhost

ContextKey
[installtype]=notransaction

ContextKey [logfile]=

ContextKey [targetsite]=/LM/W3SVC/1

ContextKey [targetdir]=C:
\
inetpub
\
wwwroot
\
EFFWeb
\

ContextKey [effuserdata]=1

ContextKey [sqlserverpassword]=

ContextKey [sqlserverusername]=sa


**************************
**************************************

EFF Web CAM Installer Execution Complete.

****************************************************************








20


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

3

Add EFF Web CAM

Module

to CAT

The following

documentation covers using the CAT web interface to create an

EFF Web CAM
Module in the CAT environment.

3.1

CAM Module Prerequisites



EFB Configuration Administration Tool Version 5.2.0000.00011 successfully installed



C
reate

and Save

a new company profile within CAT

DEFAULT project


3.2

Add Module Instructions

1.

Login to
DEFAULT company




2.

Select Administrative Tasks Menu








21


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

3.

Select Add Module link on left Menu

a.

Select the Browse Button


b.

Navigate to the EFF Web CAM Virtual Web Directory. The EFF Web CAM
module XML is located in the following directory off of the VDIR.


EFF Web CAM Module XML file name =
CamModuleV1.0.xml


EFF Web CAM VDIR =
EFFWeb


Example Application Module File Directory and File Name

=


C:
\
Inetpub
\
wwwroot
\
EFFWeb
\
cat
\
modules
\
CamModuleV1.0.xml


c.

Select Upload Button


d.

Use the value you chose earlier in

the installer for the unique and display
names. By default this is “Boeing Electronic Flight Folder”.

i.

Unique Name =
Boeing Electronic Flight Folder

ii.

Display Name =
Boeing Electronic Flight Folder




e.

Select Save Button







22


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

3.3

Assign EFF Web CAM Module

1.

Login
to Company Profile created using admin credentials


For Example


EFFProject





2.

Select Administrative Tasks Menu

3.

Select Assign Module left menu hyperlink




4.

Select Boeing Electronic Flight Folder CHECKBOX

5.

Select Save Button






23


Copyright ®
2010

Optimization Technologies, Inc.

All rights reserved.

30GW7
-
OT
-
EFF
-
CAM
-
INS

EFF
Web CAM Build and Installer Document

3.4

Create User Profile and A
ssign Module to user.

3.4.1

Prerequisites



Assign Company Module
-

Follow steps in Section 3.3 of this document

3.4.2

Create User Profile and Assign Module to user

1.

Select Create User Profile left navigation hyperlink

2.

Fill
-
out web form and select the “Boeing Electronic
Flight Folder” module.




3.

Select Save Button

4.

Logout and Login using new user

5.

Selecting a properly configured Target

6.

Select Content Application Modules Dropdown Menu and Select the Electronic Flight Folder
application link to load the EFF Web CAM.