Using the SendPulse REST Source Component
The REST Source component is an SSIS source component that can be used to read/retrieve data from SendPulse REST services and produce column data, which can then be consumed by a downstream SSIS pipeline component.
See SendPulse REST Connection Manager for how to connect to SendPulse and SendPulse REST Destination Component for how to write data to SendPulse.
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 SendPulse. The Connection Manager drop-down will show a list of all connection managers that are available for your current SSIS package.
- Search
-
Click the search button (or press Ctrl + F on your keyboard) to launch the Search Objects & Endpoints dialog. This dialog allows you to search for an object or endpoint. Clicking on a result will select that object or endpoint in the source editor.
- Source Object
-
The Source Object drop-down lists the available objects that you can read from.
- Endpoint
-
The Endpoint drop-down lists all available REST endpoints for the selected object.
- Endpoint Details
-
The Endpoint Details show the route and HTTP method of the selected endpoint.
- Batch Size
-
The Batch Size lets you specify how many records to retrieve per service call to SendPulse.
Note: Some endpoints do not support batch size, in which case this option will not be available.
- Output Time Zone
-
The Output Time Zone option lets you specify how all datetime fields should be retrieved. Available options are:
- UTC
- Local
- Filter Parameters
-
The Filter Parameters section allows you to provide parameter values that control which records are returned by the selected endpoint.
The grid consists of:
- Parameter Name: The name of the parameter that will be included in the request.
- Value: The value that will be supplied for the parameter.
Use the green plus icon to add an optional parameter when supported by the selected endpoint.
Note: Available and required filter parameters may vary depending on the selected object and endpoint.
- 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.
(Since v24.1) By clicking on Refresh Component, a new window pops up as shown below, which will have three options to decide how the updates to metadata should be performed.
- Update all: This would update all the fields regardless of whether there are metadata changes.
- Update if there are incompatible metadata: This option would refresh any incompatible metadata to the discovered metadata.
- Update none: No metadata updates would happen to existing fields.
- Expression fx Icon
-
Click the blue fx icon to launch the 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 mappings, 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 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 Hide Selected and Hide Unselected options allow you to control which fields are displayed in the grid. The Filter option allows you to find fields using a keyword.
The Columns Page grid consists of:
- REST Field: The column that will be retrieved from the SendPulse REST service.
- Additional Field Details: An information icon will appear here if the column is special. Hover over the icon to see additional details about the column.
- Data Type: The data type of the field.
- More Fields
-
This button opens the Manage Additional Fields editor, where you can select additional outputs or fields from the object returned by the server.
- Expand All: This button expands the tree view of all fields under each object.
- Collapse All: This button collapses the tree view to show only the returned sub-objects.
- View: This option enables you to view or hide the Details and Summary sections of the Manage Additional Fields editor.
- Filter: This option allows you to show checked or unchecked items and filter the list of fields using a keyword.
- Details section: This section displays information about the selected field or output, including its expected performance impact when enabled.
- Summary section: This section displays a summary of the secondary outputs or fields that will be added to the component.
Note: As a general best practice, you should only select the fields that are needed for downstream pipeline components.