Difference between revisions of "Custom Form Actions"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (11 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''[[File:GearIcon.png]] > Objects > {object} > Custom Form Actions | '''[[File:GearIcon.png]] > Objects > {object} > Custom Form Actions | ||
Custom actions are displayed | Custom actions are displayed in '''Actions''' list in the sidebar, when the user is viewing a record. | ||
__TOC__ | __TOC__ | ||
==About Actions== | ==About Actions== | ||
An Action can | An Action can invoke either: | ||
* A [[Pages|page]] which is a standard JSP (JavaServer Page) page with custom user interface elements or an independent tab | :* A [[Pages|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 | :* [[JavaScript]] that uses [[AJAX and REST]] to interact with the platform | ||
==Working with Actions== | ==Working with Actions== | ||
| Line 64: | Line 51: | ||
: '''JavaScript''' | : '''JavaScript''' | ||
:: This section appears if ''Execute JavaScript'' was selected. Use it to enter the [[JavaScript]]. | :: This section appears if ''Execute JavaScript'' was selected. Use it to enter the [[JavaScript]]. | ||
{{Note|To run the JavaScript in the LongJump UI and the legacy AgileApps UI, enter the script in the Legacy UI Script tab. To run the JavaScript in the New AgileApps UI, enter the script in the New UI Script tab.}} | |||
:: Use the [[Template Variable Tool]] that appears under it to get available [[Template Variables]] | :: Use the [[Template Variable Tool]] that appears under it to get available [[Template Variables]] | ||
<!-- | |||
===Packaging Options Section=== | ===Packaging Options Section=== | ||
Choose whether or not allow an installer to disable the action. | Choose whether or not allow an installer to disable the action. | ||
--> | --> | ||
===Available to 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. | ||
Latest revision as of 06:35, 28 August 2018
> Objects > {object} > Custom Form Actions
Custom actions are displayed in Actions list in the sidebar, when the user is viewing a record.
About Actions
An Action can invoke either:
- 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
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.
Note: To run the JavaScript in the LongJump UI and the legacy AgileApps UI, enter the script in the Legacy UI Script tab. To run the JavaScript in the New AgileApps UI, enter the script in the New UI Script tab.
- 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.