ルール（自動タグ付け）を一括で登録する方法を知りたい
はじめに
JSONファイルを使用して、ルールの新規作成・追加・編集を行うことができます。
アセット管理画面で データ一括入力 をクリックすると、図のような画面が表示されます。ここから操作を行います。
ルールの新規作成
一括でルールの新規作成をする場合に利用します。
登録手順
- 操作
新規作成 を選択します。 - ダウンロード
テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。 - ご自身でデータの入力
ダウンロードしたJSONファイルに関して、必要な項目を入力します。 - 再アップロード
入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。 - 登録完了
アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。
新規作成時のテンプレート詳細
新規作成 時にダウンロードするテンプレートは次のような構成になっています。
[
{
"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 | 適用タグ | ルールが適用されたときにアセットに付与するタグを設定します。予めタグ用語集に登録する必要があります。 記入方法は、タグカテゴリ名、スラッシュ、タグ名の順に記載します。 例）タグカテゴリ名：キーワード、タグ名：サービスA キーワード/サービスA |
| 4 | source_object_type | 適用元のアセット | 次のいずれかを入力します。複数記入する場合は、カンマで区切ります。 schema table column |
| 5 | destination_object_type | 適用先のアセット | 次のいずれかを入力します。複数記入する場合は、カンマで区切ります。 schema table column |
| 6 | and_or | 条件 | andもしくはorを記入します。 |
| 7 | object | 対象 | 条件式を適用する対象を指定するため、次のいずれかを入力します。 physical_name（物理名） logical_name（論理名） description（概要） comment_on_ddl（DDL内のコメント） service_name（サービス名） property（プロパティ） ※propertyを設定した場合は、次の8.9.10.も設定が必要です。 |
| 8 | property_set_id | プロパティセットのID | ppstで始まるプロパティセットのIDを指定します。 |
| 9 | property_id | プロパティのID | ppで始まるプロパティのIDを指定します。 |
| 10 | property_type | プロパティの種類 | 下記をご参照ください。 |
| 11 | options | 大文字小文字を区別 | 13.値について大文字と小文字を区別する場合に、case_sensitive、を指定します。 |
| 12 | operator | 演算子 | 7.対象によって指定できる値が異なります。下記をご参照ください。 |
| 13 | values | 値 | 7.対象に適用する演算子に対応する値を記入します。 |
同一名称の異なるルールセットを区別して登録することはできません。ルールセット名は一意である必要があります。
- 対象：物理名（physical_name）、論理名（logical_name）、概要（description）、DDL内のコメント（comment_on_ddl）、サービス名（service_name）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 一致する | is | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 一致しない | is_not | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 含む | contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 含まない | not_contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 〜で始まる | begin_with | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 〜で終わる | end_with | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 正規表現 | regex_match |
正規表現で記入 ※対応表現 |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：単一選択（single_choice）、複数選択（multiple_choice）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 含む | contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 含まない | not_contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：自由入力（free_input）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 一致する | is | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 一致しない | is_not | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 含む | contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 含まない | not_contain | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 〜で始まる | begin_with | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 〜で終わる | end_with | 自由入力 ※カンマ区切りを利用することで複数の値をOR条件で追加できます。 |
| 正規表現 | regex_match | 正規表現で記入 ※対応表現 |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：ユーザー（user）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 含む | contain | Quollio Data Catalogに登録されたユーザーを選択 |
| 含まない | not_contain | Quollio Data Catalogに登録されたユーザーを選択 |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：アセット（asset）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 含む | contain | Quollio Data Catalogに登録されたアセット（スキーマ、テーブル、カラム）を選択 |
| 含まない | not_contain | Quollio Data Catalogに登録されたアセット（スキーマ、テーブル、カラム）を選択 |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：日時（datetime）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 一致する | is | 日付入力 例）2023-01-31T15:00:00.000Z |
| 一致しない | is_not | 日付入力 例）2023-01-31T15:00:00.000Z |
| 〜より後 | after | 日付入力 例）2023-01-31T15:00:00.000Z |
| 〜より前 | before | 日付入力 例）2023-01-31T15:00:00.000Z |
| 〜から | from | 日付入力 例）2023-01-31T15:00:00.000Z |
| 〜まで | until | 日付入力 例）2023-01-31T15:00:00.000Z |
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
- 対象：プロパティ（property）、プロパティの種類：URL（url）、添付ファイル（attachment）
| 設定内容 | 演算子（operator） | 値（values） |
|---|---|---|
| 空である | is_empty | （入力なし） |
| 空でない | is_not_empty | （入力なし） |
ルールの追加
一括でルールの追加をする場合に利用します。
登録手順
- 操作
追加 を選択します。 - ダウンロード
テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。 - ご自身でデータの入力
ダウンロードしたJSONファイルに関して、必要な項目を入力します。 - 再アップロード
入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。 - 登録完了
アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。
追加時のテンプレート詳細
追加 時にダウンロードするテンプレートは次のような構成になっています。
[
{
"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は変更できません。
ルールの編集
一括でルールの編集をする場合に利用します。
登録手順
- 操作
編集 を選択します。 - ダウンロード
テンプレートをダウンロード からテンプレートになるJSONファイルをダウンロードします。 - ご自身でデータの入力
ダウンロードしたJSONファイルに関して、必要な項目を入力します。 - 再アップロード
入力が完了したJSONファイルに関して、JSONアップロード ボタンよりアップロードを行います。 - 登録完了
アップロードが完了しました のトーストが表示されます。アップロードの進行状況・結果に関しては、別セクション アップロード履歴 から確認することができます。
編集時のテンプレート詳細
編集 時にダウンロードするテンプレートは次のような構成になっています。
[
{
"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は変更できません。