sugarcrm accounts connector operation

SugarCRM Accounts Connector Operation

Version: 17.07

Supported Since: 17.07

What is SugarCRM Accounts Connector Operation?

SugarCRM accounts connector operation can be used to manipulate Accounts at the SugarCRM side. User can use this operation to do CRUD operations on SugarCRM Accounts. 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 Accounts.

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

Account ID

Basic

ID of the SugarCRM account 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 Accounts. Account id will be assigned by SugarCRM itself for CREATE operation.

Account Name

Basic

Name of the SugarCRM account which is supposed to use for CRUD operations.

Account Type

Basic

Type of the account - eg: Customer, Partner, Investor.

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 account.

Web Site

Basic

Web Site for the account.

Phone Number

Basic

Official phone number for the account.

Alternate Phone Number

Basic

Alternate phone number for the account.

Billing Address Street

Basic

Billing address street of the account.

Billing Address State

Basic

Billing address state of the account.

Billing Address City

Basic

Billing address city of the account.

Billing Address Postal code

Basic

Billing address postal code of the account.

Billing Address Country

Basic

Billing address country of the account.

Shipping Address Street

Basic

Shipping address street of the account.

Shipping Address State

Basic

Shipping address state of the account.

Shipping Address City

Basic

Shipping address city of the account.

Shipping Address Postal code

Basic

Shipping address postal code of the account.

Shipping Address Country

Basic

Shipping address country of the account.

Phone Fax

Basic

Annual revenue of the account.

Industry

Basic

Industry of the account.

Annual Revenue

Basic

Annual revenue of the account.

Rating

Basic

rating of the account.

Ownership

Basic

Ownership of the account.

Employees

Basic

Number of the employees of the account.

Ticker Symbol

Basic

Ticker Symbol of the account.

SIC Code

Basic

SIC Code of the account.

In this topic
In this topic
Contact Us