接続の確立

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

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

OAuth は唯一利用可能な認証メソッドです。OAuth を使って認証するには、Money Forward Invoice にアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL を取得しなければなりません。

MoneyForward Invoiceへの接続

MoneyForward はOAuth 認証標準を利用しています。

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

*MoneyForward は日本語版のみの提供です。

MoneyForward でアプリケーションを作成

OAuth クライアントクレデンシャルを取得する方法は次のとおりです。

MoneyForward にログインして、右上の［？］ボタンをクリックして、［API 連携β （開発者向け）］をクリックします。
［新規作成］をクリックします。
名前、Redirect URI、Scopes フィールドを入力します。
Redirect URL をhttps://oauth.cdata.com/oauth/ に設定します。
MF クラウド請求書API 利用規約への同意にチェックします。
［作成］をクリックします。作成が成功すると、OAuth クライアントクレデンシャルであるClient ID、Client Secret、スコープ、Callback URL が表示されます。

Money Forward Invoice への認証

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

OAuthClientId：アプリケーション設定のクライアントID に設定。
OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
CallbackURL：アプリケーション設定のSite URL に設定。

接続すると、Sync App はデフォルトブラウザでOAuth エンドポイントを開きます。もし、"この Web サイトのセキュリティ証明書には問題があります" などのメッセージを表示する場合には、"このサイトの閲覧を続行する（推奨されません）" をクリックします。認可を完了するには、Money Forward Invoice にログインする必要がありますので注意してください。Sync App がOAuth プロセスを完了します。

追加認証

Sync App の使用中に、あなたのアプリには指定のアクションを行う権限がありませんというエラーメッセージがMoneyForward から返されることがあります。このエラーを解消するには、必要な権限を持つ新しいOAuth アクセストークンを発行する必要があります。 GetOAuthAuthorizationURL とGetOAuthAccessToken の両ストアドプロシージャには、要求したい権限のインプットがあります。

有効な権限は、READ、WRITE です。

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

Sync App は、Money Forward Invoice にできるだけ多くの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 に設定します。

データモデル

Sync App を使用すると、アカウント内のすべてのテーブルを操作できます。

テーブル

Sync App はMoney Forward Invoice API をリレーショナルテーブルとしてモデル化します。スキーマは、容易に拡張できるシンプルなテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。

テーブルに加えて、Sync App は以下のストアドプロシージャとビューを備えています。これらにより、一括ジョブやカスタムレポートなど、Moneyforward API の他の要素を扱うことができます。

ストアドプロシージャ

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

ビュー

ビューは、Moneyforward のいくつかの追加的なメタデータ情報を提供します。

テーブル

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

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

Money Forward Invoice Connector for CData Sync テーブル


Name	Description
Billings	Moneyforward の有効なカテゴリをクエリします。
BillingsItems	MoneyForward の有効な請求書の品目をクエリします。
Items	Moneyforward の利用できる品目をクエリします。
Office	MoneyForward で利用可能な事業所情報をクエリします。
Partners	MoneyForward で利用可能な顧客情報をクエリします。
PartnersDepartments	MoneyForward で利用可能な顧客部門情報をクエリします。

Billings

Moneyforward の有効なカテゴリをクエリします。

テーブル固有の情報

Bills はBillings、もしくはBillingsItems テーブルを通じて挿入、クエリ、更新が可能です。Bills はBillings テーブルを使って削除することが可能です。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

MoneyForward は、SELECT クエリのWHERE 句では、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= もしくは= 比較でのみ使用できます。Bills において有効なカラムは、Id、BillingDate、およびSalesDate です。BillingDate、DueDate、およびSalesDate は、>=、<、<=、もしくは=条件と使うことができ、二つの条件を指定して範囲を指定することができますが、クエリ内では片方だけが使われます。次に例を示します。

SELECT * FROM Billings WHERE SalesDate > '1/1/2011' AND SalesDate < '2/1/2011'

Insert

INSERT ステートメントでサポートされるカラムは、DepartmentId、Title、Memo、PaymentCondition、BillingDate、DueDate、SalesDate、Note、Tags、DocumentName、およびItemsAggregate です。

Bill を追加するには、少なくともDepartmentId を指定する必要があります。ItemsAggregate カラムはItems データのJSON 集計を指定するために使われます。これらの集計で使われるカラムはBillingsItems にて定義されており、請求書アイテムは、事前に定義されたアイテムのItem Code もしくは少なくともName、Quantity、およびUnit_Price を指定することで追加することができます。例えば、次の例は二つのItem を含む新しいBill を挿入します。

INSERT INTO Billings (DepartmentId,ItemsAggregate) VALUES ('atjCPi-Oy_EXwAw-4EpRLA','[{"name":"test prod","unit_price":1000.0,"unit":","quantity":5.0,"price":5000.0,"display_order":0,"excise":true},{"code":"AA-123"}]')

また、BillingsItems を使って、請求書アイテムを挿入することも可能です。

Update

MoneyForward では、DepartmentId、Title,Memo、PaymentCondition、BillingDate、DueDate、SalesDate、Note、Tags、DocumentName、およびItemsAggregate のカラムが更新可能です。WHERE 句では、Id カラムが必須です。

UPDATE Billings SET DepartmentId='Tp-SQwHAVjo_te2DWVLsUg',DueDate='2016-09-30',Note='new note' WHERE Id='p_eg9Tmj1lv5gMmY8uR4fw'

Delete

Bills を削除するには、Bill のId を指定してDELETE ステートメントを発行します。

DELETE FROM Billings WHERE Id='KOqtVY0chz-BgXYAyBzUvw'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		カテゴリの一意の識別子
UserId	String	True		ユーザーID
PartnerId	String	True		顧客ID
DepartmentId	String	False		部門ID
PartnerName	String	True		顧客名
PartnerNameSuffix	String	True		顧客敬称
PartnerDetail	String	True		顧客詳細
MemberId	String	True		担当者ID
MemberName	String	True		担当者名
OfficeName	String	True		事業所名
OfficeDetail	String	True		事業所詳細
Title	String	False		役職
ExcisePrice	Decimal	True		消費税額
DeductPrice	Decimal	True		DeductPrice
Subtotal	Decimal	True		小計
Memo	String	False		メモ
PaymentCondition	String	False		振込先
TotalPrice	Decimal	True		合計
BillingDate	Date	False		請求日
DueDate	Date	False		お支払期限
SalesDate	Date	False		売上計上日
CreatedAt	Datetime	True		作成日
UpdatedAt	Datetime	True		更新日
BillingNumber	String	True		請求書番号
Note	String	False		備考
DocumentName	String	False		帳票名
Tags	String	False		タグ
StatusPosting	String	True		郵送したかどうか
StatusEmail	String	True		メール送信したかどうか
StatusDownload	String	True		ダウンロードしたかどうか
StatusPayment	String	True		入金済みかどうか
ItemsAggregate	String	False		品目の集計

BillingsItems

MoneyForward の有効な請求書の品目をクエリします。

テーブル固有の情報

Bills はBillingsItems テーブルを使うことで挿入、更新、削除が可能です。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

MoneyForward は、SELECT クエリのWHERE 句では、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= もしくは= 比較でのみ使用できます。BillingsItems において有効なカラムは、BillingId のみで、WHERE 句が必須です。次に例を示します。

SELECT * FROM BillingsItems WHERE BillingId='KOqtVY0chz-BgXYAyBzUvw'

Insert

INSERT ステートメントでは、BillingId カラムが必須です。既存の請求書にアイテムを追加する方法は二つあります。

Id を設定して、事前設定アイテムを使う。

INSERT INTO BillingsItems (BillingId,Code) VALUES ('KQvruJvizGQ8UlAkhLineA','021245447')

Name、Quanity、およびUnit_Price カラムを使用して動的に新しいアイテムを作成。

INSERT INTO BillingsItems (BillingId,Name,Quantity,Unit_Price) VALUES ('KQvruJvizGQ8UlAkhLineA','New Product',10,15.5)

Update

MoneyForward は、readonly であるCreatedAt、およびUpdatedAt を除いて、Billings カラムを更新することを許可しています。WHERE 句では、BillingId およびId カラムが必須です。

UPDATE BillingsItems SET Name='Test Product',Unit='kg',Display_Order=10,Unit_Price=20 WHERE BillingId='KQvruJvizGQ8UlAkhLineA' AND Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

BilllingsItems を削除するには、Bill のId およびアイテムのId を指定してDELETE ステートメントを発行します。

DELETE FROM BillingsItems WHERE BillingId='EJQ9pIz4WhseeKwsq5Ecug' AND Id='NrexrTYS2BTsim4gnb5ExQ'

Columns


Name	Type	ReadOnly	References	Description
BillingId [KEY]	String	False		請求書の一意の識別子
Id [KEY]	String	True		ID
Code	String	False		コード
Name	String	False		名前
Detail	String	False		詳細
Quantity	Double	False		数量
Unit_Price	Decimal	False		単価
Unit	String	False		単位
Price	Decimal	False		価格
Excise	String	False		消費税を加えるかどうか使用できる値は次のとおりです。true, false, untaxable, non_taxable, tax_exemption, five_percent, eight_percent, eight_percent_as_reduced_tax_rate, ten_percent
Display_Order	Integer	False		display order
CreatedAt	Datetime	True		作成日
UpdatedAt	Datetime	True		更新日

Items

Moneyforward の利用できる品目をクエリします。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

MoneyForward は、SELECT クエリのWHERE 句では、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= もしくは= 比較でのみ使用できます。Items テーブルの有効なカラムはId のみです。例は：

SELECT * FROM Items WHERE Id='byhHeWKXKXcdzcBTEGXIgg'

Insert

INSERT ステートメントでは、Name カラムが必須です。

INSERT INTO Items (Name) VALUES ('CData Driver')

Update

MoneyForward は、readonly であるCreatedAt、およびUpdatedAt を除いて、Items カラムを更新することを許可しています。WHERE 句では、Id カラムが必須です。

UPDATE Items SET Name='Test Product',Unit='kg',Display_Order=10,Unit_Price=20 WHERE Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

Items を削除するには、Item のId を指定してDELETE ステートメントを発行します。

DELETE FROM ITEMS WHERE Id='byhHeWKXKXcdzcBTEGXIgg'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		品目の一意の識別子
Code	String	False		品目コード
Name	String	False		名前
Quantity	Double	False		数量
Unit	String	False		単位
UnitPrice	Decimal	False		単価
Price	Decimal	True		価格
Excise	String	False		消費税を加えるかどうか使用できる値は次のとおりです。true, false, untaxable, non_taxable, tax_exemption, five_percent, eight_percent, eight_percent_as_reduced_tax_rate, ten_percent
Detail	String	False		詳細
CreatedAt	Datetime	True		作成日
UpdatedAt	Datetime	True		更新日

Office

MoneyForward で利用可能な事業所情報をクエリします。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

SELECT * FROM Office

Insert

MoneyForward はOffices の追加を許可していません。

Update

Offices のすべてのカラムは更新可能です。

UPDATE Office SET Name='New Office',Address1='New Address'");

Delete

MoneyForward は、Offices の削除を許可していません。

Columns


Name	Type	ReadOnly	References	Description
Name	String	False		名前
Zip	String	False		郵便番号
Prefecture	String	False		都道府県
Address1	String	False		住所1
Address2	String	False		住所2
Tel	String	False		電話番号
Fax	String	False		FAX 番号

Partners

MoneyForward で利用可能な顧客情報をクエリします。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

MoneyForward は、SELECT クエリのWHERE 句では、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= もしくは= 比較でのみ使用できます。Partners テーブルの有効なカラムはId のみです。例は：

SELECT * FROM Partners WHERE Id='KOqtVY0chz-BgXYAyBzUvw'

Insert

Partner の追加には、少なくともName カラムを指定してください。

INSERT INTO Partners (Name) VALUES ('New Partner')

Update

Moneyforward は、Partners Code、Kana、Suffix、およびMemo カラムの更新を許可しています。WHERE 句では、Id カラムが必須です。

UPDATE Partners SET Name='Old Product' WHERE Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

Partners を削除するには、Partner のId を指定してDELETE ステートメントを発行します。

DELETE FROM Partners WHERE Id='NrexrTYS2BTsim4gnb5ExQ'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		顧客の一意の識別子
Code	String	False		顧客コード
Name	String	False		名前
Kana	String	False		名前（カナ）
Suffix	String	False		敬称
Memo	String	False		メモ
CreatedAt	Datetime	True		作成日
UpdatedAt	Datetime	True		更新日
DepartmentsAggregate	String	True		部門集計

PartnersDepartments

MoneyForward で利用可能な顧客部門情報をクエリします。

Select

デフォルトでは、SupportEnhancedSQL はtrue に設定されています。存在する場合は次のフィルタが考慮されます。他のフィルタはクライアント側で実行されます。SupportEnhancedSQL がfalse に設定されている場合は、次のフィルタのみが考慮されます。

MoneyForward は、SELECT クエリのWHERE 句では、大きいカラムサブセットを扱うことを許可していません。これらのカラムは、通常= もしくは= 比較でのみ使用できます。PartnersDepartments において有効なカラムは、PartnerId のみで、WHERE 句が必須です。次に例を示します。

SELECT * FROM PartnersDepartments WHERE PartnerId='Br1hpsShuBmjMIc0BThklg'

Insert

PartnerDepartment への挿入には、少なくともPartnerId および一つのreadonly ではないカラムの指定が必要です。

INSERT INTO PartnersDepartments (PartnerId,Name) VALUES ('Br1hpsShuBmjMIc0BThklg','old dep')

Update

Moneyforwar はすべてのreadonly ではないカラムの更新を許可しています。WHERE 句では、PartnerId およびId カラムが必須です。

UPDATE PartnersDepartments SET Name='New Dep' WHERE PartnerId='Br1hpsShuBmjMIc0BThklg' AND Id='ozWPblxyZ5wphY1eZkKyJA'

Delete

MoneyForward は、PartnersDepartments の削除を許可していません。

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		顧客部門の一意の識別子
PartnerId [KEY]	String	False		顧客ID
Name	String	False		名前
Zip	String	False		郵便番号
Tel	String	False		電話番号
Prefecture	String	False		都道府県
Address1	String	False		住所1
Address2	String	False		住所2
PersonTitle	String	False		担当者役職
PersonName	String	False		担当者氏名
Email	String	False		メールアドレス
CcEmails	String	False		cc メールアドレス
CreatedAt	Datetime	True		作成日
UpdatedAt	Datetime	True		更新日

ビュー

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

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

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

Money Forward Invoice Connector for CData Sync ビュー


Name	Description
SentHistory	Moneyforward の有効な送信履歴をクエリします。

SentHistory

Moneyforward の有効な送信履歴をクエリします。

Columns


Name	Type	References	Description
OperatorId	String		operator id
Type	String		type
DocumentType	String		document type
DocumentId	String		document id
From	String		送信元
To	String		宛先
Cc	String		cc
SentAt	Datetime		送信日

接続文字列オプション

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

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

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

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

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 Invoice への接続を開き、プロキシを経由して通信が行われます。
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\\MFInvoice 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 プロパティの全リストを提供します。

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

ExciseType

BillingsItems およびItems テーブルのExcise カラムの値の型。

解説

BillingsItems およびItems エンティティに設定されているExcise の値に基づいて、boolean またはenum のどちらかになります。

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 Items WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

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

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