TABLE OF CONTENTS
- What is Apty Client Version?
- Why Apty Client Version?
- How to control versions using Client Version?
- How to find out if the Client Version is obsolete?
What is Apty Client Version?
Client Version is a feature that helps admins control Client versions they want to run globally for their end-users as well as locally on their systems. The Client Version screen features the latest and two prior major versions, for admins to choose from.
If the latest Apty version update is 4.16, that means Apty will continue the support of versions 4.16, 4.15, 4.14, and their hotfixes until the next release. Learn more about Client versions supported by Apty.
Depending upon the way an enterprise chooses to install an application (extension mode or injected mode), the UI for the Client Version feature will appear differently.
Client Version for extension mode
For systems with applications installed via extension mode, the Client Version screen appears as shown below.
Client Version for injected mode
For systems with applications installed via injected mode, the Client Version screen appears as shown below. It displays a table of applications installed via injected mode, their environment versions, and the last modification date.
Control client versions at the environment level for each application
For each application, admins can modify environment versions independently and the modification date gets updated accordingly.
How to add an application to the Injected Client Version screen?
A new check box Inject Apty Client with code snippet is added in Apty Admin under Applications Settings -> General Settings. Once this option is checked, that application will be listed in the Injected Client Version table and admins can start controlling its environment versions from the Client Version Screen.
Mouseover interactions for Injected Client Version
The normal state of the row:
On mouseover, the row displays a dropdown for each environment so that admins understand that they can manually update each version.
Client Version for extension mode and injected mode
In the case of a hybrid model, the client version screen features control options for both extension and injected mode.
Why Apty Client Version?
Control versions
Admins can control which version of Apty Client they want the end-users to use from the. Additionally, admins have the option to test a version, that they are upgrading or downgrading to, locally, before implementing the changes to all end-users.
Stay up to date
Apty encourages its customers to keep their Apty components up to date, it helps Apty provide its customers with security patches, bug fixes, and other improvements and updates. The Client Version feature will comprehend the ability to inform admins about an obsolete Apty Client version.
How to control versions using Client Version?
Initial step
Admins should test the version thoroughly locally (or on staging) for their systems from the Downloads screen, before making the changes globally, (or on production) for the end-users, from the Client Version screen.
Control the Client version for extension mode
To upgrade
Step 1: Go to the Client Version screen. From the highlighted drop-down menu, select the latest version.
Step 2: Click on Learn more to discover the latest updates and changes. Click on Upgrade to continue.
Step 3: Check the box to confirm that testing has been performed. Click on Upgrade Now to start the up-gradation process.
To downgrade
Step 1: Go to the Client Version screen. From the highlighted drop-down menu, select a prior version supported by Apty.
Step 2: Click on Downgrade to continue. Note that Apty does not recommend you downgrade your Client version. Admins should test the version before downgrading.
Step 3: Check the box to accept the risk of downgrading. Click on Downgrade to continue.
Control the Client version for injected mode
To upgrade
Step 1: Go to the Client Version screen. From the drop-down menu, select the latest version to upgrade to.
Step 2: Check the following box and click on Upgrade Now to start the up-gradation process.
Note that more than one environment can be upgraded at once. |
To downgrade
Step 1: Go to the Client Version screen. From the drop-down menu, select the latest version to upgrade to.
To upgrade and downgrade at the same time (for injected mode)
From the above table, admins can choose to upgrade or downgrade multiple environments (for the same application or for different applications) at the same time. In that scenario, the confirmation message looks like this:
How to find out if the Client Version is obsolete?
There are two ways admins can identify applications with an obsolete version:
- Warning message to upgrade the client version
- Styling for outdated Client version
Warning message to upgrade the client version
Apty will notify admins when their client version gets obsolete for an application. The warning message is application-specific and appears at the top of the Admin Panel, as shown below. Click on the message to go to the Client Version screen and learn more about the latest version.
When does a warning message occur?
- For extension mode, the warning message occurs when the Apty Client version is outdated
- For injected mode, the warning message occurs when the main environment of the application is outdated
Warning dismiss button
Admins can hide the warning message for the ongoing session by using the dismiss button. After the session expires and new login occurs, the warning message will appear again.
Styling of outdated Client versions
Applications that need updating will be styled in red. The red color box highlighter will appear in the UI to indicate that the respective application is no longer supported by Apty. This implies admins need to upgrade their Client Version to one of the latest versions supported by Apty.
Outdated Client version styling for extension mode
Apty shows a red color highlighter around the Client version box.
Outdated Client version styling for injected mode
The obsolete Client versions are styled differently to call attention to the outdated versions.
