Custom Actions List and Edit Views

Actions can be used to:

• Automate processes
• Add a layer of control
• 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 add specific functions to QuickEasy BOS, such as generating commission invoices or printing Point of Sale (PoS) 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 appears 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
• The Execute options are:
  • 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).
  • Global
    • Main Menu: Executed from the menu item the action is added to. New global actions are set to Main Menu.

List View#

Buttons Explained#

Filters Explained#

Fields Explained#

Field	Description
Field Chooser (*)	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#

Fields Explained#

Field	Description
Status	Select from a dropdown list of statuses.
Status Note	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	Depending on the type, select a Transaction Type, Service Type or custom report from the dropdown list.
Execute	Depends on the type. The options are usually: Actions (Single): Executed once from Edit View. Actions (Multi-selected): Executed from List View on all the selected items. Main Menu: Global actions only. Executed from the menu.
Caption	The caption on the menu.
Note	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	Select: Error: If the SQL query returns a note, it appears as an error message and the process stops. Warning: If the SQL query returns a note, it appears as a warning message. The user can click OK (button) to continue or Cancel (button) to exit the process. Confirm: If the SQL query returns a note, it appears as a confirmation message. The user can click OK (button) to continue or Cancel (button) to exit the process. Execute SQL: Executes a SQL query. Import SQL: Global actions only. Opens a window for you to select a file (limited to the File Extension, if one is selected) and passes the selected file’s content to the SQL as file_content. If a note is returned, it appears. Export SQL: Global and transaction actions. Runs the SQL and saves the file_content column it returns to a file named after the action’s caption (with the File Extension, if one is selected). If no data is returned, an error message appears.
Description	Enter a description of the item.
File Extension	A dropdown list of file extensions. These extensions are used for import and export purposes.
SQL	Checkbox. 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 + Delete 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: The SQL Editor has a Procedures tab: right-click it to generate the Call… SQL.

• Global
  • user_id: The active user_id is assigned.
  • file_content: The content of the imported file (Import SQL items only).

• 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 keys are assigned (first column of the report).
  • user_id: The active user_id is assigned.