オントロジーの構築Object and link types型クラスステータス

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

ステータス

オントロジー内のすべてのオブジェクトタイプ、プロパティ、リンクタイプ、アクション、インターフェースには、開発状態を示すステータスがあります。オントロジーリソースのステータスは、アクティブ、実験的、非推奨、例のいずれかです。オブジェクトタイプは推奨にも分類できます。ステータスメタデータは、オントロジーを編集するユーザーが、ユーザーアプリケーションで実際に利用されているリソースを把握するのに役立ちます。これらのステータスは Object Explorer、Object View、Workshop で確認でき、どのオブジェクトタイプがユーザーアプリケーションでの使用を想定しているかについて、より詳しい情報を提供します。

アクティブステータス

ステータスには、次の5つの値のいずれかを設定できます。

利用可能なステータス値

  • 推奨(オブジェクトタイプのみ): オブジェクトタイプが、オントロジー所有者による審査を受けた、信頼できる中核リソースであることを示します。推奨のオブジェクトタイプには、API名についてアクティブのオブジェクトタイプと同様の保護が適用されます。
  • アクティブ: リソースがユーザー向けアプリケーションで実際に使用されており、Ontology Manager で重大な破壊的変更が行われないことを示します。
  • 実験的: リソースがまだ開発中であることを示します。変更により、実験的な項目がユーザー向けアプリケーションで利用できなくなる場合があります。
  • 非推奨: リソースがまもなく削除されることを示します。ユーザー向けアプリケーションでは、非推奨の項目に依存しないでください。
    • 非推奨のリソースには、次の情報を含むメタデータもあります。
      • 非推奨にする理由の説明
      • システムから削除される予定の期限
      • 非推奨のリソースを置き換える予定のリソース
  • 例: リソースが例としてインストールされていることを示します。例のリソースは仮想的なもので、トレーニングや初期段階の探索的な使用にのみ適しています。例は本番ワークフローでの使用を想定していません。

推奨ステータス(オブジェクトタイプのみ)

オブジェクトタイプは、オントロジー内での高い信頼性と正式な位置づけを示す、特別な推奨ステータスをサポートしています。このステータスは、新しい紫色のチェックマークアイコンで表示され、ユーザーが中核となる再利用可能なオブジェクトタイプと、特定のユースケース向けや実験的なオブジェクトタイプとを区別するのに役立ちます。

推奨ステータスは、標準のアクティブステータスよりも目立つように表示されます。このステータスのオブジェクトタイプは、高い基準を満たし、中央チームが管理する「中核」リソースとして扱われることを想定しています。推奨のオブジェクトタイプには、削除の制限など、アクティブステータスと同様の運用上の保護が適用されます。

推奨ステータスの主な特性は次のとおりです。

  • スコープ: 推奨ステータスはオブジェクトタイプにのみ適用されます。プロパティ、リンクタイプ、アクションタイプ、インターフェースには使用できません。
  • 重要性: オブジェクトタイプのステータスを推奨に設定すると、重要性が自動的に強調に設定され、プラットフォーム全体での発見可能性が高まります。ユーザーは任意で、オブジェクトタイプのすべてのプロパティをアクティブステータスに変更できます。
  • 権限:
    • オントロジーレベルでオントロジー所有者ロールを持つユーザーのみが、推奨ステータスを直接適用できます。
    • その他のユーザーがこのステータスを適用するには、提案を送信し、オントロジーレベルのオントロジー所有者による審査と承認を受ける必要があります。
推奨オブジェクトタイプの例

許可されない操作

アプリケーションはオントロジーリソースに依存しているため、リソースのステータスがアクティブの場合、破壊的な影響を及ぼす可能性がある次の操作は許可されません。

  • 削除できません。リソースを削除するには、ステータスが実験的または非推奨である必要があります。
  • アクティブなリソースのAPI名は変更できません。API名を変更できるのは、実験的に指定されているリソースのみです。

ステータスを編集する

デフォルトでは、新しいオントロジーリソースには実験的ステータスが付与されます。ステータスを変更するには、次の手順を実行します。

  1. 現在のステータスの横にあるドロップダウンを選択します。
  2. 新しいステータスを選択します。

リソースを非推奨ステータスに変更すると、次の情報を入力する画面が表示されます。

  • 非推奨にする理由の説明を入力します。
  • システムから削除する予定の期限を入力します。
  • 任意で、非推奨にするリソースを置き換える予定のリソースを選択します。

これらのステータスは Object Explorer、Object View、Workshop で確認でき、どのオブジェクトタイプがユーザーアプリケーションでの使用を想定しているかについて、より詳しい情報を提供します。

ステータスを変更

Ontology Manager は、オブジェクトタイプと、それに関連するプロパティまたはリンクタイプとの間でステータスの整合性を維持します。たとえば、オブジェクトタイプをアクティブから実験的に変更すると、そのすべてのプロパティも実験的に指定されます。

次のテーブルは、異なるステータスのオブジェクトタイプ間のリンクタイプに設定できるステータスを示しています。一般的に、次のようになります。

  • リンクタイプ内のオブジェクトタイプを1つ以上、実験的に変更すると、リンクタイプは自動的に実験的に変更されます。
  • リンクタイプ内のオブジェクトタイプを1つ以上、例に変更すると、リンクタイプは自動的に例に変更されます。
  • リンクタイプ内のオブジェクトタイプを1つ以上、非推奨に変更すると、リンクタイプは自動的に非推奨に変更されます。
オブジェクトタイプ A が…の場合かつオブジェクトタイプ B が…の場合
実験的
実験的実験的のみ
アクティブ実験的のみ
非推奨非推奨のみ

リンクタイプの外部キーにも同じ要件が適用されます。プロパティを変更すると、アプリケーションはリンクタイプのステータスを変更します。

  • 外部キープロパティを実験的に変更すると、そのリンクタイプは実験的に変更されます。
  • 外部キープロパティを例に変更すると、そのリンクタイプは例に変更されます。
  • 外部キープロパティを非推奨に変更すると、そのリンクタイプは非推奨に変更されます。

アプリケーションは、無効な状態を防ぐためにステータスを変更します。外部キープロパティが実験的で、まだ開発中の場合、そのリンクタイプをアクティブに指定して本番環境で依存するべきではありません。一方、プロパティをアクティブに指定した場合、アプリケーションはそのプロパティを外部キーとして参照するリンクタイプをアクティブに変更しません。これは、リンクタイプとその元データソースがまだ開発中であっても、外部キープロパティが本番環境で使用されている状態は有効であるためです。

ステータスを一括編集する

プロパティ

オブジェクトタイプを実験的からアクティブに変更するときに、そのオブジェクトタイプのすべてのプロパティにもアクティブステータスを適用するオプションがあります。

アクティブステータスを適用

オブジェクトタイプを例に変更すると、そのすべてのプロパティも自動的に例になります。

オブジェクトタイプのプロパティのステータスは、オブジェクトタイプのプロパティページから一括編集することもできます。プロパティの一括編集について詳しくは、こちらをご覧ください。

オブジェクトタイプ

オブジェクトタイプのステータスは、ホームページのオブジェクト表示ページから一括編集することもできます。編集するオブジェクトタイプのチェックボックスを選択し、テーブル右上のステータスの編集ボタンを選択します。

オブジェクトタイプを一括編集

トラブルシューティング

プロパティのステータスとリンクタイプのステータスの競合

OntologyMetadata:ConflictBetweenLinkTypeStatusAndPropertyTypeStatus エラーが表示された場合、リンクタイプのステータスとプロパティのステータスが競合しています。たとえば、外部キーが非推奨の場合、その外部キーを参照するリンクタイプも非推奨である必要があります。

オブジェクトタイプのステータスとリンクタイプのステータスの競合

OntologyMetadata:ConflictBetweenLinkTypeStatusAndObjectTypeStatus エラーが表示された場合、リンクタイプのステータスと、それに関連付けられたオブジェクトタイプのいずれかのステータスが競合しています。これは、上のテーブルに照らして、オブジェクトタイプとリンクタイプの組み合わせが無効な場合に発生することがあります。たとえば、実験的なオブジェクトタイプにアクティブなリンクタイプを設定することはできません。