Upgrade Instruction from V3.5/V3.6/V3.7 to V4
Introduction
In this guide, we will take a look at the steps involved in upgrading your current installation of Prolaborate version 3.7 to latest version.
Prerequisites
For a smooth installation, it is recommended to upgrade your current installation of Prolaborate to version “V3.7”, if not done already, Please follow this steps to upgrade Prolaborate to version from “V3.2”to “V3.7”. Click here to know more.
Decision Gate
Check the following points and decide whether you are fine/ready to go ahead with the upgrade.
- EA Database
- Password Update
- SAML Integration
- Review Release notes
- Upgrade Prolaborate to V3.5
- Pro Cloud Server
As of now, Prolaborate supports EA repositories hosted on MS SQL and MySQL database servers only. Support for Postgres and Oracle databases are in the pipeline.
The password algorithm has been upgraded for enhanced security.
If you are using Prolaborate’s inbuilt User Management capabilities (and not integrated with AD or SAML SSO), the password will be reset for all users.
You should proceed with latest version only if you can handle the impact.
A quick update will be needed after the migration if you are using SAML integration of Prolaborate.
Proceed with latest version if the SSO team understands the change and is available.
Review the complete release notes to confirm all the features that you use right now are already released in latest version.Here is the link to a summary of the release.
For a smooth installation, it is recommended to upgrade your current installation of Prolaborate to version 3.5, if not done already. Learn more here.
Pro Cloud Server should be upgraded to version 5.0.105, if not done already. Click here to download the installer.
V4 Upgrade Plan
Once the decision is made to go ahead with latest version, you need to plan for it. This section will help you with the same.
Schedule Upgrade
Check out the details of this planning section and finalize the date of the upgrade.
Communicate
Inform the business stakeholders about the Prolaborate latest version upgrade and the changes in advance.
You can inform them about the date and time of the upgrade, and the new features.
Installation Plan
The plan should consider the following activities as a minimum:
- Backup - A backup of Prolaborate Application Server and Prolaborate database. This will be needed if the validation fails
- Installation - Review Installation steps thoroughly so that there are no surprises on the day of installation.
- Post Installation Steps
- IT team would be needed for enabling HTTPS in Prolaborate. Check the Post Installation section below for more details.
- SSO team will be needed to complete the configuration of Prolaborate with SAML SSO
- The architecture team would have to reset the Passwords and inform the users
- Validation - Once Prolaborate latest version is installed and configured, it should be validated to
ensure
success. Create a simple checklist of features that you use majorly. You can quickly check them
out and
validate the new version.
- Success - Once the installation is validated to be a success, stakeholders need to be notified again
- Failure - If validation is not successful, installation should be reverted. Create the required steps to do the same
Stakeholder Summary
| Activity | Stakeholders |
| Communications | Architecture team |
| Backups | IT team |
| Prolaborate Upgrade | IT team |
| Post Installation - User Update | Architecture Team |
| Post Installation - SSO Update | SSo Team |
| Post Installation – SSL update and other steps | IT Team |
| Validation | Architecture Team |
| Rollback | IT team |
Installation
Follow these steps on the day of the upgrade.
Note:
- Stop existing Prolaborate Service in Task Manager before initiating the upgrade process.
Run Installer
Run Setup.exe as administrator.
Click on Next
Accept EULA
Check the box to accept the terms and click Next
Set Installation Path
Select a path to install Prolaborate. (Create a separate folder for V4 installation for safety purposes)
Important Note: Please use an alternate folder path rather than the one used for version 3 to avoid data conflicts. Also, this helps in rollback if needed.
Select Database Server
Choose the Database server using which the Prolaborate database is hosted. Then choose Run Schema.
Provide Database Details
Fill in the Prolaborate database details.
Version Validation
Improved version compatibility check during upgrade. If the previous version of Prolaborate is less than 3.5.0, the application throws a warning during the upgrade and halts the upgrade process.
Database Backup
Please ensure a backup of the database is taken. This step is just a gentle reminder and does not do anything.
Configure Prolaborate
Enter the IP address or domain name in Host. Enter a port that is not in use and open in Firewall. Port 443 is recommended. Enter an email address. This user will be made the super admin of Prolaborate.
Review and Install
Review the information and click Install
Note:
- Write down the credentials or take a screenshot of this page for later reference.
Once the installation is completed successfully, the following page will appear. Click Finish
Post Installation Steps
Internet Information Service (IIS) Support
The V4 application does not require an IIS manager to perform in Version 4. We upgraded the Config file, and it completed all of the manual work that required manual installation of IIS, and the user may access the web application through the domain that was specified during the installation phase Configure Prolaborate.
Note:
- Please enter the Domain name in the URL
http://(domainname)
Ex: http://localhost
Run Data Migrator
Data Migrator helps in migrating the data from V3 to V4. Existing configurations include dashboards, chart widgets, report widgets, discussions, reviews, users, modeling languages, etc can be transferred with the help of Data Migrator.
To initiate the migration process, go to the Prolaborate installation folder (For example, C:\Program Files (x86)\Prolaborate\ProlaborateDataMigration). Right click on “DataMigrator.exe” and choose ‘Run as Administrator’.
Note:
- Data migrator will not transfer data from Database to database only transfer the application assests and configuration details.
Update Password
There are 2 ways how you can reset the password.
- If the users are fewer, the admin can set a Temporary password from the Users and License Management page. The users can then use the temporary password and reset their password
- If the users are more, you can inform the users to use the Forgot Password link to reset the password.
Note:
- Mailer should be enabled to do #2.
Protocol Update
Note:
- To change the protocol from https to http and vice versa, please follow the same steps which is mentioned below.
- Unlike V3, V4 requires a unique port. Please enter a unique port or the user can set up an external load balancer to handle this if multiple applications need to operate HTTPS on the same port while using a different domain name.
Users who want to run their application using HTTPS protocol in the sense have to do the following steps manually.
Please use this below-mentioned path to get Prolaborate Management
C:\Program Files (x86)\ProlaborateV4\ProlaborateManagement
Run Prolaborate Management as a Administrator.
Click Manage Configuration
Select WebApp
Choose SSL certificate using browse icon
Enter the respective password for the certificate.
Select Use Https check box.
Click Save.
OIDC Update
After installing Prolaborate, users must do the following steps in order to access the Application over HTTPS.
Open the application by entering the admin login credentials at the URL listed below.
Note:
- Please enter the Domain name in the URL
http://(domainname)/Applications/Admin
Click the Edit button.
Change Protocol into HTTPS and also change the Respective Port number. Then Click Save Button.
Now that information is automatically updated in the OIDC table from the prolaborate database.
Configure SAML SSO
Following the upgrade, Prolaborate V4’s Application Base URL and Assertion consumer URL of Prolaborate V4 will be different from Prolaborate V3. Admin must change or modify the Prolaborate V4 Service Provider configuration details at the current SAML application from your SAML provider in order to ensure smooth execution.
Service Provider configuration
Copy the Service Provider configuration details from Prolaborate and paste in the respective fields at the SAML application as described in the image below.
Identity Provider Configuration
Now, configure Prolaborate to link with the SAML application. Copy the URL’s from the SAML Application and paste them in the respective fields under Identity Provider Configuration as shown in the image below.
In V4, we made it easier to map the attributes from the Prolaborate UI.
Map the attributes from the SAML SSO settings page, upload the SSL certificate and save the changes.
Attribute Mapping will be pre-filled with default values in SAML Single Sign-On page and they cannot be edited.
If required, users can change the values by clicking the toggle button from Default to Custom. Then copy the Attributes & Claims values from the SAML Application and paste them in Prolaborate Attributes Mapping.
- firstname
- lastname
Support
In case of any questions, feel free to reach out to support@prolaborate.com