--- title: "参照コード" canonical: "https://wiki.yellowfin.co.jp/space/yfcurrent/1903986/%E5%8F%82%E7%85%A7%E3%82%B3%E3%83%BC%E3%83%89" format: markdown --- > Macro (anchor) > Macro (toc) ## 概要 参照コードは、各フィールド値にコードをマッピングすることで、数値およびテキストベースのデータを含むレポートで、より意味のある値を表示することができます。例えば、「Y」または「N」を含むテキストフィールドをマッピングすることで、「Yes」または「No」と表示できます。 システム管理者は、参照コードページで[モデル](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1900971)を通して作成された既存の参照コードを編集できます。 ### 参照コードの使用例 参照コードのマッピングは、あらゆる種類のものに使用できます。以下に例を示します。 - より説明的なテキストの提供 (上記の「Y」や「N」のような場合) - 翻訳された選択肢の提供 (多言語展開を有効にしている場合のみ利用可能)。これは、値を翻訳された同等のものにマッピングすることができます (上記の例では、フランス語の「Oui」や「Non」は、「Yes」や「No」と表示されます) - テーブルおよびグラフでカスタマイズされた並べかえを使用 (例えば、次の例で示すように、一部の結果に重みをつけて表示したい場合など) - 各値にカスタムカラーを追加 - 各値にカスタムイメージを追加 カスタマイズされた並べかえを例に挙げてみましょう。データは通常クエリーから英数字順で返されます。データに「Admin Staff」、「Management」、「Executive Management」が含まれる場合、レポート結果は以下のように表示されます。 | | | | --- | --- | | Admin Staff | 500 | | Executive Management | 10 | | Management | 50 | 以下に示す順序のように、好みの並べかえ順に表示したい場合は、要件に合わせて各値に並べかえ順の番号をマッピングできます。以下のように表示するには、「Executive Management」が1、「Management」が2、「Admin Staff」が3と設定します。 | | | | --- | --- | | Executive Management | 10 | | Management | 50 | | Admin Staff | 500 | ## 参照コードへのアクセス 参照コードは、Yellowfinの管理コンソール内に保存されています。ページにアクセスするには、以下の手順に従います。 1. 画面左側のメニューボタン> Macro (inline-media-image) をクリックします。 2. 表示されたメニューから、**管理**＞**管理コンソール**を選択します。 3. 表示されたページで、**参照コード**項目をクリックします。 既存の参照コードの一覧と**追加**ボタンが表示されます。 > Macro (inline-media-image) ## 参照コードダイアログボックスの使用 参照コードダイアログボックスには、詳細、値、翻訳 (ご利用の環境で多言語展開を有効化にしている場合)、更新の4つのタブがあり、それぞれが異なる機能を提供します。各タブの詳細は、以下を参照してください。 ### 詳細タブ 詳細タブでは、この参照コードでどの項目を有効および無効にするかを選択します。こちらで項目を変更すると、他のタブで利用できるオプションに影響します。 ![image](media://16d484f6-e6d8-451b-b880-4f25cf2681b7) | | | | --- | --- | | **項目名** | **説明** | | 名前 | この参照コードの名前を入力します。 | | カスタムソート | 有効にすると、デフォルトの並べかえ順を、独自のカスタムオーダーに変更できます。例えば、January = 1、February = 2と設定することで、月名を時系列で並べかえることができます。
このトグルはデフォルトで無効になっています。 | | カスタムカラー | 有効にすると、各値に色を割り当てることができます。こちらで設定した色は、グラフやフィルターにも使用できるので、値を簡単に識別し、レポートに一貫性を持たせることができます。
このトグルは、デフォルトで無効になっています。 | | カスタムイメージ | 有効にすると、各値にイメージを割り当てることができます。こちらで設定したイメージは、「一覧に含む」フィルター使用時に表示され、ユーザーの値選択をサポートします。イメージは、一覧の値の横に表示されます。
このトグルは、デフォルトで無効になっています。 | | 値の空白を削除 | 有効にすると、値の先頭と末尾の空白を削除することができます。
このトグルは、デフォルトで有効になっています。 | ### 値タブ [値]タブでは、[詳細]タブで有効にしたオプションを定義します。たとえば、[既定値]タブで[カスタム並べ替え]オプションを有効にしていない場合、[値]タブでは[並べ替え]列が利用できません。 バージョン9.16.1より、このポップアップのパフォーマンスが最適化され、大量の参照コードを処理できるようになりました。さらに、ユーザーはコードまたは説明の全文または一部を入力することでリストをフィルタリングできます。検索フィールドのいずれかにテキストを入力すると、リストは即座にフィルタリングされます。 ![image-20260121-062708.png](media://a5e30cde-1dbe-42b0-8379-d512df043d97) | | | | --- | --- | | **項目名** | **説明** | | コード | データベースで使用されている値で、新しいテキストに置き換えられます。 | | 説明 | コードの代わりに、レポートやフィルター、グラフに表示されるテキストです。 | | 並べかえ | 独自の並べかえ順を作成するために、こちらの項目に数字を入力します。後から並べかえ順にさらに値を追加する予定がある場合は、より柔軟な番号付けシステムを検討してください。例えば、上位3つのオプションに1,2,3と番号を付ける代わりに、10,20,30を使用することで、将来的に既存の値の間に素早く追加の値を挿入することができます。 | | 色 | 項目をクリックして、値のカスタムカラーを定義します。 | | イメージ | 項目をクリックしてイメージ管理を表示し、値に関連する既存のイメージを選択します (または、アクセス権がある場合は、新しいイメージをアップロードします)。 | | プラス (+) ボタン | 一覧に新しい値を追加する場合、詳細をすべて入力したら、プラス (+) ボタンをクリックします。最後の項目を入力したら、必ずこちらのプラス (+) ボタンをクリックしてください。 | | CSVから投入します。 | これらの詳細を含む一覧が既にある場合は、こちらのリンクをクリックしてCSV ファイルをアップロードすることで、このタブに素早く値を入力できます。CSV ファイルには、コード、説明、並べかえの3つのフィールドを含めることができます。テキストフィールドを含むCSV ファイルをアップロードした後に、カスタムカラーおよびイメージを定義しなくてはいけません。 | ### 翻訳タブ このタブは、Yellowfin内で多言語展開を有効にしている場合にのみ表示されます。こちらから翻訳する言語を選択し、参照コードの名前を入力して、各値に翻訳を提供します。 バージョン9.16.1以降、ユーザーはコードまたは説明の全文または一部を入力することでリストをフィルタリングできます。検索フィールドのいずれかにテキストを入力すると、リストは即座にフィルタリングされます。 ![image-20260121-062940.png](media://3eb490e6-dee9-4810-a90b-51e99e00d91b) | | | | --- | --- | | **項目名** | **説明** | | 言語 | ドロップダウンリストを使用して、ご利用の環境で利用可能な言語の一覧から別の言語を選択します。 | | 名前 | この項目には、詳細タブの名前項目に入力した参照コード名の翻訳を入力します。上図の例で、参照コード名は「顧客タイプ」になっていますが、こちらには翻訳された「Demographic」を入力します。 | | コード | この項目には、値タブのコード項目と同じ値が表示されるので、翻訳する各値を確認できます。 | | デフォルト | この項目には、値タブの説明項目と同じ値が表示されるので、コード項目がご利用の環境のデフォルトの言語でどのようにマッピングされているかを確認できます。 | | 翻訳 | この項目には、各値の翻訳を入力します。 | | 並べかえ | 並べかえ項目は空欄にしておくことを推奨します。これは、値タブで設定した並べかえ順がデフォルトで適用されるため、閲覧者が使用している言語にかかわらず、コンテンツを同じ順序で表示するためです。 | ### 更新タブ 更新タブでは、コンテンツにマッピングされたコード値を更新する方法として、3つのオプションを提供します。 ![image](media://6a6f9d54-e588-4190-855b-d38aabb74bf8) | | | | --- | --- | | **オプション** | **説明** | | 手動 | 引き続き各値を手動で入力したい場合は、こちらのオプションを使用します (または、値タブのCSVから投入します。リンクを使用して手動でインポートします)。 | | スケジュール同期 | 特定のデータソースから定期的に値を同期したい場合は、こちらのオプションを使用します。同期する頻度をスケジュール設定することができます。こちらのオプションの使用は、ひとつのフィールドに限定されていることに注意してください。 | | スケジュールされたクエリー | SQLクエリーを使用して定期的に値を更新したい場合は、こちらのオプションを使用します。これはフィールドに入力する最も簡単な方法ですが、SQLの知識が必要です。 |
展開して設定手順を確認する データソースから値を同期するスケジュールを設定するには、以下の手順に従います。 1. 値の更新設定方法として、「**スケジュール同期**」を選択します。 2. 新しい値で既存の値を置き換える場合は、「**既存の値の上書き**」トグルを有効にします。こちらのトグルを無効にした場合は、既存の値を削除、更新することなく、新しい値が追加されます。 3. 値を取得するデータソース、ビュー、フィールドを指定します。 4. 値を更新する頻度を設定します。例えば、週次で更新されるように設定することができます。 5. 値が更新された時に通知を受信する管理者ユーザーを設定することができます。 6. 「**保存**」ボタンをクリックして、更新を実行します。 7. こちらのオプションの使用は、ひとつのフィールドにのみ限定されていることに注意してください。この場合は、コードと説明の値は同一になります。そのため、[参照コード#値](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903986#値)タブから手作業で説明を更新しなくてはいけません。 ヒント：こちらの更新タスクは、スケジュール管理から実行することもできます。
展開して設定手順を確認する SQLクエリーを使用して参照コードフィールドに値を追加するには、以下の手順に従います。 1. 値の更新設定方法として、「**スケジュールされたクエリー**」を選択します。 2. 新しい値で既存の値を置き換える場合は、「**既存の値の上書き**」トグルを有効にします。こちらのトグルを無効にした場合は、既存の値を削除、更新することなく、新しい値が追加されます。 3. 値をインポートするデータソースを選択します。 4. SQLクエリーを記述します。 > Macro (inline-media-image) **注意：**クエリー内ではカラム（列）の順序を正確に指定しなくてはいけません。例：コード、言語（多言語設定をしている場合）、説明、並び順（カラム（列）名も正確でなくてはいけません）。 5. クエリー記述時には、「**クエリーのヘルプ**」を参照できます。 6. ページ下部にある「**テストクエリー**」ボタンをクリックして、クエリーをテストします。クエリーが有効であれば、メッセージとともに、結果の例が表示されます（テストクエリーボタンは、保存ボタンに変わります）。 7. 値を更新する頻度を設定します。例えば、週次で更新されるように設定することができます。 8. 値が更新された時に通知を受信する管理者ユーザーを設定することができます。 9. 「**保存**」ボタンをクリックして、更新を実行します（スケジュールされたクエリーの設定は、クエリーが有効の場合にのみ保存することができます）。 ヒント：こちらの更新タスクは、スケジュール管理から実行することもできます。
### 使用タブ こちらのタブにはコードの現在の使用状況が表示されます。これは、コードを削除する前に、使用箇所を確認する場合に使用すると便利です。 ![image](media://2a229adc-794f-4552-9254-7be8e4971170) ## 参照コードの作成 新しい参照コードを作成する場合は、上記情報を参考に、以下の手順に従います。 1. 管理コンソールの**参考コード**項目を展開します。 2. 既存の参照コード一覧の下部にある**追加**ボタンをクリックします。 3. **詳細**タブで参照コードの名前を入力し、必要な項目を設定します (各項目の詳細については、[参照コード#詳細タブ](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903986#詳細タブ)参照してください)。 > Macro (inline-media-image) 4. **値**タブをクリックして、マッピングするコンテンツを入力します (各項目の詳細については、[参照コード#値タブ](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903986#値タブ)を参照してください)。 各行を追加していくと、既存の行は並べかえ順に従い並べかえられます。並べかえ順を設定していない場合は、説明項目の英数字順に並べかえられます。 5. 翻訳を追加する場合は、**翻訳**タブをクリックしてこれを入力します (各項目の詳細については、[参照コード#翻訳タブ](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903986#翻訳タブ)を参照してください)。 6. **更新**タブをクリックして、更新方法として**手動**が選択されていることを確認します (外部ソースからの更新をスケジュール設定したい場合は、[参照コード#更新タブ](https://yellowfinjp.atlassian.net/wiki/spaces/yfcurrent/pages/1903986#更新タブ)項目で詳細を確認してください)。 > Macro (inline-media-image) 7. **保存**ボタンをクリックして、新しい参照コードを保存します。 ## クライアント組織参照コードの上書き クライアント組織レベルで参照コードを管理する場合、デフォルト組織レベルで定義された参照コードを上書きすることができます。これにより、デフォルト組織レベルで定義されたコンテンツ内で、クライアント組織の参照コードを使用することが可能になります。 クライアント組織で参照コードを作成する際、「親参照コードを上書きする」というオプションを使用すると、上書き対象としてデフォルト組織の参照コードを選択できます。このオプションを「上書きしない」のままにすると、その参照コードはクライアント組織レベルで作成されたコンテンツでのみ使用可能となります。 ![image-20260715-065645.png](media://817b81b2-1b11-4cb0-aef7-b88afb8c9d10) デフォルト組織参照コードを上書きするために選択すると、ポップアップが表示され、既存のデフォルト組織参照コードの値をクライアント組織版の参照コードに複製するかどうかを尋ねられます。「はい」を選択すると、この参照コードの値が事前に入力されます。 ![image-20260715-065731.png](media://cb6b430f-6108-4134-a6b3-1cab1a01ec92) デフォルト組織から値がインポートされた場合でも、利用可能な参照コードの値にカスタム値を追加することは可能です。また、デフォルト組織からインポートされたエントリについては、新しい説明文、色、または画像を使用して変更を加えることもできます。 ![image-20260715-065820.png](media://8ddc5ea3-c3ac-43a1-af32-ad12c887bdc1) 保存すると、クライアント組織参照コードは、デフォルト組織版の参照コードが使用されているデフォルト組織のコンテンツに対して自動的に適用されるようになります。