ジョブおよびデータフローの開発

ジョブの文書化

Objective

After completing this lesson, you will be able to 説明および注釈を含むコメントの書き込み

説明とアノテーション

説明と注釈は、オブジェクトおよびワークスペースダイアグラムにコメントを追加する便利な方法です。

これは、プロジェクトの設計を共有する必要がある場合や、各オブジェクトの目的を明確に把握し、目標を達成したかどうかを確認する手段を提供する場合に役立ちます。

説明内容、および説明を表示する場所に応じて、説明または注釈を追加することができます。

  • 説明は特定のオブジェクトにリンクされ、オブジェクトが表示されるダイアグラムだけでなく、ローカルオブジェクトライブラリにも表示されます。
  • アノテーションは、ダイアグラムにのみ表示される独立したふせんです。

オブジェクトでのテキストの使用

説明は特定のオブジェクトに関連付けられます。オブジェクトプロパティダイアログを表示して、オブジェクトプロパティを入力することができます。

[ローカルオブジェクトライブラリ] リストに表示されます。

リポジトリオブジェクトがインポートおよびエクスポートされると、説明もインポートまたはエクスポートされます。

データフローデザイナは、システムレベルの設定およびオブジェクトレベルの設定に基づいて、ダイアグラムにオブジェクトの説明を表示するタイミングを決定します。特定のオブジェクトのテキストを表示するには、両方の設定を有効化する必要があります。

注記

システムレベルの設定は、設定に固有です。

ダイアグラムで説明を表示するための要件

  • オブジェクトのプロパティに説明が入力されている
  • 説明はそのオブジェクトのプロパティで有効化されます。
  • グローバル View Enabled Object Descriptions オプションが有効化されている

注記

説明の有効化オプションは、ワークスペースに少なくとも 1 つのオブジェクトが表示されている場合にのみ使用できます。

ダイアグラムでのアノテーションの使用

注釈は、ワークスペース内のステッキノートのようなオブジェクトです。注釈は、その注釈が表示されるオブジェクトダイアグラムに関連付けられます。

ジョブ、ワークフロー、またはデータフローがインポートまたはエクスポートされ、注釈が含まれている場合、関連する注釈もインポートまたはエクスポートされます。

説明とアノテーションの追加方法について説明します。