1. Home
  2. Knowledge Base
  3. General Functions and Features
  4. Custom Actions List and Edit Views

Custom Actions List and Edit Views

Actions can be used to automate processes, to add a layer of control, or to provide additional information.

Actions can be created for:

  • Transactions: The action is written for a specific transaction.
  • Services: The action is written for a specific service type.
  • Custom Reports: The action is written for a specific custom report.
  • Global: These actions are not linked to specific modules but rather add specific functions to QuickEasy BOS such as generating commission invoices or printing point-of-sale receipts. These actions must be added to a menu and are executed by selecting the menu item.

How Actions Work

  • Actions consist of an ordered list of items that are executed in sequence. 
  • Each item contains SQL that is run on the database and optionally returns a note. 
  • If a note is returned, it is displayed as a message to users. 
  • The input variables that can be used in the SQL are determined by the module the Action is linked to. 
  • Multiple items, including duplicate items (e.g. multiple error messages) can be linked to an Action. 
  • User Access must be assigned to each Action.
  • Actions use a fixed Status list and only those with an Active status are executed.
    • 0-Pending
    • 1-Active
    • 3-Cancelled
  • Different Execute options are available as follows:
    • Transactions / Service Types
      • Actions (Single): Can be executed from the applicable Edit View > Actions (button).
      • Actions (Multi-selected): Can be executed from the applicable
        • List View > Actions (button)
        • Edit View > Actions (button)
    • Custom Reports
      • Actions (Single): Can be executed from the applicable context menu.
      • Actions (Multi-selected): Can be executed from Edit View > Actions (button).

List View

Buttons Explained

Button

Description

View

Displays a list of actions.

Arrow on View (button)

Reset Data Filter: Resets all the data filters.

New

Creates a new action of the selected Type.

The Type cannot be changed afterwards.

Actions

Import (.sql): Used to import a script.

Menu

Filters Explained

Filter

Description

Type

A dropdown list of Action Types to select one.

Status checkboxes

Option to filter the results by certain statuses. If none of the blocks are checked, all the entries are displayed.

Fields Explained

Field

Description

Field Chooser (*)

Used to add or remove columns.

ID

The system-generated number for the entry.

Status

The entry’s status.

Type

The type of action.

Module

The module for which the action was created.

Description

The action’s description.

Execute

The action’s execution method.

Created

The date on which the action was created.

Updated

The date on which the action was last updated.

Updated By

The user who last updated the action.

A submenu with the following options:

  • Edit User Access: Sets user access for the action.

  • Export (.sql): Exports the script for import into another database.

  • Copy: Copies the action.

  • Edit: Opens the edit interface.

  • Delete: Deletes the action.

Edit View

Buttons Explained

Button

Description

Arrows

Used to navigate between action types.

Edit

Allows the content to be edited.

New

Creates a new action of the type selected from the dropdown list.

Save

Saves any changes.

Actions

  • View/Edit Note

  • Export (.sql)

  • Import (.sql)

  • Copy

  • Delete

Menu

Settings

  • Edit User Access

Fields Explained

Field

Description

Status

A dropdown list of statuses to select one.

Status Note

A space to enter an optional status note.

No.

The auto-generated action number.

Type

The type of action as selected when the action was created.

Transaction / Service / Report

A dropdown list to select a transaction, service type, or custom report depending on the type.

Execute

Depends on the Type. Generally an option to select:

  • Actions (Single): Executed once from Edit View.

  • Actions (Multi-selected): Executed from List View on all the selected items.

Caption

The caption on the menu.

Note

A block to enter a note.

Item (button)

Adds another item that must be executed.

ID

The system-generated number for the item.

Order ID

The system-generated number for the item’s order on the list.

Type

Option to select:

  • Error: If a note is returned by the SQL query, it is displayed as an error message the process is terminated.

  • Warning: If a note is returned by the SQL query it is displayed as a warning message and the user can click OK (button) to continue of Cancel (button) to exit the process.

  • Confirm: If a note is returned by the SQL query it is displayed as confirmation message and the user can click OK (button) to continue or Cancel (button) to exit the process.

  • Execute SQL: Executes a SQL query.

Description

A field to describe the item.

File Extension

A dropdown list of file extensions. These extensions are used for import and export purposes.

SQL

Checkbox that is checked if SQL is added.

Created

The date on which the item was created.

Updated

The date on which the item was last updated.

Updated By

The user who last updated the item.

A submenu with the following options:

  • View/Edit Note

  • View/Edit SQL

  • Copy Item Ctrl+C

  • Delete Item Ctrl+Del

  • Move Up Ctrl+U

  • Move Down Ctrl+D

SQL Input Parameters

  • The Template button in the SQL editor can be used to generate sample SQL to show how parameters can be used.
    • Note: A Procedures tab was added to the SQL Editor – right-click to generate the Call… SQL.
  • Global
    • user_id: the active user_id is assigned.
  • Transaction 
    • trans_header_ids: a comma separated list of the selected ids (e.g. 1,2,34 OR 1).
    • user_id: the active user_id is assigned.
  • Service
    • project_ids: a comma separated list of the selected ids (e.g. 1,2,34 OR 1).
    • user_id: the active user_id is assigned
  • Custom Reports
    • pk_ids: the primary key/s is assigned (first column of the report)
    • user_id: the active user_id is assigned

Learn More

  1. Custom Actions Tutorials: These tutorials explain how to create and apply custom actions.

Need Support?

Can't find the answer you're looking for?
Contact Support