Versions Compared

Version Old Version 33 New Version 34
Changes made by

Anonymous

Yellowfin Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

Table of Contents
classcontents

Overview

Yellowfin's CSV functionality allows business users to transform their existing spreadsheets into reports. This means that any of Yellowfin's reporting capabilities can be quickly applied to spreadsheet contents, including the ability to drill down and categorise data.

Yellowfin allows spreadsheet data (stored as CSVs) to be imported into a specified data source and used for reporting. There are two methods for importing CSV data to use for report building;

...

概要

YellowfinのCSV機能を使用して、既存のスプレッドシートをレポートに変換することができます。つまり、ドリルダウンやデータの分類を含め、スプレッドシートのデータに対してYellowfinのすべてのレポート作成機能を素早く適用することができます。

Yellowfinでは、（CSVとして格納された）スプレッドシートデータを指定されたデータソースにインポートしてレポート作成に使用することができます。レポート作成に使用するCSVデータをインポートする方法は2つあります。

  1. レポートビルダーのプロセスを使用して新しいCSVファイルをインポートする
  2. ビュービルダーのプロセスを使用して新しいCSVファイルをインポートする

 

Wiki Markup
{html}<iframe width="700" height="394" src="//www.youtube.com/embed/_esfLmFUCBY?color=white" frameborder="0" allowfullscreen></iframe>{html}
 

 

Import Methods

When importing a CSV file for reporting use, it’s important to consider what the data will be used for, and which import method would best suit that use.

Report Builder Import

If the CSV has been developed for stand-alone use, or the CSV data needs to be stored in a separate data source from other reporting data, and the desired reporting results can easily be achieved with advanced sub query functionality, then the Report Builder import method should be used.

When the Report Builder import process is used, the following happens:

  1. The user defines any calculations or converters to be applied to the data, creating additional fields in the final table.
  2. The user defines all default formatting and relationships between fields, such as drill down, through the CSV step. These will be reused whenever someone selects this CSV for report building.
  3. Yellowfin creates a View with all of the above fields, formatting, and relationships for reuse by other report writers. This View will be available during the report writing process, and the View itself can be edited by users with permission in order to adjust the default settings defined.

View Builder Import

If the CSV data is to be used in conjunction with tables from a reporting data source, the view import method should be used. This option also allows the import to be used across multiple views, rather than just multiple reports.

When the View Builder import process is used, the following happens:

  1. The user defines any converters to be applied to the data, creating additional fields in the final table.
  2. Yellowfin creates a table that is listed in the View Builder, allowing the user to select it, as they would any other table from the selected source connection. This table will be available to any View built on the writable source connection.
  3. The user selects the CSV table and adds it to the View like they would any other table, joining it to other tables, etc.
  4. The user defines any default formatting and relationships between fields, such as drill down, through the standard View Builder steps, rather than the CSV step.

Setup

Writable Data Source

Yellowfin requires a Data Source connection to be defined as writable in order to write the contents of the CSV file to a table in the database. Often the writable connection will be pointing to an empty database, created solely for the purpose of importing CSVs or caching views. This is to ensure that any imports are kept separate from the main data sources.

Expand
titleClick to Expand Instructions

In order to define a writable connection, complete the following:

  1. Navigate to Administration > Admin Console.
  2. Expand the Data Sources section of the Admin Console main panel.
  3. If you already have a connection defined that you wish to set to writable, simply click on the connection name, otherwise create a new connection by clicking the Add button.
  4. In the Data Source Details section of the connection setup, set the Writable option to Yes.
    Image Removed
  5. In the case that a user has permission to import a CSV, but not permission to access the advanced options, they will need there to be a writable source connection that has been set to the CSV Default so Yellowfin knows which connection to select for them. If this is the case for some of the users in the system, set the CSV default to Yes.
    Image Removed
  6. Complete the process by clicking the Save button at the bottom of the page.

Writable HSQL Data Source

Often when working outside of a Development, QA, or Production instance of Yellowfin, you may have a need to import CSV files on a temporary or trial basis. An example of this would be trialling CSV file formats on a temporary setup, or perhaps creating sample content in a Proof Of Concept (POC) type scenario. In this situation you may not want, or be able, to set up a stable database for the purpose of storing CSV data. A temporary solution to this would be to create a writable HSQL database, similar to the one you can install Yellowfin into. In order to do this, follow these steps:

Note: HSQL databases are not stable and should never be used as part of a long term solution.

Expand
titleClick to Expand Instructions
  1. Create a directory, within your Yellowfin installation directory, to store the HSQL database. For example:
    C:\Yellowfin\HSQLdatabase
  2. In Yellowfin, navigate to Administation > Admin Console.
  3. Expand the Data Sources section of the Admin Console main panel.
  4. Click the Add button.
  5. Give your data source a Name, Description, and set the Writable option to Yes. You can also set it to CSV Default, this is optional.
    Image Removed
  6. Now provide the connection details:
    Image Removed
    1. Connection Method: JDBC
    2. Authentication: Standard Authentication
    3. Database: HSQLDB Server
    4. Database Mode: Embedded Mode
    5. Database: C:\Yellowfin\HSQLdatabase\CSVdata
      The value of this should be the directory you wish to store the HSQL database in, created in step 1, followed by the name of your database (Yellowfin will create this) - in this example we used CSVdata as the name.
    6. Username: leave this blank
    7. Password: leave this blank
    8. Schema: None
    9. Isolation Level: Read Uncommitted
  7. Now click the Click here to test the connection link to test out your settings.
    Image Removed
  8. Complete the process by clicking the Save button at the bottom of the page.

Role Permissions

In order for a user to import CSVs in Yellowfin they must have the appropriate role permissions defined. As there are two methods of importing CSVs, there are also two sets of role permissions available.

Report Builder

A user may be granted permission to import CSV files through the Report Builder. This is the less advanced import method of the two available. If the user needs to import CSV data through the Report Builder, they will require the following Role Permissions.

Expand
titleClick to Expand Instructions
  1. Navigate to Administration > Admin Console.
  2. Open the Roles section and click on the role you wish to enable CSV access for.
  3. Enable the following:
    1. Report Types - this provides the user with access to advanced report authoring options, such as CSV Import.
      Image Removed
    2. CSV Reports - this gives the user access specifically to the Load CSV File option on the Report Builder's initialisation step.
      Image Removed
    3. Advanced CSV Functionality - this allows users to select advanced options, including which writable data source to use, rather than relying on the default option.
      Image Removed
      Note: this is an optional role permission.
  4. Save the role.

View Builder

A user may be granted permission to import CSV files through the View Builder. These permissions are generally only granted to users that maintain standard Yellowfin Views as part of their role already. They may also be granted the Report Builder import permissions, allowing them to user either method. If the user needs to import CSV data through the View Builder, they will require the following Role Permissions.

Expand
titleClick to Expand Instructions
  1. Navigate to Administration > Admin Console.
  2. Open the Roles section and click on the role you wish to enable CSV access for.
  3. Enable the following:
    1. Database Views - this provides the user with access to the standard View Builder.
      Image Removed
    2. Create CSV Table - this enables the CSV Import functionality within the View Builder.
      Image Removed
  4. Save the role.

Prepare CSV File

Before the import process can begin, you will need to obtain or create your CSV file. There are some guidelines in place to ensure a compatible file.

Do

...

Don't

...

インポート方法

レポートで使用するためにCSVファイルをインポートするときは、データの用途、およびその用途に最適なインポート方法を考慮することが重要です。

レポートビルダーによるインポート

CSVがスタンドアロン用途に作成されている場合、またはCSVデータをその他のレポートデータとは別のデータソースに格納する必要がある場合、高度なサブクエリー機能を使用して目的のレポート結果を簡単に得られる場合は、レポートビルダーによるインポート方法を使用してください。

レポートビルダーによるインポートプロセスを使用する場合は、次のように操作します：

  1. データに適用する計算またはコンバーターを定義し、最終的にテーブルに追加するためのフィールドを作成します。
  2. デフォルトの書式とフィールド間の関連（ドリルダウンなど）をCSVのステップですべて定義します。これらの設定は、ほかのユーザーがこのCSVをレポート作成で選択したときでも常に再利用することができます。
  3. ほかのレポート作成者が再利用できるように、Yellowfinでは上記のフィールド、書式、および関連のすべてを設定したビューが作成されます。このビューはレポート作成プロセス中に使用でき、権限を持つユーザーであれば、定義済みのデフォルト設定を調整するためにビュー自体を編集できます。

ビュービルダーによるインポート

CSVデータをレポート作成のデータソースにあるテーブルと一緒に使用する場合は、ビュービルダーによるインポート方法を使用してください。このオプションでは、複数のレポート間だけでなく、複数のビュー間でインポートを使用できます。

ビュービルダーによるインポートプロセスを使用する場合は、次のように操作します：

  1. データに適用するコンバーターを定義し、最終的にテーブルに追加するためのフィールドを作成します。
  2. ビュービルダーに表示されるテーブルが作成されます。選択されたソース接続からほかのテーブルを選択する場合と同様に、この表も選択できます。このテーブルは、書き込み可能なソース接続上に作成されたすべてのビューで使用できます。
  3. ほかのテーブルの場合と同様に、CSVテーブルを選択してビューに追加し、ほかのテーブルに結合するといった操作を実行できます。
  4. デフォルトの書式とフィールド間の関連（ドリルダウンなど）は、CSVのステップではなく、標準のビュービルダーのステップで定義します。

設定

書き込み可能なデータソース

CSVファイルの内容をデータベースのテーブルに書き込むために、データソース接続を書き込み可能として定義する必要があります。書き込み可能な接続は、CSVのインポートやビューのキャッシュのためだけに作成される空のデータベースをポイントすることがあります。これは、インポートをメインのデータソースと分離したままにするためです。

Expand
titleクリックして手順を表示します。

書き込み可能な接続を定義するには、次の手順を実行します。

  1. 「管理」>「管理コンソール」に移動します。
  2. 「管理コンソール」のメインパネルにある「データソース」セクションを展開します。
  3. 書き込み可能に設定する接続が既に定義されている場合は、接続名をクリックします。そうでない場合は、「追加」ボタンをクリックして、新しい接続を作成します。
  4. 接続設定の「データソース詳細」セクションで、「書き込み可」オプションを「Yes」に設定します。
    Image Added
  5. ユーザーにCSVをインポートする権限はあるものの、高度なオプションにアクセスする権限はない場合は、ユーザーが選択する接続が認識されるように、「CSVデフォルト」に設定された書き込み可能なソース接続が存在する必要があります。このようなユーザーがシステムにいる場合は、「CSVデフォルト」を「Yes」に設定します。
    Image Added
  6. ページの下にある「保存」ボタンをクリックして、プロセスを完了します。

書き込み可能なHSQLデータソース

Yellowfinの開発インスタンス、QAインスタンス、または本番インスタンスの外部で操作することが多い場合は、一時的または試行的にCSVファイルのインポートが必要になることがあります。このような例としては、一時的な設定でCSVファイル形式を試行する場合や、概念実証（POC）のシナリオでサンプルのコンテンツを作成する場合が挙げられます。このような場合には、CSVデータを格納するために定常的なデータベースを設定不要であったり設定不可であったりします。一時的な解決方法としては、Yellowfinをインストール可能なものと同様な書き込み可能なHSQLデータベースを作成します。これを行うには、以下の手順を実行します。

注意：HSQLデータベースは不安定なので、長期間のソリューションで使用しないでください。

Expand
titleクリックして手順を表示します。
  1. HSQLデータベースを格納するためのディレクトリをYellowfinインストールディレクトリ内に作成します。例：
    C:\Yellowfin\HSQLdatabase
  2. Yellowfinで、「管理」>「管理コンソール」に移動します。
  3. 「管理コンソール」のメインパネルにある「データソース」セクションを展開します。
  4. 「追加」ボタンをクリックします。
  5. データソースの「名前」および「説明」を入力し、「書き込み可」オプションを「Yes」に設定します。また、「CSVデフォルト」を設定することもできます（オプション）。
    Image Added
  6. 接続の詳細を指定します：
    Image Added
    1. 接続方法：JDBC
    2. 認証：Standard Authentication
    3. データベース：HSQLDB Server
    4. データベースモード：組み込みモード
    5. データベース：C:\Yellowfin\HSQLdatabase\CSVdata
      ここでは、ステップ1で作成したHSQLデータベースを格納するディレクトリに続けてデータベースの名前を入力します（この名前でYellowfinがデータベースを作成します）。この例では、CSVdata を名前として使用しています。
    6. ユーザー名：空のままにします
    7. パスワード：空のままにします
    8. スキーマ：何もなし
    9. 分離レベル：READ UNCOMMITTED：
  7. 「ここをクリックし、接続テスト」リンクをクリックして、設定をテストします。
    Image Added
  8. ページの下にある「保存」ボタンをクリックして、プロセスを完了します。

ロール権限

YellowfinでCSVをインポートするには、ユーザーに適切なロール権限が定義されている必要があります。CSVをインポートする方法は2つあるため、使用可能なロール権限も2つあります。

レポートビルダー

ユーザーには、レポートビルダーを使用してCSVファイルをインポートするための権限をすることが付与できます。これは2つある使用可能なインポート方法のうち簡単なものです。レポートビルダーを使用してCSVデータをインポートする必要がある場合は、次のロール権限が必要です。

Expand
titleクリックして手順を表示します。
  1. 「管理」>「管理コンソール」に移動します。
  2. 「ロール」セクションを開き、CSVアクセスを有効にするロールをクリックします。
  3. 次のオプションを有効にします：
    1. SQLレポート・Jasperレポート作成権 - 高度なレポート作成オプション（「CSVからインポート」など）にアクセスできます。
      Image Added
    2. CSVレポート作成権 - レポートビルダーの初期設定ステップの「CSVファイルをロード」にアクセスできます。
      Image Added
    3. 高度なCSV機能使用権 - デフォルトオプションを利用せずに、高度なオプション（書き込み可能なデータソースの使用など）を選択できます。
      Image Added
      注意： これはオプションのロール権限です。
  4. ロールを保存します。

ビュービルダー

ユーザーには、ビュービルダーを使用してCSVファイルをインポートするための権限を付与できます。一般に、このような権限は、ロールの一部として標準のYellowfinビューを既に保持するユーザーにのみ付与されています。また、これらのユーザーには、どちらの方法でも使用できるように、レポートビルダーによるインポートの権限も付与されていることもあります。ビュービルダーを使用してCSVデータをインポートする必要がある場合は、次のロール権限が必要です。

Expand
titleクリックして手順を表示します。
  1. 「管理」>「管理コンソール」に移動します。
  2. 「ロール」セクションを開き、CSVアクセスを有効にするロールをクリックします。
  3. 次のオプションを有効にします：
    1. データベースビュー - 標準のビュービルダーにアクセスできます。
      Image Added
    2. CSVテーブルの作成 - ビュービルダー内の「CSVからインポート」機能を有効にします。
      Image Added
  4. ロールを保存します。

CSVファイルの準備

インポートプロセスを開始する前に、CSVファイルを入手または作成する必要があります。ファイルの互換性を確保するために留意すべきガイドラインを示します。

最適なファイル形式は？

  1. カラム（列）ベース - CSV内のデータがカラム（列）として格納されていることを確認します。ファイルの先頭に空のカラム（列）やロウ（行）は使用できません（スプレッドシートツールを使用して調べる場合）。
  2. 日付の書式 - Yellowfinで認識される日付の書式はyyyy/MM/ddです（例：2014/08/31）。可能な場合は、日付をこの書式で格納することをお勧めします。Yellowfinでは、インポートプロセス中に使用可能なコンバーターが用意されていますが、開始時に日付が適切な書式になっていれば、インポート中の追加作業が不要になります。
  3. 合計欄を持たない - CSVのカラム（列）には、カラム（列）合計やロウ（行）合計が適用されないようにしてください。また、インポート中に失われる可能性のあるその他の計算や書式、データ値（合計ではなく）の誤りなどがないようにしてください。
  4. カラム（列）ごとに一貫性のあるデータ - 各カラム（列）に格納されているデータがファイル全体で同じデータ型であることを確認します。これにより、カラム（列）ごとにフィールドタイプが正しく識別され、割り当てできるようになります。たとえば、日付カラム（列）があり、数件のレコードにテキスト"N/A"が設定されている以外はすべてのデータが日付である場合は、このテキストが削除されて空欄のままになります。こうすることで、このフィールドはテキストではなく日付として認識されます。
  5. ファイル形式 - Yellowfinでは、CSVファイルのみを使用できます。XLS、XLSX、またはその他の形式は使用できません。
  6. 文字セット - ファイルに含まれるすべての文字が認識されるように、ファイルではUTF-8文字セットを使用してください。

互換性のないファイル形式

  1. クロス集計/ピボット - クロス集計/ピボット形式のデータをインポートしないでください。Yellowfinではファイルがカラム（列）形式であることを前提として検査するため、クロス集計/ピボット形式のデータの場合、意図しない使用不可能な構造で格納されてしまいます。
  2. 合計欄 - 合計欄をフィールドに加えないでください。Yellowfinでは、合計をほかのデータと区別しません。
  3. XLS形式 - データをXLSまたはXLSX形式で格納しないでください。Yellowfinで読み込めるのはCSVだけです。