Cvent への接続を追加

Cvent への接続を追加するには：

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

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

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

Cvent REST API は、OAuth 2.0 のクライアント認証フローを使用してCvent へのリクエストを認可します。

接続の前に

Cvent への認証を行う前に、ワークスペースとOAuth アプリケーションを作成する必要があります。

ワークスペースの作成

ワークスペースを作成するには：

1. Cvent にサインインし、App Switcher（ページ右上の青いボタン） -> Admin に移動します。
2. Admin メニューから、Integrations -> REST API に移動します。
3. Developer Management の新しいタブが立ち上がります。新しいタブでManage API Access をクリックします。
4. Workspace を作成し、名前を付けます。開発者にアクセスさせたいスコープを選択します。スコープは、開発者がアクセスできるデータドメインを制御します。
   • All を選択すると、開発者は任意のスコープ、およびREST API にこれから追加されるスコープを選択できます。
   • Custom を選択すると、開発者がOAuth アプリで選択できるスコープを、選択したスコープに制限できます。Sync App によって公開されるすべてのテーブルにアクセスするには、次のスコープを設定する必要があります。
     • event/attendees:read
     • event/attendees:write
     • event/contacts:read
     • event/contacts:write
     • event/custom-fields:read
     • event/custom-fields:write
     • event/events:read
     • event/events:write
     • event/sessions:delete
     • event/sessions:read
     • event/sessions:write
     • event/speakers:delete
     • event/speakers:read
     • event/speakers:write
     • budget/budget-items:read
     • budget/budget-items:write
     • exhibitor/exhibitors:read
     • exhibitor/exhibitors:write
     • survey/surveys:read
     • survey/surveys:write

OAuth アプリケーションの作成

Workspace を設定して招待すると、開発者はサインアップしてカスタムOAuth アプリを作成できます。手順については、カスタムOAuth アプリケーションの作成 を参照してください。

Cvent への接続

OAuth アプリケーションを作成したら、次の接続プロパティを設定してCvent に接続します。

• InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
• OAuthClientId：OAuth アプリケーションに関連付けられたClient ID。これは、Developer Portal のApplications ページにあります。
• OAuthClientSecret：OAuth アプリケーションに関連付けられたClient secret。これは、Developer Portal のApplications ページにあります。

Overview

This section shows the available API objects and provides more information on executing SQL to Cvent APIs.

Key Features

• The Sync App models Cvent entities as relational views, allowing you to write SQL to query Cvent data.
• Stored procedures allow you to execute operations to Cvent.
• Live connectivity to these objects means any changes to your Cvent account are immediately reflected when using the Sync App.

Tables

テーブル expose Cvent entities like events, contacts, and sessions.

Views

ビュー are read-only tables that expose Cvent entities like emails, budget totals, and event questions.

Stored Procedures

ストアドプロシージャ are function-like interfaces to Cvent. Stored procedures allow you to execute operations to Cvent, including obtaining and refreshing OAuth tokens.

Inserting and Updating Tables with Aggregate Data

JSON is the accepted format for updating or inserting data for Cvent tables that contain aggregate values.

Below is an example of the HomeAddressAggregate field data from the Contacts table.

		INSERT INTO Contacts (firstName, lastName, email, HomeAddressAggregate) VALUES ('CventContactFirstName', 'CventContactLastName', '[email protected]', '{"regionCode": "TX"," "address1": "Cvent Inc.", "address2": "4001 West Parmer Lane", "address3": "PO Box 123", "city": "Austin", "countryCode": "US", "postalCode": "78727"}')

Sync App はCvent のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Cvent Connector for CData Sync テーブル

Name	Description
AttendeeActivities	Returns data from the AttendeeActivities table.
Attendees	Returns data from the Attendees table.
BudgetItems	Returns data from the BudgetItems table.
ContactGroups	Returns data from the ContactGroups table.
Contacts	Returns data from the Contacts table.
CustomFields	Returns data from the CustomFields table.
Events	Returns data from the Events table.
EventTransactions	Returns data from the EventTransactions table.
Exhibitors	Returns data from the Exhibitor table.
Sessions	Returns data from the Sessions table.
Speakers	Returns data from the Speakers table.
Users	Returns data from the Users table.

Returns data from the AttendeeActivities table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• Name supports =,!=
• Type supports =,!=
• Created supports =,!=,>,<,>=,<=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM AttendeeActivities WHERE Id='cventId' OR Created <= '06/11/2020'

INSERT

The following is an example of an INSERT statement:

INSERT INTO AttendeeActivities (name, type, dataid, dataExternalActivityDate, attendeeId, eventId)
VALUES ('social.media', 'event.external', 'e1188b76-74e7-406a-aeec-c841e52dbc11', '01/02/2024', '97bb14d0-69ce-40a3-be66-0a888542978c', 'e1188b76-74e7-406a-aeec-c841e52dbc11' )

Columns

Name	Type	ReadOnly	References	Description
Name	String	False		The Name of the AttendeeActivities table.
Type	String	False		The Type of the AttendeeActivities table.
Id [KEY]	String	False		The Id of the AttendeeActivities table.
Created	Datetime	False		The Created of the AttendeeActivities table.
AppointmentId	String	False		The AppointmentId of the AttendeeActivities table.
AppointmentName	String	False		The AppointmentName of the AttendeeActivities table.
AppointmentCode	String	False		The AppointmentCode of the AttendeeActivities table.
ContactFirstName	String	False		The ContactFirstName of the AttendeeActivities table.
ContactLastName	String	False		The ContactLastName of the AttendeeActivities table.
ContactEmail	String	False		The ContactEmail of the AttendeeActivities table.
AttendeeId	String	False		The AttendeeId of the AttendeeActivities table.
EventId	String	False		The EventId of the AttendeeActivities table.
EventCode	String	False		The EventCode of the AttendeeActivities table.
EventTimezone	String	False		The EventTimezone of the AttendeeActivities table.
EventTitle	String	False		The EventId of the AttendeeActivities table.
DataId	String	False		The DataId of the Attendess table.
DataExternalActivityDate	Datetime	False		The DataExternalActivityDate of the Attendess table.

Returns data from the Attendees table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• ConfirmationNumber supports =,!=
• CheckedIn supports =,!=
• ReferenceId supports =,!=
• Note supports =,!=
• Guest supports =,!=
• Unsubscribed supports =,!=
• Status supports =,!=
• RegisteredAt supports =,!=,>,<,>=,<=
• RegistrationLastModified supports =,!=,>,<,>=,<=
• InvitedBy supports =,!=
• ResponseMethod supports =,!=
• Visibility supports =,!=
• AttendeeLastModified supports =,!=,>,<,>=,<=
• Created supports =,!=,>,<,>=,<=
• LastModified supports =,!=,>,<,>=,<=
• ContactId supports =,!=
• ContactFirstName supports =,!=
• ContactLastName supports =,!=
• ContactEmail supports =,!=
• EventId supports =,!=
• RegistrationPathId supports =,!=
• InvitationListId supports =,!=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM Attendees WHERE Id='cventId' OR RegistrationLastModified <= '06/11/2020'

INSERT

The following is an example of an INSERT statement:

INSERT INTO Attendees (status, ContactId, EventId, InvitationListId) 
VALUES('No Response', 'DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', 'e0ce6b11-2c5c-48b2-8104-b71ace5eed13', 'be48a15b-f86f-458f-a7e5-45c9bc073030')

UPDATE

The following is an example of an UPDATE statement:

UPDATE Attendees SET status = 'Accepted', ContactId = 'DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', EventId='e0ce6b11-2c5c-48b2-8104-b71ace5eed13'
 WHERE ID='462af84e-be35-4082-ac38-3cda475dd1de'

DELETE

DELETEs are not supported for this table.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The ID of the Attendees table.
ConfirmationNumber	String	False		The ConfirmationNumber of the Attendees table.
CheckedIn	Boolean	False		The CheckedIn of the Attendees table.
CheckIn	Datetime	False		The CheckIn of the Attendees table.
CheckOut	Datetime	False		The CheckOut of the Attendees table.
Duration	String	False		The Duration of the Attendees table.
ReferenceId	String	False		The ReferenceId of the Attendees table.
Note	String	False		The Note of the Attendess table.
Guest	String	False		The Guest of the Attendess table.
PrimaryId	String	False		The PrimaryId of the Attendess table.
Unsubscribed	String	False		The Unsubscribed of the Attendess table.
Status	String	False		The Status of the Attendess table.
RegisteredAt	Datetime	False		The RegisteredAt of the Attendess table.
RegistrationLastModified	Datetime	False		The RegistrationLastModified of the Attendess table.
RegistrationCancelledAt	Datetime	False		The RegistrationCancelledAt of the Attendess table.
InvitedBy	String	False		The InvitedBy of the Attendess table.
ResponseMethod	String	False		The ResponseMethod of the Attendess table.
Visibility	String	False		The Visibility of the Attendess table.
Bio	String	False		The Bio of the Attendess table.
ShowPopupNotification	String	False		The ShowPopupNotification of the Attendess table.
WebsiteUrl	String	False		The WebsiteUrl of the Attendess table.
AllowPushNotifications	String	False		The AllowPushNotifications of the Attendess table.
AllowAppointmentPushNotifications	String	False		The AllowAppointmentPushNotifications of the Attendess table.
TestRecord	String	False		The TestRecord of the Attendess table.
AttendeeLastModified	Datetime	False		The AttendeeLastModified of the Attendess table.
Created	Datetime	False		The Created of the Attendess table.
CreatedBy	String	False		The CreatedBy of the Attendess table.
LastModified	Datetime	False		The LastModified of the Attendess table.
LastModifiedBy	String	False		The LastModifiedBy of the Attendess table.
EventId	String	False		The EventId of the Attendess table.
ContactId	String	False		The ContactId of the Attendess table.
ContactFirstName	String	False		The ContactFirstName of the Attendess table.
ContactLastName	String	False		The ContactLastName of the Attendess table.
ContactEmail	String	False		The ContactEmail of the Attendess table.
RegistrationPathId	String	False		The RegistrationPathId of the Attendess table.
RegistrationPathCode	String	False		The RegistrationPathCode of the Attendess table.
RegistrationPathName	String	False		The RegistrationPathName of the Attendess table.
InvitationListId	String	False		The InvitationListId of the Attendess table.
InvitationListName	String	False		The InvitationListName of the Attendess table.
WebLinksAcceptRegistration	String	False		The WebLinksAcceptRegistration of the Attendess table.
WebLinksDeclineRegistration	String	False		The WebLinksDeclineRegistration of the Attendess table.
RegistrationId	String	False		The RegistrationId of the Attendess table.
RegistrationName	String	False		The RegistrationName of the Attendess table.
ExternalReferencesAggregate	String	False		The ExternalReferencesAggregate of the Attendess table.
GroupId	String	False		The GroupId of the Attendess table.
GroupMember	Boolean	False		The GroupMember of the Attendess table.
GroupLeader	Boolean	False		The GroupLeader of the Attendess table.
QuestionsAggregate	String	False		The QuestionsAggregate of the Attendess table.
AnswersAggregate	String	False		The AnswersAggregate of the Attendess table.
AdmissionItemId	String	False		The AdmissionItemId of the Attendess table.
AdmissionItemCode	String	False		The AdmissionItemCode of the Attendess table.
AdmissionItemName	String	False		The AdmissionItemName of the Attendess table.
AppointmentGroupsAggregate	String	False		The AppointmentGroupsAggregate of the Attendess table.

Returns data from the BudgetItems table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =
• Deleted supports =,!=
• CostType supports =,!=
• Status supports =,!=
• Date supports >,<,>=,<=
• EventId supports =,!=
• CategoryId supports =,!=
• CategoryName supports =,!=
• SubcategoryId supports =,!=
• SubcategoryName supports =,!=
• VendorId supports =,!=
• VendorName supports =,!=

All other filters are handled client-side.

The following is an example of a SELECT statement:

select * from BudgetItems where Id='cventId' or Date <= '06/11/2020'

INSERT

The following is an example of an INSERT statement that uses an aggregate field:

String costDetail = '[ 
              { 
                \id\: \281d7a8b-f525-4658-9268-5ea73c97a54e\, 
                ame\: \Budgeted\, 
                \units\: 1.0, 
                \cost\: 500.0, 
                \gratuityDetail\: { 
                  \gratuity\: 0.0, 
                  \appliedGratuityValue\: 0.0 
                }, 
                \taxDetail\: [], 
                \totalCost\: 500.0 
              }, 
              { 
                \id\: \d8cbab1a-e370-43b9-afde-a097c81e20e1\, 
                ame\: egotiated\, 
                \units\: 1.0, 
                \cost\: 400.0, 
                \gratuityDetail\: { 
                  \gratuity\: 0.0, 
                  \appliedGratuityValue\: 0.0 
                }, 
                \taxDetail\: [], 
                \totalCost\: 400.0 
              }, 
              { 
                \id\: \0ca4467a-5843-4204-8c26-452680b04b27\, 
                ame\: \Revision1\, 
                \units\: 1.0, 
                \cost\: 424.0, 
                \gratuityDetail\: { 
                  \gratuity\: 0.0, 
                  \appliedGratuityValue\: 0.0 
                }, 
                \taxDetail\: [], 
                \totalCost\: 424.0 
              }, 
              { 
                \id\: \10cc5cef-a4f3-4474-bb9d-0c0c7110b351\, 
                ame\: \Revision2\, 
                \units\: 1.0, 
                \cost\: 455.0, 
                \gratuityDetail\: { 
                  \gratuity\: 0.0, 
                  \appliedGratuityValue\: 0.0 
                }, 
                \taxDetail\: [], 
                \totalCost\: 455.0 
              }, 
              { 
                \id\: \2eec2b68-808d-4bab-a061-b4fafc3300dc\, 
                ame\: \Actual\, 
                \units\: 1.0, 
                \cost\: 455.0, 
                \gratuityDetail\: { 
                  \gratuity\: 0.0, 
                  \appliedGratuityValue\: 0.0 
                }, 
                \taxDetail\: [], 
                \totalCost\: 455.0 
              } 
            ]';

INSERT INTO budgetitems (EventId, costType, name, Status, Date, costIncludesTaxGratuity, calculateTaxOnGratuity, gratuityType, currency, conversionRate, CategoryId, CategoryName, costDetailAggregate)
 VALUES('0ac85e1d-ef51-43a0-a4cf-773b64b1c6f9', 'FIXED', 'Airport Transportation', 'ESTIMATED', '2020-02-07T00:00:00.00Z', false, true, 'PERCENTAGE', 'USD', '5.2', '3', 'Travel', costDetail)

UPDATE

The following is an example of an UPDATE statement that uses an aggregate field:

Update BudgetItems SET  costType='FIXED', name='Airport Transportation', CategoryId='3',  
            CategoryName='Travel', status='PAID', date='2024-02-07T00:00:00.00Z', costIncludesTaxGratuity='false', 
             calculateTaxOnGratuity='true' , gratuityType='PERCENTAGE', currency='USD', conversionRate='5.2',costDetailAggregate=costDetail    
            where  EventId='0ac85e1d-ef51-43a0-a4cf-773b64b1c6f9' and id='eb07a054-71a5-49a5-9773-064c3b9ec507'

Columns

Name	Type	ReadOnly	References	Description
Deleted	Boolean	False		The Deleted of the BudgetItems table.
Id [KEY]	String	False		The Id of the BudgetItems table.
CostType	String	False		The CostType of the BudgetItems table.
Name	String	False		The Name of the BudgetItems table.
Code	String	False		The Code of the BudgetItems table.
Status	String	False		The Status of the BudgetItems table.
Date	Datetime	False		The Date of the BudgetItems table.
LastModifiedDate	Datetime	False		The LastModifiedDate of the BudgetItems table.
CostIncludesTaxGratuity	Boolean	False		The CostIncludesTaxGratuity of the BudgetItems table.
CalculateTaxOnGratuity	Boolean	False		The CalculateTaxOnGratuity of the BudgetItems table.
GratuityType	String	False		The GratuityType of the BudgetItems table.
InternalNote	String	False		The InternalNote of the BudgetItems table.
Currency	String	False		The Currency of the BudgetItems table.
ConversionRateLocked	String	False		The ConversionRateLocked of the BudgetItems table.
ConversionRate	String	False		The ConversionRate of the BudgetItems table.
AssociatedSession	String	False		The AssociatedSession of the BudgetItems table.
CategoryId	String	False		The CategoryId of the BudgetItems table.
CategoryName	String	False		The CategoryName of the BudgetItems table.
SubCategoryId	String	False		The SubCategoryId of the BudgetItems table.
SubCategoryName	String	False		The SubCategoryName of the BudgetItems table.
VendorId	String	False		The VendorId of the BudgetItems table.
VendorName	String	False		The VendorName of the BudgetItems table.
VendorType	String	False		The VendorType of the BudgetItems table.
GeneralLedgerId	String	False		The GeneralLedgerId of the BudgetItems table.
GeneralLedgerCode	String	False		The GeneralLedgerCode of the BudgetItems table.
GeneralLedgerName	String	False		The GeneralLedgerName of the BudgetItems table.
CostAvoidanceAmount	Double	False		The CostAvoidanceAmount of the BudgetItems table.
CostAvoidanceDescription	String	False		The CostAvoidanceDescription of the BudgetItems table.
CostDetailAggregate	String	False		The CostDetailAggregate of the BudgetItems table.
SavingsAggregate	String	False		The SavingsAggregate of the BudgetItems table.
AssociatedRegistrantsAggregate	String	False		The AssociatedRegistrantsAggregate of the BudgetItems table.
EventId [KEY]	String	False	Events.Id	The EventId of the BudgetItems table.

Returns data from the ContactGroups table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =
• Name supports =,!=,like
• Type supports =

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * from ContactGroups where Name='new'

INSERT

The following is an example of an INSERT statement:

INSERT INTO ContactGroups (Name, Type) VALUES ('Test 2', 'STANDARD')

UPDATE

The following is an example of an UPDATE statement:

UPDATE ContactGroups SET Id ='fa47f767-3a45-44dc-a7a5-701f42a6cccd', Name='abc', Type = 'DISTRIBUTION_LIST' WHERE Id ='fa47f767-3a45-44dc-a7a5-701f42a6cccd'

DELETE

The following is an example of a DELETE statement:

DELETE FROM ContactGroups WHERE Id='fa3ca656-a6cb-498d-9b54-25bba92cf931'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the ContactGroups table.
Name	String	False		The Name of the ContactGroups table.
ShortDescription	String	False		The ShortDescription of the ContactGroups table.
Description	String	False		The Description of the ContactGroups table.
Type	String	False		The Type of the ContactGroups table.
Note	String	False		The Note of the ContactGroups table.
Created	Datetime	False		The Created of the ContactGroups table.
CreatedBy	String	False		The CreatedBy of the ContactGroups table.
LastModified	Datetime	False		The LastModified of the ContactGroups table.
LastModifiedBy	String	False		The LastModifiedBy of the ContactGroups table.
DistributionSecurityType	String	False		The DistributionSecurityType of the ContactGroups table.
DistributionInternalNote	String	False		The DistributionInternalNote of the ContactGroups table.
DistributionStatus	String	False		The DistributionStatus of the ContactGroups table.

Returns data from the Contacts table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• FirstName supports =,!=
• LastName supports =,!=,like
• MiddleName supports =,!=,like
• Nickname supports =,!=
• Email supports =,!=,like
• Company supports =,!=
• Designation supports =,!=
• Title supports =,!=
• HomePhone supports =,!=
• HomeFax supports =,!=
• WorkPhone supports =,!=
• WorkFax supports =,!=
• SourceId supports =,!=
• MobilePhone supports =,!=
• Pager supports =,!=
• Deleted supports =,!=
• Created supports =,!=,>,<,>=,<=
• CreatedBy supports =,!=
• LastModified supports =,!=,>,<,>=,<=
• LastModifiedBy supports =,!=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM Contacts WHERE LastName='lastNameValue' OR Created <= '06/11/2020'

INSERT

The following is an example of an INSERT statement:

INSERT INTO Contacts (firstName, lastName, email, HomeAddressAddress1, HomeAddressCity, HomeAddressCountry)
VALUES('MateoMateov222', 'Villa2sds2222', '[email protected]', 'address1val', 'cityVal', 'countryVal')

UPDATE

The following is an example of an UPDATE statement:

UPDATE Contacts SET firstName= 'updatedFirstName' WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'

DELETE

The following is an example of a DELETE statement:

DELETE FROM Contacts WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the Contacts table.
ParentId	String	False		The ParentId of the Contacts table.
FirstName	String	False		The FirstName of the Contacts table.
LastName	String	False		The LastName of the Contacts table.
MiddleName	String	False		The MiddleName of the Contacts table.
Nickname	String	False		The Nickname of the Contacts table.
Email	String	False		The Email of the Contacts table.
CcEmail	String	False		The CcEmail of the Contacts table.
Gender	String	False		The Gender of the Contacts table.
Company	String	False		The Company of the Contacts table.
Designation	String	False		The Designation of the Contacts table.
Title	String	False		The Title of the Contacts table.
PrimaryAddressType	String	False		The PrimaryAddressType of the Contacts table.
HomePhone	String	False		The HomePhone of the Contacts table.
HomeFax	String	False		The HomeFax of the Contacts table.
WorkPhone	String	False		The WorkPhone of the Contacts table.
WorkFax	String	False		The WorkFax of the Contacts table.
SourceId	String	False		The SourceId of the Contacts table.
MobilePhone	String	False		The MobilePhone of the Contacts table.
Prefix	String	False		The Prefix of the Contacts table.
Pager	String	False		The Pager of the Contacts table.
Deleted	Boolean	False		The Deleted of the Contacts table.
Npi	String	False		The Npi of the Contacts table.
DateOfBirth	Datetime	False		The DateOfBirth of the Contacts table.
PassportNumber	String	False		The PassportNumber of the Contacts table.
SocialSecurityNumber	String	False		The SocialSecurityNumber of the Contacts table.
NationalIdentificationNumber	String	False		The NationalIdentificationNumber of the Contacts table.
Headline	String	False		The Headline of the Contacts table.
PersonalWebsite	String	False		The PersonalWebsite of the Contacts table.
Biography	String	False		The Biography of the Contacts table.
Pronouns	String	False		The Pronouns of the Contacts table.
Created	Datetime	False		The Created of the Contacts table.
CreatedBy	String	False		The CreatedBy of the Contacts table.
LastModified	Datetime	False		The LastModified of the Contacts table.
LastModifiedBy	String	False		The LastModifiedBy of the Contacts table.
EventId	String	False		The EventId of the Contacts table.
TypeId	String	False		The TypeId of the Contacts table.
TypeName	String	False		The TypeName of the Contacts table.
MembershipType	String	False		The MembershipType of the Contacts table.
MembershipPlan	String	False		The MembershipPlan of the Contacts table.
MembershipJoined	String	False		The MembershipJoined of the Contacts table.
MembershipExpiration	String	False		The MembershipExpiration of the Contacts table.
MembershipLastRenewal	String	False		The MembershipLastRenewal of the Contacts table.
MembershipAmountDue	String	False		The MembershipAmountDue of the Contacts table.
MembershipListInDirectory	String	False		The MembershipListInDirectory of the Contacts table.
HomeAddressRegion	String	False		The HomeAddressRegion of the Contacts table.
HomeAddressRegionCode	String	False		The HomeAddressRegionCode of the Contacts table.
HomeAddressCountry	String	False		The HomeAddressCountry of the Contacts table.
HomeAddressAddress1	String	False		The HomeAddressAddress1 of the Contacts table.
HomeAddressAddress2	String	False		The HomeAddressAddress2 of the Contacts table.
HomeAddressAddress3	String	False		The HomeAddressAddress3 of the Contacts table.
HomeAddressCity	String	False		The HomeAddressCity of the Contacts table.
HomeAddressCountryCode	String	False		The HomeAddressCountryCode of the Contacts table.
HomeAddressPostalCode	String	False		The HomeAddressPostalCode of the Contacts table.
WorkAddressRegion	String	False		The WorkAddressRegion of the Contacts table.
WorkAddressRegionCode	String	False		The WorkAddressRegionCode of the Contacts table.
WorkAddressCountry	String	False		The WorkAddressCountry of the Contacts table.
WorkAddressAddress1	String	False		The WorkAddressAddress1 of the Contacts table.
WorkAddressAddress2	String	False		The WorkAddressAddress2 of the Contacts table.
WorkAddressAddress3	String	False		The WorkAddressAddress3 of the Contacts table.
WorkAddressCity	String	False		The WorkAddressCity of the Contacts table.
WorkAddressCountryCode	String	False		The WorkAddressCountryCode of the Contacts table.
WorkAddressPostalCode	String	False		The WorkAddressPostalCode of the Contacts table.
ComplianceAggregate	String	False		The ComplianceAggregate of the Contacts table.
OptOutOptedOut	String	False		The OptOutDate of the Contacts table.
OptOutDate	String	False		The OptOut of the Contacts table.
OptOutBy	String	False		The OptOut of the Contacts table.

Returns data from the CustomFields table.

Table Specific Information

The Cvent API allows you to filter by certain fields when querying for data. The following is an example of a SELECT statement:

select * from CustomFields where Id='lastNameValue' or LastModified <= '06/11/2020'

The following is an example of an INSERT statement:

INSERT  INTO CustomFields (category, name, code, type)
VALUES('Contact', 'Villa2sds2222', 'customfieldName', 'uniqueCode', 'cityVal', 'Open Ended Text - Comment Box')

The following is an example of an UPDATE statement:

UPDATE CustomFields SET name= 'updatedFirstName' where id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the CustomFields table.
Category	String	False		The Category of the CustomFields table.
Name	String	False		The Name of the CustomFields table.
Code	String	False		The Code of the CustomFields table.
Required	Boolean	False		The Required of the CustomFields table.
Type	String	False		The Type of the CustomFields table.
Order	String	False		The Order of the CustomFields table.
HelpText	String	False		The HelpText of the CustomFields table.
DisplayInDataTag	String	False		The DisplayInDataTag of the CustomFields table.
DefaultTagText	String	False		The DefaultTagText of the CustomFields table.
ConsentField	Boolean	False		The ConsentField of the CustomFields table.
DisplayInEventCreationWizard	Boolean	False		The DisplayInEventCreationWizard of the CustomFields table.
Created	Datetime	False		The Created of the CustomFields table.
CreatedBy	String	False		The CreatedBy of the CustomFields table.
LastModified	Datetime	False		The LastModified of the CustomFields table.
LastModifiedBy	String	False		The LastModifiedBy of the CustomFields table.
DetailsAnswerFormat	String	False		The DetailsAnswerFormat of the CustomFields table.
DetailsMinimum	String	False		The DetailsMinimum of the CustomFields table.
DetailsMaximum	String	False		The DetailsMaximum of the CustomFields table.

Returns data from the Events table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• Title supports =,!=
• Code supports =,!=
• Virtual supports =,!=
• Format supports =,!=
• Description supports =,!=
• Start supports =,!=,>,<,>=,<=
• End supports =,!=,>,<,>=,<=
• CloseAfter supports =,!=,>,<,>=,<=
• ArchiveAfter supports =,!=,>,<,>=,<=
• LaunchAfter supports =,!=,>,<,>=,<=
• Note supports =,!=
• Status supports =,!=
• EventStatus supports =,!=
• Created supports =,!=,>,<,>=,<=
• LastModified supports =,!=,>,<,>=,<=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM Events WHERE Title='titleValue' OR Start <= '06/11/2020'

INSERT

The following is an example of an INSERT statement that uses aggregate fields for inserts:

@languagesAggregate = '[en-US, en-psk]'
@plannersAggregate = '[{firstName: John,  lastName: Doe,  email: [email protected] }]'

INSERT INTO Events (Title, format, timezone, LanguagesAggregate, PlannersAggregate, type) VALUES('SampleTitle', 'Virtual', 'America/New_York' , @languagesAggregate, @plannersAggregate, 'Webinar')

UPDATE

The following is an example of an UPDATE statement:

UPDATE Events SET title= 'EventTitle',format= 'Virtual',timezone= 'America/Chicago',LanguagesAggregate= @languagesAggregate,PlannersAggregate= @plannersAggregate, type='Celebration' WHERE id = '80B7A193-A807-4B7E-BFEA-787E86DFB40D'

DELETE

DELETEs are not supported for this table.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the Events table.
Title	String	False		The Title of the Events table.
Code	String	False		The Code of the Events table.
Virtual	Boolean	False		The Virtual of the Events table.
Format	String	False		The Format of the Events table.
Description	String	False		The Description of the Events table.
Start	Datetime	False		The Start of the Events table.
End	Datetime	False		The End of the Events table.
CloseAfter	Datetime	False		The CloseAfter of the Events table.
ArchiveAfter	Datetime	False		The ArchiveAfter of the Events table.
LaunchAfter	Datetime	False		The LaunchAfter of the Events table.
Timezone	String	False		The Timezone of the Events table.
Phone	String	False		The Phone of the Events table.
Note	String	False		The Note of the Events table.
DefaultLocale	String	False		The DefaultLocale of the Events table.
Currency	String	False		The Currency of the Events table.
RegistrationSecurityLevel	String	False		The RegistrationSecurityLevel of the Events table.
Status	String	False		The Status of the Events table.
EventStatus	String	False		The EventStatus of the Events table.
PlanningStatus	String	False		The PlanningStatus of the Events table.
TestMode	Boolean	False		The TestMode of the Events table.
Capacity	Integer	False		The Capacity of the Events table.
Type	String	False		The Type of the Events table.
Created	Datetime	False		The Created of the Events table.
LastModified	Datetime	False		The LastModified of the Events table.
MeetingRequestId	String	False		The MeetingRequestId of the Events table.
CreatedBy	String	False		The CreatedBy of the Events table.
LastModifiedBy	String	False		The LastModifiedBy of the Events table.
VenuesAggregate	String	False		The VenuesAggregate of the Events table.
LanguagesAggregate	String	False		The LanguagesAggregate of the Events table.
PlannersAggregate	String	False		The PlannersAggregate of the Events table.
StakeholdersAggregate	String	False		The StakeholdersAggregate of the Events table.
CategoryId	String	False		The CategoryId of the Events table.
CategoryName	String	False		The CategoryName of the Events table.
CategoryCode	String	False		The CategoryCode of the Events table.

Returns data from the EventTransactions table.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the EventTransactions table.
EventId	String	False		The EventId of the EventTransactions table.
ProcessorTransactionId	String	False		The ProcessorTransactionId of the EventTransactions table.
JournalNumber	String	False		The JournalNumber of the EventTransactions table.
PaymentType	String	False		The PaymentType of the EventTransactions table.
PaymentMethod	String	False		The PaymentMethod of the EventTransactions table.
Success	Boolean	False		The Success of the EventTransactions table.
Date	Datetime	False		The Date of the EventTransactions table.
BatchNumber	String	False		The BatchNumber of the EventTransactions table.
ReferenceNumber	String	False		The ReferenceNumber of the EventTransactions table.
Amount	String	False		The Amount of the EventTransactions table.
Currency	String	False		The Currency of the EventTransactions table.
PaymentNote	String	False		The PaymentNote of the EventTransactions table.
Created	Datetime	False		The Created of the EventTransactions table.
CreatedBy	String	False		The CreatedBy of the EventTransactions table.
LastModified	Datetime	False		The LastModified of the EventTransactions table.
LastModifiedBy	String	False		The LastModifiedBy of the EventTransactions table.
EventId	String	False		The EventId of the EventTransactions table.
AttendeeId	String	False		The AttendeeId of the EventTransactions table.

Returns data from the Exhibitor table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =
• Deleted supports =
• EventId supports =,!=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM Exhibitors WHERE Id='cventId' OR Created <= '06/11/2020'

INSERT

The following is an example of an INSERT statement:

INSERT INTO Exhibitors (EventId, Name) 
VALUES('DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD', 'exhibitorName')

UPDATE

The following is an example of an UPDATE statement:

UPDATE Exhibitors SET name = 'UpdatedName', EventId='e0ce6b11-2c5c-48b2-8104-b71ace5eed13'
 WHERE EventId='DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD' AND ID='462af84e-be35-4082-ac38-3cda475dd1de'

DELETE

The following is an example of a DELETE statement:

DELETE FROM Exhibitors where EventId='DE830CBE-B4EB-4E2B-A51C-6F10384CD0AD' and id = 'attendeeId'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the Exhibitor table.
ProfileLogoId	String	False		The ProfileLogoId of the BudgetTotals table.
ProfileLogoUrl	String	False		The ProfileLogoUrl of the Exhibitor table.
BannerId	String	False		The BannerId of the Exhibitor table.
BannerUrl	String	False		The BannerUrl of the Exhibitor table.
Name	String	False		The Name of the Exhibitor table.
Description	String	False		The Description of the Exhibitor table.
Code	String	False		The Code of the Exhibitor table.
SourceId	String	False		The SourceId of the Exhibitor table.
Location	String	False		The Location of the Exhibitor table.
Email	String	False		The Email of the Exhibitor table.
MobilePhone	String	False		The MobilePhone of the Exhibitor table.
WorkPhone	String	False		The WorkPhone of the Exhibitor table.
OtherPhone	String	False		The OtherPhone of the Exhibitor table.
Website	String	False		The Website of the Exhibitor table.
Created	Datetime	False		The Created of the Exhibitor table.
CreatedBy	String	False		The CreatedBy of the Exhibitor table.
LastModified	Datetime	False		The LastModified of the Exhibitor table.
LastModifiedBy	String	False		The LastModifiedBy of the Exhibitor table.
Deleted	Boolean	False		The Deleted of the Exhibitor table.
EventSponsor	Boolean	False		The EventSponsor of the Exhibitor table.
Featured	Boolean	False		The Featured of the Exhibitor table.
EventId	String	False	Events.Id	The EventId of the Exhibitor table.
AddressAddress1	String	False		The AddressAddress1 of the Exhibitor table.
AddressAddress2	String	False		The AddressAddress2 of the Exhibitor table.
AddressCity	String	False		The AddressCity of the Exhibitor table.
AddressRegion	String	False		The AddressRegion of the Exhibitor table.
AddressPostalCode	String	False		The AddressPostalCode of the Exhibitor table.
AddressCountry	String	False		The AddressCountry of the Exhibitor table.
ContactLinksAggregate	String	False		The ContactLinksAggregate of the Exhibitor table.
SponsorshipLevelId	String	False		The SponsorshipLevelAggregate of the Exhibitor table.

Returns data from the Sessions table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• Virtual supports =,!=
• Title supports =,!=
• Code supports =,!=
• Description supports =,!=
• Start supports =,!=,>,<,>=,<=
• End supports =,!=,>,<,>=,<=
• Status supports =,!=
• EnableWaitlist supports =,!=
• Capacity supports =,!=,>,<,>=,<=
• Featured supports =,!=
• OpenForRegistration supports =,!=
• OpenForAttendeeHub supports =,!=
• Created supports =,!=,>,<,>=,<=
• LastModified supports =,!=,>,<,>=,<=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * from Sessions WHERE Created > '2024-02-16'

INSERT

INSERT is not supported for this table.

UPDATE

UPDATE is not supported for this table.

DELETE

The following is an example of a DELETE statement:

DELETE FROM Sessions WHERE Id ='2cbd2393-8b84-42e4-9702-dc32f67d02c6'

Columns

Name	Type	ReadOnly	References	Description
IncludedSession	Boolean	False		The IncludedSession of the Sessions table.
Relevance	String	False		The Relevance of the Sessions table.
Id [KEY]	String	False		The Id of the Sessions table.
Virtual	Boolean	False		The Virtual of the Sessions table.
Title	String	False		The Title of the Sessions table.
Code	String	False		The Code of the Sessions table.
Description	String	False		The Description of the Sessions table.
Start	Datetime	False		The Start of the Sessions table.
End	Datetime	False		The End of the Sessions table.
Status	String	False		The Status of the Sessions table.
AutomaticallyOpensOn	String	False		The AutomaticallyOpensOn of the Sessions table.
AutomaticallyClosesOn	String	False		The AutomaticallyClosesOn of the Sessions table.
EnableWaitlist	Boolean	False		The EnableWaitlist of the Sessions table.
WaitlistCapacity	String	False		The WaitlistCapacity of the Sessions table.
EnableWaitlistVirtual	Boolean	False		The EnableWaitlistVirtual of the Sessions table.
Capacity	String	False		The Capacity of the Sessions table.
CapacityUnlimited	Boolean	False		The CapacityUnlimited of the Sessions table.
CapacityVirtual	String	False		The CapacityVirtual of the Sessions table.
VirtualCapacityUnlimited	Boolean	False		The VirtualCapacityUnlimited of the Sessions table.
WaitlistCapacityVirtual	String	False		The WaitlistCapacityVirtual of the Sessions table.
Timezone	String	False		The Timezone of the Sessions table.
DisplayOnAgenda	Boolean	False		The DisplayOnAgenda of the Sessions table.
Featured	Boolean	False		The Featured of the Sessions table.
OpenForRegistration	Boolean	False		The OpenForRegistration of the Sessions table.
OpenForAttendeeHub	Boolean	False		The OpenForAttendeeHub of the Sessions table.
PresentationType	String	False		The PresentationType of the Sessions table.
DataTagCode	String	False		The DataTagCode of the Sessions table.
Created	Datetime	False		The Created of the Sessions table.
CreatedBy	String	False		The CreatedBy of the Sessions table.
LastModified	Datetime	False		The LastModified of the Sessions table.
LastModifiedBy	String	False		The LastModifiedBy of the Sessions table.
EventId	String	False		The EventId of the Sessions table.
CategoryId	String	False		The CategoryId of the Sessions table.
CategoryName	String	False		The CategoryName of the Sessions table.
TypeId	String	False		The TypeId of the Sessions table.
TypeCode	String	False		The TypeCode of the Sessions table.
TypeName	String	False		The TypeName of the Sessions table.
LocationId	String	False		The LocationId of the Sessions table.
LocationCode	String	False		The LocationCode of the Sessions table.
LocationName	String	False		The LocationName of the Sessions table.
Group	String	False		The GroupAggregate of the Sessions table.
AdmissionItemsAggregate	String	False		The AdmissionItemsAggregate of the Sessions table.
RegistrationTypesAggregate	String	False		The RegistrationTypesAggregate of the Sessions table.

Returns data from the Speakers table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• FirstName supports =,!=,like
• LastName supports =,!=,like
• Code supports =,!=,like
• Email supports =,!=,like
• Company supports =,!=,like
• Title supports =,!=,like
• Visibility supports =,!=
• Featured supports =,!=
• LastModified supports =,!=,>,<,>=,<=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM Speakers WHERE FirstName='cvent'

INSERT

The following is an example of an INSERT statement:

INSERT INTO Speakers (FirstName, LastName, EventId) VALUES('Bob', 'Smith', 'e12ff613-966f-4fb9-bc91-8bd32c84f130')

UPDATE

The following is an example of an UPDATE statement:

UPDATE Speakers SET FirstName='Sam', LastName='Jackson', EventId='e12ff613-966f-4fb9-bc91-8bd32c84f130' WHERE Id='fc6d8759-2331-4ac7-8868-d9aed5b638c7'

DELETE

The following is an example of a DELETE statement:

DELETE FROM Speakers WHERE Id='fc6d8759-2331-4ac7-8868-d9aed5b638c7'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the Speakers table.
Order	String	False		The Order of the Speakers table.
FirstName	String	False		The FirstName of the Speakers table.
LastName	String	False		The LastName of the Speakers table.
Code	String	False		The Code of the Speakers table.
Email	String	False		The Email of the Speakers table.
Prefix	String	False		The Prefix of the Speakers table.
Designation	String	False		The Designation of the Speakers table.
Company	String	False		The Company of the Speakers table.
Title	String	False		The Title of the Speakers table.
Visibility	Boolean	False		The Visibility of the Speakers table.
Biography	String	False		The Biography of the Speakers table.
InternalNote	String	False		The InternalNote of the Speakers table.
Featured	Boolean	False		The Featured of the Speakers table.
Created	Datetime	False		The Created of the Speakers table.
CreatedBy	String	False		The CreatedBy of the Speakers table.
LastModified	Datetime	False		The LastModified of the Speakers table.
LastModifiedBy	String	False		The LastModifiedBy of the Speakers table.
ContactId	String	False		The ContactId of the Speakers table.
EventId	String	False		The EventId of the Speakers table.
CategoryId	String	False		The CategoryId of the Speakers table.
CategoryName	String	False		The CategoryName of the Speakers table.

Returns data from the Users table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• Id supports =,!=
• UserName supports =,!=
• Active supports =,!=
• Created supports =,!=,>,<,>=,<=
• LastModified supports =,!=,>,<,>=,<=

All other filters are handled client-side.

The following is an example of a SELECT statement:

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

INSERT

The following is an example of an INSERT statement:

INSERT INTO Users (UserName, Active, UserType, GivenName, FamilyName, Timezone, Locale, EmailValue, GroupValue, SendLoginDetails) 
VALUES ('[email protected]', 'true', 'Planner Account User','Test','Test','America/New_York', 'en-US', '[email protected]', '1234b4e4-abcd-4a6d-adb7-ce81bbc4e019', true)

UPDATE

The following is an example of an UPDATE statement:

UPDATE Users SET UserName='[email protected]', Active=true, UserType='Planner Account User', GivenName='Bob', FamilyName='Test', MiddleName='', Timezone='America/New_York', Locale='en-US', 
EmailValue='[email protected]', GroupValue='3290b4e4-afce-4a6d-adb7-ce81bbc4e019', SendLoginDetails=true WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'

DELETE

The following is an example of a DELETE statement:

DELETE FROM Users WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the Users table.
UserName	String	False		The UserName of the Users table.
Active	Boolean	False		The Active of the Users table.
Title	String	False		The Title of the Users table.
UserType	String	False		The UserType of the Users table.
Timezone	String	False		The Timezone of the Users table.
Locale	String	False		The Locale of the Users table.
GivenName	String	False		The GivenName of the Users table.
FamilyName	String	False		The FamilyName of the Users table.
MiddleName	String	False		The MiddleName of the Users table.
HonorificPrefix	String	False		The HonorificPrefix of the Users table.
EmailType	String	False		The EmailType of the Users table.
EmailValue	String	False		The EmailValue of the Users table.
EmailPrimary	Boolean	False		The EmailPrimary of the Users table.
GroupValue	String	False		The GroupValue of the Users table.
GroupDisplay	String	False		The GroupDisplay of the Users table.
SendLoginDetails	Boolean	False		The SendLoginDetails of the Users table.
Created	Datetime	False		Datetime when the record was created.
LastModified	Datetime	False		Datetime when the record was last updated.

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

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

Cvent Connector for CData Sync ビュー

Name	Description
Appointments	Returns data from the Appointments table.
BudgetTotals	Returns data from a BudgetTotals table.
ContactTypes	Returns data from the ContactTypes table.
Emails	Returns data from the Emails table.
EventOrderItems	Returns data from the EventOrderItems table.
EventOrders	Returns data from the EventOrders table.
EventQuestions	Returns data from the EventQuestions table.
EventSurveyResponses	Returns data from the EventSurveyResponses table.
SessionDocuments	Returns data from the SessionDocuments table.
StandaloneSurveys	Returns data from event and standalone surveys associated to an account.
Surveys	Returns data from the surveys associated to a single event.

Returns data from the Appointments table.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the Appointments table.
AutoAcceptAttendees	String		The AutoAcceptAttendees of the Attendess table.
EnforceScheduleRules	String		The EnforceScheduleRules of the Attendess table.
Modified	String		The Modified of the Attendess table.
Deleted	String		The Deleted of the Attendess table.
Code	String		The Code of the Attendess table.
Name	String		The Name of the Attendess table.
Description	String		The Description of the Attendess table.
Start	String		The Start of the Attendess table.
End	String		The End of the Attendess table.
Status	String		The Status of the Attendess table.
Created	String		The Created of the Attendess table.
CreatedBy	String		The CreatedBy of the Attendess table.
LastModified	String		The LastModified of the Attendess table.
LastModifiedBy	String		The LastModifiedBy of the Attendess table.
AppointmentEventId	String		The AppointmentEventId of the Attendess table.
LocationName	String		The LocationName of the Attendess table.
TypeName	String		The TypeName of the Attendess table.
ParticipantsAggregate	String		The ParticipantsAggregate of the Attendess table.
QuestionsAggregate	String		The QuestionsAggregate of the Attendess table.

Returns data from a BudgetTotals table.

Table Specific Information

SELECT

The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:

• EventId supports =,!=

All other filters are handled client-side.

The following is an example of a SELECT statement:

SELECT * FROM BudgetTotals WHERE EventId='fee38876-e5c1-421f-a613-63f812501620'

Columns

Name	Type	References	Description
EventId [KEY]	String	Events.Id	The EventId of the BudgetTotals table.
LastModifiedDate	Datetime		The LastModifiedDate of the BudgetTotals table.
Currency	String		The Currency of the BudgetTotals table.
VersionId	String		The VersionId of the BudgetTotals table.
VersionName	String		The VersionName of the BudgetTotals table.
VersionDefault	String		The VersionDefault of the BudgetTotals table.
TotalHighLevelEstimateAmount	Double		The TotalHighLevelEstimateAmount of the BudgetTotals table.
CostDetailAggregate	String		The CostDetailAggregate of the BudgetTotals table.

Returns data from the ContactTypes table.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the ContactTypes table.
Code	String		The Code of the ContactTypes table.
Name	String		The Name of the ContactTypes table.
Description	String		The Description of the ContactTypes table.

Returns data from the Emails table.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the Emails table.
Subject	String		The Subject of the Emails table.
From	String		The From of the Emails table.
To	String		The To of the Emails table.
Type	String		The Type of the Emails table.
Sent	Datetime		The Sent of the Emails table.
Status	String		The Status of the Emails table.
Undeliverable	Boolean		The Undeliverable of the Emails table.
Opened	Boolean		The Opened of the Emails table.
FirstOpened	String		The FirstOpened of the Emails table.
Clicked	Boolean		The Clicked of the Emails table.
FirstClicked	String		The FirstClicked of the Emails table.
Bounced	Boolean		The Bounced of the Emails table.
Created	Datetime		The Created of the Emails table.
CreatedBy	String		The CreatedBy of the Emails table.
LastModified	Datetime		The LastModified of the Emails table.
LastModifiedBy	String		The LastModifiedBy of the Emails table.
EventId	String		The EventId of the Emails table.
ContactId	String		The ContactId of the Emails table.
AttendeeId	String		The AttendeeId of the Emails table.

Returns data from the EventOrderItems table.

Columns

Name	Type	References	Description
Id	String		The Id of the EventOrderItems table.
EventId	String	Events.Id	The EventId field of the EventOrderItems table.
Guest	Boolean		The Guest field of the EventOrderItems table.
Active	Boolean		The Active field of the EventOrderItems table.
Name	String		The Name field of the EventOrderItems table.
Price	Double		The Price field of the EventOrderItems table.
Quantity	Double		The Quantity field of the EventOrderItems table.
AmountOrdered	Double		The AmountOrdered field of the EventOrderItems table.
AmountPaid	Double		The AmountPaid field of the EventOrderItems table.
AmountDue	Double		The AmountDue field of the EventOrderItems table.
ProductPriceTierAmount	Double		The ProductPriceTierAmount field of the EventOrderItems table.
Tiered	Boolean		The Tiered field of the EventOrderItems table.
Deleted	Boolean		The Deleted field of the EventOrderItems table.
Created	Datetime		The Created field of the EventOrderItems table.
CreatedBy	String		The CreatedBy field of the EventOrderItems table.
LastModified	Datetime		The LastModified field of the EventOrderItems table.
LastModifiedBy	String		The LastModifiedBy field of the EventOrderItems table.
ProductId	String		The ProductId field of the EventOrderItems table.
ProductType	String		The ProductType field of the EventOrderItems table.
OrderId	String		The OrderId field of the EventOrderItems table.
OrderType	String		The OrderType field of the EventOrderItems table.
AttendeeId	String		The AttendeeId field of the EventOrderItems table.
GuestDetailId	String		The GuestDetailId field of the EventOrderItems table.
FeeId	String		The FeeId field of the EventOrderItems table.
FeeName	String		The FeeName field of the EventOrderItems table.
GeneralLedgerItemsId	String		The GeneralLedgerItemsId field of the EventOrderItems table.
GeneralLedgerItemsName	String		The GeneralLedgerItemsName field of the EventOrderItems table.
GeneralLedgerItemsCode	String		The GeneralLedgerItemsCode field of the EventOrderItems table.
GeneralLedgerItemsDescription	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
GeneralLedgerItemsAllocationPercentage	String		The GeneralLedgerItemsAllocationPercentage field of the EventOrderItems table.
DiscountsId	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
DiscountsName	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
DiscountsCode	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
DiscountsType	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
DiscountsValue	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.
DiscountsAmount	String		The GeneralLedgerItemsDescription field of the EventOrderItems table.

Returns data from the EventOrders table.

Columns

Name	Type	References	Description
Id	String		The Id of the EventOrders table.
EventId	String		The LastModifiedBy of the EventOrders table.
AttendeeId	String		The VenuesAggregate of the EventOrders table.
Number	String		The LanguagesAggregate of the EventOrders table.
Cancelled	Boolean		The PlannersAggregate of the EventOrders table.
Type	String		The StakeholdersAggregate of the EventOrders table.
InvoiceNumber	String		The StakeholdersAggregate of the EventOrders table.
AmountOrdered	Decimal		The StakeholdersAggregate of the EventOrders table.
AmountPaid	Decimal		The StakeholdersAggregate of the EventOrders table.
AmountDue	Decimal		The StakeholdersAggregate of the EventOrders table.
DiscountName	String		The StakeholdersAggregate of the EventOrders table.
DiscountCode	String		The StakeholdersAggregate of the EventOrders table.
DiscountType	String		The StakeholdersAggregate of the EventOrders table.
DiscountValue	String		The StakeholdersAggregate of the EventOrders table.
PaymentMethod	String		The StakeholdersAggregate of the EventOrders table.
ReferenceNumber	String		The StakeholdersAggregate of the EventOrders table.
Created	Datetime		The StakeholdersAggregate of the EventOrders table.
CreatedBy	String		The StakeholdersAggregate of the EventOrders table.
LastModified	Datetime		The StakeholdersAggregate of the EventOrders table.
LastModifiedBy	String		The StakeholdersAggregate of the EventOrders table.

Returns data from the EventQuestions table.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the EventQuestions table.
Text	String		The Text of the EventQuestions table.
Code	String		The Code of the EventQuestions table.
Tag	String		The Tag of the EventQuestions table.
Created	Datetime		The Created of the EventQuestions table.
CreatedBy	String		The CreatedBy of the EventQuestions table.
LastModified	Datetime		The LastModified of the EventQuestions table.
LastModifiedBy	String		The LastModifiedBy of the EventQuestions table.
EventId	String		The EventId of the EventQuestions table.

Returns data from the EventSurveyResponses table.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the EventSurveyResponses table.
Score	String		The Score of the EventSurveyResponses table.
Created	Datetime		The Created of the EventSurveyResponses table.
CreatedBy	String		The CreatedBy of the EventSurveyResponses table.
LastModified	Datetime		The LastModified of the EventSurveyResponses table.
LastModifiedBy	String		The LastModifiedBy of the EventSurveyResponses table.
EventId	String		The EventId of the EventSurveyResponses table.
SurveyId	String		The SurveyId of the EventSurveyResponses table.
SessionId	String		The SessionId of the EventSurveyResponses table.
SpeakerId	String		The SpeakerId of the EventSurveyResponses table.
RespondentId	String		The RespondentId of the EventSurveyResponses table.
QuestionId	String		The QuestionId of the EventSurveyResponses table.
AnswersAggregate	String		The AnswersAggregate of the EventSurveyResponses table.

Returns data from the SessionDocuments table.

Columns

Name	Type	References	Description
Href	String		The Href of the SessionDocuments table.
SessionId [KEY]	String	Sessions.Id	The SessionId of the SessionDocuments table.
FriendlyName	String		The FriendlyName of the SessionDocuments table.
Type	String		The Type of the SessionDocuments table.
Size	String		The Size of the SessionDocuments table.
DisplayEnabled	Boolean		The DisplayEnabled of the SessionDocuments table.
FileId	String		The FileId of the SessionDocuments table.

Returns data from event and standalone surveys associated to an account.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the Surveys table.
EventId	String		The EventId of the StandaloneSurveys table.
ResponseCount	String		The responseCount of the Surveys table.
Status	String		The Status of the Surveys table.
Type	String		The type of the Surveys table.
ActivateDate	String		The AudienceType of the Surveys table.
Title	String		The title of the Surveys table.
Code	String		The code of the Surveys table.
Timezone	String		The Timezone of the Surveys table.
Description	String		The Description of the Surveys table.
CloseAfter	String		The CloseAfter of the Surveys table.
Created	Datetime		The Created of the Surveys table.
CreatedBy	String		The CreatedBy of the Surveys table.
LastModified	Datetime		The LastModified of the Surveys table.
LastModifiedBy	String		The LastModifiedBy of the Surveys table.
AuthorFirstName	String		The AuthorFirstName of the Surveys table.
AuthorLastName	String		The AuthorLastName of the Surveys table.
AuthorCompany	String		The AuthorCompany of the Surveys table.
AuthorTitle	String		The AuthorTitle of the Surveys table.
AuthorEmail	String		The AuthorEmail of the Surveys table.

Returns data from the surveys associated to a single event.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the Surveys table.
EventId [KEY]	String	Events.Id	The EventId of the Surveys table.
Type	String		The Type of the Surveys table.
AvailableTo	String		The AvailableTo of the Surveys table.
AudienceType	String		The AudienceType of the Surveys table.
SessionMatch	String		The SessionMatch of the Surveys table.
ParentId	String		The ParentId of the Surveys table.
Title	String		The Title of the Surveys table.
Code	String		The Code of the Surveys table.
Timezone	String		The Timezone of the Surveys table.
Description	String		The Description of the Surveys table.
CloseAfter	String		The CloseAfter of the Surveys table.
Created	Datetime		The Created of the Surveys table.
CreatedBy	String		The CreatedBy of the Surveys table.
LastModified	Datetime		The LastModified of the Surveys table.
LastModifiedBy	String		The LastModifiedBy of the Surveys table.
SessionsAggregate	String		The SessionsAggregate of the Surveys table.
AuthorFirstName	String		The AuthorFirstName of the Surveys table.
AuthorLastName	String		The AuthorLastName of the Surveys table.
AuthorCompany	String		The AuthorCompany of the Surveys table.
AuthorTitle	String		The AuthorTitle of the Surveys table.
AuthorEmail	String		The AuthorEmail of the Surveys table.

ストアドプロシージャはファンクションライクなインターフェースで、Cvent の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにCvent から関連するレスポンスデータを返します。

Cvent Connector for CData Sync ストアドプロシージャ

Name	Description
AssignContactProfilePicture	Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB.

Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB.

Input

Name	Type	Required	Description
ContactId	String	False	Full local file path, including the file name, for the file being uploaded. This field is mandatory if FileData is not provided.
FileId	String	False	Base-64 encoded string containing the entire contents of the file. Use this field when LocalFile is not provided.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file upload operation completed successfully. Returns true for success and false for failure.

Gets an authentication token from Cvent.

Input

Name	Type	Required	Description
AuthMode	String	False	The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. 使用できる値は次のとおりです。APP, WEB デフォルト値はAPPです。
Scope	String	False	A comma-separated list of permissions to request from the user. Please check the Cvent API for a list of available permissions.
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Cvent app settings. Only needed when the Authmode parameter is Web.
Verifier	String	False	The verifier returned from Cvent after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State	String	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Cvent authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns

Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Cvent.
OAuthRefreshToken	String	The OAuth refresh token. This is the same as the access token in the case of Cvent.
ExpiresIn	String	The remaining lifetime on the access token. A -1 denotes that it will not expire.

Uploads a file and returns a unique ID to identify the file. The file must be less than 10MB.

Input

Name	Type	Required	Description
LocalFile	String	False	Full local file path, including the file name, for the file being uploaded. This field is mandatory if FileData is not provided.
FileData	String	False	Base-64 encoded string containing the entire contents of the file. Use this field when LocalFile is not provided.
FileName	String	False	Desired name for the uploaded file in CVent. If left blank, the name from LocalFile will be used. Required when FileData is provided.

Result Set Columns

Name	Type	Description
Success	String	Indicates whether the file upload operation completed successfully. Returns true for success and false for failure.
Id	String	Unique internal identifier assigned to the uploaded file

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

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

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

SSL

---

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

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecret	カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）
Scope	データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります：

• カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
• ドライバーが埋め込みOAuth 資格情報を提供しない場合。

（ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。）

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ）

解説

このプロパティ（アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます）は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes：

• この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
• クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

データへの適切なアクセスを確実にするために、認証ユーザーのアプリケーションへのアクセス範囲を指定します。 カスタムOAuth アプリケーションが必要な場合は、通常、アプリケーションの作成時に指定します。

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。

InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、このプロパティまたはScope 入力を使用して、要求するスコープを変更できます。

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

---

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

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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

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

---

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

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

解説

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

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

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

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

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

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

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

---

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

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

解説

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

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

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

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

解説

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

ProxyAutoDetect がTrue（デフォルト）に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

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

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

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

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としないことを示します。

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

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

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 接続プロパティは設定しないでください。

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

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

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

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

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

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

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

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

解説

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

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

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

解説

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

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

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

---

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

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

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

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

---

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

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

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

解説

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

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

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

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

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

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

統合およびフォーマット

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

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

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

解説

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

次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

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

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.