Updating an Install Manually With a Patch File
Simple Step-by-Step Instructions
๐ Pre-Upgrade Checklist
-
[ ] Coordinate upgrade date with customer
-
[ ] Schedule training session if needed
-
[ ] Review release notes for changes
-
[ ] Backup production database (licensed customers only)
๐ง Step 1: Enable Maintenance Mode
Location: /var/www/pcr360/test/public/index.php
-
Open
index.phpfile -
Find the line:
APPLICATION_MAINTENANCE = false; -
Change it to:
APPLICATION_MAINTENANCE = true; -
Save and upload the file
Result: Only PCR staff can access the application - customers see "Maintenance Mode" screen.
๐ Step 2: Extract Patch Archive
Extract the patch file:
-
Navigate to the patch file location
-
Extract the
.tar.gzfile:tar -xzf 2024.2.4-2025.1-MySql.tar.gz -
This creates a folder named
2024.2.4-2025.1-MySql
๐ Step 3: Update Application Files
Source: Extracted โPatchesโ folder
Destination: Customer server, usually /var/www/pcr360/<environment>
Files to Copy:
Copy ALL files and folders from inside the Patches folder
-
After extracting Everything from the archive file
-
All subfolders and files inside the
Patchesdirectory should be copied -
The entire patch contents should be copied to the base of the PCR-360 environment. This is generally located at either:
-
/var/www/pcr360/test -
/var/www/pcr360/prod
-
๐ Step 4: Deleted Files
Check for a deletes.txt file from the patch:
-
Open
controllers/controllers.txtfrom the patch -
If the file is empty or doesn't exist, no files need to be deleted
-
If the file contains patches, each file should be removed from the environment
-
This is generally located at either:
-
/var/www/pcr360/test/<path_to_deleted_file>.php -
/var/www/pcr360/prod/<path_to_deleted_file>.php
-
๐๏ธ Step 5: Run Database Updates
Location: SQL360 Repository โ Maintenance โ [Database Type] โ [Version]
Required SQL Files:
From the patch's sql/ folder, run these files in order of the version:
For version 2024.2:
-
sql/2024.2/2024.2_default.sql -
sql/2024.2/2024.2_archive.sql -
sql/2024.2/2024.2_metadata.sql
For version 2025.1:
-
sql/2025.1/2025.1_default.sql
Run these commands in order:
-
Execute each .sql file in your database management tool
-
Run them in the order of the versions
-
Make sure to run ALL files for each version
๐ Step 6: Run Custom Controllers
Check the controllers.txt file from the patch:
-
Open
controllers/controllers.txtfrom the patch -
If the file is empty - no custom controllers to run
-
If the file contains URLs - run each controller URL in your browser
-
Run them in the order listed in the file
๐ Step 7: Update System Data
Run these URLs in your browser (append to customer's installation URL):
-
Update Menu:
/cron/db/update-menu -
Reload Lists:
/cron/db/reload-lists -
Reload Import Types:
/cron/db/reload-import-record-types
๐๏ธ Step 8: Rebuild Views
Run these URLs in order:
-
Rebuild MT-Views:
/update/create/mt-views -
Rebuild Views:
/update/create/views
โ
Step 9: Validate Database
Run these validation checks:
-
Main Validation:
/update/validate/ -
SQL Validation:
/update/validate/sql -
Metadata Validation:
/update/validate/metadata -
Archive Validation:
/update/validate/archive
If any validation generates SQL output, run that SQL in your database.
๐ฐ Step 10: Test Billing (If Applicable)
Only if this release contains billing changes:
-
Run a test bill before upgrade
-
Record the totals
-
Run a test bill after upgrade
-
Compare totals - they should match (unless billing changes were intentional)
๐ Step 11: Disable Maintenance Mode
Location: /var/www/pcr360/data/inbound/2024.2.4-2025.1-MySql/public/index.php
-
Open
index.phpfile -
Find the line:
APPLICATION_MAINTENANCE = true; -
Change it back to:
APPLICATION_MAINTENANCE = false; -
Save and upload the file
๐งช Step 12: Final Testing
-
[ ] Log into the application
-
[ ] Test a few grids and forms
-
[ ] Verify no obvious issues
-
[ ] Inform customer that upgrade is complete
๐ Step 12: Customer Communication
-
[ ] Notify customer that upgrade is complete
-
[ ] Update customer tracking document
-
[ ] Address any issues found by customer
-
[ ] Schedule production upgrade (if this was test environment)
๐จ Troubleshooting
Common Issues:
-
Error 500: Check that all required folders were copied correctly
-
Database Errors: Run validation steps again
-
Missing Features: Check if all SQL files were executed
-
Billing Issues: Compare pre/post upgrade totals
When to Get Help:
-
Contact manager if you need to deviate from these steps
-
Create Service Desk ticket for code-related issues
-
Consult team lead for complex database problems
๐ Additional Resources
-
Release Notes: Check for version-specific instructions
-
Internal Wiki: Look for upgrade-specific controller processes
-
Customer Tracking: Update documentation after each step
Remember: This guide covers the standard upgrade process. Some versions may require additional steps - always check the release notes and internal wiki for version-specific instructions.