EXT: SugarCRM¶

SERVER_VERSION¶

Test

SERVER_VERSION

Description

This will play back a string like “The Server Version is X.X.X”

LOG_IN¶

Test

LOG_IN

Description

This will make the plug-in try to log in to the server using the credentials you provided when you installed the extension. The result (success or failure) will be reported on screen.

LIST_USERS¶

Test

LIST_USERS

Description

This will query the SugarCRM server for the list of all users and output them along wit their details. This switch implies the LOG_IN switch.

LIST_MODULES¶

Test

LIST_MODULES

Description

This will query the server for all available modules and output a list. This switch implies the LOG_IN switch.

LIST_MODULE_DETAILS¶

Test

LIST_MODULE_DETAILS

Description

This will not only query the list of modules but also obtain all their details and display them along with the respective module. This switch implies the LOG_IN switch.

BE AWARE that this might take a long time to render!

• If you access your SugarCRM in any other way than through localhost (or at least if it is not a super-fast network connection), you should most likely refrain from using LIST_MODULE_DETAILS and if possible even LIST_MODULE_DETAILS and LIST_USERS. They run a lot of queries as separate HTTP POST requests and can therefore take very long to process. If that takes longer than your maximum execution time on your PHP install, they will even time out.
• As a general note, you should be aware that this is a mere test plug- in. There is no reason why it would ever show up on a production website. Use it to test your connection and then delete it from all pages again.

ObjectName¶

type¶

identifier¶

timeshift¶

form.condition¶

input_dateformat¶

default¶

mapping¶

children¶

Setup the form¶

• Create the contact form on the page using the standard mail form content element.

• Illustration 2: Configuration of web form

  In our example the following form definition was used.

Salutation: | *Salutation=select | Mr, Ms.
     Firstname: | *FirstName=input,25
     Name: | *Name=input,25
     Company: | Company=input,25
     Phone: | *Phone=input,25
     e-Mail: | *email=input,25 | | email
     Please give me a call: | Recall=check |
         Preferred date and time: | DPC_Date=input,16
     Message: | *Query=textarea,40,8
     | formtype_mail=submit | submit
     | html_enabled=hidden | 1
     | subject=hidden | Online-Contact

Configure mapping to SugarCRM¶

• You will notice that there are additional options for mail form content element now. To use the SugarCRM integration, select the “create SugarCRM Lead on form submit” option. You then will need to configure how the field data is submitted to SugarCRM. This includes setting up whether the data should create new lead or contact or update data, and how the form fields map to the sugar fields.

• The settings are entered in a syntax similar to TypoScript as shown in Illustration3: Configuration of SugarCRM binding (eu_sugarcrm).

• Illustration3: Configuration of SugarCRM binding (eu_sugarcrm)

  The full configuration for our example is listed below.

FirstContact {
          // what to create?
          type = Leads
          // require unique e-mail address
          identifier = email1
          default {
                  lead_source = TYPO3 Online Contact
                  // Who is the lead assigned to?
                  assigned_user_id = jim_id
          }
          // Allocation SugarCRM Filed = Form Field
          mapping {
                  first_name = FirstName
                  last_name = Name
                  email1 = email
                  salutation = Salutation
                  phone_work = Phone
                  account_name = Company
          }
          // create linked entries
          children {
                  Task {
                          type = Tasks
                          // Only create task. if checkbox is active
                          condition.form = Recall=0
                          default {
                                  name = Answer online query
                                  priority = Medium
                                  status = Not Started
                                  assigned_user_id = jim_id
                                  parent_type = parent.type
                                  parent_id = parent.id
                          }
                          mapping {
                                  description = Query
                          }
                  }
                  Call {
                          type = Calls
                          condition.form = Recall=1
                          // Which format is the date entered into the form in?
                          input_dateformat = d-m-Y H:M
                          default {
                                  name = Call online contact
                                  priority = Medium
                                  status = Planned
                                  direction = Outbound
                                  reminder_time = 600
                                  duration_hours = 0
                                  duration_minutes = 15
                                  assigned_user_id = jim_id
                                  parent_type = parent.type
                                  parent_id = parent.id
                                  date_start = now
                                  time_start = now
                          }
                          mapping {
                                  description = Query
                                  date_start = DPC_Date
                                  date_end = DPC_Date
                          }
                  }
          }
  }

• In this example if the email address of the visitor is already present in SugarCRM (in the field email1), the lead information will be updated. Otherwise, a new lead will be created. As a second step, an appointment and a task will be created for this first lead.
• The allocation of the data to a SugarCRM user is set by the the value of assigned_user_id in the configuration, it is important to understand that this is the user id rather than user name from SugarCRM. In our example jim_id is the value of the default example user id in SugarCRM. To get you users id's it is easiest to use the test plug-in and run LIST_USERS. You can also use LIST_MODULE_DETAILS in the test plug-in to find out the SugarCRM field names. However, bear in mind that a lot of information will be gathered from the SugarCRM and output in your browser.
• Alternatively (and preferably), you can get the SugarCRM field names for a module from within SugarCRM by accessing the Studio (in Admin area), selecting the relevant module and listing its fields.