Installation

What You Need Before You Can Begin

Before you can begin creating iOS applications with the ArcGIS Runtime SDK for iOS, you will need a few things.

Machine Requirements

Development using the ArcGIS Runtime SDK for iOS requires an Intel-based Macintosh running Snow Leopard (OS X 10.6.2 or higher) or Lion (OS X 10.7 or higher).

Apple's iOS SDK

If you are not one already, you will need to become a registered Apple developer. Apple requires this step before you're allowed to download the iOS SDK. To sign up, navigate to the registration page and enroll.

Once registered, you can then go to the iOS Dev Center, log in and download Apple's iOS SDK onto your machine. The SDK contains documentation, frameworks, tools, and a simulator to help develop iOS applications. XCode (the developer toolset for iOS application development) is included in the download as well so you do not need to purchase any developer tools to build iOS applications - that is included in the enrollment fee.

You will need to use iOS SDK 4 or higher for developing applications. At the time of writing this document, iOS SDK 5.1 was the most recent version available and supported.

Note:

Beta and GM seed versions of the iOS SDK are generally not supported unless noted otherwise.

Device Requirements

Applications built with ArcGIS Runtime SDK for iOS can be run on a variety of devices such as iPhone 3G / 3GS / 4 / 4S, iPod touch, and iPad / 2 / 3. These devices must be running iOS version 4 or higher.

We strongly recommend that you test your applications on actual devices to ensure that they work as expected and perform well. Testing on the simulator alone does not provide a good measure of how the application will perform on the physical device.

Installing the ArcGIS Runtime SDK for iOS

Once you have installed Apple's iOS SDK, you will need to download and install the ArcGIS Runtime SDK for iOS.

Note:

If you already have a previous version of the Runtime SDK installed on your machine, you should uninstall it. You can do this by running the ${HOME}/Library/Application Support/AGSiOSSDK/uninstallAGSiOSSDK script in the Terminal application

The installation package (*.pkg file) for the latest Runtime SDK can be found here. After downloading the package, double click it and step through the installation wizard. The SDK components will be installed under the ${HOME}/Library/SDKs/ArcGIS folder. Under this folder, you will find a Samples folder containing a single sample. and an ArcGIS.framework folder containing the SDK components such as the API libary, header files, images, localized strings, etc.

Note:

The ${HOME}/Library folder is hidden by default in Mac OS X Lion. You can unhide it by issuing the command chflags nohidden ~/Library/ in the Terminal application.

Troubleshooting installation errors

If you encounter any errors while installing the Runtime SDK, you can find information about the cause of failure in the /var/log/install.log file. Among the common reasons for failure are :

• Missing Write permissions on the ${HOME}/Library folder

• Corrupt installation package