Difference between revisions of "Custom Form Actions"
imported>Aeric |
imported>Aeric |
||
| Line 71: | Line 71: | ||
--> | --> | ||
===Available Roles section=== | ===Available to Roles section=== | ||
Select the user [[Roles]] which can execute the action. The action button appears only for users in those roles. | Select the user [[Roles]] which can execute the action. The action button appears only for users in those roles. | ||
| Line 79: | Line 79: | ||
::*The Template Variable '''''will not''''' be replaced if the Action is invoked from a Group Action. | ::*The Template Variable '''''will not''''' be replaced if the Action is invoked from a Group Action. | ||
::*The Template Variable '''''will''''' be replaced if the Action is invoked from a Single Record | ::*The Template Variable '''''will''''' be replaced if the Action is invoked from a Single Record | ||
<!-- | |||
====Requires Record Selection during Group Operation==== | ====Requires Record Selection during Group Operation==== | ||
The ''Requires Record Selection during Group Operation'' option defines the type of Group Action to create. | The ''Requires Record Selection during Group Operation'' option defines the type of Group Action to create. | ||
:*If checked, the Group Action requires that a record is selected in order to execute the action | :*If checked, the Group Action requires that a record is selected in order to execute the action | ||
:*If not checked, the Group Action can execute when no records are selected | :*If not checked, the Group Action can execute when no records are selected | ||
--> | |||
==Using Template Variables== | ==Using Template Variables== | ||
Revision as of 00:40, 6 June 2013
> Objects > {object} > Custom Form Actions
Custom actions are displayed as buttons the user can click when displaying data records.
About Actions
An Action can execute any of the following:
- A page which is a standard JSP (JavaServer Page) page with custom user interface elements or an independent tab
- JavaScript that uses AJAX and REST to interact with the platform
The action can run on a single record, on multiple records (via More Actions), or both.
Single Record Actions
For a single-record action, the user visits the record and then invokes one of the action button(s) in the heading bar. (The buttons they see depend on the actions that have been implemented and the user's permissions.)
Multiple Record Actions
For multiple-record actions, the user selects records in a View, and then uses the More Actions dropdown to invoke the desired action.
Learn More
Working with Actions
Add an Action
To add an action:
- Click the Add Action button
- Fill in the Action settings
- Click [Save]
Edit an Action
To edit an action:
- Click the title of the action
- Click the [Edit] button
- Modify the Action settings.
- Click [Save]
Delete an Action
To delete an action:
- Click the title of the action
- Click the [Delete] button
Action Settings
Action Information section
- Name
- Unique name for the action
- Use alphanumeric characters and underscores
- Title
- Field display label
- Type
- Select the type of action:
- Invoke Page
- Select the page from the list
- Execute JavaScript (single-record action only)
- Invocation Point:
- Single Record: The action works on a single record
- Enabled - Uncheck this box to disable the action.
- JavaScript
- This section appears if Execute JavaScript was selected. Use it to enter the JavaScript.
- Use the Template Variable Tool that appears under it to get available Template Variables
Available to Roles section
Select the user Roles which can execute the action. The action button appears only for users in those roles.
Considerations
- If Template Variables are used in the JavaScript code:
- The Template Variable will not be replaced if the Action is invoked from a Group Action.
- The Template Variable will be replaced if the Action is invoked from a Single Record