Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Tip

Looking for a section on this page? Hover your cursor over the Table of Contents icon  to the right to quickly navigate this page.

...

When you click on any step in the workflow, a series of action icons displays depending on the step type. 

  • Properties displays tabs to set up Settings, Assignment, Messages, Rejection, Precondition, Escalations, Emails, Web Hook, Quick Approval and Geo Location. 
  • Edit form takes you to Forms editing mode for the form or parent form of a linked step.
  • Download Step allows you to download the step of the workflow as a standalone form. You may want to do this if you update the step in the workflow designer and you want to keep your Forms and Workflow libraries in sync.
  • Delete removes a step in a workflow. You will be asked to confirm the deletion. 
    Image Modified

Summary and HTTP steps only display the Properties and Delete options.

Step Properties Wizard

The Step Properties wizard opens when you click on a workflow step or select Properties from the step's action menu. The workflow outline will slide left but stay visible, and the Step Properties tabs will appear. You can close the Properties wizard by click the X just above it.  

...

  • You can navigate between tabs and between Guided Designer editing modes as you make edits, and your changes will be temporarily saved. Click the Save to permanently save your changes and continue working.
  • You can switch between steps while remaining on the same properties tab. This may be helpful when making lots of similar changes to workflow steps, such as changing the Task Info message for every step of a workflow.

  • will validate the Property Settings when you save. If a property value is invalid, the tab(s) will not close and a message will display with two options.
    • CLOSE: Close this dialog and fix your errors. Your changes will be saved, but you must correct validation errors shown in order to proceed.
    • DISCARD & CLOSE: Discard your changes. You can then navigate elsewhere. Note that this discards all changes made in the properties settings, not just the validation errors. 
    • The screen will stay on the current tab if there is a validation error.  Otherwise, another invalid tab will be auto selected (starting from left to right) if another tab needs attention. Tab labels with invalid entries display in red.
      Image Modified
  • Hover over any field on the Properties tabs to see a helpful hint providing information about the property. Some fields contain instructions to guide you.
  • Clicking on the down arrow for a property shows an unfiltered list of choices applicable to that property. For some properties, you may see templatized controls from your workflow and workflow/special templates provided in .
  • In some cases, you can type ahead to narrow down the list. Use the up/down arrows, the Enter key or click an option with your mouse to select an option. Use the Backspace, Delete or click the x on a selected property to delete it.
  • Typing a opening curly brace into some fields, followed by the name of a control, show a list of the fields in your workflow that match the entered text and will be added to the field as a control template.
  • On some tabs, you may have to slide the toggle to the right to turn on a feature.

Each step property setting is described below. 

Tip

Click the Help icon at the top of any tab for a quick tour of the features in that section. Currently tours are only available for Cloud customers.

...

  • You can enter any text you want for in the Subject and Message fields. Clicking on the DEFAULT button, shows "New Task" as the default subject and "You can access your task by clicking <a href="{task.perform.url}">this link</a>" for the default message.
  • Clicking on the down arrow, show a list of templatized fields from your workflow, workflow/special templates provided by and Task Templates that you can use in the body of your email.
  • Type the opening curly brace '{' followed by the control name to enter a field from your workflow as a template. Select an option to enter the control name into the field with the closing curly brace.

Built-in workflow templates

...

See the Email Integration topic for information on setting up email notifications for form and workflow submissions. This function uses a similar notification wizard.

The tenant admin can configure the from email address for task notification emails on the admin's Edit Tenant page.

Info

If you are using tomcat, emails sent are tracked in the <frevvo-home>\tomcat\logs\frevvo.log file when the INFO  log level is enabled. In-house customers can search for an entry like "Sending email to <email address> with subject <the subject of your email>. If an error occurs when sending, the message "Could not send email to <email address> with subject <the subject of your email> including the actual exception that caused the problem.

Built-in workflow templates

  • {flow.id} - The unique workflow instance id. This id is unique for each workflow submission.
  • {flow.type.id} - The unique id associated with a given workflow. See Sharing Forms
  • {flow.extid} - Client defined extId passed in the formtype Url parameter.
  • {flow.name} - The name of the workflow.
  • {flow.description} - Description of the workflow. 
  • {flow.activity.id} - The Id of the current workflow step.
  • {flow.activity.name} - The name of the current workflow step
  • {flow.activity.reject.reason} - The reason a workflow step is rejected

...

In this example, the url is the space URL with /tasklist appended to it. Users must be logged in for this URL to take them directly to their Task List in your space. On mobile, you will see a Back button rendered to take you back to the space. In both cases, the top browser URL is redirected to the appropriate menu item for your task list so the user will not have to click on the Task List menu tab to display it. If you do not have a task list menu item in your space, you'll end up at the space home page.

See the Email Integration topic for information on setting up email notifications for form and workflow submissions. This function uses a similar notification wizard.

The tenant admin can configure the from email address for task notification emails on the admin's Edit Tenant page.

...

.

Disable Task Notification Emails

...

Expand
titleClick here for a Pending Message example.

Let's say you have a 3 step Expense Report workflow.

Section
Column
width20%

Column
width80%
  1. Step 1 (the Expense Report) is filled in by the employee. It has fields that collects the user's ManagerID and Manager Name. When the employee submits the Expense Report, we want the employee to see the message "Your request has been sent to Jerry Jones". We can make the manager's name in this text dynamic using the template {ManagerName} use the name entered in the ManagerName field in Step 1.
  2. Step 2 is performed by the employee's manager who approves or rejects the report. When the manager approves the report and clicks submit, we want to display the message "The Expense Report has been sent to Payroll for processing" to the manager.
  3. Step 3 is performed by an employee in the payroll department who processes the Expense Report for payment.

To understand where you type in the text for your messages to get them to display when you want them to, think of the Pending Message property as the message that is displayed when users try to access workflow steps. In our example, when the employee submits Step 1, the workflow moves to Step 2, the manager approval step. The Pending Message configured on Step 2, "Your request has been sent to {Manager name}", is shown to the employee instead of the Step 2 form. When the manager approves the Expense Report and submits Step 2, the Pending Message configured on Step 3, "The Expense Report has been sent to Payroll for processing", is displayed to the manager when the workflow moves to the Payroll department employees instead of the Step 3 form.

To set up the Pending messages discussed in our example, follow these steps:

  1. Click on the first workflow step to display the Properties Wizard.
    1. The Pending Message for Step 1 displays the default - "Your request is being processed"
    2. A Pending message set up on the first step of a workflow is only displayed if there is an assignment on the first step. This feature is useful for auto-starting workflows programmatically. Leave the default Pending Message or leave this field blank on the first step if you are not using this feature.

  2. Click on Step 2 of your workflow - in our example this is the Manager step. Notice that the Step Properties Wizard stays on the Messages tab, but the step name above the tabs changes to Manager.

    1. Type "Your request has been sent to {ManagerName}" into the Pending Message field. The employee will see this message when he/she submits Step 1.

  3. Click on Step 3 of your workflow - in our example this is the Payroll step. Notice that the Step Properties Wizard stays on the Messages tab, but the step name above the tabs changes to Payroll.
    1. Type "The {flow.name} has been sent to Finance for processing." without the quotes into the Pending Message field. The manager will see this message after clicking Submit on Step 2.

  4. Save the workflow.

Tip

If you want to display a custom message such as "Expense Report Processing is complete." after the Finance user clicks the Finish button, use the Workflow Properties Message tab for the workflow. 

...

Steps performed by the same user in a workflow are referred to as a screenflow. The steps of the screenflow are considered one task. The reject functionality will allow users to reject only to the beginning of that screenflow. You cannot reject back to steps after step 1 in the screenflow.

Tip
Steps performed by the same user that are separated by Anonymous Task steps are considered to be a separate workflow tasks. For example, consider a Purchase Order workflow with the following navigation: Step 1 is performed by Sales employee > Step 2 is sent to the customer's Email Address (Anonymous user) > Step 3 is performed by the same Sales employee that performed Step 1. You can configure a Reject button on the Sales step that will show both steps as rejection targets even though Step 1 and 4 were performed by the same user. Refer to the Workflow Tutorial for an example.

Customize the Rejection Email

It is possible to customize the subject and email message body that is sent when a workflow task is rejected. You will configure this email on the step you are rejecting from. The customized rejection email will be sent when the Reject button is clicked on that workflow step or Quick Approval screen.

You can choose controls from your form which will be added to the Message as templates or you can use built-in templates as described below. Click on theImage Modifieddown arrow shows the list.

  •  {flow.name} - Name of the workflow
  •  {subject.first.name} - First name of the user who rejected the task.

  •  {subject.last.name} - First name of the user who rejected the task.

  •  {flow.activity.name} - The step of the workflow that was being performed when the task was rejected.

  •  {flow.activity.reject.reason} - The reason for the rejection.

  •  {task.perform.url} - The URL to the rejected task.

...

Troubleshooting the Reject Button

Here are some reasons why you might not see the Reject option on a step where "Reject From Here" is selected:

  1. If  the Reject To Here option is not selected in the previous steps, then user won't be able to see the Reject button on current step.
  2. When consecutive steps are executed by the same user,  treats it as a screenflow. Think of those steps in the screenflow as one task. The reject functionality allows users to reject only to the beginning of that screenflow/task i.e. where the previous user started his work. It won’t allow a reject to the in-between steps.
  3. If the immediate steps prior to the current step were performed by the same user, then he/she cannot reject to those steps (the user is rejecting the workflow to himself). Users can reject only to those steps performed by other users, or to steps performed by himself that do not come immediately before the current step.
  4. If a previous step was skipped because its precondition failed, then the user won't be able to reject to such a step.
  5. If a precondition on previous step passed when that step was being performed, but the control values change causing the precondition to now fail, the user might not be able to reject to that step.
  6. The Reject button will not be displayed at all if the conditions are such that users cannot reject to any prior steps.

...

  1. You can skip a task when the deadline expires and the workflow automatically navigates to the next step. This is set up on the Action tab.
  2. You can reassign the task to another user/role. This is set up on the Action tab.
  3. You can send notifications to the user(s) that currently have the task that the deadline has been reached and the task has been reassigned. This is set up on the Notifications tab.
  4. You can use templatized values of controls in any of the Assignee(s) fields in the Escalation setup screen. The username that is filled in as that control's value will be picked up during escalation.
  5. You can send reminder emails to the user(s) who have the task on their task list at specified intervals reminding them that the deadline for the task is approaching. This is set up on the Reminders tab.

For example. if you wanted to send reminder emails to the user(s) who currently have the task on their Task List that the deadline is approaching and then send an email notification to them when the deadline is reached, you would configure the Notifications and Reminders tabs and check None (Notify Only) on the Action tab. Continue reading for more details.

Escalation Tips
  • Multiple escalation triggers can be setup for the same step in a workflow.
  • Escalations will use the business calendar and timezone configured by the tenant admin.

...

Expand
titleClick here to see some Escalation Examples
Escalation Example 1
Let's consider a Time Sheet workflow consisting of 3 steps: 
  1. The employee accesses the Time Sheet workflow, fills in the form, signs it and clicks Continue. frevvo sends that employee's manager a notification via email
  2. The manager clicks on the notification [on any device], views the Time Sheet approval request and approves it or sends it back for corrections.
  3. If approved by the manager, the workflow is routed to employees in the payroll department for final processing. 

In this example, the designer has configured a 10 minute interval for the Manager to approve/reject the task. The Escalation tabs are shown:

Employee William submits his Time Sheet at 12:55 PM. The deadline to complete this task is 1:05 PM. William's Manager Jerry receives a Task Notification email notifying him there is a task that requires his attention. The email includes a link he can use to access it.
In this example, the deadline to complete the task is 1:05 PM. Based on the setup of the Reminder(s) section shown above, Jerry will receive 3 reminders every 3 minutes as the deadline approaches. The emails contain a link that Jerry can click to get to the task. The first one arrives as 12:56 PM, the second at 12:59 PM and the final reminder before the deadline arrives at 1:02 PM.
At 1: 05 PM, the task is removed from Jerry's task list since it was not completed in the allotted time and is routed to the task list of any users with the role of Supervisor. Jerry receives an email informing him that the deadline for the task has expired and the task is now assigned to any user with the role of Supervisor.
Reassigned users receive the Task Information email specified by the designer. So be sure to Setup the Task Notification Emails.

When Jack, a user with the role of Supervisor, access his task list he will see a task sent to him by the system and the Audit Trail shown in the image:
Image Modified
Escalation Example 2

Let's consider a situation where you might want to skip the task after the deadline has been reached. Imagine a workflow with a requirement that it must be approved by specific users in sequence. To prevent the chain of approvals from being delayed if one user does not perform their approval before the deadline, the designer can check the Skip the Task checkbox on the workflow steps and  will automatically complete the current step and create a pending task on the Task List of the next user.

The Project Approval workflow shown in the image must be approved by Approver 1 and Approver 2 in that order. The escalation set up on the Approver 2 step automatically skips this step and advances the workflow to the next next step . Notice that notification and reminder emails are also configured.

In this example,
  • The Approver 1 and Supervisor steps do not have Escalation configured.
  • The Approver 2 step has an escalation that specifies the step must be completed within 3 minutes. 
  • If Approver 2 does not complete the task within 3 minutes, the Approver 2 step is skipped and the workflow advances to the Supervisor step.
  • Approver 2 receives an Notification email stating that the workflow is now assigned to a Supervisor.
  • Approver 2  receives 1 Reminder email during the 3 minutes interval.


Here's what happens:
Image Modified
  1. Project Details are submitted for approval.
  2. Approver 1 receives a Task Notification email, clicks the link in it and performs Step 2 of the workflow. The task is placed on Approver 2's task list.
  3. Approver 2 receives a Task Notification email which includes a link to the task. Approver 2 does not click the link in the email to perform the task.
  4. Approver 2 receives 1 reminder email. Approver 2 does not perform their approval within the 3 minutes.
  5. When the 3 minutes expires, the task is removed from Approver 2's Task List. Approver 2 receives a customized email stating that the workflow has moved to a Supervisor for approval.
  6. All users with the role of Supervisor receives a Task Notification email which includes a link to the task. 
  7. Someone in the Supervisor group approves/rejects the task.

...