Bureaucrats, confirmed, Administrators
4,558
edits
Changes
m
The instructions also fail to mention that the application wants to create a .htaccess file (which doesn<source lang="php">print 't exist in the distribution and would not necessarily be writable to the web user. As a failsafe, the information is printed to the screen in the installer. However it doesn<pre>'t properly display ; var_export (lacking newline characters$arrFields) which would make the content suitable for ; print '</pre>';// copy and paste that output; then add comments about which fields go into which table// comment the file. whole block so that it remains as a reference in the toolarray ( 0 => 'Company Name',// a:name 1 => 'Industry', // a:industry 2 => 'First Name', I found the source which generates the .htaccess content// c:first_name 3 => 'Last Name', // c:last_name 4 => 'Fax', // a:phone_fax c:phone_fax 5 => 'Address', // a:billing_address_street c:primary_address_street 6 => 'City', // a:billing_address_city c:primary_address_city 7 => 'State', // a:billing_address_state c:primary_address_state 8 => 'Zip Code', // a:billing_address_postalcode c:primary_address_postalcode 9 => 'Country', // a:billing_address_country c:primary_address_country 10 => 'Notes', // a:description 11 => 'Work Phone', // a:phone_office c:phone_work 12 => 'Other Phone',// a:phone_alternate c:phone_other 13 => 'Email', // a:email c:email1 14 => 'website', // a:website 15 => 'employees', and used that. An alternative is to simply touch and chmod // a:employees 16 => 'ticker_symbol'// a .htaccess file prior to running the installer.:ticker_symbol )</source>
=== Existing Work ===My first instinct was to find info about somebody doing this before (e.g. APIs, Documentation, forum questions, Wikis) I searched the wiki for importing or APIs and quickly The form can be found in the SOAP Intro and Practical Examples, so I figured I was onto a fast track.However, the soap example worked with a frontend form (which wasn't explained much) leading me to investigate more into what was required by "examples" directory in the soap servicesource. When I found Note: the form in "examples", it example did not work as an application entry point (because even though it defined ('sugarEntry', true); there was also an IF that pre-empted that definition) -- because other code was being loaded before requests inside the SugarCRM install directory will automatically bootstrap the formSugarCRM system). I did not immediately see To work around this cause for the example failure, so I either put the example form outside the application directory and successfully used or define sugarEntry as true ''without'' the 'if' conditional. Using the lead capture form to insert a single lead This is illustrated at http://www.sugarcrm.com/wiki/index.php?title=Creating_a_lead_capture_form_for_your_websiteSeeing that the example workedIf your needs are more complex, but did not capture all the details provided in the data exercise, I knew I should look you can learn more by looking at the existing functionality of modules dealing with Import (dataMaps), the database abstraction layer (SugarBeans and VarDefs) or the database directly to get a clearer picture of what I needed to label everythinggoing on in the SugarCRM system.
My second instinct was to look at the source. Answers are always found in the source, with the caveat that it can be confusing and/or time-consuming to find those answers.
-->
array (
'modules' =>
array (
0 => 'Home',
1 => 'Dashboard',
2 => 'Calendar',
3 => 'Activities',
4 => 'Emails',
5 => 'Documents',
6 => 'Contacts',
7 => 'Accounts',
8 => 'Campaigns',
9 => 'Leads',
10 => 'Opportunities',
11 => 'Project',
12 => 'Cases',
13 => 'Bugs',
14 => 'iFrames',
15 => 'Feeds',
16 => 'Administration',
17 => 'Currencies',
18 => 'CustomFields',
19 => 'Dropdown',
20 => 'Dynamic',
21 => 'DynamicFields',
22 => 'DynamicLayout',
23 => 'EditCustomFields',
24 => 'EmailTemplates',
25 => 'Help',
26 => 'Import',
27 => 'MySettings',
28 => 'FieldsMetaData',
29 => 'UpgradeWizard',
30 => 'Releases',
31 => 'Sync',
32 => 'Users',
33 => 'Versions',
34 => 'EmailMan',
35 => 'ProjectTask',
36 => 'TargetLists',
37 => 'Targets',
38 => 'Prospects',
39 => 'ProspectLists',
40 => 'Employees',
41 => 'LabelEditor',
42 => 'Roles',
43 => 'EmailMarketing',
44 => 'OptimisticLock',
45 => 'TeamMemberships',
46 => 'Audit',
47 => 'MailMerge',
48 => 'MergeRecords',
49 => 'EmailAddresses',
50 => 'Schedulers',
51 => 'Schedulers_jobs',
52 => 'InboundEmail',
53 => 'CampaignLog',
54 => 'Groups',
55 => 'ACLActions',
56 => 'ACLRoles',
57 => 'CampaignTrackers',
58 => 'DocumentRevisions',
59 => 'ACL',
60 => 'Configurator',
61 => 'UserPreferences',
62 => 'SavedSearch',
63 => 'Studio',
64 => 'Calls',
65 => 'Meetings',
66 => 'Notes',
67 => 'Tasks',
),
'error' =>
array (
'number' => '0',
'name' => 'No Error',
'description' => 'No Error',
),
)
<source lang="php">
array (
'module_name' => 'Accounts',
'module_fields' =>
array (
0 =>
array (
'name' => 'id',
'type' => 'id',
'label' => 'ID',
'required' => 0,
'options' =>
array (
),
),
1 =>
array (
'name' => 'name',
'type' => 'name',
'label' => 'Name:',
'required' => 1,
'options' =>
array (
),
),
2 =>
array (
'name' => 'date_entered',
'type' => 'datetime',
'label' => 'Date Entered:',
'required' => 0,
'options' =>
array (
),
),
3 =>
array (
'name' => 'date_modified',
'type' => 'datetime',
'label' => 'Date Modified:',
'required' => 0,
'options' =>
array (
),
),
4 =>
array (
'name' => 'modified_user_id',
'type' => 'assigned_user_name',
'label' => 'Modified By Id',
'required' => 0,
'options' =>
array (
),
),
5 =>
array (
'name' => 'modified_by_name',
'type' => 'assigned_user_name',
'label' => 'Modified By Id',
'required' => 0,
'options' =>
array (
),
),
6 =>
array (
'name' => 'created_by',
'type' => 'assigned_user_name',
'label' => 'Created By Id',
'required' => 0,
'options' =>
array (
),
),
7 =>
array (
'name' => 'created_by_name',
'type' => 'assigned_user_name',
'label' => 'Created By Id',
'required' => 0,
'options' =>
array (
),
),
8 =>
array (
'name' => 'description',
'type' => 'text',
'label' => 'Description:',
'required' => 0,
'options' =>
array (
),
),
9 =>
array (
'name' => 'deleted',
'type' => 'bool',
'label' => 'Deleted',
'required' => 0,
'options' =>
array (
),
),
10 =>
array (
'name' => 'assigned_user_id',
'type' => 'relate',
'label' => 'Assigned User:',
'required' => 0,
'options' =>
array (
),
),
11 =>
array (
'name' => 'assigned_user_name',
'type' => 'relate',
'label' => 'Assigned to:',
'required' => 0,
'options' =>
array (
),
),
12 =>
array (
'name' => 'account_type',
'type' => 'enum',
'label' => 'Type:',
'required' => 0,
'options' =>
array (
0 =>
array (
'name' => '',
'value' => '',
),
1 =>
array (
'name' => 'Analyst',
'value' => 'Analyst',
),
2 =>
array (
'name' => 'Competitor',
'value' => 'Competitor',
),
3 =>
array (
'name' => 'Customer',
'value' => 'Customer',
),
4 =>
array (
'name' => 'Integrator',
'value' => 'Integrator',
),
5 =>
array (
'name' => 'Investor',
'value' => 'Investor',
),
6 =>
array (
'name' => 'Partner',
'value' => 'Partner',
),
7 =>
array (
'name' => 'Press',
'value' => 'Press',
),
8 =>
array (
'name' => 'Prospect',
'value' => 'Prospect',
),
9 =>
array (
'name' => 'Reseller',
'value' => 'Reseller',
),
10 =>
array (
'name' => 'Other',
'value' => 'Other',
),
),
),
13 =>
array (
'name' => 'industry',
'type' => 'enum',
'label' => 'Industry:',
'required' => 0,
'options' =>
array (
0 =>
array (
'name' => '',
'value' => '',
),
1 =>
array (
'name' => 'Apparel',
'value' => 'Apparel',
),
2 =>
array (
'name' => 'Banking',
'value' => 'Banking',
),
3 =>
array (
'name' => 'Biotechnology',
'value' => 'Biotechnology',
),
4 =>
array (
'name' => 'Chemicals',
'value' => 'Chemicals',
),
5 =>
array (
'name' => 'Communications',
'value' => 'Communications',
),
6 =>
array (
'name' => 'Construction',
'value' => 'Construction',
),
7 =>
array (
'name' => 'Consulting',
'value' => 'Consulting',
),
8 =>
array (
'name' => 'Education',
'value' => 'Education',
),
9 =>
array (
'name' => 'Electronics',
'value' => 'Electronics',
),
10 =>
array (
'name' => 'Energy',
'value' => 'Energy',
),
11 =>
array (
'name' => 'Engineering',
'value' => 'Engineering',
),
12 =>
array (
'name' => 'Entertainment',
'value' => 'Entertainment',
),
13 =>
array (
'name' => 'Environmental',
'value' => 'Environmental',
),
14 =>
array (
'name' => 'Finance',
'value' => 'Finance',
),
15 =>
array (
'name' => 'Government',
'value' => 'Government',
),
16 =>
array (
'name' => 'Healthcare',
'value' => 'Healthcare',
),
17 =>
array (
'name' => 'Hospitality',
'value' => 'Hospitality',
),
18 =>
array (
'name' => 'Insurance',
'value' => 'Insurance',
),
19 =>
array (
'name' => 'Machinery',
'value' => 'Machinery',
),
20 =>
array (
'name' => 'Manufacturing',
'value' => 'Manufacturing',
),
21 =>
array (
'name' => 'Media',
'value' => 'Media',
),
22 =>
array (
'name' => 'Not For Profit',
'value' => 'Not For Profit',
),
23 =>
array (
'name' => 'Recreation',
'value' => 'Recreation',
),
24 =>
array (
'name' => 'Retail',
'value' => 'Retail',
),
25 =>
array (
'name' => 'Shipping',
'value' => 'Shipping',
),
26 =>
array (
'name' => 'Technology',
'value' => 'Technology',
),
27 =>
array (
'name' => 'Telecommunications',
'value' => 'Telecommunications',
),
28 =>
array (
'name' => 'Transportation',
'value' => 'Transportation',
),
29 =>
array (
'name' => 'Utilities',
'value' => 'Utilities',
),
30 =>
array (
'name' => 'Other',
'value' => 'Other',
),
),
),
14 =>
array (
'name' => 'annual_revenue',
'type' => 'varchar',
'label' => 'Annual Revenue:',
'required' => 0,
'options' =>
array (
),
),
15 =>
array (
'name' => 'phone_fax',
'type' => 'phone',
'label' => 'Fax:',
'required' => 0,
'options' =>
array (
),
),
16 =>
array (
'name' => 'billing_address_street',
'type' => 'varchar',
'label' => 'Billing Street:',
'required' => 0,
'options' =>
array (
),
),
17 =>
array (
'name' => 'billing_address_city',
'type' => 'varchar',
'label' => 'Billing City:',
'required' => 0,
'options' =>
array (
),
),
18 =>
array (
'name' => 'billing_address_state',
'type' => 'varchar',
'label' => 'Billing State:',
'required' => 0,
'options' =>
array (
),
),
19 =>
array (
'name' => 'billing_address_postalcode',
'type' => 'varchar',
'label' => 'Billing Postal Code:',
'required' => 0,
'options' =>
array (
),
),
20 =>
array (
'name' => 'billing_address_country',
'type' => 'varchar',
'label' => 'Billing Country:',
'required' => 0,
'options' =>
array (
),
),
21 =>
array (
'name' => 'rating',
'type' => 'varchar',
'label' => 'Rating:',
'required' => 0,
'options' =>
array (
),
),
22 =>
array (
'name' => 'phone_office',
'type' => 'phone',
'label' => 'Phone Office:',
'required' => 0,
'options' =>
array (
),
),
23 =>
array (
'name' => 'phone_alternate',
'type' => 'phone',
'label' => 'Alternate Phone:',
'required' => 0,
'options' =>
array (
),
),
24 =>
array (
'name' => 'website',
'type' => 'varchar',
'label' => 'Website:',
'required' => 0,
'options' =>
array (
),
),
25 =>
array (
'name' => 'ownership',
'type' => 'varchar',
'label' => 'Ownership:',
'required' => 0,
'options' =>
array (
),
),
26 =>
array (
'name' => 'employees',
'type' => 'num',
'label' => 'Employees:',
'required' => 0,
'options' =>
array (
),
),
27 =>
array (
'name' => 'ticker_symbol',
'type' => 'varchar',
'label' => 'Ticker Symbol:',
'required' => 0,
'options' =>
array (
),
),
28 =>
array (
'name' => 'shipping_address_street',
'type' => 'varchar',
'label' => 'Shipping Street:',
'required' => 0,
'options' =>
array (
),
),
29 =>
array (
'name' => 'shipping_address_city',
'type' => 'varchar',
'label' => 'Shipping City:',
'required' => 0,
'options' =>
array (
),
),
30 =>
array (
'name' => 'shipping_address_state',
'type' => 'varchar',
'label' => 'Shipping State:',
'required' => 0,
'options' =>
array (
),
),
31 =>
array (
'name' => 'shipping_address_postalcode',
'type' => 'varchar',
'label' => 'Shipping Postal Code:',
'required' => 0,
'options' =>
array (
),
),
32 =>
array (
'name' => 'shipping_address_country',
'type' => 'varchar',
'label' => 'Shipping Country:',
'required' => 0,
'options' =>
array (
),
),
33 =>
array (
'name' => 'email1',
'type' => 'varchar',
'label' => 'Email:',
'required' => 0,
'options' =>
array (
),
),
34 =>
array (
'name' => 'parent_id',
'type' => 'id',
'label' => 'Parent Account ID',
'required' => 0,
'options' =>
array (
),
),
35 =>
array (
'name' => 'sic_code',
'type' => 'varchar',
'label' => 'SIC Code:',
'required' => 0,
'options' =>
array (
),
),
36 =>
array (
'name' => 'account_name',
'type' => 'relate',
'label' => 'Account Name:',
'required' => 0,
'options' =>
array (
),
),
37 =>
array (
'name' => 'parent_name',
'type' => 'relate',
'label' => 'Member of:',
'required' => 0,
'options' =>
array (
),
),
38 =>
array (
'name' => 'campaign_id',
'type' => 'id',
'label' => 'Campaign ID',
'required' => 0,
'options' =>
array (
),
),
),
'error' => '',
)
</source>
<source lang="php">array ( 'module_name' => '[[Importing_contacts/Contacts|See the SOAP profile for Contacts', 'module_fields' => array ( 0 => array ( 'name' => 'id', 'type' => 'id', 'label' => 'ID:', 'required' => 0, 'options' => array ( ), ), 1 => array ( 'name' => 'date_entered', 'type' => 'datetime', 'label' => 'Date Created', 'required' => 0, 'options' => array ( ), ), 2 => array ( 'name' => 'date_modified', 'type' => 'datetime', 'label' => 'Date Modified:', 'required' => 0, 'options' => array ( ), ), 3 => array ( 'name' => 'modified_user_id', 'type' => 'assigned_user_name', 'label' => 'Modified By Id', 'required' => 0, 'options' => array ( ), ), 4 => array ( 'name' => 'modified_by_name', 'type' => 'assigned_user_name', 'label' => 'Modified By Id', 'required' => 0, 'options' => array ( ), ), 5 => array ( 'name' => 'created_by', 'type' => 'assigned_user_name', 'label' => 'Created By Id', 'required' => 0, 'options' => array ( ), ), 6 => array ( 'name' => 'created_by_name', 'type' => 'assigned_user_name', 'label' => 'Created By Id', 'required' => 0, 'options' => array ( ), ), 7 => array ( 'name' => 'description', 'type' => 'text', 'label' => 'Description:', 'required' => 0, 'options' => array ( ), ), 8 => array ( 'name' => 'deleted', 'type' => 'bool', 'label' => 'Deleted', 'required' => 0, 'options' => array ( ), ), 9 => array ( 'name' => 'assigned_user_id', 'type' => 'relate', 'label' => 'Assigned User', 'required' => 0, 'options' => array ( ), ), 10 => array ( 'name' => 'assigned_user_name', 'type' => 'relate', 'label' => 'Assigned to:', 'required' => 0, 'options' => array ( ), ), 11 => array ( 'name' => 'salutation', 'type' => 'enum', 'label' => 'Salutation:', 'required' => 0, 'options' => array ( 0 => array ( 'name' => '', 'value' => '', ), 1 => array ( 'name' => 'Mr.', 'value' => 'Mr.', ), 2 => array ( 'name' => 'Ms.', 'value' => 'Ms.', ), 3 => array ( 'name' => 'Mrs.', 'value' => 'Mrs.', ), 4 => array ( 'name' => 'Dr.', 'value' => 'Dr.', ), 5 => array ( 'name' => 'Prof.', 'value' => 'Prof.', ), ), ), 12 => array ( 'name' => 'first_name', 'type' => 'varchar', 'label' => 'First Name:', 'required' => 0, 'options' => array ( ), ), 13 => array ( 'name' => 'last_name', 'type' => 'varchar', 'label' => 'Last Name:', 'required' => 1, 'options' => array ( ), ), 14 => array ( 'name' => 'title', 'type' => 'varchar', 'label' => 'Title:', 'required' => 0, 'options' => array ( ), ), 15 => array ( 'name' => 'department', 'type' => 'varchar', 'label' => 'Department:', 'required' => 0, 'options' => array ( ), ), 16 => array ( 'name' => 'do_not_call', 'type' => 'bool', 'label' => 'Do Not Call:', 'required' => 0, 'options' => array ( ), ), 17 => array ( 'name' => 'phone_home', 'type' => 'phone', 'label' => 'Home:', 'required' => 0, 'options' => array ( ), ), 18 => array ( 'name' => 'phone_mobile', 'type' => 'phone', 'label' => 'Mobile:', 'required' => 0, 'options' => array ( ), ), 19 => array ( 'name' => 'phone_work', 'type' => 'phone', 'label' => 'Office Phone:', 'required' => 0, 'options' => array ( ), ), 20 => array ( 'name' => 'phone_other', 'type' => 'phone', 'label' => 'Other Phone:', 'required' => 0, 'options' => array ( ), ), 21 => ]] array ( 'name' => 'phone_fax', 'type' => 'phone', 'label' => 'Fax:', 'required' => 0, 'options' => array ( ), ), 22 => array ( 'name' => 'email1', 'type' => 'varchar', 'label' => 'Email:', 'required' => 0, 'options' => array ( ), ), 23 => array ( 'name' => 'email2', 'type' => 'varchar', 'label' => 'Other Email:', 'required' => 0, 'options' => array ( ), ), 24 => array ( 'name' => 'primary_address_street', 'type' => 'varchar', 'label' => 'Primary Address Street:', 'required' => 0, 'options' => array ( ), ), 25 => array ( 'name' => 'primary_address_city', 'type' => 'varchar', 'label' => 'Primary Address City:', 'required' => 0, 'options' => array ( ), ), 26 => array ( 'name' => 'primary_address_state', 'type' => 'varchar', 'label' => 'Primary Address State:', 'required' => 0, 'options' => array ( ), ), 27 => array ( 'name' => 'primary_address_postalcode', 'type' => 'varchar', 'label' => 'Primary Address Postal Code:', 'required' => 0, 'options' => array ( ), ), 28 => array ( 'name' => 'primary_address_country', 'type' => 'varchar', 'label' => 'Primary Address Country:', 'required' => 0, 'options' => array ( ), ), 29 => array ( 'name' => 'alt_address_street', 'type' => 'varchar', 'label' => 'Alternate Address Street:', 'required' => 0, 'options' => array ( ), ), 30 => array ( 'name' => 'alt_address_city', 'type' => 'varchar', 'label' => 'Alternate Address City:', 'required' => 0, 'options' => array ( ), ), 31 => array ( 'name' => 'alt_address_state', 'type' => 'varchar', 'label' => 'Alternate Address State:', 'required' => 0, 'options' => array ( ), ), 32 => array ( 'name' => 'alt_address_postalcode', 'type' => 'varchar', 'label' => 'Alternate Address Postal Code:', 'required' => 0, 'options' => array ( ), ), 33 => array ( 'name' => 'alt_address_country', 'type' => 'varchar', 'label' => 'Alternate Address Country:', 'required' => 0, 'options' => array ( ), ), 34 => array ( 'name' => 'assistant', 'type' => 'varchar', 'label' => 'Assistant:', 'required' => 0, 'options' => array ( ), ), 35 => array ( 'name' => 'assistant_phone', 'type' => 'phone', 'label' => 'Assistant Phone:', 'required' => 0, 'options' => array ( ), ), 36 => array ( 'name' => 'lead_source', 'type' => 'enum', 'label' => 'Lead Source:', 'required' => 0, 'options' => array ( 0 => array ( 'name' => '', 'value' => '', ), 1 => array ( 'name' => 'Cold Call', 'value' => 'Cold Call', ), 2 => array ( 'name' => 'Existing Customer', 'value' => 'Existing Customer', ), 3 => array ( 'name' => 'Self Generated', 'value' => 'Self Generated', ), 4 => array ( 'name' => 'Employee', 'value' => 'Employee', ), 5 => array ( 'name' => 'Partner', 'value' => 'Partner', ), 6 => array ( 'name' => 'Public Relations', 'value' => 'Public Relations', ), 7 => array ( 'name' => 'Direct Mail', 'value' => 'Direct Mail', ), 8 => array ( 'name' => 'Conference', 'value' => 'Conference', ), 9 => array ( 'name' => 'Trade Show', 'value' => 'Trade Show', ), 10 => array ( 'name' => 'Web Site', 'value' => 'Web Site', ), 11 => array ( 'name' => 'Word of mouth', 'value' => 'Word of mouth', ), 12 => array ( 'name' => 'Email', 'value' => 'Email', ), 13 => array ( 'name' => 'Campaign', 'value' => 'Campaign', ), 14 => array ( 'name' => 'Other', 'value' => 'Other', ), ), ), 37 => array ( 'name' => 'account_name', 'type' => 'relate', 'label' => 'Account Name:', 'required' => 0, 'options' => array ( ), ), 38 => array ( 'name' => 'account_id', 'type' => 'relate', 'label' => 'Account ID:', 'required' => 0, 'options' => array ( ), ), 39 => array ( 'name' => 'opportunity_role_fields', 'type' => 'relate', 'label' => 'Account Name:', 'required' => 0, 'options' => array ( ), ), 40 => array ( 'name' => 'reports_to_id', 'type' => 'id', 'label' => 'Reports to ID:', 'required' => 0, 'options' => array ( ), ), 41 => array ( 'name' => 'report_to_name', 'type' => 'relate', 'label' => 'Reports To:', 'required' => 0, 'options' => array ( ), ), 42 => array ( 'name' => 'birthdate', 'type' => 'date', 'label' => 'Birthdate:', 'required' => 0, 'options' => array ( ), ), 43 => array ( 'name' => 'portal_name', 'type' => 'varchar', 'label' => 'Portal Name:', 'required' => 0, 'options' => array ( ), ), 44 => array ( 'name' => 'portal_active', 'type' => 'bool', 'label' => 'Portal Active:', 'required' => 0, 'options' => array ( ), ), 45 => array ( 'name' => 'portal_app', 'type' => 'varchar', 'label' => 'Portal Application:', 'required' => 0, 'options' => array ( ), ), 46 => array ( 'name' => 'campaign_id', 'type' => 'id', 'label' => 'Campaign ID', 'required' => 0, 'options' => array ( ), ), 47 => array ( 'name' => 'campaign_name', 'type' => 'relate', 'label' => 'Campaign:', 'required' => 0, 'options' => array ( ), ), 48 => array ( 'name' => 'c_accept_status_fields', 'type' => 'relate', 'label' => 'Accept Status', 'required' => 0, 'options' => array ( ), ), 49 => array ( 'name' => 'm_accept_status_fields', 'type' => 'relate', 'label' => 'Accept Status', 'required' => 0, 'options' => array ( ), ), ), 'error' => '',)</source>
// insert our records
The source is formatted differently, or practically not at all in some cases, due to various editors using different space and tab settings, even across different Operating Systems which leads to different line endings. PHPBeautifier used in a commit hook would solve this in the repo. Coding standards and configuration files like vim modelines would solve this on the developer desktop.[[Category:CRM]][[Category:Code]][[Category:Software]]
added Category:Software using HotCat
{{Not free|CiviCRM}}
[http://en.wikipedia.org/wiki/Sugarcrm SugarCRM] is the world's leading Customer Relationship Management (CRM) software available with complete freedom under the GPL license. For companies that want more than freedom, SugarCRM Inc, fully backs the product with expert support, service, training and customization. SugarCRM offers several deployment options, including on-demand, on-premise and appliance-based solutions to suit customers' security, integration and configuration needs. Because CRM software captures the varied relationships between a company and it's sources of revenue, most businesses really stand to benefit from the intelligence provided by a CRM system. All companies already have 'ad-hoc' methods to track leads, contacts, customer accounts and the company interactions with these (e.g. spreadsheets, lists and email records). They may even have organized CRM solutions in place. Either way, once you decide to adopt an open and standards-based solution like SugarCRM, your first order of business will be to load it with your existing data. SugarCRM has importing (and exporting) utilities that make it easy to do this, so these wizards will not be the focus of this article. Instead, we'll focus on programmatic interaction with the system.
<!--
{{Infobox Company
|company_name=SugarCRM
|company_type=Private
|foundation=[[California]] 2004
|location=[[Cupertino, California]]
|industry=CRM Software
|products= Sugar Community Edition, Sugar Professional, Sugar Enterprise
|num_employees=150+
|parent=
|subsid=
|homepage=[http://www.sugarcrm.com/ www.sugarcrm.com]
}} -->
{{Infobox
|name = SugarCRM
|bodystyle =
|title = Company Info
|titlestyle =
|above =
|abovestyle =
|image =
|imagestyle =
|caption =
|captionstyle =
|headerstyle =
|labelstyle =
|datastyle =
|header1 =
|label1 = Company Name
|data1 = SugarCRM
|header2 =
|label2 = Company Type
|data2 = private
|header3 =
|label3 = Founded
|data3 = California 2004
|header4 =
|label4 = Industry
|data4 = CRM Software
|header5 =
|label5 = Products
|data5 = Sugar Community Edition, Sugar Professional, Sugar Enterprise
|header6 =
|label6 = Employees
|data6 = 150+
|header7 =
|label7 = Website
|data7 = [http://www.sugarcrm.com/ www.sugarcrm.com]
|header8 =
|label8 =
|data8 =
|header9 =
|label9 =
|data9 =
|header10 =
|label10 =
|data10 =
}}
== Introduction ==
Typically a company will deploy the CRM system and will also create one or more pipelines which act as conduits to capture new account, and contact information. This article will show how to establish a web service, using [http://en.wikipedia.org/wiki/SOAP SOAP] to add contacts and accounts to your [[Installing SugarCRM|SugarCRM installation]]. As an example scenario, let's suppose that a conference organizer wants to offer a sign-up sheet on their existing website. The existing website could be a [http://drupal.org Drupal] content management system (CMS) which not only manages the conference, but also adds company and individual contact details to the SugarCRM system via the web service. The details on creating the form for the capture are beyond the scope of this article but the capture routines could easily handle a form input (HTTP POST) just as easily as we read input from a file . Again our focus for today will be on the plumbing of the interaction with the SOAP server.
== Goal ==
Import records into SugarCRM without using existing functionality, import wizards but rather by writing some a tool in [http://en.wikipedia.org/wiki/PHP PHP tool ] to do the work. Records should go into Accounts and Contacts, which obviously implies while creating a relationshipbetween the two. == Resources Used ==* http://www.sugarcrm.com/wiki/index.php?title=SOAP_Intro_and_Practical_Examples* http://freephile.com/crm/index.php?module=Home&action=TrainingPortal* http://freephile.com/crm/soap.php* http://www.sugarcrm.com/wiki/index.php?title=SOAP_in_PHP* http://dietrich.ganx4.com/nusoap/* http://www.beanizer.org/site/index.php/en/Articles/Sugar-CRM-integration-with-custom-PHP-applications-I.html
==First I downloaded the source Requirements ==# I went Assume that we start with a spreadsheet that has column headings matching the 17 fields shown below. Assume too that we want to capture all of the SugarCRM homepage, and clicked data in the top navbar link to "Sugar Open Source"# I skipped sample. (The owner of the "Wizard" data collected it for a reason and went right to the "Download Page" because I know what Ithey wouldn'm doing and also have t be too happy with a pre-existing setup loss of Linux, Apache MySQL and PHP - so I only want the app# I downloaded SugarCE-5.0.0e.zip (production releasedata in a migration to a new application!)# I visited did not define new fields in the recommended "Installation" instructions page at http://www.sugarforge.org/content/installation/# Then I installed it according to the instructionsdatabase, however but I immediately ran into trouble because the instructions did say to chmod 766 all files that needed correlate my data source to be writable by the web_userAccounts and Contacts tables. # This command renders Because I had parsed the directories non-executable which manifests in include errors because the web user (www-data) can not see into those directories source (to find includesspreadsheet or CSV file).<source lang="bash"># find directories for column headings, I simply exported that variable and then used it as a comment right in the my code workup as I went./crm path and change the mode on them so What I mean is that all users can execute I created a PHP (see intoarray) variable of the directory find 17 field names, and then used the [http://php.net/crmvar_export|var_export]() function to print it and copy/ -type d |xargs chmod paste into a comment block so that I could mark up a+x </source> resolved the include errorsplan for mapping those fields into fields in SugarCRM.
== Ideas on How to do the import = Using a Form ===My selfThe [http://www.sugarcrm.com/wiki/index.php?title=SOAP_Intro_and_Practical_Examples SOAP Intro and Practical Examples], shows a simple form-imposed requirement was to capture all of the data provided -- assuming the owner of the data collected it based processing script for a reason and that they wouldn't be too happy with a loss of data in a migration to a new application. I looked briefly at the import functionality exposed by the application, but noticed how the lead capture did not reflect the same data profile as the source that I hadleads.
=== Use the Source Luke ===
Looking at the full application import routines and the four-step forms for importing leads, it was obvious that there was is a lot of example machinery that I didn't necessarily need or want you could use to get involved with to simply import recordscreate a sophisticated web front-end using SugarCRM internals. For instancethis exercise, I would not want to (re-)write the form assume that we'll be operating between two websites, and UI handling when so I will simply needed to insert records into a the database. This made me reconsider using the communicating with SugarCRM's SOAP example to do the job. In essence, it would only need to read the exercise data and create full records for the 50 provided leads. <!--From looking at the source code of the import routines, I noticed that the modules/Import/config.php file defined various types of data profiles, and that the "Salesforce" profile was close to the data that I hadserver.
; Tip: You can peer into the SugarCRM environment with a call to PHP's 'get_defined_vars()'. This will give you some information about field maps etc.
<source lang="php">
# temp.php to show a concise view of the variables defined in the config script
)
</source>
== Using SOAP ==
Note: Soap SOAP examples seem to have changed can obviously change slightly over time with the addition of a version numberSugarCRM, so you must be careful about what example you use, and generally rely on the source to be the definitive source ;-)* soap/SoapPortalUsers.php* soap/SoapSugarUsers.php* soap/SoapData.php* soap/SoapDeprecated.php
Getting on with the soap service, it is easy to discover the service profile and import the data
From the [http://freephile.com/crm/soap.php|soap.php] page (which shows the WSDL), we can get a definition of the available SOAP calls. For example, here is the definition of the 'create_account' method
<pre>
// output:
</source>
See [[Importing_contacts/sugar_modules]]
<source lang="php">
===Accounts fields: ===
[[Importing_contacts/Accounts|See the SOAP profile for Accounts]]
=== Contacts fields: ===
== Setting Records ==
$arrData[$k] = explode($separator, $v);
}
foreach ($arrData as $record) {
// Accounts
$set_entry_params = array(
'session' => $session_id,
)
);
// make the soap call
$result = $soapclient->call('set_entry',$set_entry_params);
// print "\n <br />Entry results:<br />\n<pre>\n"; var_export ($result); print "\n</pre>\n";
// the return value will give us the unique identifier for the Account record, which we
// then use to create a relationship entry when creating the Contact
$accountId = $result['id'];
// Contacts
$set_entry_params = array(
'session' => $session_id,
'module_name' => 'Contacts',
'name_value_list'=>array(
array('name'=>'first_name', 'value'=>$record[$fieldKeys['First Name']]),
array('name'=>'last_name', 'value'=>$record[$fieldKeys['Last Name']]),
array('name'=>'phone_fax', 'value'=>$record[$fieldKeys['Fax']]),
array('name'=>'primary_address_street', 'value'=>$record[$fieldKeys['Address']]),
array('name'=>'primary_address_city', 'value'=>$record[$fieldKeys['City']]),
array('name'=>'primary_address_state', 'value'=>$record[$fieldKeys['State']]),
array('name'=>'primary_address_postalcode', 'value'=>$record[$fieldKeys['Zip Code']]),
array('name'=>'primary_address_country', 'value'=>$record[$fieldKeys['Country']]),
array('name'=>'phone_office', 'value'=>$record[$fieldKeys['Work Phone']]),
array('name'=>'phone_other', 'value'=>$record[$fieldKeys['Other Phone']]),
array('name'=>'email', 'value'=>$record[$fieldKeys['Email']]),
array('name'=>'account_name', 'value'=>$record[$fieldKeys['Company Name']]), // relation
array('name'=>'account_id', 'value'=>$accountId), // relation
array('name'=>'assigned_user_id', 'value'=>$user_guid)
)
);
// make the soap call to create the (related) Contact entry
$result = $soapclient->call('set_entry',$set_entry_params);
print "\n <br />Contact Entry results:<br />\n<pre>\n"; var_export ($result); print "\n</pre>\n";
$contactId = $result['id'];
/** // alternately, if you have both ids, you can use set_relationship $set_relationship_params = array( 'session' => $session_id, 'set_relationship_value' => array( 'module1' => 'Contacts', 'module1_id' => $contactId, 'module2' => 'Accounts', 'module2_id' => $accountId ) ); $result = $soapclient->call('set_entryset_relationship',$set_entry_paramsset_relationship_params); print "\n <br />Relationship results:<br />\n<pre>\n"; var_export ($result); print "\n</pre>\n"; */
}
</source>
== Conclusion ==In this article we've shown how the SugarCRM system is enterprise-ready in that it has a fully built SOAP service that can be used to integrate the system with one or more 'front-end' websites or applications for data capture. With important information easily added to the system, it allows the company to focus resources on managing the most valuable assets. Due to SugarCRM's open source nature and standards support, it's easy to extend and integrate the system with other existing or new infrastructure components. In future articles, we'll take a look at still more interesting integrations with SugarCRM such as collaboration, document management and knowledge management. <table class="toc"><tr><td>-- Greg Rundlett<br />Greg Rundlett is an open source technologist. He currently manages the Technology Services team at [http://www.oasis-open.org OASIS]. <br />''This website is not affiliated nor endorsed by any third-party .''</td></tr></table> == Postscript: Some Issues discovered Improvements for SugarCRM == As with any software, there is always room for improvement. Here are some minor issues that I noted in the course of writing this article.# "Import Step 2: Upload Export File" is a confusing title on the second step of the "Import Contacts" wizard. How can one use the words 'import', 'upload', 'export' all at once? It could read "Import Step 2: Specify Select Data File to load" # Typographical bug: I saw that the term "custom_delimeted" in the language files. It doesn't actually cause any errors, but b/c the term is used in elsewhere (spelled correctly), this typo could potentially lead to a self-contained way inreal bug down the line. ## ./modules/Import/language/en_us.lang.php ## ./modules/Import/ImportStep1.html ## ./modules/Import/ImportStep2.phpThis term # The source is formatted poorly, or practically not at all in some cases, due to various editors using different space and tab settings, and line endings. [http://pear.php.net/package/PHP_Beautifier PHP Beautifier] used elsewhere spelled correctlyin a commit hook would solve this in the version control system. Coding standards and configuration files like vim modelines would solve this on the developer desktop. Being open source, I can pass this information on to the developers (or even get involved myself by posting articles like this to [http://www.sugarcrm.com/wiki/index.php?title=Main_Page the wiki]) and thus could potentially lead will likely see a positive response to a bug down the linethese suggested fixes. Note too - SugarCRM fosters an extended community of value-add partners through it's [http://www.sugarforge.org/ forge site]. == Further Resources ==* http://www.sugarcrm.com/wiki/index.php?title=SOAP_Intro_and_Practical_Examples* http://freephile.com/crm/index.php?module=Home&action=TrainingPortal* http://freephile.com/crm/soap.php* http://www.sugarcrm.com/wiki/index.php?title=SOAP_in_PHP* http://dietrich.ganx4.com/nusoap/* http://www.beanizer.org/site/index.php/en/Articles/Sugar-CRM-integration-with-custom-PHP-applications-I.html