component.json

{
  "title": "Salesforce v2",
  "description": "Customer relationship management (CRM) software & cloud computing from the leader in CRM solutions for businesses large & small.",
  "docsUrl": "https://github.com/elasticio/salesforce-component-v2",
  "url": "https://www.salesforce.com/",
  "version": "2.8.5",
  "authClientTypes": [
    "oauth2"
  ],
  "envVars": {
    "SALESFORCE_API_VERSION": {
      "required": true,
      "description": "Salesforce API version. Default 46.0"
    },
    "HASH_LIMIT_TIME": {
      "required": false,
      "description": "Hash expiration time in millis"
    },
    "HASH_LIMIT_ELEMENTS": {
      "required": false,
      "description": "Hash size number limit"
    }
  },
  "credentials": {
    "fields": {
      "oauth": {
        "label": "Authentication",
        "viewClass": "OAuthFieldView",
        "required": true
      }
    }
  },
  "triggers": {
    "getUpdatedObjectsPolling": {
      "main": "./lib/triggers/getUpdatedObjectsPolling.js",
      "title": "Get Updated Objects Polling",
      "type": "polling",
      "help": {
        "description": "Poll for updated objects",
        "link": "/components/salesforce/triggers#get-updated-objects-polling"
      },
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object Type",
          "order": 20,
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "selectedFields": {
          "label": "Selected Fields",
          "viewClass": "MultiSelectView",
          "order": 17,
          "required": false,
          "require": [
            "sobject"
          ],
          "help": {
            "description": "Select fields that will be returned"
          },
          "model": "getObjectFields"
        },
        "linkedObjects": {
          "label": "Include linked objects",
          "viewClass": "MultiSelectView",
          "order": 15,
          "required": false,
          "require": [
            "sobject"
          ],
          "help": {
            "description": "Linked objects that you can query at once - beyond two or three, depending on the number of fields in the linked objects."
          },
          "model": "linkedObjectTypes"
        },
        "emitBehavior": {
          "viewClass": "SelectView",
          "order": 12,
          "required": false,
          "label": "Emit Behavior",
          "prompt": "Select an output method. Defaults to: Emit individually",
          "model": {
            "emitIndividually": "Emit individually",
            "fetchPage": "Emit page"
          }
        },
        "startTime": {
          "viewClass": "TextFieldView",
          "label": "Start Time",
          "order": 10,
          "required": false,
          "placeholder": "1970-01-01T00:00:00.000Z",
          "note": "Indicates the beginning time to start polling from, default 1970-01-01T00:00:00.000Z"
        },
        "endTime": {
          "viewClass": "TextFieldView",
          "label": "End Time",
          "order": 8,
          "required": false,
          "placeholder": "3000-01-01T00:00:00.000Z",
          "note": "If provided, do not fetch records modified after this time (defaults to execution time)"
        },
        "pageSize": {
          "required": false,
          "viewClass": "TextFieldView",
          "order": 7,
          "label": "Size of Polling Page",
          "placeholder": "10000",
          "note": "Number of records to be fetched by each request (defaults to 10000). Positive integer only, max 10000 objects"
        },
        "singlePagePerInterval": {
          "viewClass": "CheckBoxView",
          "order": 4,
          "label": "Process Single Page Per Execution",
          "note": "Indicates that if the number of changed records exceeds the maximum number of results in a page, instead of fetching the next page immediately, wait until the next flow start to fetch the next page."
        }
      },
      "dynamicMetadata": true
    },
    "entry": {
      "title": "Get New and Updated Objects Polling",
      "main": "./lib/entry.js",
      "deprecated": true,
      "order": 99,
      "help": {
        "description": "Will poll for existing and updated objects where you can select any custom or build-in object for your Salesforce instance",
        "link": "/components/salesforce/triggers#get-new-and-updated-objects-polling-trigger"
      },
      "type": "polling",
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "linkedObjects": {
          "label": "Include linked objects",
          "viewClass": "MultiSelectView",
          "required": false,
          "require": [
            "sobject"
          ],
          "model": "linkedObjectTypes",
          "prompt": "Please select any linked objects that should be included in the query"
        },
        "startTime": {
          "viewClass": "TextFieldView",
          "label": "Start Time",
          "required": false,
          "placeholder": "1970-01-01T00:00:00.000Z",
          "note": "Indicates the beginning time to start polling from, default 1970-01-01T00:00:00.000Z"
        },
        "endTime": {
          "viewClass": "TextFieldView",
          "label": "End Time",
          "required": false,
          "placeholder": "3000-01-01T00:00:00.000Z",
          "note": "If provided, do not fetch records modified after this time (defaults to never)"
        },
        "sizeOfPollingPage": {
          "label": "Size of Polling Page",
          "viewClass": "TextFieldView",
          "required": false,
          "placeholder": "10000",
          "note": "Please set the size of pages to be fetched (defaults to 10000). Please enter positive integer only, max 10000 objects"
        },
        "singlePagePerInterval": {
          "label": "Process single page per execution",
          "viewClass": "SelectView",
          "required": false,
          "model": {
            "yes": "yes",
            "no": "no"
          },
          "prompt": "Process single page per execution:"
        },
        "outputMethod": {
          "viewClass": "SelectView",
          "label": "Output method",
          "required": false,
          "model": {
            "emitAll": "Emit all",
            "emitIndividually": "Emit individually"
          },
          "prompt": "Please select an output method. Defaults to: Emit individually"
        },
        "maxFetch": {
          "label": "Max Fetch Count",
          "required": false,
          "viewClass": "TextFieldView",
          "placeholder": "1000",
          "note": "Limit for a number of messages that can be fetched, 1,000 by default"
        }
      }
    },
    "queryTrigger": {
      "title": "Query",
      "main": "./lib/triggers/query.js",
      "type": "polling",
      "order": 98,
      "help": {
        "description": "Will continuously run the same SOQL Query and emit results",
        "link": "/components/salesforce/triggers#query-trigger"
      },
      "metadata": {
        "out": {}
      },
      "fields": {
        "query": {
          "label": "SOQL Query",
          "required": true,
          "viewClass": "TextAreaView"
        },
        "outputMethod": {
          "viewClass": "SelectView",
          "label": "Output method",
          "required": false,
          "model": {
            "emitAll": "Emit all",
            "emitIndividually": "Emit individually"
          },
          "prompt": "Please select an output method. Defaults to: Emit individually"
        },
        "dontEmitOnEmptyResults": {
          "viewClass": "CheckBoxView",
          "label": "Don't emit on empty results",
          "required": false,
          "help": {
            "description": "If selected, component will not produce empty messages when result is empty."
          }
        }
      }
    },
    "streamPlatformEvents": {
      "title": "Subscribe to platform events (REALTIME FLOWS ONLY)",
      "order": 97,
      "help": {
        "description": "Can be used for subscription to the specified in the configuration Platform Event object. Can be used only for Realtime flows",
        "link": "/components/salesforce/triggers#subscribe-to-platform-events-trigger"
      },
      "main": "./lib/triggers/streamPlatformEvents.js",
      "type": "polling",
      "fields": {
        "object": {
          "viewClass": "SelectView",
          "label": "Event object name",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Event object"
        }
      }
    },
    "streamPlatformEventsPubSub": {
      "title": "Subscribe to PubSub",
      "order": 97,
      "help": {
        "description": "Can be used for subscription to the specified in the configuration Platform Event object",
        "link": "/components/salesforce/index.html#subscribe-to-pubsub"
      },
      "main": "./lib/triggers/streamPlatformEventsPubSub.js",
      "type": "polling",
      "fields": {
        "object": {
          "viewClass": "SelectView",
          "label": "Event object name",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select Event object"
        },
        "pubsubEndpoint": {
          "label": "Pub/Sub API Endpoint",
          "viewClass": "TextFieldView",
          "required": false,
          "placeholder": "api.pubsub.salesforce.com:7443",
          "help": {
            "description": "You can set Pub/Sub API Endpoint manually or leave it blank for default: \"api.pubsub.salesforce.com:7443\""
          }
        },
        "eventCountPerRequest": {
          "label": "Number of events per request",
          "viewClass": "TextFieldView",
          "required": false,
          "placeholder": "10",
          "help": {
            "description": "Salesforce uses batches of events to deliver to the component, the bigger number may increase processing speed, but if the batch size is too big, you can get out of memory error. If there are fewer events ready than the batch size, they will be delivered anyway. Positive integer, defaults to 10, max 100"
          }
        },
        "initialReplayId": {
          "label": "Start from Replay Id",
          "viewClass": "TextFieldView",
          "required": false,
          "placeholder": "31142963",
          "help": {
            "description": "In the Salesforce platform events and change data capture events are retained in the event bus for 3 days and you can subscribe at any position in the stream by providing here Replay Id from the last event. This field is used only for the first execution, following executions will use the Replay Id from the latest event to get a new one. Positive integer"
          }
        }
      },
      "metadata": {
        "out": {
          "type": "object",
          "properties": {
            "event": {
              "type": "object",
              "properties": {
                "replayId": {
                  "type": "number"
                }
              }
            },
            "payload": {
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    }
  },
  "actions": {
    "bulk_cud": {
      "title": "Bulk Create/Update/Delete/Upsert",
      "main": "./lib/actions/bulk_cud.js",
      "order": 99,
      "help": {
        "description": "Bulk operations on objects in CSV file",
        "link": "/components/salesforce/actions#bulk-createupdatedeleteupsert-action"
      },
      "fields": {
        "operation": {
          "viewClass": "SelectView",
          "label": "Operation",
          "required": true,
          "model": {
            "insert": "Create",
            "update": "Update",
            "delete": "Delete",
            "upsert": "Upsert"
          },
          "prompt": "Please select an operation"
        },
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "require": [
            "operation"
          ],
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "timeout": {
          "viewClass": "TextFieldView",
          "label": "Timeout for operation (sec)",
          "required": true,
          "note": "A positive integer specifying timeout in seconds. Maximum Salesforce's server timeout for the bulk operations is 10 min (600 sec).",
          "placeholder": "600"
        }
      },
      "dynamicMetadata": true
    },
    "bulk_q": {
      "title": "Bulk Query",
      "main": "./lib/actions/bulk_q.js",
      "order": 98,
      "help": {
        "description": "Bulk query with the results in CSV file",
        "link": "/components/salesforce/actions#bulk-query-action"
      },
      "metadata": {
        "in": "./lib/schemas/bulk_q.in.json",
        "out": "./lib/schemas/bulk_q.out.json"
      }
    },
    "create": {
      "title": "Create Object",
      "main": "./lib/actions/createObject.js",
      "order": 97,
      "help": {
        "description": "Creates new Selected Object",
        "link": "/components/salesforce/actions#create-object-action"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "utilizeAttachment": {
          "viewClass": "CheckBoxView",
          "label": "Utilize data attachment from previous step (for objects with a binary field) or by URL inside this field (instead of data)"
        }
      }
    },
    "delete": {
      "title": "Delete Object (at most 1)",
      "main": "./lib/actions/deleteObject.js",
      "order": 96,
      "help": {
        "description": "Delete Selected Object",
        "link": "/components/salesforce/actions#delete-object-action-at-most-1"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "typeOfSearch": {
          "viewClass": "SelectView",
          "label": "Type Of Search",
          "required": false,
          "model": {
            "uniqueFields": "Unique Fields",
            "allFields": "All Fields"
          },
          "prompt": "Please select a type of search. By default - All Fields"
        },
        "lookupField": {
          "viewClass": "SelectView",
          "label": "Lookup by field",
          "required": false,
          "require": [
            "sobject"
          ],
          "model": "getLookupFieldsModel",
          "prompt": "Please select the field which you want to use for lookup. By default - Object ID"
        }
      }
    },
    "lookupObject": {
      "title": "Lookup Object (at most 1)",
      "main": "./lib/actions/lookupObject.js",
      "order": 95,
      "help": {
        "description": "Lookup object (at most 1) by selected field",
        "link": "/components/salesforce/actions#lookup-object-action-at-most-1"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object",
          "order": 8
        },
        "typeOfSearch": {
          "viewClass": "SelectView",
          "label": "Type Of Search",
          "required": true,
          "model": {
            "uniqueFields": "Unique Fields",
            "allFields": "All Fields"
          },
          "prompt": "Please select a type of search",
          "order": 7
        },
        "lookupField": {
          "viewClass": "SelectView",
          "label": "Lookup by field",
          "required": true,
          "require": [
            "sobject",
            "typeOfSearch"
          ],
          "model": "getLookupFieldsModel",
          "prompt": "Please select the field which you want to use for lookup",
          "order": 6
        },
        "linkedObjects": {
          "viewClass": "MultiSelectView",
          "require": [
            "sobject"
          ],
          "label": "Include referenced objects",
          "model": "getLinkedObjectsModel",
          "order": 5,
          "prompt": "Please select the related objects you want included in your lookup"
        },
        "allowCriteriaToBeOmitted": {
          "viewClass": "CheckBoxView",
          "label": "Allow criteria to be omitted",
          "order": 4
        },
        "allowZeroResults": {
          "viewClass": "CheckBoxView",
          "label": "Allow zero results",
          "order": 3
        },
        "passBinaryData": {
          "viewClass": "CheckBoxView",
          "label": "Pass binary data to the next step (if found object has it)",
          "order": 2
        },
        "enableCacheUsage": {
          "viewClass": "CheckBoxView",
          "label": "Enable Cache Usage",
          "order": 1
        }
      }
    },
    "lookupObjects": {
      "title": "Lookup Objects",
      "main": "./lib/actions/lookupObjects.js",
      "order": 94,
      "help": {
        "description": "Look for objects satisfying specified criteria",
        "link": "/components/salesforce/actions#lookup-objects-action"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "includeDeleted": {
          "viewClass": "CheckBoxView",
          "label": "Include deleted"
        },
        "outputMethod": {
          "viewClass": "SelectView",
          "label": "Output method",
          "required": true,
          "model": {
            "emitAll": "Emit all",
            "emitPage": "Emit page",
            "emitIndividually": "Emit individually"
          },
          "prompt": "Please select an output method"
        },
        "termNumber": {
          "viewClass": "TextFieldView",
          "label": "Number of search terms",
          "required": true,
          "placeholder": "Please specify a number of search terms",
          "note": "Enter a positive integer number [1-99] or 0 to lookup all entities of chosen type"
        },
        "enableCacheUsage": {
          "viewClass": "CheckBoxView",
          "label": "Enable Cache Usage"
        },
        "maxFetch": {
          "label": "Max Fetch Count",
          "required": false,
          "viewClass": "TextFieldView",
          "placeholder": "1000",
          "note": "Limit for a number of messages that can be fetched, 1,000 by default"
        }
      }
    },
    "queryAction": {
      "title": "Query",
      "main": "./lib/actions/query.js",
      "order": 93,
      "help": {
        "description": "Executing an SOQL Query that may return many objects. Each resulting object is emitted one-by-one",
        "link": "/components/salesforce/actions#query-action"
      },
      "fields": {
        "batchSize": {
          "viewClass": "TextFieldView",
          "label": "Optional batch size",
          "required": false,
          "note": "A positive integer specifying batch size. If no batch size is specified then results of the query will be emitted one-by-one, otherwise query results will be emitted in array of maximum batch size.",
          "placeholder": "0"
        },
        "allowResultAsSet": {
          "label": "Allow all results to be returned in a set",
          "viewClass": "CheckBoxView",
          "help": {
            "description": "`Optional batch size` and `Max Fetch Count` options are ignored in this case"
          }
        },
        "includeDeleted": {
          "viewClass": "CheckBoxView",
          "label": "Include deleted"
        },
        "maxFetch": {
          "label": "Max Fetch Count",
          "required": false,
          "viewClass": "TextFieldView",
          "placeholder": "1000",
          "note": "Limit for a number of messages that can be fetched, 1,000 by default, up to 2000"
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "query": {
              "maxLength": 20000,
              "title": "SOQL Query",
              "type": "string",
              "required": true
            }
          }
        },
        "out": {}
      }
    },
    "rawRequest": {
      "title": "Raw Request",
      "main": "./lib/actions/rawRequest.js",
      "order": 91,
      "help": {
        "description": "Make Raw Request",
        "link": "/components/salesforce/actions#make-raw-request"
      },
      "metadata": {
        "in": "./lib/schemas/rawRequest.in.json",
        "out": "./lib/schemas/rawRequest.out.json"
      }
    },
    "upsert": {
      "deprecated": true,
      "title": "Upsert Object",
      "main": "./lib/actions/upsert.js",
      "order": 50,
      "help": {
        "description": "Create or Update Selected Object"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "objectTypes",
          "prompt": "Please select a Salesforce Object"
        },
        "extIdField": {
          "viewClass": "TextFieldView",
          "label": "Optional Upsert field",
          "required": false,
          "note": "Please make sure selected SObject has this field and it is marked as 'External ID'",
          "placeholder": "extID__c"
        },
        "utilizeAttachment": {
          "viewClass": "CheckBoxView",
          "label": "Utilize data attachment from previous step (for objects with a binary field)"
        }
      }
    },
    "upsert_v2": {
      "title": "Upsert Object",
      "main": "./lib/actions/upsert_v2.js",
      "order": 90,
      "help": {
        "description": "Create or Update selected Object",
        "link": "/components/salesforce/actions#upsert-object-action"
      },
      "dynamicMetadata": true,
      "fields": {
        "sobject": {
          "viewClass": "SelectView",
          "label": "Object",
          "required": true,
          "model": "getObjectTypes",
          "prompt": "Please select a Salesforce Object",
          "order": 8
        },
        "typeOfSearch": {
          "viewClass": "SelectView",
          "label": "Type Of Search",
          "required": true,
          "require": [
            "sobject"
          ],
          "model": {
            "uniqueFields": "Unique Fields",
            "externalIds": "External IDs",
            "allFields": "All Fields"
          },
          "prompt": "Please select a type of search",
          "order": 7
        },
        "lookupField": {
          "viewClass": "SelectView",
          "label": "Lookup by field",
          "required": true,
          "require": [
            "sobject",
            "typeOfSearch"
          ],
          "model": "getLookupFieldsModel",
          "prompt": "Please select the field which you want to use for lookup",
          "order": 6
        }
      }
    }
  }
}