Show TOC

OpenUI Installation Instructions (iOS)Locate this document in the navigation structure

Set up the OpenUI environment to access iOS development resources.

As part of OpenUI, the iOS client has been "SDK-ized" into a pseudo framework containing a statically linked library that application designers can use to create an Xcode project, and build custom field adapters.

This page contains a description of the pseudo framework contents, instructions on how to incorporate it into an arbitrary Xcode project, and a description of the sample project provided with the framework. Also at the end, see the notes section for hints. A sample prepackaged Xcode project ready to accept field extensions is also provided with the library for ease of use and prototyping extensions easily.

SMPAgentryClientFramework Framework
The resources for OpenUI are delivered as a framework for iOS. Because at the present time Apple does not support the proper creation of dynamic frameworks, the library at the heart of our framework is supposed to be statically linked into the user's applications. This library and the resources provided with the framework contain all the functionality of the iOS Agentry Client. The framework is packaged as a TGZ file which name is in the format SMPAgentryClientFramework-iOS-<W.X.Y.Z>.tgz (<W.X.Y.Z> would be the current Agentry Version), and it has the following directory structure:
- `SMPAgentryClientFramework/`
	- `iOS/`
		- `SMPAgentryClient.framework/`
			- `Headers@ -> Versions/Current/Headers`
			- `Resources@ -> Versions/Current/Resources`
			- `MPAgentryClient@ -> Versions/Current/SMPAgentryClient`
			- `Versions/`
				- `Current@ -> W.X.Y.Z`
				- `W.X.Y.Z/`
					- `Headers/`
						- `SMPOpenUI/`    _The headers needed for adapters and models of SMPOpenUI_
						- `SMPDataAPI/`    _The headers needed for SMPDataAPI_
					- `Resources/`
						- `SMPAgentryClientResources.bundle`    _The resource (images, sounds, etc...) needed for Agentry_
					- `SMPAgentryClient*`    _The static library containing the iOS Agentry Client code_
		- `Samples/`    _Xcode sample projects are here, see section below for more details. These are tested with Xcode 6.0_
			- `SMPAgentryClientFrameworkDemo/`
			- `SMPAgentryClientFrameworkSetup/`
		- `SampleApp/` _The sample application Agentry definitions_
			- `OpenUI-app.agxz` _The definitions for the sample App exported from the Agentry Editor_
			- `OpenUIPlayersDB.txt` _The sample data in SQL query format ready to populate a sample database_
Static Library

The framework static library is provided with slices for architectures armv7 and asmv7s as well as i386 so your applications can be tested in the simulator and devices alike.