Workflows Reference

Overview

A workflow module lists the records of one workflow, for example each case or request it tracks, and lets users move them along with actions. How each workflow looks and behaves is set in Workflow Setup.

  • The module's heading is the workflow's Code.
  • The workflow's settings decide which header fields appear: customer or supplier and contact, staff, item, Ref1 to Ref3, and the reminders.
  • Actions add items to the record (notes, appointments, files, forms and transactions) and can change its status.
  • A transaction created from a workflow has the menu option Open <workflow name>, which opens the linked workflow records.
Info

You need user access (or supervisor access) to the module: the user setting Workflows & Workspace > Workflows – User Access (Select Modules). Without it, the message "Access Denied" appears.

Navigation Example

Main Menu > Select the workflow module (under the Workflow menu items)

List View

Buttons Explained

Button Description
ViewDisplays the workflow records that match the filters.
NewCreates a record with the workflow's New Workflow status.
OutputPreviews, prints or emails the records.
MenuOpens a menu with these options:
  • Reset Data Filter: Resets the filters.
  • Save Grid: Saves your grid layout.
  • Save Grid (All Users): Saves the grid layout for all users.
  • Restore Grid: Restores your saved grid layout.

Filters Explained

Filter Description
SetSelect a date option. The options are:
  • No Date
  • User Date
  • Today
  • Yesterday
  • This week
  • Last week
  • This month
  • Last month
  • This year
  • Last year
  • Fin year
Date / toThe start and end dates. The arrows move the period back or forward.
Search for a numberEnter a record number.
Search text fieldsEnter words to find in Ref1 to Ref3.
StatusSelect All or a status.
Customer / Supplier / Staff / Product / EntityShown when the workflow uses them. Select a value to filter by.

Fields Explained

Field Description
Field Chooser (*)Add or remove columns.
No.The record number. Each workflow has its own numbering.
DateThe date the record was created.
UserThe user who created the record.
StatusThe record's status, in the status colour.
Ref 1 to Ref 3The reference fields, with the captions set for the workflow.
Customer / Supplier / Staff / Product / EntityThe linked company, staff member, item and entity.
Menu (...)Right-click a record for these options:
  • Edit: Opens the record (pressing Enter does the same).
  • Delete: Deletes the record and its reminders after you confirm ("Delete Workflow?").

Edit View

Edit View Buttons Explained

Button Description
ArrowsReturn to the list, or move to the previous or next record.
NewCreates a record.
SaveSaves the record, its items, input fields and reminders.
DeleteDeletes the record after you confirm ("Delete Workflow?").
RefreshReloads the record.
OutputPreviews, prints or emails the record.
ActionsOpens the workflow's actions (see Running an Action below). Actions from Custom Actions set up for the workflow also appear here.
MenuOpens a menu with these options:
  • View/Edit Images: Opens the record's images.
  • Edit Customer / Edit Supplier: Opens the linked company.
  • Add Customer: Creates a customer. Needs access to add customers; otherwise "Access denied." appears.
  • Add Supplier: Creates a supplier.
  • Timeline / Transactions / Notes: Switches the items section between its three views.
  • Show Preview: Shows or hides the preview rows in the Timeline and Transactions views.
  • Sort ascending: Shows the oldest items first.
  • Layout: Save Layout, Restore Layout and Restore Default Layout ("The default layout will be restored after you restart BOS Enterprise. Restart now?").

Header Fields Explained

Info

Only the fields the workflow uses are shown. The captions of Staff, Product and Ref1 to Ref3 are set per workflow.

Field Description
No.The record number.
DateThe date the record was created.
StatusThe record's status. It may be locked: see Read-Only Statuses below.
NoteA short note next to the status.
Customer / SupplierThe linked company. The button next to it opens the customer or supplier summary ("Customer has not been linked." when the field is empty).
ContactA contact of the company. It is filled in when the company has only one contact.
StaffThe linked staff member. When the workflow links reps, the customer's rep is filled in.
ProductThe linked item. The button next to it opens the item summary.
Ref1 to Ref3Reference fields. They may have a list of values.
EntityThe record's entity. Only entities linked to you can be selected: otherwise "Invalid selection. Only Entities linked to the User may be selected." appears.
UpdatedThe user who created the record and the date of the latest item.
Input fieldsThe workflow's header input fields, if any.

Reminders

  • Remind: Lists the users with access to the module. Tick a user to add a reminder for them, dated by the period next to it (Now, or after the Days, Weeks or Months you enter). Untick to remove it.
  • Set: Sets the reminder date of the selected users again and reopens their reminders.
  • The reminders list shows each user with the date and time. A reminder's text is the record's item and references.
  • The section is hidden when the workflow setting Hide Reminders is checked.

Running an Action

  1. Click Actions (button) and select an action. Greyed-out actions wait for the actions they depend on.
  2. If the action asks for a status, select it.
  3. The record is saved and the action runs (see the table below).
  4. The status changes to the action's Change Status to status, if it has one.
Type What happens
NoteA note item is added with the action's description and note, and the note editor opens.
AppointmentAn appointment item is added with your resource, today's date and a one-hour slot. Saving it creates an event in the calendar; clearing the resource or start time deletes the event.
Input FormAn item is added and its input fields open for you to fill in.
Load a File
  • Select a file. It is copied to the documents folder and added as an item.
  • The folder is set in General > Folder - Documents.
  • If the folder is not set, this message appears: "The 'Documents Folder Path' has not been set. See 'Settings > General.'".
Link a TransactionSelect the Transaction Type, enter the number (and version) and click Verify, then Add. The transaction is added as an item.
Transaction TypeA transaction of that type is created from the record, opened and added as an item.
Note
  • To create a transaction from a workflow, you need access to create that Transaction Type.
  • Without it, the message "Access denied. You are not allowed to create new Transactions. See Transactions Setup > View/Edit User Access." appears.
Message When it appears
"Please select a Transaction"No Transaction Type is selected.
"Please enter a valid Transaction No."The number is missing or invalid.
"Please enter a valid Version No."The version is missing or invalid.
"<Trans> No. <n> not found."No transaction has that number.
"<Trans> No. <n> has already been linked."The transaction is already linked to the record.

Items Section

Info

The items section shows what the actions have added. Its caption and the Timeline view's name come from the workflow setting Caption – Items (Timeline).

Timeline Fields Explained

Field Description
DescriptionThe item, for example the action's description or the file name.
UserThe user who added the item.
Date / @The date and time the item was added.
PreviewThe item's note, the file details, the input field values or the transaction's details.

Transactions Fields Explained

Field Description
TransThe Transaction Type.
No.The transaction number.
DateThe transaction date.
CompanyThe customer or supplier.
ReferenceThe transaction's reference.
TotalThe transaction total.
PreviewThe company, reference, number of items and total.

Notes Fields Explained

Field Description
NoteThe text of the Note, Appointment and Input Form items.
UserThe user and date.
Menu (...)Right-click an item for these options:
  • View in Calendar: Opens an appointment in the calendar ("Calendar has not been linked." when there is no event).
  • Open Item: Opens the item, the file or the transaction ("File not found." when the file is missing).
  • Email file: Emails a file item.
  • Update file: Updates a file item's details.
  • Delete: Deletes the item after you confirm ("Delete Item?"). Deleting an appointment also deletes its calendar event.

Read-Only Statuses

  • Each status has an Editing option in Workflow Setup: All, Status only or None.
  • With None, the record is read-only: the header fields, the items, the reminders and the workflow's actions are locked.
  • With Status only, the status can still be changed.
  • A record is also read-only for a user who is linked to entities but not to the record's entity.
  • Supervisors can change the status of a read-only record.
  • When the workflow setting Disable Status Field is checked, the status can only be changed by actions.

Report an issue with this page

For more useful feedback, select the text on the page you're reporting about, then click Feedback again — or continue without selecting anything.