sap iphone app

Application Overview - User Lookup iPhone Application Overview

User Lookup Sample iPhone Application Overview of 16

User Lookup iPhone Application Overview

Contents

• Purpose• Application Overview• ° Application Screens

° Project Structure° Implementation Files

• Installation and configuration guidelines• ° Prerequisites

° Preparing Web Services° - Web Service Functionality overview

- SOAP Web Service Interface- REST Web Service Interface- Configuring Authentication

° Installing an Application on the iPhone Simulator° Installing an Application on iPhone or iPod Touch° Installing a Provisioning Profile on iPhone° - Installing a Provisioning Profile Using iTunes

- Installing a Provisioning Profile Using xCode.- Installing a Provisioning Profile Using the iPhone Configuration Utility- Build and Go

• Configuring an Application• ° Introducing an Application Settings

° Installing Digital Certificates on iPhone.° - Installing Certificates Using Mail

- Installing Certificates Using Safari- Installing Certificates Using iPhone Configuration Utility

• Additional Information

PurposeThis document presents overview of a Sample User Lookup iPhone application.

Applicable application version 1.0

Application OverviewUser Lookup application is a simple application for demonstrating how to implement SOAP and REST web servicescalls from the iPhone application and handle the following aspects:

• Basic authentication• Client certificate authentication• SOAP/XML response parsing• REST/JSON response parsing• Application specific settings



Application Screens

Description Image

A user has to specify a user ID. Depending on a web service type specifiedin application settings, an application performs SOAP or REST web servicerequest.

If a user has specified a wrong user name or/and password for the Basicauthentication type, he gets a prompt asking for authentication credentials.

When an application receives response from a web service, the details screenappears. Depending on a web service type, an application receives SOAP orJSON response. The response is beeing parsed by application and presentedto user.



Description Image

Error prompt is shown when user enters invalid User ID.

• Web Service Type - A user can choose between two web service types. SOAP and REST.

• SOAP URL - A user has to specify a SOAP service URL. The URL has to bespecified without a protocol. (http:// or https:// )

• REST URL - A user has to specify a REST service URL. The URL has to bespecified without protocol. (http:// or https:// )

• SAP Logon Ticket - A user can choose whether to use the SAP LogonTicket or not.

• Authentication Type - A user can choose between two authenticationtypes. Basic and Client Certificate authentication.

• Basic Authentication Settings - A user has to specify a user name andpassword.

Project Structure

• Classes All implementation classes° Utils Utility Classes° Model Model implementation classes

- DataObjects- Service Implementations Web service implementations implementation classes

- REST The REST service implementation classes, including data parsing- SOAP The SOAP service implementation classes, including data parsing- Common Common (Abstract) service implementation classes for REST and SOAP

° View Controllers UI implementation• Third Party Libraries

° JSON Third party JSON parser library• Other Sources Other classes including constants• Resources

° NIB Files All *.xib files used in application° Settings Configuration files° Images All images used in application

• Frameworks Frameworks included in project• Products Compiled application files



Implementation Files

Table below outlines all class files used in an application and their functional area:

Module Location File Description

Delegate Classes UserLookupSampleAppDelegate The Application Delegate is aclass that receives the application-level messages. It is a subclassof NSObject, which implementsUIApplicationDelegate delegate.

Utility Class Classes/Utils SettingsManager A utility class that implementsinteraction with user preferences. Including setting default values whenapplication is installed on a device forthe first time.

Utility Class Classes/Utils Utils A utility class that implementscommon methods used in allapplications.

Data Object Classes/Model/DataObjects

RequestDO A data object class that represents arequest data object.

Data Object Classes/Model/DataObjects

ResponseDO A data object class that represents aresponse data object.

Model Classes/Model/ServiceImplementations/REST

GetUserDetailsRESTService A subclass ofAbstractServiceProvider thatimplements the specific functionalityfor a REST web service data request. This class also implements the JSONresponse parsing using a third-partyparser.

Model Classes/Model/ServiceImplementations/SOAP

GetUserDetailsSOAPService A subclass ofAbstractServiceProvider and itimplements specific functionality fora SOAP web service data request. This class also implements an XMLresponse parsing.

Protocol Classes/Model/ServiceImplementations/Common

AbstractServiceProviderDelegate Delegate protocol forAbstractServiceProvider.

Model Classes/Model/ServiceImplementations/Common

AbstractServiceProvider An abstract web service providerthat has to be extended. This classimplements common functionality forthe SOAP and REST web servicedata request, including passing databack to its delegate.

Controller Classes/View Controllers RootViewController Implements user interface for theUser Lookup application first screen. It provides capability for a user toenter a User ID and perform the datarequest. It also informs a user aboutthe asynchronous activity.

Controller Classes/View Controllers DetailsViewController Implements user interface for theUser Lookup application detailsscreen. It provides capability for auser to see the response data.

Utility Class Other Sources Constants Defines the common constants usedin all applications.

Installation and configuration guidelinesBelow are provided guidelines for preparing application testing environment and installing application.



Prerequisites

User Lookup iPhone application is build as a standard iPhone application using iPhone SDK 3.1. Application is targetedto running on 3.0 or 3.1 iPhone OS (iPhone or iPod Touch), but the Base SDK used here is 3.0.

For application to be used with real data additional web services must be created, deployed and configured ontesting environment. For more details refer to Preparing Web Services section

Preparing Web Services

For application to be used with real data, a web services must be created, deployed and configured on testingenvironment.

Implemented web services may use R3 system to get data (complete end-to-end scenario), or return predefined datawithout using SAP R3 system. SAP NetWeaver 7.0 or 7.1 may be required for integrating with SAP R3 system.

Web Service Functionality overview

A web service should BAPI_USER_GET_DETAIL RFC from ABAP system to get user first and last using provideduser name. User name is passed using USERNAME input parameter, while user first and last name are returned insideADDRESS structure in FIRSTNAME and LASTNAME fields.In case of an error, error message is returned inside RETURN table parameter, using MESSAGE field.

SOAP Web Service Interface

Application expects SOAP web service to have following format:

Request Sample

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <yq1:getUserDetailsxmlns:yq1="http://www.sap.com/caf/demo.sap.com/userlookup/modeled"> <username>JOHND</username> </yq1:getUserDetails> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Response Sample

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <yq1:getUserDetailsResponsexmlns:yq1="http://www.sap.com/caf/demo.sap.com/userlookup/modeled"> <outputParameter1xmlns:ns2="http://www.sap.com/caf/demo.sap.com/userlookup/modeled"> <ns2:firstName>John</ns2:firstName> <ns2:lastName>Doe</ns2:lastName> </outputParameter1> </yq1:getUserDetailsResponse> </SOAP-ENV:Body>



Response Sample

</SOAP-ENV:Envelope>

Error Sample

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Server</faultcode> <faultstring>User SOME does not exist</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

For web service sample implementation please see Enterprise MicroApplications Technical Users Guide forNetweaver 7.0 or 7.1, section Appendix - Creating a Data Service. Guide is available for download under https://wiki.sdn.sap.com/wiki/display/Img/MicroApplications

REST Web Service Interface

Application expects REST web service to have following format:

Request Sample

Single URL that accepts username as URL parameter, for example http://myhost/mywebservice?username=JOHND

Response Sample

{ "UserDetails":{ "firstName":"First Name", "lastName":"Last Name" }}

Error Sample

{ "error":"User SOME does not exist"}

Following web service can be implemented using SAP NetWeaver 7.0 or 7.1, by creating J2EE web application that haveservlet acting as endpoint to web service and uses JCo library for accessing SAP backend system.

Following could be basic implementation of required functionality:

try{ IFunctionTemplate getUserDetailsFunction = mRepository.getFunctionTemplate("BAPI_USER_GET_DETAIL"); function = getUserDetailsFunction.getFunction();

https://wiki.sdn.sap.com/wiki/display/Img/MicroApplications

https://wiki.sdn.sap.com/wiki/display/Img/MicroApplications

http://myhost/mywebservice?username=JOHND



if (function == null) { throw new Exception("BAPI_USER_GET_DETAIL could not be found"); } function.getImportParameterList().setValue(username, "USERNAME"); mConnection.execute(function); JCO.Structure returnStructure = function.getExportParameterList().getStructure("ADDRESS"); String firstName = returnStructure.getString("FIRSTNAME"); String lastName = returnStructure.getString("LASTNAME"); if(firstName.equals("") && lastName.equals("")){ JCO.Table errorMessage = function.getTableParameterList().getTable("RETURN"); throw new Exception(errorMessage.getString("MESSAGE")); }else{ response.getWriter() .print("{\"UserDetails\":" + "{"+"\"firstName\":\"" + firstName + '"' + "," + "\"lastName\":\"" + lastName + '"' + "}}"); }} catch (Exception ex) { response.setStatus(500); response.getWriter().print("{\"error\":\"" + ex.getMessage()+ "\"}"); ex.printStackTrace();} finally { mConnection.disconnect();}

Configuring Authentication

This application demonstrates usage of Basic and Client certificate authentication, as well as SAP Logon ticket. Forsupporting desired authentication way, web service security must be additionally configured.

For complete functionality a web service must have following security mechanisms configured:

• Basic Authentication• Client Certificate• SAP Logon Ticket (Create and evaluate)

Following is an example of login module configuration:

Login Module Name Flag

EvaluateTicketLoginModule SUFFICIENT

com.sap.engine.services.security.server.jaas.ClientCertLoginModule OPTIONAL

CreateTicketLoginModule SUFFICIENT

BasicPasswordLoginModule OPTIONAL

CreateTicketLoginModule SUFFICIENT

For web service configuration sample please see Enterprise MicroApplications Technical Users Guide for Netweaver7.0 or 7.1, section Appendix - Configuring a Data Service.

Installing an Application on the iPhone Simulator

To deploy an application on the iPhone simulator, open the project, select the Active SDK version and click Build andGo.



To build an application using different iPhone SDK version, select Groups & Files > Right click on project > Get Info >Build > iPhone OS Deployment Target.



Installing an Application on iPhone or iPod Touch

In order to deploy developed applications on an iPhone device, a user need to be enrolled into iPhone DeveloperProgram. To deploy the application, the following steps must be completed:

• Create a development certificate (How to?)• Register a device on the developers program (How To?)• Generate an App ID (How to?)• Download and install a provisioning profile on the device (How to?)• "Build and Go"

Installing a Provisioning Profile on iPhone

The provisioning profile can be installed on iPhone using the following installation methods:

• Install a provisioning profile using iTunes.• Install a provisioning profile using xCode.• Install a provisioning profile using iPhone Configuration Utility (Download Windows, Mac OS X)

Installing a Provisioning Profile Using iTunes

• Simply drag and drop a provisioning profile on the iTunes icon.

Installing a Provisioning Profile Using xCode.

• In the xCode toolbar, select the Windows toolbar item.• Select the Organizer menu item.• Click Add .

Installing a Provisioning Profile Using the iPhone Configuration Utility

• Select the Provisioning Profiles tab.• Click Add in the top left corner.

http://developer.apple.com/iphone/

http://developer.apple.com/iphone/

http://developer.apple.com/iphone/manage/certificates/team/howto.action

http://developer.apple.com/iphone/manage/devices/howto.action

http://developer.apple.com/iphone/manage/bundles/howto.action

http://developer.apple.com/iphone/manage/provisioningprofiles/howto.action

http://support.apple.com/downloads/iPhone_Configuration_Utility_2_0_for_Windows

http://support.apple.com/kb/DL851



• Select the device, and select the Provisioning Profiles tab.• Select a provisioning profile from the list, and click Install.



Build and Go

Before deploying an application to the device, the following must be performed:

• Set the code signing identity.Select a project in Groups & Files > Right click on project > Get Info > Build > Code Signings Identity.Select the appropriate development profile.

• Set the appropriate App IdIn the project, find the Info.plist file, and in the Bundle identifier row, specify the App ID.

Configuring an ApplicationThis section presents an application settings that must be configured before the application can be used.

Introducing an Application Settings

All application settings are saved in the application preferences. To open the User Lookup application preferencesscreen, on the device Home Screen, select Settings > User Lookup. When an application is deployed for the first time,the preferences screen is populated with the default values. To set the default values, select UserLookupSample >Resources > Settings > Settings.bundle, open *.plist files in the xCode project, and set the default values in the XMLproperty list.

Settings.bundle contains two files. The Root.plist file represents the main screen of preferences, but theBasicAuthenticationSettings.plist file represents screen where a user enters a user name and password.

• The Root.plist file# Settings

Parameter KeyType Description

Item 1 PSGroupSpecifier A group item preference. A group type is a methodfor organizing groupsof preferences on a single page. Used to separateWeb Service Settings from AuthenticationSettings

Item 2 wsType PSMultiValueSpecifier Used for a preference that supports a set of mutuallyexclusive values. A numeric value, that can containeither0(SOAP) or 1 (REST).

Item 3 soapUrl PSTextFieldSpecifier Displays an optional title and an editabletext field. Must contain a SOAP URL.

Item 4 restUrl PSTextFieldSpecifier Displays an optional title and an editabletext field. Must contain a REST URL.

Item 5 PSGroupSpecifier The RA group item preference. A group type is amethod for organizing groups



# SettingsParameter Key

Type Description

of preferences on a single page. Used to separateWeb Service Settings from AuthenticationSettings

Item 6 logonTicket PSToggleSwitchSpecifier Typically used to represent preferences containingBoolean values.

Item 7 authType Used for a preference that supports a set of mutuallyexclusive values. A numeric value that can containeither0(Basic Authentication) or 1 (Client CertificateAuthentication).

Item 8 PSChildPaneSpecifier Used to link to a new page of preferences. Links tothe BasicAuthenticationSettings.plist file.

• The BasicAuthenticationSettings.plist file# Settings Parameter

KeyType Description

Item 1 PSGroupSpecifier A group item preference. A group type is a methodfor organizing groups ofpreferences on a single page. Used to seta group title.

Item 2 username PSTextFieldSpecifier Displays an optional title andan editable text field. Used tospecify a user name.

Item 3 password PSTextFieldSpecifier Displays an optional title andan editable text field. Usedto specify a password. TheIsSecure parameter propertyvalue is set to TRUE.

Installing Digital Certificates on iPhone.

iPhone supports X.509 certificates with RSA keys. iPhone recognizes .cer, .crt, .der, .p12and .pfx file formats.

Certificates can be installed as follows:

• Installing certificates using Mail• Installing certificates using Safari• Installing certificates using iPhone Configuration Utility

Installing Certificates Using Mail

Send certificate files to required email account accessible from the device. Then open the email and select theappropriate certificate.



When the certificate link is clicked in iPhone, it asks whether to install it. The certificate will most likely not be verified byanother party.

If the certificate is protected with a password, iPhone asks to enter it. Once the password is entered, the certificate is tobe installed on the device.



Installing Certificates Using Safari

Safari can be used to download certificates from a web page. Host a certificate ona website and install them on the device in the same way as from mail.

Installing Certificates Using iPhone Configuration Utility

To install a configuration profile:

• Select the Configuration Profiles tab.• In the credentials section, click Add and add certificates.



• Select the device.• Select the Configuration Profiles tab.• Select a configuration profile from the list and click Install.• To install the profile, on the device, tap Install.



Additional InformationFor more information and other sample applications please refer to:

Location URL

MicroApps Home Page http://wiki.sdn.sap.com/wiki/display/Img/MicroApplications/Code+Samples

MicroApps Code Samples http://wiki.sdn.sap.com/wiki/display/Img/MicroApplications/Code+Samples

http://wiki.sdn.sap.com/wiki/display/Img/MicroApplications/Code+Samples

http://wiki.sdn.sap.com/wiki/display/Img/MicroApplications/Code+Samples

sap iphone app

Documents

editable text field

configuration profiles tab

including data parsing

mutually exclusive values

provisioning profiles tab

sap logon ticket

web service type

client certificate authentication