Custom Actions
Custom Actions let you add your own buttons, backed by JavaScript code, to AdmCloud screens. Unlike a Client Script (which runs automatically when the screen opens), a Custom Action only runs when the user clicks the button, which makes it ideal for on-demand actions such as calling an external system, calculating or filling in information on request, or triggering any other behavior AdmCloud does not offer natively.
What is it and what is it for?
A Custom Action is a button you add to a given screen (a transaction, a card, or a Custom Record) so it runs the JavaScript code you write. When you create it, you specify:
- The Object (the system screen) where the button should appear — for example an invoice, an item, or any other card or transaction — or, if you create it from a Custom Record, it's automatically linked to that record type instead.
- The Mode: whether the button should appear while that screen is in Add, Edit or View mode.
- The button's Caption and the JavaScript code that runs when it is clicked, using the same JavaScript API AdmCloud exposes for Client Scripts.
This feature is meant for businesses that need a button with very specific behavior that AdmCloud does not offer natively, and that have someone (in-house or a Partner) able to write JavaScript.
How to use it
- Open the Custom Actions list. You'll see every existing action with its caption, the object (screen) it applies to, its owner and whether it's flagged as protected.
- Click "New". If you're creating the action from a Custom Record's detail screen, the Object field is hidden because the action is automatically tied to that record type.
- Pick the Object (the system screen) where you want the button to show up, and the Mode: Add, Edit or View.
- Type the Caption that will show on the button, and the JavaScript code that will run every time a user clicks it.
- Set the action's Owner, and whether it should be Protected (so only the owner can edit or delete it).
- Save. AdmCloud validates the information (see below) and, if everything checks out, the button appears immediately on the chosen screen, in the mode you picked — as long as the code isn't empty.
- Review, edit or delete an existing action from its detail screen. If you're the owner and your plan allows it, you can also transfer it to another company of the same Partner.
Poorly written code can affect the screen the button is added to. AdmCloud does not validate your code's syntax on save (the editor only highlights JavaScript syntax); a bug can keep the button from working or affect the rest of the form for everyone who sees it. Test it before considering it finished.
Key capabilities
- Your own buttons, backed by JavaScript, added to the Add, Edit and View screens of any card, transaction or Custom Record, without touching the product.
- One button per Object/Mode combination you need; you can have several buttons on the same screen.
- A "Protected" action can only be edited or deleted by its owner, useful when it was installed by a Partner or a technician.
- The button only shows up on screen when it has code saved; an action with no saved code stays registered but is not displayed.
- Transfer an action to another company of the same Partner, to reuse the same customization across several clients.
Key fields
| Field | What it's for |
|---|---|
| Object | The system screen (card or transaction) where the button will appear. It's hidden and assigned automatically when the action is created from a Custom Record. |
| Caption | The text shown on the button. Together with the Object, it must be unique: you can't repeat the same caption for the same object. |
| Mode | Determines whether the button appears on the Add, Edit or View screen of a record of that object. |
| Owner | The user responsible for the action; must be an active user. They're the one who can edit or delete it when it's flagged as Protected. |
| Protected | When checked, only the owner can modify or delete the action's structure. |
| Script | The JavaScript code that runs when the user clicks the button. |
Validations on save
- The Object must exist among the screens supported by AdmCloud, or match a valid Custom Record when the action is created from one.
- The Owner is required and must be an active user in the system.
- You can't repeat the same Caption for the same Object. AdmCloud rejects the save if another action already exists with that combination.
- A Protected action can only be edited or deleted by its owner; other users get a message saying they don't have permission.
- An action can't be deleted if it's being used inside a Plugin; unlink it from the Plugin first.
Availability and permissions
- Custom Actions are available only on the Enterprise plan, and the feature must be enabled for your account.
- Creating, viewing, editing and deleting actions requires the Customization permission on your user group.
- Transferring an action to another company also requires the permission to create Plugins.
Tips and common mistakes
Don't see your button on screen? Check that the Script field isn't empty: an action with no saved code is not shown on screen, even though it still appears in the Custom Actions list.
"You don't have permission to modify this action": shown when it's flagged as Protected and whoever is trying to edit or delete it isn't its owner. Ask the registered owner to make the change.
Can't delete the action: if the message says it's in use inside a Plugin, open that Plugin and remove the reference before trying to delete it again.
Need the same behavior to fire automatically when the screen opens, instead of on a click? Use a Client Script instead of a Custom Action.