Migrating Agentry Applications to SAP® Mobile Platform 3.0

Prerequisites
The following items must be addressed prior to performing this procedure:
  • If the mobile application being migrated contains a Java system connection the procedure on “Preparing Agentry Applications With Java System Connections” must be performed prior to this procedure.
  • You must have access to the currently installed mobile application to be migrated. The source from which the application will be migrated dictates the components to which you need access. You will always need access to the Agentry Server or SAP® Mobile Platform environment upon which the mobile application is deployed. Additionally, if importing the application definitions from the Agentry application project you will also need to the Agentry Editor and Eclipse workspace in which the Agentry application project exists.
  • The SAP® Mobile Platform 3.0 must be installed and an Agentry application defined within the Management Cockpit.
  • The Agentry Editor plug-in as provided in the SAP Mobile SDK 3.0 must be installed to Eclipse.
Task

This procedure describes the steps necessary to migrate a mobile application built and/or currently deployed on the Agentry Mobile Platform version 6.0.x or earlier; or currently deployed in SAP® Mobile Platform 2.3 and is built on the Agentry archetype within that system. The procedure to migrate to SAP® Mobile Platform 3.0 is the same.

In this procedure the following terms are used and should be noted to fully understand the procedure:
  • Import Source: The source mobile application or application project within the Agentry Mobile Platform 6.0.x or SAP® Mobile Platform 2.3 that is to be migrated to SAP® Mobile Platform 3.0. This can be an Agentry application export file generated by exporting the project from the Agentry Editor, or the mobile application as it exists on the Agentry Server.
  1. Verify the Agentry Server within the SAP® Mobile Platform Server 3.0 is not running. If it is running, stop the service using the Management Cockpit before proceeding.
  2. If the import source of the mobile application is an Agentry application project within the Eclipse workspace, use the Agentry Editor plug-in within Eclipse to export the entire project. This results in a file with extension .agx or .agxz.
  3. Open the Eclipse installation containing the Agentry Editor plug-in as provided in the SAP Mobile SDK 3.0. Once started, open the Agentry perspective.
  4. Begin the import process by either right clicking within the Package Explorer view and selecting Import... or by selecting the menu item File | Import...
  5. Expand the item Agentry Project in the dialog now displayed. Then select the proper import source from the options listed. Continue the import by clicking through import wizard and selecting the proper options.

    Once the import process is complete, the new Agentry application project for the mobile application exists in the Eclipse workspace and is listed in the Package Explorer view.

  6. If your mobile application includes a Java system connection, the associated Java project should now be migrated to the Eclipse workspace. If making changes to the Java logic using the findConfigurationFile method, described in the section “Preparing Agentry Applications With Java System Connections,” these changes should be made now and the Java project rebuilt.
  7. Next publish the application to the SAP® Mobile Platform Server 3.0, into the configuration directory of the Agentry application defined there; typically the directory within the SAP® Mobile Platform Server installation location is as follows:

    configuration\com.sap.mobile.platform.server.agentry.application

  8. Next all other resources residing in either the Agentry Server for version 6.0.x, or in the Agentry application directory within the SAP® Mobile Platform Server 2.3 directory structure, which are specific to the mobile application must be copied to the SAP® Mobile Platform Server 3.0. The specific files are different from mobile application to the next. In general the following are the types of resources to be moved, and which should be collected in this step in preparation for move. TH next step specifies where the files should be placed within the SAP® Mobile Platform Server 3.0 installation:
    • Application-specific configuration files, plus the Agentry.ini file
    • Application-specific Java resources, including .jar files, but do not include the Agentry-v5.jar or Agentry-v4.jar (if present) files found in the Java folder of the server’s installation. Any other resources found here should be included as they are likely to be application-specific. NOTE: If changes were made to the Java logic, the resulting resources (Jar files and similar) should be those moved to the SAP® Mobile Platform Server 3.0 installation, not those in the previous implementation of the application.
    • Application-specific DLL files, but do not include DLL’s provided with a standard Agentry Server installation.
    • The contents of the sql directory under the Agentry Server’s installation location. All files in this directory can be safely added to the ZIP archive.
    • Any other files know to be a part of the mobile application but not provided with a standard Agentry Server installation.
  9. Once all file resources have been collected or their locations noted, they must be placed within the proper location within the SAP® Mobile Platform Server 3.0. The following locations each pertain to different file resource types:
    1. The Agentry.ini file is copied to two locations within the SAP® Mobile Platform Server 3.0 location. First, it should be copied and renamed to AgentryServer.ini and placed within the directory Server\configuration\com.sap.mobile.platform.server.agentry.
    2. A second copy of the Agentry.ini file, with the name remaining Agentry.ini, is copied to the location Server\configuration\com.sap.mobile.platform.server.agentry.application.
    3. All Java .jar files are copied to the location Server\configuration\com.sap.mobile.platform.server.agentry.application\Java
    4. All SQL files or command scripts are copied to the location Server\configuration\com.sap.mobile.platform.server.agentry.application\sql
    5. All application-specific configuration files not referenced by Java system connection and synchronization logic are copied to the location Server\configuration\com.sap.mobile.platform.server.agentry.application
    6. All application specific configuration files and all other file resources which are referenced by Java system connection synchronization logic are copied to one of two locations, depending on the approach taken after following the procedure provided in the topic “Preparing Agentry Applications With Java System Connections.” If the recommended option to change the logic to use the API file method was implemented, copy the Java-referenced files to the location Server\configuration\com.sap.mobile.platform.server.agentry.application. Otherwise, these Java-referenced files must be copied to the root directory of the SAP® Mobile Platform Server 3.0 installation.
  10. Start the Agentry Server within the SAP® Mobile Platform Server 3.0 using the Management Cockpit. When the startup is complete, verify the Agentry Server has successfully connected with the back end system.
  11. At this point the system should be thoroughly tested, ideally with full end-to-end testing and operations. When this is complete, it is next necessary to upgrade the Agentry Client installations within the implementation environment in order to migrate all mobile users to the new environment. This is a standard client device operation consisting of the following general steps:.
    1. Have all users perform a final transmit to verify all information stored on the device has been updated to the back end system.
    2. All users should shut down their clients prior to upgrading them.
    3. Install the Agentry Client provide with the SAP® Mobile Platform 3.0 for the client device type.
    4. Each user should start the new Agentry Client, login, and perform an initial transmit.

With the complete of this procedure the mobile application has been successfully migrated to the SAP® Mobile Platform 3.0 implementation.

Next

At some point after the completion of fully migrating all mobile users to the new environment, it is possible to uninstall the previous version of the Agentry Client from the mobile devices, provided there are two separate versions of the client. For platforms, the Agentry Client may be upgraded in place, resulting in only one Agentry Client executable existing on the device at any given time.

Parent topic: Migrating of Agentry Applications