- Release Notes
- Getting started
- Hardware and software requirements
- Setup and configuration
- Working with Task Capture
- File Option
- Managing Word Templates
- Creating Your Own Word Template
- Best Practices
- Additional resources
Besides managing existent templates, in Task Capture you can create your own template and use it for exporting PDDs.
To do so follow one of the below methods:
-
Adjust the design and structure according to your branding and needs to a default template. This way it's easier to be sure you added all the needed placeholders.
-
Create your own template from scratch
To do this:
- Use your current company Word template or create one applying the necessary styles and sections.
- Copy and paste the needed placeholders from the below list.
Add only those loops/cycles you need to have in your exported PDD. None of the below placeholders is mandatory.
{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}Make sure you save the entire loops/cycles structure as the included placeholders do not work outside the designed loops/cycles.
For example, the {NAME} placeholder does not work outside the below loop/cycle.
{#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}
{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}Make sure you save the entire loops/cycles structure as the included placeholders do not work outside the designed loops/cycles.
For example, the {NAME} placeholder does not work outside the below loop/cycle.
{#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}
The following variables are boolean (true/false) values:
-
{IS_MOUSE} -
{IS_KEYBOARD_INPUT} -
{IS_KEYBOARD_SPECIAL}This means that they are not replaced by specific data. The content inside the variable is shown, depending on its value, as true or false.
For example:
If you want to add the text This is a mouse event when an action type is a mouse event, the variable should be used like this:
{#IS_MOUSE} This is a mouse event {/IS_MOUSE} Meaning that when the value of {IS_MOUSE} variable is true the desired text is added.
If you want to add text This is NOT a mouse event when an action type is not a mouse event, the variable should be used like this:
{^IS_MOUSE} This is NOT a mouse event {/IS_MOUSE} Meaning that when the value of {is_mouse} variable is false the desired text will be added.
The same logic applies for both {IS_KEYBOARD_INPUT} and {IS_KEYBOARD_SPECIAL} variables.
-
Save the changes and rename your Word template to template.
-
Open Task Capture and go to Export & Publish > Word document > Template view.
- Hover over the default template and click Edit template.
- The Edit Template pop-up is displayed. Click OK to confirm generating a copy.
- A folder that contains the editable copy automatically opens on your PC. Access the template folder.
- Paste your Word template (previously renamed to template in Step 3) to replace the existent template file in this folder.
-
Close the folder.
-
Go back to Task Capture.
-
Hover over this template in the Template view and click the Rename icon.
- Type in the new name. Click Save.