Terminology
This page describes the terminology Omnata Push uses throughout the product.
App
An App (short for Application) is a SaaS product.
Examples: Salesforce, Hubspot, Zendesk
Internally, each App has a Plugin which contains all the code for communicating with that App.
Connection
A Connection is a link to a customer's instance of an App.
Examples: Salesforce Production Environment, Salesforce Sandbox 2
Sync
A Sync defines a configuration and schedule to synchronise data from Snowflake to an App, via a particular Connection.
Examples: Contacts Sync to Salesforce Production Environment
Branch
Branching is how change management occurs within Omnata push. Every Sync has an implied 'main' branch, which is the production environment.
A Sync created in Advanced mode can have branches, which allow proposed changes to be tested outside of the production environment, and merged in when ready.
Branching is described in more detail in the 'Branching' page.
States
Sync Health States
Describes the Sync's state from a success perspective.
Pending: Sync is yet to have its first run
Healthy: All pending records have either been successfully applied, or outstanding issues suppressed
Incomplete: The most recent sync containing records had at least one success, but there are records with unresolved sync failures
Failed: The most recent sync that contained records had zero success
Delayed: Sync behind schedule due to rate limiting, but otherwise Healthy
Sync Activity States
Describes the sync's current activity.
Pending: Sync is yet to have its first run
Running: The sync is currently executing
Waiting: The sync is waiting for the next scheduled run time
Paused: The schedule has been paused, so that runs will no longer trigger at the configured time
Sync Run Health States
Describes a Sync Run's state from a success perspective.
Pending: Sync Run has been initiated
In Progress: Sync Run is currently in progress
Healthy: All records were successfully sync'd without error
Incomplete: At least one success occurred, but there were records which experienced errors
Failed: All records in the sync experienced errors
Delayed: The sync run was incomplete due to rate limiting, but otherwise Healthy
Terminology specific to outbound syncs
Record States
Describes what was most recently observed in the source (Snowflake).
Created: Record was created in the source. When the Sync strategy is "Replace", all records remain in this state.
Updated: Record was updated in the source
Deleted: Record was deleted in the source
Record Sync Action
Describes the action required as a result of the record state, given the sync strategy.
Below is the standard set of Sync Actions, which covers most common actions to perform in apps.
Custom Sync Actions can be defined in plugins and utilised by custom sync strategies.
Create
Object will be created in the app
Update
Object will be updated in the app
Delete
Object will be deleted in the app
Send
Record will be sent to the app
Record Apply States
The state of the Record's sync action.
Success: Record has been applied in the app
Source Failure: The record failed pre-flight checks
Destination Failure: The record failed to be applied in the app
Delayed: The record was delayed due to rate limiting or the cancellation of a sync run
Active: The record is actively being applied
Not Required: No action was required
Resync Requested: The record has been marked for resync. Sync action will have been set at the same time.
Skipped Once: The most recent change was manually skipped, but future changes will continue to sync
Skipped Always: The record has been permanently excluded from the sync
Record Apply Reasons
The reason for current apply state.
Transform Error: An error occurred while performing the transformation that occurs during staging.
Change Criteria Met: The record changed.
Previously Delayed: The record was included in a previous run, but was not processed in that run.
Resync Requested: The user requested that the record have a resync performed.
Previously Failed: The previous attempt to apply the sync action failed.
Terminology specific to inbound syncs
Stream
Represents an object within an app, e.g. Salesforce has Account, Contact, etc. This term is borrowed from the Singer Specification.
Last updated