AgileApps Support Wiki

Difference between revisions of "Custom Form Actions"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Designer > Data > Objects > {object} > Actions'''
'''[[File:GearIcon.png]] > Objects > {object} > Custom Form Actions


Custom actions can be created and invoked when displaying data records.
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 execute any of the following:
An Action can invoke either:  
* A [[Components|component]] which is an element written in HTML and JavaScript
:* 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
 
The action can run against a single record, multiple records (via [[More Actions]]), or both single and multiple records.
 
===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===
''Compare to:''
:* [[Workflows#About States, Actions, and Decision Boxes|Actions in Workflows]]
:* [[Manage Related Information]]


==Working with Actions==
==Working with Actions==


=== Add an Action ===
=== Add an Action ===
Follow these steps to add an action:
To add an action:
# Click '''Designer > Data > Objects > {object name} > Actions'''
# Click the '''Add Action''' button
# Click the '''Add Action''' button
# Fill in the Action settings
# Fill in the Action settings
Line 34: Line 17:


=== Edit an Action ===
=== Edit an Action ===
Follow these steps to edit an action:
To edit an action:
# Click '''Designer > Data > Objects > {object name} > Actions'''
# Click the title of the action
# Click the title of the action
# Click the '''[Edit]''' button
# Click the '''[Edit]''' button
Line 42: Line 24:


=== Delete an Action ===
=== Delete an Action ===
Follow these steps to delete an action:
To delete an action:
# Click '''Designer > Data > Objects > {object name} > Actions'''
# Click the title of the action
# Click the title of the action
# Click the '''[Delete]''' button
# Click the '''[Delete]''' button
Line 50: Line 31:


===Action Information section===
===Action Information section===
#Provide basic information:
:;Name:Unique name for the action
#;Name:Unique name for the action
::Use alphanumeric characters and underscores
#:Use alphanumeric characters and underscores
:;Title:Field display label
#;Title:Field display label
:;Type:Select the type of action:
#;Type:Select the type of action:
::* Invoke Page
#:* Invoke Component
:::* Select the page from the list
#:* Invoke Page
::* Execute JavaScript (single-record action only)
#:* Execute JavaScript (single-record action only)
:'''Invocation Point:'''
#If ''Invoke Page'' or ''Invoke Component'' was selected, select it from the list
::* '''Single Record:''' The action works on a single record  
#Select the invocation point:
<!--
#* '''Single Record:''' The action works on a single record  
::* '''Group Action:''' The action works on a group of records selected in a [[View]]
#* '''Group Action:''' The action works on a group of records selected in a [[View]]
::* '''Both:''' The action works on both single records and groups of records
#* '''Both:''' The action can works on both single records and groups of records
::: ''Note:'' The Group Action and Both options are not present if the action type is Execute JavaScript.
#:: ''Note:'' The Group Action and Both options are not present if the action type is Execute JavaScript.
-->
#Optionally, unclick the ''Enabled'' checkbox to disable the action
:'''Enabled -''' Uncheck this box to disable the action.
#Optionally, click the [[#About Requires Record Selection during Group Operation|Requires Record Selection during Group Operation]] checkbox (this option appears only when ''Group Action'' is selected as the invocation point)
<!--:[[#About Requires Record Selection during Group Operation|Requires Record Selection during Group Operation]] checkbox
# If ''Execute JavaScript'' was selected, enter the JavaScript
::This option appears only when ''Group Action'' is selected as the invocation point)
#:'''Tip:''' Use the [[Template Variable Tool]] to get available [[#Template Variables|Template Variables]]
-->
: '''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]]
<!--


===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 Roles section===
-->
Select the user [[Roles]] which can execute the action. The action only appears for users in those roles.
===Available to Roles section===
 
Select the user [[Roles]] which can execute the action. The action button appears only for users in those roles.
<!--
====Considerations====
====Considerations====
 
:*If [[Template Variable]]s are used in the JavaScript code:
:*If [[#Template Variable|Template Variable]]s are used in the Component and JavaScript code:
::*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
:*Warning Messages:
::*If the Action type is ''Invoke Component'', this warning message is displayed when the invocation point is selected as Group Action, or Both:
:::''WARNING! Template variables used in component other than User category will not be replaced by its corresponding values if Invocation Point is Group Action/Both''


====Requires Record Selection during Group Operation====
====Requires Record Selection during Group Operation====
Line 90: Line 71:
:*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==
{{:Template Variables for Actions and Components}}
<noinclude>
<noinclude>


[[Category:Objects| 4]]
[[Category:Object Aspects]]
[[Category:{{features}}]]
[[Category:Glossary]]
</noinclude>
</noinclude>

Latest revision as of 06:35, 28 August 2018

GearIcon.png > 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:

  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.

Notepad.png

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.

Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Custom_Form_Actions&oldid=4757"