進行状況
定義と用法
進行状況コンポーネントは、進行状況のステータスをグラフィカルに表示するウィジェットです。このコンポーネントは、全体の進行状況を水平進行状況バーとして表示し、進行状況に関する個々の詳細をバーの下に表示します。
進行状況コンポーネントのサンプルイメージを以下に示します。
次の方法で、進行状況コンポーネントを設定できます。
• タイトルを定義する
• 進行状況バーの下のメッセージを設定する
タスク進行状況は、進行状況コンポーネントに使用可能な定義済みのコンフィギュレーションです。
バインドプロパティ
入力 | ||
|---|---|---|
プロパティ名 | 説明 | プロパティタイプ |
Input | バックエンドシステムからフェッチするデータの識別に使用します。 サンプル JSON: { "version":"1.0.0", "data":[ { "adapter":{ "thingName":"PTC.WCAdapter", "instanceName":"windchill" }, "itemListsData":[ { "objectType":"PTC.Workflow.WorkItem", "items":[ { "id":{ "value":"OR:wt.workflow.work.WorkItem:566231" } } ] } ] } ] } | CCOフォーマットの JSON |
コンフィギュレーションプロパティ
次のテーブルは、このコンポーネントの設定に使用される JSON プロパティを示しています。
コンフィギュレーションの構造の詳細については、コンポーネントのコンフィギュレーション構造を参照してください。
サブプロパティの詳細については、サブプロパティとコンテナキーを参照してください。
プロパティ名 | 説明 | プロパティタイプ | デフォルト値 | 必須またはオプション | ||
|---|---|---|---|---|---|---|
title | コンポーネント内のタイトルとして表示される文字列。 | なし | オプション | |||
progressBarMessage | 進行状況バーの下に表示される文字列。これは、アクティビティによって測定された進行状況を示すメッセージです。 進行状況バーのメッセージに表示されているプレースホルダーは %0 および %1 です。既成のコンポーネントでは、これらの値はそれぞれ保留中のアイテムと完了したアイテムに置き換えられます。%total をプレースホルダーとして使用することもできます。これはアイテムの総数に置き換えられます。 たとえば、アイテムの総数が 7 個で、そのうち 5 個のアイテムが完了し、2 個のアイテムがまだ保留中の場合、「%1/%total 個のアイテムが完了しました」という文字列は、ユーザーインタフェースでは「5/7 個のアイテムが完了しました」と表示されます。「%0/%total 個のアイテムが保留中です」という文字列は、ユーザーインタフェースでは「2/7 個のアイテムが保留中です」と表示されます。青色の進行状況バーには、文字列に関係なく、完了したタスクの割合 (%) が反映されます。 | なし | オプション | |||
サンプルコンフィギュレーション
進行状況コンポーネントのサンプルコンフィギュレーションについては、タスク進行状況を参照してください。
カスタマイズサービス
コンフィギュレーションに加え、コンポーネントごとにビジネスロジックを拡張してコンポーネントをカスタマイズできます。各コンポーネントのビジネスロジックには、拡張およびオーバーライド可能な Thing Template 内のサービスが含まれています。次のテーブルは、このコンポーネントのオーバーライド可能なサービスの詳細を示しています。
各サービスの戻り値とパラメータの例については、カスタマイズサービスの入力/出力の例を参照してください。
名前 | 説明 |
|---|---|
GetConfigurations | コンポーネントの実装で使用可能なコンフィギュレーションを返します。 パラメータ: なし 戻り値: JSON |
GetImplementationLabel | コンポーネントのローカライズ名、またはローカライズ名を取得するために使用できるトークンを返します。このローカライズ名は Mashup Builder のユーザーインタフェースに表示されます。 パラメータ: なし 戻り値: String |
CalculateProgress | 進行状況データを計算して返します。カスタム実装を作成する場合、このサービスをカスタムロジックによってオーバーライドします。 このサービスで使用可能なカスタムロジックの例については、タスク進行状況を参照してください。 パラメータ: input (必須) - バックエンドシステムからフェッチするデータの入力 ID およびバックエンドシステムのアダプタ情報を含む、CCOフォーマットの JSON。 configuration (オプション) - 調整マネージャリソースから取得した最終マージコンフィギュレーションを含む JSON。 戻り値: JSON |
実装定義
進行状況コンポーネントの実装定義については、タスク進行状況を参照してください。