Custom Form Actions

> 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.)

File:RecordActions-Single.png

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.

File:RecordActions-Multiple.png

Learn More

• Manage Related Information

Working with Actions

Add an Action

To add an action:

1. Click the Add Action button
2. Fill in the Action settings
3. Click [Save]

Edit an Action

To edit an action:

1. Click the title of the action
2. Click the [Edit] button
3. Modify the Action settings.
4. Click [Save]

Delete an Action

To delete an action:

1. Click the title of the action
2. 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 the text area to get available Template Variables

Packaging Options Section

Choose whether or not allow an installer to disable the action.

Available 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

Requires Record Selection during Group Operation

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 not checked, the Group Action can execute when no records are selected

Using Template Variables

Template Variables for Actions and Components