version date: 12th june 2017 · 2017-08-30 · 4.6.2 push notification setup ip address/ host name...
TRANSCRIPT
Version: 1.4.3
Date: 12th June 2017
Author: Nizam Mohammed
CONTENTS
1 Overview ........................................................................................................................................................ 4
2 Pre-Requisites ................................................................................................................................................. 4
2.1.1 Operating Systems - Enterprise Use ................................................................................................... 4
2.1.2 Operating Systems - Small Teams Only............................................................................................... 4
2.1.3 Database ........................................................................................................................................... 4
2.1.4 FIPS Security ...................................................................................................................................... 4
2.1.5 Hardware Specifications ....................................................................... Error! Bookmark not defined.
2.1.6 Software Prerequisites....................................................................................................................... 5
2.1.7 Ports and protocols ........................................................................................................................... 5
2.1.8 Supported Browsers .......................................................................................................................... 5
2.1.9 Optional Requirements (For Optimized Performance) ........................................................................ 5
3 Prolaborate setup steps - Outline .................................................................................................................... 6
4 Setup Steps – Explained .................................................................................................................................. 6
4.1 Run Setup as administrator .................................................................................................................... 6
4.2 License agreement ................................................................................................................................. 7
4.3 Setup Installation Mode ......................................................................................................................... 7
4.4 Setup Installation Path ........................................................................................................................... 8
4.5 Setup SQL Server and Prolaborate Database .......................................................................................... 8
4.6 Prolaborate Web App Setup................................................................................................................... 9
4.6.1 IIS server setup .................................................................................................................................. 9
4.6.2 Push notification setup .................................................................................................................... 10
4.6.3 Prolaborate administrator credentials setup .................................................................................... 10
4.7 Review Details ..................................................................................................................................... 11
4.8 Setup Complete ................................................................................................................................... 11
5 Get started with Prolaborate......................................................................................................................... 12
5.1 Activate prolaborate ............................................................................................................................ 12
5.2 Add reserved users .............................................................................................................................. 14
5.3 Active Directory Configuration ............................................................................................................. 15
5.3.1 SERVER AND Port values .................................................................................................................. 16
5.3.2 MASTER User name, Password AND DOMAIN .................................................................................. 16
5.4 Configure Prolaborate SMTP to enable notifications ............................................................................ 17
5.4.1 Port ................................................................................................................................................. 18
5.5 Add EA Repository ............................................................................................................................... 18
6 Appendix ...................................................................................................................................................... 20
6.1 Setup sql server ................................................................................................................................... 20
6.1.1 Enable SQL Server Authentication .................................................................................................... 20
6.2 Install .NET 4.5 Framework .................................................................................................................. 22
6.3 Enable Internet Information Server (IIS) ............................................................................................... 22
6.3.1 Configure Windows Features to Turn on Internet Information Server............................................... 22
6.3.2 Start IIS Server ................................................................................................................................. 24
6.4 Register ASP .NET libraries ................................................................................................................... 26
6.5 Disable FIPS Security ............................................................................................................................ 26
Prolaborate – Setup Guide
4 Overview | Prolaborate
1 OVERVIEW
This document describes the steps involved in setting up Prolaborate©. The document also describes the specific
environment settings required in the database, Webserver and other supporting software.
2 PRE-REQUISITES
2.1.1 OPERATING SYSTEMS - ENTERPRISE USE
Windows Server 2008 - SP2 Required
Windows Server 2008 R2 - SP1 Required
Windows Server 2012
Windows Server 2012 R2
Windows Server 2016 Not Recommended
2.1.2 OPERATING SYSTEMS - SMALL TEAMS ONLY
Windows 7 – SP1 Required
Windows 8 +
Windows 10 Not Recommended
2.1.3 DATABASE
SQL Server 2008 R2 and above (recommended)
SQL Server Express 2008 R2 and above
Recommended to use ‘SQL Server Authentication’ mode.
2.1.4 FIPS SECURITY
Recommended to disable FIPS
2.1.5 HARDWARE SPECIFICATIONS
The following is a guideline only and deployment will depend on usage and other environmental factors.
Memory 4.0-8.0GB depending on usage CPU 2.4 GHz x2 Disk (Operating System) 15 GB
5 Pre-Requisites
Disk (Database) 5 GB
2.1.6 SOFTWARE PREREQUISITES
The prerequisites for installing Enterprise Tester are:
IIS 7.5 and above
Microsoft .Net Framework 4.5 and above.
If you install IIS after the .Net Framework you will probably need to register ASP.Net for use with IIS
2.1.7 PORTS AND PROTOCOLS
The port number to be configured with SMTP and Active Directory should be opened on Firewall
Outbound rules on the network as well as the Machine where Prolaborate is installed.
SMTP (Default SSL Port: 465)
Active Directory (Default Port: 389)
2.1.8 SUPPORTED BROWSERS
The following browsers are compatible:
Chrome (recommended)
Firefox
Safari
Internet Explorer 10 or above
A minimum screen resolution of 1280x720 is required for best use of Prolaborate.
2.1.9 OPTIONAL REQUIREMENTS (FOR OPTIMIZED PERFORMANCE)
Active Directory Access for Live Sync
SMTP configuration. (Access to SMTP Port and SMTP mail server)
There may be other configurations required depending on specific environmental factors. Please contact support.
6 Prolaborate setup steps - Outline
3 PROLABORATE SETUP STEPS - OUTLINE
Figure 1 Prolaborate setup steps
4 SETUP STEPS – EXPLAINED
4.1 RUN SETUP AS ADMINISTRATOR
To start the installer, administrator privilege is required. Run the “Setup.exe” as administrator.
Run the Installer as Administrator
Accept Terms in License Agreement
Choose Installation Path
Provide Database Details
Provide WebAppliation
DetailsReview Installation
Summary
Setup Complete
7 Setup Steps – Explained
4.2 LICENSE AGREEMENT
Accept the terms in license agreement to proceed installation.
4.3 SETUP INSTALLATION MODE
Choose the installation mode to proceed.
Automated Installation: Includes installation of Prolaborate components and required configurations (IIS
setup, Database setup, Registry entry and configuration file setup).
Manual Installation: Prolaborate components will be installed but configuration (IIS setup, Database
setup, Registry entry and configuration file setup) needs to be done manually.
8 Setup Steps – Explained
4.4 SETUP INSTALLATION PATH
Choose the path for installing Prolaborate
4.5 SETUP SQL SERVER AND PROLABORATE DATABASE
SQL Server 2008 or above is required for Prolaborate to operate. A full SQL Server setup or an Express edition
setup will suffice.
Valid SQL server details (Database Host name, Username, Password and Database name) should be given to
proceed the installation.
Choose the installation mode to proceed,
Fresh Installation: Create Prolaborate scheme for the provided database.
Database already exists: No operation will be performed in database.
9 Setup Steps – Explained
Provide the SQL server details
4.6 PROLABORATE WEB APP SETUP
4.6.1 IIS SERVER SETUP
Port Number: Ensure Port is available and opened in firewall settings.
10 Setup Steps – Explained
4.6.2 PUSH NOTIFICATION SETUP
IP Address/ Host name : Machine IP or Machine name should be given
Port: Ensure Port is available and opened in firewall settings.
4.6.3 PROLABORATE ADMINISTRATOR CREDENTIALS SETUP
Provide the credentials for the Prolaborate administrator user account.
11 Setup Steps – Explained
4.7 REVIEW DETAILS
4.8 SETUP COMPLETE
Once the setup is done, web browser will be opened with the site URL provided in web application setup step.
The above step completes Prolaborate Setup. To test installation, please login with credentials you have provided.
12 Get started with Prolaborate
5 GET STARTED WITH PROLABORATE
5.1 ACTIVATE PROLABORATE
Log in into Prolaborate Using Credential you have provided.
Initially ‘License Management’ page will be open and asks for Product Key.
Click ‘Choose File’ button to upload the Product Key.
Click ‘Activate Offline’ option to activate the Prolaborate.
License Management
Activate Prolaborate
Manage Reserved User
Add Reserved Users
Active Directory Integration
Configure Active Directory Settings
SMTP Configuration
Configure SMTP Server details
Configure Email Account
Add Repository
Manage Users
Configure Sections
Configure Permissions
13 Get started with Prolaborate
After Successful activation, ‘License Management’ page will look like this with Verified symbol on right side of the
Page.
14 Get started with Prolaborate
5.2 ADD RESERVED USERS
Choose Setting License Reserved Users.
In ‘Manage Reserved Users’ page Choose ‘Add Reserved Users’ option to add the user.
15 Get started with Prolaborate
In the Add Reserved Users Screen, choose ‘Select users From Prolaborate’. Select the User and click ‘Add’ option to
proceed.
After adding Reserved User log out the Prolaborate and Log in again to proceed.
5.3 ACTIVE DIRECTORY CONFIGURATION
This document will outline how to work out the values needed when configuring connection between Prolaborate
& Active Directory Settings.
Key configuration attributes
Name – Name for Active Directory Configuration
Server – Active Directory Server
Port – Port to Access Active Directory Server
SSL – Enable if connection over SSL is required
Domain – Active Directory Domain
Master User / Master password – Credentials for Active directory configuration.
Access: Settings ->Portal Active Directory.
16 Get started with Prolaborate
Figure 2 Active Directory Settings
5.3.1 SERVER AND PORT VALUES
Enter in the DNS name of your Active Directory server. If you don't have a DNS name configured, you can use the
IP address.
The default port for connecting to AD is 389. If you have this set to something else, please change this
value. This port should be opened on Firewall Outbound rules on the network as well as the Machine where
Prolaborate is installed.
5.3.2 MASTER USER NAME, PASSWORD AND DOMAIN
These values are required to login to your Active Directory instance. You need to specify an account that is able to
browse and search your AD tree.
The Domain indicates the primary Active Directory Domain to retrieve users and user groups.
17 Get started with Prolaborate
Figure 3 Active Directory Configuration
5.4 CONFIGURE PROLABORATE SMTP TO ENABLE NOTIFICATIONS
To enable Prolaborate to send notifications to collaborators, you need to configure an SMTP mail server in
Prolaborate.
Note: For all of the following procedures, you must be logged in Prolaborate super administrator
Access: Settings Portal SMTP Settings.
Figure 4 SMTP Settings
18 Get started with Prolaborate
Configure the following fields to complete SMTP setup
Server – SMTP Server
Port – SMTP Port
Encryption Type – Choose between SSL, TLS, Auto
User ID / Password – Account to be used to send notifications (Optional)
From Address (E-Mail) – Email to be used to send notifications. (This could be same as UserID/ or a
different alias if required)
Figure 5 Prolaborate SMTP Settings
5.4.1 PORT
The port should be opened on Firewall Outbound rules on the network as well as the Machine where
Prolaborate is installed.
5.5 ADD EA REPOSITORY
Choose ‘Add Repository option’ in Repositories page to add EA Repository to the Prolaborate.
In the Add New Repository screen, click ‘Choose File’ button to Upload the EA Repository.
Provide the following Details.
Repository Name – Name for EA Repository. (Mandatory)
Description – Information about EA Repository. (Optional)
Number of User – Number of Access to Repository. (Mandatory)
Enable Cache – Option to Enable or disable cache for Repository.
Active—Option to Activate or Deactivate the Repository. Enabled by default.
Authentication required – Enabling this option requires Authentication to Access Repository.
Click Add Repository option to proceed.
19 Get started with Prolaborate
Added EA Repository will be listed in Repositories Page and it shows ‘Checking Status’ .
Now open the ‘Interactive Service Detection’ and add the EA key in Licence Management Popup and Click OK to
Activate.
20 Appendix
Repository will be available after activation.
6 APPENDIX
6.1 SETUP SQL SERVER
SQL Server 2008 or above is required for Prolaborate to operate. A full SQL Server setup or an Express edition
setup will suffice.
6.1.1 ENABLE SQL SERVER AUTHENTICATION
‘SQL server authentication’ must be enabled and an admin account must be created. The following settings must
be accomplished
Step 1. Create a new user by using ‘New Login’ option under Security -> Login section
Step 2. Uncheck ‘Enforce password policy’
Step 3. Set Default Database to ‘Prolaborate’
21 Appendix
Figure 6 - SQL Server - New User Creation
Step 4. Configure ‘Server Roles’, grant access to all admin privileges.
Figure 7 SQL Server - Server Roles
Step 5. Configure ‘User Mapping’, map ‘Prolaborate’ database to the new user defined in previous steps.
22 Appendix
Figure 8 SQL Server - User Mapping
6.2 INSTALL .NET 4.5 FRAMEWORK
Setup Microsoft .NET 4.5 Framework. Download the latest Microsoft .NET Framework 4.5 from
https://www.microsoft.com/en-au/download/details.aspx?id=30653
6.3 ENABLE INTERNET INFORMATION SERVER (IIS)
6.3.1 CONFIGURE WINDOWS FEATURES TO TURN ON INTERNET INFORMATION SERVER
Step 1. Under Control Panel Programs Programs and Features Turn Windows features on or off.
Step 2. In Windows Features, under Internet Information Services select the following categories and options
as shown in the screenshots shown in Figure 5 IIS Settings (Windows Features)
a. Web management Tools
b. World Wide Web Services
c. Health and Diagnostics
d. Performance Features
e. Security
23 Appendix
Figure 9 IIS Settings (Windows Features)
24 Appendix
6.3.2 START IIS SERVER
Step 1. To start the server, type “inetmgr” in the Run Window and click “Ok” Button.
Figure 10 Start Internet Information Services Manager
Step 2. In the “Internet Information Service Manager”, select the Local host and click on the “start” button.
Figure 11 Start IIS Server
Step 3. Expand the server and under the “sites”, find “Default Web Site” and click the “start” button.
Figure 12 Start Default Web Site
25 Appendix
Step 4. After starting the site. Select “Browse” button. It should open the default website on the browser.
Figure 13 Browse Default Website Properties
Step 5. Ensure Internet Information Services landing page is displayed in the default web browser.
Figure 14 IIS Server Landing page
26 Appendix
6.4 REGISTER ASP .NET LIBRARIES
Step 1. Register ASP .NET libraries (for OSes other previous to Win 8.1)
a. Run Cmd prompt in admin mode
b. 32-bit Windows
i. %windir%\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis.exe –i
c. 64-bit Windows
i. %windir%\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe –i
d. Restart IIS Server (using IIS Manager)
6.5 DISABLE FIPS SECURITY
Steps to Disable FIPS Mode,
Step 1. Press Windows Key+R to open the Run dialog.
Step 2. Type “gpedit.msc” into the Run dialog box (without the quotes) and press Enter.
Step 3. Navigate to “Computer Configuration\Windows Settings\Security Settings\Local Policies\Security Options” in the Local Computer Policy.
27 Appendix
Step 4. Locate the “System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing” setting in the right pane and double-click it.
Step 5. Set the setting to “Disabled” and click “OK.”
Step 6. Restart the computer.