SugarCRM actions

Lookup object by ID action

Looks up an object by its ID. You must select the type of object to look up.

Input field description

  • SugarCRM module to lookup - A dropdown list from which to choose the module you want to look up. E.g. Accounts.

  • Pass binary data to the next component (if found object has it) - A checkbox, which if selected, and the object found has a binary field (type of file), then the object’s data is passed to the next component as a binary attachment.

Lookup objects action

Look ups a list of objects satisfying specified criteria.

Input field description

  • SugarCRM module to lookup - A dropdown list from which to choose the module you want to look up. E.g. Accounts.

  • Output method - A dropdown list with following values: Emit all, Emit page, Emit individually.

  • Number of search terms - A text field where you can specify the number of search terms (not less than 0 and not greater than 99). The default value is 0 (if provided value is not allowed).

Metadata description

Depending on the Output method configuration field, the input metadata can contain different fields:

  • Output method - Emit page:

    • Field Page size - requires a positive integer that defaults to 1000;

    • Field Page number - requires a non-negative integer (starts with 0, default value 0);

  • Output method - Emit all: Field "Maximum number of records" - optional positive integer (default value 1000);

  • Output method - Emit individually: Field Maximum number of records - optional positive integer (default value 10000);

The number of records the component emits may affect the performance of the platform/component.

Next are groups of fields for each search term:

  • Field Field name - string represents module’s field (a list of allowed values is available);

  • Field Field value - string represents value for selected field;

  • Field Condition - one of the following: =, !=, <, <=, >, >=, STARTS WITH, ENDS WITH, CONTAINS, IS NULL, NOT NULL, IN, NOT IN;

Between each two term’s group of fields:

  • Field Logical operator - one of the following: AND, OR;

The output data depends on the configuration field Output method, which if the following were selected:

  • Emit page or Emit all, the output is an array of records;

  • Emit individually, the output is a record;

Delete object by ID action

Deletes an object by its ID. You must select the type of object to look up.

Upsert object by ID action

Updates an existing object entry if its ID is provided. Otherwise, creates a new object entry. You must select the type of object to look up.

  • The input metadata is fetched dynamically from your SugarCRM account.

  • The output metadata is the same as the input metadata, so you may expect all fields that you mapped as input to be returned as output.

Input fields description

  • Module - Input field to choose the object type you want to find. E.g. Note

  • Utilize data attachment from previous step (for objects with a binary field) - A checkbox, which if selected, and the input message contains an attachment and the specified object has a binary field (type of file), then the attachment is placed into object’s binary field.

Bulk create objects action

Provides a simple interface to quickly create large numbers of objects.

Input field description

  • Module - A dropdown list from which to choose the object type to perform the bulk create operation. E.g. Cases.

Metadata description

  • Objects - an array of the objects that will be created. Refer to SugarCRM objects for examples of formats.

    The result is an object with a property result: array. This array contains the list of newly created objects.

Bulk update objects action

Provides a simple interface to quickly update large numbers of objects.

Input field description

  • Module - A dropdown list from which to choose the object type to perform the bulk update operation. E.g. Cases.

Metadata description

  • Massupdate_params - an object that contains an array of UIDs and new values for updated objects. This action allows primitive fields to be updated, as well as values in lists to be added or replaced. Refer to SugarCRM Mass Update for examples.

Result is an object with the 2 properties:

  • failed - numeric, and indicates how many objects failed to update.

  • status - string. If the operation was successful, status="done". If the operation was not successful, failed > 0

The SugarCRM server does not return errors in case of a wrong UID.

Bulk delete objects action

Provides a simple interface to quickly delete large numbers of objects.

Input field description

  • Module - A dropdown list from which to choose the object type to perform the bulk delete operation. E.g. Cases.

Metadata description

  • Massupdate_params - an object contains array of uid’s for deleted objects. Please, take a look SugarCRM Mass Update documentation for examples.

Result is an object with the 2 properties:

  • failed - numeric, how many objects were failed to delete.

  • status - string, if operation were successful status="done". Operation could consider successful even if failed > 0

Query action

Retrieves a set of records filtered by an expression utilizing the SugarCRM REST API filter endpoint. See for details.

Input field description

  • SugarCRM module - A dropdown list from which to choose the module you want to look up. E.g. Accounts.

  • Output method - A dropdown list with following values: Emit all, Emit individually.

Metadata description

In the Integrator mode, a request can be built by completing the following fields:

  • Filter expression - A JSON object representing the filter expression. E.g.

      [
        {
          "billing_address_country":
          {
            "$in": ["England","France"]
          }
        }
      ]
  • Maximum number of records - The maximum number of records to return. The default is 20.

  • The number of records to skip - The number of records to skip over before records are returned. The default is 0.

  • How to sort the returned records - A comma delimited list of sort criteria, where each criterion is a column name, a colon and the direction (ASC or DESC) by which data in the column preceding the colon is sorted.

    E.g. "name:DESC,account_type:DESC,date_modified:ASC".

In Developer mode, a request can be built utilizing all features by providing a JSON object (for more information go to the link above). E.g.:

{
  "filter": [{
    "$or": [{
        "$and": [{
            "billing_address_country": {
              "$not_in": ["DE", "India"]
            }
          },
          {
            "acc_float_c": {
              "$is_null": ""
            }
          }
        ]
      },
      {
        "billing_address_country": {
          "$equals": "England"
        }
      }
    ]
  }],
  "fields": "id,name,billing_address_country,parent_name,accdate_c,acccheck_c,acc_float_c",
  "max_num": 42
}
that the number of records the component emits may affect the performance of the platform/component.

Output data depends on the configuration field Output method:

  • Emit all - an array of records.

  • Emit individually - a record.

© 2015- Squiz Pty Ltd