レポートの注釈

概要

Yellowfinでは注釈形式の特別なコメントをレポートに追加することができます。注釈には以下の3つのタイプがあります：

• レポートレベルの注釈
• ビューレベルの注釈
• 組織レベルの注釈

注釈を使うことで、レポートの閲覧者にそのレポートの意味をより明確に伝えることが可能です。注釈は、レポートが有効化されていて注釈ドロップダウンメニューが表示されている場合にのみ表示されます。

上の図は注釈が表示される3つの位置を示しています。

1. 注釈フラグ：タイムシリーズのX軸の日付または日付範囲の開始位置を、レポートページから編集可能な記述ロールオーバーとともに強調表示します。
   注意：注釈が個人用に設定されている場合、フラグは赤色になります。
2. ハイライト：単一の日付ではなく日付範囲に注釈が適用されたタイムシリーズグラフ内の強調表示です。
3. テーブルの記述ロールオーバー：日付または日付範囲の開始位置で表示されます。レポートから編集可能です。

注釈の有効化

Yellowfinで注釈を使用するには2つの手順を実行する必要があります。

1. 管理者に申請してロールの注釈権限を有効化します。「C」（作成）、「R」（読み取り）、「U」（更新）、「D」（削除）のオプションが使用できます。
   1. 管理者は、「管理」 > 「ロール管理」に移動して、ロールを編集する必要があります。
   2. 「注釈」ロールが有効になっていることを確認する必要があります。
      
2. 注釈を表示するレポートが適切に有効化されている必要があります。
   1. レポートがドラフト（編集中）モードの場合は、「表示」メニューを開きます。
   2. 「グラフに表示」または「表に表示」あるいはその両方が「はい」に設定されていることを確認します。
      
   3. レポートを有効化します。

注釈の作成

注釈を作成するには、次の手順を実行します：

1. レポートが有効化されている（ドラフト（編集中）モードでない）ことを確認します。
2. 「注釈」メニューで、「注釈の追加」ボタンをクリックします。
   
3. 「注釈」ウインドウが開き、以下のオプションが表示されます：
   

日付

注釈を表示する日付または日付範囲を指定します。日付範囲を選択した場合は、グラフの強調表示に使用する色を選択することもできます。

フィルター

オプションのフィルター設定では、注釈をフィルター値と関連付けることができます。これにより、表示しているレポートにフィルターが含まれていて、指定された値が使用できる場合に限り、注釈が使用可能になります。

注釈をフィルター値にリンクするには、次の手順を実行します：

1. 必要なフィルターをレポートに追加します。ただし、フィルターが以下を満たしていることを確認します：
   1. ユーザープロンプトであること
   2. キャッシュされていること
2. Select the Filter from the first drop down list in the Annotation window
3. Select the desired value from the second drop down list in the Annotation window

Note: if you apply a Filter link to your Annotation, the Visibility options will be reduced to Report and View. This is because the filter is linked to a view field and as such cannot be applied to reports based on other views.

Visibility

Here you should select the level of your Annotation. This will restrict what content it can appear on. There are three levels available:

1. This Report (Report Level): These annotations are only attached to a single report. Any date that falls on the specified date, or within the range, will be annotated.
2. Multi-Report - View (View Level): Any annotation applied to the view level will be displayed on all reports written off the selected view. This is where tags become more important. For example, if you add an annotation about an invoicing system you should apply a tab, such as 'Invoicing'. This will allow you to hide the annotation when you are viewing a report about Date of Births, where invoicing is irrelevant.
3. Multi-Report - Global (Organisation Level): Anyone who belongs to the same organisation as the annotation creator will be able to see these annotations on any reports with the matching date data. Again, tagging is important here, as you are dealing with a wide range of reports.

Note: If the Annotation is linked to a filter, the Global (Organisation) level will not be available, as the filter is linked to a view field and as such cannot be applied to reports based on other views.

Tag

Specify a tag to categorise your Annotation. This can be left blank, but it's suggested that tags are used where possible in order to make it easier for the users to view content relevant to them.

A new tag can be added by typing the description of the tag in the text box at the bottom of the list and clicking Add.

Title

Enter the Subject of your Annotation

Description

This is where you should enter the details of your Annotation, and format as desired.

Security

Annotations are set to Public by default. In order to restrict visibility of the annotation, complete the following:

1. Click on the + Add people to make private link
2. From here you are able to search through Yellowfin users & groups. Enter a search term in order to locate a user or group allowed to view the annotation. You will notice that groups have this symbol next to them.
   
3. Click the user/group you wish to add and continue until you have all the users required. Note: the creator of the annotation will always have permission to view it, and will be added by the system automatically.
   

Note: Annotations will always be secured by Client Org (if implemented), so even if set to Public, only users and groups within the Org it was created in will have access. If your Annotation is Private the flag on a chart will be red, rather than grey.

Viewing Annotations

By default, a report will display an Annotation if the following criteria are met:

1. The Report and/or Time Series Chart contains the matching date or range specified in the Annotation
2. Annotations display is enabled during report creation
   
3. The Filters used in the Report match those used in the Annotation (if specified)
4. The Annotation is Untagged OR matches a tag specified in the Report Save Menu
   

Annotation Display Options

There are options available in the Annotation Menu of an active report, that allow the user to restrict the Annotations seen on the report.

From this menu, the user can select which Level of Annotations they wish to view on the report, by ticking or unticking the appropriate check boxes.

The user can then specify which Annotations they wish to view by the tags that have been applied to them (or untagged as the case may be).

Global Annotations

When using the Client Organisations feature in Yellowfin, Administrators of the Primary Org will have the option enable Global Annotations. Enabling this feature means that all Annotations created at the Primary Org (Default Level) will be passed through and visible in all Client Orgs.

To enable this, the Administrator will have to:

1. Navigate to Administration > Configuration > Authentication
2. Under the Client Organisation Functionality, set Global Annotations to Yes.
3. Save the settings.

Users logged in at the Client Org level will not be able to Edit or Delete the Global Annotations. They will, however, be able to display or hide them through the same display settings as their own Client Annotations.

Note: when Global Annotations are enabled, the Annotations at the Primary Org will be set to Public.