すべての WORKFLOW XML 要素のリファレンス

  • [アーティクル]

このトピックの情報は、作業項目の種類のワークフローを制御するすべての要素と主要な属性に関するクイック リファレンスとして使用できます。 これらの要素は、WORKFLOW 要素コンテナー (作業項目の種類の定義の 2 番目にある主要セクション) で指定します。 STATES 子要素および TRANSITIONS 子要素を使用して、ユーザーが作業項目の種類に対して選択できるさまざまな状態と、許可される状態遷移を定義します。 これらの要素を定義する方法の詳細については、「ワークフローのデザイン」を参照してください。

このトピックの内容

  • WORKFLOW の例

  • WORKFLOW 要素の構文構造

WORKFLOW の例

次の例は、WORKFLOW 要素の全体的な構造を示しています。 まず、STATES コンテナー内で、ユーザーが作業項目の種類を割り当てることができるすべての状態を指定します。 次に、許可されるすべての状態遷移を指定します。 各状態は STATE 要素に対応し、各遷移は TRANSITION 要素に対応します。 STATES コンテナー要素および TRANSITIONS コンテナー要素内で、状態と遷移を必要な順序で定義できます。

遷移ごとに、作業項目の状態を変更する一連の理由 (既定の理由を含む) を指定します。 状態、遷移、または理由ごとに、FIELD (ワークフロー) 要素を使用して、1 つ以上のフィールドに値を割り当てたり、値に条件を設定したりすることもできます。 また、遷移の間に ACTION 要素を指定することで、アクションを発生させることもできます。

<WORKFLOW>
<STATES>
  <STATE value="Active">
    <FIELDS> . . . </FIELDS>
  </STATE>
  <STATE value="Resolved">
    <FIELDS> . . . </FIELDS>
  </STATE>
  <STATE value="Closed" />
</STATES>
<TRANSITIONS>
  <TRANSITION from="" to="Active">
    <REASONS>
      <DEFAULTREASON value="New" />
    </REASONS>
    <FIELDS> . . . </FIELDS>
  </TRANSITION>
  <TRANSITION from="Active" to="Resolved">
    <REASONS> . . . </REASONS>
    <FIELDS> . . . </FIELDS>
    <ACTIONS > . . . </ACTIONS >
</TRANSITION>
<TRANSITION from="Resolved" to="Closed">
    <REASONS> . . . </REASONS>
    <FIELDS> . . . </FIELDS>
    <ACTIONS > . . . </ACTIONS >
</TRANSITION>
<TRANSITION from="Resolved" to="Active">
    <REASONS> . . . </REASONS>
    <FIELDS> . . . </FIELDS>
</TRANSITION>
<TRANSITION from="Active" to="Closed ">
    <REASONS> . . . </REASONS>
    <FIELDS> . . . </FIELDS>
</TRANSITION>
<TRANSITION from="Closed" to="Active">
    <REASONS> . . . </REASONS>
    <FIELDS> . . . </FIELDS>
</TRANSITION>
</TRANSITIONS>
</WORKFLOW>

ページのトップへ

WORKFLOW 要素の構文構造

次の表で示している要素を使用して、チーム メンバーが特定の種類の作業項目を設定できる状態を指定できます。 定義の WORKFLOW セクションでは、状態を先に定義してから、遷移を定義します。 詳細については、「ワークフローのデザイン」を参照してください。

要素

説明と構文

必須?

ACTION

アクションに対応するテキスト文字列を定義します。このアクションは、作業項目を追跡するシステムが WorkItem.GetNextState メソッドを呼び出して、作業項目のアクション後の状態を取得するときに実行されます。

<ACTION value="NameOfAction" />

詳細については、「状態、遷移、または理由に基づいたフィールド割り当ての自動化」を参照してください。

省略可能

ACTIONS

ACTION 要素のコレクションを定義します。

<ACTIONS>
   <ACTION>. . . </ACTION>
</ACTIONS>

省略可能

DEFAULTREASON

チーム メンバーが作業項目をある特定の状態から別の状態に変更する最も一般的な理由を定義します。

<DEFAULTREASON value="ValueOfDefaultReason">
   <FIELDS>. . . </FIELDS>
</DEFAULTREASON>

必須

FIELD

チーム メンバーが作業項目の種類の状態を変更し、変更理由を指定したときに、それらのフィールドに適用される作業項目の種類および規則と条件のフィールドを指定します。

<FIELD refname="FieldReferenceName">
   <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
   <ALLOWEXISTINGVALUE />
   <CANNOTLOSEVALUE />
   <COPY />
   <DEFAULT />
   <EMPTY />
   <FROZEN />
   <MATCH />
   <NOTSAMEAS />
   <PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES>
   <READONLY />
   <SERVERDEFAULT />
   <SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES>
   <VALIDUSER />
   <WHEN>> . . . </WHEN>
   <WHENNOT> . . . </WHENNOT>
   <WHENCHANGED> . . . </WHENCHANGED>
   <WHENNOTCHANGED> . . . </WHENNOTCHANGED>
<FIELD>

詳細については、「FIELD (ワークフロー) 要素」を参照してください。

省略可能

FIELDS

FIELD の要素のコレクションを指定します。

<FIELDS>
   <FIELD . . . </FIELD>
</FIELDS>

省略可能

REASON

チーム メンバーが作業項目の状態を変更した理由に関する補足説明を定義します。

<REASON value="NameOfReason">
   <FIELDS>. . . </FIELDS>
</REASON>

省略可能

REASONS

チーム メンバーが作業項目の状態を変更した理由を説明する、1 つの DEFAULTREASON 要素およびオプションの REASON 要素のコレクション。

<REASONS>
   <DEFAULTREASON>. . . </DEFAULTREASON>
   <REASON>. . . </REASON>
</REASONS>

STATE

作業項目の種類の有効な状態を定義します。 この要素には、チーム メンバーがその作業項目の種類の状態を変更するときに、特定のフィールドに適用される規則と条件を参照する FIELDS 要素を含めることができます。

<STATE value="NameOfState">
  <FIELDS>. . . </FIELDS>
</STATE>

必須

STATES

ユーザーが作業項目の種類を割り当てる有効な状態を定義する STATE 要素のコレクションを指定します。

<STATES>
   <STATE>. . . </STATE>
</STATES>

必須

TRANSITION

作業項目の特定の種類に対し、ある状態から他の状態への有効な進行または回帰を指定します。

<TRANSITION from="NameOfStartingState" 
   to="NameOfEndingState" 
   for="UserOrGroupName"
   not="UserOrGroupName">
   <ACTIONS>. . . </ACTIONS>
   <REASONS>. . . </REASONS>
   <FIELDS>. . . </FIELDS>
</TRANSITION>

詳細については、「TRANSITION 要素」を参照してください。

必須

TRANSITIONS

TRANSITION の要素のコレクションを指定します。

<TRANSITIONS>
    <TRANSITION>. . . </TRANSITION>
</TRANSITIONS>

必須

WORKFLOW

STATES コンテナー要素および TRANSITIONS コンテナー要素のコレクションを両方指定します。これらは両者で作業項目の種類に対するワークフローを定義します。

<WORKFLOW>
   <STATES>. . . </STATES>
   <TRANSITIONS>. . . </TRANSITIONS>
</WORKFLOW>

必須

ページのトップへ

参照

参照

FIELD (ワークフロー) 要素

概念

ワークフローのデザイン

その他の技術情報

作業項目ワークフローの定義とカスタマイズ