Versions Compared

Key

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

Image Removed

When you click on any step in the flow,  a series of action icons displays depending on the step type. Creating a flow step by dragging/dropping an existing form or a New Form from the Palette shows these icons:

Image Removed - Cog icon - Click
Section
Column
width70%
Section
Column
width70%

Image Added

When you click on any step in the flow,  a series of action icons displays depending on the step type. Creating a flow step by dragging/dropping an existing form or a New Form from the Palette shows these icons:

  • Image Added - Cog icon - Click this icon to edit Step Properties. This icon is displayed when you select the flow step and in the Properties Navigator on the left side of the designer. 
    • Clicking the Image ModifiedEdit Step Properties icon on a flow step displays tabs to set up Settings, Assignment, Messages, Rejection, Precondition, Escalations, Emails, Web Hook, Quick Approval and Geo Location  as shown in the image above.
    • Clicking the Image ModifiedEdit Step Properties from the Properties Navigator or simply clicking on a section of the Properties Navigator brings you directly to the tab for immediate editing.
  • Image Modified - Chain link icon - Click this icon to create Linked Steps. Refer to Linked Steps in a Flow for a discussion of this Flow Design pattern and when you should use it.
  • Image Modified - Download Arrow over bar - Use this icon to download the step of the workflow as a standalone form. You may want to do this if you update the step in the flow designer and you want to keep your Forms and Flow libraries in sync.
  • Image Modified -  Pencil icon - Click this icon to make changes to a flow step. The form will open in the Forms Designer inside of the Flow Designer. Remember, the form in the Flow Designer is a copy and any form changes will not automatically sync up with the original form in your Forms library.
  • Image Modified - Minus icon - Use this icon to delete a step in a workflow. You will NOT be asked to confirm the deletion. Once clicked, the deletion is permanent.

If your step is a Summary, HTTP or Linked step, you will only see the Image ModifiedEdit Step Properties and Image Modified Delete icons.

Properties Navigator

When you click on a flow step, a Properties Navigator panel displays in the lower-left portion of the Flow Designer. This panel shows information about important properties setup for this flow step. Not all of the configured properties are shown in this view. Clicking inside a section or clicking on the Edit Step Properties icon in a section of the Properties Navigator immediately displays the property tab for editing.

The Properties Tabs work the same way whether you open them from the Navigator or from the flow step. Here is what you need to know:

  •  If you are working on several tabs at one time, you can navigate to other tabs and make changes there. Use the left and right arrows at the top of the screen to display additional tabs. You must click the Submit button when you are finished configuring Step Properties  to save your changes. Remember to save the workflow.
  • will validate the Property Settings when you click Submit. If a property value is invalid, the tab(s) will not close and a  message will display telling the designer that there are corrections to be made before saving. 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
  • Clicking on the Cancel button closes the tab(s). You will be asked to confirm if any changes were made.
  • 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 flow and flow/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 flow 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.

Settings

Specify General Settings for a step in your flow on the Settings screen.

Name

This is the name of the form that you dragged from the flow designer palette and dropped into your flow. If you drag and drop a New Form from the palette, you can change this name to something meaningful. Form names longer than 60 characters will be truncated. The Flow Step name can also be edited from the Flow designer canvas by clicking the flow step then clicking the pencil icon above the Properties Navigator. Edit the name then click the checkmark to save or the cancel icon to discard your changes.

CSS Class

This CSS class name will be added to the XHTML markup generated for this step in the flow. Refer to the CSS class topic for details.

Continue Label

This is the label of the button that is displayed at the bottom of every step in the flow. The default label is Continue for all flow steps except the last step where it defaults to Finish. You can use templates to customize the label on different steps of the workflow. 

Save Label

The Save button label can be customized for each step in your workflow. For example, you can change the button text to Save for Later. This will help users understand what to do if they want to save a partially completed flow. To show the Save button on a flow step, the 1063682867 property must be checked on the entire flow and on the flow step.

Decorator

The designer can select a decorator for the steps in a flow by choosing an icon from the Decorator dropdown.  The selected decorator will replace the default number for the step of the flow on the Navigation toolbar. The image shows the navigation bar for a flow that does not have a decorator selected on the Employee Information step and then shows how the navigation bar looks when the pencil icon is selected for this step.

Expand
titleClick here to see an image of the Navigation Bar with a Decorator selected

Printable

If this is unchecked, then this step will not appear in the printable PDF for the flow. This is commonly used when you add the same form to the flow multiple times or use the linked step feature to duplicate the same form for multiple steps. This is a common design pattern when the same form is passed among multiple people for approval (Approval Workflows). You will only be able to set printable on non-linked steps. The linked steps will not have the Printable property available in the designer. The setting for the non-linked step covers that step and all steps linked to it. The form for these step(s) will only be printed once in the pdf. It is no longer necessary to uncheck the printable property for all but one of the steps in this type of workflow . The designer can have fine grained control over which controls appear in the PDF by editing the step and setting the control's printable property.

Save/Load

If you check this checkbox on the flow level and on the step level, a Save button will be displayed for each step in your flow. If you don’t want users to be able to save partially completed flows and continue them later, uncheck the checkbox so users will not see this button.This feature is useful for flows containing lengthy forms where your users may not have all the information required to complete the form in a single session. By clicking on the Save button, a copy of the flow with all the current values is saved by frevvo. frevvo will also generate an entry in the user's task list. Users access the saved flow task from the to continue working on it at a later time.

If you are not authenticated, clicking the Save button will display an authentication dialog that requires you to login. Users can save the flow as many times as they wish.

Saved flows can be monitored in the Submissions Repository. Saved flows can contain invalid data and can also contain required fields with no values yet entered. When such a flow is re-loaded the missing and invalid values are again flagged as such by frevvo. And the flow cannot be continued/finished until corrections are made to those fields.

This setting overrides the default Save/Load for the flow for this step only. If Save/Load is enabled for the flow as a whole, you can uncheck this property to disable it for specific steps. Click here for an explanation of how the Save/Load feature works.

Save to Role

When you click Save to save a partially completed flow, the saved flow will only appear on your own task list. If you check this box, then the saved flow is assigned to all users in the Role that is specified for the current step. For example, you may have an Issue Tracking workflow where an employee submits an Issue and the Issue can be acted upon by multiple users in the "Admin" role before it is resolved. The first step is filled in by any employee. When the employee clicks Continue, a task is generated for an "Admin" user. Any user with the "Admin" role can perform the task. The user can enter some data and click Save. The flow goes back into a pending state and is placed on the task list for any "Admin" user. A different "Admin" user can pick it up and continue working on the issue. In this manner, you can create a step in a flow that loops several times before continuing. Refer to the Looping between multiple users in a role topic for an example of a flow design pattern that uses Save to Role.

Save to User

When you click Save to save a partially completed flow, the saved flow will only appear on your own task list. If you check this box, then the saved flow is assigned to the user that is specified in the Users property. When you use this feature the User property should contain a template. For example, you may have form that needs to be reviewed and approved in an ad-hoc manner. In this manner, you can create a step in a flow that loops several times and that dynamically routes to different people before continuing. See the flow example Ad-hoc workflow: pass steps between arbitrary users for a deeper understanding of this feature.

Fast Finish

The Fast Finish feature is useful for workflows with many steps. If a user navigates to a previous step to change data, Fast Finish eliminates the need for the user to click the Continue button on the remaining steps of the flow to resubmit it with the changed data. Fast Finish can be selected at the flow level or at the step level. Refer to this feature announcement for more information.

Allow Signature Pad

Check this checkbox if the step in a flow will be using an external signature pad. Leave the property unchecked (default) on the steps that will not be using a signature pad.  See Topaz Electronic Signature Pads topic for the models supported and configuration information.

Column
width30%

On This Page:

Table of Contents
maxLevel3
 

...

  • 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 flow, flow/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 flow as a template. Selecting an option enters the control name into the field with the closing curly brace

    • Built-in flow templates

      • {flow.id} - The unique flow instance id. This id is unique for each flow submission.
      • {flow.type.id} - The unique id associated with a given flow. See Sharing Forms
      • {flow.extid} - Client defined extId passed in the formtype Url parameter.
      • {flow.name} - The name of the flow.
      • {flow.description} - Description of the flow. 
      • {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
    • Built-in special templates

      • {subject.id} - logged in user's username. 
      • {subject.roles} - A list of all the roles for the logged in user 
      • subject.email - logged in users's email address
      • {subject.first.name} - logged in users's First Name
      • {subject.last.name} - logged in users's Last Name

      • {subject.reports.to} - the user id of the person the logged in user Reports To - configured in the user profile by the Tenant Admin. Typically used to designate a manager/supervisor.

      • {tn.id} - the Tenant ID where a form/flow is located

      • {tn.name} - the Tenant Name where a form/flow is located

      • {user.id} - Owner of form/flow and user folder name in the filesystem 

      • {app.id} - The unique id associated with a given application. See Sharing Forms
      • {app.name} - The unique name associated with a given application.

...

Expand
titleClick here

Let's say you have a 3 step Expense Report workflow. Step 1 (the Expense Report) is filled in by the employee, Step 2 is performed by the employee's manager who approves or rejects the report and Step 3 is performed by an employee in the payroll department who processes the Expense Report for payment.

<< Employee submits Expense Report (Step 1) ==> the flow is routed to the employee's manager for approval (Step2) ==> once approved, the flow is routed to the payroll department for payment>>.

Step 2 in our example workflow is assigned to the employee's manager which is collected by a field in the form named ManagerName. When the employee submits the Expense Report, the designer wants the employee to see the message "Your request has been sent to {Manager name}". {ManagerName} is an example of a template that is replaced at runtime by the name that is entered in the ManagerName field in Step 1.

Step 3 in our example is assigned to any user that is assigned the role of Payroll. When the manager approves the report and clicks submit, the designer would like to display the message "The Expense Report has been sent to Payroll for processing" to the manager.

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 flow moves to step 2, the manager approval step. The message typed into the Pending Msg field for 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 message typed into the Pending Msg field on Step 3 - "The Expense Report has been sent to Payroll for processing" is displayed to the manager when the flow 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 the Edit icon for your flow on the Flows Home Page.
  2. Click on the first workflow step to display the Properties Navigator panel.
    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 flow is only displayed if there is an assignment on the first step of your workflow. This feature is useful for auto-starting flows programmatically. Do not assign a Pending Message for the first step if you are not using this feature.
      Image Modified

  3. Click on Step 2 of your flow - in our example this is the Manager Approval step.

    1. Click the Edit step Properties icon in the Messages section of the Properties Navigator.
    2. Type "Your request has been sent to {Manager name}", without the quotes into the Pending Msg field. The employee will see this message when he/she submits Step 1 and the task is placed on the Manager's Task List

  4. Click on Step 3 of your flow - in our example this is the Payroll step. 
    1. Click the Edit step Properties icon in the Messages section of the Properties Navigator.
    2. Type "The Expense Report has been sent to Payroll for processing." without the quotes into the Pending Msg field. The manager will see this message after clicking Submit on Step 2 and the workflow is routed to the Payroll department. Click Submit
  5.  If you want to display a custom message such as "Expense Report Processing is complete." after the Payroll user clicks the Finish button, click the  what does the user see icon? on the flow designer toolbar to display the Form Action wizards. Click on Display Message when users submit your form wizard. Type your message in the Message box. Click Finish.
  6. Save the flow.

...

  • Reject to Revise - The form is sent back to a prior flow step for correction/more information. This is the Reject to Revise (Easy Reject) feature described below and is built into .
  • Reject to Discard - Users pick the option to Reject to Discard the Submit as Disapproved - When a user disapproves the request from an Approval control, enter a status or comment and the flow the workflow skips all subsequent steps and completes. A submission is saved into the Submission Repository. It is likely that you You may want to implement some custom business rules to fill requirements after the of Reject to Discard that run when the "disapprove" option is selected, such as display a message to communicate the status to the user. Refer to Reject to Discard to see how the designer can implement this feature in workflows.the user. 
  • Abort a Task - crumple the form up and toss it into the trash can. Only the Tenant Admin, users who have been granted the Flow Admin privilege for the workflow and the designer who created the workflow have the capability to abort a workflow task. When a task is aborted, all subsequent flow steps are skipped and the form is not saved in the Submission Repository. The Abort feature is built into .

...

Steps performed by the same user in a flow 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 flow 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 Flow 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.

...

In-house customers can modify the default subject and message values by changing the text in the web.xml file. Click here for the details.

Click here for an example showing how the Easy Reject feature works.

The "from" email for a rejection is the tenant "from" email. If no tenant "from" email is set, this will default to the admin user's email address.

Reject to Discard

Most often, steps in an Approval workflow can have three possible outcomes.They can be:

  • Approved
  • Sent back to a previous step for corrections/more information (Reject to Revise)
  • Rejected and terminated (Reject to Discard)

Consider a workflow where Step 1 is filled out by a user, the second Step requires approval by a manager and when approved, Step 3 of the workflow is routed to the VP for review. After approval by the VP, the workflow completes.

The designer must consider what actions the Manager and the VP could take when the workflow appears on their Task List.

...

. Click here for the details.

Click here for an example showing how the Easy Reject feature works.

The "from" email for a rejection is the tenant "from" email. If no tenant "from" email is set, this will default to the admin user's email address.

Submit as Disapproved (Reject to Discard)

Most often, steps in an Approval workflow can have one of three possible outcomes. They can be:

  • Approved
  • Sent back to a previous step for corrections/more information (Reject to Revise)
  • Disapproved and terminated (Submit as Disapproved)

In the third case, where any approval step that is disapproved should terminate the workflow, we recommend the Submit as Disapproved workflow pattern. This is also know as "Reject to Discard" but it is important to note that this scenario does not use the Rejection feature. Rather, it uses Preconditions to skip the remaining steps in the workflow and submit it. Let's say you have a three-step workflow:

  1. User fills out a form
  2. Manager approves or disapproves
  3. VP approves or disapproves 

If the Manager disapproves, you don't want the VP to even see the workflow; you simply want to discard it. To do this, you will set a Precondition on the VP step to only perform that step if the Manager has approved (click the link below for step-by-step instructions). Often you will use a Radio control to indicate Approved/Disapproved. The workflow will now route as follows:

  1. User fills out form
  2. Manager can 
    1. Approve and send to VP
    2. Reject and return to User for more info
    3. Disapprove and skip VP step, submitting the workflow at this point.
  3. (if Manager approved) VP approves/disapproves and submits the workflow.

When you use the Submit as Disapproved scenario, you will still have a submission for the workflow, and Workflow Document Actions will run. Activity Doc Actions on skipped steps will not run. Many customers choose to configure Document Actions, such as email, with templatized strings in the To address, subject and message, in conjunction with business rules that set those control values, so that the message sent will be different depending on whether the steps were approved or disapproved. Here is an example of conditionally sending a Workflow Doc Action email. You may also choose to set the control that indicates approval/disapproval as a Searchable Field, so that you can easily view it in the Submission table and filter submissions by that field.


Expand
titleClick here to see how to implement Reject to Discard Submit as Disapproved for the above example

Follow these steps to implement Reject to DiscardSubmit as Disapproved:

  1. Create an approval section with a Radio button in Step 2 of the workflow. Note the name of the Manager Approval control. In this example, the control where the Manager selects "yes or no" to approve/reject is named mgrApp.



  2. Set a 1063682867 on Step 3 (VP step in our example) so that it only executes when the Manager selects "yes" in the Approval control in Step 2. You can invoke the Precondition Rule Builder by clicking on the icon or click the icon too enter the code manually.
    In our example, the precondition would be:

    Code Block
    mgrApp.value==="yes"

    Step 3 is only performed if the precondition evaluates to true (Manager selects "yes"). When the Manager selects "no"  Step 3 will be skipped and the flow completes.

  3. Use the Visual Rule Builder to write any Business Rules needed for behaviors after the Reject to Discard selection is made. For example, a business rule to show a message to the Manager explaining the flow status, when "no" is selected and to hide the message if the Manager selects "yes" to approve the request.

  4. Configure the Reject button to give the Manager/VP the opportunity to reject the workflow back to a previous step for revision.
  5. Check Submissions Stored Inside of frevvo for the procedure to check the completed submission.

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 flow 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.

...


Tip

In general, a condition is selected that acts as a trigger for the escalations. If the condition is NOT met, then the designer can specify what actions to take. You can elect to reassign, notify, send reminders or skip the task but you do not have to choose all three. However, once a condition is selected one of the actions must be reassign,notify or skip.

  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.


...

  1. Perform By - This condition is met when the user clicks the  (if the task is assigned to a particular user) or ( if the task is assigned to a role) Perform icon on the task in the users Task List or Saves/Locks the task before the configured due date. If the Task Notification email includes the {task.perform.url} then the deadline is met when the user clicks the link in the email to display the task. 

  2. Perform Within - This condition is met when the user clicks the (if the task is assigned to a particular user) or ( if the task is assigned to a role) Perform icon on the task in the users Task List or Saves/Locks the task before the configured the configured duration). If the Task Notification email includes the {task.perform.url} then the deadline Undo is met when the user clicks the link in the email to display the task.
  3. Complete By - This condition is met when the user clicks the Continue/Finish button on a step in a workflow before the configured due date.
  4. Complete Within - This condition is met when the user clicks the Continue/Finish button on a step in a workflow before the configured duration.

Selecting Perform By or Complete By displays two options.

Using Date/Time Control: The Due Date control dropdown displays all date controls in your form. 

...

  1. condition is met when the user clicks the Continue/Finish button on a step in a workflow before the configured duration.

Selecting Perform By or Complete By displays two options.

  • Using Date/Time Control: The Due Date control dropdown displays all date controls in your form. 

    Image Added

    • The control used in the template must have a value before the task is created. For example, a date entered by the user on Step 1 can be used in an escalation condition on any later step. However, that date control template will not work in an escalation on Step 1, because the escalation is created at the moment the Step 1 task is created (when the form loads), and at that moment the control does not yet have a value. The date or date/time control used as a template in an escalation can get it's value a) in use mode or by business rule in a prior step, b) by setting a default value in the designer, or c) using _data when the workflow is initialized. 
    • An invalid due date template value will resolve to the current time to prevent any use-mode errors. The following message will appear in the frevvo logfile: "Escalation Due Date {DueDate} resolves to an invalid value".
    • Date controls will automatically use the end of the day set in your business calendar in UTC, or 11:59 PM if no end of day is set, as the time component. 
  • Use Using Fixed Date: Enter a date/time as the deadline.

...

  • Image Modified

Selecting Perform Within or Complete Within displays Days, Hours and Minutes and a Business Calendar checkbox.

  1. Specify the amount of time the user has to perform or complete the task in Days, Hours or Minutes.
    1. Check the Business Calendar checkbox if you want to use the business days, times and timezone specified for your tenant to calculate a task deadline. The business calendar is set up at the tenant level by the tenant admin.

Image Modified

Escalation Actions

Once the condition is selected, click the Action tab to continue. Select from the following choices:

  1. None (Notify only) - Check this option if you want 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. The Notification tab becomes required. The task will not be reassigned or skipped. 
    1. Reassign Task - Reassignment sends the task to the user/role selected if the deadline is passed. Select whether the task will be reassigned to a Role, User or Unlock to Role: 
      Image Modified
      1. If you select Role or User, then you must select the user or role in Select Role or User Assignee(s) field. Type ahead to display the Roles/Users in your tenant that begin with the letter you are typing and select from the list or enter comma separated templates. Remember that  userids and roles are case sensitive. If reassigning to a specific user, only one user id can be selected but you can reassign to more than one role.
      2. Unlock to Role - This option unlocks the task. Use this option for a step in your workflow that has a role assigned to it and you want to handle the situation where one user with that role has the task locked and the deadline for the task has passed. Selecting Unlock to Role unlocks the task and keeps it on the Task list of all users with the role after the deadline expires. Now it can be performed by any user with the specified role again.
        For example, let's say you have a step in your workflow that is assigned the manager role. Users Jerry and Jim are managers so the task shows up on both their task lists. Jerry clicks the Image ModifiedPerform icon but he does not complete the step. The task remains on his task list and it is locked by him. If Jim tries to access the task or checks the Audit Trail he will see that the task is locked by Jerry. The deadline to complete the task passes. If Unlock to Role is selected as the reassignment option, the task remains on the task list of users with the manager role, in this case, Jerry and Jim, but it is unlocked and the audit trail shows a status of pending. Now it can be performed by any user with the manager role again.
        Image Modified
      3. Reassigned users receive the Task Information email specified by the designer. So be sure to Setup Task Notification Email for the step in your workflow where you assigned escalations and you want to reassign the task after the deadline.
    2. Skip Task - check this option if you want the workflow to escalate automatically to the next step when the timer expires. When checked, no further configuration is required.

      Info

      Skipping a task is only supported if the next step in the workflow is a form/summary step. Configuring the Skip a task feature on the last step of your workflow will not work. 

Escalation Notifications

You can set up notifications for any of the three actions. 

  1. Click on the Notifications tab.
    1. Slide the Image Modifiedtoggle icon to the right to turn on Notifications
    2. Select Role, User or the Current Owners from the Send To dropdown to specify who will receive email notification reminders when the deadline is reached.
      1. If you select Role or User, then you must list them in the Select User(s) or Role Recipient(s) field. Type ahead to display the Roles/Users in your tenant that begin with the letter you are typing and select from the list or enter comma separated templates. Remember that  userids and roles are case sensitive. You can specify more than one user or role.
        1. Current Owners refers to user(s) who currently have the task on their task list. Partial templates with prefixes and suffixes can be used to create a complex role such as floor-manager when setting up Escalations.

          Expand
          titleClick here for an example
           
          Insert excerpt
          Templatized Strings
          Templatized Strings
          nopaneltrue
      2. Specify an email(s), user(s), or role(s) to receive a CC: of the notification (optional).
      3. The subject and body of the notification email are shown once the Recipient(s) are selected. You can customize the email message by adding controls from your form as templates, workflow templates, common templates, escalation or task templates. Simply click the Image Modifiedto show the templates or type ahead to filter the list. For example, when a task is reassigned, you may want to specify the user/role that the task is being reassigned to (reassignee) in the email to avoid confusion. Simply add some text with this template in the Notification message section:  {flow.step.escalation.reassignee}.
        Image Modified
Escalation Reminders

Configure email reminders on the Reminders tab. Reminder emails notify the roles/user(s) originally assigned to this step.

  1. Specify the interval between reminders by entering the number of reminders in the Every field and select Days, Hours or Minutes from the Unit dropdown.
    1. You can limit the number of reminders by sliding the Image Modifiedtoggle icon to the right and entering the number of reminders closer to the deadline in the Occurrence(s) field. If you enter a negative number in this field by mistake,  will change it to a 1 when you exit the field.
    2. Specify an email(s), user(s), or role(s) to receive a CC: of the notification (optional.)
    3. You can customize the email message by adding controls from your form as templates, workflow templates, common templates, escalation or task templates. Simply click the Image Modifiedto show the templates or type ahead to filter the list. Select them from the Control dropdown.
Info

Reminders calculate back from the deadline. For example, let's say you set the condition to Perform within 1 day (24 hours), and then set the Reminders for every 2 hours, with no limit. So, 12 reminders will be sent (24 hours / 2 hours = 12 reminders), including one immediately after the Task Notification. To prevent this, be sure to toggle Limit reminders and set the occurrences to at least one fewer, in this case 11. 

...

Escalations and Screenflows

Escalation should always be defined on the first step of a task - this is relevant when setting up Escalations for a Screenflow.

Screenflows are steps in a workflow that are performed by the same user. Consider a New Employee On-boarding workflow where steps 1 - 5 are designed to collect the Personal Information, W - 4 Allowances, State Allowances, Health Insurances preferences and Banking Information. Step 6 in the flow is routed to the new employee's manager and step 7 is routed to HR for final processing. Steps 6 and 7 are not part of the screenflow as they are performed by users other than the new employee.

Think of the 5 steps of the screenflow as one task. Escalation for the screenflow task will work as long as you define the escalation on the first step of the screenflow task. The escalation configured on the first step of the screenflow applies to all steps of the screenflow. For example, if a Complete Within 2 days escalation is configured on Step 1 of screenflow, then the escalation is triggered if the whole screenflow is not completed within 2 days.

Tip

If the first steps of a workflow consist of a screen flow, you must configure the flow to use the Save on Navigate and/or Task for First Step properties for escalation triggers to get created

Escalation Examples

Expand
titleClick here to see some Escalation Examples

Escalation Example 1

Let's consider a Time Sheet workflow consisting of 3 steps: 
  • 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
    • The manager clicks on the notification [on any device], views the Time Sheet approval request and approves it or sends it back for corrections.
    • 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.

Image Modified

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.

Image Modified

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 flow 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 flow 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 flow advances to the Supervisor step.
    • Approver 2 receives an Notification email stating that the flow is now assigned to a Supervisor.
    • Approver 2  receives 1 Reminder email during the 3 minutes interval. 
      Image Modified
Here's what happens:   

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

Activity Document Actions

...

  • Click on the step of the workflow, then click the Edit Step Properties icon then click on the Email tab.
    • Click anywhere in the Email section in the Properties Navigator. This takes you directly to the Email tab.
    • Click the Image Modified inside the Email section in the Properties Navigator. This takes you directly to the Email tab.
    • Slide the Image Modifiedtoggle to the right to turn on the Email feature.
    • Enter email addresses or click the Image Modifieddown arrow to select control and built-in form/flow templates to dynamically determine it at runtime.
    • Customize the Subject and Message of the email.
    • Select the type of attachments to include in the email.
    • Remember to click Submit to save your changes.

Configuring Email

You can configure the Email tab on as many steps of your workflow. Remember the Document Actions that are set up will execute when the flow is completed, so you may not need to configure an action for the last step.

...

  • You have the option of sending a filled form image using the Send Snapshot dropdown. Select the image type from the dropdown. Leave the option blank if you do not want to send a snapshot.
    • The Data checkbox adds an XML document of your flow.
    • Check Attachments to include files uploaded to your form/flow. Uncheck it to exclude attachments in the submission.
    • If you have Pixel Perfect mapped PDFs (ex: W-4, I-9 etc…) associated with your forms/flows, choose  the action you want to take by checking an option in the Send Generated PDF Forms field:

      • Check All to send all the Pixel Perfect PDFs in the submission. This is the default value.
      • Check None to send none of the PDFs.
      • Check Select to display a list of all the PDFs associated with your form/flow. Click the ones you want to be part of the submission from the popup.

Info

Snapshots are generated for the entire flow when step Document Actions are configured on individual steps. For example, imagine a flow with 2 steps. An email step Document Action is configured on step 1. When Step1 is submitted, a pdf containing all printable controls in both steps will be attached to the email. This is as designed.

...

Expand
titleClick here to see an example of a Club Membership workflow configured to send an Email after the second step is performed

Consider the following Country Club Membership application flow:

  • To join the Country Club, an applicant has to be sponsored by 2 members of the club. Mary Jones calls the Club office and requests a membership application. The office worker creates a  user id and password for the applicant, logs into the club's  space, submits the form for first step of the flow providing the user id and password for the applicant.
    • Mary Jones gets a task notification email with link back to the club space and the information she needs to login. She logs into the Country Club  space, fills out the application, attaches letters of recommendation and a photo and submits the form.
    • Office workers get a task notification email informing them that a membership application task is pending for final processing.
    • When the office completes the final processing, an email goes to the Chairman of the Board with all documents attached – (Application, Letters of Recommendation, photo) so he can prepare for the final meeting with the applicant. 

In this scenario, the Chairman of the Board is not informed about the applicant until all of the office tasks have been completed. This could delay the process for some time. The Country Club wanted to improve the process by sending the Chairman of the board an email with the relevant documents (application, letters of recommendation, photo) attached after the step in the flow where the applicant completes the application. 

The Email tab can be configured to send an email  to the Chairman of the Board when the applicant submits the Candidate step (Step2) of the workflow. The application, required letters of recommendation and photo are attached to the email. Now the Chairman of the Board can review the application and relevant documents ( letters of recommendation, photo) without having to wait for the office to complete the final processing step. 


...

  • Clicking on the step of the workflow, then click the Edit Step Properties icon then click on the Web Hook tab.
    • You will not see a section for this tab in the Properties Navigator.
    • Slide the Image Modifiedtoggle to the right to turn on the Post to Web Hook feature.
    • Click the Image Modifieddown arrow to select control and built-in form/flow templates in the URL.
    • Select the type of attachments, if any.
    • Remember to click Submit to save your changes.

Configuring the Web Hook

  • Type the URL to your web application in the URL field. Templates can be used. Click the down arrow in the URL field to select control and built-in form/flow templates in the URL to your Web Application. When the form is submitted,  POSTs the document set to the specified URL. This option may be used for additional processing of data.
    • You have the option of also sending a filled form image using the Send Snapshot dropdown. Select the image type from the dropdown. Leave the option blank if you do not want to send a snapshot of the flow
    • The Data checkbox sends the flow XML document.
    • Attachments uploaded to your form/flow are sent if the Attachments checkbox is checked.
    • If you have Pixel Perfect mapped PDFs (ex: W-4, I-9 etc…) associated with your forms/flows, choose  the action you want to take from the Send Generated PDF Forms control:

      • Check All to send all the Pixel Perfect PDFs in the submission. This is the default value.
      • Check None to send none of the PDFs.
      • Check Select to display a list of all the PDFs associated with your form/flow. Click the ones you want to be part of the submission from the popup.

Activity Document Action Failure Notification

...

Expand
titleClick here for more information about failed posts

Activity Document Action Behavior for Failed Post

If the HTTP POST returns a status code 422 and an error message, interprets this code to mean that the activity in question should be re-run. For flow steps, this means that the form for the flow step is re-rendered. 

If you want to display a message to the user when the post fails,

  1. Add a Message control with the text you want to display to the flow step
    1. Add the class f-action-error to the CSS class property of the Message control. Controls with this class are not visible when the flow step loads, even if the Visible property is checked.

      Image Modified

    2. If the post returns a status code of 422 and some error text, the flow step will be re-rendered and the Message control will display.

For example, Let's say you have a fields on the last step of a flow step to collect a credit card number and the expiration date. The user fills in the information then clicks Finish. There is a Post Submission to a web app configured on this step.

Code Block
https://<your server>/services/testhttp?status={t}&content=errortext

If the web app returns a status code of 422 and some type of error message, the flow step will be re-rendered. The message informing the user to check the information and resubmit displays.

The flow step will continue to be re-displayed until the post returns an Ok status (HTTP 200).

Note

This behavior ONLY applies to POSTs to a web app in workflows. The behavior changes slightly if a Quick Approval is configured on the step. Refer to the Quick Approval Behavior when Activity Document Action post fails topic provides the details.

...

  • Clicking on the step of the workflow, then click the Edit Step Properties icon then click on the Quick Approval tab.

Approval Control

Your workflow step MUST have an Approval Control to successfully configure the Quick Approval feature.

...

  1. Drag/drop a Section control into the step of the workflow where you want to configure the Quick Approval feature. Name the section whatever you want.
    1. Drop a Textarea control inside the section. Do NOT add any other controls to the section.

The Approval control can be optionally set up to be digitally signed. Regular text digital signatures and Wet Signatures are supported. See Electronic Signatures for more information. The image below shows a section named Manager Review with a textarea control for comments. Text/Signature image is selected on the Signature dropdown on the section security tab. This section meets the requirements for an Approval control that can also be digitally signed.

 

...

  • Slide the toggle to the right to turn on the Quick Approval feature.
    • Set up Task Information for the Quick Approval view in the Summary field. Click the Image Modifieddown arrow to include control and built-in form/flow templates in the Task List Summary. The Quick View icon Image Modified will appear on the Quick Approval view on the Task List if the step in your flow has been setup for it. This feature is helpful if your users will be approving/rejecting steps of a workflow from a mobile device.
    • Select the Quick Approval control from the dropdown.
    • Remember to click Submit to save your changes.
    • Repeat for all steps where you want to configure Quick Approval.

There is a visual cue, a lightning icon, , that displays on a workflow step if quick approval is enabled.

...

Expand
titleClick here

Let’s use an Employee On Boarding flow as an example.

The Employee On Boarding flow consists of 6 forms: Employee Information, Allowances, Additional Information, Confirmation, Approval and Office Use Only. The requirements are as follows:

  1. The new employee fills out 4 forms: Employee Information, Allowances, Education History and Confirmation.
    1. The Confirmation form allows the new employee the opportunity to confirm the information and view the generated W-4 form.  
    2. Upon submission, the flow is routed to the new employee’s manager for approval.
    3. Managers can approve/reject the forms from an iPad or iPhone, using the Quick Approval feature which is configured on the Approval step of the flow
    4. If approved, the task is sent to the Human Resources department so that the Office Use Only form can be completed.
    5. If rejected, the task is sent back to the new employee for correction.

The Approval step consists of one section named Manager Review. This section has one control in it – a text area where the manager can comment. The section is set up for a digital signature - the Text/Signature image choice is selected in the Signature dropdown on the Security Tab. This section meets the criteria for an Approval Control and can be used to setup the Quick Approval feature.

  1. Click on the step in your flow where you want to set up Quick Approval.
    1. Click the step of the workflow, then click the Image Modified Edit Step Properties icon then click on the Quick Approval tab.
    2. If the form does not include an Approval Control, the wizard will indicate that the Quick Approval feature cannot be configured. 

      Image Modified
    3. Slide the Image Modifiedtoggle to the right to turn on the Quick Approval feature.
    4. Set up Task Information for the Quick Approval view in the Summary field. You can type the Summary statement or click the Image Modifieddown arrow to include control and built-in form/flow templates in the Task List Summary.  The Summary gives the mobile device user a short description of the task.
    5. Select the Approval Control from the Approval Control dropdown. In this example, the Manager Review section is the Approval set up on the second step of the flow - the Manager Approval step
    6. Click Submit to save the changes.

 A Lightning icon appears on the step in the flow once the Quick Approval has been enabled. This icon will appear and disappear as required when you enable/disable Quick Approval using the wizard.

The Quick Approval screen shown above displays in a manager's Task List when it is accessed from a mobile device. The manager clicks the Quick View icon  on the Task List to approve/reject the task without having to view all the details.

Refer to the Using the Task List for more information about how to use the Quick Approval feature.

Tip
  • If a step in a flow is setup for the Quick Approval/Rejection feature and it is followed by a Summary step or another step accessible by the same role , the task will go right back onto the user's Task List. It will be locked by that user who must click on the perform icon so the task can proceed to the next step in the flow. A flow where the next step after a Quick View approval is intended for the same user is not typical of good flow design.
    • You cannot configure Quick Approval on a workflow step that has the Save to User or Save to Role property selected. A warning message will display:

      Image Modified
Expand
titleClick here for details about flow behavior when Quick Approval is configured along with a post to a web application that fails

Quick Approval Behavior when Activity Document Action post fails

If the HTTP POST returns a status code 422 and an error message, interprets this code to mean that the flow step in question should be re-run. For flow steps, this means that the form for the flow step is re-rendered. If there are any message controls in the form with CSS class f-action-error, they will now become visible. These message controls are not visible by default when the form is first rendered.

For example, Let's say you have a two step workflow where step 2 has fields to collect a credit card number and the expiration date and has to be approved by a manager. .An Activity Document Action Post to a web app for data verification and Quick Approval have also been configured on this step.

The user fills in the fields in step 1, then clicks Continue to send the workflow to a manager for approval. The manager accesses his Task List, clicks the Quick Approval icon then the Approve button. The information is posted to a web application for verification. If the web app returns a status code of 422,(fail status) and some error text, the manager sees this message:

When the manager clicks on the Perform icon the flow step will be re-rendered. Any message controls, where the f--action-error class has been added to the CSS property, will display.



The Message control informs the manager that the post failed and provides instructions.

The flow step will continue to be re-displayed until the post returns an Ok status (HTTP 200).

Note

This behavior ONLY applies to workflow steps with Quick View configured and a POST to a web application that fails.

...

  • Capture location information for a step in your workflow.
    • Embed a Google map in your flow step.



You can display the Geo Location tab by:

  • Clicking on the step of the workflow, then click the Edit Step Properties icon then click on the Geo Location tab.
    • You will not see a section for this tab in the Properties Navigator.
    • Enable the Geo Location feature for the step.
    • Enable the ability to capture additional location information or embed a Google map in the flow step
    • Do this for each step in your flow where you want to use the Geo Location feature.
    • Remember to click Submit to save your changes.

You can capture the location where your form/flow was filled in by turning on ' Geo location feature. A form/flow knows it's current location and will submit that information when the form is completed.   uses the HTML5 GeoLocation api.  The geo api is well supported on tablet, phone and recent laptop/desktop browser versions. This feature works on a desktop or any GPS capable mobile device.

...

  • Select one of three options from the Geo Location dropdown to turn this feature on:
    • None - (no location) - this is the default
      • On Load - turn the feature on when the flow step loads (at start time)
      • Custom - allows the designer to specify a periodic refresh. The default value is 30 seconds. Choosing this method will fire a rule in the specified time. For example, if the field to the right of the Geo Location dropdown was set to 10, rules to capture additional location information would fire every 10 seconds. 
    • Enter the Location Refresh Timeout - thisis the amount of time in seconds the location finder in the browser will search to find the location before it times out. The default value is 5 seconds.
    • Check the Detailed Location checkbox to capture additional information based on the location via a Business Rule or to embed a Google map in your form. You will need a connection to google.com for this to work.

      Info
      • A connection to google.com is required for this to work. This connection is automatically available in the frevvo Cloud.
        • New in-house installations must obtain an API key in order to use this feature. Follow the steps listed here to obtain the key.

Displaying a Google Map in your Workflow Step

...