Show TOC

Updating Agentry Configuration SettingsLocate this document in the navigation structure

Update Agentry configuration files, and deploy the changes to the production environment. Agentry configuration files include back-end connection files, and override files (localization files, query files, and constants files). Configuration files may apply to the landscape, or to a particular application. In some cases, you must restart the application before the changes take effect, in others you must restart SAP Mobile Platform Server.


  • Developers create configuration files as part of application development. This typically involves copying and renaming a template file to use as a base. For example, use the ClientTextBase.ini template file to create ClientText.ini, then modify ClientText.ini to change the configuration settings.
  • Once the configuration files are published to SAP Mobile Platform Server, they are stored in the production database.
  • Administrators can update configuration files, or work with developers to update them. The updated files must be republished using Agentry Editor and Management Cockpit.
    Note Do not modify the configuration files directly on the server; those changes will be overwritten by files in the production database.
  • Some changes require you to restart the application for the changes to take effect:
    • Changes to configuration items that are related to a configuration file require an application restart. For example, changing the content of an existing file, like SqlBE.ini, or changing the Query Init File of a SQL back end from SqlBE.ini to SqlBE_Oracle.ini.
    • Changes to actual code require an application restart. For example, changing Java code for the Java back end.
    • Changes to the SQL query files require an application restart, if the SQL back end’s preloadQueries setting is true.
    • Updates to application configuration files require an application restart. For example, if a new version of the application that includes updated configuration files is published from one server in the cluster, you must restart each SAP Mobile Platform Server in the cluster.
    • Changes to any settings where Management Cockpit indicates it is necessary, require an application restart.
  • Changes made in sections labeled "Affects All Agentry Applications" in the App Specific Settings screen require a SAP Mobile Platform Server restart for the changes to take effect.


  1. Use any text editor to update configuration files.
  2. Use Agentry Editor to publish the application. Include the updated configuration files in the publish folder structure, along with the product definitions, so they are included in the ZIP file.
  3. In Management Cockpit, use App Specific Settings to publish the new ZIP file. You can complete any additional Agentry application configuration tasks as well. When you save the ZIP file, it is uploaded through the browser to SAP Mobile Platform Server, and published. You are notified of success or failure.
  4. Restart the application, or SAP Mobile Platform Server if required. In a cluster environment, restart the application on each server in the cluster, to distribute the configuration changes. Application users can then obtain the updated application version on their devices, from the server.