# Selligent (v1)

Information note **Selligent is supported by the Singer community**   
This integration is powered by [Singer's](https://www.singer.io/) Selligent tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-selligent) or [join the Singer Slack](https://singer-slackin.herokuapp.com/).

## 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](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on December 14, 2017 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Success icon<br><br>This version of the integration is available via the API.<br><br><br>Available |
| **Singer GitHub repository** | [singer-io/tap-selligent](https://github.com/singer-io/tap-selligent) |  |  |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon<br><br>Table-level resets are not supported for this integration. Resets are only supported at the integration level.<br><br><br>Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon<br><br>Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.<br><br><br>Unsupported |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Remove icon<br><br>Table selection is not supported for this integration. All available table and fields will be automatically selected for replication.<br><br><br>Unsupported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Remove icon<br><br>Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.<br><br><br>Unsupported |
| **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Remove icon<br><br>As this integration doesn't support table or column selection, all available tables and columns are automatically replicated.<br><br><br>Unsupported |  |  |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>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

1. [Sign into your Stitch account](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Click the **Selligent** icon.

4. 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.

5. In the **Base URL** field, enter the base URL for your Selligent installation. It will be similar to `https://organization.some-host.com:443`

6. In the **API Key** field, paste the API key you obtained in [Step 1](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#obtain-api-key).

### Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Selligent integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse.

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](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide.

### Step 4: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). 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:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)

* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (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](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.

### Step 5: Set objects to replicate

Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements).

The last step is to select the tables you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#schema)

**Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts.

1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate.

2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate.

3. Repeat this process for all the tables you want to replicate.

4. 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.**

Information note

**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](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) 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.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.

## Selligent table reference

Information note

**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.

Information note

**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` &gt; `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` &gt; `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info.

### campaign

This table contains campaign data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | asset\_id |
| **Useful links** | [campaign schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: campaign schema on GitHub") |

campaign table foreign keys

| Join campaign with | on |
| --- | --- |
| [internal_datasource](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#internal-datasource) | ```<br>campaign.asset_id = internal_datasource.id<br>``` |
| [owner](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#owner) | ```<br>campaign.asset_id = owner.asset_id<br>``` |
| [source](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#source) | ```<br>campaign.asset_id = source.asset_id<br>``` |
| [transactional_mailing](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#transactional-mailing) | ```<br>campaign.asset_id = transactional_mailing.id<br>``` |
| [program](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#program) | ```<br>campaign.asset_id = program.id<br>``` |

campaign table schema

| **asset\_id**<br><br><br>INTEGER |
| --- |
| **asset\_name**<br><br><br>STRING |
| **modified\_time**<br><br><br>STRING |
| **version\_number**<br><br><br>STRING |

### internal\_datasource

This table contains internal data source data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id |
| **Useful links** | [internal_datasource schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: internal_datasource schema on GitHub") |

internal\_datasource table foreign keys

| Join internal\_datasource with | on |
| --- | --- |
| [campaign](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#campaign) | ```<br>internal_datasource.id = campaign.asset_id<br>``` |
| [owner](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#owner) | ```<br>internal_datasource.id = owner.asset_id<br>``` |
| [source](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#source) | ```<br>internal_datasource.id = source.asset_id<br>``` |
| [transactional_mailing](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#transactional-mailing) | ```<br>internal_datasource.id = transactional_mailing.id<br>``` |
| [program](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#program) | ```<br>internal_datasource.id = program.id<br>``` |

internal\_datasource table schema

| **asset\_name**<br><br><br>STRING |
| --- |
| **asset\_url**<br><br><br>STRING |
| **cloud\_sync**<br><br><br>BOOLEAN |
| **data\_source\_stat**<br><br><br>OBJECT<br><br>This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. &lt;a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'&gt;Learn more&lt;/a&gt;.<br><br>Click to expand data\_source\_stat<br><br><table> <tr> <td> <p> <strong>								num_total_rec							</strong> </p> <p>							INTEGER													</p> </td> </tr> </table> |
| **id**<br><br><br>INTEGER |
| **modified\_time**<br><br><br>STRING |
| **version\_number**<br><br><br>STRING |

### owner

This table contains owner data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | asset\_id |
| **Useful links** | [owner schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: owner schema on GitHub") |

owner table foreign keys

| Join owner with | on |
| --- | --- |
| [campaign](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#campaign) | ```<br>owner.asset_id = campaign.asset_id<br>``` |
| [internal_datasource](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#internal-datasource) | ```<br>owner.asset_id = internal_datasource.id<br>``` |
| [source](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#source) | ```<br>owner.asset_id = source.asset_id<br>``` |
| [transactional_mailing](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#transactional-mailing) | ```<br>owner.asset_id = transactional_mailing.id<br>``` |
| [program](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#program) | ```<br>owner.asset_id = program.id<br>``` |

owner table schema

| **asset\_id**<br><br><br>INTEGER |
| --- |
| **first\_name**<br><br><br>STRING |
| **last\_name**<br><br><br>STRING |
| **modified\_time**<br><br><br>STRING |

### program

This table contains program data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id |
| **Useful links** | [program schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: program schema on GitHub") |

program table foreign keys

| Join program with | on |
| --- | --- |
| [campaign](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#campaign) | ```<br>program.id = campaign.asset_id<br>``` |
| [internal_datasource](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#internal-datasource) | ```<br>program.id = internal_datasource.id<br>``` |
| [owner](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#owner) | ```<br>program.id = owner.asset_id<br>``` |
| [source](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#source) | ```<br>program.id = source.asset_id<br>``` |
| [transactional_mailing](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#transactional-mailing) | ```<br>program.id = transactional_mailing.id<br>``` |

program table schema

| **asset\_name**<br><br><br>STRING |
| --- |
| **asset\_url**<br><br><br>STRING |
| **id**<br><br><br>INTEGER |
| **modified\_time**<br><br><br>STRING |
| **status**<br><br><br>STRING |
| **type**<br><br><br>STRING |

### source

This table contains source data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | asset\_id |
| **Useful links** | [source schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: source schema on GitHub") |

source table foreign keys

| Join source with | on |
| --- | --- |
| [campaign](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#campaign) | ```<br>source.asset_id = campaign.asset_id<br>``` |
| [internal_datasource](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#internal-datasource) | ```<br>source.asset_id = internal_datasource.id<br>``` |
| [owner](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#owner) | ```<br>source.asset_id = owner.asset_id<br>``` |
| [transactional_mailing](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#transactional-mailing) | ```<br>source.asset_id = transactional_mailing.id<br>``` |
| [program](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#program) | ```<br>source.asset_id = program.id<br>``` |

source table schema

| **asset\_id**<br><br><br>INTEGER |
| --- |
| **asset\_name**<br><br><br>STRING |
| **data\_source\_type**<br><br><br>STRING |
| **modified\_time**<br><br><br>STRING |
| **version\_number**<br><br><br>STRING |

### transactional\_mailing

This table contains transactional mailing data.

| **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table |
| --- | --- |
| **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id |
| **Useful links** | [transactional_mailing schema on GitHub](https://github.com/singer-io/tap-selligent/blob/master/tap_selligent/schemas.py "Opens in new tab: transactional_mailing schema on GitHub") |

transactional\_mailing table foreign keys

| Join transactional\_mailing with | on |
| --- | --- |
| [campaign](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#campaign) | ```<br>transactional_mailing.id = campaign.asset_id<br>``` |
| [internal_datasource](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#internal-datasource) | ```<br>transactional_mailing.id = internal_datasource.id<br>``` |
| [owner](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#owner) | ```<br>transactional_mailing.id = owner.asset_id<br>``` |
| [source](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#source) | ```<br>transactional_mailing.id = source.asset_id<br>``` |
| [program](https://help.qlik.com/en-US/stitch/integrations/saas/selligent#program) | ```<br>transactional_mailing.id = program.id<br>``` |

transactional\_mailing table schema

| **approved**<br><br><br>BOOLEAN |
| --- |
| **asset\_name**<br><br><br>STRING |
| **channel**<br><br><br>STRING |
| **compliance**<br><br><br>BOOLEAN |
| **id**<br><br><br>INTEGER |
| **mailing\_priority**<br><br><br>STRING |
| **mailing\_server\_group**<br><br><br>STRING |
| **mailing\_status**<br><br><br>STRING |
| **modified\_time**<br><br><br>STRING |
| **target**<br><br><br>OBJECT<br><br>This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. &lt;a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'&gt;Learn more&lt;/a&gt;.<br><br>Click to expand target<br><br><table> <tr> <td> <p> <strong>								asset_id							</strong> </p> <p>							INTEGER													</p> </td> </tr> <tr> <td> <p> <strong>								asset_name							</strong> </p> <p>							STRING													</p> </td> </tr> </table> |
| **version\_number**<br><br><br>STRING |