SugarCRM API

Overview

These public interfaces are used in SugarCRM components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and CozyRoc.SugarCRM.dll libraries. Also include CozyRoc.SqlServer.SSIS, CozyRoc.SugarCrm and CozyRoc.SugarCrm.Service namespaces.

IConnection / ISugarCrmConnection

When you call SugarCRM Connection Manager AcquireConnection method, it returns object implementing IConnection interface. This is the interface used for interaction with SugarCRM service.

Connect method

Connects to SugarCRM service. The method result is object implementing SugarCRM Core Calls.

Close method

Closes the connection to SugarCRM service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

GetSessionId method

Returns session identifier of connection.

ServerHost property (string)

Specify the name or IP address of the SugarCRM server.

ServerUser property (string)

Specify user name to access the SugarCRM service.

ServerPassword property (string)

Specify user password to access the SugarCRM service.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.

RetainSameConnection property (bool)

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection (default).
False Every client uses different connection.

ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.