SugarCRM v2 (Beta) connection

Introduction

A SugarCRM v2 (Beta) connection, created using the SugarCRM v2 (Beta) connector, establishes access to SugarCRM. Once a connection is configured, you can create instances of SugarCRM v2 (Beta) activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a SugarCRM v2 (Beta) connection

A new SugarCRM v2 (Beta) connection is created using the SugarCRM v2 (Beta) connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing SugarCRM v2 (Beta) connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design Component Palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a SugarCRM v2 (Beta) connection

Each user interface element of the SugarCRM v2 (Beta) connection configuration screen is described below.

• Connection name: Enter a name to use to identify the connection. The name must be unique for each SugarCRM v2 (Beta) connection and must not contain forward slashes / or colons :. This name is also used to identify the SugarCRM v2 (Beta) endpoint, which refers to both a specific connection and its activities.

• Hostname: Enter the hostname of the database server, in the format example.demo.sugarcrm.com.

• Client ID: Enter the SugarCRM client ID. The default value for most SugarCRM instances is sugar.

  Note

  Alternative client IDs for the SugarCRM instance are managed by an administrator in Admin > OAuth Keys within the SugarCRM user interface. For more information, see SugarCRM's documentation.

• Client secret: Enter the SugarCRM client secret. This field can be left empty for most SugarCRM instances.

  Note

  Client secrets for the SugarCRM instance are managed by an administrator in Admin > OAuth Keys within the SugarCRM user interface. For more information, see SugarCRM's documentation.

• Username: Enter the SugarCRM username.

• Password: Enter the SugarCRM password.

• Version: Select the SugarCRM version. Versions v10 through v11.25 are available to choose from.

• Optional settings: Click to expand additional optional settings:

  • Platform: If you are using a platform other than base, enter the platform to be used. The default (base) allows you to have custom metadata per platform.

    Note

    Ensure any alternative platforms are registered using the Platform extension.

  • Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a SugarCRM v2 (Beta) connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.

These activity types are available:

• Query: Retrieves object data from SugarCRM and is intended to be used as a source in an operation.

• Create: Creates object data in SugarCRM and is intended to be used as a target in an operation.

• Update: Updates object data in SugarCRM and is intended to be used as a target in an operation.

• Delete: Deletes object data in SugarCRM and is intended to be used as a target in an operation.