Enable jQuery 1.7 compatibility in Appway 5.3

Problem

Appway 5.2 was shipped with version 1.7.1 of the jQuery Core JavaScript library. With Appway 5.3 we will upgrade the built-in jQuery Core library to version 1.9.1. jQuery 1.9 removes or modifies several APIs that behaved inconsistently or inefficiently in the past. This may have an impact on your solution if you use screen components or custom JavaScript code relying on jQuery 1.7 functions and features. If this is the case, you may run into JavaScript errors in the workspace of your solutions.

Solution

Backward compatibility with jQuery 1.7 can be restored (up to a certain degree) by setting the new configuration property "nm.workspace.jquery.compatibility" to "1.7":

1nm.workspace.jquery.compatibility = 1.7

I suggest to set this configuration property in the "Content Configuration" section. It will trigger the inclusion of the jQuery Migrate plugin in the workspace. As a result, screen components and custom JavaScript code relying on jQuery 1.7 functions and features should continue to work. The default value of the configuration property is "1.9", so the jQuery Migrate plugin is not included by default.

The jQuery Core 1.9 upgrade guide contains information about how to migrate existing jQuery code to version 1.9, and which functions and features the jQuery Migrate plugin can restore and which not.

We highly recommend to upgrade all custom JavaScript code to jQuery 1.9. If the JavaScript code is part of the solution, use global search to find all locations where jQuery 1.7 code is executed.

Example:
Search for ".live(" to find invocations of the function "live". Then follow the upgrade guide and rewrite the JavaScript code so that it is jQuery 1.9 compliant. According to the documentation, the function "live" can be replaced with "on". Attention: The way the function is invoked has changed! The function is now invoked on the document object and the number and order of parameters has changed.

Here is a separate list of all features deprecated in jQuery 1.7 and removed in jQuery 1.9.

IMPORTANT
If you have running process instances on your live system, fixing the jQuery code in your solution only has an impact on newly started process instances (unless you upgrade all process instances). You should therefore consider to enable the inclusion of the jQuery Migrate plugin until all process instances are running on the fixed versions of your business objects. There is no tool support in the Appway Studio for fixing such issues in older (non-head) versions of business objects. If you must patch older versions of business objects in the repository, please consult an Appway support engineer for further assistance.

Could this article be better?Yes, let me send feedback

Back to Cookbook

Comments (0)

Developer is transitioning to Appway Community

All material for Appway 6 is still available here on developer.appway.com during the transition to Appway Community.

Material for Appway 6.3 and Appway 7 is available in the Knowledge Base on community.appway.com.

Note: The Community Blog, our Forum, and the Support system are available exclusively on Appway Community.

Any questions or feedback? Please contact community@appway.com

Cookbook

Enable jQuery 1.7 compatibility in Appway 5.3

How Could This Recipe be Improved?

Developer is transitioning to Appway Community

See Also

COOKBOOK