接続の確立

Sync App アプリケーションの接続ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Money Forward Expense への接続を作成します。Money Forward Expense アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMoney Forward Expense コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Money Forward Expense はOAuth 2 認証標準を利用しています。Money Forward Expense にアプリケーションを登録し、OAuthClientId およびOAuthClientSecret を取得する必要があります。認証方法については、MoneyForward Expense への接続を参照してください。

また、ほとんどのテーブルを操作するためにOfficeId プロパティを指定する必要があります。

MoneyForward Expense への接続

OAuth では認証するユーザーにブラウザでMoney Forward Expense との通信を要求します。次のセクションで説明するとおり、Sync App はさまざまな方法でこれをサポートします。

Money Forward Expense へのアクセスを設定

次の手順に従って、OAuth クライアントクレデンシャル、OAuthClientId、OAuthClientSecret、およびCallbackURL を取得できます。

Money Forward Expense アカウントにログインして［For Developer］セクションの［API 連携（開発者向け）］をクリックします。
［アプリケーションの作成］をクリックします。
Redirect URI をCallbackURL デフォルト値のhttps://oauth.cdata.com/oauth/ に設定します。

Note：Money Forward Expense にはHTTPS Redirect URI が必要です。
Scope を"office_setting:write user_setting:write transaction:write report:write account:write public_resource:read" に設定します。
変更を保存し、クライアントID、クライアントシークレット、Callback URL を記録します。これらの値は、OAuth による認証管理に必要です。

Money Forward Expense への認証

次の接続プロパティを設定して、接続してください。

OAuthClientId：アプリケーションの作成後に受け取ったクライアントID に設定。
OAuthClientSecret：アプリケーションの作成後に受け取ったクライアントシークレットに設定。
CallbackURL：アプリケーション設定で指定したCallback URL に設定。
OfficeId：指定した事業所にクエリ結果を制限するために設定。これはほとんどのクエリで必須です。

接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。CallbackURL にリダイレクトされます。ブラウザにセキュリティエラーが表示されます。

Money Forward Expense からマシンへのリダイレクトは安全ですが、エラーが発生しても続行するには、ブラウザでCallbackURL のセキュリティ例外を追加する必要があります。

リダイレクトを許可すると、Sync App がOAuth プロセスを完了します：

Callback URL からアクセストークンを取得し、リクエストを認証します。
古いトークンの期限が切れたときは、新しいアクセストークンを取得します。

高度な機能

このセクションでは、Money Forward Expense Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Money Forward Expense にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

データモデル

CData Sync App は、Money Forward Expense API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらは、テキストベースの拡張可能なコンフィギュレーションファイルであるスキーマファイルにて定義されます。

テーブルおよびビュー

次のセクションでは、使用可能なAPI テーブルおよびビューへのSQL の実行について説明します。Sync App は、Money Forward Expense にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。API の制限事項および要件については、このセクションで説明します。 Sync App がクライアントサイドのインメモリ処理でAPI 制限を回避する方法の詳細については、SupportEnhancedSQL を参照してください。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

テーブル

Sync App はMoney Forward Expense のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Money Forward Expense テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Money Forward Expense Connector for CData Sync テーブル


Name	Description
Departments	部門一覧を作成、更新、削除、およびクエリします。
MyTransactions	自分の経費明細を作成、更新、削除、およびクエリします。
OfficeMembers	事業所に所属するメンバーをクエリおよび削除します。
OfficeMemberSettings	メンバーの経費設定を作成、更新、およびクエリします。
OfficeMemberWorkflows	メンバーのワークフロー設定を作成、更新、削除、およびクエリします。
Positions	役職を作成、更新、削除、およびクエリします。
Projects	プロジェクトを作成、更新、削除、およびクエリします。

Departments

部門一覧を作成、更新、削除、およびクエリします。

テーブル固有の情報

SELECT

事業所のすべての部門のリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。

Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Departments

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Insert

部門を挿入するには、次のカラムが必要です：OfficeId およびName。

INSERT INTO Departments (OfficeId, Name, Code, Memo) VALUES ('OfficeId123', 'OfficeName123', 'DepCode123', 'Memo123')

Update

部門を更新するには、次のカラムが必要です：OfficeId およびId。

UPDATE Departments SET Name='NewDepName', Code='NewDepCode', Memo='NewDepMemo' WHERE OfficeId='1234' AND Id='12345'

Delete

部門を削除するには、次のカラムが必要です：OfficeId およびId。

DELETE FROM Departments WHERE OfficeId = '12345' AND Id = '123456'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	部門Id。
OfficeId [KEY]	String	False	事業所Id。
Name	String	False	部門名称。
Code	String	False	コード。
Memo	String	False	メモ。
ParentId	String	False	親部門Id。
RootId	String	True	最上位親部門Id。

MyTransactions

自分の経費明細を作成、更新、削除、およびクエリします。

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	役職Id。
OfficeId [KEY]	String	False	事業所Id。
Remark	String	False	支払先・内容。
Value	Double	False	金額。
ItemId	String	False	経費科目Id。
RecognizedAt	Date	False	支払日。
Number	Integer	True	明細番号。
Memo	String	False	メモ。
JpyRate	Double	False	為替レート。
Currency	String	False	通貨。
UseCustomJypRate	Boolean	False	為替レートを手動設定するかどうかを示します。
AutomaticStatus	String	True	ステータス。
ErrorMessage	String	True	エラーメッセージ。
WarningMessage	String	True	ワーニングメッセージ。
WaitingMessage	String	True	待機メッセージ。
OfficeMemberId	String	True	メンバーId。
CreditItemId	String	False	貸方勘定科目Id。
CreditSubItemId	String	False	貸方補助科目Id。
ExciseId	String	False	税区分Id。
DepartmentId	String	False	部門Id。
ProjectId	String	False	プロジェクトId。
CreatedAt	Datetime	True	登録日時。
UpdatedAt	Datetime	True	更新日時。

OfficeMembers

事業所に所属するメンバーをクエリおよび削除します。

テーブル固有の情報

SELECT

事業所のすべてのメンバーのリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。 Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM OfficeMembers

メンバーがUI から作成され、アクセス許可が与えられていない場合、カラムPermissionRoleID の値は0 になる場合があります。
SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Insert

事業所メンバーを挿入するには、次のカラムが必要です：OfficeId、Email、およびPermissionRoleID。
PermissionRoleID には次の値のみを設定できます：201：一般利用者、202：承認者、203：管理者。
-PermissionRoleID = 201 の場合、IsExUser はtrue に設定されます
-PermissionRoleID = 202 の場合、IsExUser、IsExAuthorizer はtrue に設定されます
-PermissionRoleID = 203 の場合、IsExUser、IsExAuthorizer、IsExAdministrator がtrue に設定されます
Departments は集約フィールドであるため、挿入および更新の値は、Department Id 属性のみを持つオブジェクトの配列を含むjson 文字列になります

INSERT INTO OfficeMembers(OfficeId, Email, PermissionRoleID) VALUES('12345', '[email protected]', '201')

INSERT INTO OfficeMembers(OfficeId, Email, PermissionRoleID, PositionID, Departments) VALUES('23457', '[email protected]', '202', '2457', '[{"id": "7457"},{"id": "24577"}]')

Update

OfficeMember を更新するには、OfficeMember ID とOfficeID を指定する必要があります。

UPDATE OfficeMembers SET Name='hello new', Number='hello new', PermissionRoleID=203 WHERE ID='345' AND OfficeID='123'

UPDATE OfficeMembers SET  Name='hey world', Number='346', PermissionRoleID=201, PositionID='2457754', Departments='[{\"id\": \"457\"},{\"id\": \"346\"}]' WHERE ID='345' AND OfficeID='346'

Delete

事業所メンバーを削除するには、次のカラムが必要です：OfficeId、Id。

DELETE FROM OfficeMembers WHERE OfficeId = '12345' AND Id = '123456'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	メンバーId。
OfficeId [KEY]	String	True	事業所Id。
IdentificationCode	String	True	メンバー識別番号。
Name	String	False	メンバー名。
Number	Integer	False	従業員番号。
CreatedAt	Datetime	True	メンバー追加日時。
UpdatedAt	Datetime	True	メンバー更新日時。
IsExUser	Boolean	True	MF クラウド経費の一般権限を持つかどうか。
IsExAuthorizer	Boolean	True	MF クラウド経費の承認権限を持つかどうか。
IsExAdministrator	Boolean	True	MF クラウド経費の管理者権限を持つかどうか。
PositionId	String	True	役職Id。
PositionName	String	True	役職名称。
PositionPriority	Integer	True	表示優先順（昇順）。
PermissionRoleID	String	False	権限ロールID（挿入時に必要。201：一般利用者、202：承認者、203：管理者）
Departments	String	False	Aggregate field representing departments of an office member.

OfficeMemberSettings

メンバーの経費設定を作成、更新、およびクエリします。

テーブル固有の情報

SELECT

事業所メンバーの設定を取得するには、WHERE 句でOfficeId およびOfficeMemberId カラムが必要です。指定しない場合は、すべての事業所メンバーの設定が返されます。

Sync App はMoney Forward Expense API を使用してOfficeId およびOfficeMemberId を参照する検索条件を処理します。Sync App はクライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM OfficeMemberSettings WHERE OfficeId = '1234' AND OfficeMemberId = '12345'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

INSERT

挿入は、このテーブルではサポートされていません。

UPDATE

事業所メンバーの設定を更新するには、次のカラムが必要です：OfficeId およびOfficeMemberId。

UPDATE OfficeMemberSettings SET UseAgent = false, ApprovingPriority = 1234, ProjectId = '1234', CreditItemId = '1234', CreditSubItemId = '1234', TransportationItemId = '1234', DrivingItemId = '1234' WHERE OfficeMemberId = '1234' AND OfficeId = '123456'

Delete

削除は、このテーブルではサポートされていません。

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	経費設定Id。
OfficeId [KEY]	String	False	事業所Id。
OfficeMemberId [KEY]	String	False	経費メンバー設定Id。
UseAgent	Boolean	False	代理承認オンフラグ。
ApprovingPriority	Integer	False	承認優先順位。
ProjectId	String	False	立替経費デフォルトプロジェクトId。
ProjectName	String	True	立替経費デフォルトプロジェクト名称。
ProjectCode	String	True	立替経費デフォルトプロジェクトコード。
CreditItemId	String	False	立替経費デフォルト貸方科目Id。
CreditItemExciseId	String	True	立替経費デフォルト貸方科目税区分Id。
CreditItemName	String	True	立替経費デフォルト貸方科目名称。
CreditItemCode	String	True	立替経費デフォルト貸方科目コード。
CreditSubItemId	String	False	立替経費デフォルト貸方補助科目Id。
CreditSubItemItemId	String	True	立替経費デフォルト貸方補助科目勘定科目Id。
CreditSubItemExciseId	String	True	立替経費デフォルト貸方補助科目税区分Id。
CreditSubItemName	String	True	立替経費デフォルト貸方補助科目名称。
CreditSubItemCode	String	True	立替経費デフォルト貸方補助科目コード。
TransportationItemId	String	False	経路から立替経費登録デフォルト経費科目Id。
TransportationItemName	String	True	経路から立替経費登録デフォルト経費科目名称。
DrivingItemId	String	False	移動距離から立替経費登録デフォルト経費科目Id。
DrivingItemName	String	True	移動距離から立替経費登録デフォルト経費科目名称。

OfficeMemberWorkflows

メンバーのワークフロー設定を作成、更新、削除、およびクエリします。

テーブル固有の情報

SELECT

事業所メンバーのワークフローのリストを取得するには、OfficeId およびOfficeMemberId カラムが必要です。指定しない場合は、すべての事業所メンバーのワークフローがMoney Forward Expense サーバーによって返されます。

Sync App はMoney Forward Expense API を使用してOfficeId およびOfficeMemberId を参照する検索条件を処理します。Sync App はクライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM OfficeMemberWorkflows WHERE OfficeId='1234' AND OfficeMemberId = '12345'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

INSERT

事業所メンバーにワークフローを挿入するには、次のカラムが必要です：OfficeId、OfficeMemberId、WorkFlowId、およびReportTypeId。

INSERT INTO OfficeMemberWorkflows (OfficeId, OfficeMemberId, WorkFlowId, ReportTypeId) VALUES ('123', '12345', '123456', '1234567')

UPDATE

事業所メンバーのワークフローを更新するには、次のカラムが必要です：Id、OfficeId、OfficeMemberId、WorkFlowId、およびReportTypeId。

UPDATE OfficeMemberWorkflows SET WorkFlowId = '123', ReportTypeId = '1234' WHERE OfficeId = '12345' AND OfficeMemberId = '123456' AND Id = '1234567'

DELETE

削除は、このテーブルではサポートされていません。

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	メンバーワークフロー設定Id。
OfficeId [KEY]	String	False	事業所Id。
OfficeMemberId [KEY]	String	False	メンバーId。
WorkflowId	String	False	承認ルートId。
ReportTypeId	String	False	申請種別Id。
ReportTypeName	String	True	申請種別名称。
ReportTypeUseTransactionReserves	Boolean	True	明細を添付するかどうかのフラグ
ReportTypeUseTransactionActionAfterApproval	String	True	明細を添付した場合に申請承認後の処理。
ReportTypeIsActive	Boolean	True	使用フラグ。

Positions

役職を作成、更新、削除、およびクエリします。

テーブル固有の情報

SELECT

事業所のすべての役職のリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。

Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはMoney Forward Expense API によって処理されます。

SELECT * FROM Positions

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Insert

役職を挿入するには、次のカラムが必要です：OfficeId およびName。

INSERT INTO Positions (OfficeId, Name, IsAuthorizer, Priority) VALUES ('OfficeId1234', 'PositionName123' , false, 150)

Update

役職を更新するには、次のカラムが必要です：OfficeId およびId。

UPDATE Positions SET Name='UpdatedPositionName', IsAuthorizer=true, Priority=170 WHERE OfficeId='12345' AND Id='123456'

Delete

役職を削除するには、次のカラムが必要です：OfficeId およびId。

DELETE FROM Positions WHERE OfficeId = '12345' AND Id = '123456'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	役職Id。
OfficeId [KEY]	String	False	事業所Id。
Name	String	False	役職名称。
IsAuthorizer	Boolean	False	承認権限がデフォルトかどうかを示します。
Priority	Integer	False	表示優先順（昇順）。

Projects

プロジェクトを作成、更新、削除、およびクエリします。

テーブル固有の情報

SELECT

事業所のすべてのプロジェクトのリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。 Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Projects

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Insert

プロジェクトを挿入するには、次のカラムが必要です：OfficeId、Name、Code。

INSERT INTO Projects (OfficeId, Name, Code) VALUES ('OfficeId123', 'ProjectName123', 'ProjectCode123')

Update

プロジェクトを更新するには、次のカラムが必要です：OfficeId、Id。

UPDATE Projects SET Name='NewProjectName', Code='NewProjectCode' WHERE OfficeId='12345' AND Id='123456'

Delete

プロジェクトを削除するには、次のカラムが必要です：OfficeId、Id。

DELETE FROM Projects WHERE OfficeId = '12345' AND Id = '123456'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	プロジェクトId。
OfficeId [KEY]	String	False	事業所Id。
Name	String	False	プロジェクト名称。
Code	String	False	プロジェクトコード。
ParentId	String	True	親プロジェクトId。
RootId	String	True	最上位プロジェクトid。

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Money Forward Expense Connector for CData Sync ビュー


Name	Description
ApprovingReports	事務所全体の承認待ちの申請をクエリします。
Excises	Lists the Excises for an office.
InvoiceReports	null
Items	経費科目をリストします。
MyApprovingReports	自分の承認待ちの申請をクエリします。
MyInvoiceReports	null
MyReports	自分の申請をクエリします。
Offices	自分が所属する事業所をリストします。
Reports	事業所全体の申請をリストします。
ReportUnits	集計をリストします。
Transactions	事業所全体の経費明細をクエリします。

ApprovingReports

事務所全体の承認待ちの申請をクエリします。

Columns


Name	Type	Description
Id [KEY]	String	申請Id。
OfficeId	String	事業所Id。
ReportTypeId	String	申請種類Id。
OfficeMemberId	String	メンバーId。
Number	Integer	申請番号。
Title	String	タイトル。
Status	String	ステータス。
SubmittedAt	Datetime	申請日時。
ApprovedAt	Datetime	承認日時。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。

Excises

Lists the Excises for an office.

Columns


Name	Type	Description
Id [KEY]	String	The Excise Id.
OfficeId [KEY]	String	The office Id.
Rate	String	The Excise Rate.
Code	String	The Excise Code.
LongName	String	The Excise LongName.

InvoiceReports

null

Columns


Name	Type	Description
Id [KEY]	String	申請id
CreatedAt	Datetime	登録日時
OfficeId [KEY]	String	The office id
ApprovedAt	Datetime	承認日時
Number	String	申請番号
SubmittedAt	Datetime	申請日時
Status	String	unsubmitted: 下書き, waiting_step_one: 第一承認待ち, waiting_step_two: 第二承認待ち, waiting_step_three: 第三承認待ち, waiting_step_four: 第四承認待ち, waiting_step_five: 第五承認待ち, approved: 承認済み, canceled: 取消済み, rejected: 却下済み
UpdatedAt	Datetime	更新日時
Title	String	タイトル
OfficeMemberId	String	従業員Id
NumberWithoutPrefix	String	number_without_prefix
ReportApprovals	String	Report Approvals

Items

経費科目をリストします。

Columns


Name	Type	Description
Id [KEY]	String	プロジェクトId。
OfficeId [KEY]	String	事業所Id。
Name	String	経費科目名称。
SubItemId	String	補助科目Id。

MyApprovingReports

自分の承認待ちの申請をクエリします。

Columns


Name	Type	Description
Id [KEY]	String	申請Id。
OfficeId	String	事業所Id。
ReportTypeId	String	申請種類Id。
OfficeMemberId	String	メンバーId。
Number	Integer	申請番号。
Title	String	タイトル。
Status	String	ステータス。
SubmittedAt	Datetime	申請が提出された日付。
ApprovedAt	Datetime	承認日時。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。

MyInvoiceReports

null

Columns


Name	Type	Description
Id [KEY]	String	id
CreatedAt	Datetime
OfficeId [KEY]	String	The office id
ApprovedAt	Datetime
Number	String
SubmittedAt	Datetime
Status	String
UpdatedAt	Datetime
Title	String
OfficeMemberId	String	OfficeMemberId
NumberWithoutPrefix	String	number_without_prefix
ReportApprovals	String	Report Approvals

MyReports

自分の申請をクエリします。

Columns


Name	Type	Description
Id [KEY]	String	申請Id。
OfficeId	String	事業所Id。
ReportTypeId	String	申請種類Id。
OfficeMemberId	String	メンバーId。
Number	Integer	申請番号。
Title	String	タイトル。
Status	String	ステータス。
SubmittedAt	Datetime	申請日時。
ApprovedAt	Datetime	承認日時。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。

Offices

自分が所属する事業所をリストします。

テーブル固有の情報

SELECT

Sync App は、このテーブルのすべてのフィルタをクライアント側でSync App 内で処理します。例えば、次のクエリはMoney Forward Expense API によって処理される唯一のクエリで、所属するすべての事業所のリストを返します。

SELECT * FROM Offices

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns


Name	Type	Description
Id [KEY]	String	事業所Id。
IdentificationCode	String	事業所番号。
Name	String	事業所名。
OfficeTypeId	String	事業所タイプId。事業所種別。1は個人、2は法人 = ['1', '2']

Reports

事業所全体の申請をリストします。

テーブル固有の情報

SELECT

事業所のすべての申請のリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。 Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Reports

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns


Name	Type	Description
Id [KEY]	String	申請Id。
OfficeId	String	事業所Id。
ReportTypeId	String	申請種類Id。
OfficeMemberId	String	メンバーId。
Number	Integer	申請番号。
Title	String	タイトル。
Status	String	ステータス。
SubmittedAt	Datetime	申請日時。
ApprovedAt	Datetime	承認日時。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。

ReportUnits

集計をリストします。

テーブル固有の情報

SELECT

事業所のすべての集計のリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータが必須です。指定しない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。

Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM ReportUnits

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Columns


Name	Type	Description
Id [KEY]	String	集計Id。
OfficeId	String	メンバーId。
Title	String	タイトル。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。
Number	String	集計番号。

Transactions

事業所全体の経費明細をクエリします。

テーブル固有の情報

SELECT

事業所のすべての経費明細のリストを取得するには、OfficeId カラムまたはOfficeId 接続文字列パラメータ、およびRecognizedAt カラムの範囲が必須です。OfficeId が指定されていない場合は、Offices テーブルの最初の事業所のOfficeId が使用されます。

Sync App はMoney Forward Expense API を使用してOfficeId を参照する検索条件を処理し、クライアント側でSync App 内で他のフィルタを処理します。例えば、次のクエリはサーバー側で処理されます。

SELECT * FROM Transactions WHERE RecognizedAt <= '2020-04-30' AND RecognizedAt >= '2020-04-01'

SupportEnhancedSQL をfalse に設定すると、クライアント側の実行をオフにできます。その場合、その他のカラムを参照する検索条件でエラーが発生します。

Insert

経費明細を挿入するには、次のカラムが必要です：OfficeId、Remark、ItemId、Value、RecognizedAt。

INSERT INTO Transactions (OfficeId, Remark, ItemId, Value, RecognizedAt, Memo, JpyRate, Currency, UseCustomJpyRate, CreditItemId, CreditSubItemId, ExciseId, DepartmentId, ProjectId) VALUES ('OfficeId123', 'RemarkValue', 'ItemId1234', 100.11, '01-01-2017', 'MemoValue', 100.123, 'JPY', false, 'CreditItemId213', 'CreditSubItemId213', 'ExciseId123', 'DepartmentId123', 'ProjectId123')

Update

経費明細を更新するには、次のカラムが必要です：OfficeId、Id。認証されたユーザーで、他の事業所メンバーでないユーザーに属する経費明細を更新することができます。

UPDATE Transactions SET Remark='NewRemark', ItemId='NewItemId', Value=123.123, Memo='NewMemo', UseCustomJypRate=false, RecognizedAt='01-02-2018', Currency='USD', ExciseId='NewExciseId', CreditItemId='NewCreditItemId', CreditSubItemId='NewCreditSubItemId', DepartmentId='NewDepartmentId', ProjectId='NewProjectId' WHERE OfficeId='12345' AND Id='123456'

Delete

経費明細を削除するには、次のカラムが必要です：OfficeId、Id。認証されたユーザーで、他の事業所メンバーでないユーザーに属する経費明細を削除することができます。

DELETE FROM Transactions WHERE OfficeId = '12345' AND Id = '123456'

Columns


Name	Type	Description
Id [KEY]	String	経費明細Id。
OfficeId [KEY]	String	事業所Id。
Remark	String	支払先・内容。
Value	Double	金額。
ItemId	String	経費科目Id。
RecognizedAt	Date	支払日。
Number	Integer	明細番号。
Memo	String	メモ。
JpyRate	Double	為替レート。
Currency	String	通貨。
UseCustomJypRate	Boolean	為替レートを手動設定するかどうかを示します。
AutomaticStatus	String	ステータス。
ErrorMessage	String	エラーメッセージ。
WarningMessage	String	ワーニングメッセージ。
WaitingMessage	String	待機メッセージ。
OfficeMemberId	String	メンバーId。
CreditItemId	String	貸方勘定科目Id。
CreditSubItemId	String	貸方補助科目Id。
ExciseId	String	税区分Id。
DepartmentId	String	部門Id。
ProjectId	String	プロジェクトId。
CreatedAt	Datetime	登録日時。
UpdatedAt	Datetime	更新日時。

接続文字列オプション

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

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

Authentication

プロパティ	説明
OfficeId	事業所のId。ほとんどのクエリで必須です。

OAuth

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

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

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
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	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

Authentication

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

プロパティ	説明
OfficeId	事業所のId。ほとんどのクエリで必須です。

OfficeId

事業所のId。ほとんどのクエリで必須です。

解説

事業所のId。ほとんどのクエリで必須です。この値は、クエリ結果を指定した事業所に制限します。SQL クエリに直接アクセスできない場合は、代わりにこの接続プロパティを設定できます。

クエリにアクセスできる場合は、OfficeId 疑似カラムを設定して、特定のクエリの接続プロパティ値をオーバーライドできます。

OAuth

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

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

SSL

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

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

SSLServerCert

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

解説

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

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


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

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

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

Firewall

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

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はMoney Forward Expense への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

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

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

ProxyServer

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

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

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

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

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

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


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

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

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

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

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

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

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

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット


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

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"