Migrating Custom Client Applications to BPM 4.2.0

Migrating Custom Client Applications to BPM 4.2.0

book

Article ID: KB0083624

calendar_today

Updated On:

Products Versions
TIBCO BPM Enterprise (formerly TIBCO ActiveMatrix BPM) 4.2.0

Description

Before you can use existing custom client applications with ActiveMatrix BPM
4.2.0, you must modify them to take account of the following changes.

1) New jQuery and AngularJS Library Versions
---------------------------------------------------------------
ActiveMatrix BPM version 4.2.0 uses new versions of the jQuery and AngularJS
third-party libraries, as follows:

* jQuery v3.1.1 (replacing v2.1.3)
* AngularJS v1.6.0 (replacing v1.4.8)

These libraries are packaged as part of Application Development, in the App Cdn
library application.

Custom client applications that use the old versions of these libraries will not
work against ActiveMatrix BPM 4.2.0. You must modify them to use the new
versions, and update them if they have any dependencies on breaking changes
introduced in the new versions.

2) New Localization Message Property File - BpmTcfAlertMessages.properties
----------------------------------------------------------------------------------------------------------
Messages (errors, information and confirmations) returned by the Client
Application Framework component services can now be localized. Prior to version
4.2.0, these messages were hard-coded in English.

Keys and default English strings for these messages are supplied in the
BpmTcfAlertMessages.properties file. This file is included in the l10n folder of
the sample applications provided with Application Development in ActiveMatrix
BPM 4.2.0.

Custom client applications that do not include the BpmTcfAlertMessages.properties
file will generate an error when a component service attempts to return one of
the messages now provided in this file.

You must add the BpmTcfAlertMessages.properties file to your custom client
application before using it on ActiveMatrix BPM 4.2.0. If your application is
already localized, you may also want to update each locale to provide translated
versions of the messages.

Issue/Introduction

Before you can use existing custom client applications with ActiveMatrix BPM 4.2.0, you must modify them to take account of the following changes: - New jQuery and AngularJS library versions - New localization message property file - BpmTcfAlertMessages.properties

Environment

All supported operating systems

Resolution

1. Update the custom client application to use the new versions of the jQuery
   and AngularJS libraries:

   a. Edit the application, replacing any references to the old versions of the
      jQuery and AngularJS libraries with references to the new versions. For
      example:

      <script type="text/javascript" src="/apps/app-cdn/tcf/tcf.nocache.js"></script>
      <script type="text/javascript" src="/apps/app-cdn/jquery/jquery-3.1.1.js"></script>
      <script src="/apps/app-cdn/angular/1.6.0/angular.min.js"></script>
      <script src="/apps/app-cdn/angular-ui-grid/ui-grid.min.js"></script>

   b. Check the jQuery and AngularJS documentation for details of the changes
      between the old and new versions. If your application code is affected by
      any breaking changes, update it as required.

      Note: The following references may be useful starting points to help you
      identify breaking changes that may impact existing applications.

      * "Migrating an App to a newer version" in the Angular Developer Guide:
   
          https://docs.angularjs.org/guide/migration

      * jQuery Core 3.0 Upgrade Guid:
   
          https://jquery.com/upgrade-guide/3.0/

2. Copy the BpmTcfAlertMessages.properties file, supplied with this article, to
   the application's l10n folder.
   
3. Upload the updated version of the application to the ActiveMatrix BPM 4.2.0
   system.
   
4. If the application is already localized, localize the phrases for the new
   keys provided by BpmTcfAlertMessages.properties. (See "Editing Phrases in a
   Locale" in the TIBCO ActiveMatrix BPM Client Application Management Guide for
   more information.)

5. Test the application. When you are satisfied that it is working properly,
   publish it.

Attachments

Migrating Custom Client Applications to BPM 4.2.0 get_app