Using the SuiteCRM REST Source Component
The REST Source component is an SSIS source component that can be used to read/retrieve data from SuiteCRM REST services and produce column data, which then can be consumed by a downstream SSIS pipeline component.
See SuiteCRM Rest Connection Manager for how to connect to SuiteCRM and SuiteCRM REST Destination Component for how to write to SuiteCRM.
The component includes the following two pages to configure how you want to read data.
- General
- Columns
General Page
The General page of the REST Source Component allows you to specify the general settings of the component.
- Connection Manager
-
The source component requires a REST connection to SuiteCRM. The Connection Manager drop-down will show a list of all connection managers that are available to your current SSIS package.
- Source Object
-
The Source Object drop-down lists available objects which you can read from.
- Endpoint
-
The Endpoint drop-down lists all available rest endpoints for the selected object.
- Endpoint Details
-
This is a read-only property that displays the Route and HTTP Method of the currently selected Endpoint.
- Batch Size
-
The Batch Size lets you specify how many records to retrieve per service call to SuiteCRM.
Note: Some objects do not support batch size, so this option will become disabled.
- Filter Parameters
-
You can specify Filter Parameters so that the source component only returns those records that satisfy such filter parameters. If a filter parameter has a yellow asterisk beside it, it means the parameter is required and a value must be provided. There are two types of filter parameters available.
Search: Provide the parameters to filter based on them. Multiple parameters can be used.
Sort: Provide the parameters to sort based on them. Direction for sort – ascending or descending can be specified.
Note: Filter fields may vary from object to object depending on endpoints.
- Refresh Component Button
-
Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.
- Expression fx Icon
-
Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.
- Generate Documentation Icon
-
Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.
Columns Page
The Columns page of the REST Source Component shows you all available attributes from the endpoint that you specified on the General page. On this page, you can select the output whose columns you wish to configure in the top left drop-down.
On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.
- The Columns Page grid consists of:
- REST Field: Column that will be retrieved from the SuiteCRM REST service.
- Additional Field Details: An information icon will appear here if the column is special. Hover over the icon to see what makes the column special.
- Data Type: The data type of this field.
Note: As a general best practice, you should only select the fields that are needed for the downstream pipeline components.