introduction - protecting vulnerable populations through ... · web viewsql server 2008 r2 service...

12
Database and Application Deployment Background Check System IT Deployment Guide Version 01 2/19/2015

Upload: others

Post on 09-Oct-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Database and Application DeploymentBackground Check System

IT Deployment GuideVersion 01

4/21/2015

Page 2: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

Table of Contents

1 Introduction......................................................................................................................................... 3

2 BCS Hardware Requirements............................................................................................................4

3 BCS Software Requirements..............................................................................................................4

4 Setting Up the BCS Platform..............................................................................................................5

4.1 Source Installation Package.........................................................................................................5

4.2 Microsoft .NET 4.0 Framework.....................................................................................................5

4.3 Internet Information Services (IIS) 7.x..........................................................................................5

4.4 BCS Database............................................................................................................................. 5

5 Running the BCS Platform................................................................................................................. 6

5.1 Visual Studio Professional 2010 SP1 Configuration.....................................................................6

5.2 Website Configuration.................................................................................................................. 6

5.3 Criminal Justice Information Services (CJIS) Enhancements......................................................7

5.4 Testing the Application................................................................................................................. 8

6 Running the BCS Tasks Service........................................................................................................9

6.1 BCS Tasks Service Installation....................................................................................................9

6.2 BCS Tasks Service Configuration..............................................................................................10

6.3 Uninstalling the BCS Tasks Service...........................................................................................10

Database and Application Deployment Page 2 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 3: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

1 IntroductionThe Background Check System (BCS) platform is a Microsoft-based application that takes advantage of the .NET 4.0 Framework and SQL Server 2008 R2. This deployment guide is intended to instruct IT staff on how to deploy the BCS application and database on a single machine. Instructions are not intended to demonstrate best practices for establishing a secure production environment, which should be dictated by the policies and procedures set by your agency for your infrastructure.

In order to understand the BCS platform deployment instructions provided within this document, the reader will need an understanding of the IT/coding concepts described in the following table.

IT/Coding Concepts Description

Application Development ASP.NET/C# application written in Visual Studio Professional 2010 with Service Pack 1 on the .NET Version 4 Framework

Database Support SQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and development, SQL Jobs

Reporting Development SQL Server Reporting Services (SSRS) 2008 R2

Integration Services SQL Server Integration Services (SSIS) with Visual Studio 2010 being the platform to develop the packages

Task Service An operational services component, written in C#/.NET 4.x

Infrastructure/Operations/Security Internet Information Services (IIS) 7.x. To establish a website and Application Pool for the BCS platform to run under, this would include publishing the application to IIS, creating and properly securing a database connection, and updating configuration files for the website and task service.

Database and Application Deployment Page 3 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 4: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

2 BCS Hardware RequirementsFor the BCS platform to run effectively, you must ensure that the machine on which BCS will be deployed meets or exceeds the requirements listed in the following table. (Note: The machine is not assumed to be a production grade server.)

BCS Machine Components Minimum Requirement

Processor Minimum 1GHz processor or equivalent

Operating System Windows Server 2008 R2 (Recommended, preferred Service Pack 1); Windows Server 2008; Windows Server 2003; Windows 7; Windows 7 SP1

Memory 2GB-4GB (Recommended)

Hard Disk 20+ GB of available space

Assumptions Installation user has local administrative privileges

3 BCS Software RequirementsThe machine to which the BCS will be deployed must have the following software in order to be compatible with the BCS platform:

Visual Studio Professional 2010 with Service Pack 1

SQL Server 2008 R2 with Service Pack 1; An SQL Developer license will suffice; SQL Standard is not required; Please refer to the “Database Installation” IT Deployment guide.

Microsoft .NET 4.0 Framework; Please refer to the “.Net 4.0 Framework Verification” IT Deployment guide.

Internet Information Services (IIS) 7.x; Please refer to the “IIS Installation Verification” IT Deployment guide.

Source Installation Packageo Deployment documentation

o Source code

o Back up of BCS supported databases (.bak files)

o SQL scripts to initialized the database

Database and Application Deployment Page 4 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 5: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

4 Setting Up the BCS Platform

4.1 Source Installation PackageCopy the contents of the Source Installation Package to a local drive, preferably named “C:\BCS_SourceFiles.” The contents of the Source Installation Package will be divided into the folders described in the table below.

Source Installation Package Folders

Description

Application Source code of the BCS solution to be opened via Visual Studio

DatabaseDataUpdate Database scripts to update or modify data within the BCS application

DatabaseSchema Database scripts to update the schema or actual back up files for initial deployment

SSIS SQL Server Integration Services (SSIS) installation packages

SSRS SQL Server Report Services (SSRS) source Report Definition Language (RDL) files

TaskService .NET Service source code for installation or updates

4.2 Microsoft .NET 4.0 FrameworkPlease refer to the “.Net 4.0 Framework Verification” IT Deployment guide for setup steps.

4.3 Internet Information Services (IIS) 7.xPlease refer to the “IIS Installation Verification” IT Deployment guide for setup steps.

4.4 BCS Database Please refer to the “Database Installation” IT Deployment guide for setup steps.

Database and Application Deployment Page 5 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 6: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

5 Running the BCS Platform

5.1 Visual Studio Professional 2010 SP1 ConfigurationDepending on how you normally setup your Visual Studio projects, copy the source code (Application folder of the Source Installation Package) to a preferred location. For example: “C:\Projects\Cna\Registries\.”

To load and build the BCS web project, named “Bcs.Web.Mvc.Website.Bureaucrat,” you will need to install ASP.NET MVC 3, which can be found at: http://www.microsoft.com/en-us/download/details.aspx?id=4211. Open the “Bcs.sln” file from the root directory and ensure no errors occur when loading the project.

5.2 Website ConfigurationYou will need to modify the “web.config” file to ensure that the database connection strings are correctly associated to the BCS platform databases. Please refer to the <connectionStrings> attribute and the “Data Source=” values.

In the “Database Installation” IT Deployment guide, Database Security (section 4.5) recommends creating the SQL server login as ‘BCS’ (or as your security policy requires). Update the “web.config” file to match to the SQL server user under which the BCS platform will be running.

The following is an example of the connection section of a working application where the database resides on the same server as the web application (Data Source=.\):

<connectionStrings>

<add name="Logging" connectionString="Data Source=.\;Initial Catalog=BcsLogging; integrated security=False;User ID=USERNAME;Password=PASSWORD;multipleactiveresultsets=True" providerName="System.Data.SqlClient" />

<add name="Registry" connectionString="Data Source=.;Initial Catalog=BcsRegistry;integrated security=False;User ID=USERNAME;Password=PASSWORD;multipleactiveresultsets=True" providerName="System.Data.SqlClient" />

Database and Application Deployment Page 6 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 7: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

<add name="Bcs" connectionString="Data Source=.;Initial Catalog=Bcs;integrated security=False;User ID=USERNAME;Password=PASSWORD;multipleactiveresultsets=True" providerName="System.Data.SqlClient" />

</connectionStrings>

5.3 Criminal Justice Information Services (CJIS) Enhancements

5.3.1 Systems that Utilize CJIS InformationIf your system includes enhancements related to viewing CJIS information and the associated security needed to do so, the following instructions will guide you through how to correctly establish the CJIS web pages on your web server. Since CJIS code will not be deployed automatically, you must consider the processes described below in order to deploy the code.

Local builds should automatically copy the “Bcs.Cjis.*.dll” files into the “\Bin” folder; therefore, typical development should not be impacted by any of these changes.

The following files are related to the CJIS implementation and should be copied to the “\Bin” folder after publishing:

o Bcs.Cjis.Dal.dll

o Bcs.Cjis.Impl.dll

o Bcs.Cjis.Log.dll

o Bcs.Cjis.Sani.dll

o Bcs.Cjis.Val.dll

o Bcs.Web.Mvc.Website.Controllers.Cjis.dll

o Bcs.Web.Mvc.Website.Models.Cjis.dll

5.3.2 Systems that do not Utilize CJIS InformationAlternatively, for a non-CJIS deployment, the “Views\Cjis” folder and its contents should be deleted. These “*.cshtml” files are responsible for rendering the HTML generated via the Controllers.Cjis and Models.Cjis classes (that should not be present). Even though the CJIS views won’t work without the underlying controller and model classes, they should be deleted nonetheless.

The related “*.Cjis.*.dll” files should also be deleted. Though deleting the views will provide some level of protection against users being able to access CJIS functionality, it is possible to perform get/post actions against controllers with missing views. Such attempts would fail due to our use of the AntiForgeryToken, but it is still best to delete all CJIS related files.

Database and Application Deployment Page 7 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 8: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

5.4 Testing the ApplicationRun the application from Visual Studio to ensure you have a working system on your local machine. Run the solution via the Start Debugging process by clicking: Debug > Start Debugging or {F5}. Verify the application builds without error and that a web session is started. When the Login page displays, login with the temporary Admin account. After reaching the Home page, you have successfully installed and configured the BCS web application.

If needed, set Bcs.Web.Mvc.Website.Bureaucrat as your StartUp Project in Visual Studio.

Once you are ready for development deployment, publish the BCS to your local IIS installation (or to another server if internal processes dictate).

Database and Application Deployment Page 8 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 9: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

6 Running the BCS Tasks ServiceThe Tasks Service facilitates messaging within the BCS platform. Install it as a service on the machine to which BCS is being deployed.

6.1 BCS Tasks Service InstallationBrowse to the location where the source was installed on to your target machine; for example: “C:\BCS_SourceFiles\TaskService.” Verify the “Install.bat” and “Uninstall.bat” files are located within the folder. Edit both files to make sure the path to “InstallUtil.exe” is valid. (The default path is: “C:\Windows\Microsoft.NET\Framework64\v4.0.30319.”) Below is an example of running the “Install.bat” file.

path=C:\Windows\Microsoft.NET\Framework64\v4.0.30319;%PATH%

installutil /ShowCallStack Bcs.Tasks.WinService.exe

rem installutil /ShowCallStack C:\Projects\Cna\Registries\Application\Tasks\Bcs.Task.Winservice\Bin\Debug\Bcs.Tasks.WinService.exe

pause

Note that when running the “Install.bat” file, the path to “Bcs.Tasks.WinService.exe” must be correct. If the relative path does not work, you can use a direct path.

1. Update the “Bcs.Tasks.WinService.exe” file to ensure that <connectionStrings> is updated to reflect the correct database connection information. Refer to Website Configuration (section 5.2 above) for more information.

2. Run the “Install.bat” file.

3. Review the output of the DOS window to ensure there are no errors. Confirm the Tasks Service has been installed in the Services section. Confirm the name of the service running is BCS Task Service.

If you want to modify the name of the Task Service, modify the value for the Deployment key in the configuration file prior to running the “Install.bat” file. The value you enter will be appended to the BCS Task Service name. For example, if you enter a value of “UAT”, the service name will be: “BCS Task Service – UAT.”

Database and Application Deployment Page 9 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff

Page 10: Introduction - Protecting Vulnerable Populations Through ... · Web viewSQL Server 2008 R2 Service Pack 1 and database development, Transact-SQL (T-SQL) for configuration items and

Protecting Patients through Background Checks

6.2 BCS Tasks Service ConfigurationAfter completing the steps described above (section 6.1), the Tasks Service should now be installed under Services for the target machine.

Edit the Properties of the BCS Tasks Service and update the following configurations:

Set Startup Type to Automatic. Depending on your needs, you may also set it to delayed start so that the Tasks Service will startup at a designated time instead of immediately.

Edit Log On As (if necessary, per your security or infrastructure requirements).

Click Start the Service.

6.3 Uninstalling the BCS Tasks ServiceWhen the need arises to remove the Tasks Service from the target machine, refer to the same directory used in the installation. Note that when running the “Uninstall.bat” file, the path to “Bcs.Tasks.WinService.exe” must be correct. If the relative path does not work, you can use a direct path.

1. Run the “Uninstall.bat” file.

2. Review the output of the DOS window to ensure there are no errors. Confirm the Tasks Service has been removed from the Services section.

Database and Application Deployment Page 10 of 10Version 01 | 4/21/2015 | IT Deployment Guide | Audience: State IT Staff