Show TOC

Agentry OpenUI SDK for Android Setup OverviewLocate this document in the navigation structure

The Agentry OpenUI for Android clients is provided within the SAP Mobile Platform SDK. It is provided in a single ZIP archive, referred to generally as the Agentry Client framework, and can be used to create a development project within a Java IDE. Eclipse was used to create these resources by SAP. It is provided in the Java programming language.

Also included in this framework is a sample project with basic overrides of each detail screen field edit type provided as examples.

In order to create the project, it is necessary to have the following tools installed
  • Eclipse
  • Android SDK - API versions 10, 15, and 17
  • Java SDK
  • ANT If building with ANT - This is provided as a part of the Eclipse installation, but may also be installed separately to support rebranding-only builds

In order to set up an Android development environment, there are different options available and the proper option is up to the developer and the environment currently in place. Both include the usage of the Android Development Toolkit (ADT), an Eclipse plug-in. A summary of each option is provided below, and step by step instructions are available for each in subsequent sections, which include URLs to the Android developer site where both the downloads and installation instructions are provided.

Once the Android development environment is created, the projects provided in the Agentry Client framework archive for OpenUI can be directly imported into the Eclipse workspace. Once this process is complete, you can begin developing the custom controls needed for your mobile application. Instructions are also provided on creating the projects within the Eclipse workspace and information on items such as build order and similar details are included.

Setup for Android Development - Installing the ADT Bundle

To create the Android development environment you can download and install the Android Development Toolkit (ADT) Bundle. This bundle includes both the Eclipse IDE as well as the ADT plug-in for Eclipse already bundled together and configured. As a part of the ADT bundle the Android SDK is included and installed. After installing this bundle it is necessary to use the SDK Manager within the Android SDK to verify and/or install the required API versions of the SDK.

Setup for Android Development - Installing the ADT Plug-in Manually

If you have an existing installation of Eclipse, it is possible to install the ADT plug-in to it, rather than installing the full Eclipse IDE and plug-in. The primary difference in this process from the full ADT bundle option is that you will need to manually configure the preferences within Eclipse for the ADT after it is installed to point it your Android SDK installation.

Setup for Android Rebranding Only

If you will only be rebranding the Agentry Client for Android and will not be developing customer controls using the OpenUI SDK, you do not need to setup an Android development environment. Rather, you can simply install the Ant build scripting tool and make changes to certain files extracted from the framework archive. You can then run an Ant build command to create a rebranded and/or resigned Agentry Client for Android.

Framework Contents

The resources for the OpenUI SDK are provided in the Agentry Client framework, which is found in the file SMPAgentryClientFramework-Android-7.0.x.x.zip. This archive and the resources it contains includes all functionality of the Agentry Client for Android and also includes the OpenUI SDK to allow for the detail screen fields to be overridden with custom controls; as well as exposing the necessary resources to rebrand the Agentry Client.

The framework contains the following directory structure, relative to the base directory into which it is extracted:
./Sample/
	OpenUI-app.agz
		Agentry application project corresponding to the Java sample project
	./com/
		Beginning of the folder structurein which the sample project and extensions are contained.
./SAP/Mobile/Platform/android/AgentryAndroidClientSolution
	Location of the project containing the buildable resources that produce the standard Agentry
Clientfor Android
./vendor/