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. 
  
  

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

Settings

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

Name

This is the name of the step that you set in the Workflow Design Wizard or Add Step Wizard. If you do not provide a step name,  will give it a default name i.e. "Step 1" or the name of the existing form, if used. Form names longer than 60 characters will be truncated. 

CSS Class

This CSS class name will be added to the XHTML markup generated for this step in the workflow. 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 workflow. The default label is Continue for all workflow 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 workflow. To show the Save button on a workflow step, the Save/Load property must be checked on the entire workflow and on the workflow step.

Decorator

The designer can select a decorator for the steps in a workflow by choosing an icon from the Decorator dropdown. The selected decorator will replace the default number for the step of the workflow on the Navigation toolbar and will display in the Workflow Diagram. 

No decorators selected:

With decorators selected:

Printable

If this is unchecked, then this step will not appear in the printable PDF for the workflow. This is commonly used when you add the same form to the workflow multiple times. The Printable property is only available on non-linked steps. The setting for the parent step applies to that step and all steps linked to it. The form for linked step(s) will only be printed once in the PDF snapshot. 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.

Saved to the Task List

This feature displays a Save button on the step, and is useful for workflows containing lengthy forms where your users may not have all the information required to complete the form in a single session. When users click the Save button at runtime,  saves a copy of the workflow with all the current values to the user's task list. Users access the saved workflow from the task list to continue working on it at a later time.

The Saved to the Task List property is checked by default when you create a workflow step. In order to display the Save button, you must also check Save/Load in Workflow Settings. To remove the Save button for all steps, uncheck the Save/Load property in Workflow Settings. To remove the Save button for an individual step, uncheck the Saved to Task List property in Step Settings.

Workflow Setting: Save/Load	Step Settings:     Saved to the Task List	Result
Checked	Checked	A Save button is displayed on this step.
Checked	Unchecked	No button is displayed for this step.
Unchecked	Checked or Unchecked	No button is displayed for any step.

Save to Role

The Save to Role property allows the user to save the workflow to the task list of users in the assigned Role 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 the "Admin" role. Any user with the "Admin" role can perform the task. The user can enter some data and click Save. The workflow 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 workflow that loops several times before continuing. Refer to the Looping between multiple users in a role topic for an example of a workflow design pattern that uses Save to Role.

Save to User

The Save to User property allows the workflow to be saved to the user specified in the Assign to User field, rather than the current user. Usually in this scenario the Assign to User field contains a template, such as {NextApprover} to dynamically assign the step based on data entered at runtime. For example, you may have form that needs to be reviewed and approved in an ad-hoc manner. You can create a step in a workflow that loops several times and that dynamically routes to different people before continuing. Each approver selects another user from the NextApprover control, and then clicks Save to save the task to the next user's task list. See the Task Collaboration workflow pattern example 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 workflow to resubmit it with the changed data. Fast Finish can be selected at the workflow 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 workflow 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.

Assignment

Use the Assignment tab to:

• Assign a workflow step to a to a user, role(s) or an email address.

• CC a notification to any additional user(s) who should also know the workflow is on this step.
• Customize the Task Notification email message that is sent when the generated task for that step is put on the user's Task List. This email informs the recipients that there is a task that requires their attention.
• Disable task notification emails for the step.
  

Assign a Workflow Step to a User, Role(s) or Email Address

Users are given the highest priority at runtime followed by roles and then any email address.

User

This field allows the designer to assign a workflow step to a specific user. Clicking the shows the first 10 users in your tenant in alphabetical order, followed by the first 10 fields in your workflow in curly braces, making it a Control Template.

• You can enter a user id. Begin typing in the user id and a list of user names matching the text displays. Use the Enter key, the Up/Down arrows or click an option with your mouse to select a user.
• You can only enter a single username in this field. Ex: nancy. Setting the user property to a comma separated list of usernames, Ex: nancy, prajakta, will not work. This will be treated as a single username.
• This field can use templatized strings for dynamic content. For example, in a Vacation Request workflow, the first step is to be completed by an employee but the second (approval) step must be performed by the employee's manager. i.e. it can contain "{ManagerId}" where ManagerId is the name of a field in a form from a prior step.  will resolve the ManagerId string using the actual value of the ManagerId control and generate a task targeted at that specific user.
• To enter a Control Template, type the opening curly brace '{' followed by the control name into the Assign to User field. A list of fields from your workflow displays. Select an option to enter the control name into the field with the closing curly brace.
  
  

Refer to the workflow topic sending a workflow step to a specific user for an example.

You may want to route a step in a workflow to the user's manager.  provides a built-in template that is available for every transaction. Simply type the template {subject.reports.to} in the User property for that step in your workflow. The workflow will then be routed to the user who is specified in the Reports To field on the User's configuration screen.

Role

Roles are created by your tenant administrator or automatically imported from your LDAP or Active Directory server. When a role is selected, only users belonging to that role may perform the step. For example, if you have a Purchase Request workflow where the first step is to be completed by any employee but the second (approval) step must be performed by someone with the "Manager" role, you can select the Manager role for the second step. When an employee uses the workflow, completes the first step and clicks Continue,  will generate a task and place it on the task list for users with the Manager role and display the Pending Message to the employee.

• You can enter one or more roles. Begin typing in the role name and a list of roles in your tenant matching the text displays. Use the Enter key, the Up/Down arrows or click an option with your mouse to select a role.
• Repeat these actions to select additional roles i.e. Manager, HR 

• This field can use templatized strings to dynamically determine a role at runtime.  For example, you may have a workflow where the first step is a Purchase Order or a Loan Request and the second step is an approval; however the approval must be performed by a Manager if the amount is less than $1000 and a Supervisor otherwise. You will need a control in your form that is populated with the role that you want the workflow to navigate to - in this case, Manager or Supervisor. To enter a Control Template, type the opening curly brace '{' followed by the name of the control into the Assign to Role(s) field. A list of fields from your workflow displays. Select an option to enter the control name into the field with the closing curly brace. Repeat these actions for the steps in your workflow that are going to use the role entered for routing e.g. {ApproveRole}. At runtime.  will resolve the target role using the data in the ApproveRole control and will route the workflow to that specific role. See the workflow example topic determining the role at run-time.

Partial templates with prefixes and suffixes can be used to create a complex role such as floor-manager for workflow routing.

 Click here for an example

When you are setting up step Assignments or Escalations for workflows, you can assign a user/role template where only part of the text is inside the curly brackets - {}. This is best explained with a simple example using roles for workflow routing.

Let's say the roles in your organization are floor-manager, sales-manager and store-manager. Of course, these role names and users assigned these roles must exist in your tenant. Your form has a dropdown control named roles with these options: floor, sales, store. Users select the first part of the role from the dropdown. The suffix -manager is typed in after the role template in the Assignment tab to create the complex template - (floor-manager, sales-manager, store-manager). The workflow step with the complex template assigned will navigate to the appropriate role.

A partial match template lookup is available on the Assignment and Escalations tabs to select the complex template from dropdown options.

We will assign the {role}-manager on the Assignment tab of a workflow as an example:

1. Type the control name of the template surrounded by curly brackets - in our example - {role}

    

2. Type the dash - followed by manager. The {role}-manager appears in the dropdown

3. Click on it to select. Click Finish to save the changes to the Assignment tab then click the save and exit to save the changes to the workflow.

4. Test the workflow. Select floor in the role dropdown. The assigned workflow step will navigate to all the users in your tenant with the role of floor-manager.

The partial lookup works with users/roles and prefixes/suffixes in the users/role names.

Email Address(No login required)

Use this field to assign a step in your workflow that is going to be performed by an anonymous user. This is a user who will not need to log into your tenant to perform their step. Let's say you have a Purchase Order workflow, where the Order Details are completed by someone in your company and one of the steps is routed to the customer for approval and signature.

1. Edit the Purchase Order workflow in the Workflows Designer.
2. Click on the three dot Action Menu for the step anonymous users will perform and select Edit Properties. Select the Assignment tab.
3. Enter a valid email address into the Assign to Email Address (No login required) field.
   • will check if the address is entered in the correct format and notify the user if it is not.
   • Only one email address is allowed.
   • This field can use templatized strings to dynamically determine an email address at runtime. To enter a Control Template, type the opening curly brace '{' followed by the name of the control that will contain the email address into the field. A list of fields from your workflow displays. Select an option to enter the control name into the field with the closing curly brace. Repeat these actions for additional steps in your workflow that will be performed by anonymous users.
     

Some important information about the Assign to Email feature is

• The workflow can be rejected to a task performed by anonymous user.
• Tenant/workflow admins can reassign the anonymous step to a different email address.
• The Task Assignment can be CC'd to another user so that in case the link is lost, there is another way to access the task, reassign or resend it. Be aware that first user to click the link will lock the task, so to ensure the intended user performs the task, consider including in the email message a warning such as "A copy of this message has been sent to your manager. Managers should not click the task link."
• Configure a History Message on the step before the Anonymous Task step if you want to see relevant information in the audit trail. The History Message can include templatized strings so you can see the email address of the recipient.
• The Who can start the workflow permission does not need to be set to 'Anyone (login not required)'. The Anonymous step will work with any of the workflow visibility choices.
  

• The Anonymous step uses the {task.perform.url} template in the Task Notification email Message by default. If the anonymous user submits their step of the workflow then goes back into the email and re-clicks on the link, the following message displays:
  
  
  

Refer to the Anonymous Participant topic or the Workflow Tutorial for an example.

Workflow Task Design Considerations

The designer defines task boundaries by setting assignments (user, role or email address), so each workflow step with an assignment is considered a new task. Any subsequent workflow steps without assignment are considered part of screenflow of the same task. If the next step is a new task and the current user is eligible to perform it, the user will be provided with a link to continue the workflow in the same screen. When the user clicks the link to continue the workflow execution, the workflow will continue like a screenflow but a new task will be created behind the scenes. 

Here is a diagram that explains how step assignments define tasks:

Having an assignment to a workflow step strictly enforces the task boundary and it is applicable for the first step of workflow as well. This means to create a task for the first step simply configure the first step with an assignment. Designers can also define workflow level Access Control by selecting Custom in the Who can start the workflow property and entering user(s) or role(s).

Assignment on First Step

There are some cases where you may want an assignment on the first step of the workflow, so that initiating the workflow places a task on the user(s) task list rather than opening the form up right away. Usually this pattern is used when an external process is used to start the workflow. Here are a few examples:

• The HR Manager needs to launch Employee Review Forms for all of the employees annually, and place them on the respective Managers' task lists.
• The CFO kicks off the budget process by placing the first step of a budget workflow on each department head's task list. The first step has an escalation to ensure the step is completed within 60 days.
• After a new employee completed their Employee On-Boarding workflow, a task is created for them to complete the Acceptable Use Policy Workflow, which follows a different approval process than the EOB workflow. (This is one way to handle parallel workflows.)

Just as with any step of the workflow, you can set the first step's assignment to a hard-coded user, role or email. For example, if the first step of the Budget Planning workflow is assigned to the user Sue, then anyone with Access Control to start the workflow can start it (i.e. via portal, link, etc.). For example, perhaps the CFO clicks this link when they are ready to start the budget planning process. When they do so, they will see the pending message set on the first step, and the step will be placed on Sue's task list. Sue will also get a task notification email. 

However, it is more common to use this pattern with a template in the assignment field. In this case, a hidden control is added to the form, i.e. 'assignedUser'. The Assign to User field is set to the template {assignedUser}. The workflow is launched using a kick-off form (or other web service) that calls the workflow's raw share URL with the parameter _data=(<targetControlName>:<value>). The value in the parameter can also be template, such as when using another  form to select a user and launch the workflow to that user's task list. Here's an example:

The CFO is ready to kick off the budget planning process, and wants to place the Budget Planning Workflow on the task list of each department head. The Budget Planning Workflow has a hidden control named 'assignedUser' and the first step's Assign to User field is set to {assignedUser}. The CFO opens a different frevvo form designed as a "launch" or "kick-off" form. She enters the userID of a department head in a control named 'userID', and clicks a trigger button. A business rule then performs an http.get to the Budget Planning Workflow's raw share URL plus the parameter &_data=(assignedUser:{userID}). Let's imagine she entered the userID 'trevor'. Trevor will get a task notification email to perform the first step of the Budget Planning Workflow. The CFO can repeat her process for each department head userID. 

When a templatized control is used in the first step assignment, it's important to know that the value for that control can be initialized only by the first three methods of initializing default values in the order of precedence: 

1. Default values entered when the form was created in the Form Designer
2. Values from an XML document(s) sent in the Post request for the form or OnInit. (This is uncommon.)
3. URL parameters appended to the form URL via the frevvo _data URL parameter 

The third method, URL with the _data parameter, is by far the most common method. The workflow pattern "Start a New Workflow from Another Form/Workflow" describes how to design this scenario using  forms/workflows. All values set by the _data parameter (including the assignment control value and any other control values) will be set prior to the user performing the task. 

Doc URIs and Business Rules on the target workflow will only run after the assigned user performs the task. This ensures the correct initialization of form data when these methods are used. However, it also means that the target workflow in this pattern (whose first step is assigned to a template that is initialized using _data URL parameter) cannot be started using the traditional methods i.e. via a portal or email link without _data parameter setting the value of the assignment control. For example, a business rule that sets assignedUser to the logged in user's id would not run until after the task assignment. If a user tried to start the form via a portal, they would see the pending message for Step 1, but the {assignedUser} template would resolve to null, resulting in an invalid task assignment. The best practice is to only launch a target workflow using the external process, such as a launch form or web service. However, if the first step has Save to User or Save to Role checked,  will bypass the user assignment when the workflow is first initiated via the share link or portal. This can be a workaround if a target workflow needs to be started both via the launch form and via the share link.

Save to User or Save to Role on First Step

When you have Save to User or Save to Role, combined with a templatized User/Role assignment, enabled on the first step,  will allow a null value in the template only on workflow initiation. These means that any eligible initiator (based on Who Can Start the Workflow permissions) can start the first step, bypassing the user assignment on initiation. 

When the user clicks Save, the step will be assigned to the user specified in the template following the standard Save to User/Save to Role behavior.

• If the template resolves to a valid user, the step is assigned to that user/role. The current user sees the Step 1 pending message after clicking Save.
• If the template resolves to null, the step will be saved to the current user's task list. The current users sees "Save successful" next to the Save button after clicking Save.
• If the template resolves to an invalid user/role, an Invalid Task Assignment notification will be sent to the admin. The current user sees the Step 1 pending message after clicking Save.

Invalid Task Assignment

When a task that is routed to templatized user, role, or email resolves to null or empty string, the task will be assigned to the "invalid-task-assignment" userId and a notification with be sent to workflow admin users (or tenant admin user if no workflow admin is configured.) This will enable workflow admin users to easily search mis-routed tasks assigned to the "invalid-task-assignment" userId and re-assign to valid user.

One exception to this is when you have both a templatized user and a role assigned, the step will reroute to the Role(s) if the template resolves to null at run time. If the templatized user is valid, Role will be ignored.

Anonymous Steps and the Audit Trail

If your workflow was created in a version of previous to v8.0, then the step performed by the customer (anonymous user) was designed by dragging an EMail or Anonymous Task step from the Palette and dropping it on the Workflow Designer canvas. Workflows designed in this manner will still work in v10.0 but the Audit Trail will show the task in a WAITING state.

In version 8.0 and later, the same workflow can be designed by simply assigning the step to an Email Address. The Audit Trail, shows the step performed by the customer (anonymous user) in a Pending state and displays the Email address it was sent to.

Setup Task Notification Email

When  generates a task and places it on a user's task list, a notification email is generated.  The email informs the user that there is something on their Task List that requires their attention. A clickable link to the task or the Task List depending on the template that you choose, is included in the email.

You can specify your own email subject and message. The message body can contain HTML and CSS, giving you the ability to generate nicely formatted emails. Form data values can be added to the message subject and body using control template names or workflow/special templates provided by .

The designer can also specify email address(es), user(s), and role(s) to receive a CC: of the task notification message. For tasks assigned to an Email Address (No login required), the task will be locked by the first user who clicks the {task.perform.url} link. Designers can help ensure only the intended recipient picks up the task by configuring a warning into the email message such as "A copy of this notification has been sent to your manager. Managers should not click the link above."

Access the Assignment tab for that step to customize the subject and message of the email the user receives.

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

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.

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
  

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/workflow is located

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

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

• {project.id} - The unique id associated with a given project (See Sharing Forms.)

• {project.id} -The name of the project

• {form.project.id} - The unique id associated with the project of the given form

Task Notification Email Links

There are two built-in frevvo templates that can be used to generate a link in the task notification email: {task.list.url} and {task.perform.url}.  To make any of these clickable links in your task notification emails, wrap them in an HTML <a> tag like this:

You can access your task by clicking <a href="{task.perform.url}">this link</a>

Portal Specific URL

If you use a single  portal for all of the activities in your tenant, an easy way to open task URLs in your preferred portal is to set a Default Portal for the tenant in the Manage Tenant page. Selecting a default portal will cause task notification links to direct the user to the task and/or Task List rendered in the default portal.

However, if you have multiple  portals, you might want links to render in different portals for different forms/workflows. To do this - modify the task notification email  to use a portal specific URL. Change the default Task List special template to a portal specific URL which will return you to the user's Task List embedded in your chosen portal. Create a portal specific URL by supplying a URL to the Task List with the portal/portalID/tasklist appended to it.

You have a new task for New Hire. To access your task list,
please click on:
http://10.0.0.14:8082/frevvo/web/tn/mycompany.com/user/designer/portal/mycompany/tasklist   

In this example, the url is the portal URL with /tasklist appended to it. Users must be logged in for this URL to take them directly to their Task List in your portal. On mobile, you will see a Back button rendered to take you back to the portal. 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 portal, you'll end up at the portal home page.

Disable Task Notification Emails

You can disable the Task Notification emails for any workflow step assigned to a User or Role. This feature is useful for steps that should not notify users or for testing purposes. This feature is not available for steps assigned to an Email.

1. Navigate to the Assignment Tab.
2. Click CLEAR NOTIFICATION .
3. A confirmation message will appear. Click OK.
   

This will permanently remove both the Subject and Message text, effectively disabling the Task Notification email for that step.

Messages

Setup Task Information, Pending Messages and History Messages on the Messages tab. If you created your workflow using the Workflow Design Wizard, the Messages are preset for you. You can further customize them by entering the static text and/or templatized fields from your form. Click the down arrow or type an opening curly brace /{ and the first few letters of your control name to show a list of templatized fields from your workflow, workflow/special templates provided by  and Task Templates that you can use in the messages.

Task Information

When a user saves a partially filled workflow to continue it later or is assigned a step of a workflow, the task is accessed via the task list. Task Information controls the text that gets displayed in the user's task list. For more details, see the Using the Task List. This information gives the user(s) more details about the task that is waiting on their Task List. It also helps you to quickly find a particular task if you have a lot of tasks on your Task List.

This field can use templatized strings for dynamic content, e.g. the Task Info can contain "Vacation Request for {FirstName} {LastName}" where FirstName and LastName are the names of fields in a form from a prior step in the workflow. Before putting the task on a user's task list,  will resolve the Task Info string using the actual values of the FirstName and LastName fields e.g. "Vacation Request for Tom Smith".  will truncate the Task Info data to 250 characters.

You access your Task List from your projects home page or from a  portal. You use the Task list to perform tasks assigned to you, to view a task's history, or search for tasks you've participated in — a tenant admin can also search for other users' tasks.

If the Task Information is the same for all the steps of your workflow, you can set it up on the workflow level. If you want the Task Info to show something different on a workflow step, select the step, select the Messages tab and customize the Task Information message. The Task Information on individual workflow steps overrides the default Task Info for the workflow for this step only.

Pending Message

Use this property to display different customized messages for each step of your workflow. Pending messages can be setup at the workflow or workflow step level. Workflow step settings override the default workflow level setting so that you can display different messages to the users submitting each step of the workflow. Templates can be used in the messages to provide dynamic content. The Pending Message is best explained with an example.

History Message

You can use the History Message property to configure the information that appears in the audit trail for each step. Type a message e.g. {EFullName} requested leave starting {StartDate} for {NumberOfDays} days in the History Message field.  At runtime, will resolve this message using the data from the form and save it in the audit trail. The names in the {} must exactly match the names of the respective controls.

Use the Save on Navigation feature and the history message to log a new submission entry in the Audit Trail every time the workflow navigates to a new step, even if the current user has permissions required to immediately execute that step.

Configure a History Message on the step before the task to be performed by the anonymous user, if you want to see relevant information in the audit trail. The History Message can be templatized so you can see the email address of the recipient.

Rejection

Use the Rejection tab to:

• Specify if a user can reject a step in a workflow or if the step can be rejected to by other users or both.
• Customize the Reject button label on workflow steps that are configured to show one.
• Customize the Subject and Message for the email users receive when a task is rejected.

1. Click on any step to display the Step Properties Wizard and then select the Rejection tab.
2. Check Reject to Here if the workflow may be rejected/reset TO this step.
3. Check Reject from Here if the workflow may be rejected/reset FROM this step.
4. If Reject from Here is checked, fields to customize the rejection email will be enabled.

Click  Save to save your changes and continue working.

Rejecting a Workflow

There are three types of rejection scenarios for workflows:

• Reject to Revise - The form is sent back to a prior workflow step for correction/more information. The Reject to Revise (Easy Reject) feature is described below and is built into .
• Submit as Disapproved - When a user disapproves the request from an Approval control, the workflow skips all subsequent steps and completes. A submission is saved into the Submission Repository. You may want to implement some custom business rules that run when the "disapprove" option is selected, such as display a message to communicate the status to 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 Workflow 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 workflow steps are skipped and the form is not saved in the Submission Repository. The Abort feature is built into .

Reject to Revise (Easy Reject)

Steps in a workflow that are routed to different non-admin users other than the person originally performing the step can be rejected (sent back) to a previous step by clicking on the Reject button. The designer can specify which steps display a Reject button and the steps the reject button can reset to. To take full advantage of this feature, make sure email is selected as the notification method for participating users. On Premise customers should also make sure email is correctly configured. When a task is rejected, the user to whom it is sent back receives an email informing them of the reason for the rejection. The subject and message of the email contain default content which can be customized. The History Message is set to the specified reason provided by the person rejecting the task.

Users designated as workflow admins can reject a task using the Reject button (if configured) or the Modify Task icon to reject workflow steps.

Configure the Reject button

To configure the Reject button on an step of a workflow, follow these steps:

1. Click on the step in your workflow where you want to configure the Rejection feature and select the Rejection tab.
2. The Reject to Here checkbox is checked by default. Leave it checked if the workflow can be rejected/reset to this step. Check Reject to Here if the workflow may be rejected/reset TO this step. This
3. The Reject From Here checkbox is checked by default. Leave it checked if the workflow can be rejected/reset from this step.

4. If Reject from Here is checked, you can customize the Reject button label and the Rejection email. You can use a template to set dynamic text using controls in your workflow.

   Clicking on the down arrow shows a list of templatized fields from your workflow, workflow/special templates provided by  and Task Templates that you can use in the rejection email Subject and Message. Type the opening curly brace - {- followed by the control name to enter a field from your workflow as a template. Selecting an option enters the control name into the field with the closing curly brace

5. Repeat these steps for each step of your workflow. Click  Save to save your changes and continue working.
   

Configuring a Reject button on the first step of a workflow or for the steps in a multipage form/screenflow (steps fill out by the same user) serves no purpose. It is possible to reject to a step with a precondition, provided that step was executed and the precondition still holds.

When a user clicks the reject button, an embedded rejection page replaces the task form on the right side of the task list. This will happen on a desktop or mobile devices. To reject a task, the user selects the user/step that they want to send the workflow back to from the To dropdown. and provides a reason for the rejection. Note the list contains prior workflow steps and the first and last names of the users who performed them. 

If a task is accessed from an email that uses the task.perform.url, the user will be taken directly to the task. If the task is then rejected on the desktop, the display rejection popup displays instead of the embedded rejection page.

Configuring Reject for Steps performed by Anonymous Users

Tasks assigned to an Email Address can be rejected from and rejected to, just like any step is the workflow performed by a logged in user.

Let's say you have a Purchase Order workflow where the PO is sent to the customer for signature. The designer can configure a Reject button on this step (anonymous) so that the customer can send the PO back to the sender for corrections before signing.

Subsequent workflow steps can be configured to Reject the task back to the customer, if necessary.

Configuring Reject for Screenflows

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.

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

Here is the default rejection subject and message. Notice the use of built-in templates to pull the following information into the email:

Subject: You have a new task for {flow.name}
Message: <p>This workflow was rejected back to you for further action.</p><p>The workflow was rejected by {subject.first.name} {subject.last.name} at step: {flow.activity.name}. The reason was: {flow.activity.reject.reason}.</p><p>You can access this task at <a href="{task.perform.url}">this link.</a></p>

In-house customers can modify the default subject and message values by changing the text in the  frevvo-config.properties 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.

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.

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.

Escalations

Use the Escalations tab to set up the following on a workflow step:

• The workflow condition that needs to be met for escalations to take effect
• The time interval/due date for a task to be performed or completed
• Specify an action when the deadline is missed - Reassign to a different user or role, Notification that the task has been escalated or the ability to skip the step and navigate the workflow to the next step.
• The number of email reminders and the interval to send them before the task deadline.

1. Click on the step in your workflow where you want to configure the Escalation feature and select the Escalations tab.
2. A short explanation of existing Escalations displays. Click the arrow to edit or review.
3. Click the ADD ESCALATION button to add one.
4. Click the Delete icon to remove an escalation.

Setup Escalations

You can define customized Escalation(s) for each step in your workflow (including Email steps), provided each step is performed by a different user. 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 notify only, reassign the task or skip the task. You can also set up Notifications and/or Reminders for any of the three actions. Here are some common scenarios.

Configuring Escalations

To start, click on the step in your workflow where you want to configure the Escalation feature and select the Escalations tab. Then click ADD ESCALATION to display the Escalation Condition tab. 

Escalation Conditions

Select a condition from the dropdown. There are 4 choices:

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

  

  • 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. 
    
    
• Using Fixed Date: Enter a date/time as the deadline.
  

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

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. 
2. 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: 
   
   
   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 Perform 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.
      
   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.

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

   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.
2. Slide the toggle icon to the right to turn on Notifications
3. 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.

          Click here for an example

          When you are setting up step Assignments or Escalations for workflows, you can assign a user/role template where only part of the text is inside the curly brackets - {}. This is best explained with a simple example using roles for workflow routing.

         Let's say the roles in your organization are floor-manager, sales-manager and store-manager. Of course, these role names and users assigned these roles must exist in your tenant. Your form has a dropdown control named roles with these options: floor, sales, store. Users select the first part of the role from the dropdown. The suffix -manager is typed in after the role template in the Assignment tab to create the complex template - (floor-manager, sales-manager, store-manager). The workflow step with the complex template assigned will navigate to the appropriate role.

         A partial match template lookup is available on the Assignment and Escalations tabs to select the complex template from dropdown options.

         We will assign the {role}-manager on the Assignment tab of a workflow as an example:
         

         1. Type the control name of the template surrounded by curly brackets - in our example - {role}

             

         2. Type the dash - followed by manager. The {role}-manager appears in the dropdown

         3. Click on it to select. Click Finish to save the changes to the Assignment tab then click the save and exit to save the changes to the workflow.

         4. Test the workflow. Select floor in the role dropdown. The assigned workflow step will navigate to all the users in your tenant with the role of floor-manager.

         

         The partial lookup works with users/roles and prefixes/suffixes in the users/role names.

   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 to 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}.
      

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.
2. You can limit the number of reminders by sliding the toggle 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.
3. Specify an email(s), user(s), or role(s) to receive a CC: of the notification (optional.)
4. 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 to show the templates or type ahead to filter the list. Select them from the Control dropdown.

Escalations and Screenflows

In the case of screenflows, escalations should always be defined on the first step of a task.

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

Escalation Examples

 Click 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:

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:

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.

Quick Approval

Use the Quick Approval tab to configure the Quick Approval feature on workflow steps. Quick Approval provides the ability for a user to see a simple view of a task in order to Approve or Reject it. A comment and/or signature can be added to the task without viewing the entire form. Quick View makes the process of task review/approval/rejection easy especially on mobile devices. Click any step to open the Step Properties Wizard, then select the Quick Approval tab.

Approval Control

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

Approval controls are sections in your form that contain a textarea control. The Approval control section cannot contain any other controls in addition to the text area. The section can be named anything. It cannot be nested in a repeat or a signed section.  

Follow these steps to create an Approval control:

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.
2. Drop a Textarea control inside the section. Do NOT add any other controls to the section.
3. 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.
   

 Quick Approval will be disabled if the approval control is removed from the workflow step or additional controls are added to the Approval Control section.

If the workflow step does not contain an Approval Control, you will see this warning message when you display the Quick Approval tab.

Setup Quick Approval

Once you have added Approval Controls to the workflow steps where you want to configure Quick Approval, select the Quick Approval tab.

1. Slide the toggle to the right to turn on the Quick Approval feature.
2. Set up Task Information for the Quick Approval view in the Summary field. Click the down arrow to include control and built-in form/workflow templates in the Task List Summary. The Quick View icon  will appear on the Quick Approval view on the Task List if the step in your workflow has been setup for it. This feature is helpful if your users will be approving/rejecting steps of a workflow from a mobile device.
3. Select the Quick Approval control from the dropdown.
4. 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.

Quick Approval Example

An example of an Employee On Boarding workflow with Quick Approval configured on the Manager Approval step is provided.

Geo Location

Use the Geo Location tab to:

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

You can capture the location where your form/workflow was filled in by turning on 's Geo location feature. A form/workflow 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.

When the form/workflow loads in the browser, it will ask for the location. All browsers will show a pop up asking the user's permission to use their location, unless permission was Always granted or refused in a previous session. The user must give permission for Geo Location to proceed. Here is an example of the request in the Firefox browser:

The Geo Location feature works in conjunction with rules that use the form.positionUpdated identifier. You can set up the rule to execute every time the position is updated. See Business Rules for examples of rules that will do this. Also see Rules Position Data for the complete list of available build-in data.

You can also collect additional information associated with your location. For example, a section of a Police Incident Report, shown in the image, captures the location where the form/workflow was filled in plus the address information associated with it. The last position update will be in the submission metadata of your form or workflow but it is NOT automatically added to the XML document .  You must create controls (perhaps hidden) and rules to add the location information to the form XML document. The Position Address section of the Police Incident Report has controls and rules to show longitude, latitude, accuracy and/or errors plus the address information.

Latitude and Longitude display the coordinates of the user location. The accuracy of the location in meters is represented by the value in the Accuracy field - a low Accuracy value means the position is more precise. You can display a position error code and the text description of an error message in your form/workflow if desired. Error message codes can be 1, 2 or 3:

• 1 - Permission Denied - You will get this error code if the user says no to the access question.
• 2 - Position Unavailable - This error code means the device running the browser cannot get the GPS satellite signal (tunnel, underground).
• 3 - Timeout - The device running the browser times out trying to get the location information.
  

You will never see coordinates and error codes in the same form. You get one or the other.

Configuring Geo Location

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 workflow 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, the rule would fire every 10 seconds. 

Displaying a Google Map in your Workflow Step

Add a Message Control where you want the map to display in your workflow step. Type f-map-div in the css class field on the Message Control Properties panel. This is a built in java script that cannot be edited to display the map.

The map will only display at runtime. You will not see it in the Workflow Designer.