このページでは、CData Cloud でのFreshdesk への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Freshdesk への接続

接続の確立 は、CData Cloud にデータベースを作成するためのFreshdesk への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してFreshdesk からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Freshdesk に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Connecting to Freshdesk

Freshdesk makes use of basic authentication. To connect to data, set the following connection properties:

• Domain: Set this to the domain associated with your Freshdesk account. For example, in your URL, https://{domainValue}.freshdesk.com, thus the connection string should be:

  Domain=domainValue

• APIKey: Set this to the API key associated with your Freshdesk account. To retrieve your API key, log in to your support Portal. Click the profile picture in the upper-right corner and select the profile settings page. The API key is available below the change password section to the right.

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Overview

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

Key Features

• The Cloud models Freshdesk entities as relational tables, allowing you to write SQL to query Freshdesk data.
• Live connectivity to these objects means any changes to your Freshdesk account are immediately reflected when using the Cloud.

Tables

テーブル describes the available tables. Tables are statically defined to model Tickets, Conversations, Agents, and more.

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

CData Cloud - Freshdesk テーブル

Update, delete, and query from agents table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Agents WHERE Id = 100

Note: To query Agents table, All Agent APIs other than the Currently Authenticated Agent API require admin privileges.

Update

Following is an example of how to update an agent:

UPDATE Agents SET GroupIdsAggregate = '111' WHERE Id = 100

Delete

Following is an example of how to delete an agent:

DELETE FROM Agents WHERE Id = 100

Columns

Query from BusinessHours table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from BusinessHours table:

SELECT * FROM BusinessHours

You can also select a specific entry from BusinessHours table:

SELECT * FROM BusinessHours WHERE Id = 100

Columns

Create, update and query from CannedResponses table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

To query the CannedResponses table, FolderId should be mentioned in the WHERE clause. For example:

SELECT * FROM CannedResponses WHERE FolderId = 100

Insert

FolderId, Visibility, Title and ContentHTML are mandatory columns for Inserting into CannedResponses tables. For example:

INSERT INTO CannedResponses (Title, ContentHTML, Visibility, FolderId) VALUES (Sample response, 'this is also a new sample response', 0, 100)

Update

Following is an example to update a row in CannedResponses table:

UPDATE CannedResponses SET Title = 'Updated title' WHERE Id = 100

Columns

Query from CannedResponsesFolder table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from CannedResponsesFolder table:

SELECT * FROM CannedResponsesFolder

You can also select a specific entry from CannedResponsesFolder table:

SELECT * FROM CannedResponsesFolder WHERE Id = 100

Insert

Name is a mandatory columns for Inserting into CannedResponsesFolder table.

INSERT INTO CannedResponsesFolder (Name) VALUES (directoryA)

Update

Following is an example to update CannedResponsesFolder:

UPDATE CannedResponsesFolder SET Name = 'updated name' WHERE Id = 100

Columns

Create, update, delete, and query from companies table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Companies WHERE CreatedAt >= '2017-10-01' AND CreatedAt <= '2017-10-07'

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

• Id
• DomainAggregate
• CreatedAt
• UpdatedAt

Note: To filter all companies created on a specific day (e.g: 2019-09-23), query should be structured as:

WHERE CreatedAt >= '2019-09-22' AND CreatedAt <= '2019-09-24' 

Insert

Name is mandatory for creating a new company. Following is an example of creating a new company:

INSERT INTO Companies (Name, Description) VALUES ('Example', 'Example description of new company')

Update

Following is an example of how to update a company:

UPDATE Companies SET Description = 'New description' WHERE Id = 786

Delete

Following is an example of how to delete from Companies table:

DELETE FROM Companies WHERE Id = 786

Columns

Create, update, delete, and query from contacts table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Contacts WHERE Active = false AND (Email = '[email protected]' OR CompanyId = 1)

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

• Id
• Active
• CompanyId
• Email
• Language
• Tag
• TimeZone
• CreatedAt
• UpdatedAt

Note: To filter all contacts created on a specific day (e.g: 2019-09-23), query should be structured as:

WHERE CreatedAt >= '2019-09-22' AND CreatedAt <= '2019-09-24'

Insert

Name and Email are mandatory for creating a new contact. Following is an example of creating a new contact:

INSERT INTO Contacts (Name, Email, Language) VALUES ('Example', '[email protected]', 'English')

Update

Following is an example of how to update a contact:

UPDATE Contacts SET Active = true WHERE Id = 786

Delete

Following is an example of how to delete from Contacts table:

DELETE FROM Contacts WHERE Id = 786

Columns

Delete, and query from conversations table

Table Specific Information

Select

To query the Conversations table, TicketId should be mentioned in the WHERE clause. For example:

SELECT * FROM Conversations WHERE TicketId = 100

Note: The Conversations table can only be filtered on TicketId.

Delete

Following is an example of how to delete from the Conversations table:

DELETE FROM Conversations WHERE Id = 786

Columns

Create, update, delete, and query from groups table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Groups WHERE Id = 100

Note: Only users with admin privileges can access this Table.

Insert

Name is a mandatory column for inserting into Groups table. For example:

INSERT INTO Groups (Name, Description, AutoTicketAssign) VALUES ('Example', 'Example Description...', false)

Update

Following is an example of how to update a group:

UPDATE Groups SET Description = 'New description...' WHERE Id = 100

Delete

Following is an example of how to delete from Groups table:

DELETE FROM Groups WHERE Id = 786

Columns

Create, update, delete, and query from Mailboxes table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from Mailboxes table:

SELECT * FROM Mailboxes

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

• Id
• SupportEmail
• ForwardEmail
• ProductId
• GroupId
• Active

Insert

SupportEmail and MailboxType are mandatory to Insert into Mailboxes table. For instance:

INSERT INTO Mailboxes (SupportEmail, Name, MailboxType) VALUES ('[email protected]', 'Test', 'freshdesk_mailbox')

Update

UPDATE Mailboxes SET Name = 'Test mailbox' WHERE Id = 786

Delete

Following is an example of how to delete from the Mailboxes table:

DELETE FROM Mailboxes WHERE Id = 786

Columns

Query from products table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from Products table:

SELECT * FROM Products

You can also select a specific entry from Products table:

SELECT * FROM Products WHERE Id = 100

Columns

Query from roles table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Roles WHERE Id = 100

Note: Only users with admin privileges can access the following Table. Following is an example of selecting a role:

Columns

Create, update, delete, and query from skills table

Table Specific Information

Select

Following is an example to select all entries from Skills table:

SELECT * FROM Skills

You can also select a specific entry from Skills table:

SELECT * FROM Skills WHERE Id = 73000001322

Insert

Name is mandatory for creating a new skill. Following is an example of creating a new skill:

INSERT INTO Skills (Name) VALUES ('Example')

Update

Following is an example of how to update a skill:

UPDATE Skills SET Name = 'New name' WHERE Id = 73000001322

Delete

Following is an example of how to delete from Skills table:

DELETE FROM Skills WHERE Id = 73000001322

Columns

Query, Create and Update SLAPolicies table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from SLAPolicies table:

SELECT * FROM SLAPolicies

You can also select a specific entry from SLAPolicies table:

SELECT * FROM SLAPolicies WHERE Id = 100

Columns

Query from surveys table

Table Specific Information

Select

Following is an example to select all entries from Surveys table:

SELECT * FROM Surveys

You can also select a specific entry from Surveys table:

SELECT * FROM Surveys WHERE Id = 73000092562

Columns

Create, update, delete, and query from TicketCreationAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TicketCreationAutomationRules table:

SELECT * FROM TicketCreationAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

• Id

Insert

Name, Actions, and Conditions are mandatory to Insert into TicketCreationAutomationRules table. For instance:

INSERT INTO TicketCreationAutomationRules (Name, Actions, Conditions) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]')

Update

UPDATE TicketCreationAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TicketCreationAutomationRules table:

DELETE FROM TicketCreationAutomationRules WHERE Id = '2043002030021'

Columns

Query from ticketFields table

Table Specific Information

Note: Users whose credentials (identified by the API key) are used to access the Table should be authorised to either view the ticket fields or create a new ticket.

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support client side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed server side within the Cloud. For example, the following query is processed server side:

SELECT * FROM TicketFields WHERE Type = 'default_requester'

The Freshdesk API allows only the following column(s) to be used as filter criteria in the WHERE clause:

• Type

Insert

Label, LabelForCustomers and Type are mandatory columns for Inserting into TicketFields table.

INSERT INTO TicketFields (Label, LabelForCustomers, Type) VALUES ('labelA', 'labelA', custom_text)

Update

Following is an example to update TicketFields:

UPDATE TicketFields SET Label = 'updated label' WHERE Id = 100

Delete

Following is an example to delete a TicketFields:

DELETE FROM TicketFields WHERE Id = 100

Columns

Create, update, delete, and query from tickets table

Table Specific Information

Select

The Cloud will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the Cloud. For example, the following query is processed server side:

SELECT * FROM Tickets WHERE Status = 2 AND (Priority = 1 OR Type = 'Other')

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

• Id
• AgentId
• GroupId
• Priority
• Status
• Tag
• Type
• DueBy
• FirstResponseDueBy
• CreatedAt
• UpdatedAt

Insert

Email, Subject, Description, GroupId, Status and Priority are mandatory columns for Inserting/Creating a new ticket.

Every ticket uses fixed numerical values to denote its Status and Priority. Numerical values are given as:

Status:

• Open = 2
• Pending = 3
• Resolved = 4
• Closed = 5

Priority:

• Low = 1
• Medium = 2
• High = 3
• Urgent = 4

A new ticket can be inserted as following:

INSERT INTO Tickets (Description, Subject, Email,  GroupId, Status, Priority) VALUES ('Details about the issue...', 'New support needed...', '[email protected]', 12345, 3, 2)

Update

Following is an example to update a ticket:

UPDATE Tickets SET Priority = 1 WHERE Id = 100

Delete

Following is an example to delete a ticket:

DELETE FROM Tickets WHERE Id = 100

Columns

Create, update, delete, and query from TicketUpdatesAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TicketUpdatesAutomationRules table:

SELECT * FROM TicketUpdatesAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

• Id

Insert

Name, Actions, Conditions, Performer, and Events are mandatory to Insert into TicketUpdatesAutomationRules table. For instance:

INSERT INTO TicketUpdatesAutomationRules (Name, Actions, Conditions, Performer, Events) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]', '{"type": 1}', '[{"field_name": "reply_sent"}]')

Update

UPDATE TicketUpdatesAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TicketUpdatesAutomationRules table:

DELETE FROM TicketUpdatesAutomationRules WHERE Id = '2043002030021'

Columns

Create, update, delete, and query from TimeEntries table

Table Specific Information

Select

Following is an example to select all entries from TimeEntries table:

SELECT * FROM TimeEntries

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

• AgentId
• Billable
• ExecutedAt

Insert

TicketId is mandatory to INSERT into the TimeEntries table. For instance:

INSERT INTO TimeEntries (TicketId, Note, AgentId) VALUES ('255', 'Invoice Information', '122')

Note:

• The TicketId is required field to INSERT into TimeEntries table.
• Default value for Billable is true.
• If the TimeSpent attribute and the TimerRunning attribute are not specified, then the TimerRunning attribute will automatically be set to 'true'.
• If the StartTime is specified and the TimerRunning attribute is not specified, then the TimerRunning attribute will automatically be set to 'true'.
• The StartTime cannot be greater than the current time.
• The StartTime cannot be given in the query if the TimerRunning attribute is set to 'false'

Update

UPDATE TimeEntries SET Billable = 'true' WHERE Id = 786

Note:

• The StartTime cannot be updated if the timer is already running.
• The StartTime cannot be be updated unless the timer_running attribute is updated from 'true' to 'false'.
• The StartTime cannot be greater than the current time.
• The TimerRunning attribute cannot be set to the same value as before.
• The AgentId cannot be updated if the timer is already running.

Delete

Following is an example of how to delete from the TimeEntries table:

DELETE FROM TimeEntries WHERE Id = 786

Columns

Create, update, delete, and query from TimeTriggersAutomationRules table

Table Specific Information

Note: Only users with admin privileges can access the following Table.

Select

Following is an example to select all entries from TimeTriggersAutomationRules table:

SELECT * FROM TimeTriggersAutomationRules

The API allows only a subset of columns to be used as filter criteria in the WHERE clause. The filters listed can also be combined using AND OR. The following columns can be used:

• Id

Insert

Name, Actions, and Conditions are mandatory to Insert into TimeTriggersAutomationRules table. For instance:

INSERT INTO TimeTriggersAutomationRules (Name, Actions, Conditions) VALUES ('Test', '[{"field_name": "status", "value": 5}]', '[{"name": "condition_set_1", "match_type": "any", "properties": [{"field_name": "to_email", "resource_type": "ticket", "operator": "contains", "value": ["@lyftron.com"]}]}]')

Update

UPDATE TimeTriggersAutomationRules SET Name = 'Test2' WHERE Id = '2043002030021'

Delete

Following is an example of how to delete from the TimeTriggersAutomationRules table:

DELETE FROM TimeTriggersAutomationRules WHERE Id = '2043002030021'

Columns

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

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

CData Cloud - Freshdesk ビュー

Retrieve the available Custom Objects in FreshDesk.

Table Specific Information

Select

Following is an example to select all entries from the CustomObjects table:

SELECT * FROM CustomObjects

You can also select a specific entry from the CustomObjects table:

SELECT * FROM CustomObjects WHERE Id = 11704

Columns

Query the TicketActivities view.

Table Specific Information

Select

Following is an example to select all entries from the TicketActivities table:

SELECT * FROM TicketActivities

Columns

Query the TicketProperties view.

Table Specific Information

Select

Following is an example to select all entries from the TicketProperties table:

SELECT * FROM TicketProperties

Columns

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

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

CData Cloud - Freshdesk ストアドプロシージャ

Create or update a ticket with attachments.

To edit an existing ticket, supply a value for the Id column:

EXEC AttachToTicket Id = 100000 FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

You can also supply ticket fields to update the ticket alongside adding attachments:

EXEC AttachToTicket Id = 100000, Status = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

If you do not include a value for the Id column, the Cloud creates a new ticket with the provided values. At a minimum, you must provide an Email, Description, Subject, Status, and Priority. Other fields may be required for ticket creation based on the ticket rules set up on your Freshdesk account.

EXEC AttachToTicket Email = '[email protected]', Description = 'Sample Description', GroupId = 2222222222222, Status = 3, Subject = 'Testing', Priority = 3, FullPath = 'C:/Users/Public/A.txt,C:/Users/Public/B.txt', FileName = 'Attachment1,Attachment2'

Input

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Freshdesk のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Tickets テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tickets' 

Columns

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

ストアドプロシージャパラメータについて説明します。

次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columns

主キーおよび外部キーについて説明します。

次のクエリは、Tickets テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tickets' 
          

Columns

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Authentication

SSL

Logging

Schema

Miscellaneous

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

Domain is used for accessing your Freshdesk account.

データ型

string

デフォルト値

""

解説

Domain is used for accessing your Freshdesk account. For example, in your URL: https://{domainValue}.freshdesk.com, thus connection string should be:

Domain=domainValue

The API key used for accessing your Freshdesk account.

データ型

string

デフォルト値

""

解説

The API key used for accessing your Freshdesk account. The API key can be found in Freshdesk by going to Profile Settings -> API Key.

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

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

データ型

string

デフォルト値

""

解説

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

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

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

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

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

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

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

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

データ型

string

デフォルト値

""

解説

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

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

Use FetchTicketsUpdatedSince to query tickets older than 30 days. Note: TicketStats must be set to True.

データ型

string

デフォルト値

""

解説

When TicketStats = true, all requests (including filtering request) would be sent to the 'List all' endpoint. The 'List all' endpoint only retrieves the tickets created in the last 30 days, unless FetchTicketsUpdatedSince is set to a specifed date. Set FetchTicketsUpdatedSince to a specified date to retrieve tickets created past the last 30 days. (Example: FetchTicketsUpdatedSince=2022-01-01 or FetchTicketsUpdatedSince=2022-01-01T00:00:00Z)

Use IgnoreSurplusResults to ignore results beyond 300 which have same CreatedAt value.

データ型

bool

デフォルト値

false

解説

By default, FreshDesk API only returns upto 300 results matching a specific filter. Paging mechanism of the driver uses CreatedAt attribute as a filter, thus more than 300 results with same CreateAt value will cause paging to fail. IgnoreSurplusResults will cause these surplus results to be ignored without causing an exception and keep retrieving results.

Whether to include custom objects or not.

データ型

bool

デフォルト値

false

解説

If set to TRUE, the custom objects are retrieved. Note: You must have the Custom Objects feature enabled to use this property.

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

データ型

int

デフォルト値

-1

解説

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

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

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

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

データ型

string

デフォルト値

""

解説

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

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

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

Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.

データ型

string

デフォルト値

"30"

解説

Determines the number of rows used to determine the column data types.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Use TicketPropertiesURL to query ticket properties.

データ型

string

デフォルト値

""

解説

Set TicketPropertiesURL to the API URL that is found on the Schedule page of the created Scheduled Export. To find this, go to Reports/Schedule an export/Click on the name of the Schedule and the URL is under the Receive via API section.

Determines which ticket field to order by.

Possible Values

データ型

string

デフォルト値

"None"

解説

Determines which ticket field to order by.

Possible Values

データ型

string

デフォルト値

"None"

解説

Use TicketsStats to retrieve stats attributes of a ticket, which are not normally available.

データ型

bool

デフォルト値

false

解説

When TicketStats = true, all requests (including filtering request) would be sent to the 'List all' endpoint. This would slightly affect the performance by handling filtering client-side, but would retrieve stats attributes of each ticket. 'List all' endpoint only retrieves the tickets created in the last 30 days.

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

データ型

int

デフォルト値

60

解説

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

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

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

Determines how to determine the data type of columns.

Possible Values

データ型

string

デフォルト値

"RowScan"

解説