How To: Use ChangeLog to apply Khaos Control Updates
Table Of Contents
Introduction
ChangeLog is a utility provided with Khaos Control that allows you to download and apply software updates to your system.
Updates are published to a secure online location and can be downloaded and installed without needing direct intervention from Khaos Control Support. This makes it quick and easy to keep your system up to date with the latest fixes, improvements and developments.
Before You Begin
Before running an update, make sure:
- All users are logged out of Khaos Control.
- No users have the splash screen or login screen open.
- You are using the correct ChangeLog shortcut for the database you want to update.
- You have access to both your Khaos Control database and the internet.
ImportantAlways launch ChangeLog using the shortcut provided in:K:\KeystoneSoftwareUTILS\ShortcutsThese shortcuts contain settings that tell ChangeLog which database to update.
Multiple Databases
If you have more than one Khaos Control database, such as:
- KHAOS
- KHAOS_TESTING
you must use the correct ChangeLog shortcut for the database you want to update.
What Does ChangeLog Do?
When you run the update wizard, ChangeLog completes two phases:
Phase 1: Download the Update
ChangeLog connects to the Khaos Control update server and downloads:
- A control file containing update instructions.
- A compressed update package containing program files and components.
Phase 2: Apply the Update
ChangeLog applies the downloaded changes to your Khaos Control system.
Applying an Update
Follow these steps to update your Khaos Control system.
Step 1: Log Everyone Out
Ensure all users are logged out of the Khaos Control system you are updating.
You can check who is logged in from the Help About screen within Khaos Control.
ImportantUsers who have only the splash screen or login screen open may not appear in the logged-in user list. These users must also close Khaos Control before the update can proceed.
Step 2: Open ChangeLog
Run the appropriate ChangeLog shortcut from:
K:\KeystoneSoftwareUTILS\ShortcutsStep 3: Start the Wizard
Select Wizard.
This is the only option most users need when applying updates.
Step 4: Begin the Update
Select Start.
An information window will display an overview of the update process.
Read the information and select OK to continue.
Step 5: Confirm Your Location
ChangeLog will ask whether you are running the update on the server itself.
- Select Yes if you are on the server.
- Select No if you are running the update from a workstation or client PC.
Step 6: Complete Phase 1
The update files will now download.
Once the download is complete, Phase 1 has finished.
Before continuing, it is a good idea to confirm that all users remain logged out.
Step 7: Start Phase 2
Select OK to begin applying the update.
Step 8: Allow the Update to Complete
ChangeLog will now apply the update.
The time required depends on:
- The size of the update.
- The speed of your system.
- The size of your database.
Step 9: Confirm Success
When the update completes successfully, you will see the message:
"Auto update complete"
Step 10: Allow Users Back Into the System
Once the update has finished, users can log back in and continue working.
Recommended Testing Procedure
If you have a KHAOS_TESTING database, we strongly recommend testing updates there before updating your live system.
This helps identify any issues before they affect day-to-day operations.
Preparing the Testing Environment
1. Log Users Out of KHAOS_TESTING
Ensure nobody is using the testing system.
Also check that no splash or login screens remain open.
2. Refresh the Test Environment
Run CopyLive2Test on the server.
This copies your live KHAOS database and application to KHAOS_TESTING.
Users can continue working in the live system while this process runs, but nobody should be logged into KHAOS_TESTING.
For more information, see: /?title=How_To:_Use_Shortcuts_to_run_Khaos_Control#CopyLive2Test
3. Apply the Update to KHAOS_TESTING
Run ChangeLog TESTING and install the update.
4. Test the Update
Log into KhaosControl KHAOS_TESTING and verify:
- The requested fixes are present.
- New developments work as expected.
- Existing processes continue to function correctly.
You may also wish to carry out regression testing on key business processes.
CautionIf your testing includes integrations such as:
- Card payment providers
- Couriers
- External services
make sure they are configured in test mode before performing any tests.
Updating the Live System
Once you are happy with the results in KHAOS_TESTING:
1. Log Everyone Out of the Live System
Verify that all users have exited Khaos Control.
2. Run ChangeLog
Launch the live ChangeLog shortcut and apply the update.
3. Verify the Update
Log into the live Khaos Control system and confirm everything is working as expected.
4. Resume Normal Use
Inform users they can log back in and continue working.
Frequently Asked Questions
Where should I run the update from?
You can run ChangeLog from:
- The server.
- Any workstation that can access both:
- The Khaos Control database.
- The internet.
For best results, we recommend performing Phase 2 directly from the server, although this is not mandatory.
How do I identify my server?
Your server is typically the machine that hosts the Khaos Control databases and shared application files.
If you are unsure which machine this is, please speak to your IT provider or system administrator.
Understanding the Update Notification Email
When a new Khaos Control update becomes available, you will receive an email containing:
- The new version number.
- Details of included fixes.
- Information about developments and enhancements.
- A summary of your outstanding support items.
Checking the Installed Version
After applying the update:
- Open Khaos Control.
- Look at the version number displayed in the top-left corner of the screen.
- Compare it with the version number shown in your update notification email.
If the versions match, the update has been applied successfully.
Troubleshooting
Update Errors
Occasionally an update may fail due to network restrictions, user access, or other environmental factors.
If an error occurs, review the message displayed by ChangeLog and consult:
If you are unable to resolve the issue, contact Khaos Control Support.
Network Errors
If your internet connection blocks ChangeLog from downloading updates during Phase 1, you may see errors such as:
- 302 (Defer)
- 404 (Not Found)
These errors usually indicate that network security settings are preventing access to the update service.
Information for Your IT Team
ChangeLog uses the following methods to connect to Khaos Control update services:
- HTTP/1.0
- FTP (occasionally, where required)
It communicates with:
This connection is used to:
- Update the ChangeLog application itself.
- Download the files required to install Khaos Control updates, including:
- A control file.
- A compressed update package.
If these connections are blocked, your IT provider may need to update firewall, proxy or web filtering rules.
Additional Information
The ChangeLog utility contains several administrative options that are used internally by support and system administrators.
For most customers, the only option required is Wizard, which handles the complete update process automatically.