JSONによるルール（自動タグ付け）の管理 - 旧ドキュメント

この機能を使用できるユーザー

管理者・運用者

はじめに

JSONファイルを使用して、ルールの新規作成・追加・編集を行うことができます。

アセット管理画面で データ一括入力 をクリックすると、図のような画面が表示されます。ここから操作を行います。

ルールの新規作成

一括でルールの新規作成をする場合に利用します。

登録手順

1. 操作
   新規作成 を選択します。
2. ダウンロード
   テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。
3. ご自身でデータの入力
   ダウンロードしたJSONファイルに関して、必要な項目を入力します。
4. 再アップロード
   入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。
5. 登録完了
   アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。

新規作成時のテンプレート詳細

新規作成 時にダウンロードするテンプレートは次のような構成になっています。

[
  {
    ""rule_set_name"": ""用語分類:番号"", # 1.ルールセット名
    ""rule_set_description"": ""番号に関連するカラムを検知するルールセット"", # 2.ルールセット概要
    ""rules"": [
      {
        ""target_tags"": [ # 3.適用タグ
          ""用語分類:番号/郵便番号"" 
        ],
        ""source_object_type"": [ # 4.適用元のアセット
          ""column"" 
        ],
        ""destination_object_type"": [ # 5.適用先のアセット
          ""table"",
          ""column""
        ],
        ""and_or"": ""or"", # 6.条件
        ""conditions"": [
          {
            ""object"": ""physical_name"", # 7.対象
            ""property_object"": {
              ""property_set_id"": """", # 8.プロパティセットのID
              ""property_id"": """", # 9.プロパティのID
              ""property_type"": """" # 10.プロパティの種類
            },
            ""options"": [ # 11.大文字小文字の区別
              """" 
            ],
            ""operator"": ""contain"", # 12.演算子
            ""values"": [ # 13.値（カンマ区切り）
              ""郵便番号"",
              ""ZIP""
            ]
          },
          {
            ""object"": ""logical_name"", # ※複数の条件式を設定する場合はconditionsに追加
            ""property_object"": {
              ""property_set_id"": """",
              ""property_id"": """",
              ""property_type"": """"
            },
            ""options"": [],
            ""operator"": ""contain"",
            ""values"": [
              ""郵便番号"",
              ""ZIP""
            ]
          }
        ]
      }
    ]
  }
]

1. rule_set_name — ルールセット名

任意の文字列

2. rule_set_description — ルールセット概要

ルールセットの説明文

3. target_tags — 適用タグ

ルールが適用されたときにアセットに付与するタグ。あらかじめタグ用語集に登録されている必要があります。
書式は、タグカテゴリ名、タグ名の順に、スラッシュ [/] で区切って記入します。

4. source_object_type — 適用元のアセット

次のいずれかを記入します。複数設定可能。複数を指定する場合は、カンマで区切ります。

• schema
• table
• column

5. destination_object_type — 適用先のアセット

次のいずれかを記入します。複数設定可能。複数を指定する場合は、カンマで区切ります。

• schema
• table
• column

6. and_or — 条件

andもしくはor

7. object — 対象

条件式を適用する対象として、次のいずれかを記入します。propertyの場合は、8・9・10も記入が必要です。

• physical_name（物理名）
• logical_name（論理名）
• description（概要）
• comment_on_ddl（DDL内のコメント）
• service_name（サービス名）
• property（プロパティ）

8. property_set_id — プロパティセットのID

ppstで始まるプロパティセットのID

9. property_id — プロパティのID

ppで始まるプロパティのID

10. property_type — プロパティの種類

以下のいずれかを記入します。

• single_choice — 単一選択
• multiple_choice — 複数選択
• free_input — 自由入力
• user — ユーザー
• asset — アセット
• datetime — 日時
• url — URL
• attachment — 添付ファイル

11. options — 大文字小文字を区別

13valuesについて大文字と小文字を区別する場合、case_sensitiveを記入します。

12. operator — 演算子

7objectによって、記入する値が異なります。

13. values — 値

7objectによって、記入する値が異なります。

同一名称の異なるルールセットを区別して登録することはできません。ルールセット名は一意である必要があります。

7object — 演算子と値の関係

10property — 演算子と値の関係

単一選択（single_choice）または 複数選択（multiple_choice）

自由入力（free_input）

ユーザー（user）

アセット（asset）

自由入力（free_input）

URL（url）、添付ファイル（attachment）

ルールの追加

一括でルールの追加をする場合に利用します。

登録手順

1. 操作
   追加 を選択します。
2.  ダウンロード
   テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。
3. ご自身でデータの入力
   ダウンロードしたJSONファイルに関して、必要な項目を入力します。
4. 再アップロード
   入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。
5. 登録完了
   アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。

追加時のテンプレート詳細

追加 時にダウンロードするテンプレートは次のような構成になっています。

[
  {
    ""rule_set_id"": ""rlst-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"",
    ""rules"": [
      {
        ""target_tags"": [ # 3.適用タグ
          """"
        ],
        ""source_object_type"": [ # 4.適用元のアセット
          """"
        ],
        ""destination_object_type"": [ # 5.適用先のアセット
          """"
        ],
        ""and_or"": """", # 6.条件
        ""conditions"": [
          {
            ""object"": """", # 7.対象
            ""property_object"": {
              ""property_set_id"": """", # 8.プロパティセットのID
              ""property_id"": """", # 9.プロパティのID
              ""property_type"": """" # 10.プロパティの種類
            },
            ""options"": [ # 11.大文字小文字の区別
              """"
            ],
            ""operator"": """", # 12.演算子
            ""values"": [ # 13.値（カンマ区切り）
              """"
            ]
          }
        ]
      }
    ]
  },
  {
    ""rule_set_id"": ""rlst-yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"", # ※以下、ルールセットの数だけ表示されます。
    ""rules"": [
      {
        ""target_tags"": [
          """"
        ],
        ""source_object_type"": [
          """"
        ],
        ""destination_object_type"": [
          """"
        ],
        ""and_or"": """",
        ""conditions"": [
          {
            ""object"": """",
            ""property_object"": {
              ""property_set_id"": """",
              ""property_id"": """",
              ""property_type"": """"
            },
            ""options"": [
              """"
            ],
            ""operator"": """",
            ""values"": [
              """"
            ]
          }
        ]
      }
    ]
  }
]

各項目は、新規作成時のテンプレート詳細をご参照ください。

rule_set_idは、ルール設定画面の各ルールセットに対応したURLのrlst-で始まる文字列です。このIDは変更できません。

ルールの編集

一括でルールの編集をする場合に利用します。

登録手順

1. 操作
   編集 を選択します。
2.  ダウンロード
   テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。
3. ご自身でデータの入力
   ダウンロードしたJSONファイルに関して、必要な項目を入力します。
4. 再アップロード
   入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。
5. 登録完了
   アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。

編集時のテンプレート詳細

編集 時にダウンロードするテンプレートは次のような構成になっています。

[
  {
    ""rule_set_id"": ""rlst-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"",
    ""rule_set_name"": ""用語分類:番号"", # 1.ルールセット名
    ""rule_set_description"": """", # 2.ルールセット概要
    ""rules"": [
      {
        ""rule_id"": ""rl-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"",
        ""target_tags"": [ # 3.適用タグ
          ""用語分類:番号/ストレージ番号""
        ],
        ""source_object_type"": [ # 4.適用元のアセット
          ""column""
        ],
        ""destination_object_type"": [ # 5.適用先のアセット
          ""table"",
          ""column""
        ],
        ""and_or"": ""or"", # 6.条件
        ""conditions"": [
          {
            ""object"": ""physical_name"", # 7.対象
            ""property_object"": {
              ""property_set_id"": """", # 8.プロパティセットのID
              ""property_id"": """", # 9.プロパティのID
              ""property_type"": """" # 10.プロパティの種類
            },
            ""options"": [], # 11.大文字小文字の区別
            ""operator"": ""regex_match"", # 12.演算子
            ""values"": [ # 13.値（カンマ区切り）
              ""(ストレージ|STORAGE|Storage|_storage)(-|_)*(?i)(番号|no|number|num|bango|bng)(-|_)*[0-9]*$""
            ]
          },
          {
            ""object"": ""logical_name"",
            ""property_object"": {
              ""property_set_id"": """",
              ""property_id"": """",
              ""property_type"": """"
            },
            ""options"": [],
            ""operator"": ""regex_match"",
            ""values"": [
              ""(ストレージ|STORAGE|Storage|_storage)(-|_)*(?i)(番号|no|number|num|bango|bng)(-|_)*[0-9]*$""
            ]
          }
        ]
      },
      {
        ""rule_id"": ""rl-yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"", # ※以下、ルールとルールセットの数だけ表示されます。
        ""target_tags"": [
          ""用語分類:番号/郵便番号""
        ],
        ""source_object_type"": [
          ""column""
        ],
        ""destination_object_type"": [
          ""table"",
          ""column""
        ],
        ""and_or"": ""or"",
        ""conditions"": [
          {
            ""object"": ""physical_name"",
            ""property_object"": {
              ""property_set_id"": """",
              ""property_id"": """",
              ""property_type"": """"
            },
            ""options"": [],
            ""operator"": ""regex_match"",
            ""values"": [
              ""(郵便|ZIP|Zip|_zip|POSTAL|Postal|_postal|ユウビン|YUUBIN|Yuubin|_yuubin)(-|_)*(?i)(番号|no|number|num|bango|bng)(-|_)*[0-9]*$""
            ]
          },
          {
            ""object"": ""logical_name"",
            ""property_object"": {
              ""property_set_id"": """",
              ""property_id"": """",
              ""property_type"": """"
            },
            ""options"": [],
            ""operator"": ""regex_match"",
            ""values"": [
              ""(郵便|ZIP|Zip|_zip|POSTAL|Postal|_postal|ユウビン|YUUBIN|Yuubin|_yuubin)(-|_)*(?i)(番号|no|number|num|bango|bng)(-|_)*[0-9]*$""
            ]
          }
        ]
      }
    ]
  }
]

各項目は、新規作成時のテンプレート詳細をご参照ください。

rule_set_idとrule_idのIDは変更できません。