Installation

From CaisisWiki

(Difference between revisions)
Jump to: navigation, search
(Database Setup)
m
Line 85: Line 85:
To setup the database, you will first have to login to the database server as an Administrator and create the base database and login for the application. The follow steps will guide you through creating and setting up the Caisis database using the [http://www.microsoft.com/downloads/details.aspx?FamilyID=08E52AC2-1D62-45F6-9A4A-4B76A8564A2B&displaylang=en Microsoft® SQL Server® 2008 Management Studio Express] tool.
To setup the database, you will first have to login to the database server as an Administrator and create the base database and login for the application. The follow steps will guide you through creating and setting up the Caisis database using the [http://www.microsoft.com/downloads/details.aspx?FamilyID=08E52AC2-1D62-45F6-9A4A-4B76A8564A2B&displaylang=en Microsoft® SQL Server® 2008 Management Studio Express] tool.
 +
[[Image:db_setup3.jpg|thumb|none|650px|baseline|alt=|Open the DatabaseFiles folder from the Caisis download folder, which includes the README and sql files.]]
 +
[[Image:db_setup1.jpg|thumb|none|650px|baseline|alt=|Log into database server as Server Administrator, i.e., "sa"]]
 +
[[Image:db_setup4.jpg|thumb|none|650px|baseline|alt=|Create a new database]]
 +
[[Image:db_setup5.jpg|thumb|none|650px|baseline|alt=|Give the new database a name]]
 +
[[Image:db_setup7.jpg|thumb|none|650px|baseline|alt=|Ensure the correct '''Collation''' and '''Compatibility Levels''' are set.]]
 +
[[Image:db_setup8.jpg|thumb|none|650px|baseline|alt=|The new database will now show up in the list of available databases.]]
 +
[[Image:db_setup2.jpg|thumb|none|650px|baseline|alt=|Create a new Server Login]]
 +
[[Image:db_setup10.jpg|thumb|none|650px|baseline|alt=|This login will be the account used by the web application to connect to the database.]]
 +
[[Image:db_setup11.jpg|thumb|none|650px|baseline|alt=|Ensure the login has '''datareader''' and '''datawriter''' role for the Caisis database.]]
 +
[[Image:db_setup12.jpg|thumb|none|650px|baseline|alt=|The new login will now show up in the Security node of the database server.]]
 +
[[Image:db_setup13.jpg|thumb|none|650px|baseline|alt=|The next step is to open the list of SQL files required to create the database tables.]]
 +
[[Image:db_setup14.jpg|thumb|none|650px|baseline|alt=|Run the list of files sequentially until all are completed.]]
 +
[[Image:db_setup15.jpg|thumb|none|650px|baseline|alt=|The first script will create the database structure.]]
 +
[[Image:db_setup16.jpg|thumb|none|650px|baseline|alt=|The last script will ensure the new login you created can access the Caisis database. NOTE: adjust the username variable to the new login created.]]
 +
[[Image:db_setup17.jpg|thumb|none|650px|baseline|alt=|After the scripts have run, you will now have all the Caisis system tables, metadata and lookup codes.]]
-
[[Image:db_setup3.jpg|thumb|650px|baseline|alt=|Open the DatabaseFiles folder from the Caisis download folder, which includes the README and sql files.]]
 
-
[[Image:db_setup1.jpg|thumb|650px|baseline|alt=|Log into database server as Server Administrator, i.e., "sa"]]
 
-
[[Image:db_setup4.jpg|thumb|650px|baseline|alt=|Create a new database]]
 
-
[[Image:db_setup5.jpg|thumb|650px|baseline|alt=|Give the new database a name]]
 
-
[[Image:db_setup7.jpg|thumb|650px|baseline|alt=|Ensure the correct '''Collation''' and '''Compatibility Levels''' are set.]]
 
-
[[Image:db_setup8.jpg|thumb|650px|baseline|alt=|The new database will now show up in the list of available databases.]]
 
-
[[Image:db_setup2.jpg|thumb|650px|baseline|alt=|Create a new Server Login]]
 
-
[[Image:db_setup10.jpg|thumb|650px|baseline|alt=|This login will be the account used by the web application to connect to the database.]]
 
-
[[Image:db_setup11.jpg|thumb|650px|baseline|alt=|Ensure the login has '''datareader''' and '''datawriter''' role for the Caisis database.]]
 
-
[[Image:db_setup12.jpg|thumb|650px|baseline|alt=|The new login will now show up in the Security node of the database server.]]
 
-
[[Image:db_setup13.jpg|thumb|650px|baseline|alt=|The next step is to open the list of SQL files required to create the database tables.]]
 
-
[[Image:db_setup14.jpg|thumb|650px|baseline|alt=|Run the list of files sequentially until all are completed.]]
 
-
[[Image:db_setup15.jpg|thumb|650px|baseline|alt=|The first script will create the database structure.]]
 
-
[[Image:db_setup16.jpg|thumb|650px|baseline|alt=|The last script will ensure the new login you created can access the Caisis database. NOTE: adjust the username variable to the new login created.]]
 
-
[[Image:db_setup17.jpg|thumb|650px|baseline|alt=|After the scripts have run, you will now have all the Caisis system tables, metadata and lookup codes.]]
 
==== Database Upgrade from Caisis 4.1 to 4.5 ====
==== Database Upgrade from Caisis 4.1 to 4.5 ====
Line 128: Line 128:
==== Installer Screenshots ====
==== Installer Screenshots ====
-
[[File:Installer_1.jpg]]
+
[[Image:Installer_1.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_2.jpg]]
+
[[Image:Installer_2.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_3.jpg]]
+
[[Image:Installer_3.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_4.jpg]]
+
[[Image:Installer_4.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_5.jpg]]
+
[[Image:Installer_5.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_6.jpg]]
+
[[Image:Installer_6.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_7.jpg]]
+
[[Image:Installer_7.jpg|thumb|none|650px|baseline|alt=|]]
-
[[File:Installer_8.jpg]]
+
[[Image:Installer_8.jpg|thumb|none|650px|baseline|alt=|]]
-
 
+
Note, it is NOT necessary to add all the variables in the Caisis Configuration Utility during setup. The can be modified anytime by:
Note, it is NOT necessary to add all the variables in the Caisis Configuration Utility during setup. The can be modified anytime by:

Revision as of 17:05, 11 May 2010

Translations: italiano - français

VERSION 5.0 install instructions are in progress! The web instructions below still apply, but for revised database instructions please check back on Monday.

Version 4.5 Release Notes

Caisis is an ASP.NET web application with a SQL Server backend. Users interface with the application using a web browser and we have supported Internet Explorer 6 & 7, FireFox, and Safari 3.0 for the Mac since version 4.0.

Caisis was built to scale to from single users to thousands, and the number of users and performance expectations should be considered when selecting hardware. At minimum, the Caisis database and web server can be run on the same server with 5 GB of free hard drive space and 512MB of RAM. Using SQL Server 2005 Express in place of the Enterprise version allows groups to get up and running at no cost (assuming you have a Windows Server with IIS installed).

This page will guide you through the installation of the database and web application.


Contents

System Requirements

.NET Framework

Database Server

  • Microsoft SQL Server 2008
  • Microsoft SQL Server 2005
  • Microsoft SQL Server Express (with limitations: see Microsoft Web Site)

Web Server

  • Microsoft Windows 2008, 2003 or XP
  • Microsoft Internet Information Services (IIS) 6 or Greater

NOTES

  • The database and web server can be on the same or different physical machines
  • .NET 3.5 (required by Caisis) is not supported under Windows 2000.
  • II5 is also not suppored by the .NET 3.5 Framework


Installation Prerequisites

Before you begin the installation, verify that you have met the requirements above and that the .NET 2.0 and 3.5 Frameworks are installed on your web server, and SQL Server and Internet Information Services(IIS) are running.

This will help to ensure a problem free installation when running the Caisis Installer and SQL setup script.


Downloads

Caisis 5.0 can be downloaded as a zip package, which contains the files needed to setup the database and web application.

There are 3 packages available for download:

Caisis 5.0 - New Installation

  • Installer: Contains the Windows Installer file for a standard installation.
  • Database: Contains the Database sql script files needed to create and install the Caisis 5.0 database.

Caisis 5.0 - Upgrade from Caisis 4.5

  • WebApp: Contains the web application files if you prefer to manually copy the Caisis files to a registered IIS web root instead of running the Installer file.
  • Installer: (recommended) Contains the Windows Installer file for a standard installation. Before running the install, you may have to uninstall prior versions of Caisis using Control Panel:Add/Remove programs
  • Database: Contains the Database sql script files needed to upgrade your Caisis 4.5 Database to the Caisis 5.0 Database.
  • NOTE: The above also applies when upgrading from version 4.1 to 4.5. To upgrade the database to 5.0 from an older version of the Caisis database, you must run the appropriate scripts between versions, as this ensures the data is moved correctly, and metadata is preserved.

Example: To upgrade from Version 4.1 to 5.0

   4.1 -> 4.5 - 5.0

Example: To upgrade from Version 4.0 to 5.0

   4.0 -> 4.1 -> 4.5 -> 5.0

Caisis 5.0 Source Files

Contains the Visual Studio Solution file and source code used to build and modify Caisis.


Database Setup

You will need to log into your SQL Server in order to run the install or upgrade scripts.

Setup Scripts

New Caisis 5.0 Database Installation

You will find 6 files in the DatabaseFiles folder. These files will be used to create the database structure as well as the necessary meatadata to get starter running Caisis. This version of Caisis uses SQL files to create the database structure, import metadata (lookup codes, table and field level metadata).

  1. _README.txt
  2. 1_BuildDatabaseObjects.sql
  3. 2_SecurityData.sql
  4. 3_Metadata.sql
  5. 4_CTCAE_TableData.sql
  6. 5_GrantPermissions.sql

New Caisis Database Setup Walkthrough

To setup the database, you will first have to login to the database server as an Administrator and create the base database and login for the application. The follow steps will guide you through creating and setting up the Caisis database using the Microsoft® SQL Server® 2008 Management Studio Express tool.

Open the DatabaseFiles folder from the Caisis download folder, which includes the README and sql files.
Log into database server as Server Administrator, i.e., "sa"
Create a new database
Give the new database a name
Ensure the correct Collation and Compatibility Levels are set.
The new database will now show up in the list of available databases.
Create a new Server Login
This login will be the account used by the web application to connect to the database.
Ensure the login has datareader and datawriter role for the Caisis database.
The new login will now show up in the Security node of the database server.
The next step is to open the list of SQL files required to create the database tables.
Run the list of files sequentially until all are completed.
The first script will create the database structure.
The last script will ensure the new login you created can access the Caisis database. NOTE: adjust the username variable to the new login created.
After the scripts have run, you will now have all the Caisis system tables, metadata and lookup codes.


Database Upgrade from Caisis 4.1 to 4.5

Before attempting to upgrade the database from 4.1 to 4.5 it is recommended to make a backup of your current database. It is advisable to run the database upgrade process on a copy to see if any problems may occur.

The upgrade process consists of three sequential steps:

  • Upgrade the database using the file 4.1_to_4.5_upgrade_script.sql
  • Grant permissions to new objects introduced in 4.5 using the file GrantPermissions.sql
  • Import new system data into the database using the file ImportMetadata.sql

You must be connected to the correct database to run these files. If all steps run without error then the upgrade is successful.

NOTE 1: If errors occur during the first step then restore your database and instead of using 4.1_to_4.5_upgrade_script.sql run the files in the folder IndividualScriptFiles until the exact file is found that is causing a problem. Resolve data errors before proceeding.

NOTE 2: The ImportMetadata.sql file will remove your old lookup codes and help descriptions and replace it with the new data. So if you have made many changes to your own data be sure to backup at least those tables.

Web Application Setup

Windows Installer File

Before beginning the installation, please make sure IIS is running and that you have permissions to the modify settings. Caisis comes packed in a Windows Installer file which will install the application through a series of steps. The installer will setup your virtual directory in IIS for hosting Caisis and then launch the Caisis Configuration Utility, a desktop application which will allow you to to modify various settings in your application, such as Institution settings, Email settings, Database settings and Error Handling. It will also allow you to test the connection from the web app to the Database.

Once the settings are saved, the installer will end and launch the application in a new browser.

Installer Screenshots

Note, it is NOT necessary to add all the variables in the Caisis Configuration Utility during setup. The can be modified anytime by:

  • The Caisis Configuration Utility will be located in the user's program files directory and can be launched anytime to mange the settings in your web.config file.
  • The same installation parameters can also be modified anytime by opening the web.config file found in the web root directly

NOTE: You will need to log in to the server as an administrator to install Caisis using the provided Windows Installer.

Manual Installation

If you need to manually configure the application, you can create a virtual directory in IIS and place the files contained in the Upgrade/WebApp Folder in there. You will also need to verify that your application is running under ASP.NET 2.0. You can check this, and other web site properties, by opening IIS, find the Caisis web site, right clicking on it and choose properties. When the dialogue box opens select the "ASP.NET" tab and check that 2.0 appears in the drop down box.


Confirm Application Running

After running the Setup file, a web page will launch to your application. The typical URL of your application will be http://machine_name/virtual_directory/Login.aspx If you application was installed on machine ONYX in the virtual directory Caisis, your application would be located at http://onyx/Caisis/Login.aspx. If you receive any errors, you can consult the Troubleshooting page for help diagnosing the issues.

Personal tools