A node represents a step in a workflow. Winshuttle Designer provides a set of standard node types for which you can set properties specific to your workflow. The table below alphabetically lists each node type and its purpose. The following sections of this appendix describe each node type in detail, including the properties you can set for each.
NOTE: for instructions on how to include a node in your workflow and set its properties, see Using Winshuttle Designer.
Node Types
Node |
Name |
Purpose |
Activity node |
A single step or task in a workflow. |
|
And/Join node |
A step to evaluate an Approval node and to move on to the next step in the workflow. |
|
Approval node |
A step or task that requires approval or consent before proceeding. |
|
Decision node |
A step that branches to more than one path in the workflow. |
|
End node |
The last step in a workflow. |
|
Loop block node |
A sub process within a main workflow. |
|
Notification node |
A notification to alert participants to an event or status. |
|
Plug-in action node |
A step that you can customize to integrate your own functionality into a workflow. |
|
Start node |
The beginning of a workflow. |
|
Value Setter node |
A step that allows you to set values in fields or list columns to manipulate a workflow route. |
|
Xor/Join node |
A step to evaluate an Approval node and to move on to the next step in the workflow. |
The Activity node is used to represent a single logical step or task in a workflow.
Property |
Description |
AllowBulkApproval |
Whether or not assignees should have the option of bulk, approving their assignments based on this node in the Winshuttle Task List detail view. |
Allow OverrideDuration |
Allows the initiator of the form to set a new duration (time in which the task must be completed), other than the default (set from the Duration property). A reference to a column must be entered in the property, either as an expression (e.g. $date(today()+[//my:numberofdaysallowed])) or a single column (e.g. [overrideDuration]). NOTE: This option works in conjunction with a SharePoint list or document library column. The column can be created from an InfoPath control in the form that has been exported as Form Library Column or manually created in the document library properties. The overriding value must be in a date format (such as 12/07/2010). Make sure that End Users are aware of the format. Using a date picker control ensures that users enter a correctly formatted value. |
Allow |
Allows the task assignee to reassign their task to someone else. |
AllowReplacement |
Allows the task assignee to replace a process-controlled document that is being routed. |
AllowTeamAddition |
Allows the task assignee to add team members (members of his/her SharePoint Group) to the task. New team additions receive an email notifying them that they have a task. This setting converts an assignment to a single user into a team assignment. |
AssignmentCompletionText Link |
Text displayed as the hypertext link directing the assignee to their task. |
CommentRequirement |
Requires the task assignee to enter a comment prior to completing their assignment. Possible values are: None — does not require comments. |
DefaultCompletionPeriod |
The time (in days or hours) that a task will automatically be completed if the assignee does not complete it. NOTE: The task will only be automatically completed once the value (amount of time) of this setting and the Duration property setting have elapsed. |
Description |
A description of the task/assignment. |
Duration |
The time (in days or hours – see DurationUnit) within which the task must be completed. Reminder emails are sent out one DurationUnit before the assignment due date, unless the Duration is set to 1 unit. Overdue emails are sent out after the assignment due date. |
DurationUnit |
The time unit (Days or Hours) for the duration of the task. |
EmailApproval |
Allows the task assignee to complete the assignment (approve or reject) via email. This usually does not apply to the Activity node. |
EmailFormattingType |
Type of notification that goes out when the task is assigned. Possible values are: HTML— the email notification is sent in HTML format. HTML and Text — the email notification is sent in both HTML and text format, and the mobile device automatically determines which view (text or HTML) to display. Text — the email notification is sent in text format. NOTE: In order to support as many devices as possible, there are two email options that specifically address mobile devices, HTML/Text or Text Only. Some devices fully support HTML/text emails, rendering the correct view of the notification, while other devices do not. The Text Only option should be used for devices that do not support HTML/Text email. Run a few tests with your workflow and mobile device(s) to determine which option is best for your users. |
FormAttachmentFormat |
Whether to use MHTML or JPEG as the format for the email form attachments. |
FormHiddenFields |
List of fields to remove from the form XML that is sent to the client when the FormHiddenFieldType is List. This option can be used to avoid sending sensitive information in a form to the browser. NOTE: Option maintains sensitive information on the server only. |
FormHiddenFieldType |
None is the default, and does not exclude any fields. List allows the Process Designer to specify a comma-separated list of columns to remove from the form XML. Auto attempts to compute only the fields that should be shown based on the view assigned to the task, and it will then send only those fields. |
FormView |
The InfoPath form view visible to the task assignee when the assignment is accessed. |
IncludeAssignment CompletionLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to their task (see AssignmentCompletionText Link). |
IncludeHistoryInNotification |
Toggles the appending of workflow history associated with the form or document. |
IncludeItem |
Attaches the form and/or file attachments to the email. |
IncludeItemLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the form or document pertaining to the task (see ItemLink Text). |
IncludeMainPageLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the forms site where the task originated (see MainPageLink Text). |
ItemLevelPermissions |
The name of the SharePoint permission set that should be ascribed to the Originator for the SharePoint item against which the workflow will run. |
ItemLevelPermissionsType |
Can be one of the following: None — does nothing with respect to permissions. |
ItemLinkText |
Hypertext link directing the assignee to the form or document pertaining to the task. |
LinkOrder |
The order in which to place the links in the automatically generated email notifications. |
MainPageLinkText |
Hypertext link directing the assignee to the forms site where the task originated. |
ManagedAttributes |
SharePoint list fields exposed to the task assignee. |
Name |
The name of the task/assignment. |
OverdueReminderFrequency |
The interval (in hours or days) to send the overdue notices for an assignment. NOTE: The default value of this property (0) sends only one reminder after the assignment is past due. |
PastDueEmailCC |
Takes a comma-separated list of email addresses and/or swimlane names that will be carbon copied when a past due email is sent. |
RequireReview |
Requires that the assignee view the task’s supporting document/file by clicking on the link to it prior to completing their assignment. |
SendAssignmentEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node. |
SendDefaultApprovalEmail |
Whether or not to send an email to the workflow participant should a default assignment approval happen based on this node. |
SendPastDueEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node when the assignment becomes overdue. |
SendReminderEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node when the assignment will soon become overdue. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Swimlane |
The swimlane assigned to the task. |
Type |
Read-only type of the node. |
The And/Join node is used to evaluate Approval node dispositions and move on to the next step in a workflow based on the property setting of the Approval nodes.
Property |
Description |
Assignment CompletionLinkText |
A hypertext link directing the assignee to their task. This usually does not apply to the And/Join node. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the And/Join node. |
MainPageLinkText |
A hypertext link directing the assignee to the forms site where the task originated. This usually does not apply to the And/Join node. |
Name |
The name of task/assignment. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Type |
Read-only type of the node. |
Example
In the following example, the And/Join node requires that ALL managers approve, before going on to approve and complete the process. By contrast, the Xor/Join node requires a single rejection from any of the managers to reject and end the process.
The Approval node is a step within a workflow that requires the consent or decision of its assignees to proceed to the next step in the workflow.
Property |
Description |
|
AllowBulkApproval |
Whether or not assignees should have the option of bulk approving their assignments based on this node in the Winshuttle Task List detail view. |
|
AllowOverrideDuration |
Allows the initiator of the form to set a new duration (time in which the task must be completed), other than the default set from the Duration property. A reference to a column must be entered in the property, either as an expression (e.g. date(today()+[//my:numberofdaysallowed])) or a single column (e.g. [overrideDuration]). NOTE: This option works in conjunction with a SharePoint list or document library column. The column can be created from an InfoPath control in the form that has been exported as a Form Library Column or manually created in the document library properties. The overriding value must be in a date format (e.g. 12/07/2010). Make sure that users are aware of the format. Using a date picker control ensures that users enter a correctly formatted value. |
|
AllowReassignment |
Allows the task assignee to reassign their task. |
|
AllowReplacement |
Allows the task assignee to replace a process controlled document that is being routed. |
|
AllowTeamAddition |
Allows the task assignee toadd team members (members of his/her SharePoint Group) to the task. New team additions receive an email notifying them that they have a task. This setting converts an assignment to a single user into a team assignment. |
|
ApprovalType |
Type of approval required to complete this task. Possible values are: Unanimous — all must agree for approval. |
|
Assignment |
Text displayed as the hypertext link directing the assignee to their task. |
|
CommentRequirement |
|
|
DefaultApprovalPeriod |
The time (in days or hours) in which a task will automatically be approved if the assignee does not complete it. NOTE: The task will be automatically completed only when the value (amount of time) of this setting and the Duration property setting have elapsed. The workflow continues along the transition or transitions that meets the criteria. If you have a task and there is a single transition, it will go down that path. If you have an approval node and a reject node, it will move down the approved transition. Best practice when you use this function is to have a transition node that is set to condition "AutoApproved" and one that is labeled "ExplicitlyApproved" and a transition that is labeled "Rejected." |
|
Description |
A description of the task/assignment. |
|
Duration |
The time (in days or hours – see DurationUnit) within which the task must be completed. Reminder emails are sent out one DurationUnit before the assignment due date, unless the Duration is set to 1 unit. Overdue emails are sent out after the assignment due date. |
|
DurationUnit |
The time unit (days or hours) for the duration of the task. |
|
EmailApproval |
Allows the task assignee to complete the assignment (approve or reject) via email. |
|
EmailFormattingType |
Type of notification that goes out when the task is assigned. Possible values are: HTML — the email notification is sent in HTML format. NOTE: in order to support as many devices as possible, there are two email options that specifically address mobile devices, HTML/Text or Text. Some devices fully support HTML/text emails, rendering the correct view of the notification, while other devices do not. The Text option should be used for devices that do not support HTML/Text email. Run a few test with your workflow and mobile device(s) to determine which option is best for your users. |
|
FormAttachmentFormat |
Whether to use MHTML or JPEG as the format for the email form attachments. |
|
FormHiddenFields |
List of fields to hide from the task assignee. NOTE: This option maintains sensitive information on the server only. |
|
FormHiddenFieldType |
Type of fields to hide from the task assignee. |
|
FormView |
The InfoPath form view visible to the task assignee when the assignment is accessed. |
|
IncludeAssignment CompletionLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to their task (see AssignmentCompletionLinkText). |
|
IncludeHistoryIn Notification |
Toggles the appending of workflow history associated with the form or document. |
|
IncludeItem |
Attaches the form and/or file attachments to the email. |
|
IncludeItemLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the form or document pertaining to the task (see ItemLinkText). |
|
Include MainPageLink InNotification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the Designer site where the task originated (see MainPageLink Text). |
|
ItemLevelPermissions |
The name of the SharePoint permission set that should be ascribed to the Originator for the SharePoint item against which the workflow will run. |
|
ItemLevelPermissions Type |
Can be one of the following: None — does nothing with respect to permissions. |
|
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. |
|
LinkOrder |
The order in which to place the links in the automatically generated email notifications. |
|
MainPageLinkText |
A hypertext link directing the assignee to the Designer site where the task originated. |
|
ManagedAttributes |
SharePoint list fields exposed to the task assignee. |
|
Name |
The name of the task/assignment. |
|
OverdueReminder Frequency |
The interval (in hours or days) to send the overdue notices for an assignment. NOTE: The default value of this property (0) sends only one reminder after the assignment is past due. |
|
PastDueEmailCC |
Takes a comma-separated list of email addresses and/or swimlane names that will be carbon copied when a past due email is sent. |
|
RequireReview |
Requires that the assignee view the task’s supporting document/file by clicking on the link to it prior to completing their assignment. |
|
SendAssignmentEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node. |
|
SendDefaultApproval |
Whether or not to send an email to the workflow participant should a default assignment approval happen based on this node. |
|
SendPastDueEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node when the assignment becomes overdue. |
|
SendReminderEmail |
Whether or not to send an email to the workflow participant who receives an assignment based on this node when the assignment will soon become overdue. |
|
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
|
Swimlane |
The swimlane assigned to the task. |
|
Type |
Read-only type of the node. |
|
VoteCount |
Percentage that must be reached by the participants assigned to the node for approval or rejection to be granted. |
The Decision node is used as a visual reference point in the process to indicate branching in the workflow.
Property |
Description |
Assignment CompletionLink Text |
A hypertext link directing the assignee to their task. This usually does not apply to the Decision node. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Decision node. |
MainPageLinkText |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the Decision node. |
Name |
The name of task/assignment. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Type |
Read-only type of the node. |
The End node is used as a visual reference in a workflow to indicate where it ends. An End node is required to conclude a process or sub-process (loop).
Property |
Description |
||
Assignment CompletionLink Text |
A hypertext link directing the assignee to their task. This usually does not apply to the End node. |
||
Description |
A description of the task/assignment. This usually does not apply to the End node. |
||
Disposition |
The value of the End node. There are three possible values: Completed — indicates that the process has been completedand flags it as completed. This is the default value. Approved — indicates that the process has been completed and flags it as approved. Rejected — indicates that a process was not completed and flags it as rejected. |
||
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the End node. |
||
MainPageLink Text |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the End node. |
||
Name |
The name of task/assignment. This usually does not apply to the End node. |
||
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
||
Type |
Read-only type of the node. |
The Loop node allows you to integrate sub processes within a main workflow.
NOTE: Complex workflows can contain multiple sub workflows, whose framework is contained in a separate canvas in Winshuttle Designer. Multiple canvases for sub workflows are presented in a tabbed stacking order and are accessed by clicking the corresponding tab.
Property |
Description |
Assignment CompletionLink Text |
A hypertext link directing the assignee to their task. This usually does not apply to the Loop node. |
Condition |
The condition that must be met in order for the LoopType property to function. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Loop node. |
LoopType |
The type of loop. Possible values are: While_Cond — the loop will continue while the condition assigned to it is met. |
MainPageLink Text |
A hypertext link directing the assignee to the Designer site where the task originated. This usually does not apply to the Loop node. |
Name |
The name of task/assignment. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Type |
Read-only type of the node. |
The Notification node is used to send notifications at a specific point informing team members of an action, event, or statusin a workflow.
Property |
Description |
Description |
A description of the task/assignment. This usually does not apply to the Notification node. |
EmailFormattingType |
Type of notification that goes out when the task is assigned. Possible values are: HTML — the email notification is sent in HTML format. NOTE: in order to support as many devices as possible, there are two email options that specifically address mobile devices, HTML/Text or Text. Some devices fully support HTML/text emails, rendering the correct view of the notification, while other devices do not. The Text option should be used for devices that do not support HTML/Text email. Run a few test with your workflow and mobile device(s) to determine which option is best for your users. |
FormAttachmentFormat |
Whether to use MHTML or JPEG as the format for the email form attachments. |
FormView |
The name of the form view to use in the case where a form is attached to the email. |
IncludeItem |
Attaches a form and/or file attachments to the email. |
IncludeHistoryIn Notification |
Toggles the appending of workflow history associated with the form or document. |
IncludeItemLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the form or document pertaining to the task (see ItemLink Text). |
IncludeMainPageLinkIn Notification |
Toggles the inclusion/exclusion of a hypertext link in the task notification, directing the assignee to the Winshuttle Workflow site where the task originated (see MainPageLinkText). |
ItemLinkText |
Hypertext link directing the assignee to the form or document pertaining to the task. |
MainPageLinkText |
Hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. |
Message |
The message in the notification. NOTE: HTML code can be used to format the email notification. |
Name |
The name of task/assignment. This usually does not apply to the Notification node. |
OverrideSendDelay |
The name of the SharePoint column that should be used to set the send delay of the email. |
SendDelay |
Time (in days or hours) to wait until sending out the notification. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Swimlane |
The swimlane assigned to the task. |
Type |
Read-only type of the node. |
The Plug-in node is used to automate tasks in a workflow, such as:
See the Winshuttle Actions Reference Guide for detailed information about each plug-in type, settings, and configuration examples. for details on using plug-ins.
Property |
Description |
Assignment CompletionLink Text |
A hypertext link directing the assignee to their task. This usually does not apply to the Plug-in node. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Plug-in node. |
MainPageLink Text |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the Plug-in node. |
Name |
A name of the task/assignment. |
PluginType |
The type of Plug-in node being used. |
Sync |
Indicates whether or not the system should wait until the plug-in completes to continue execution of the workflow engine. |
Type |
Read-only type of the node. |
ValuePairs |
Property settings for the Plug-in node. |
The Start node is used as a visual reference in a workflow to indicate where it begins. A Start node is required to initiate a process.
Property |
Description |
Assignment CompletionLinkText |
A hypertext link directing the assignee to their task. This usually does not apply to the Start node. |
Description |
A description of the task/assignment. This usually does not apply to the Start node. |
ItemLevelPermissions |
The name of the SharePoint permission set that should be ascribed to the Originator for the SharePoint item against which the workflow will run. |
ItemLevelPermissionsType |
Can be one of the following: None — does nothing with respect to permissions. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Start node. |
MainPageLinkText |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the Start node. |
Name |
The name of the task/assignment. This usually does not apply to the Start node. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Type |
Read-only type of the node. |
The Value Setter node allows you to set values in a form field or list column.This functionality can be used to manipulate a workflow route, based on the setting of values in a form field or list column.
Property |
Description |
Assignment CompletionLink Text |
A hypertext link directing the assignee to their task. This usually does not apply to the Value Setter node. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Value Setter node. |
MainPageLink Text |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the Value Setter node. |
Name |
The name of task/assignment. |
Type |
Read-only type of the node. |
ValuePairs |
Values that the Value Setter node will set. |
Example
The workflow below uses a hidden form field titled Review that gets exported as form library columns. The Value Setter node sets the value of the field to OFF on the main workflow, to direct the routing in the Factory Approval Loop to the Vendor Manager Approval and AP Planner Approval tasks. If one of those task participants rejects the form, the route proceeds to the Rejects route and a Value Setter node sets the value of the Review field to OFF. The loop restarts and the workflow is routed to the Revise PD task.
TIP: When working with Winshuttle Designer, always use the XPath (e.g. [//my:Review]) to the field in the form. When working with Process Controlled Document Workspaces (DocEx), always use the column (e.g. [Review]) as a reference.
The Xor/Join node is used to evaluate Approval node dispositions and move on to the next step in a workflow based on the property setting of the Approval nodes.
Property |
Description |
Assignment CompletionLinkText |
A hypertext link directing the assignee to their task. This usually does not apply to the Xor/Join node. |
Description |
A description of the task/assignment. |
ItemLinkText |
A hypertext link directing the assignee to the form or document pertaining to the task. This usually does not apply to the Xor/Join node. |
MainPageLinkText |
A hypertext link directing the assignee to the Winshuttle Workflow site where the task originated. This usually does not apply to the Xor/Join node. |
Name |
The name of task/assignment. |
SetValues |
Allows you to set a value in a form field or SharePoint list item, after the task has been completed. |
Type |
Read-only type of the node. |
Example
In the following example, the Xor/Join node requires the approval of a single manager before going on to approve and complete the process. The And/Join node requires a single rejection from any of the managers to reject and end the process.