IBM Case Manager Mobile Version SDK for ios Developers' Guide IBM SC

Transcription

1 IBM Case Manager Mobile Version SDK for ios Developers' Guide IBM SC

2 This edition applies to version of IBM Case Manager Mobile (product number 5725-W63) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM and Future Workshops 2015, All rights reserved.

3 IBM Case Manager Mobile SDK for ios Welcome Welcome to the IBM Case Manager Mobile SDK for ios documentation, where you can find information about how to install and use the IBM Case Manager Mobile SDK for ios. Overview The IBM Case Manager Mobile SDK for ios enables you to build high-quality mobile case management apps. The goal of the framework is to encapsulate low level implementation detail such as networking, persistence, XML parsing and workflow processing, allowing you to focus on higher value work such as business logic or user experience. Getting started Documentation Prerequisites This document assumes the reader has a working knowledge of IBM Case Manager, Apple's Xcode, and the Objective-C or Swift programming language. SDK Prerequisites Here are the prerequisites for using the SDK: An IBM Case Manager server that runs IBM Case Manager or later An Apple Mac that runs OS X or later with Xcode 8 or later installed The IBM Case Manager Mobile SDK or later package Integrating with an Xcode project To integrate IBM Case Manager Mobile SDK with an existing or new Xcode project: 1. Create a subfolder in your project directory called Frameworks. 2. Copy the universal frameworks IBMCaseManagerSDK.framework and IBMCaseManagerUISDK.framework into the Frameworks directory. 3. Drag both IBMCaseManagerSDK.framework and IBMCaseManagerUISDK.framework into the Embedded Binaries section of your target in Xcode. 4. Add a new Run Script Phase in your target s Build Phases. IMPORTANT: Make sure this Run Script Phase is below the Embed Frameworks build

4 phase. You can drag and drop build phases to rearrange them. Paste the following lines into the Run Script Phase's script text field: bash "${SRCROOT}/Frameworks/IBMCaseManagerSDK.framework/strip_framework.sh" bash "${SRCROOT}/Frameworks/IBMCaseManagerUISDK.framework/strip_framework.sh" You can now begin using the IBM Case Manager SDK inside your project. TEST TARGETS If you need to integrate IBM Case Manager Mobile SDK in your test targets, add both IBMCaseManagerSDK.framework and IBMCaseManagerUISDK.framework to the Link Binaries With Libraries build phase. SDK Components The SDK is organized into two frameworks: IBMCaseManager - Model, networking and workflow functions IBMCaseManagerUI - User Interface and Data Visualization Package contents The IBM Case Manager Mobile SDK package includes the following components: Universal SDK frameworks A sample Xcode project that contains a working application Developer reference documentation Sample Xcode Project A sample app can be accessed from your IBM Case Manager Mobile SDK package. The comments are numbered. To familiarize yourself with the mechanisms and features of the SDK, run the sample app and review the comments in the sample app's code. Important: The sample Xcode project is not intended to be a tutorial on how to design your application. For example, it does not contain robust error handling and recovery. Developer Reference Documentation The SDK provides reference documentation in Docset format for each public interface class, method, and type. This documentation can be imported into your Xcode project.

5 SDK Code details The SDK is written in Objective-C, but it can be integrated with either Objective-C or Swift code. Here are some of the tasks that you can perform with the SDK: Connect to a Case Manager solution and access the list of tasks for a given in-basket. Update properties Process a task Search for a Case Create a new Case Public API Here are the main purposes of the SDK's public API: To provide the means for achieving a task in only one way so that the API can be kept as small as possible. To expose an architecture that comes configured for default use. To allow developers to inject custom logic to achieve greater control over behavior. Runtime debug support The SDK makes extensive use of NSAssert to verify preconditions in public and private methods. It aims to "fail early" with good error messages that clarify the API contract so developers can debug issues without the library source code. Coding standards The SDK follows Apple's cocoa guidelines, in terms of naming, style and coding conventions. FAQ Q: Do I need to create bridging headers to use the SDK in a Swift project? A: We have defined module-maps in the SDK so you don't need bridging headers.

6 IBM Product Number: 5725-W63 Printed in USA SC