Changes between Initial Version and Version 1 of TracWorkflow


Ignore:
Timestamp:
06/04/12 12:01:35 (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v1  
     1= Trac のチケットワークフローシステム = #TheTracTicketWorkflowSystem 
     2[[TracGuideToc]] 
     3 
     4Trac のチケットデータベースはコンフィグ可能なワークフローを提供します。 
     5 
     6== デフォルトのワークフロー == #TheDefaultTicketWorkflow 
     7=== 0.10 からアップグレードした Environment === #Environmentsupgradedfrom0.10 
     8`trac-admin <env> upgrade` を実行したとき、`trac.ini` に `[ticket-workflow]` セクションが追加され、 0.10 でのワークフロー (original ワークフロー) と同様のアクションをするようにデフォルトの設定値が設定されます。 
     9 
     10original ワークフローは下図を参照してください: 
     11 
     12[[Image(htdocs:../common/guide/original-workflow.png)]] 
     13 
     14original ワークフローにはいくつかの重要な "欠点" があります; 新しいチケットを承認 (accept) したときにステータスは 'assigned' に設定されますが、 'assigned' のチケットを再割り当て (reassign) するとステータスは 'new' に設定され、直観的ではありません。 
     15これは original ワークフローから "basic" ワークフローに移行することで解決します; original ワークフローから basic ワークフローへの移行には [http://trac.edgewall.org/browser/trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] が役に立つかもしれません。 
     16 
     17=== 0.11 で新規作成した Environment === #Environmentscreatedwith0.11 
     180.11 の環境が新規に作成されるとき、デフォルトのワークフローが trac.ini に構成されます。このワークフローは basic ワークフローです (basic ワークフローは `basic-workflow.ini` 内に記述されています)。 basic ワークフローは 0.10 でのワークフローとは少し違います。 
     19 
     20basic ワークフローは下図を参照してください: 
     21 
     22[[Image(htdocs:../common/guide/basic-workflow.png)]] 
     23 
     24== そのほかのワークフロー == #AdditionalTicketWorkflows 
     25 
     26Trac のソースにはいくつかのワークフローの例が含まれています; [http://trac.edgewall.org/browser/trunk/contrib/workflow contrib/workflow] の `*.ini` ファイル内のコンフィグセクションを参照してください。それらの一つはあなたが求めているものとマッチするかもしれません。 `*.ini` ファイル内のコンフィグセクションは、 `trac.ini` の `[ticket-workflow]` セクションに貼り付けて使用することができます。 
     27 
     28これらの例の [http://trac.edgewall.org/wiki/WorkFlow/Examples ダイヤグラム] を見ることができます。 
     29 
     30== 基本的なワークフローのカスタマイズ == #BasicTicketWorkflowCustomization 
     31 
     32Note: チケットの "ステータス群 (Statuses or states)" は独立した状態で定義することはできません。チケットがとりうるステータスはワークフローで定義された状態遷移から自動生成されます。つまり、チケットを新規作成するためには、ワークフローで開始状態と終了状態を持つ状態遷移を定義せねばなりません。 
     33 
     34`trac.ini` に `[ticket-workflow]` セクションを作成します。 
     35`[ticket-workflow]` セクション内の各エントリはチケットが取り得るアクションです。 
     36`simple-workflow.ini` の `accept` を例に説明します: 
     37{{{ 
     38accept = new,accepted -> accepted 
     39accept.permissions = TICKET_MODIFY 
     40accept.operations = set_owner_to_self 
     41}}} 
     421 行目は `accept` の動作についての定義です。 `accept` は `new` と `accepted` のステータスで有効であり、ステータスが `new` か `accepted` の場合に `accept` が実行されるとステータスが `accepted` になることを表しています。 
     432 行目は、ユーザが `accept` を行うために必要な権限についての定義です。 
     443 行目は `accept` を行ったときに、同時にチケットに対して行う操作についての定義です。 `set_owner_to_self` は、チケットの所有者をログイン中のユーザに更新することを表します。同一エントリーに対して複数の定義を行う場合は、カンマ区切りのリストとして設定することが可能です。 
     45 
     46''actionname''`.operations` で使用できる値は以下の通りです: 
     47 - del_owner -- チケットの所有者を削除します。 
     48 - set_owner -- チケットの所有者を選択された所有者か入力された所有者に設定します。 
     49   - ''actionname''`.set_owner` カンマ区切りのリストか1つの値を設定することができます。 
     50 - set_owner_to_self -- チケットの所有者をログインユーザに設定します。 
     51 - del_resolution -- チケットの解決方法を削除します。 
     52 - set_resolution -- チケットの解決方法を選択された解決方法か入力された解決方法に設定します。 
     53   - ''actionname''`.set_resolution` カンマ区切りのリストか1つの値を設定することができます。 
     54{{{ 
     55例: 
     56 
     57resolve_new = new -> closed 
     58resolve_new.name = resolve 
     59resolve_new.operations = set_resolution 
     60resolve_new.permissions = TICKET_MODIFY 
     61resolve_new.set_resolution = invalid,wontfix 
     62}}} 
     63 - leave_status -- "変更しない 現在のステータス: <現在のステータス>" (英語版では "leave as <current status>") を表示してチケットへの変更を行いません。 
     64'''Note:''' `set_owner` と `del_owner` などのように相反する操作を同時に指定した場合の動作は不定です。 
     65 
     66{{{ 
     67resolve_accepted = accepted -> closed 
     68resolve_accepted.name = resolve 
     69resolve_accepted.permissions = TICKET_MODIFY 
     70resolve_accepted.operations = set_resolution 
     71}}} 
     72 
     73`.name` 属性を使用した場合の例です。この例のアクションは `resolve_accepted` ですが、 `.name` で別名を付けることによって、ユーザからは `resolve` として見えます。 
     74 
     75すべてのステータスで利用可能なアクションであることを表す値として、 `*` を使用することができます。分かりやすい例は `leave` です: 
     76{{{ 
     77leave = * -> * 
     78leave.operations = leave_status 
     79leave.default = 1 
     80}}} 
     81これは '.default' 属性の使用例でもあります。 `.default` 属性の値は整数であることを期待します。そして、アクションが表示される順番は `.default` 属性の値で決まります。 `.default` の値が最も大きいアクションが最初に表示され、デフォルトで選択されます。残りのアクションは `.default` の値に従い、降順で表示されます。 `.default` の値を指定しない場合のデフォルト値は0になります。 
     82`.default` の値には負の値を指定することもできます。 
     83 
     84ワークフローにはハードコードされた 2, 3 の制限があります。新しく作成されたチケットのステータスは `new` になり、チケットには `closed` のステータスが存在する必要があります。さらにデフォルトのレポート/カスタムクエリでは `closed` 以外のすべてのステータスをアクティブなチケットとして扱います。 
     85 
     86ワークフローを作成・編集するのに `contrib/workflow/workflow_parser.py` が役に立つかもしれません。 `contrib/workflow/workflow_parser.py` は [http://www.graphviz.org GraphViz] が理解でき、ワークフローを視覚化するための `.dot` ファイルを作ることができます。 
     87 
     88以下に例を示します (インストールパスは環境により異なる場合があります) 。 
     89{{{ 
     90cd /var/local/trac_devel/contrib/workflow/ 
     91sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 
     92}}} 
     93実行結果は `trac.pdf` として出力されます。 (`trac.ini` 同じディレクトリに出力されます。) 
     94 
     95ワークフローを変更した後に、 Apache (サーバ) を再起動する必要があります。サーバの再起動が行われるまでは変更が適用されず変更前のワークフローが実行されることになります。 
     96 
     97== 例: ワークフローにテストを追加する == #Example:AddingoptionalTestingwithWorkflow 
     98 
     99trac.ini の [ticket-workflow] セクションに以下の記述を追加することで optional testing を実現できます。チケットのステータス (status) が new, accepted, needs_work の場合にチケットを testing 状態に遷移させることができます。 testing ステータスでは reject して needs_work 状態に戻すか、 pass して closed 状態に進めることができます。 pass させた場合、 closed での解決方法 (resolution) は自動的に fixed に設定されます。以前のワークフローはそのまま残っているので、このセクションで設定した内容をスキップすることもできます。 (訳注: 通常、チケットのクローズを行うためには TICKET_MODIFY 権限が必要です。このワークフローでは testing 状態からのクローズには権限が不要なので、報告者 (reporter) に修正結果をテストしてもらう場合などに有効です) 
     100 
     101{{{ 
     102testing = new,accepted,needs_work,assigned,reopened -> testing 
     103testing.name = Submit to reporter for testing 
     104testing.permissions = TICKET_MODIFY 
     105 
     106reject = testing -> needs_work 
     107reject.name = Failed testing, return to developer 
     108 
     109pass = testing -> closed 
     110pass.name = Passes Testing 
     111pass.operations = set_resolution 
     112pass.set_resolution = fixed 
     113}}} 
     114 
     115== 例: レビュー状態を追加する == #Example:Addsimpleoptionalgenericreviewstate 
     116 
     117"testing" ステータスが利用者によっては、異なる状況を指すような Trac の使い方をしている場合、実装固有の詳細な箇所は "testing" に分類せず、デフォルトのワークフローの `assigned` と `closed` ステータスの間に、必要に応じて分岐できるステータスを追加したいと考えるはずです。新しいステータスは `reviewing` とすべきでしょう。 "submitted for review" されたチケットは、どのようなステータスからでも reassigned になります。レビューが通過した場合、 `resolve` アクションを再利用して、チケットを close します。通過しない場合は `reassign` アクションを再利用して通常のワークフローに戻します。 
     118 
     119新しい `reviewing` ステータスは `review` アクションに関連付けます。以下のように記述してください: 
     120 
     121{{{ 
     122review = new,assigned,reopened -> reviewing 
     123review.operations = set_owner 
     124review.permissions = TICKET_MODIFY 
     125}}} 
     126 
     127デフォルトの Trac 0.11 ワークフローに統合するために、 `reviewing` ステータスを `accept` と `resolve` アクションに追加します。以下のようになります: 
     128 
     129{{{ 
     130accept = new,reviewing -> assigned 
     131[…] 
     132resolve = new,assigned,reopened,reviewing -> closed 
     133}}} 
     134 
     135必要に応じて `reviewing` からステータスを変更せずに、チケットの担当者 (owner) を変更するための新しいアクションを追加します。この設定を行うと、 `new` ステータスに遷移させることなくレビューの担当者を変更することができるようになります。 
     136 
     137{{{ 
     138reassign_reviewing = reviewing -> * 
     139reassign_reviewing.name = reassign review 
     140reassign_reviewing.operations = set_owner 
     141reassign_reviewing.permissions = TICKET_MODIFY 
     142}}} 
     143 
     144完全な `[ticket-workflow]` への設定は以下のようになります: 
     145 
     146{{{ 
     147[ticket-workflow] 
     148accept = new,reviewing -> assigned 
     149accept.operations = set_owner_to_self 
     150accept.permissions = TICKET_MODIFY 
     151leave = * -> * 
     152leave.default = 1 
     153leave.operations = leave_status 
     154reassign = new,assigned,reopened -> new 
     155reassign.operations = set_owner 
     156reassign.permissions = TICKET_MODIFY 
     157reopen = closed -> reopened 
     158reopen.operations = del_resolution 
     159reopen.permissions = TICKET_CREATE 
     160resolve = new,assigned,reopened,reviewing -> closed 
     161resolve.operations = set_resolution 
     162resolve.permissions = TICKET_MODIFY 
     163review = new,assigned,reopened -> reviewing 
     164review.operations = set_owner 
     165review.permissions = TICKET_MODIFY 
     166reassign_reviewing = reviewing -> * 
     167reassign_reviewing.operations = set_owner 
     168reassign_reviewing.name = reassign review 
     169reassign_reviewing.permissions = TICKET_MODIFY 
     170}}} 
     171 
     172== 例: new チケットでの解決方法 (resolution) を制限する == #Example:Limittheresolutionoptionsforanewticket 
     173 
     174resolve_new という操作では、 new 状態のチケットで使用可能な、解決方法 (resolution) を設定しています。既に存在する resolve アクションを変更し、 `->` の前から new のステータスを削除することで、2種類の resolve アクションが使用できるようになっています。 new のチケットでは制限された解決方法 (resolution) となり、それ以外の一旦 accept されたチケットでは通常通りとなります。 
     175 
     176{{{ 
     177resolve_new = new -> closed 
     178resolve_new.name = resolve 
     179resolve_new.operations = set_resolution 
     180resolve_new.permissions = TICKET_MODIFY 
     181resolve_new.set_resolution = invalid,wontfix,duplicate 
     182 
     183resolve = assigned,accepted,reopened -> closed 
     184resolve.operations = set_resolution 
     185resolve.permissions = TICKET_MODIFY 
     186}}} 
     187 
     188== 高度なワークフローのカスタマイズ == #AdvancedTicketWorkflowCustomization 
     189 
     190ここまでのカスタマイズで十分でないならば、プラグインを使用することでワークフローのさらなる拡張が可能です。プラグインを使用すると、ワークフローに (code_review のような) 操作を追加できます。また、単純なステータスの変更だけでない (トリガを構築するなどの) 2 次的な操作を実行することができます。いくつかの簡単な例は [http://trac.edgewall.org/browser/trunk/sample-plugins/workflow sample-plugins/workflow] を参照してください。 
     191 
     192プラグインを使用した拡張でさえも十分でないならば !ConfigurableTicketWorkflow のコンポーネントを無効にし、!ConfigurableTicketWorkflow  を完全に置き換える十分な機能を持ったプラグインを作成することも可能です。 
     193 
     194== ワークフローのステータスをマイルストーンのプログレスバーに追加する == #AddingWorkflowStatestoMilestoneProgressBars 
     195 
     196新しいステータスをワークフローに追加した場合、マイルストーンのプログレスバーへの表示もカスタマイズできます。 [TracIni#milestone-groups-section TracIni] を参照してください。 
     197 
     198== 次のステップに向けたアイデア集 == #someideasfornextsteps 
     199 
     200(訳注: この項はワークフローシステムの実装に関するアイデア集です。現在実装されているものではないので、プラグインを作成するときなどに参考にしてください) 
     201 
     202New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component.  If desired, add a single-line link to that ticket here.  Also look at the [th:wiki:AdvancedTicketWorkflowPlugin] as it provides experimental operations. 
     203 
     204If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 
     205 
     206 * the "operation" could be on the nodes, possible operations are: 
     207   * '''preops''': automatic, before entering the state/activity 
     208   * '''postops''': automatic, when leaving the state/activity 
     209   * '''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows. 
     210''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 
     211 
     212 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like  
     213''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 
     214 
     215 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 
     216   * either to a role, a person 
     217   * entered fix at define time, or at run time, e.g. out of a field, or select. 
     218''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 
     219 
     220 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 
     221''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''