Skip to main content

Upgrading to Central 1

This document is aimed at assisting Systems Administrators in the application of their first Jadu Central upgrade patch. Some basic information is also provided for any web developers wishing to extend the platform and how these should be managed through version controlled.

Before starting please review:

Patching Prerequisites

  1. Verify that the DB version is MariaDB 10.1 (LAMP only)
  2. Verify that the PHP version installed is PHP 7.2 (minimum 7.2.5)
  3. You have patched to at least CP 6.3.0 before applying this patch
  4. Take a backup of config/perceptive/constants.xml
  5. Take a backup of the /public_html/site/ folder (as the web development team may have customised some of these front end template scripts - see Git repository section of this document)
  6. Download the packages listed in the Required packages section below and upload to your web server(s).

Note: It is advisable that you manually add the Jadu Rescheduler task after installation & setup - this will only need to be done once if not already configured - steps have been provided in a later section for this.

Required Packages

  1. Central-1.0.0.zip = Jadu Central
  2. Central-1.0.0-Templates.zip = Full JCP Front end template bundle

Upgrade Process

We would recommend that this process be followed on your UAT environment first with a round of testing prior to application to PROD if currently actively using PROD at this time. Each step mentioned below is described in more detail afterwards:

  1. Turn off forms via Forms > Settings in the Control Center

  2. Windows only: Stop IIS

  3. Install Central 1.0.0 template package via Meteor (see below steps)

  4. Install Central 1.0.0 core package via Meteor (same process as above)

  5. Manually clear cache (although Meteor does also clear cache)

  6. Warm cache using the following CLI commands:

    Linux System

        sudo -u jadu-www /usr/bin/php -d memory_limit=-1 /var/www/jadu/cli.php cache:warmup --kernel=cc
    sudo -u jadu-www /usr/bin/php -d memory_limit=-1 /var/www/jadu/cli.php cache:warmup --kernel=frontend

    Windows System (run as Administrator user, where the Jadu installation directory is C:\inetput\wwwroot\jadu)

        php -d memory_limit=-1 C:\inetpub\wwwroot\cli.php cache:warmup --kernel=cc
    php -d memory_limit=-1 C:\inetpub\wwwroot\cli.php cache:warmup --kernel=frontend
  7. If Galaxies Sites are in service, also warm their cache:

    Linux System

        sudo -u jadu-www /usr/bin/php -d memory_limit=-1 /var/www/jadu/cli.php cache:warmup --kernel=galaxy

    Windows System (run as Administrator user, where the Jadu installation directory is C:\inetput\wwwroot\jadu)

        php -d memory_limit=-1 C:\inetpub\wwwroot\cli.php cache:warmup --kernel=galaxy
  8. Windows only: Start IIS

  9. Turn on forms via Forms > Settings in the Control Center

  10. Manually Verify the upgrade / connectivity of the system

  11. Reapply your front end templates (where customisations have taken place - ideally from version control)

note

Front end template files will be replaced as part of applying step 3 above. Your team may therefore need to reapply manually any front end customisations previously made as a final step, as these changes will have been overwritten during the patching process. See Git Version control section for how you version control such changes better.

How to verify the upgrade

Where Perceptive Content / ImageNow integration has been in use prior to patch application, it would be best to check that connectivity has not been impacted by this upgrade.

This can be done by logging into the Jadu Control Center, going to the Utilities > Integrations page and selecting “Perceptive Content” from the list of systems on the left. If all configuration is still in place, then you will be able to click on the “Drawers” or “Views” tabs in order to see a list of these resources displayed (permissions permitting to the nominated system user account). This will show that connectivity between the systems is still active.

warning

If there are existing forms in the system with identical question names when applying a patch to an existing environment, then the forms migrations may report an issue. This requires resolving in the database before then resuming the patch. Contact us if you hit this particular issue when trying to apply this patch and we’ll try to assist you in how to resolve this.

Notable changes in Jadu Central 1.0.0

User interface and branding update

The Control Center user interface has been updated to use a new colour scheme and brand elements. Functionally, all control center pages will behave the same way as they did prior to the rebrand.

Key improvements include:

  • The text size has been increased in a number of places, especially buttons and labels, improving readability and clarity
  • Interactive controls like form fields and buttons are physically larger, they're easier to see and their target areas are larger to meet current accessibility guidelines
  • Links are more obvious and strongly defined, with higher contrast against regular text, and a consistent stronger underline
  • Content landmark areas are now more clearly defined, visually, through the use of colour and contrast, but also defined with code using semantically appropriate section elements, the position of the main headings has also been changed to improve navigation with assistive technology and allow anyone who relies upon headings to navigate around a given page to be able to find what they're looking for
  • Breadcrumbs have been tweaked to make them more useful, and those are now consistent across the software
  • Homepage widgets can now be quick-searched, handy if you have a long list of custom widgets and you know you want to find the 'map' ones
  • Some help text and labeling have been improved here and there, like when deleting a document, the option now clearly explains the scope of the action you're about to take instead of just 'delete'
  • Modals are generally larger, given more space to breathe, and
  • The sign-in experiences—which differed between products -- have now been brought closer together visually
  • We've been able to strip out a lot of older styles which catered for browsers which we no longer officially support, some components have been completely rewritten in the background to take advantage of newer design capabilities in CSS, we can do some things like more reliable responsive layouts with much less code these days, you might not see any visible differences, but fewer lines of code and fewer supported browsers makes it easier for us to test and release changes
  • Textarea elements with character limits have a new accessible character counter, which also warns when you're getting close to the limit
  • Date pickers have been replaced with a more accessible calendar
  • Tooltips, which display additional information when you interact with an element, are now compatible with screen readers and other assistive technology, and also now work with touchscreen devices which don't have a 'hover' interaction.
  • Updates "CXM" to "Connect" and "XFP" to "Central Forms" throughout the Control Center. Following the rebrand references to Jadu products have been updated throughout the Control Center. The "XForms Pro" module has been renamed to "Forms".

Jadu Content Portal widgets

Existing Jadu Content Portal customers will already have Perceptive Content & Hyland OnBase widgets, Central Form customers will not previously have had these widgets. To prevent duplication of widgets for Jadu Content Portal customers the original widgets have been hidden from the Homepages designer replaced by the new Central Form widgets that provide the same functionality. Any existing Homepages using the original widgets will continue to function without needing to be updated and will use the original widgets. Newly created Homepages after patching will only have the option to use the new Central Form version of the widget.

Version check

To prevent the deployment of Central 1.0.0 on to systems that do not meet the minimum required version of Content Portal the patch deployment tool, Meteor, will check the Content Portal version is 6.3.0 prior to deploying the patch.

End of life warning message

In line with the previously communicated timeline, the classic form builder is scheduled to be removed in a forthcoming version. A warning banner has been added in this version to highlight the need to migrate forms from the classic form builder to the modern version where they are currently in use.

Perceptive user classes renamed to use PSR-4 conventions

A number of PHP classes have been renamed in this version, and any references in custom functionality will require updating to the new class name. A table of updated classes is shown below:

BeforeAfter
Jadu_Perceptive_UserJadu\Integrations\Perceptive\Entity\User
Jadu_Perceptive_UserExtensionJadu\Integrations\Perceptive\Entity\UserExtension
Jadu\Perceptive\Entity\AbstractEntityJadu\Integrations\Perceptive\Entity\AbstractEntity
Jadu\Perceptive\Mapper\AbstractPerceptiveDataMapperJadu\Integrations\Perceptive\Mapper\AbstractPerceptiveDataMapper
Jadu_Perceptive_Mapper_UserExtensionMapperJadu\Integrations\Perceptive\Mapper\UserExtensionMapper
Jadu_Perceptive_Mapper_UserMapperJadu\Integrations\Perceptive\Mapper\UserMapper
Jadu_Perceptive_User_Adapter_CASJadu\Integrations\Perceptive\User\Adapter\CAS