This integration is powered by Singer's Deputy tap. For support, visit the GitHub repo or join the Singer Slack.
Deputy integration summary
Stitch’s Deputy integration replicates data using the Deputy API. Refer to the Schema section for a list of objects available for replication.
Deputy feature snapshot
A high-level look at Stitch's Deputy (v1) integration, including release status, useful links, and the features supported in Stitch.
STITCH | |||
Release status |
Released on September 26, 2019 |
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 |
Supported |
Column selection |
Supported |
Select all |
Supported |
||
TRANSPARENCY | |||
Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Deputy
Step 1: Add Deputy as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Deputy 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 Deputy” would create a schema called
stitch_deputy
in the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Authorize Stitch to access Deputy
In this step, you’ll grant Stitch access to the Deputy organization you want to connect.
- When finished, click Authorize. You’ll be prompted to sign into your Deputy account if you aren’t already.
- After you log into Deputy, a screen with a list of your Deputy organizations will display. Select the organization you want to connect to Stitch and click Authorize.
- After the authorization process is successfully completed, you’ll be directed back to Stitch.
- Click All Done.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Deputy 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 Deputy’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.
Deputy 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 and columns 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.
For Deputy integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- 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.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Deputy, 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.
Deputy 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 Deputy 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.
addresses
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The addresses
table contains info about addresses.
Modified
The address ID. Reference: |
Modified
The time the address was last modified. |
ContactName
|
UnitNo
|
StreetNo
|
SuiteNo
|
PoBox
|
Street1
|
Street2
|
City
|
State
|
Postcode
|
Country
|
Phone
|
Notes
|
Format
|
Saved
|
Creator
Reference:
|
Created
|
categories
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The categories
table contains info about categories.
Modified
The category ID. Reference: |
Modified
The time the category was last modified. |
category
|
group
|
SortOrder
|
Stafflog
|
System
|
Creator
Reference:
|
Created
|
comments
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The comments
table contains info about comments.
Modified
The comment ID. |
Modified
The time the comment was last modified. |
Orm
|
RecId
|
InFeed
|
IgnorePermission
|
Comment
|
Creator
Reference:
|
Created
|
companies
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The companies
table contains info about companies.
Modified
The company ID. Reference: |
Modified
The time the company was last modified. |
Portfolio
|
Code
|
Active
|
ParentCompany
Reference: |
CompanyName
|
TradingName
|
BusinessNumber
|
CompanyNumber
|
IsWorkplace
|
IsPayrollEntity
|
PayrollExportCode
|
Address
Reference: |
Contact
Reference: |
Creator
Reference:
|
Created
|
company_periods
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The company_periods
table contains info about company periods.
Modified
The company period ID. Reference: |
Modified
The time the was last modified. |
Start
|
DateStart
|
End
|
DateEnd
|
Company
Reference: |
PayPeriod
Reference: |
Creator
Reference:
|
Created
|
contacts
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The contacts
table contains info about contacts.
Modified
The contact ID. Reference: |
Modified
The time the contact was last modified. |
Phone1
|
Phone2
|
Phone3
|
Fax
|
Phone1Type
|
Phone2Type
|
Phone3Type
|
PrimaryPhone
|
Email1
|
Email2
|
Email1Type
|
Email2Type
|
PrimaryEmail
|
Im1
|
Im2
|
Im1Type
|
Im2Type
|
Web
|
Notes
|
Saved
|
Creator
Reference:
|
Created
|
countries
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The countries
table contains info about countries.
Modified
The country ID. Reference: |
Modified
The time the country was last modified. |
Code
|
CodeA3
|
Region
|
Active
|
SortOrder
|
Country
|
ZipVAlidatePreg
|
PhoneDisplayPreg
|
Creator
Reference:
|
Created
|
custom_app_data
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The custom_app_data
table contains info about custom app data.
custom_fields
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The custom_fields
table contains info about
Modified
The custom fieldID. |
Modified
The time the custom field was last modified. |
System
|
Name
|
ApiName
|
DeputyField
|
SortOrder
|
Default
|
Type
|
ValueList
|
Validation
|
Helptext
|
Creator
Reference:
|
Created
|
custom_field_data
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The custom_field_data
table contains info about custom field data.
Modified
The custom field data ID. Reference: |
Modified
The time the was last modified. |
System
|
F01
|
F02
|
F03
|
F04
|
F05
|
F06
|
F07
|
F08
|
F09
|
F10
|
F11
|
F12
|
F13
|
F14
|
F15
|
F16
|
Creator
Reference:
|
Created
|
employee_agreements
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_agreements
table contains info about employee agreements.
employee_agreement_history
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_agreement_history
table contains info about
employee_appraisal
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_appraisal
table contains info about employee appraisals.
employee_availability
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_availability
table contains info about employee availability.
employee_contracts
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_contracts
table contains info about employee contracts.
employee_contract_leave_rules
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_contract_leave_rules
table contains info about employment contract leave rules.
employee_history
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_history
table contains info about employee histories.
employee_paycycles
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_paycycles
table contains info about employee paycycles.
employee_paycycle_returns
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_paycycle_returns
table contains info about employee paycycle returns.
employee_roles
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_roles
table contains info about employee roles.
Modified
The employee role ID. Reference: |
Modified
The time the employee role was last modified. |
Role
|
Ranking
|
ReportTo
|
Permissions
|
Require2fa
|
Creator
Reference:
|
Created
|
employee_salary_opunit_costing
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_salary_opunit_costing
table contains info about employee salary operational unit costs.
employee_workplaces
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employee_workplaces
table contains info about employee workplaces.
employment_conditions
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The employment_conditions
table contains info about employment conditions.
Modified
The employment condition ID. |
Modified
The time the employment condition was last modified. |
Name
|
Description
|
AwardLevel
|
EmploymentBasis
|
EmploymentCategory
Reference: |
EmploymentPeriod
|
EmploymentStatus
|
ProbationaryPeriod
|
WorkingDaysPerPeriod
|
UsualStartTime
|
UsualFinishTime
|
UsualMealbreak
|
AvgHoursPerDay
|
MinHoursPerDay
|
MinHoursForLeave
|
Creator
Reference:
|
Created
|
events
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The events
table contains info about events.
Modified
The event ID. |
Modified
The time the event was last modified. |
Title
|
Schedule
Reference: |
Colour
|
ShowOnRoster
|
BlockTimeOff
|
AddToBudget
|
Creator
Reference:
|
Created
|
geo
Replication Method : |
Key-based Incremental |
Replication Key |
Modified |
Primary Key |
Modified |
Official docs : |
The geo
table contains info about geographic locations.
Modified
The geo ID. |
Modified
The time the geo was last modified. |
Orm
|
RecId
|
Longitude
|
Latitude |