sugarcrm generic connector operation

SugarCRM Generic Connector Operation

Version: 17.07

Supported Since: 17.07

What is SugarCRM Generic Connector Operation?

SugarCRM generic connector operation can be used to manipulate any entity at the SugarCRM side by configuring required REST API URL and the operation. Since it’s a generic connector, it’s payload agnostic. Because of that, not like other connector operations, user have to decide what is the required message payload which should be send to SugarCRM server to manipulate the expected entity. As an example, if it’s required to create a Contact at the Sugar side using generic operation, user has to set the required JSON message payload for Contact creation. This operation will send the receiving payload as it’s to the SugarCRM without doing any payload manipulations.

This connector operation is compatible only with the SugarCRM Egress Connector. In order to use the SugarCRM Generic 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 - @{<property_key>}

  • to extract out message payload - @{message.payload}

  • to extract out message id - @{}

  • to extract out message context id - @{}

  • to extract out a value from a message context property with a given context property key - @{<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>}


* marked fields are mandatory



Operation to be invoked on SugarCRM entities. If value is DYNAMIC, operation will be extracted from variable with name SUGARCRM_OPERATION.

Parameters to fetch


Comma separate list of parameters to fetch via GET request from SugarCRM. This is only applicable only for GET operations. For more details of parameter names, refer the SugarCRM documentation for each entity.

Maximum Number of Entries


Maximum number of entries 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


Filtering query to filter out entries 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.

In this topic
In this topic
Contact Us