sugarcrm relationships connector operation

SugarCRM Relationships Connector Operation

Version: 17.07

Supported Since: 17.07

What is SugarCRM Relationships Connector Operation?

SugarCRM relationships connector operation can be used to manipulate relationships between entities at the SugarCRM side. User can use this operation to do CRUD operations on SugarCRM relationships such as attaching given contact to some account, fetching all contacts which are attached to a given account etc. 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 relationships.

This connector operation is compatible only with the SugarCRM Egress Connector. In order to use the SugarCRM Relationships 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 SugarCRM relationships. 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 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

Basic

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

Basic

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.

Relate From Entity Type

Basic

Entity type to relate from. eg: if it’s required to create a relationship from an Account to Contact, this parameter should be Accounts.

From Entity ID

Basic

ID of the from entity. eg: if it’s required to create a relationship from an Account with ID abc-xyz to Contact, this parameter value should be abc-xyz (Account ID).

Relate To Entity Type

Basic

Entity type to relate to. eg: if it’s required to create a relationship from an Account to Contact, this parameter should be Contacts.

To Entity ID

Basic

ID of the to entity. eg: if it’s required to create a relationship from an Account to a Contact with ID ijk-lmn, this parameter value should be ijk-lmn (Contact ID).

In this topic
In this topic
Contact Us