This integration is powered by Singer's Selligent tap. For support, visit the GitHub repo or join the Singer Slack.
Selligent feature snapshot
A high-level look at Stitch's Selligent (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on December 14, 2017 |
Supported by | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
REPLICATION SETTINGS | |||
Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
DATA SELECTION | |||
Table selection |
Unsupported |
Column selection |
Unsupported |
Select all |
Unsupported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Selligent
Selligent setup requirements
To set up Selligent in Stitch, you need:
-
Personal Selligent API Key. This is required to connect Selligent to Stitch.
Step 1: Obtain Selligent API Key
Contact your Selligent account manager to obtain the API key for your organization.
After you receive your API key, you can proceed with the setup in Stitch.
Step 2: Add Selligent as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Selligent icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Selligent” would create a schema called
stitch_selligent
in the destination. Note: Schema names cannot be changed after you save the integration. - In the Base URL field, enter the base URL for your Selligent installation. It will be similar to
https://organization.some-host.com:443
- In the API Key field, paste the API key you obtained in Step 1.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Selligent integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Selligent’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Selligent integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
- Repeat this process for all the tables you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
Initial and historical replication jobs
After you finish setting up Selligent, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Selligent table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Selligent integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
campaign
Replication Method : |
Full Table |
Primary Key |
asset_id |
Official docs : |
This table contains campaign data.
asset_id
|
modified_time
|
asset_name
|
version_number
|
internal_datasource
Replication Method : |
Full Table |
Primary Key |
id |
Official docs : |
This table contains internal data source data.
id
The asset_id of this mailing. |
|
modified_time
|
|
asset_name
|
|
asset_url
|
|
cloud_sync
|
|
data_source_stat
|
|
version_number
|
Replication Method : |
Full Table |
Primary Key |
asset_id |
Official docs : |
This table contains owner data.
asset_id
|
modified_time
|
first_name
|
last_name
|
program
Replication Method : |
Full Table |
Primary Key |
id |
Official docs : |
This table contains program data.
id
The asset_id of this mailing. |
modified_time
|
asset_name
|
asset_url
|
status
|
type
|
source
Replication Method : |
Full Table |
Primary Key |
asset_id |
Official docs : |
This table contains source data.
asset_id
|
modified_time
|
asset_name
|
data_source_type
|
version_number
|
transactional_mailing
Replication Method : |
Full Table |
Primary Key |
id |
Official docs : |
This table contains transactional mailing data.
id
The asset_id of this mailing. |
||
modified_time
|
||
approved
|
||
asset_name
|
||
channel
|
||
compliance
|
||
mailing_priority
|
||
mailing_server_group
|
||
mailing_status
|
||
target
|
||
version_number
|
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.