Home Custom Actions Custom Actions Reference
Custom Actions
Custom Actions Reference
Actions can be used in the following modules: Actions can also be Unlinked, in which case they can be added directly to the Menu. Actions use items to implement the functionality explained under Item Types Explained and in the sub-topics of this section. Note# If multiple transactions are actioned, ONLY the error messages are checked before completing the Action. The Action starts with a standard confirmation message (similar to Batch Updates ) and ends with an Information message that displays the number of records updated and a log of error messages for the records not updated. Running Actions# An Action appears on the Actions menu of the module it is linked to, under its Caption. If the Action has a Button Caption, it also appears as a button with that caption on the module. Users only see the Actions that are selected for them in the user setting General > Actions – Access Allowed. Settings# Note The defaults are the values for new databases, new users and new Transaction Types. Your database may have different values.
Setting Description Default General > Actions – Access Allowed Opens a list for you to select the Actions the user can run. Not applicable Setups > Actions Setup – Access Allowed Checkbox. If checked, you can set up Actions. Unchecked
Actions Setup# Button Description Edit Lets you edit the selected Action. Save Saves your changes. New Creates an Action. Copy Copies the selected Action. Menu Opens a menu with these options:Delete Action: Deletes the selected Action.Save Grid: Saves your grid layout.Restore Grid: Restores your saved grid layout.Import: Imports an Action from a file.Export: Exports the selected Action to a file.View/Edit User Access: Shows and edits which users can run the Action.
Fields Explained# Field Description Module The module the Action is linked to, or Not linked (the Action can then be added directly to the Menu). Description The description of the Action. Caption The name of the Action on the module's Actions menu. Button Caption If filled in, the Action also appears as a button with this caption on the module. Updated Read-only. When the Action was last updated.
Items Explained# Info Click Add (button) to add an item to the Action. The items run in the order of the list.
Field Description Type The type of item (see Item Types Explained below). Description A description for reference purposes. Note A note about the item. Menu Click the button or right-click an action item for these options:Move Up: Moves the item one line up.Move Down: Moves the item one line down.Delete Item: Deletes the item.Edit SQL: Opens the SQL Editor for the item.Copy Item: Copies the item.Edit Note: Opens the note of the item.
Item Types Explained# Type Description SQL Update Runs SQL that updates the data. See Actions - SQL Update . Message - Error, Message - Confirmation, Message - Information, Message - Warning Generates a message. See Actions - Messages . Open Transaction Opens the transaction that the SQL returns (TRANSID). Not available for Production Planning. Open Report Opens the report that the SQL returns (REPORTID), with an optional caption added to the report name. Not available for Production Planning. Create New Record Creates a record in Customers, Suppliers, Classes, Transactions or Workflow. See Actions - Create New Record . Not available for Production Planning. Copy Rule Implements a Transaction Copy Rule . The Copy Rules of the linked Transaction Type appear in the list.
Open Transaction Template# select
max(L.TRANSID) as TRANSID
from LEDGER L
where L.ENTRYTYPEID = ??Open Report Template# /* REPORTID: This is the ID of the Report that will be opened
CAPTION: This is suffixed to the Report name - eg. '' - '' ||:COMPANY
All the Variables required by the Report that will be opened need to be included.*/
select
1 as REPORTID,
'' as CAPTION
from RDB$DATABASE
Learn More