Agentry OpenUI SDK for iOS Setup Overview

The Agentry OpenUI for iOS clients is provided within the SAP Mobile Platform SDK. It is provided in a single TGZ file, referred to generally as the Agentry Client framework, and can be used to create a development project within the Xcode IDE on Mac systems. It is provided in the native Objective C programming language for iOS devices. Also included in this framework is a sample project with basic overrides of each detail screen field edit type provided as examples.

When creating the project within Xcode, the developer has two options. The first is to manually create the project in Xcode, pulling in the various resources provided in the Agentry Client framework and setting the various configuration options for the project. Instructions are provided here to support this method if desired.

The second, and recommended option in most situations, is to use the prebuilt empty project file provided in the Agentry Client framework, named SMPAgentryClientFrameworkSetup. This project contains all the same settings and options as described in the manual process. It can be used as is within Xcode to support a quicker and easier project setup. In general it is only necessary to create the project manually in situations where there is a need for significant differences from the recommended setup. Such situations are extremely rare and should not be necessary in most use cases.

Framework Contents

The resources for the OpenUI SDK are provided in the Agentry Client framework, which is found in the file SMPAgentryClientFramework-iOS-7.0.x.x.tgz. This library and the resources it contains includes all functionality of the Agentry Client for iOS and 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. Due to limitations with Appleā€™s current support of dynamic frameworks, this framework is intended to be statically linked to the application.

To support testing on both iOS devices and within the simulator, the framework standard library is provided with slices for instruction set architectures armv7, armv7s, and i386.

The framework contains the following directory structure after it has been expanded:
//SMPAgentryClientFramework/iOS/
	./SMPAgentryClient.Framework/Versions/Current/Headers
		Headers needed for adapters and models of SMPOpenUI
	./SMPAgentryClient.Framework/Versions/Current/Resources
		SMPAgentryClientResources.bundle - Image, sound, and other resources
	./SMPAgentryClient.Framework/Versions/Current/SMPAgentryClient
		SMPAgentryClient - The static library containing the iOS Agentry
Clientcode
	./Samples/SMPAgentryClientFrameworkDemo/
	./Samples/SMPAgentryClientFrameworkSetup/
	./SampleApp/
		./OpenUI-app.agx - Agentry application project corresponding to the XCode demo project provided in the Samples directory
		./OpenUIPlayersDB.txt - Sample data in SQL script for back end DB