enfr

Workflow ids

Updated: 2018-08-23

Copy or export workflow ids

You can use workflow items in conditions in templates. To copy the ids from the workflow screen:

  1. With a file open, go to the File menu and click on Info.
  2. Right-click on a workflow item and select Copy ID for Template.
    copy-workflow-id
  3. In options, you can also right-click on an item to get the ID.
  4. Or, you can export all items by clicking on the Export task list link.
    Workflow options

Template functions for workflow ids

You can use these ids in the following functions:

Function Example
istaskcomplete

{{#istaskcomplete(CurrentClient, "Planning") }}

This text will show if the Planning task is complete.

{{/end}}

isnottaskcomplete

{{#isnottaskcomplete(CurrentClient, "Planning") }}

This text will show if the Planning task is not complete.

{{/end}}

taskcompleted

Planning was complete on the following date {{taskcompleted(CurrentClient, "Planning")}}.

tasktitle

{{tasktitle(CurrentClient, "Planning")}} was complete on the following date {{taskcompleted(CurrentClient, "Planning")}}.

Full example

{{# istaskcomplete(CurrentClient, "Planning") }}

This will show if the planning item is complete. {{ tasktitle(CurrentClient, "Planning") }} completed on {{ format(taskcompleted(CurrentClient, "Planning"), "January 2, 2003") }}.

{{/ istaskcomplete(CurrentClient, "Planning") }}

Using workflow task details in templates

By opening by placing the following items within the task() function and calling the task's workflow ID, you can get use the details of the task in templates.

Code Description Sample result
{{# task("WorkflowID") }}
{{/ task }}
Statement to surround all of the following elements with. It declares the task from which to pull the information. Be sure to surround it with {{#CurrentClient}} or another tag to define the context, and replace WorkflowID with the ID of the task you want to reference. You can copy this ID by right-clicking on a task in options or in File Info. See the Workflow ids help topic for more details. n/a
{{ Title }} Title of the workflow item. Engagement letter signed and on file
{{ Subtitle }} Subtitle of the workflow item (if available). Depending on the task, this could be a tracking number or transmission confirmation number, etc. n/a
{{ InProgressSummary }} Display a summary of what shows when the task is not yet complete. Waiting to receive engagement letter
{{ Summary }} Display the summary of the task when complete. Engagement received by Elizabeth on 2018-08-10
{{ ShortSummary }} Display the short summary of the task when complete. Signed engagement letter received
{{ IsCompleted }} Check whether the task is complete. True or False
{{ IsNotCompleted }} Check whether the task is not complete. True or False
{{ CompletionDate }} Display the date when the task was completed. 2018-08-10 3:24:36 PM
{{ TargetCompletionDate }} Display the expected completion date for the task. Currently only applies to the CompletionDate workflow id in the Due date task. 2018-08-10 3:24:36 PM
{{ IsOverdue }} Check whether the task is past-due based on the completion date. Currently only applies to theCompletionDate workflow id in the Due date task. True or False
{{ UserName }} Display the username of the person who completed the task. Elizabeth
{{ HasComments }} Check whether there are any comments on the task. True or False
{{ Comments }} Display the comments associated with the task. n/a
{{ IsVisible }} Check whether this task is visible based on the Show check box in options. True or False
{{ IsOptional }} Check whether this task is optional based on the Required check box in options. True or False
{{ IsRelevant }} Check whether this task is relevant based on the content in the return. For example, is there a T1135 required? If so, the T1135 tasks display. True or False
{{ IsOverridden }} Check whether an automatic task is manually overriden in the client's return. True or False
{{ TrackingNumber }} Display the tracking number for the task. Currently only applies to the TrackingNumber workflow ID. Must be surrounded by {{# task("CourieredReturnToClient")}} {{/task}} to work. 1234577

Using task details in conditions

For any of the True or False task details, you can show or hide text based on that test. For example:

Example
{{# CurrentClient }}
{{# task("EngagementLetter") }}
{{# IsCompleted }}Show this text if the task is complete.{{/ IsCompleted }}
{{# not(IsCompleted) }}Show this text if the task is not complete.{{/ not(IsCompleted) }}
{{/ task }}
{{/ CurrentClient}}

Formatting dates from task details

You can format dates outputted by these task details. See the Dates help topic for more examples.

Example Result
{{# CurrentClient }}
{{# task("EngagementLetter") }}
{{ CompletionDate }}
{{ format(CompletionDate) }}
{{/ task }}
{{/ CurrentClient }}
2019-01-23 3:02:00 PM
January 23, 2019