Connector Builder Guide – How to Enable Bulk

[former_member604434]

Connector Builder Guide – How to Enable Bulk

Open Connectors consists of over 170 connectors to 3rd Party Applications natively embedded in the SAP ecosystem. If the Connector you need does not exist in the catalog, you can build it quickly with Connector Builder. This instruction guide will walk you through using this tool, with concrete examples throughout. The beginning, Part 1, can be found here.

 

If the vendor API does not offer native batching, or bulk endpoints, Connector Builder will simulate bulk and create bulk resources that work to create a file of records. This file can then be streamed directly from Open Connectors.



First, make sure to have added response models to the objects to want to enable bulk resources for.

Then, on the resource, click Bulk. Specify the Primary Key (usually Id or similar), and the Created At and Updated At fields, if they exist. These are necessary if you will be using a data range when creating a bulk file. Select Enable Bulk Download and Save. Now click on the API Docs tab, next to the Resources tab on the top menu. You will now see bulk resources.

Enter in select * from contacts and Execute. You will get back a bulk job Id. This Id can be used to get the bulk job status (GET /bulk/{id}/status).





This file can then be retrieved by using the GET /bulk/{id}/{objectName} endpoint.