UiPath Task Captureテンプレートで使用する各プレースホルダーの説明を記載して見た！

# はじめに
みなさん、こんにちわ！

UiPath Task Captureは、自動化候補に関する詳細な情報をビジネスユーザーから直接取得するのに役立つプロセス定義ドキュメント生成ツールですね。もちろん、ビジネスユーザーに限らず活用できるツールです。
UiPathの新しいライセンス（NPS）のNamed Userライセンスに付いてくるツールなので、今後、活用するユーザーが増えてくるのではないでしょうか。
と言うことで、今後、活用するユーザーが増えてくるが、情報の公開がなく困りそうな「テンプレートで使用するプレースホルダーの情報」について記事を書きます。

###※プレースホルダーについて
Task Captureのプロセス定義ドキュメントは標準でいくつかテンプレートが提供されていますが、企業によっては、現在の自社用Wordテンプレートに合わせたり、新しく自社用のテンプレートを作成したい場合もあるでしょう。
Task Captureはプレースホルダーを使用した独自のテンプレートの作成が可能となっています。


# 本記事の前提（免責事項）
2020/7/27現在では、下記のUiPathドキュメントポータルにも情報が記載されていないため、独自で調べた情報です。
手探りで調べたものであり、間違っている部分もあるかも知れません:sweat_smile:ご参考レベルとしてください。
https://docs.uipath.com/task-capture/lang-ja/docs/creating-your-own-word-template

Task Capture バージョン 2020.4.1を使用しての調査ですが、今後のバージョンで仕様が変更される可能性があります。

# 2020/7/27現在で公開されているプレースホルダーの情報

```
{TITLE} - title of the document
{DESCRIPTION} - description of the document
{AUTHOR} - author of the document
{PROCESS_DATE}
{PROCESS_EXECUTION_TIME}
{TOTAL_APPLICATIONS_COUNT}
{TOTAL_WINDOWS_COUNT}
{TOTAL_ACTIONS_COUNT}
{TOTAL_CLICKS}
{TOTAL_HOTKEYS}
{TOTAL_TEXT_ENTRIES}
{TOTAL_KEYS_PRESSED}
{TOTAL_TIME}
{#APPLICATIONS}
    {NAME}
    {TOTAL_ACTIONS_COUNT}
    {TOTAL_CLICKS}
    {TOTAL_HOTKEYS}
    {TOTAL_TEXT_ENTRIES}
    {TOTAL_KEYS_PRESSED}
    {TOTAL_TIME}
    {#WINDOWS}
        {NAME}
        {TOTAL_ACTIONS_COUNT}
        {TOTAL_CLICKS}
        {TOTAL_HOTKEYS}
        {TOTAL_TEXT_ENTRIES}
        {TOTAL_KEYS_PRESSED}
        {TOTAL_TIME}
    {/WINDOWS}
{/APPLICATIONS}

{#WINDOWS}
    {NAME}
    {TOTAL_ACTIONS_COUNT}
    {TOTAL_CLICKS}
    {TOTAL_HOTKEYS}
    {TOTAL_TEXT_ENTRIES}
    {TOTAL_KEYS_PRESSED}
    {TOTAL_TIME}
{/WINDOWS}
{%DIAGRAM} -  insert diagram image
{#SEQUENCELAYOUT}
    {SEQUENCETITLE}
    {SEQUENCEDESCRIPTION} - only applicable for adding values for Business Rule elements in order to describe the workflow. For example, ‘if ‘yes’ then go to ‘sequence1’, if ‘no’ then go to 'sequence2’
    {SEQUENCE_EXECUTION_TIME}

    {#ACTIONLAYOUT}
        {ACTIONTITLE}
        {ACTIONDESCRIPTION}
        {%ACTIONIMAGE} - insert action image
        {ACTION_EXECUTION_TIME};
        {#ACTION_METADATA}
            {ACTION_TYPE}
            {KEY_MODIFIERS}
            {KEY_LOG}
            {KEY}
            {IS_MOUSE}
            {IS_KEYBOARD_INPUT}
            {IS_KEYBOARD_SPECIAL}
            {MOUSE_BUTTON}
        {/ACTION_METADATA}
    {/ACTIONLAYOUT}
{/SEQUENCELAYOUT}
```

# 各プレースホルダーを使って調べた結果を記載
```
{TITLE}                                ドキュメントプロパティに入力した「タイトル」を挿入
{DESCRIPTION}                          ドキュメントプロパティに入力した「説明」を挿入
{AUTHOR}                               ドキュメントプロパティに入力した「作成者」を挿入
{PROCESS_DATE}                         エキスポートした「日付」を挿入
{PROCESS_EXECUTION_TIME}               プロセスの「実行推定時間」を挿入
{TOTAL_APPLICATIONS_COUNT}             使用している「アプリケーションの総数」を挿入
{TOTAL_WINDOWS_COUNT}                  操作するアプリケーションの「ウインドウ総数」を挿入
{TOTAL_ACTIONS_COUNT}                  キャプチャーされている「ステップ総数」を挿入
{TOTAL_CLICKS}                         「クリックしている総数」を挿入
{TOTAL_HOTKEYS}                        「ホットキーを押下している総数」を挿入
{TOTAL_TEXT_ENTRIES}                   「テキストへのキー操作ステップ総数」を挿入
{TOTAL_KEYS_PRESSED}                   （文字入力操作×1）＋（Enterキー×5）+（BSキー×4）+（Tabキー×3）の「カウント数」挿入
{TOTAL_TIME}                           プロセスの「実行推定時間」を挿入
{#APPLICATIONS}                        ＜定義開始＞アプリケーション単位で展開
    {NAME}                             起動しているアプリケーションの「ファイルパス名」を挿入
    {TOTAL_ACTIONS_COUNT}              キャプチャーされている「ステップ総数」を挿入
    {TOTAL_CLICKS}                     「クリックしている総数」を挿入
    {TOTAL_HOTKEYS}                    「ホットキーを押下している総数」を挿入
    {TOTAL_TEXT_ENTRIES}               「テキストへのキー操作ステップ総数」を挿入
    {TOTAL_KEYS_PRESSED}               （文字入力操作×1）＋（Enterキー×5）+（BSキー×4）+（Tabキー×3）の「カウント数」挿入
    {TOTAL_TIME}                       プロセスの「実行推定時間」を挿入
    {#WINDOWS}                         ＜定義開始＞Window単位で展開
        {NAME}                         「Windowのタイトル名」を挿入
        {TOTAL_ACTIONS_COUNT}          「キャプチャーされている総数」を挿入
        {TOTAL_CLICKS}                 「クリックしている総数」を挿入
        {TOTAL_HOTKEYS}                「ホットキーを押下している総数」を挿入
        {TOTAL_TEXT_ENTRIES}           「テキストへのキー操作ステップ総数」を挿入
        {TOTAL_KEYS_PRESSED}           （文字入力操作×1）＋（Enterキー×5）+（BSキー×4）+（Tabキー×3）の「カウント数」挿入
        {TOTAL_TIME}                   プロセスの「実行推定時間」を挿入
    {/WINDOWS}                         ＜定義終了＞Window単位で展開
{/APPLICATIONS}                        ＜定義終了＞アプリケーション単位の展開を終了する定義
{#WINDOWS}                             ＜定義開始＞Window単位で展開
    {NAME}                             「Windowのタイトル名」を挿入
    {TOTAL_ACTIONS_COUNT}              「キャプチャーされている総数」を挿入
    {TOTAL_CLICKS}                     「クリックしている総数」を挿入
    {TOTAL_HOTKEYS}                    「ホットキーを押下している総数」を挿入
    {TOTAL_TEXT_ENTRIES}               「テキストへのキー操作ステップ総数」を挿入
    {TOTAL_KEYS_PRESSED}               （文字入力操作×1）＋（Enterキー×5）+（BSキー×4）+（Tabキー×3）の「カウント数」挿入
    {TOTAL_TIME}                       プロセスの「実行推定時間」を挿入
{/WINDOWS}                             ＜定義終了＞Window単位で展開
{%DIAGRAM}                             ダイアグラム画像の挿入
{#SEQUENCELAYOUT}                      ＜定義開始＞シーケンス（ダイアグラムの記号）単位で展開
    {SEQUENCETITLE}                    「シーケンスのタイトル」を挿入
    {SEQUENCEDESCRIPTION}              条件分岐の記号の場合、「条件と分岐先の説明」が自動的に挿入
    {SEQUENCE_EXECUTION_TIME}          シーケンスの「実行推測時間」を挿入
    {#ACTIONLAYOUT}                    ＜定義開始＞ステップ単位の展開
        {ACTIONTITLE}                  入力した「ステップのタイトル」を挿入
        {ACTIONDESCRIPTION}            入力した「ステップの説明」を挿入
        {%ACTIONIMAGE}                 キャプチャーされている「ステップの画像」を挿入
        {ACTION_EXECUTION_TIME}        ステップの「実行推測時間」を挿入
        {#ACTION_METADATA}             ＜定義開始＞メタデータ
            {ACTION_TYPE}              「クリック」、「ダブルクリック」、「キーボード入力」、「特殊キー」など文字列挿入
            {KEY_MODIFIERS}            キーの場合は「修飾キー」を挿入
            {KEY_LOG}                  キーの場合は入力した「キー」を挿入
            {KEY}                      キーの場合は入力した「キー」を挿入
            {#IS_MOUSE}                ＜定義開始＞マウス操作の場合のみ挿入
                  {ACTION_TYPE}        「クリック」、「ダブルクリック」の文字列を挿入
            {/IS_MOUSE}                ＜定義終了＞マウス操作の場合のみ挿入
            {#IS_KEYBOARD_INPUT}       ＜定義開始＞特殊キー以外の場合のみ挿入
                   {KEY}               「入力キー」を挿入
            {/IS_KEYBOARD_INPUT}       ＜定義終了＞特殊キー以外の場合のみ挿入
            {#IS_KEYBOARD_SPECIAL}     ＜定義開始＞特殊キーの場合のみ「特殊キー」を挿入
                   {KEY}               「 特殊キー」を挿入
            {/IS_KEYBOARD_SPECIAL}     ＜定義終了＞特殊キーの場合のみ特殊キーを挿入
            {MOUSE_BUTTON}             マウスの場合は「Left」、「Right」の文字列を挿入
        {/ACTION_METADATA}             ＜定義終了＞メタデータ
    {/ACTIONLAYOUT}                    ＜定義終了＞ステップ単位の展開
{/SEQUENCELAYOUT}                      ＜定義終了＞シーケンス（ダイアグラムの記号）単位で展開

```

### 気をつけるべき点①
ドキュメントポータルに記載されている下記のプレースホルダーを挿入すると、エクスポートを実行すると、「申し訳ございません」とダイアログ表示されてしまいます・・・
`{IS_MOUSE}
{IS_KEYBOARD_INPUT}
{IS_KEYBOARD_SPECIAL}`

ドキュメントポータルの記載が間違っている可能性があり、下記の使い方では機能しました。
`{#IS_MOUSE}{ACTION_TYPE}{/IS_MOUSE}
{#IS_KEYBOARD_INPUT}{KEY}{/IS_KEYBOARD_INPUT}
{#IS_KEYBOARD_SPECIAL}{KEY}{/IS_KEYBOARD_SPECIAL}`

### 気をつけるべき点②
`{TOTAL_KEYS_PRESSED}`では、公開されていない仕様でカウントされている様です。
文字入力操作は何文字入力してもカウントは1です。
Enterキー押下でカウントが5加算されます。
Back Spaceキー押下でカウントが4加算されます。
Tabキー押下でカウントは3加算されます。
その他の特殊キーでも公開されていない仕様でカウントされると思います。

### 気をつけるべき点③
繰り返し処理（ループ）している場合や条件分岐等によって、各プレースホルダーで展開される値は修正が必要となります。

# おわりに
今後、仕様がUiPathドキュメントポータルにアップデートされる可能性もありますが、それまでのご参考に頂ければと思います。