Outreach Connector for CData Sync

Build 24.0.9175
  • Outreach
    • 接続の確立
    • データモデル
      • ビュー
        • Accounts
        • CallDispositions
        • CallPurposes
        • Calls
        • ComplianceRequests
        • ContentCategories
        • ContentCategoryMemberships
        • ContentCategoryOwnerships
        • Duties
        • EmailAddress
        • Events
        • Favorites
        • MailAliases
        • Mailbox
        • Mailings
        • Opportunities
        • OpportunityProspectRoles
        • OpportunityStages
        • Personas
        • PhoneNumbers
        • Profiles
        • Prospects
        • Recipients
        • Roles
        • Rulesets
        • Sequences
        • SequenceStates
        • SequenceSteps
        • SequenceTemplates
        • Snippets
        • Stages
        • TaskPriorities
        • Tasks
        • Teams
        • Templates
        • Users
        • UsersDuties
    • 接続文字列オプション
      • Connection
        • APIVersion
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Outreach Connector for CData Sync

概要

CData Sync App は、Outreach データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。

Outreach コネクタはCData Sync アプリケーションから使用可能で、Outreach からデータを取得して、サポートされている任意の同期先に移動できます。

Outreach バージョンサポート

Sync App は、Outreach API のバージョン2 (v2) を利用して、Outreach の収益管理データへの双方向アクセスを実現します。

Outreach Connector for CData Sync

接続の確立

Outreach への接続を追加

Outreach への接続を追加するには:

  1. アプリケーションコンソールで、接続ページに移動します。
  2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
  3. Outreach アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからOutreach コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Outreach への接続

Outreach はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのOutreach への認証について詳しく説明します。

  • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
  • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
  • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth 情報を取得する方法と、埋め込みOAuth 認証情報を持つ認証フローでもカスタム接続を作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Outreach で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

アクセストークンの期限が切れたときは、Sync App は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ:

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

  1. はじめてデータに接続する際、次の接続プロパティを設定します。
    • InitiateOAuth: REFRESH。
    • OAuthClientId:アプリケーション設定のクライアントId。
    • OAuthClientSecret:アプリケーション設定のクライアントシークレット。
    • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation:Sync App がOAuth 値を保存する場所のパス。これは接続間で維持されます。
  2. その後のデータ接続では、以下を設定します。
    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId:アプリケーション設定のクライアントId。
    • OAuthClientSecret:アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

Outreach Connector for CData Sync

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Outreach API へのSQL の実行について詳しく説明します。

主要機能

  • Sync App は、Outreach エンティティをリレーショナルビューとしてモデル化し、SQL を記述してOutreach データをクエリできるようにします。
  • ストアドプロシージャを使用するとOutreach の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Sync App を使用するとOutreach アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Accounts、Prospects、Calls などのOutreach エンティティを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Outreach のファンクションライクなインターフェースです。

ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Outreach の操作を実行できます。

Outreach Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

Outreach Connector for CData Sync ビュー

Name Description
Accounts Get details of accounts.
CallDispositions A ready-made collection of call dispositions that help categorize your call logs.
CallPurposes Get details of ready-made collection of call dispositions that help categorize your call logs.
Calls Get details of an inbound or outbound call made with a prospect.
ComplianceRequests Get details of compliance requests.
ContentCategories Get details of content categories.
ContentCategoryMemberships Get details of a record that maps content to a content category.
ContentCategoryOwnerships A record that maps content to a content category.
Duties An Outreach-suggested role or job duty played by a user in their organization.
EmailAddress Get details of prospect email addresses.
Events Get details of application events, capturing details around the initiator, recipient.
Favorites Get details of a record favorited by a particular user.
MailAliases Alternative email name for a mailbox.
Mailbox Get details of email mailboxes.
Mailings Get details of mailings.
Opportunities Get details of opportunities for sales or pending deals.
OpportunityProspectRoles Get details of prospect roles and associated with an opportunity.
OpportunityStages The stage an opportunity is in.
Personas A descriptor of a person used for categorizing prospects.
PhoneNumbers Get details of prospect phone numbers.
Profiles Controls what you can see and do within Outreach.
Prospects Get details of prospects.
Recipients Record for a recipient for some communication, such as email.
Roles Get details of where you fall within your organizations structure.
Rulesets A reusable set of behaviors to be applied to sequences.
Sequences Get details of sequences.
SequenceStates Get details of sequence states.
SequenceSteps Get details of sequence steps.
SequenceTemplates An object used to track which templates are in use by which sequence steps.
Snippets Piece of an email to be reused in multiple messages.
Stages The point in the process used for categorizing prospects.
TaskPriorities Descriptor of importance used for categorizing tasks.
Tasks An item that requires action to complete.
Teams Get details of a group of users.
Templates Get details of reusable templates for building emails.
Users Get details of the individual that uses the application.
UsersDuties Get details of the individual that uses the application.

Outreach Connector for CData Sync

Accounts

Get details of accounts.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • BuyerIntentScore supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • CustomId supports the '=,>=,<=,>,<' operators.
  • Domain supports the '=,IN' operators.
  • Name supports the '=,IN' operators.
  • Nammed supports the '=,IN' operators.
  • SharingTeamId supports the '=,IN' operators.
  • TouchedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Accounts WHERE Id = 1

SELECT * FROM Accounts WHERE Id IN (1, 2)

SELECT * FROM Accounts WHERE Id >= 1

SELECT * FROM Accounts WHERE Id <= 1

SELECT * FROM Accounts WHERE Id > 1

SELECT * FROM Accounts WHERE Id < 2

SELECT * FROM Accounts WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM accounts WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Accounts WHERE CustomId = 1

SELECT * FROM Accounts WHERE BuyerIntentScore = 1

SELECT * FROM Accounts WHERE SharingTeamId = 1

Columns

Name Type Description
Id [KEY] Integer Id of Accounts.
BuyerIntentScore Double A custom score given to measure the quality of the account.
CompanyType String A description of the company type.
CreatedAt Datetime The date and time the account was created.
CustomId String A custom ID for the account often referencing an ID in an external system.
Description String A custom description of the account.
Domain String The company website domain.
ExternalSource String The source of the resource creation.
Followers String The number of followers the company has listed on social media.
FoundedAt Datetime The founding date of the company.
Industry String A description of the company industry.
LinkedInEmployees String The number of employees listed on the company LinkedIn URL.
LinkedInUrl String The company LinkedIn URL.
Locality String The company primary geographic region.
Name String The name of the company.
Named Boolean A boolean value determining whether this is a named account or not Only named accounts will show up on the collection index.
NaturalName String The natural name of the company.
NumberOfEmployees String The number of employees working at the company.
SharingTeamId String The ID of the sharing team associated with this object Access is currently in beta.
Tags String A list of tag values associated with the account.
TouchedAt Datetime The date and time the account was last touched.
TrashedAt String The date and time the account was last updated.
UpdatedAt Datetime The date and time the account was last touched at.
WebsiteUrl String The company website URL.
LinksSelf String Link Self.
Creatorid Integer Creator Id.
CreatorType String Creator Type.
OwnerId Integer owner Id.
OwnerType String Owner Type.
ProspectsLinks String Prospects Links.
TasksLinks String Tasks Links.
UpdaterId Integer Updater Id.
UpdaterType String Updater Type.
Type String Type.

Outreach Connector for CData Sync

CallDispositions

A ready-made collection of call dispositions that help categorize your call logs.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • OrderValue supports the '=,>=,<=,>,<' operators.
  • Outcome supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
For example, the following query is processed server side:
SELECT * FROM CallDispositions WHERE Id = 1

SELECT * FROM CallDispositions WHERE Id IN (1, 2)

SELECT * FROM CallDispositions WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallDispositions WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallDispositions WHERE Name IN ('test', 'ram')

SELECT * FROM CallDispositions WHERE OrderValue = 1

Columns

Name Type Description
Id [KEY] Integer Id.
CreatedAt Datetime The date and time the call disposition was created.
LinksSelf String Links self.
Name String The disposition's name.
OrderValue Integer The disposition's display OrderValue within the collection.
Outcome String The disposition's call outcome. Possible values are 'Answered', 'Not Answered', etc.
UpdatedAt Datetime The date and time the call disposition was last updated.
CallsLinks String Calls links.
CreatorId Integer Creator Id.
Type String Type of disposition.

Outreach Connector for CData Sync

CallPurposes

Get details of ready-made collection of call dispositions that help categorize your call logs.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • OrderValue supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM CallPurposes WHERE Id = 1

SELECT * FROM CallPurposes WHERE Id IN (1, 2)

SELECT * FROM CallPurposes WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM CallPurposes WHERE Name = 'Answered - Meeting Set'

SELECT * FROM CallPurposes WHERE Name IN ('test', 'ram')

SELECT * FROM CallPurposes WHERE OrderValue = 1

Columns

Name Type Description
Id [KEY] Integer Id.
CreatedAt Datetime The date and time the call disposition was created.
LinksSelf String Links self.
Name String The purpose's name.
OrderValue Integer The purpose's display OrderValue within the collection.
UpdatedAt Datetime The date and time the call disposition was last updated.
CallsLinks String Calls Links.
CreatorId Integer Creator Id.
Type String Type of disposition.

Outreach Connector for CData Sync

Calls

Get details of an inbound or outbound call made with a prospect.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • From supports the '=,IN' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Outcome supports the '=,IN' operators.
  • State supports the '=,IN' operators.
  • To supports the '=,IN' operators.
  • UserCallType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Calls WHERE Id = 1

SELECT * FROM Calls WHERE Id IN (1, 2)

SELECT * FROM Calls WHERE Id >= 1

SELECT * FROM Calls WHERE Id <= 1

SELECT * FROM Calls WHERE Id > 1

SELECT * FROM Calls WHERE Id < 2

SELECT * FROM Calls WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Calls WHERE UserCallType = 'bridge'

SELECT * FROM Calls WHERE UserCallType IN('bridge', 'test')

Columns

Name Type Description
Id [KEY] Integer Id of call.
AnsweredAt Datetime The date and time the call was answered.
CompletedAt Datetime The date and time the call was completed.
CreatedAt Datetime The date and time the call was created.
DialedAt Datetime The date and time the call was dialed.
Direction String The call direction from the user's point of view.
ExternalVendor String The voice provider of the call.
From String The phone number used to place the call.
Note String A custom note associated with this call.
Outcome String The calls outcome. Possible values are 'Answered', 'Not Answered', etc.
RecordingDeletionReason String Recording Deletion Reason.
RecordingUrl String The URL of the calls audio recording.
ReturnedAt Datetime The date and time the call was returned.
SequenceAction String The action to take on the associated sequence.
ShouldRecordCall Boolean Indicated whether or not the call is recorded.
State String The calls current state.
StateChangedAt Datetime The date and time the calls state last changed.
Tags String A list of tag values associated with the call.
To String The phone number that the call was placed to.
Uid String The Outreach voice trace Id.
UpdatedAt Datetime The date and time the call was last updated.
UserCallType String The type of call placed within the Outreach client. Possible values are bridge, voip, etc.
VendorCallId String The call-id as recorded by the voice provider.
VoicemailRecordingUrl String The URL of the calls voicemail audio recording.
LinksSelf String Link self.
BatchesLinks String Batches Links.
CallDispositionId Integer The associated call disposition Id.
CallDispositionType String The associated Call disposition type.
CallPurposeId Integer The associated call purpose Id.
CallPurposeType String The associated call purpose type.
OpportunityId Integer The associated opportunity Id.
PhoneNumberId Integer The associated phone number's Id.
ProspectId Integer The associated prospect Id.
SequenceId Integer The associated sequence Id.
SequenceStateId Integer The associated sequenceStates Id.
SequenceStepId Integer The associated sequence Step Id.
TaskId Integer The associated task's Id.
UserId Integer The associated user's Id.
Type String Type.

Outreach Connector for CData Sync

ComplianceRequests

Get details of compliance requests.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN' operators.
  • State supports the '=,IN' operators.
  • UuId supports the '=,IN' operators.
For example, the following query is processed server side:
SELECT * FROM ComplianceRequests WHERE Id = 1

SELECT * FROM ComplianceRequests WHERE Id IN (1, 2)

SELECT * FROM ComplianceRequests WHERE State = 'test'

SELECT * FROM ComplianceRequests WHERE uuid = '12345'

SELECT * FROM ComplianceRequests WHERE uuid IN (1, 2)

Columns

Name Type Description
Id [KEY] Integer Id of compliance request.
BatchComplianceRequestUuid String The UUID of the batch the compliance request belongs to.
CreatedAt Datetime The date and time the compliance request was created.
ObjectType String The type of record to process.
RequestObjectId String The identifier for the record processed for prospects. This is the prospect Id for recipients. This is an e-mail address.
RequesterId Integer The ID of the Outreach user who submitted the compliance request.
RequestType String The type of compliance request.
State String The current state of the compliance request.
UpdatedAt Datetime The date and time at which the compliance request was last updated.
UuId String The UUID of the compliance request.

Outreach Connector for CData Sync

ContentCategories

Get details of content categories.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM ContentCategories WHERE Id = 1

SELECT * FROM ContentCategories WHERE Id IN (1, 2)

SELECT * FROM ContentCategories WHERE Id >= 1

SELECT * FROM ContentCategories WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategories WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of Content Category.
AllowSequences Boolean Whether or not this category be used to group sequences.
AllowSnippets Boolean Whether or not this category be used to group snippets.
AllowTemplates Boolean Whether or not this category be used to group templates.
Color String Color of the content category to be used as a background.
CreatedAt Datetime The date and time the content category was created.
Name String The name of the content category.
UpdatedAt Datetime The date and time the content category was last updated.
LinksSelf String Link self.
CreatorId Integer Creator Id.
CreatorType String Creator type.
Type String Types.

Outreach Connector for CData Sync

ContentCategoryMemberships

Get details of a record that maps content to a content category.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM ContentCategoryMemberships WHERE Id = 1

SELECT * FROM ContentCategoryMemberships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1

SELECT * FROM ContentCategoryMemberships WHERE Id < 2

SELECT * FROM ContentCategoryMemberships WHERE Id <= 2

SELECT * FROM ContentCategoryMemberships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryMemberships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of content category memberships.
CreatedAt Datetime The date and time the content category membership was created.
UpdatedAt Datetime The date and time the content category membership was last updated.
ContentCategoryId Integer The content category Id.
CreatorId Integer Creator Id.
CreatorType String Creator type.
OwnerId Integer owner Id.
OwnerType String Owner type.
Type String Types.

Outreach Connector for CData Sync

ContentCategoryOwnerships

A record that maps content to a content category.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM ContentCategoryOwnerships WHERE Id = 1

SELECT * FROM ContentCategoryOwnerships WHERE Id IN (1, 2)

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1

SELECT * FROM ContentCategoryOwnerships WHERE Id < 2

SELECT * FROM ContentCategoryOwnerships WHERE Id <= 2

SELECT * FROM ContentCategoryOwnerships WHERE Id >= 1 AND Id <= 10

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-01-25 01:02:02.0 ' AND UpdatedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM ContentCategoryOwnerships WHERE UpdatedAt > '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of content category ownerships.
CreatedAt Datetime The date and time the content category ownership was created.
UpdatedAt Datetime The date and time the content category ownership was last updated.
ContentCategoryId Integer The content category Id.
CreatorId Integer Creator Id.
CreatorType String Creator type.
Type String Type.

Outreach Connector for CData Sync

Duties

An Outreach-suggested role or job duty played by a user in their organization.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Duties WHERE Id = 1

SELECT * FROM Duties WHERE Id IN (1, 2)

SELECT * FROM Duties WHERE Id >= 1

SELECT * FROM Duties WHERE Id <= 4

SELECT * FROM Duties WHERE Id > 1

SELECT * FROM Duties WHERE Id < 4

Columns

Name Type Description
Id [KEY] Integer Id of duty.
DutyType String The polymorphic type of the duty.
SymbolicName String The string constant used to refer to this duty which can be internationalized on the client.
Type String Type.

Outreach Connector for CData Sync

EmailAddress

Get details of prospect email addresses.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • Email supports the '=,IN' operators.
  • EmailType supports the '=,IN' operators.
  • Status supports the '=,IN' operators.
  • OrderValue supports the '=,>=,<=,>,<' operators.
  • StatusChangedAt supports the '=,>=,<=,>,<' operators.
  • UnsubscribedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM EmailAddress WHERE Id = 1

SELECT * FROM EmailAddress WHERE Id IN (1, 2)

SELECT * FROM EmailAddress WHERE Id >= 1

SELECT * FROM EmailAddress WHERE Id <= 1

SELECT * FROM EmailAddress WHERE Id > 1

SELECT * FROM EmailAddress WHERE Id < 2

SELECT * FROM EmailAddress WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-27 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE UnsubscribedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM EmailAddress WHERE Email = '[email protected]'

Columns

Name Type Description
Id [KEY] Integer Id of Email Address.
BouncedAt Datetime The date and time the email was bounced.
CreatedAt Datetime The date and time the email address was created.
Email String The raw email address value.
EmailType String Type of email address.
OrderValue Integer Ordered position in list of emails.
Status String The status of the email.
StatusChangedAt Datetime Time the status was updated.
UnsubscribedAt Datetime Time a mailing was unsubscribed using this address.
UpdatedAt Datetime The date and time the email address was last updated.
LinksSelf String Link self.
ProspectId Integer Prospect's Id.
ProspectType String Relationship type.
Type String Type.

Outreach Connector for CData Sync

Events

Get details of application events, capturing details around the initiator, recipient.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • EventAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Events WHERE Id = 1

SELECT * FROM Events WHERE Id IN (1, 2)

SELECT * FROM Events WHERE Id >= 1

SELECT * FROM Events WHERE Id <= 1

SELECT * FROM Events WHERE Id > 1

SELECT * FROM Events WHERE Id < 2

SELECT * FROM Events WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE EventAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Events WHERE Name IN ('task_updated', 'task_owner_changed')

Columns

Name Type Description
Id [KEY] Integer Id of Email Address.
Body String The event body.
CreatedAt Datetime The date and time the event was created.
EventAt Datetime The date and time the event occurred.
ExternalUrl String The external URL associated with this event.
Name String The name of the event that took place.
Payload String The transmitted data for the event.
RequestCity String The city where the request that created the event was made.
RequestDevice String The type of device on which the request that created the event was made.
RequestHost String Name of the host from which the request was made.
RequestProxied Boolean A boolean value indicating whether or not the request was proxied.
RequestRegion String Name of the region from which the request was made.
LinksSelf String Link self.
MailingId Integer Mailing Id.
ProspectId Integer Prospect's Id.
ProspectType String Prospect's type.
UserId Integer User's Id.
Type String Type.

Outreach Connector for CData Sync

Favorites

Get details of a record favorited by a particular user.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • TargetType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Favorites WHERE Id = 1

SELECT * FROM Favorites WHERE Id IN (1, 2)

SELECT * FROM Favorites WHERE Id >= 1

SELECT * FROM Favorites WHERE Id <= 1

SELECT * FROM Favorites WHERE Id > 1

SELECT * FROM Favorites WHERE Id < 2

SELECT * FROM Favorites WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Favorites WHERE TargetType = 'Prospect'

Columns

Name Type Description
Id [KEY] Integer Id of favorites.
CreatedAt Datetime The date and time the favorite was created.
TargetType String The type of record that was favorited.
UpdatedAt Datetime The date and time the favorite was last updated.
LinksSelf String Links self.
CreatorId Integer Creator Id.
CreatorType String Creator type.
UserId Integer User's Id.
UserType String User's type.
Type String Type.

Outreach Connector for CData Sync

MailAliases

Alternative email name for a mailbox.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM MailAliases WHERE Id = 1

SELECT * FROM MailAliases WHERE Id IN (1, 2)

SELECT * FROM MailAliases WHERE Id >= 1

SELECT * FROM MailAliases WHERE Id <= 1

SELECT * FROM MailAliases WHERE Id > 1

SELECT * FROM MailAliases WHERE Id < 2

SELECT * FROM MailAliases WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM MailAliases WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of mail alias.
CanSend Boolean Whether or not this alias can send email.
CreatedAt Datetime The date the alias was created.
Email String The email alias.
UpdatedAt Datetime The date the alias was last updated.
UserId Integer User's Id.
Type String Type.

Outreach Connector for CData Sync

Mailbox

Get details of email mailboxes.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Email supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • UserId supports the '=,IN,>=,<=,>,<' operator.
For example, the following query is processed server side:
SELECT * FROM Mailbox WHERE Id = 1

SELECT * FROM Mailbox WHERE Id IN (1, 2)

SELECT * FROM Mailbox WHERE Id >= 1

SELECT * FROM Mailbox WHERE Id <= 1

SELECT * FROM Mailbox WHERE Id > 1

SELECT * FROM Mailbox WHERE Id < 2

SELECT * FROM Mailbox WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailbox WHERE UserId = 1

Columns

Name Type Description
Id [KEY] Integer Id of mailbox.
AuthId Integer The Auth Id associated with the mailbox.
CreatedAt Datetime The date and time the mailbox was created.
Editable Boolean A boolean value to indicate if the user has the permission to edit mailbox fields.
Email String The email address of the mailbox.
EmailProvider String The mail service provider.
EmailSignature String The default signature in HTML to be appended to sent email messages.
EwsEndpoint String The url of the Exchange Web Service.
EwsSslVerifyMode Integer The SSL verify mode represented as an integer the EWS connection will used.
ExchangeVersion String The version of Exchange.
ImapHost String The address of the IMAP host used for syncing.
ImapPort Integer The port number the IMAP server is using.
ImapSsl Boolean A boolean value indicating whether or not the IMAP connection will use SSL.
MaxEmailsPerDay Integer The maximum number of in and out emails per day.
MaxMailingsPerDay Integer The maximum number of emails the application can send in a day from this mailbox.
MaxMailingsPerWeek Integer The maximum number of emails the application can send within a week from this mailbox.
OptOutMessage String The message displayed on the unsubscribe confirmation page seen after clicking the unsubscribe link in the email.
OptOutSignature String The message below the signature in HTML.
ProspectEmailExclusions String A list of email address patterns to be excluded from syncing.
ProviderId Integer The Id of the provider associated with this calendar.
ProviderType String Email provider type.
SendDisabled Boolean A boolean value indicating whether or not sending is disabled from this mailbox.
SendErroredAt Datetime The date and time the most recent send error occurred.
SendMaxRetries Integer The maximum number of times to auto-retry a delivery when it fails.
SendMethod String The method used for sending email.
SendPeriod Integer The amount of time in seconds that the number of sendThreshold emails can be sent.
SendPermanentErrorAt Datetime The date and time the most recent send error occurred.
SendRequiresSync Boolean A boolean value indicating whether or not the mailbox is required to be recently synced before sending.
SendSuccessAt Datetime The date and time the most recent successful email send occurred.
SendThreshold Integer The maximum number of email sends per the sendPeriod amount of time.
SmtpHost String The address of the SMTP host used for sending.
SmtpPort Integer The port number the SMTP server is using.
SmtpSsl Boolean A boolean value indicating whether or not the SMTP connection will use SSL.
SmtpUsername String The username for the SMTP account.
SyncActiveFrequency Integer The amount of time in seconds between syncing when the user is actively using the application.
SyncDisabled Boolean A boolean value indicating whether or not syncing is disabled from this mailbox.
SyncErroredAt Datetime The date and time the most recent sync error occurred.
SyncFinishedAt Datetime The date and time the most recent sync finished.
SyncMethod String The method used for syncing email.
SyncOutreachFolder Boolean A boolean value indicating whether or not the folder for syncing is named Outreach instead of Inbox.
SyncPassiveFrequency Integer The amount of time in seconds between syncing when the user is not actively using the application.
SyncSuccessAt Datetime The date and time the most recent successful email sync occurred.
UpdatedAt Datetime The date and time the mailbox was last updated.
CreatorId Integer Creator Id.
CreatorType String Creator type.
ownerId Integer Owner Id.
OwnerType String Owner type.
UserId Integer The Id of the user associated with this mailbox.
Username String The username of the email account.
Type String Type.

Outreach Connector for CData Sync

Mailings

Get details of mailings.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • BouncedAt supports the '=,>=,<=,>,<' operators.
  • ClickedAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DeliveredAt supports the '=,>=,<=,>,<' operators.
  • MailingType supports the '=,IN' operators.
  • MessageId supports the '=,IN' operators.
  • NotifyThreadScheduledAt supports the '=,>=,<=,>,<' operators.
  • NotifyThreadStatus supports the '=' operator.
  • OpenedAt supports the '=,>=,<=,>,<' operators.
  • RetryAt supports the '=,>=,<=,>,<' operators.
  • RepliedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • ScheduledAt supports the '=,>=,<=,>,<' operators.
  • State supports the '=' operator.
  • StateChangedAt supports the '=,>=,<=,>,<' operators.
  • UnsubscribedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Mailings WHERE Id = 1

SELECT * FROM Mailings WHERE Id IN (1, 2)

SELECT * FROM Mailings WHERE Id >= 1

SELECT * FROM Mailings WHERE Id <= 1

SELECT * FROM Mailings WHERE Id > 1

SELECT * FROM Mailings WHERE Id < 2

SELECT * FROM Mailings WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Mailings WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of mailing.
BodyHtml String The mailing custom email body represented in HTML.
BodyText String The plain-text representation of the bodyHTML field.
BouncedAt Datetime The date and time the email was bounced.
ClickCount Integer The total number of times links within the email were clicked.
ClickedAt Datetime The most recent date and time a link was clicked.
CreatedAt Datetime The date and time the mailing was created.
DeliveredAt Datetime The date and time the email was delivered.
ErrorBacktrace String Technical details explaining the mailing error.
ErrorReason String A summary explaining the mailing error.
FollowUpTaskScheduledAt Datetime The date and time of when a follow-up task should be due for this mailing.
FollowUpTaskType String The type of follow-up task to create.
MailboxAddress String The email address the mailing was sent from.
MailingType String A description of the type of the emailing.
MarkedAsSpamAt Datetime The date and time the email was marked as spam.
MessageId String The MIME content MessageId of the delivered message.
NotifyThreadCondition String The condition of when to bump this mailing to the top of the user inbox.
NotifyThreadScheduledAt Datetime The date and time of when this mailing should be bumped to the top of the user inbox.
NotifyThreadStatus String The status of the bump. Possible values are 'pending', 'sent', 'skipped', etc.
OpenCount Integer The total number of times the email was opened.
OpenedAt Datetime The most recent date and time the email was opened.
OverrideSafetySettings Boolean A boolean value indicating whether or not users can override submission if template variables have not all been replaced.
References String A list of references for the mailing taken from the email header.
RepliedAt Datetime The date and time the email was replied to.
RetryAt Datetime The date and time the email will retry to send.
RetryCount Integer The number of times the email has been retried to send.
RetryInterval Integer The amount of time in seconds between retry attempts.
ScheduledAt Datetime The date and time the email is scheduled to send.
State String The current state of the mailing. Possible values are 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', 'scheduled', etc.
StateChangedAt Datetime The date and time the state last changed.
Subject String The subject line of the email.
TrackLinks Boolean A boolean value indicating whether or not the mailing is tracking link clicks.
TrackOpens Boolean A boolean value indicating whether or not the mailing is tracking email opens.
UnsubscribedAt Datetime The date and time the recipient unsubscribed from the mailing sequence.
UpdatedAt Datetime The date and time the mailing was last updated.
LinksSelf String Links self.
MailboxId Integer Id of mailbox.
MailboxType String Mailbox type.
OpportunityId Integer Opportunity's Id.
ProspectId Integer Prospect's Id.
ProspectType String Prospect's type.
SequenceId Integer Sequence Id.
SequenceStateId Integer SequenceState Id.
SequenceStepId Integer SequenceStep Id.
TaskId Integer Task's Id.
Type String Type.

Outreach Connector for CData Sync

Opportunities

Get details of opportunities for sales or pending deals.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • ExternalCreatedAt supports the '=,>=,<=,>,<' operators.
  • MapLink supports the '=,IN' operators.
  • MapStatus supports the '=,IN' operators.
  • Name supports the '=,IN' operators.
  • Probability supports the '=,IN,>=,<=,>,<' operators.
  • SharingTeamId supports the '=,IN' operators.
  • TouchedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Opportunities WHERE Id = 1

SELECT * FROM Opportunities WHERE Id IN (1, 2)

SELECT * FROM Opportunities WHERE Id >= 1

SELECT * FROM Opportunities WHERE Id <= 1

SELECT * FROM Opportunities WHERE Id > 1

SELECT * FROM Opportunities WHERE Id < 2

SELECT * FROM Opportunities WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Opportunities WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of opportunities.
Amount Integer The amount the opportunity is worth..
CloseDate Datetime The date the opportunity is expected to close.
CreatedAt Datetime The date and time the mailing was created.
CurrencyType String The ISO code of the currency this opportunity is in.
Description String A description of the opportunity.
ExternalCreatedAt String he date the opportunity was created in the external system.
MapLink String A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.
MapNextSteps String The next event in the timeline that has yet to be completed for the SamePlan MAP.
MapStatus String The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.
Name String The name of the opportunity.
NextStep String The next step to take for the opportunity.
OpportunityType String The type of opportunity.
Probability Integer The chances of the opportunity succeeding represented as a percentage.
ProspectingRepId String The ID of the sales rep that prospects the opportunity.
SharingTeamId String The ID of the sharing team associated with this object. Access is currently in beta.
Tags String Tags associated with the opportunity.
TouchedAt Datetime The last time an event happened for an opportunity.
UpdatedAt Datetime The date the opportunity was last updated.
LinksSelf String Links Self.
AccountId Integer Account Id.
AccountType String Account type.
CreatorId Integer Creator Id.
CreatorDataType String Creator type.
OpportunityStageId Integer opportunityStage Id.
OpportunityStageType String OpportunityStage Type.
OwnerId Integer Owner Id.
OwnerType String Owner Type.
StageId Integer Stages Id.
StageType String Stages Type.
UpdaterId Integer Updater Id.
UpdaterType String Updater Type.
Type String Opportunities type.

Outreach Connector for CData Sync

OpportunityProspectRoles

Get details of prospect roles and associated with an opportunity.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Role supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM OpportunityProspectRoles WHERE Id = 1

SELECT * FROM OpportunityProspectRoles WHERE Id IN (1, 2)

SELECT * FROM OpportunityProspectRoles WHERE Id >= 1

SELECT * FROM OpportunityProspectRoles WHERE Id <= 1

SELECT * FROM OpportunityProspectRoles WHERE Id > 1

SELECT * FROM OpportunityProspectRoles WHERE Id < 2

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityProspectRoles WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of opportunity prospect role.
CreatedAt Datetime The date and time the role was created.
Primary Boolean A boolean value indicating if this prospect is the primary contact within an opportunity.
Role String A string value representing the role.
UpdatedAt Datetime The date and time the role was last updated.
ProspectId Integer Prospect's Id.
OpportunityId Integer Opportunity's Id.

Outreach Connector for CData Sync

OpportunityStages

The stage an opportunity is in.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • OrderValue supports the '=' operator.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM OpportunityStages WHERE Id = 1

SELECT * FROM OpportunityStages WHERE Id IN (1, 2)

SELECT * FROM OpportunityStages WHERE Id >= 1

SELECT * FROM OpportunityStages WHERE Id <= 1

SELECT * FROM OpportunityStages WHERE Id > 1

SELECT * FROM OpportunityStages WHERE Id < 2

SELECT * FROM OpportunityStages WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM OpportunityStages WHERE Name = 'Prospecting'

SELECT * FROM OpportunityStages WHERE OrderValue = 0

Columns

Name Type Description
Id [KEY] Integer Id of opportunity stage.
CreatedAt Datetime The date and time the opportunity stage was created.
Color String The color used to label and highlight the opportunity stage.
Name String The name of the opportunity stage.
OrderValue Integer The Order Value of the opportunity stage.
UpdatedAt Datetime The date and time the opportunity stage was last updated.
CreatorId Integer Creator Id.
OpportunityLinks String The opportunities currently associated with the opportunity stage.

Outreach Connector for CData Sync

Personas

A descriptor of a person used for categorizing prospects.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Personas WHERE Id = 1

SELECT * FROM Personas WHERE Id IN (1, 2)

SELECT * FROM Personas WHERE Id >= 1

SELECT * FROM Personas WHERE Id <= 1

SELECT * FROM Personas WHERE Id > 1

SELECT * FROM Personas WHERE Id < 2

SELECT * FROM Personas WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Personas WHERE Name = 'Prospecting'

SELECT * FROM Personas WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of persona.
CreatedAt Datetime The date and time the persona was created.
Description String A description of the persona.
Name String The name of the persona.
UpdatedAt Datetime The date and time the persona was last updated.
LinksSelf String Link self.
ProspectsLinks String The prospects with this persona.
Type String Type.

Outreach Connector for CData Sync

PhoneNumbers

Get details of prospect phone numbers.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • Number supports the '=,IN' operators.
  • Order supports the '=,>=,<=,>,<' operator.
  • PhoneType supports the '=' operator.
  • Status supports the '=' operator.
  • StatusChangedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM PhoneNumbers WHERE Id = 1

SELECT * FROM PhoneNumbers WHERE Id IN (1, 2)

SELECT * FROM PhoneNumbers WHERE Id >= 1

SELECT * FROM PhoneNumbers WHERE Id <= 1

SELECT * FROM PhoneNumbers WHERE Id > 1

SELECT * FROM PhoneNumbers WHERE Id < 2

SELECT * FROM PhoneNumbers WHERE StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-01-25 01:02:02.0 ' AND StatusChangedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt < '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE StatusChangedAt > '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE Number = '+919876543210'

SELECT * FROM PhoneNumbers WHERE UpdatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM PhoneNumbers WHERE PhoneType = 'work'

Columns

Name Type Description
Id [KEY] Integer Id of phone numbers.
CountryCode String The country code.
CreatedAt Datetime The date and time the phone number was created.
Extension String Phone number extension.
Number String The phone number.
OrderValue Integer Ordered position in list of numbers.
PhoneType String Type of phone. Possible values are 'mobile', 'work', 'home', 'voip', 'other', etc.
RawNumber String Unformatted phone number.
Status String The status of the number.
StatusChangedAt Datetime Time the status was updated.
UpdatedAt Datetime The date and time the phone number was last updated.
LinksSelf String Link self.
ProspectId Integer Prospect's Id.
ProspectType String Prospect type.
Type String Type.

Outreach Connector for CData Sync

Profiles

Controls what you can see and do within Outreach.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • SpecialId supports the '=,IN' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Profiles WHERE Id = 1

SELECT * FROM Profiles WHERE Id IN (1, 2)

SELECT * FROM Profiles WHERE Id >= 1

SELECT * FROM Profiles WHERE Id <= 1

SELECT * FROM Profiles WHERE Id > 1

SELECT * FROM Profiles WHERE Id < 2

SELECT * FROM Profiles WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Profiles WHERE Name = 'Admin'

SELECT * FROM Profiles WHERE Name IN ('Admin', 'Default')

SELECT * FROM Profiles WHERE SpecialId IN ('Admin', 'Default')

Columns

Name Type Description
Id [KEY] Integer Id of profile.
CreatedAt Datetime The date and time the team was created.
IsAdmin Boolean Flag that indicates whether the profile provides admin access.
Name String The name of the profile.
SpecialId String The special Id flag assigned to the profile.
UpdatedAt Datetime The date and time the team was last updated.
LinksSelf String Links self.
Type String type.

Outreach Connector for CData Sync

Prospects

Get details of prospects.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Emails supports the '=,IN' operators.
  • EngagedAt supports the '=,>=,<=,>,<' operators.
  • EngagedScore supports the '=,>=,<=,>,<' operators.
  • ExternalSource supports the '=,IN' operators.
  • FirstName supports the '=,IN' operators.
  • GithubUsername supports the '=,IN' operators.
  • LastName supports the '=,IN' operators.
  • LinkedInId supports the '=,IN' operators.
  • LinkedInSlug supports the '=,IN' operators.
  • SharingTeamId supports the '=,IN' operators.
  • StackOverflowId supports the '=,IN' operators.
  • TimeZone supports the '=,IN' operators.
  • Title supports the '=,IN' operators.
  • TouchedAt supports the '=,>=,<=,>,<' operators.
  • TwitterUsername supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Prospects WHERE Id = 1

SELECT * FROM Prospects WHERE Id IN (1, 2)

SELECT * FROM Prospects WHERE Id >= 1

SELECT * FROM Prospects WHERE Id <= 1

SELECT * FROM Prospects WHERE Id > 1

SELECT * FROM Prospects WHERE Id < 2

SELECT * FROM Prospects WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE EngagedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Prospects WHERE Emails = '[email protected]'

SELECT * FROM Prospects WHERE FirstName = 'test'

SELECT * FROM Prospects WHERE LastName = 'test'

Columns

Name Type Description
Id [KEY] Integer Id of Prospects.
AccountName String Name of prospects.
AddedAt String The date and time the prospect was added to any system.
AddressCity String The prospects city.
AddressCountry String The prospects country.
AddressState String The prospects state.
AddressStreet String The prospects street address.
AddressStreet2 String The prospects second street address.
AddressZip String The prospects postal code.
AngelListUrl String The prospects AngelList URL.
AvailableAt String The date and time the prospect is available to contact again.
CallOptedOut Boolean Whether the prospect is opted out of calling or opted out in general if granular opt-out is not enabled.
CallsOptedAt String A string that represents whether a prospect has opted into or out of calls.
CallsOptStatus String The date and time the prospect opted in out of calls.
CampaignName String The name of the campaign the prospect is associated with.
ClickCount Integer The number of clicks the prospect has made since the last touch point.
Company String The name of the company the prospect works at If associated with an account this is the name of the account.
CompanyFollowers String The company Follwers.
CompanyFoundedAt String The date and time when company founded at.
CompanyIndustry String company Industry.
CompanyLinkedIn String company LinkedIn.
CompanyLinkedInEmployees String companyLinkedIn Employees.
CompanyLocality String company Locality.
CompanyNatural String company Natural.
CompanySize String company Size.
CompanyStartDate String company StartDate.
CompanyType String company Type.
ContactHistogram String The last 12 months of email contact history with the prospect with the current month being the last element.
CreatedAt Datetime The date and time the prospect was created.
DateOfBirth String The date the prospect was born.
Degree String The degrees the prospect has received.
EmailOptedOut Boolean Whether the prospect is opted out of email or opted out in general if granular opt-out is not enabled.
Emails String A list of email addresses associated with the prospect.
EmailsOptedAt String he date and time the prospect opted in out of emails.
EmailsOptStatus String The date and time the prospect opted in out of emails.
EngagedAt Datetime The date and time the prospect last engaged.
EngagedScore Double A number representing the quality of the lead based on the number of the prospects opens ,clicks and mailing replies.
EventName String The name of the event the prospect was met at.
ExternalId String A custom ID for the prospect often referencing an ID in an external system.
ExternalOwner String A custom owner for the prospect often referencing an ownering in an external system.
ExternalSource String The source of the resources creation.
FacebookUrl String The prospects Facebook URL.
FirstName String The first name of the prospect.
Gender String The gender of the prospect.
GithubUrl String The prospects GitHub URL.
GithubUsername String The prospects GitHub username.
GooglePlusUrl String The prospects Google+ URL..
GraduationDate String The graduation date of the prospect.
HomePhones String A list of home phone numbers associated with the prospect.
JobStartDate String The starting date of the prospects current job.
LastName String The last name of the prospect.
LinkedInConnections String The number of connections on the prospects LinkedIn profile.
LinkedInId String The prospects LinkedIn ID.
LinkedInSlug String The prospects LinkedIn slug.
LinkedInUrl String The prospects LinkedIn URL.
MiddleName String The middle name of the prospect.
MobilePhones String A list of mobile phone numbers associated with the prospect.
Name String The full name of the prospect.
Nickname String The nickname of the prospect.
Occupation String The occupation of the prospect.
OpenCount Integer The number of opens the prospect has made since the last touch point.
OptedOut Boolean A boolean value representing whether this prospect is currently opted out of all mailings.
OptedOutAt String The date and time the prospect opted out of emails.
OtherPhones String A list of other phone numbers associated with the prospect.
PersonalNote1 String A note field related to the prospect.
PersonalNote2 String A second note field related to the prospect.
PreferredContact String The preferred contact method for the prospect.
QuoraUrl String The prospects Quora URL.
Region String The primary geographic region of the prospect.
ReplyCount Integer The number of replies the prospect has made since the last touch point.
School String The schools the prospect has attended.
Score String A custom score given to measure the quality of the lead.
SharingTeamId String The ID of the sharing team associated with this object.
Source String A custom source representing where the lead was first acquired..
Specialties String description of the prospects specialties.
StackOverflowId String The prospects StackOverflow ID.
StackOverflowUrl String The prospects StackOverflow URL.
StageName String Stage Name.
Tags String A list of tag values associated with the account.
TimeZone String The prospects current timezone preferably in the IANA format.
TimeZoneIana String The prospects current IANA timezone if available.
TimeZoneInferred String The prospects current inferred IANA timezone if available.
Title String The title of the prospect.
TouchedAt Datetime The date and time the prospect was last touched.
TrashedAt String The date a prospect was soft deleted.
TwitterUrl String The prospects Twitter URL.
TwitterUsername String The prospects Twitter username.
UpdatedAt Datetime The date and time the prospect was last updated.
VoipPhones String A list of voip phone numbers associated with the prospect.
WebsiteUrl1 String The URL of the prospects website.
WebsiteUrl2 String The value of the prospects second website URL field.
WebsiteUrl3 String The value of the prospects third website URL field.
WorkPhones String A list of work phone numbers associated with the prospect.
LinksSelf String Link Self.
AccountId Integer Account Id.
AccountType String Account Type.
BatchesLinks String Batches Links.
CallsLinks String Calls Link.
CreatorId Integer Creator Id.
CreatorType String Creator Type.
TasksLinks String task links releated.
OwnerId Integer Owner Id.
OwnerType String Owner Type.
SequenceStatesLinks String SequenceStates Links.
UpdaterId Integer Updater Id.
UpdaterType String Updater Type.
Type String Type.

Outreach Connector for CData Sync

Recipients

Record for a recipient for some communication, such as email.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Recipients WHERE Id = 1

SELECT * FROM Recipients WHERE Id IN (1, 2)

SELECT * FROM Recipients WHERE Id >= 1

SELECT * FROM Recipients WHERE Id <= 1

SELECT * FROM Recipients WHERE Id > 1

SELECT * FROM Recipients WHERE Id < 2

Columns

Name Type Description
Id [KEY] Integer Id of Recipient.
CreatedAt Datetime The date and time the team was created.
EmailHash String Hash of email for recipient.
RecipientType String The type of action for the communcation to the recipient.
UpdatedAt Datetime The date and time the team was last updated.
Value String The recipient contact information.
LinksSelf String Link self.
Type String Type.

Outreach Connector for CData Sync

Roles

Get details of where you fall within your organizations structure.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Roles WHERE Id = 1

SELECT * FROM Roles WHERE Id IN (1, 2)

SELECT * FROM Roles WHERE Id >= 1

SELECT * FROM Roles WHERE Id <= 1

SELECT * FROM Roles WHERE Id > 1

SELECT * FROM Roles WHERE Id < 2

SELECT * FROM Roles WHERE Name = 'test'

Columns

Name Type Description
Id [KEY] Integer Id of roles.
CreatedAt Datetime The date and time the team was created.
Name String The name of the role.
UpdatedAt Datetime The date and time the team was last updated.
LinksSelf String Link self.
ParentRoleLinks String Parent role links.
Type String Type.

Outreach Connector for CData Sync

Rulesets

A reusable set of behaviors to be applied to sequences.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • AutoResumeOotoProspects supports the '=' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • IncludeUnsubscribeLinks supports the '=' operator.
  • Name supports the '=,IN' operators.
  • PermitDuplicateProspects supports the '=,IN' operators.
  • SequenceExclusivity supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Rulesets WHERE Id = 1

SELECT * FROM Rulesets WHERE Id IN (1, 2)

SELECT * FROM Rulesets WHERE Id >= 1

SELECT * FROM Rulesets WHERE Id <= 1

SELECT * FROM Rulesets WHERE Id > 1

SELECT * FROM Rulesets WHERE Id < 2

SELECT * FROM Rulesets WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Rulesets WHERE AutoResumeOotoProspects = 'false'

SELECT * FROM Rulesets WHERE PermitDuplicateProspects = 'disallow'

SELECT * FROM Rulesets WHERE SequenceExclusivity = 'none'

Columns

Name Type Description
Id [KEY] Integer Id of ruleset.
ApplyCompletedStageIn Integer The amount of time in seconds after the sequence has completed before the completedStage will be applied to the Prospect.
AutoResumeOotoProspects Boolean A boolean value indicating whether or not out-of-the-office Prospects will be automatically resumed.
AutoResumeOotoProspectsExpiresIn Integer The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.
AutoResumeOotoProspectsIn Integer The default amount of time in seconds to wait before opted-out Prospects will be resumed.
CallOptOutAction String Determines if prospect can be added to sequences if they are opted out of calling.
ClicksNeededBeforeCallTaskCreated Integer The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.
CreatedAt Datetime The date and time the ruleset was created.
EmailOptOutAction String Determines if prospect can be added to sequences if they are opted out of emails.
IncludeUnsubscribeLinks Boolean A boolean value specifying whether or not to include unsubscribe links within emails.
MeetingBookedAction String Determines if a prospect is marked as finished when a meeting is booked.
MinimumProspectTouchedInterval Integer The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequence.
Name String The name of the ruleset.
OotoAutoExtractionEnabled Boolean A boolean value determining whether to use out of the office return date auto extraction.
OpensNeededBeforeCallTaskCreated Integer The number of email opens needed before a call task will be automatically created.
PermitDuplicateProspects String A value determining whether a Prospect may be added to this Sequence multiple times or not. Possible values are 'allow', 'disallow', 'only_if_inactive', etc.
SequenceExclusivity String A value determining whether Prospects may be added to multiple different Sequences. Possible values are 'all_sequences', 'exclusive_sequences', 'none', etc.
SmsOptOutAction String Determines if prospect can be added to sequences if they are opted out of SMS.
SmsReceivedAction String Determines if a prospect is marked as finished when a text message is received.
StepOverridesEnabled Boolean A boolean value determining whether to allow users to customize step templates when adding to sequence.
OwnerId Integer Owner Id.
SequenceStatesLinks String Sequence states links.
UpdatedAt Datetime The date and time the ruleset was last updated.
LinksSelf String Link self.
Type String Type.

Outreach Connector for CData Sync

Sequences

Get details of sequences.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • ClickCount supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DeliverCount supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • EnabledAt supports the '=,>=,<=,>,<' operators.
  • LastUsedAt supports the '=,>=,<=,>,<' operators.
  • LockedAt supports the '=,>=,<=,>,<' operators.
  • OpenCount supports the '=,>=,<=,>,<' operators.
  • ReplyCount supports the '=,>=,<=,>,<' operators.
  • ThrottleCapacity supports the '=,>=,<=,>,<' operators.
  • ThrottleMaxAddsPerDay supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • ShareType supports the '=' operator.
For example, the following query is processed server side:
SELECT * FROM Sequences WHERE Id = 1

SELECT * FROM Sequences WHERE Id IN (1, 2)

SELECT * FROM Sequences WHERE Id >= 1

SELECT * FROM Sequences WHERE Id <= 1

SELECT * FROM Sequences WHERE Id > 1

SELECT * FROM Sequences WHERE Id < 2

SELECT * FROM Sequences WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Sequences WHERE DeliverCount = 0

SELECT * FROM Sequences WHERE Name = 'test'

SELECT * FROM Sequences WHERE ThrottleMaxAddsPerDay = 1

SELECT * FROM Sequences WHERE ShareType = 'private'

Columns

Name Type Description
Id [KEY] Integer Id of sequence template.
AutomationPercentage Double The percentage of auto_email sequence steps in this sequence.
BounceCount Integer The total count of bounced mailings during this sequence.
ClickCount Integer The total count of clicked mailings from this sequence.
CreatedAt Datetime The date and time the sequence was created.
DeliverCount Integer The total count of delivered mailings from this sequence.
Description String A custom description for the sequence.
DurationInDays Integer The total number of days it takes to get through this sequence.
Enabled Boolean A boolean value determining whether the sequence is enabled or not.
EnabledAt Datetime The date and time the sequence was enabled or null if currently disabled.
FailureCount Integer The total count of failed mailings from this sequence.
LastUsedAt Datetime The date and time the sequence was last used.
Locked Boolean A boolean value determining whether the sequence is locked or not.
LockedAt Datetime The date and time the sequence was locked or null if currently unlocked.
MaxActivations Integer The maximum number of prospects that can be associated with the sequence.
Name String The name or the sequence.
NegativeReplyCount Integer The total count of negative reply mailings from this sequence.
NeutralReplyCount Integer The total count of neutral reply mailings from this sequence.
NumContactedProspects Integer The total count of prospects who have been either called or emailed.
NumRepliedProspects Integer The total count of prospects who have been marked as replied.
OpenCount Integer The total count of opened mailings from this sequence.
OptOutCount Integer The total count of opted out mailings from this sequence.
PositiveReplyCount Integer The total count of positive reply mailings from this sequence.
PrimaryReplyAction String The action to take when the primary prospect replies.

使用できる値は次のとおりです。finish, continue, pause

PrimaryReplyPauseDuration Integer The duration in seconds to pause for before automatically finishing after a reply from the primary prospect if the primaryReplyAction is pause.
ReplyCount Integer The total count of replied mailings from this sequence.
ScheduleCount Integer The total count of scheduled mailings from this sequence.
ScheduleIntervalType String The schedule interval type.
SecondaryReplyAction String The action to take when someone other than the primary prospect replies.

使用できる値は次のとおりです。finish, continue, pause

SecondaryReplyPauseDuration Integer The duration in seconds to pause for before automatically finishing after a reply from anyone other than the primary prospect if the secondaryReplyAction is pause.
SequenceStepCount Integer The total number of sequence steps in this sequence.
SequenceType String The sequence type must be either date or interval.

使用できる値は次のとおりです。date, interval

ShareType String The sequence share type. Possible values are 'private', 'read_only', 'shared', etc.
Tags String A list of tag values associated with the sequence.
ThrottleCapacity Integer The maximum number of associated sequence states per user that can be active at a one time.
ThrottleMaxAddsPerDay Integer The maximum number of associated sequence states per user that can be added to the sequence each day.
ThrottlePaused Boolean A boolean value determining whether the throttling of sequence states is paused or not.
ThrottlePausedAt Datetime The date and time the sequence state throttling was paused or null if not currently paused.
Transactional Boolean A boolean value determining whether prospect opt out preferences are respected.
UpdatedAt Datetime The date and time the sequence was last updated.
LinksSelf String Link self.
CreatorId Integer Creator Id.
OwnerId Integer Owner Id.
SequenceStatesLinks String Sequence states links.
UpdaterId Integer Updater Id.
RulesetId Integer Ruleset Id.
Type String Type.

Outreach Connector for CData Sync

SequenceStates

Get details of sequence states.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • ClickCount supports the '=,IN,>=,<=,>,<' operators.
  • CallCompletedAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DeliverCount supports the '=,IN,>=,<=,>,<' operators.
  • OpenCount supports the '=,IN,>=,<=,>,<' operators.
  • PauseReason supports the '=,IN' operators.
  • RepliedAt supports the '=,>=,<=,>,<' operators.
  • ReplyCount supports the '=,IN,>=,<=,>,<' operators.
  • State supports the '=' operator.
  • StateChangedAt supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM SequenceStates WHERE Id = 1

SELECT * FROM SequenceStates WHERE Id IN (1, 2)

SELECT * FROM SequenceStates WHERE Id >= 1

SELECT * FROM SequenceStates WHERE Id <= 1

SELECT * FROM SequenceStates WHERE Id > 1

SELECT * FROM SequenceStates WHERE Id < 2

SELECT * FROM SequenceStates WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE UpdatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceStates WHERE DeliverCount = 0

SELECT * FROM SequenceStates WHERE Name = 'test'

Columns

Name Type Description
Id [KEY] Integer Id of sequence state.
ActiveAt Datetime The date and time the sequence state was last active.
BounceCount Integer The total count of bounced mailings during this sequence state.
CallCompletedAt Datetime The date and time the sequence state last had a call completed.
ClickCount Integer The total count of clicked mailings from this sequence state.
CreatedAt Datetime The date and time the sequence state was created.
DeliverCount Integer The total count of delivered mailings from this sequence state.
ErrorReason String The reason for the most recent error.
FailureCount Integer The total count of failed mailings from this sequence state.
NegativeReplyCount Integer The total count of negative reply mailings from this sequence state.
NeutralReplyCount Integer The total count of neutral reply mailings from this sequence state.
OpenCount Integer The total count of opened mailings from this sequence state.
OptOutCount Integer The total count of opted out mailings from this sequence state.
PauseReason String The reason for the most recent pause.
PositiveReplyCount Integer The total count of positive reply mailings from this sequence state.
RepliedAt Datetime The date and time the sequence state last had a mailing reply.
ReplyCount Integer The total count of replied mailings from this sequence state.
ScheduleCount Integer The total count of scheduled mailings from this sequence state.
State String The current state of the sequence state.
StateChangedAt Datetime The date and time the sequence state's state last changed.
UpdatedAt Datetime The date and time the sequence state was last updated.
LinksSelf String Link self.
AccountId Integer Account Id.
AccountType String Account type.
CreatorId Integer Creator Id.
CreatorType String Creator type.
MailboxId Integer Mailbox Id.
MailboxType String MailBox type.
ProspectId Integer Prospect Id.
ProspectType String Prospect type.
SequenceId Integer Sequence Id.
SequenceType String Sequence type.
SequenceStepId Integer Sequence step's Id.
SequenceStepType String Sequence step's type.
Type String Type.

Outreach Connector for CData Sync

SequenceSteps

Get details of sequence steps.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • OrderValue supports the '=,IN,>=,<=,>,<' operators.
  • StepType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM SequenceSteps WHERE Id = 1

SELECT * FROM SequenceSteps WHERE Id IN (1, 2)

SELECT * FROM SequenceSteps WHERE Id >= 1

SELECT * FROM SequenceSteps WHERE Id <= 1

SELECT * FROM SequenceSteps WHERE Id > 1

SELECT * FROM SequenceSteps WHERE Id < 2

SELECT * FROM SequenceSteps WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM SequenceSteps WHERE StepType = 'task'

SELECT * FROM Stages WHERE OrderValue > 3 AND OrderValue < 7

Columns

Name Type Description
Id [KEY] Integer Id of sequence step.
BounceCount Integer The total count of bounced mailings during this sequence step.
ClickCount Integer The total count of clicked mailings from this sequence step.
CreatedAt Datetime The date and time the sequence step was created.
Date Datetime The date this step will activate.
DeliverCount Integer The total count of delivered mailings from this sequence step.
DisplayName String A human-readable display name that captures the steps type and OrderValue.
FailureCount Integer The total count of failed mailings from this sequence step.
Interval Integer The interval in minutes.
NegativeReplyCount Integer The total count of negative reply mailings from this sequence step.
NeutralReplyCount Integer The total count of neutral reply mailings from this sequence step.
OpenCount Integer The total count of opened mailings from this sequence step.
OptOutCount Integer The total count of opted out mailings from this sequence step.
OrderValue Integer The steps display Order value within its sequence.
PositiveReplyCount Integer The total count of positive reply mailings from this sequence step.
ReplyCount Integer The total count of replied mailings from this sequence step.
ScheduleCount Integer The total count of scheduled mailings from this sequence step.
StepType String The steps type. Possible values are 'auto_email', 'manual_email', 'call', 'task', etc.
TaskAutoskipDelay Integer The optional interval in seconds from when tasks created by this sequence step are overdue until they are automatically skipped.
TaskNote String An optional note to associate with created tasks.
UpdatedAt Datetime The date and time the sequence step was last updated.
LinksSelf String Link self.
CreatorId Integer Creator Id.
CreatorType String Creator type.
SequenceId Integer Sequence Id.
SequenceType String Sequence type.
TaskPriorityId Integer Task priority Id.
TaskPriorityType String Task priority type.
UpdaterId Integer Updater Id.
UpdaterType String Updater type.
Type String Type.

Outreach Connector for CData Sync

SequenceTemplates

An object used to track which templates are in use by which sequence steps.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM SequenceTemplates WHERE Id = 1

SELECT * FROM SequenceTemplates WHERE Id IN (1, 2)

SELECT * FROM SequenceTemplates WHERE Id >= 1

SELECT * FROM SequenceTemplates WHERE Id <= 1

SELECT * FROM SequenceTemplates WHERE Id > 1

SELECT * FROM SequenceTemplates WHERE Id < 2

Columns

Name Type Description
Id [KEY] Integer Id of sequence template.
BounceCount Integer The total count of bounced mailings during this sequence template.
ClickCount Integer The total count of clicked mailings from this sequence template.
CreatedAt Datetime The date and time the sequence template was created.
DeliverCount Integer The total count of delivered mailings from this sequence template.
Enabled Boolean Boolean indicating if the sequence template is currently enabled.
EnabledAt Datetime Datetime for when the sequence template was enabled.
FailureCount Integer The total count of failed mailings from this sequence template.
IsReply Boolean Boolean indicating if the sequence template should be a reply email or a new thread.
NegativeReplyCount Integer The total count of negative reply mailings from this sequence template.
NeutralReplyCount Integer The total count of neutral reply mailings from this sequence template.
OpenCount Integer The total count of opened mailings from this sequence template.
OptOutCount Integer The total count of opted out mailings from this sequence template.
PositiveReplyCount Integer The total count of positive reply mailings from this sequence template.
ReplyCount Integer The total count of replied mailings from this sequence template.
ScheduleCount Integer The total count of scheduled mailings from this sequence template.
UpdatedAt Datetime The date and time the sequence template was last updated.
LinksSelf String Link self.
SequenceStepId Integer Sequence step Id.
SequenceStepType String Sequence step type.
TemplateId Integer Template Id.
TemplateType String Template type.
Type String Type.

Outreach Connector for CData Sync

Snippets

Piece of an email to be reused in multiple messages.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • ShareType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Snippets WHERE Id = 1

SELECT * FROM Snippets WHERE Id IN (1, 2)

SELECT * FROM Snippets WHERE Id >= 1

SELECT * FROM Snippets WHERE Id <= 1

SELECT * FROM Snippets WHERE Id > 1

SELECT * FROM Snippets WHERE Id < 2

SELECT * FROM Snippets WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt >= '2022-01-25 01:02:02.0' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE ShareType = 'private'

SELECT * FROM Snippets WHERE Name = 'test'

SELECT * FROM Snippets WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Snippets WHERE UpdatedAt < '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of sequence snippet.
BodyHtml String The HTML of the snippet.
BodyText String The text of the snippet.
ContainsCustomHtml Boolean Contains Custom HTML.
CreatedAt Datetime The date and time the snippet was created.
Name String The name of the snippet.
ShareType String The permissions for sharing the snippet. Possible values are 'private', 'shared', etc.
Tags String A list of tags associated with the snippet.
UpdatedAt Datetime The date and time the snippet was last updated.
LinksSelf String Link self.
ContentCategoryMembershipsLinks String Content category memberships links.
CreatorId Integer Creator Id.
CreatorType String Creator type.
FavoritesLinks String Favorites links.
OwnerId Integer Owner Id.
OwnerType String Owner type.
UpdaterId Integer Updater Id.
UpdaterType String Updater type.
Type String Type.

Outreach Connector for CData Sync

Stages

The point in the process used for categorizing prospects.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • Order supports the '=,IN,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Stages WHERE Id = 1

SELECT * FROM Stages WHERE Id IN (1, 2)

SELECT * FROM Stages WHERE Id >= 1

SELECT * FROM Stages WHERE Id <= 1

SELECT * FROM Stages WHERE Id > 1

SELECT * FROM Stages WHERE Id < 2

SELECT * FROM Stages WHERE Name IN ('Interested', 'Replied')

SELECT * FROM Stages WHERE OrderValue > 3 AND OrderValue < 7

SELECT * FROM Stages WHERE OrderValue IN (3, 5, 7)

Columns

Name Type Description
Id [KEY] Integer Id of Stage.
Color String The color the stage label will be highlighted in the interface, specified as a hexidecimal value.
CreatedAt Datetime The date and time the stage was created.
Name String The name of the stage.
OrderValue Integer The stages display order value within the collection.
UpdatedAt Datetime The date and time the stage was last updated.
LinksSelf String Link self.
CreatorId Integer Creator Id.
UpdaterId Integer Updater Id.
ProspectsLinks String The prospects associated to the stage.
UpdaterData String The most recent updater of the stage.
Type String Type.

Outreach Connector for CData Sync

TaskPriorities

Descriptor of importance used for categorizing tasks.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • Weight supports the '=,>=,<=,>,<' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM TaskPriorities WHERE Id = 1

SELECT * FROM TaskPriorities WHERE Id IN (1, 2)

SELECT * FROM TaskPriorities WHERE Id >= 1

SELECT * FROM TaskPriorities WHERE Id <= 1

SELECT * FROM TaskPriorities WHERE Id > 1

SELECT * FROM TaskPriorities WHERE Id < 2

SELECT * FROM TaskPriorities WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE Name = 'test'

SELECT * FROM TaskPriorities WHERE Weight > 10

SELECT * FROM TaskPriorities WHERE Weight = 10

SELECT * FROM TaskPriorities WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM TaskPriorities WHERE UpdatedAt < '2022-02-25 01:02:02.0'

Columns

Name Type Description
Id [KEY] Integer Id of task priority.
Color Long The color the task priority label will be highlighted in the interface specified as a hexadecimal value.
CreatedAt Datetime The date and time the task priority was created.
Name String The name of the task priority.
UpdatedAt Datetime The date and time the task priority was last updated.
Weight Integer A relative value used for display order value task priorities are listed from lowest to highest weight.
LinksSelf String Links self.
SequenceStepsLinks String The associated sequence steps.
TasksLinks String The associated tasks.
Type String Type.

Outreach Connector for CData Sync

Tasks

An item that requires action to complete.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • AutoskipAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DueAt supports the '=,>=,<=,>,<' operators.
  • ScheduledAt supports the '=,>=,<=,>,<' operators.
  • State supports the '=,IN' operators.
  • StateChangedAt supports the '=,>=,<=,>,<' operators.
  • TaskType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Tasks WHERE Id = 1

SELECT * FROM Tasks WHERE Id IN (1, 2)

SELECT * FROM Tasks WHERE Id >= 1

SELECT * FROM Tasks WHERE Id <= 1

SELECT * FROM Tasks WHERE Id > 1

SELECT * FROM Tasks WHERE Id < 2

SELECT * FROM Tasks WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE AutoskipAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE DueAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE ScheduledAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE StateChangedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Tasks WHERE TaskType = 'follow_up'

SELECT * FROM Tasks WHERE State = 'incomplete'

Columns

Name Type Description
Id [KEY] Integer Id of Task.
Action String The action type of the task.
AutoskipAt Datetime The optional date and time when the task will automatically be skipped.
CompiledSequenceTemplateHtml String The compiled template HTML of incomplete SMS or LinkedIn tasks associated with a sequence.
Completed Boolean A boolean value indicating whether or not the task has been completed.
CompletedAt Datetime The date and time the task was completed.
CreatedAt Datetime The date and time the task was created.
DueAt Datetime The date and time the task is due.
Note String An optional note for the task.
OpportunityAssociation String The optional opportunity rule associated with the task.
ScheduledAt Datetime The date and time the pending task is scheduled for.
State String The current state of the task. Possible values are 'pending', 'incomplete', 'complete', etc.
StateChangedAt Datetime The date and time the state last changed.
TaskType String The type of task. Possible values are 'follow_up', 'manual', 'no_reply', 'sequence_open', 'sequence_click', 'sequence_step_call', 'sequence_step_email', 'sequence_step_linkedin_interact_with_post', 'sequence_step_linkedin_other', 'sequence_step_linkedin_send_connection_request', 'sequence_step_linkedin_send_message', 'sequence_step_linkedin_view_profile', 'sequence_step_sms', 'sequence_step_task', 'touch', etc.
UpdatedAt Datetime The date and time the task was last updated.
LinksSelf String Links self.
OwnerId Integer Owner Id.
OwnerType String Owner type.
ProspectId Integer Prospect Id.
ProspectType String Prospect's type.
ProspectAccountId Integer Prospect's account owner Id.
ProspectAccountType String Prospect's account type.
ProspectContactsData String Prospect's contacts.
ProspectContactsLinks String Prospect's contacts links.
ProspectContactsMetaCount Integer Prospect's meta count.
ProspectOwnerId Integer Prospect's owner Id.
ProspectOwnerType String Prospect's owner type.
ProspectPhoneNumbersData String Prospect's phone numbers.
ProspectPhoneNumbersLinks String Prospect's phone numbers links.
ProspectStageData String Prospect's stage.
SequenceId Integer The associated sequence Id.
SequenceType String The associated sequence type.
SequenceStateId Integer The associated sequence state Id.
SequenceStateType String The associated sequence state type.
SequenceStepId Integer The associated sequence step Id.
SequenceStepType String The associated sequence step type.
TaskPriorityId Integer The associated task priority Id.
TaskPriorityType String The associated task priority type.
TemplateId Integer The associated template Id.
Type String Types.

Outreach Connector for CData Sync

Teams

Get details of a group of users.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Teams WHERE Id = 1

SELECT * FROM Teams WHERE Id IN (1, 2)

SELECT * FROM Teams WHERE Id >= 1

SELECT * FROM Teams WHERE Id <= 1

SELECT * FROM Teams WHERE Id > 1

SELECT * FROM Teams WHERE Id < 2

SELECT * FROM Teams WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Teams WHERE Name = 'test'

Columns

Name Type Description
Id [KEY] Integer Id of team.
Color String The color used to label and highlight the team.
CreatedAt Datetime The date and time the task was created.
Name String The name of the team.
ScimExternalId String The ID from the SCIM provisioning service used to create the team.
ScimSource String The name of the SCIM provisioning source used to create the team.
UpdatedAt Datetime The date and time the team was last updated.
LinksSelf String Link self.
ContentCategoriesId Integer The content categories that are assigned to the team.
ContentCategoriesLinks String The content categories links Id.
CreatorId Integer The creator Id.
CreatorType String Creator type.
UpdaterId Integer The most recent updater Id.
UpdaterType String The most recent updater type.
UsersId Integer User data.
UsersLinks String User links.
Type String Type.

Outreach Connector for CData Sync

Templates

Get details of reusable templates for building emails.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • ArchivedAt supports the '=,>=,<=,>,<' operators.
  • ClickCount supports the '=,IN,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • DeliverCount supports the '=,IN,>=,<=,>,<' operators.
  • LastUsedAt supports the '=,>=,<=,>,<' operators.
  • Name supports the '=,IN' operators.
  • OpenCount supports the '=,IN,>=,<=,>,<' operators.
  • ReplyCount supports the '=,IN,>=,<=,>,<' operators.
  • ShareType supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
For example, the following query is processed server side:
SELECT * FROM Templates WHERE Id = 1

SELECT * FROM Templates WHERE Id IN (1, 2)

SELECT * FROM Templates WHERE Id >= 1

SELECT * FROM Templates WHERE Id <= 1

SELECT * FROM Templates WHERE Id > 1

SELECT * FROM Templates WHERE Id < 2

SELECT * FROM Templates WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Templates WHERE Name = 'test'

SELECT * FROM Templates WHERE ShareType = 'read_only'

Columns

Name Type Description
Id [KEY] Integer Id of Template.
Archived Boolean Boolean value indicating if the template has been archived.
ArchivedAt Datetime The date and time the template was archived.
BccRecipients String A list of default person and email address pairs to receive this template in the bcc field.
BodyHtml String The body HTML of the template.
BodyText String The body text of the template.
BounceCount Integer The total count of bounced mailings during this template.
CcRecipients String A list of default person and email address pairs to receive this template in the cc field.
ClickCount Integer The total count of clicked mailings from this template.
ClonedFromId String Cloned from Id.
ContainsCustomHtml Boolean Boolean value indicating if the template contains custom HTML.
CreatedAt Datetime The date and time the template was created.
DeliverCount Integer The total count of delivered mailings from this template.
FailureCount Integer The total count of failed mailings from this template.
LastUsedAt Datetime The last time the template was used.
Name String The name of the template.
NegativeReplyCount Integer The total count of negative reply mailings from this template.
NeutralReplyCount Integer The total count of neutral reply mailings from this template.
OpenCount Integer The total count of opened mailings from this template.
OptOutCount Integer The total count of opted out mailings from this template.
PositiveReplyCount Integer The total count of positive reply mailings from this template.
ReplyCount Integer The total count of replied mailings from this template.
ScheduleCount Integer The total count of scheduled mailings from this template.
ShareType String The share type must be one of. Possible values are 'read_only', 'private', 'shared', etc.
Subject String The subject line for the email to be sent.
Tags String A list of tag values associated with the template.
ToRecipients String A list of default person and email address pairs to receive this template in the To field.
TrackLinks Boolean Boolean value indicating if link tracking is enabled for the template.
TrackOpens Boolean Boolean value indicating if open tracking is enabled for the template.
UpdatedAt Datetime The date and time the template was last updated.
LinksSelf String Links self.
ContentCategoryMembershipsId Integer Content category memberships Id.
ContentCategoryMembershipsLinks String Content category memberships links.
CreatorId Integer The creator Id of the template.
CreatorType String The creator type of the template.
OwnerId Integer The Owner Id of the template.
OwnerType String The Owner type of the template.
RecipientsId Integer The Recipients Id.
RecipientsLinks String The Recipients links.
UpdaterId Integer The Updater Id of the template.
UpdaterType String The Updater type of the template.
Type String Type.

Outreach Connector for CData Sync

Users

Get details of the individual that uses the application.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,IN,>=,<=,>,<' operators.
  • CurrentSignInAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Email supports the '=,IN' operators.
  • FirstName supports the '=,IN' operators.
  • LastName supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • UserName supports the '=,IN' operators.
For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = 1

SELECT * FROM Users WHERE Id IN (1, 2)

SELECT * FROM Users WHERE Id >= 1

SELECT * FROM Users WHERE Id <= 1

SELECT * FROM Users WHERE Id > 1

SELECT * FROM Users WHERE Id < 2

SELECT * FROM Users WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND createdAt <= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE CurrentSignInAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM Users WHERE Email = '[email protected]'

SELECT * FROM Users WHERE FirstName = 'test'

SELECT * FROM Users WHERE LastName = 'test'

Columns

Name Type Description
Id [KEY] Integer Id of Users.
AccountsViewId String The default smart view to load on the account index view.
ActivityNotificationsDisabled Boolean A boolean value whether the users activity notifications are disabled.
BounceWarningEmailEnabled Boolean A boolean value whether the users bounce warning emails are enabled.
BridgePhone String The telephone number of the users outbound bridge phone.
BridgePhoneExtension String The extension number of the users outbound bridge phone.
CallsViewId String The default smart view to load on the calls view.
ControlledTabDefault String The users preferred default tab to open when in task flow.
CreatedAt Datetime The date and time the user was created.
CurrentSignInAt Datetime The date and time the user most recently signed in.
DailyDigestEmailEnabled Boolean A boolean value whether the users daily digest emails are enabled.
DefaultRulesetId Integer The id of the default ruleset assigned to the user.
Duties String A collection of the users work roles.
DutiesSetAt Datetime The date and time the DutiesSetAt..
Email String The email address of the user.
EnableVoiceRecordings Boolean A boolean value whether the user has voice recordings enabled.
EngagementEmailsEnabled Boolean A boolean value whether the user has engagement emails enabled.
FirstName String The first name of the user.
InboundBridgePhone String The telephone number of the users inbound bridge phone.
InboundBridgePhoneExtension String The extension number of the users inbound bridge phone.
InboundCallBehavior String The behavior of inbound calls.
InboundPhoneType String The users type of telephone for inbound calls.
InboundVoicemailCustomMessageText String The message for inbound voicemails.
InboundVoicemailMessageTextVoice String The gender of the voice that reads the voicemail message.
InboundVoicemailPromptType String The type of inbound voicemail to use.
KaiaRecordingsViewId String The default smart view to load on the kaia recordings view.
KeepBridgePhoneConnected Boolean Whether to keep the users bridge phone connected in-between outbound calls.
LastName String The last name of the user.
LastSignInAt Datetime The date and time the user previously signed in.
Locked Boolean A boolean value whether the user is locked out of the application.
MailboxErrorEmailEnabled Boolean A boolean value whether the users mailbox error emails are enabled.
MeetingEngagementNotificationEnabled Boolean A boolean value whether the users meeting engagement notifications are enabled.
Name String The full name of the user.
NotificationsEnabled Boolean A boolean value whether the users notifications are enabled.
OceClickToDialEverywhere Boolean A boolean value indicating if phone calls will launch a call from Outreach.
OceGmailToolbar Boolean A boolean value indicating whether the Outreach Gmail toolbar is enabled.
OceGmailTrackingState String The users current email tracking settings when using Outreach Everywhere with GMail.
OceSalesforceEmailDecorating Boolean A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.
OceSalesforcePhoneDecorating Boolean A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.
OceUniversalTaskFlow Boolean A boolean value indicating whether Outreach Everywhere universal task flow is enabled.
OceWindowMode Boolean A boolean value indicating whether Outreach Everywhere window mode is enabled.
OnboardedAt Datetime The default smart view to load on the opportunity index view.
OpportunitiesViewId String The date and time the current password expires.
PasswordExpiresAt Datetime The country code of the users phone.
PhoneCountryCode String The telephone number of the users phone.
PhoneNumber String The users type of telephone for outbound calls.
PhoneType String A boolean value whether the users plugin related error notifications are enabled.
PluginAlertNotificationEnabled Boolean A string that represents Twilio data center used to connect to Twilio.
PreferredVoiceRegion String A boolean value whether the user prefers that a voice call comes from a local phone number.
PrefersLocalPresence Boolean The primary preferred timezone to use when scheduling meetings.
PrimaryTimezone String The default smart view to load on the prospect index view.
ProspectsViewId String The default smart view to load on the team performance reports view.
ReportsTeamPerfViewId String The default smart view to load on the reports view.
ReportsViewId String The ID from the SCIM provisioning service used to create the user.
ScimExternalId String The name of the SCIM provisioning source used to create the user.
ScimSource String The secondary preferred timezone to use when scheduling meetings.
SecondaryTimezone String A boolean value whether the users sender notifications are excluded.
SenderNotificationsExcluded Boolean The default smart view to load on the tasks index view.
TasksViewId String The default smart view to load on the teams index view.
TeamsViewId String The tertiary preferred timezone to use when scheduling meetings.
TertiaryTimezone String A boolean value whether to send the user email notifications when a text message is missed.
TextingEmailNotifications Boolean The users job title.
Title String A boolean value whether the users unknown reply emails are enabled.
UnknownReplyEmailEnabled Boolean The date and time the user was last updated.
UpdatedAt Datetime The globally unique ID GUID assigned to the user.
UserGuid String A reader friendly unique identifier of the user.
Username String A reader friendly unique identifier of the user.
UsersViewId String The default smart view to load on the users index view.
VoicemailNotificationEnabled Boolean A boolean value whether the users voicemail notifications are enabled.
WeeklyDigestEmailEnabled Boolean A boolean value whether the users weekly digest email are enabled.
LinksSelf String Link Self.
ContentCategoryMembershipsId String ContentCategoryMemberships Id.
CreatorId Integer The creator Id of the template.
CreatorType String The creator type of the template.
MailboxId Integer Mailboxes Id associated with the users.
MailboxType String Mailboxes Type associated with the users.
ProfileId Integer Profile Id associated with the users.
ProfileType String Profile type associated with the users.
RecipientsId String Recipients Id associated with the users.
RecipientsLinks String Recipients type associated with the users.
RoleId Integer Roles Id associated with the users.
RoleType String Roles Type associated with the users.
TeamsId String Teams Id associated with the users.
UpdaterId Integer The Updater Id of the template.
UpdaterType String The Updater type of the template.
Type String type.

Outreach Connector for CData Sync

UsersDuties

Get details of the individual that uses the application.

Select

The Sync App will use the Outreach API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

  • UsersId supports the '=,IN,>=,<=,>,<' operators.
  • CurrentSignInAt supports the '=,>=,<=,>,<' operators.
  • CreatedAt supports the '=,>=,<=,>,<' operators.
  • Email supports the '=,IN' operators.
  • FirstName supports the '=,IN' operators.
  • LastName supports the '=,IN' operators.
  • UpdatedAt supports the '=,>=,<=,>,<' operators.
  • UserName supports the '=,IN' operators.
  • Locked supports the '=' operators.
For example, the following query is processed server side:
SELECT * FROM UsersDuties WHERE CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt >= '2022-01-25 01:02:02.0 ' AND CreatedAt <= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt >= '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt < '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CreatedAt > '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE CurrentSignInAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE UpdatedAt = '2022-02-25 01:02:02.0'

SELECT * FROM UsersDuties WHERE Email = '[email protected]'

SELECT * FROM UsersDuties WHERE FirstName = 'test'

SELECT * FROM UsersDuties WHERE LasttName = 'test'

Columns

Name Type Description
Id [KEY] Integer Id.
Name String Duty name.
DutyType String Duty type.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
UsersId Integer Id of Users.
CreatedAt Datetime The date and time the user was created.
CurrentSignInAt Datetime The date and time the user most recently signed in.
Email String The email address of the user.
FirstName String The first name of the user.
LastName String The last name of the user.
Locked Boolean A boolean value indicating whether or not the user is locked out of the application.
UpdatedAt Datetime The globally unique ID GUID assigned to the user.
Username String A reader friendly unique identifier of the user.

Outreach Connector for CData Sync

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Connection


プロパティ説明
APIVersionThe version of the Outreach API used.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall


プロパティ説明
FirewallTypeprovider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServerファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPortプロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUserプロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPasswordプロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy


プロパティ説明
ProxyAutoDetectprovider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPortクライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLTypeProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptionsProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesレポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Viewsレポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous


プロパティ説明
IncludeCustomFieldsA boolean indicating if you would like to include custom fields in the column listing.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
Outreach Connector for CData Sync

Connection

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。


プロパティ説明
APIVersionThe version of the Outreach API used.
Outreach Connector for CData Sync

APIVersion

The version of the Outreach API used.

解説

The version of the Outreach API used.

Outreach Connector for CData Sync

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
Outreach Connector for CData Sync

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

Outreach Connector for CData Sync

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

Outreach Connector for CData Sync

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
Outreach Connector for CData Sync

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Outreach Connector for CData Sync

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。


プロパティ説明
FirewallTypeprovider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServerファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPortプロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUserプロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPasswordプロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
Outreach Connector for CData Sync

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル デフォルトポート 説明
TUNNEL 80 Sync App がOutreach への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4 1080 Sync App がOutreach への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 Sync App がOutreach にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

Outreach Connector for CData Sync

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Outreach Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Outreach Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Outreach Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Outreach Connector for CData Sync

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。


プロパティ説明
ProxyAutoDetectprovider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPortクライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLTypeProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptionsProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
Outreach Connector for CData Sync

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

Outreach Connector for CData Sync

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

Outreach Connector for CData Sync

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

Outreach Connector for CData Sync

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

  • BASIC:Sync App はHTTP BASIC 認証を行います。
  • DIGEST:Sync App はHTTP DIGEST 認証を行います。
  • NTLM:Sync App はNTLM トークンを取得します。
  • NEGOTIATE:Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • NONE:ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

Outreach Connector for CData Sync

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyUser に設定する値
BASIC プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

Outreach Connector for CData Sync

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyPassword に設定する値
BASIC ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

Outreach Connector for CData Sync

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTOデフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

Outreach Connector for CData Sync

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Outreach Connector for CData Sync

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Outreach Connector for CData Sync

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

Outreach Connector for CData Sync

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesレポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Viewsレポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
Outreach Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Outreach Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

Outreach Connector for CData Sync

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Outreach Connector for CData Sync

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Outreach Connector for CData Sync

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Outreach Connector for CData Sync

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeCustomFieldsA boolean indicating if you would like to include custom fields in the column listing.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
Outreach Connector for CData Sync

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

解説

Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.

Outreach Connector for CData Sync

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Outreach Connector for CData Sync

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

Outreach Connector for CData Sync

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

Outreach Connector for CData Sync

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Outreach Connector for CData Sync

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。


{
	"MyView": {
		"query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175