Sugar Developer Guide 6.5

Total Page:16

File Type:pdf, Size:1020Kb

Sugar Developer Guide 6.5 Sugar Developer Guide 6.5 1 / 756 Sugar Developer Guide 6.5 ........................................... 40 Preface .......................................................... 40 Overview ....................................................... 40 The Sugar Application .............................................. 40 The Sugar Community .............................................. 40 Audience ........................................................ 41 Application Overview ............................................... 41 Core Features ................................................... 41 Sales Force Automation ............................................ 41 Marketing Automation ............................................. 42 Customer Support ............................................... 42 Collaboration .................................................. 42 Reporting .................................................... 42 Administration ................................................. 43 Introduction ....................................................... 43 Overview ....................................................... 43 Background ...................................................... 43 6 Basic Development Rules for Sugar Products ............................. 44 Application Framework .............................................. 44 Directory Structure ................................................ 45 Key Concepts ................................................... 46 Application Concepts .............................................. 46 Files ....................................................... 47 Variables ..................................................... 47 Entry Points ................................................... 47 Module Framework ................................................ 48 User Interface Framework ........................................... 51 Extension Framework ............................................... 51 Sugar Dashlets ................................................... 52 Web Services ..................................................... 52 Connectors ...................................................... 52 Application Framework .............................................. 53 Introduction ..................................................... 53 Application Framework ............................................. 53 Directory Structure ............................................... 54 Key Concepts .................................................. 55 Application Concepts ............................................. 55 Files ..................................................... 56 Variables ................................................... 56 Entry Points .................................................. 56 ACL ........................................................... 57 Overview ...................................................... 57 Access Control Lists ............................................... 57 Checking Access ................................................. 57 Parameters ................................................... 57 Example ..................................................... 58 2 / 756 Administration Links ............................................... 58 Overview ...................................................... 58 Administration Links ............................................... 58 Example ....................................................... 58 AjaxUI ......................................................... 60 Overview ...................................................... 60 About the AjaxUI ................................................. 60 Reduced server load .............................................. 60 No Full Rebuild of the Dom .......................................... 60 Script Files are not Parsed ........................................... 60 Fewer Requests Per Page ........................................... 61 Side Effects .................................................... 61 document.write ................................................. 61 onLoad ...................................................... 61 Page Order vs Execution Order ........................................ 61 JSON Responses ................................................ 62 Authentication .................................................... 63 Oauth ........................................................ 63 Overview ..................................................... 63 Using OAuth with Sugar ............................................ 63 Step 1: Establishing Consumer Key ...................................... 63 Step 2: Creating Request Token ........................................ 63 Step 3: Approve Request Token ........................................ 64 Step 4: Request Access Token ......................................... 64 Step 5: Using Access Token .......................................... 65 Charts ......................................................... 66 Custom Charts ................................................... 66 Overview ..................................................... 66 Custom Charts ................................................. 66 Connectors ...................................................... 68 Introduction .................................................... 68 Factories ...................................................... 68 Sources ....................................................... 69 Formatters ..................................................... 74 Class Definitions ................................................. 76 Examples ...................................................... 77 Creating A Custom Connector ......................................... 78 Overview ................................................... 78 Connectors .................................................. 78 Protocol Type ................................................. 78 Source .................................................... 79 Connector Class (.php) ............................................ 79 getList() ................................................. 79 getItem() ................................................ 80 test() .................................................. 81 Class Example .............................................. 82 3 / 756 Vardefs (vardefs.php) ............................................ 84 Things to Note .............................................. 86 Configuration (config.php) .......................................... 87 Labels (.lang.php) .............................................. 87 Mappings (mapping.php) ........................................... 88 Formatter ................................................... 89 Building a Module Loadable Package ..................................... 91 Dashlets ........................................................ 92 Introduction .................................................... 93 Sugar Dashlets ................................................. 93 Sugar Dashlet Files .............................................. 93 Templating .................................................. 94 Categories .................................................. 94 Sugar Dashlet base class ........................................... 94 Sugar Dashlets JavaScript ........................................... 95 Custom Dashlets ................................................. 95 Overview ..................................................... 95 Sugar Dashlets ................................................. 95 Custom Sugar Dashlets ........................................... 100 JotPadDashlet.php ............................................. 101 JotPadDashletOptions.tpl .......................................... 104 JotPadDashletScripts.tpl .......................................... 106 Refreshing the Sugar Dashlet Cache ..................................... 106 Packaging Generic Sugar Dashlets ...................................... 106 Creating Custom Chart Dashlets ....................................... 108 Databases ...................................................... 110 Indexes ...................................................... 110 Primary Keys, Foreign Keys, and GUIDs .................................. 111 Entry Points .................................................... 113 Introduction ................................................... 113 Overview .................................................... 113 Introduction to Entry Points ......................................... 113 Accessing Entry Points ............................................ 114 Custom Entry Points .............................................. 114 Overview .................................................... 114 Creating a Custom Entry Point ........................................ 114 Example .................................................. 115 File Caching .................................................... 115 Overview ..................................................... 116 What It Does ................................................... 116 Where is the Cache? .............................................. 116 Developer Mode ................................................. 116 Global Control Links ............................................... 116 Overview ..................................................... 116 Link Location .................................................. 117 Modifying the Links .............................................
Recommended publications
  • Sugar Developer Guide
    SUGAR DEVELOPER GUIDE VERSION 6.2.0 Sugar Developer Guide – 6.2.0 Sugar Developer Guide Version 6.2.0, 2011 Copyright © 2004-2011 SugarCRM Inc. www.sugarcrm.com This document is subject to change without notice. License This work is licensed under the Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 License (“License”). To view a copy of this license, visit http://www.creativecommons.org/licenses/by- nc-nd/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. Disclaimer Your Warranty, Limitations of liability and Indemnity are expressly stated in the License. Please refer to the License for the specific language governing these rights and limitations Trademarks All SugarCRM logos in this document are registered trademarks of SugarCRM Inc. See the SugarCRM trademark policies at http://www.sugarcrm.com/crm/open-source/trademark-information.html for more information on how SugarCRM trademarks can be used. 2 Table of Contents Preface ____________________________________________________________________ 10 About this Guide__________________________________________________________________ 10 Audience ________________________________________________________________________ 10 Overview ________________________________________________________________________ 10 Core Features ____________________________________________________________________ 11 Related Documentation ____________________________________________________________ 12 Chapter 1: SugarCRM Overview ________________________________________________
    [Show full text]
  • Ostechnix Install Sugarcrm on Centos 6.4 / RHEL / 6.4 / Scientific
    Install SugarCRM on CentOS 6.4 / RHEL / 6.4 / Scientific... http://ostechnix.wordpress.com/2013/05/08/install-suga... Ostechnix Open source and Linux How-to articles, Manuals, Tips & Tricks Install SugarCRM on CentOS 6.4 / RHEL / 6.4 / Scientific Linux 6.4 May 8, 2013 ~ Admin SugarCRM (http://www.sugarcrm.com/) is a web based CRM(Customer Relationship Management) Solution written in PHP. It comes with different editions such as Enterprise, Ultimate, Corporate" Professional and Community(free) editions. For more details about the editions refer the official link (http://support.sugarcrm.com/02_Documentation/01_Sugar_Editions). (http://ostechnix.files.wordpress.com/2013/05 /images.jpeg) In this how-to, i am gonna to show you how to install SugarCRM (http://sugarcrm.com) Community edition in CentOS 6.4. Prerequisites Install the necessary so twares such as MySQL (http://www.mysql.com), Apache and PHP modules first as shown below. 1 de 18 28/10/14 12:44 Install SugarCRM on CentOS 6.4 / RHEL / 6.4 / Scientific... http://ostechnix.wordpress.com/2013/05/08/install-suga... [root@server ~]# yum install mysql mysql-server httpd php php-devel php-gd php-imap php 7 ter installing the above prerequisites, we need to tune the PHP settings. To do that open file /etc/php.ini and adjust the following settings. Make sure that memory_limit is set as 128M" post_max_size and upload_max_size as 20M. [root@server ~]# vi /etc/php.ini memory_limit = 128M post_max_size = 20M upload_max_filesize = 20M 1nce done this reboot the server to save the changes. Now start Apache and MySQL services and make them to start automatically on e8ery reboot.
    [Show full text]
  • Building an Automation System for Customer Acquisition Processes
    Aleksandr Romanov Building an automation system for customer acquisition processes Bachelor’s thesis Information Technology 2017 Author (authors) Degree Time Aleksandr Romanov Bachelor of May 2017 Engineering, Information Technology Title 56 pages Building an automation system for customer acquisition 3 pages of appendices processes Commissioned by Caterva GmbH Supervisor Timo Mynttinen Abstract CRM software has been supporting companies in their internal customer acquisition processes for decades. However, in the field of renewable energy storage, which involves the handling of a larger amount of customer related information, traditional CRM systems become less effective and the need for more efficient software is required The objective of the thesis was to implement the initial state of the automation system for customer acquisition processes, required by the case company in order to remove the future complexity in managing information manually. The methods used for designing and implementing the system were influenced by a set of predefined software requirements and the existing state of internal CRM software. The thesis described the solutions, including the design of communication mechanism between the external CRM system and an internal one, performing new data creation and updates, utilizing the RESTful APIs provided by Sugar CRM system and finally the development and testing of the automation workflow. The outcome of the development was a functioning part of the automation system which was performing the required tasks, supporting internal employees. Since the project was focused on the initial important functionality, the potential improvements and extensions were discussed in the thesis. Keywords Software Engineering, Sugar CRM, PHP, MySQL, REST, API, OAuth, Linux CONTENTS 1 INTRODUCTION .........................................................................................................
    [Show full text]
  • Sugar Professional Application Guide
    Sugar Professional Application Guide Version 6.2.1 Copyright Information Sugar Professional Application Guide Version 6.2.1, 2011 Copyright © 2004-2011 SugarCRM Inc. www.sugarcrm.com This document is subject to change without notice. License The contents of this document are subject to the Sugar Professional Subscription Agreement (“Agreement”). You may not use this document except in compliance with the Agreement. Disclaimer Your Warranty, Limitations of liability and Indemnity are expressly stated in the Agreement. Please refer to the Agreement for the specific language governing these rights and limitations under the Agreement. Trademarks All SugarCRM logos in this document are registered trademarks of SugarCRM Inc. See the SugarCRM trademark policies at http://www.sugarcrm.com/crm/open-source/trademark-information.html for more information on how SugarCRM trademarks can be used. 07/13/11 Preface Welcome to Sugar, a commercial open source Customer Relationship Management (CRM) application. Sugar enables organizations to organize, populate, and maintain information efficiently on all aspects of their customer relationships. It provides integrated management of corporate information on customer accounts and contacts, sales leads and opportunities, plus activities such as calls, meetings, and assigned tasks. The system seamlessly blends all the functions required to manage information on many aspects of your business into an intuitive and user-friendly graphical interface. The system also offers a graphical dashboard to track the sales pipeline, the most successful lead sources, and the month-by-month outcomes for opportunities in the pipeline. Sugar is based on an open source project, and therefore, advances quickly through the development and contribution of new features by its supporting community.
    [Show full text]
  • The Three of Comparison of Open Source Customer Relationship Management (Crm) Software
    THE THREE OF COMPARISON OF OPEN SOURCE CUSTOMER RELATIONSHIP MANAGEMENT (CRM) SOFTWARE Ayuditya Annisa Edmarani (1006822694) Desi Ratiwi (1006822744) Mochamad Luthfi Suladria (1006822952) Nikmatul Wachidah (1006822965) Putri Sidratul Muntaha (1006823002) March 2012 ABSTRACT Customer Relationship Management (CRM) softwares are very common in large companies. However, CRM softwares are not very common in small and medium company. Open source CRM softwares are often targeted to enterprises whose requirements are not covered by standard software. Similar circumstances apply to organizations that need continuous adaption of the software to changing processes and needs. Therefore a company have to start implementing Information Systems (IS) technology into their business operations in order to improve business values and gain more competitive advantage over rivals. CRM software has the potential to help improve the business value and competitive capabilities of the company. And in this paper the suitability of current open source CRM softwares for these enterprises will be examined. It provides sufficient information for a small or medium enterprise to choose a flexible and adaptable open source CRM software. Then selected open source CRM projects are reviewed and classified according to these criteria. The results are a criteria catalog and a classification of selected open source CRM softwares. Keywords: CRM, Open Source, SugarCRM, Vtiger, SplendidCRMSoftware I. INTRODUCTION In an era of financial crisis and expense reduction it is important that companies keep pace with changing technologies and markets, adopting strategies for tracking trends, but which are not expensive. Because the current economic crisis leads companies to adopt strategies in order to fight against the difficulties. Regarding the costs, the purchase of open source software is free and the hardware associated to the systems has lower costs.
    [Show full text]
  • ADMINISTRACIJA SISTEMA CRM Diplomsko Delo
    Mitja Ristič ADMINISTRACIJA SISTEMA CRM Diplomsko delo Maribor, september 2016 ADMINISTRACIJA SISTEMA CRM Diplomsko delo Študent: Mitja Ristič Študijski program: visokošolski študijski program Računalništvo in informacijske tehnologije Smer: / Mentor: doc. dr. Danilo Korže Lektor(ica): prof. Barbara Škorc i ii ZAHVALA Za strokovno pomoč, vodenje in potrpežljivost pri nastajanju diplomskega dela se zahvaljujem mojemu mentorju, doc. dr. Danilu Koržetu. Za finančno podporo in informacije, ki sem jih lahko uporabil za izdelavo diplomskega dela se zahvaljujem mojem štipenditorju, podjetju Gora d.o.o., Ljubljana in so-mentorici Mateji Čampa. Prav tako iz srca hvala mami Tatjani in očetu Deanu za neizmerno ljubezen, spodbudo in podporo skozi vsa leta mojega šolanja. Hvala tudi sošolcem in prijateljem, ki so mi v tem času stali ob strani. iii ADMINISTRACIJA SISTEMA CRM Ključne besede: administrator, sistemi CRM, upravljanje odnosov s strankami, marketing UDK: 005.336.5:005.57(043.2) Povzetek V diplomski nalogi je predstavljeno upravljanje odnosov s strankami, tako njegov koncept kot njegova povezanost z informacijsko tehnologijo. Po kriterijih podjetja Gora d.o.o, Ljubljana je opisana analiza trga programa CRM in njihovih ponudnikov. Opisane so tudi prednosti po integraciji sistema v podjetje. Predstavljeni sta vloga administratorja sistema CRM in njegova opravila z vidika sistemske administracije. Praktični del diplomske naloge vključuje predvsem opis namestitve in konfiguracije programske opreme SuiteCRM ter nekatera orodja za razvijalce. V zaključku je predstavljena kreacija modula, narejenega po meri z orodji za razvijalce. iv ADMINISTRATION OF THE CRM SYSTEM Key words: administrator, CRM system, customer relationship management, marketing UDK: 005.336.5:005.57(043.2) Abstract The thesis is presenting the concept of customer relationship management, as well as its connection with information technology.
    [Show full text]
  • Implementing Sugarcrm Introduce the Leading Open Source CRM Application Into Your Small/Mid-Size Business with This Systematic, Practical Guide
    Implementing SugarCRM Introduce the leading Open Source CRM application into your small/mid-size business with this systematic, practical guide "Not just a powerful guide to SugarCRM, it's a practical, hands on introduction to CRM as a whole." – Bernard Golden, Author, "Succeeding with Open Source" Michael J.R. Whitehead BIRMINGHAM - MUMBAI Implementing SugarCRM A practical guide for small-medium businesses Copyright © 2006 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, Packt Publishing, nor its dealers or distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: February 2006 Production Reference: 1030206 Published by Packt Publishing Ltd. 32 Lincoln Road Olton Birmingham, B27 6PA, UK. ISBN 1-904811-68-X www.packtpub.com Cover Design by www.visionwt.com Credits Author Development Editor Michael J.R. Whitehead David Barnes Reviewer Indexer Alan Sutton Ashutosh Pande Technical Editors Proofreader Nanda Padmanabhan Chris Smith Rushabh Sanghavi Production Coordinator Editorial Manager Manjiri Nadkarni Dipali Chittar Cover Designer Helen Wood About the Author Michael J.
    [Show full text]
  • Openerp OUTLINE WARNING
    Credits: Guillaume Rivière 2013 – 2018 OUTLINE 1. Overview – Birth and growth OpenERP – Customers, Partners, Vendors 2. Administration – Versions, Architecture Overview, Introduction to – Main modules Administration & Development 3. Development – Module programming – EFREI – – Webservice programming – ESTIA – Guillaume Rivière 4. Documentation Last update: March 2018 1 2 WARNING !!! History of OpenERP • You are going to learn one ERP • Initiated by Fabien Pinckaers – But keep in mind to select an ERP only because it is – in 2002, in Belgium the best adapted to the case of your company – Written in Python Our competitors – Database is PostgreSQL This ERP fits all the use this ERP !!! This is the only needs of my company. – Open Source (but not free software, according to FSF) ERP i know … • Licence: AGPL v3 2002 2004 2005 2006 2008 2009 2011 2012 2013 2014 2015 2016 2017 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0 10.0 11.0 1.0 2.0 3.0 3.4 3.6 4.0 4.6 3 4 OpenERP today Hardware needed • Used for teaching since 2008 • 5 employees: 2 CPU 2GB RAM – The CERTA network teach accounting to BTS • 20 employees: 4 CPU 8GB RAM – CERPEG • 90 employees: 2x 8 CPU 32GB RAM • Arround the world, we find dozens of – Split application and database server Customers, Vendors and Partners • 250+ employees: 2x 12 CPU 128 GB RAM • Still supported Long Term Stable versions (LTS) – Load balancing – Version 7.0 released in December 2012 – Version 8.0 released in September 2014 – Version 9.0 released in October2015 • Enterprise (20€/user/month) & Community (90%) Editions
    [Show full text]
  • CUSTOMER RELATIONSHIP MANAGEMENT Implementing
    Implementing SugarCRM Introduce the leading Open Source CRM application into your small/mid-size business with this systematic, practical guide "Not just a powerful guide to SugarCRM, it's a practical, hands on introduction to CRM as a whole." – Bernard Golden, Author, "Succeeding with Open Source" Michael J.R. Whitehead BIRMINGHAM - MUMBAI Implementing SugarCRM A practical guide for small-medium businesses Copyright © 2006 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, Packt Publishing, nor its dealers or distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: February 2006 Production Reference: 1030206 Published by Packt Publishing Ltd. 32 Lincoln Road Olton Birmingham, B27 6PA, UK. ISBN 1-904811-68-X www.packtpub.com Cover Design by www.visionwt.com Credits Author Development Editor Michael J.R. Whitehead David Barnes Reviewer Indexer Alan Sutton Ashutosh Pande Technical Editors Proofreader Nanda Padmanabhan Chris Smith Rushabh Sanghavi Production Coordinator Editorial Manager Manjiri Nadkarni Dipali Chittar Cover Designer Helen Wood About the Author Michael J.
    [Show full text]
  • Open Source Development
    G E T T I N G S T A R T E D W I T H Open source development A book for the community by the community Rachna Kapur, Mario Briggs, Tapas Saha, Ulisses Costa, Pedro Carvalho, Raul F. Chong, Peter Kohlmann F I R S T E D I T I O N 4 Getting started with open source development First Edition (July 2010) © Copyright IBM Corporation 2010. All rights reserved. IBM Canada 8200 Warden Avenue Markham, ON L6G 1C7 Canada 5 Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd.
    [Show full text]
  • Unleashing Application Performance with Solid-State Drives and Sun Servers
    An Oracle White Paper May 2010 Unleashing Application Performance with Solid-State Drives and Sun Servers Unleashing Application Performance with Solid-State Drives and Sun Servers Executive Overview ........................................................................... 1 Introduction ....................................................................................... 1 Computing Cost and Performance Challenges .................................. 3 Performance Bottlenecks ............................................................... 3 Power and Cooling ........................................................................ 4 Increasing Complexity and Decreasing Reliability .......................... 4 SSDs Address the Need for Speed ................................................... 5 Flash Economies ........................................................................... 5 Fast, Predictable Performance ...................................................... 6 SSDs for Performance and HDDs for Capacity .............................. 6 Application Economics................................................................... 7 Flashing the Datacenter .................................................................... 7 Better Application Performance ..................................................... 8 Reducing the Footprint .................................................................. 8 Greener IT ..................................................................................... 8 Less Maintenance and Support ....................................................
    [Show full text]
  • Using IBM DB2 for I As a Storage Engine of Mysql
    Front cover Using IBM DB2 for i as a Storage Engine of MySQL Discover how to configure and manage the IBMDB2I Storage Engine Integrate and consolidate MySQL and DB2 in one place Access PHP Applications data through native interfaces Hernando Bedoya Brad Bentley Xie Dan Dan Sadamitsu Hayakawa Shirley Pintos Guo Qi Morten Buur Rasmussen Satid Singkorapoom Wang Yun ibm.com/redbooks International Technical Support Organization Using IBM DB2 for i as a Storage Engine of MySQL March 2009 SG24-7705-00 Note: Before using this information and the product it supports, read the information in “Notices” on page vii. First Edition (March 2009) This edition applies to IBM i 6.1 © Copyright International Business Machines Corporation 2009. All rights reserved. Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Notices . vii Trademarks . viii Preface . ix The team that wrote this book . ix Become a published author . xi Comments welcome. xii Chapter 1. Overview . 1 1.1 MySQL on IBM i . 2 1.2 MySQL pluggable storage engine. 3 1.3 IBM DB2 for i Storage Engine for MySQL on IBM i. 5 Chapter 2. Architecture and functional support. 7 2.1 Architecture introduction . 8 2.2 DB2 for i SQL Server Mode . 9 2.3 Using the IBMDB2I Storage Engine . 10 2.3.1 Plugging in the storage engine . 10 2.3.2 Unplugging the storage engine . 10 2.3.3 Setting the storage engine . 11 2.3.4 MySQL metadata files when using IBMDB2I . 11 2.4 Comparison of MySQL and DB2 for i .
    [Show full text]