iphone Native Client for Sugar CRM (isugarcrm)

Transcription

2 iphone Native Client for SugarCRM Installation Guide ID December 2008 Imaginea 301 White House, Begumpet Hyderabad India Made in India. Copyright 2008 Imaginea. All rights reserved. Imaginea is a business unit of Pramati Technologies Private Limited. Pramati is a registered trademark of Pramati Technologies in United States and India. DISCLAIMER The information provided within by Imaginea is believed to be correct, but no liability is assumed for errors that may be contained in the data. Imaginea and Pramati Technologies accept no liability for the accuracy of the data or any actions resulting from its use. It is provided "as is" without express or implied warranty, although Imaginea has made reasonable effort towards accuracy and validity. isugarcrm is not a Trademark of Imaginea or of Pramati Technologies, and has been loosely used across the document. SugarCRM is a trade mark of SugarCRM Inc. All other trademarks and copyrights are the property of their respective owners. ABOUT IMAGINEA Imaginea provides product engineering services to independent software vendors, enterprises and online SaaS businesses, all with a very reliable technology partnership. Services are fully comprehensive and cover the process from beginning to end. We bring all of our years of product engineering and services to software companies from several different industries at many stages of the process. Through the use of several technologies and strong, innovative development processes, we deliver dependable software products at a lower cost and fulfill our customer s business needs. To learn more, visit

3 Table of Contents 1. GETTING STARTED ISSUES WITH THE COMMUNITY EDITION & SOLUTION Issues The Solution DOWNLOADING AND INSTALLING THE ISUGARCRM APPLICATION Downloading isugarcrm Using itunes Store Downloading isugarcrm Using AppStore isugarcrm Requirements Before you start working with isugarcrm APPLICATION OF PATCH FOR SUGARCRM COMMUNITY EDITION Installing the Patch...9

4 1. Getting Started Welcome to the iphone Native Client for Sugar CRM the isugarcrm! Did you ever wish there was an iphone Client for SugarCRM? Well, worry no more! Imaginea is pleased to announce a free iphone native Client for SugarCRM. Yes it is absolutely FREE! Get used to the true mobile solution for SugarCRM with a brand new iphone native Client from Imaginea. The following are the highlights of the iphone client: - It is iphone native and not HTML-based - It is truly mobile: o Works with limited, intermittent and no connectivity modes o Works on the principles of Store, Operate and Sync! - Dynamic and offline search as opposed to server based batch search - Supports Create, Read, Update and Delete operations on major modules - Unlimited updates of offline data! - iphone like navigations - On demand sync with the server - Ability to or call directly from your contacts - Integration with Google Maps This application comes as a boon for people desperately looking for an iphone Solution that provides full CRM functionalities and more. 4

5 2. Issues with the Community Edition & Solution 2.1 Issues CRUD (Create, Read, Update, and Delete) works perfectly fine if you are using Professional or Enterprise Edition of isugarcrm. The Community Edition does not have some of the important services required to synchronize data between client and server. If you are using a Community edition, following are the things you must keep in mind: - Conflict resolver - (that smartly handles modifications made for same data on both server and client) - does not work in Community Edition, which may result in data integrity issues - Client always gets the preference over server whenever there is a conflict while synching data The above restrictions are a result of the following Web services not being available in the Community Edition of SugarCRM: sync_get_entries sync_get_relationships We encourage users of Community Edition to report the same to SugarCRM and also request them to release the same using a patch. There will be no functional differences in the iphone client for SugarCRM once these two services are added to the Community Edition. If you are not a Professional/Enterprise Edition user it is suggested that you use the CRUD features with caution. The best practice involves changing a record at a single location (either client or server-side). If you want to change the same record again, you must first synchronize it with the server. To maintain data integrity, periodically erase all data from application settings and re-download all the data. Note: All the issues listed above are not applicable for Professional/Enterprise Edition users. 2.2 The Solution Community edition users have now a reason to smile as we have come up with a patch to take care of their problems. For details, please read Chapter 4, Application of Patch for SugarCRM Community Edition. Note: If you are a Community Edition user, you must apply the patch using the instructions provided before you start using the latest build. 5

6 3. Downloading and Installing the isugarcrm Application To get started with isugarcrm, you need to download the application. Two ways to download the application are: Using itunes Store Using Apple's AppStore 3.1 Downloading isugarcrm Using itunes Store Click the following URL to download the isugarcrm application using itunes Store: Once connected, it displays a screen like the following: 6

7 3.2 Downloading isugarcrm Using AppStore Use the following steps to download the isugarcrm application using AppStore: 1. On your iphone or ipod, tap on the AppStore icon ( ). 2. Go to the Search tab and search for SugarCRM. You can see our application along with others, with information about its functionalities. 3. Click Install. This starts the installation on your device. The isugarcrm icon is displayed on your device. Tapping on the icon launches the application. 4. The Login screen is displayed. This is an indication that your application has been properly installed. To set up the URLs, close the application. 5. Click the Settings icon. An applications menu is displayed. Select isugarcrm. 6. In the next screen, enter the SugarCRM URL. Note: Make sure that you have the proper URLs. Talk to your administrator. 7. Open the isugarcrm application. 8. Enter your login credentials on the Login screen. 9. Click Activate on the top right corner of the screen. This registers your application with SugarCRM Server and starts synchronizing your data with isugarcrm. This may take some time. Please be patient. Imp: Make sure that while downloading the data your iphone or ipod device doesn t go into sleep mode else your download may have inconsistencies. In case of inconsistencies, you need to go to the Application Information screen and click the Erase All Data button. This removes all existing data and displays the Login screen. In case of low network connection, you are provided with three retrials. The main screen is displayed once the application is up and running. You can activate your isugarcrm account on your iphone or ipod and begin using the mobile application. 7

8 3.3 isugarcrm Requirements isugarcrm is a client application you download and run on the iphone or ipod touch. The requirements for this product are: isugarcrm Requirements: You must have an active isugarcrm account to access isugarcrm on your iphone or ipod touch. If you are not already a customer, visit the isugarcrm website to sign up for a free trial. If you are not sure whether you have a isugarcrm account, contact your organization's system administrator. iphone Requirements: isugarcrm requires iphone operating system 2.0 or later. If the App Store icon is available on the home screen, you can use isugarcrm on your iphone or ipod touch. Be sure your device has at least 10 MB of available memory before installing isugarcrm. Wireless Requirements: isugarcrm relies on a cellular or Wi-Fi network to communicate with isugarcrm; however, you can continue working on your local data even when you lose connectivity to the Internet. 3.4 Before you start working with isugarcrm Before you start working with isugarcrm on your device, you should understand how to navigate around isugarcrm. For further details, refer to the iphone Native Client for SugarCRM User Guide. 8

9 4. Application of Patch for SugarCRM Community Edition As you know, some of the data services to retrieve the relationships information are not available on the Community Edition while the same are available in the Professional and Enterprise Edition of SugarCRM. Imaginea has written custom soap services to retrieve the required relationships information with minimal intrusion to the core SugarCRM code. The modification does not affect the existing functionalities and is used only to retrieve information out of SugarCRM Community Edition. No alteration of data is carried out with the use of these customer services. If you are using Community Edition of SugarCRM and want to enable the relationships among modules, - such as to relate Accounts with Contacts - you need to install this patch using the instructions below. Attention: Neither is Imaginea or Pramati Technologies, responsible for any mishap during the installation procedure, nor do we imply any guarantee whatsoever on the quality and working of this patch. You are requested to test and apply this patch at your own risk. This patch is covered under the standard licensing policy of the iphone native client for SugarCRM. We strongly recommend that this procedure is carried by an admin who is familiar with the installation and administration of SugarCRM. 4.1 Installing the Patch The patch installation is a two step process: 1. Installing the custom soap service: To install the custom soap service: i. Access the SoapSugarIphoneUsers.php file using ii. Right click and do a View Source for the content. iii. Copy the content to <SugarCRM Installation Directory>/soap folder and ensure that it has appropriate read-write permissions as the SoapSugarUsers.php file in the same folder. The above two steps complete the installation of the custom soap service. 2. Enabling the custom soap service: To enable the custom soap service: i. Call the custom soap service from the core soap service of SugarCRM. This requires a small addition to the SoapSugarUsers.php file located in the <SugarCRM Installation Directory>/soap folder. ii. Make a back up of <SugarCRM Installation Directory>/soap/ SoapSugarUsers.php by copying it into SoapSugarUsers.php.backup iii. Make the following changes to SoapSugarUsers.php as given in the images below. 1. For Importing the custom service: As indicated in the image below, insert the following line of code (highlighted in the image) in the <SugarCRM Installation Directory>/soap/SoapSugarUsers.php file at the exact location displayed: require_once( soap/soapsugariphoneusers.php ); 9

10 2. Calling the custom service: Once you have added the line of code to import the custom service, make the exact change (as indicated in the image below) in the <SugarCRM Installation Directory>/soap/SoapSugarUsers.php file to call the custom service when the call is made from the iphone. Add the following code immediately after the function get_relationships header: //stripping module ID for iphone call if($module_id== iphone ) { return get_relationships_iphone($session, $module_name, $module_id, $related_module, $related_module_query, $deleted); } Important: Please ensure that there are no spelling mistakes and also follow the case sensitivity as given in the codes above. We will not be providing any support for this unless the changes are carried out by an experienced administrator. Should the patch not work for you then please back out the changes and replace the old file from the back taken above. 10