Upgrade Notes

Software version upgrades are included for all current Angelfish customers.

The upgrade retains all your existing report data.  

Please follow the recommendations in this article when upgrading your Angelfish instance(s).


Pre-Upgrade


DOWNLOAD THE INSTALLER

Please open a support ticket and let us know if you need the Windows or Linux installer.


BACKUP YOUR DATA DIRECTORY
If you have enough space, make a copy of the entire /data/ directory.

This isn't a required step, but having a backup lets you quickly recover from upgrade errors.


LINUX: RUN UPGRADE IN SCREEN
If you run Angelfish on Linux, run the upgrade in the screen utility.  It avoids unnecessary problems, like network issues.




Post-Upgrade


CHECK THE UPGRADE LOG
The /log/ directory under the Angelfish Installation Directory contains a file that stores the console messages from the upgrade.  If any errors were encountered during the upgrade, they will be listed here.  The filename is "upgrade-<version>.log"

If you see any errors in the upgrade log, please open a support ticket - we're here to help!


WHAT'S NEW IN v2.4?
This article covers key changes when upgrading from v2.33 and earlier:

Help Article: What's New in v2.4?


ADMIN TASKS: FIRST LOGIN
Look at the Settings section in this article:



ENABLE ASK YOUR ADMINS
The AYA feature lets Global Admins delegate management of Profiles to Collection Managers.  We highly recommend using this feature.



CONFIGURE INTERNAL SEARCH REPORTS
Angelfish has a set of Internal Search reports that show you how users interact with the search function on your website.  These reports are configured in the Settings tab of each Profile, in the Internal Search section.


If you use the search term parameter in the Page Query Parameters field, you can remove it - it's no longer necessary.


ENTER A CLICKABLE PAGE PREFIX
The "Clickable Page Prefix" field in the Settings tab of each Profile makes Pages & Documents clickable in the reports.  Very handy.


PERUSE ADVANCED INFO & TIPS
Learn some new admin tips!  For example: the copy button is an underused gem.

Help Article: Advanced Info & Tips


DELETE THE "SAMPLE PROFILE"
The Sample Profile is replaced by the "Demo Profile" in v2.4+.  We recommend deleting the Sample Profile so it doesn't count against your Profile Limit.


Next Steps


BROWSE THE NEW HELP CENTER
You're already here!



UPDATE ANGELFISH.JS
If any of your Profiles use the AGF Tracking Method, now is a good time to update angelfish.js to the current version.  Older versions of angelfish.js don't work with some of the new features in v2.4+.

You can grab the current file here:



WAYS TO USE ANGELFISH
Creation date: 5/15/2022 10:15 PM      Updated: 1/25/2024 8:28 AM