Difference between revisions of "SAM V2:Installation"

From CIDI Wiki
Jump to navigation Jump to search
(New page: ==Architecture and Features== SAM V2 is functionally similar to SAM V1 in terms of data tracking, but differs in terms of architecture, user interface, and reporting. While [[SAM V1]...)
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Architecture and Features==
The installation of SAM V2 is peformed by the customer.


SAM V2 is functionally similar to [[SAM V1]] in terms of data tracking, but differs in terms of architecture, user interface, and reportingWhile [[SAM V1]] follows a [[Wikipedia:Software_as_a_Service|software as a service]] model, SAM V2 requires that the software be installed on computers owned and managed by the userPlease review the [[Media:SAMV1vsSAMV2.doc|SAM descriptions and pricing document]] for a comparison between SAM V1 and SAM V2.
SAM V2 requires the customer to have a [[Wikipedia:Web Server|web server]] with [http://www.php.net PHP] installed.  The [http://www.php.net PHP] installation must also have the [http://www.mysql.com MySQL] extension installed.  [http://www.mysql.com MySQL] should also be installed, either on the web server or another computer that can communicate with the web serverThis configuration is typically referred to as [[Wikipedia:WAMP|WAMP]] or [[Wikipedia:LAMP_(software_bundle)|LAMP]], depending on the operating system of the web serverFor information on installing [http://www.apache.org Apache], [http://www.php.net PHP], and [http://www.mysql.com MySQL], read this recommended [http://www.php-mysql-tutorial.com/index.php PHP MySQL Tutorial].


SAM V2 was developed using the leading open source solutions of [http://www.php.net PHP] and [http://www.mysql.com MySQL].  For an overview of [http://www.php.net PHP] and [http://www.mysql.com MySQL] and why these products where used, see [http://media.wiley.com/product_data/excerpt/67/07645574/0764557467.pdf Why PHP and MySQL].
Once the above software is installed and configured, SAM V2 is installed as follows:


Other features of SAM V2 include:
# Create the MySQL sam database using the sam_shema.sql script.  Typically this database is created by running the following MySQL command: mysql -u root -p[root password] < sam_schema.sql.
 
# Create a MySQL user and grant all schema privleges for the sam database to this user.  Typically, the easiest way to do this is to use the MySQL Administrator logged in as root.
* Web-based
# Install the SAM V2 PHP source code onto the web server by unzipping and extracting the samv2.zip file.  Be sure to extract the files to the location you intend to use as the URL.  If your web server address is 128.192.60.163 and you extract samv2.zip to the projects directory, then your SAM V2 software URL will be 128.192.60.163/projects/samv2.
* Accessible
# Modify the following programs:
* Custom, printable reporting
#*dbconnect.php - Change the MySQL connection parameters to be IP address of the machine running your MySQL database, the port number (typically 3306), and the username and password you setup in step 2.
* Access control via logins
#*header.php - Change the $institution variable to be the name of your institution.
* Data encryption
#*index.php - Change the $institution variable to be the name of your institution.
* Data export
#*notification.php and notification2.php - Change the name of the institution and address lines to be accurate for your institution.
 
#Place a JPEG image file of your institution logo in the samv2 directory on the web server.  The file name should be logo.jpg.  The logo image should be approximately 180 by 180 pixels.
Knowledge of [[Wikipedia:SQL|SQL]] is required to create custom reports using the SAM V2 interfaceAdditionally, [[Wikipedia:SQL|SQL]] can be used to import or manipulate data.
#Log into the SAM V2 application as the administratorBefore any users can access the application, you must define users and permissions.  Tools to create users and configure permissions are located under the Administration menu.

Latest revision as of 15:56, 12 November 2008

The installation of SAM V2 is peformed by the customer.

SAM V2 requires the customer to have a web server with PHP installed. The PHP installation must also have the MySQL extension installed. MySQL should also be installed, either on the web server or another computer that can communicate with the web server. This configuration is typically referred to as WAMP or LAMP, depending on the operating system of the web server. For information on installing Apache, PHP, and MySQL, read this recommended PHP MySQL Tutorial.

Once the above software is installed and configured, SAM V2 is installed as follows:

  1. Create the MySQL sam database using the sam_shema.sql script. Typically this database is created by running the following MySQL command: mysql -u root -p[root password] < sam_schema.sql.
  2. Create a MySQL user and grant all schema privleges for the sam database to this user. Typically, the easiest way to do this is to use the MySQL Administrator logged in as root.
  3. Install the SAM V2 PHP source code onto the web server by unzipping and extracting the samv2.zip file. Be sure to extract the files to the location you intend to use as the URL. If your web server address is 128.192.60.163 and you extract samv2.zip to the projects directory, then your SAM V2 software URL will be 128.192.60.163/projects/samv2.
  4. Modify the following programs:
    • dbconnect.php - Change the MySQL connection parameters to be IP address of the machine running your MySQL database, the port number (typically 3306), and the username and password you setup in step 2.
    • header.php - Change the $institution variable to be the name of your institution.
    • index.php - Change the $institution variable to be the name of your institution.
    • notification.php and notification2.php - Change the name of the institution and address lines to be accurate for your institution.
  5. Place a JPEG image file of your institution logo in the samv2 directory on the web server. The file name should be logo.jpg. The logo image should be approximately 180 by 180 pixels.
  6. Log into the SAM V2 application as the administrator. Before any users can access the application, you must define users and permissions. Tools to create users and configure permissions are located under the Administration menu.