SugarCRM Contacts Connector Operation
Version: 17.07
Supported Since: 17.07
What is SugarCRM Contacts Connector Operation?
SugarCRM contacts connector operation can be used to manipulate Contacts at the SugarCRM side. User can use this operation to do CRUD operations on SugarCRM Contacts. User doesn’t require to know the REST API semantics at the SugarCRM side while using this connector operation. This will encapsulates the complexity of the SugarCRM REST API. User just have to configure relevant parameters or the way to extract those parameters from the message, to do CRUD operations on their SugarCRM Contacts.
| This connector operation is compatible only with the SugarCRM Egress Connector. In order to use the SugarCRM Contacts Connector operation, you must first select the SugarCRM Connector dependency from the connector list when you are creating an empty Ultra project. If you have already created a project, you can add the SugarCRM Connector dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list, select the SalesForce Connector dependency. |
All the parameters of this operation can be configured to extract out dynamically from the message context. For that, required parameters should be configured from the place holder notation as below,
-
to extract out a value from a message header with a given header value - @{message.headers.<header_name>}
-
to extract out a value from a message property with a given property key - @{message.properties.<property_key>}
-
to extract out message payload - @{message.payload}
-
to extract out message id - @{message.id}
-
to extract out message context id - @{mc.id}
-
to extract out a value from a message context property with a given context property key - @{message.properties.<context_property_key>}
-
to extract out a value from a scope variable with a given variable name - @{variable.<variable_name>}
-
to use current execution time stamp with given format - @{current.timestamp.<timestamp_format>}
Parameters
* marked fields are mandatory
Operation |
Basic |
Operation to be invoked on a SugarCRM Contacts. If value is DYNAMIC, operation will be extracted from variable with name SUGARCRM_OPERATION. |
Parameters to fetch |
Basic |
Comma separate list of parameters to fetch Contacts via GET request from SugarCRM. This is only applicable only for GET operations. For more details of parameter names, refer the SugarCRM documentation. |
Maximum Number of Entries |
Basic |
Maximum number of contacts to fetch via GET request from SugarCRM. This is only applicable only for GET operations. Defaults to -1 which means it won’t add any limits and will return all the matching entries. |
Filtering Query |
Basic |
Filtering query to filter out contacts while fetching entries via GET request from SugarCRM. This is only applicable only for GET operations. Value should be given in following format, eg: if it’s required to filter out from name and email, filtering query should be, [first_name]=John&[last_name][$starts]=Doe. For more information on filtering queries, refer the SugarCRM documentation. |
Contact ID |
Basic |
ID of the SugarCRM contact which is supposed to use for CRUD operations. However, this parameter will be ignored for CREATE operation since SugarCRM doesn’t expect id from the client while creating Contacts. Contact id will be assigned by SugarCRM itself for CREATE operation. |
First Name |
Basic |
First name of the SugarCRM contact which is supposed to use for CRUD operations. |
Last Name |
Basic |
Last name of the SugarCRM contact which is supposed to use for CRUD operations. |
Full Name |
Basic |
Full name of the SugarCRM contact which is supposed to use for CRUD operations. |
Email Addresses |
Basic |
Comma separated list of email addresses to be associated with the account which is going to be used for CRUD operations. |
Description |
Basic |
Description of the contact. |
Title |
Basic |
Title of the contact. |
Department |
Basic |
Department of the contact. |
Team Name |
Basic |
Team name of the contact. |
Team Count |
Basic |
Team count of the contact. |
Salutation |
Basic |
Salutation of the contact. |
Phone Number |
Basic |
Official phone number for the account. |
Phone - Home |
Basic |
Home phone number for the contact. |
Phone - Work |
Basic |
Work place phone number for the contact. |
Phone - Other |
Basic |
Other phone number for the contact. |
Don’t Call |
Basic |
Whether is it okay to contact via a call. If this is false, it’s okay to contact via a call. Otherwise, should not call to the contact. |
Phone - Fax |
Basic |
Fax number for the contact. |
Primary Address Street |
Basic |
Primary address street of the contact. |
Primary Address State |
Basic |
Primary address state of the contact. |
Primary Address City |
Basic |
Primary address city of the contact. |
Primary Address Postal code |
Basic |
Primary address postal code of the contact. |
Primary Address Country |
Basic |
Primary address country of the contact. |
Alternative Address Street |
Basic |
Alternative address street of the contact. |
Alternative Address State |
Basic |
Alternative address state of the contact. |
Alternative Address City |
Basic |
Alternative address city of the contact. |
Alternative Address Postal code |
Basic |
Alternative address postal code of the contact. |
Alternative Address Country |
Basic |
Alternative address country of the contact. |
Facebook Account |
Basic |
Facebook account name of the contact. |
Twitter Account |
Basic |
Twitter account name of the contact. |
GooglePlus Account |
Basic |
GooglePlus account name of the contact. |
Birthday |
Basic |
Birthday of the contact. |
Assistant Name |
Basic |
Assistant name of the contact. |
Assistant Phone |
Basic |
Assistant phone number of the contact. |
Lead Source |
Basic |
Lead source of the contact. |
In this topic
In this topic