XBRL文書中の指定データをCSVストリームの各フィールドにマッピングして出力します。
本コンポーネントは、入力ストリームから渡されたXBRL文書中のデータを、定義に従って出力CSVストリームの各フィールドにマッピングします。マッピングの定義は、XBRLCSVマッパーを起動して行います。詳細については、下記トピック「XBRLCSVマッパーの使い方」を参照してください。
| 入力 | フォーマット | XML,Binary |
|---|---|---|
| 接続数 | 1 | |
| 出力 | フォーマット | CSV |
| 名前 | プロパティ型 | マッピング | 説明 |
|---|---|---|---|
| 変換ファイルパス | remoteFile | - |
マッピング定義を保存するファイルのパスを指定します。XBRLCSVマッパーで定義した内容はこのファイルに保存されます。ファイルの内容はフロー実行時に解析されるので、フローを修正せずにこのファイルの内容を書き換えて、マッピング定義を変更することができます。 区切り文字「\」と「/」は区別されません。 相対パスの場合は相対パスの起点の指定に基づいて解釈されます。 |
| ファイルパスの詳細設定 | group | - | ファイルパスの詳細設定を行うプロパティ群です。 |
| 相対パスの起点 | pathResolver | - |
相対パス指定の場合にベースディレクトリを指定します。
|
| 絶対パスを許可 | boolean | - | 絶対パスを許可するかどうか選択します。 |
| 「..」を許可 | boolean | - | 上のフォルダへ移動する記述に「..」を許可するかどうか選択します。 |
| コミット | 何もしません。 |
|---|---|
| ロールバック | 何もしません。 |
| タイプ | パラ メータ | エラー処理フロー へのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | なし | 変換ファイルパスに指定がない場合 |
| なし | 変換ファイルパスの内容に誤りがある場合 | |||
| なし | 入力XBRL文書中にマッピング対象となるデータ項目が全くない場合 |
XBRLCSVマッパーは、XBRLCSVConverterコンポーネントの外部ツールで、入力XBRL文書のどのデータを出力CSVストリームのどのフィールドに出力するかを定義するためのツールです。はじめにひな形となるXBRL文書インスタンスを読み込み、インスタンスまたはタクソノミに定義されているデータについて、マッピング対象とするかどうかを設定していきます。また、XBRLデータと、インスタンス中に定義されているコンテキストをひもづけて、マッピング対象とすることも可能です。
マッピング対象とするデータを、タクソノミの名前空間ごとに表示したり、文字列による絞り込みを行って表示する機能も提供します。
以下のいずれかの操作でXBRLCSVマッパーを起動します。

XBRLCSVマッパーを新規に起動した場合、マッピングの対象としたいXBRL文書のひな形となるXBRL文書インスタンスファイルをインポートします。マッピング定義の途中で[XBRLインスタンスのインポート]ボタンをクリックして、既存のマッピング定義を破棄してインポートからやり直すこともできます。
XBRL文書インスタンスファイルは、通常いくつかのXMLSchemeファイル(xsdファイル)を参照しています。これらのファイルはインスタンス中の定義にしたがって自動的に読み込まれますが、指定されたパス上に見つからない場合は、適宜ダイアログが表示されますのでxsdファイルのパスを指定してください。
インポートが完了すると、インスタンス中に定義されているタクソノミ、実データ(ファクト)、コンテキスト、名前空間が読み込まれ、マッピング操作で使用することができるようになります。

XBRLインスタンスファイルのインポート直後には、このような画面が表示されます。
左側のリスト(マップ可能項目)にマッピング可能なXBRLデータの名称、右側のリスト(マップ済み項目)にマッピング済みのXBRLデータの名称が表示されます。通常のXBRLデータ項目(ファクト)は黒字で、コンテキスト中のデータ項目は青字で表示されます。左右のリストと中央のボタンを使用して、マッピングを編集することができます。
マップ可能項目リストからマッピングしたいデータを選択し[追加]ボタンをクリックするか、データをダブルクリックすることにより、マッピングの対象とすることができます。マップ済み項目リストからマッピング対象から除外したいデータを選択し[削除]ボタンをクリックするか、データをダブルクリックすることにより、マッピング対象から除外することができます。
[すべて追加]ボタンをクリックすると、マップ可能項目に表示されているリストがすべてマッピング対象となります。逆に[すべて削除]ボタンをクリックすると、マップ済み項目の表示されているリストがすべてマッピング対象から除外されます。
マッピング対象とされたデータは、CSVストリームにマップ済み項目リストに表示された順番で出力されます。マップ済み項目リストからデータを選択し、[上に移動]または[下に移動]ボタンをクリックして、出力する順番を変更することができます。
XBRLCSVマッパーでは、通常のXBRLデータだけでなく、コンテキスト上のデータ(データがひもづけられる団体、期間などの情報)もマッピングの対象とすることができます。コンテキスト上のデータは、左右のリスト上では青い文字列で表示され、通常のXBRLデータと同様の操作が可能です。
XBRLCSVマッパーの左上部にある[表示フィルター]を使用して、表示する項目を制御することできます。
XBRLインスタンスファイル中に定義されている名前空間を、[名前空間]コンボボックスから選択することができます。名前空間を選択すると、対応するタクソノミで定義された項目のみが、マップ可能項目に表示されます。[(すべて)]を選択すると、すべてのタクソノミの項目が表示されます。
[検索文字列]テキストボックスに文字列を指定すると、その文字列を項目名に含むものだけがマップ可能項目に表示されます。項目名が非常に多い場合にこの機能を用い得て絞り込みを行うことができます。
[XBRLインスタンス中の要素のみ表示]チェックボックスをONにすると、インスタンス中に実データ(ファクト)が存在する項目のみが、マップ可能項目に表示されます。OFFにすると、タクソノミに定義されているすべての項目が表示されます。
[マップ済み要素を表示]チェックボックスをONにすると、すでにマップ済みの要素もマップ可能項目に表示されます。OFFにすると、マップ済みの要素はマップ可能項目に表示されません。
[ファクト名を表示]チェックボックスをONにすると、マップ可能項目にXBRL定義中のファクト名(XML中の要素名)が名前空間のプリフィクスとともに表示されます。
XBRLCSVマッパーの右上部にある[コンテキスト設定]を使用して、インスタンス中に定義されているコンテキストとマッピング対象をひもづけることができます。
[コンテキスト]コンボボックスで、インスタンス中に定義されたコンテキストを選択できます。選択すると、インポートされたXBRL文書におけるコンテキストの内容(団体ID、期間など)がコンボボックスの下に表示されます。また、[表示フィルター]の[XBRLインスタンス中の要素のみ表示]チェックボックスをONの場合、選択されたコンテキストを参照するデータ項目のみが、マップ可能項目リストに表示されます。
コンボボックスで[すべて]を選択した状態でマッピング対象に追加されたデータ項目は、コンテキストとひもづけられていません。この場合、フロー実行時に入力されたXBRL文書中のデータは項目名だけでマッピングされます。一方、[コンテキスト]コンボボックスで特定のコンテキストを選択した状態でマッピング対象に追加されたデータ項目は、そのコンテキストとひもづけられ、マッピング済み項目リストではラベル名とコンテキスト名が同時に表示されます。この場合、フロー実行時に入力されたXBRL文書中のデータは項目名とコンテキスト名の両方が一致するものがマッピングされます。
編集したマッピング定義は変換ファイルパスプロパティで示される定義ファイルに保存されます。マッピング定義中に、ダイアログ下部の[新規マッピング定義]、[マッピング定義を開く]、[マッピング定義を保存]、[名前をつけて保存]ボタンをクリックして、定義ファイルの操作を行うことができます。
初回起動時(あるいは変換ファイルパスプロパティが未定義の場合)には、新規に空の定義ファイルが作成され、終了時に定義ファイルの名前を入力します。
ダイアログ下部の[OK]ボタンをクリックしてXBRLCSVマッパーを終了すると、マップ済み項目リストを使用して、コンポーネントの出力フィールド定義が行われます。ダイアログ中央の[出力フィールド定義]ラジオボタンで、[ファクト名]を選択していると、フィールド名にXBRL定義中のファクト名(XML中の要素名)が使用されます。[ラベル名]を選択していると、フィールド名にXBRL定義中のラベル名が使用されます。複数のタクソノミを参照していてフィールド名の重複があった場合には、適宜フィールド名に名前空間のプリフィクスがつけられます。