Upgrading ReadyWorks in On-Premises or Self-Hosted Environments

Upgrading ReadyWorks to the latest version ensures you have access to new features, improvements, and security enhancements. This guide provides detailed instructions for ReadyWorks administrators with server access to perform an upgrade in on-premises or self-hosted environments.

Note: Before proceeding, please review the latest Release Notes to understand the changes in the new version. 

Prerequisites

• Administrator Access: Ensure you have server-level administrative privileges.
• Backup Tools: MySQL Workbench or a similar database management tool.
• Web Browser: Use Chrome or Edge for certain steps; Internet Explorer may not be compatible.
• Latest ReadyWorks Package: Obtain the new version’s ZIP file from the official source or your ReadyWorks account manager.

Upgrade Steps

1. Confirm Current Version and Remove Database Views

1. Log into the ReadyWorks Front End:

   • Open your web browser and navigate to the ReadyWorks login page.
   • Enter your administrator credentials.

2. Navigate to Configuration Options:

   • Go to the top menu and select Configuration.
   • Click on Options.

3. Remove Existing Database Views:

   • Click on Remove Views.
     • Note: This step drops existing database views to prevent conflicts during the schema update.

2. Backup the www Directory

1. Access the Server:

   • Log into the server where ReadyWorks is installed.

2. Locate the www Folder:

   • Navigate to the ReadyWorks installation directory, typically found at C:\ReadyWorks\www or a custom installation path.

3. Create a Backup:

   • Copy the entire www folder.
   • Paste it in the same directory or a safe backup location.
   • Rename the copied folder to include the current version number, e.g., www_0603.

3. Backup the ReadyWorks Database

1. Open MySQL Workbench:

   • Launch MySQL Workbench or your preferred database management tool.

2. Create a Self-Contained Backup:

   • Connect to the ReadyWorks database.
   • Select the database and choose the option to export it.
   • Save the backup as a self-contained file.
     • Note: This backup is precautionary and may not be used during the upgrade.

3. Handle Export Dump Errors (If Any):

   • If you encounter export dump errors, refer to the [process to resolve export errors] (insert link or reference to the process here).

4. Log Out of the ReadyWorks Front End

• Ensure that all users are logged out to prevent data inconsistencies.
• Close all browser sessions connected to ReadyWorks.

5. Prepare the New Version Files

1. Extract the New Version ZIP File:

   • Locate the downloaded ZIP file of the new ReadyWorks version.
   • Right-click the ZIP file and select Extract All.
   • Choose a temporary location for the extracted files.

2. Verify Extracted Files:

   • Ensure all files and folders have been extracted successfully.

6. Update the www Directory with New Files

1. Delete Old Files:

   • Navigate back to the original www folder (C:\ReadyWorks\www).
   • Delete all contents within the www folder.
     • Warning: Ensure you have completed the backup in Step 2 before deleting.

2. Copy New Files:

   • From the extracted new version folder, select all files and folders.
   • Copy and paste them into the now-empty www folder.

7. Restore Configuration Files

1. Copy Configuration Files from Backup:

   • From your backed-up www folder (www_0603), locate:
     • database.php
     • client_config.php

2. Paste Configuration Files into New www Folder:

   • Copy these two files into the new www directory.
   • Overwrite any existing files if prompted.
     • Note: The existing edit_me database and config files in the new version can remain unchanged.

8. Update the Database Schema

1. Edit the client_config.php File:

   • Open client_config.php from the new www folder in a text editor (e.g., Notepad++).

2. Change Schema Update Flag:

   • Locate line 22, which should read:

     $update_schema = "False";
     

   • Change the value to "True" so it reads:

     $update_schema = "True";
     

   • Save and close the file.

9. Refresh the Front End to Apply Schema Updates

1. Open the ReadyWorks Login Page:

   • In your web browser, navigate to the ReadyWorks URL.

2. Trigger Schema Update:

   • Refresh the page.
   • The system will detect the schema update flag and begin updating the database schema.
     • Note: This process may take several minutes. Do not close the browser during the update.

10. Log In and Confirm New Version

1. Log Back into ReadyWorks:

   • Use your administrator credentials to log in.

2. Verify the Version:

   • Navigate to Configuration > About or a similar section that displays version information.
   • Confirm that the displayed version matches the new version number.

11. Recreate Database Views

1. Remove Old Views Again:

   • Go to Configuration > Options.
   • Click on Remove Views.

2. Create New Views:

   • Still in Options, click on Create Views.
     • Note: Use Chrome or Edge browsers for this step, as Internet Explorer may not be compatible.

12. Verify System Functionality

1. Check Custom Reports:

   • Navigate to the Reports section.
   • Ensure all custom reports are accessible and displaying data correctly.

2. Confirm Environment Name and Logo:

   • Verify that the environment name and logo are correctly displayed on the dashboard and login page.

3. Test Attachments:

   • Access any files or attachments within the system to confirm they are working.

4. Review Cron Jobs:

   • Go to Admin Options > Cron Jobs.
   • Ensure scheduled tasks are listed and configured correctly.

5. Check ETL Processes:

   • Navigate to the ETL module.
   • Verify that all ETL processes are online and functioning.

13. Confirm Schema Update Flag Reset

1. Reopen client_config.php:

   • Open the file from the www directory.

2. Verify Schema Update Flag:

   • Ensure line 22 has automatically reverted to:

     $update_schema = "False";
     

   • Note: The system resets this flag after successfully updating the schema to prevent unintended future updates.

14. Send Latest Release Notes to Stakeholders

• Download the Release Notes:

  • Access the latest Release Notes from [Placeholder for Release Notes Link].

• Review Changes and Updates:

  • Familiarize yourself with new features, bug fixes, and any deprecated functionalities.

• Distribute to Relevant Parties:

  • Share the Release Notes with your team, users, or stakeholders to inform them of the updates.

Additional Information

• Handling Export Dump Errors:

  • If you encountered errors during the database backup, refer to the specific troubleshooting guide or contact ReadyWorks support.

• Post-Upgrade Monitoring:

  • Keep an eye on system performance and logs for any anomalies.
  • Encourage users to report any issues they experience.

• Support:

  • For assistance, contact ReadyWorks support through your designated support channel.

Conclusion

You have successfully upgraded ReadyWorks to the latest version in your on-premises or self-hosted environment. Regularly updating your system ensures optimal performance, security, and access to new features that enhance your organization’s operational efficiency.

Disclaimer: Always ensure you have adequate backups before performing system upgrades. This guide assumes that you have the necessary administrative privileges and familiarity with ReadyWorks system administration.