Skip to Content

SugarCRM Get Contacts activity

Introduction

A SugarCRM Get Contacts activity, using its SugarCRM connection, retrieves contacts from SugarCRM and is intended to be used as a source to provide data in an operation.

Create a SugarCRM Get Contacts activity

An instance of a SugarCRM Get Contacts activity is created from a SugarCRM connection using its Get Contacts activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.

An existing SugarCRM Get Contacts activity can be edited from these locations:

Configure a SugarCRM Get Contacts activity

Follow these steps to configure a SugarCRM Get Contacts activity:

Step 1: Enter a name

In this step, provide a name for the activity. Each user interface element of this step is described below.

SugarCRM Get Contacts activity configuration step 1

  • Name: Enter a name to identify the activity. The name must be unique for each SugarCRM Get Contacts activity and must not contain forward slashes / or colons :.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

SugarCRM Get Contacts activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The SugarCRM connector uses the SugarCRM REST API. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the SugarCRM endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a SugarCRM Get Contacts activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

SugarCRM Get Contacts activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.