Framework Installation : Web Portal Environment Setup
- Matthew Garrett
Article Index
The following are summary topics that list the steps required on the day (or evening prior to) the installation of the Framework Product Suite Web Portal Software. This information is for internal IT staff responsible for the deployment of the Framework Product Suite Web Portal Software and its integration into internal systems and business processes.
Ensure you have read and completed the steps in the Web Portal Pre-Requisite Checklist.
Step 1 - Download PHP
PHP is a widely used scripting language that is designed for web development to produce dynamic web pages.
Framework's web portal software, including MyNewHome, QuickView, and SupplierConnect, uses PHP to view the web portal.
Framework's Web Portal Software currently uses PHP Version 5.3.xx (Zip Package version).
Download from http://www.php.net/releases.
Step 2 - PHP Installation
PHP is a computer scripting language designed to help produce dynamic web pages. The Framework Product Suite Web Portal Software uses PHP to create the website and to connect the website to the required Framework databases.
If PHP is already installed on the system, please Contact Insula Software.
Unzip PHP to the folder: C:\php (on the target machine).
In the C:\php folder, rename the ini-recommended file to be php.ini.
Step 3 - Microsoft SQL Server Driver For PHP
The SQL Server Driver for PHP v1.0 is designed to enable reliable, scalable integration with SQL Server for PHP applications deployed on the Windows platform. The Driver for PHP is a PHP 5 extension that allows the reading and writing of SQL Server data from within PHP scripts. It provides a procedural interface for accessing data in all editions of SQL Server (including Express Editions).
Install - Microsoft SQL Server Driver For PHP
If the Microsoft SQL Server Driver for PHP is already installed on the system, please skip this step.
Open Windows Explorer.
Browse to: [fw folder]\Setup\Database - MSSQL\Microsoft SQL Server Driver for PHP\
Double-click the setup file. The Microsoft SQL Server Driver for PHP installation will begin.
Click the Yes The File Extraction step will be displayed.
Enter a location to extract the files (e.g., C:\phpext\). If the folder does not exist, confirm the folder creation. The files will be extracted.
Browse to the extracted file location (e.g., C:\phpext\).
Copy the following files:
php_sqlsrv.dll
php_sqlsrv_ts.dll
Browse to: C:\php\ext\
Paste the files into the C:\php\ext\ folder.
After pasting the files, the location of the extracted files can be safely deleted
Step 4 - PHP Configuration
Open Windows Explorer.
Browse to the location of the ini file (typically: C:\php\).
Edit the ini file.
Update the following settings:
The following default settings may be different to those listed depending on the PHP version (the following is based on PHP 5.3.xx).
Field Name | Default Setting | Required Setting |
|---|---|---|
safe_mode | Off | Off |
max_execution_time | 30 | 60 |
error_reporting ** | E_ALL | E_ERROR & E_WARNING |
register_globals | Off | Off |
register_long_arrays | Off | Off |
register_argc_argv | Off | Off |
auto_globals_jit | On | On |
magic_quotes_gpc | Off | Off |
extension_dir | "./" | "C:\php\ext" |
enable_dl | On | Off |
cgi.force_redirect * | 1 | 0 |
fastcgi.impersonate * | 1 | 1 |
SMTP | localhost | [server name or IP address] |
smtp_port | 25 | [server's smtp port number] |
sendmail_from * | me@example.com | [administrator@acmehomes.com.au] |
odbc.defaultlrl | 4096 | 65536 |
session.auto_start | 0 | 0 |
* If a semi-colon (;) appears at the beginning of the line, users MUST remove it. | ||
Find the Windows Extensions section of the ini file.
Add the following extensions:
;extension=php_sqlsrv.dll (including the leading semi-colon(;))
;extension=php_sqlsrv_ts.dll (including the leading semi-colon(;))
extension=ixed\ixed.win
Uncomment the following extension (by removing the leading semi-colon (;)):
extension=php_gd2.dll
Save the php.ini file.
Close the php.ini file.
Step 5 - Configure Firewall Settings
If the Framework Product Suite Web Portal Web Server is separated from the Framework database server by a network firewall (recommended), your firewall may require configuration of the following ports:
Microsoft SQL Ports
To configure the Firewall Ports, please consult your Microsoft documentation for more information.
Port | Required | Firewall Changes |
|---|---|---|
1433 | Compulsory | Microsoft SQL ODBC. |
53 | Optional | The DNS port is not required by Framework however is sometimes enabled to address network communications performance issues. |
Step 6 - Install Microsoft SQL Server Native Client
Installs the native client for Microsoft SQL Server on the web server. The native client driver is required to connect the web portal software to the Framework ECM database.
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Database - MSSQL 2008\Microsoft - SQL Server Native Client Driver\
Double-click the relevant setup file. The Microsoft SQL Server Native Client installation will begin.
Click the Next The Licence Agreement step will be displayed.
Select I accept the terms in the licence agreement.
Click the Next The Registration Information step will be displayed.
Enter the registration details.
Click the Next The Feature Selection step will be displayed.
Click the Next The Ready To Install the Program step will be displayed.
Click the Install button to begin the installation.
Click the Finish button to complete the installation.
Step 3 - ODBC DSN Configuration
Provide Framework with the connection to read and write from the database.
ODBC DSN Configuration - Framework ECM
Open Data Sources (ODBC).
Select the System DSN
Click the Add The Create New Data Source dialog will be displayed.
Select SQL Native Client for the SQL Server version being used.
Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.
Enter the following details:
Name: FworkSQLECM
Description (optional): Enter a description for the database connection. For example, Framework ECM.
Server: Select the SQL Server from the Server drop-down list.
OR
Enter the SQL Server name.
If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS
Click the Next
Click the Next
Tick Change the default database to.
From the drop-down list select: FworkSQLEcm
Click the Next
Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.
Click the Test Data Source...
If successful, click the OK
Click the OK The ODBC Microsoft SQL Server Setup dialog will close.
Click the OK The Data Sources (ODBC) dialog will close.
ODBC DSN Configuration - Framework Licence
Open Data Sources (ODBC).
Select the System DSN tab.
Click the Add button. The Create New Data Source dialog will be displayed.
Select SQL Native Client.
Click the Finish button. The Create a New Data Source to SQL Server dialog will be displayed.
Enter the following details:
Name: FworkSQLLic
Description (optional): Enter a description for the database connection. For example, Framework Licence.
Server: Select the SQL Server from the Server drop-down list.
OR
Enter the SQL Server name.
If there is an error following Step 8, change the server name above to: \[server name]\SQLEXPRESS.
Click the Next button.
Click the Next button.
Tick Change the default database to.
From the drop-down list select: FworkSQLLic
Click the Next button.
Click the Finish button. The ODBC Microsoft SQL Server Setup dialog will be displayed.
Click the Test Data Source... button.
If successful, click the OK button.
Click the OK button. The ODBC Microsoft SQL Server Setup dialog will close.
Click the OK button. The Data Sources (ODBC) dialog will close.