Online Help Process Modeler
.

文書パターン

文書パターン

このセクションでは、プロセス文書 を作成するための文書パターン の使用方法について説明します。各パターンは、BPMN 要素をどのように走査しプロセス文書にどのような構造で組み込むか、その様式を定義します。Word テンプレート（*.dot、*.dotx）ファイル内でパターンを使用するには、次の構文の%%で開始/終了する変数を事前に定義する必要があります。

構文：

%%PATTERN;type=<type>[;<パラメータ>]*%%

<パラメータ> := <名前>=<値>

例：

%%PATTERN;type=generic;recursive=true;elementfilter=4,5,6,7%%

Word テンプレートを使用すると、プロセス文書化 機能は、このパターンを選択した要素の属性値で置き換えます。

文書内に展開された例:

12 アクティビティ 1 タスク
13 アクティビティ 2 タスク
14 ゲートウェイ A ゲートウェイ

 

それぞれの文書パターン には、複数のパラメータを定義することができます。各パラメーターは、セミコロン（;）で区切られなければなりません。次の表は、すべてに共通する文書パターン のパラメータを示します：

パラメータ名 説明, パラメータの値 と 使用例
type この必須パラメータは、以下のいずれかのパターンの種類を定義します：

  • generic　（すべて）
  • activity　（アクティビティ）
  • pool　（プール）
  • lane　（レーン）
  • graphics　（グラフィックスのみ）

使用例:
type=graphics
description このオプション・パラメータは、このパターンを説明するために使用します。サンプル: description=”全データオブジェクトの一覧”
sort このオプション・パラメータは、要素を属性値で並び替えるために使用します。いくつかの属性は、コンマ（,）で区切られていなければなりません。使用できる属性は、ここに 説明しています。接尾辞として[asc]（昇順）と[desc]（降順）を使用して、並び替えの順序を定義することができます。使用例:
sort=System.*.number
sort=Bpmn.*.Name[desc],User.*.A[asc]
outlinelevel このオプション・パラメータは、生成されたword コンテンツの最上部のアウトラインレベル を設定するために使用します。たとえば、アウトラインレベル が３ に設定されている場合は、コンテンツの最上部のアウトラインレベル は、見出し3 です。outlinelevel=n とすると nに1,2,3,4,5,…の値を指定します。
elementfilter このオプション・パラメータは、どのBPMNの要素タイプを処理するか定義するために使用します。各タイプは、カンマ（,）で区切ることで複数の対象を指定できます。以下のリストは、要素タイプに指定する番号を示しています（番号自体の代わりに要素タイプの名前も使用できます）:

  • StartEvent = 1　（開始イベント）
  • IntermediateEvent = 2　（中間イベント）
  • EndEvent = 3　（終了イベント）
  • Task = 4　（タスク）
  • SubProcessCollapsed = 5　（折りたたまれたサブプロセス）
  • SubProcessExpanded = 6　（展開されたサブプロセス）
  • Gateway = 7　（ゲートウェイ）
  • SequenceFlow = 8　（シーケンスフロー）
  • MessageFlow = 9　（メッセージフロー）
  • TextAnnotation = 10　（テキスト注釈）
  • Association = 11　（関連）
  • DataObject = 12　（データオブジェクト）
  • Group = 13　（グループ）
  • Pool = 14　（プール）
  • Lane = 15　（レーン）
  • DataObjectReference = 16　（データオブジェクト参照）
  • DataStore = 17　（データストア）
  • CallActivity = 18　（コールアクティビティ）
  • DataAssociation = 19　（データ関連）
  • DataInputAssociation = 20　（データ入力関連）
  • DataOutputAssociation = 21　（データ出力関連）
  • DataInput = 22　（データ入力）
  • DataOutput = 23　（データ出力）
  • Message = 24　（メッセージ）
  • BoundaryEvent = 25　（境界イベント）

使用例:
elementfilter=4,5,6
elementfilter=Task,SubProcessCollapsed,SubProcessExpanded
onlynumbered
(デフォルト: false)		 このオプション·パラメータは、true、またはfalseのいずれかを指定できます。trueの場合は、System.number が割り当てられていない（番号付けされていない）すべての要素が無視されます。使用例: onlynumbered=true
onlyvisible
(デフォルト: false)		 このオプション·パラメータは、true、またはfalseのいずれかを指定できます。trueの場合は、非表示の要素のすべてが無視されます。使用例: onlyvisible=true
recursive
(デフォルト: false)		 このオプション·パラメータは、true、またはfalseのいずれかを指定できます。trueの場合、要素は再帰的に走査されます。すなわち、サブプロセスが文書化する必要がある場合、その内容も一緒に処理されます。使用例: recursive=true
tableautofit
(デフォルト: false)		 このオプション·パラメータは、true、またはfalseに設定することができます。trueの場合、すべての表サイズは、ウィンドウサイズに自動調整されます。使用例: tableautofit=true
tableautofitcontent (デフォルト: false) このオプション·パラメータは、trueまたはfalseに設定することができます。trueの場合、すべての表サイズは、その表の内容に自動調整されます。使用例: tableautofitcontent=true

 

以下の章では、それぞれのパターンとその構成方法を説明します。

汎用リスト パターン

このパターンは、BPMN 要素の単純な（非階層型）リストを作成するために使用します。各要素は、表の行として扱われます。

構文:

%%PATTERN;type=generic[;パラメータ]*%%

パラメータ:

この文書パターン には、共通パラメータへの追加パラメータがありません。

 

たとえば、すべてのBPMN データオブジェクト名をその属性値で昇順に並び替えた全般的なリストを作成するには：

%%PATTERN;type=generic;sort=Bpmn.DataObject.Name[asc];elementfilter=12%%

アクティビティ パターン

このパターンは、アクティビティのみを含むプロセス文書を作成するために使用します。このオプション・パラメータは、サブプロセスに含まれる各アクティビティを階層的に 表現することを示し、文書内に新たな階層が作成されます。

構文:

%%PATTERN;type=activity[;パラメータ]*%%

追加パラメータ：

パラメータ名 説明, パラメータの値 と 使用例
hierarchical
(デフォルト: false)		 このオプション・パラメータは、true、またはfalseのいずれかを指定できます。trueの場合、サブプロセスが階層的な章見出しで文書化されます。recursiveパラメータがtrueに設定されている場合にのみ、このパラメータは作用します。

プール パターン

このパターンは、プールとその内容との関係を示します。追加パラメータにmessages が存在します。このパラメータが有効になっている場合は、すべての着信およ​​び発信のメッセージフローが文書化されます。

構文：

%%PATTERN;type=pool[;パラメータ]*%%

追加パラメータ：

パラメータ名 説明, パラメータの値 と 使用例
hierarchical
(デフォルト: false)		 このオプション・パラメータは、true、またはfalseのいずれかを指定できます。trueの場合、プールが階層的な章見出しで文書化されます。recursiveパラメータがtrueに設定されている場合にのみ、このパラメータは作用します。
messages (デフォルト: false) このオプション・パラメータは、true、またはfalseのいずれかを指定できます。trueの場合、すべての着信および発信メッセージフローも２つの分離した章見出しで文書化されます。メッセージの出力をカスタマイズするには、必ずプールパターン 内のメッセージフロー要素に割り当てられたドックレット を使用してください。

レーン パターン

このパターンは、レーンとその内容との関係を示します。このオプション・パラメータは、階層的 な順序でレーン構造を文書化すること示します。

構文:

%%PATTERN;type=lane[;パラメータ]*%%

追加パラメータ：

パラメータ名 説明, パラメータの値 と 使用例
hierarchical
(デフォルト: false)		 このオプション・パラメータは、true、またはfalseのいずれかを指定できます。trueの場合、レーンが階層的な章見出しで文書化されます。recursiveパラメータがtrueに設定されている場合にのみ、このパラメータは作用します。

グラフィックス パターン

このパターンは、プロセス文書内にVisio シートを画像として挿入するために使します。パラメータを指定しない場合は、すべてのシートが現在の選択に関係なく挿入されます。これは単に、すべてのシートをビットマップとして一覧表示します。

構文:

%%PATTERN;type=graphics[;パラメータ]*%%

追加パラメータ：

パラメータ名 説明, パラメータの値 と 使用例
ignoretitleblock (デフォルト: false) このオプション·パラメータは、true、またはfalseのいずれかを指定できます。trueの場合は、タイトルブロックがビットマップに含まれません。
sheets このオプション・パラメータは、文書に挿入するVisio シートを選択するために使用します。挿入する各Visioシートは、カンマ（,）で区切ります。たとえば、2番目と3番目のシートを挿入するには、sheets=2,3 と指定します。このパラメータが存在しない場合は、すべてのVisioシートがリストされます。

すべての共通パラメータは、descriptionパラメータを除いて、このパターンの使用出力には、影響を及ぼしません。