SAP Fiori Elements のプロパティ注釈の例の説明

SAP Fiori Elements は、SAP が提供するユーザーインターフェイス開発フレームワークで、開発者は Fiori 設計原則に準拠したアプリケーションを作成できます。このフレームワークは主に、SAP の HTML5 ベースのユーザーインターフェイステクノロジである SAPUI5 に基づいています。Fiori Elements は、ユーザーインターフェイスを定義するための宣言的な方法を提供します。つまり、開発者は大量のフロントエンドコードを記述する必要がありません。代わりに、アノテーションと呼ばれる手法を使用して、アプリケーションがデータをどのように表示および操作するかを記述することができます。

SAP Fiori Elements アプリケーションノートでは、「propertyAnnotations」は、データモデル内の特定のプロパティのプロパティと動作を説明する手段です。これにより、開発者はコードを直接記述するのではなく、より高いレベルの方法でユーザーインターフェイスを定義できるようになります。これらの注釈は、データモデルのメタデータドキュメントで直接定義することも、注釈ファイルと呼ばれる別の XML ドキュメントで定義することもできます。

「propertyAnnotations」の各項目は、データモデルのプロパティに関連付けられます。各プロパティの注釈には、ユーザーインターフェイスでのプロパティの表示方法、編集可能かどうか、必須かどうかなど、プロパティのさまざまな側面を説明する複数の注釈項目を含めることができます。これらの注釈項目は事前定義されており、その意味と動作は Fiori Elements フレームワークによって解釈および実装されます。

たとえば、注文の金額を表す「Amount」というプロパティを持つ、注文を表すデータモデルがあるとします。「propertyAnnotations」を使用して、このプロパティをユーザーインターフェイスでどのように表示するかを記述することができます。考えられるアノテーション定義は次のとおりです。

<Annotations Target="MyModel.Order/Amount">
    <Annotation Term="Common.Label" String="Order Amount" />
    <Annotation Term="Common.Text" Path="AmountText" />
    <Annotation Term="UI.DataField" >
        <Record>
            <PropertyValue Property="Value" Path="Amount" />
            <PropertyValue Property="Label" String="Order Amount" />
            <PropertyValue Property="Criticality" Path="AmountCriticality" />
        </Record>
    </Annotation>
</Annotations>

この例では、3 つのアノテーション項目を定義します。「Common.Label」アノテーションは、ユーザーインターフェイスの属性のラベルを定義します。「Common.Text」アノテーションは、プロパティ値のテキスト表現を生成するために使用されるプロパティへのパスを定義します。「UI.DataField」アノテーションは、ユーザーインターフェイスでプロパティがどのように表現されるかを説明します。その「Value」属性はデータフィールドの値を定義し、「Label」属性はデータフィールドのラベルを定義し、「Criticality」属性はデータフィールドの重要性または重大度を表す属性へのパスを定義します。

別の例を見てみましょう。

上の図で強調表示されている注釈は、metadata.xml次の場所からのものです。

SAP Fiori Elements のプロパティ注釈の例の説明

おすすめ