Difference between revisions of "Macros"
From AgileApps Support Wiki
imported>Aeric |
Wikieditor (talk | contribs) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>'''[[File:GearIcon.png]] > Case Automation > Macros'''<br> | <noinclude>'''[[File:GearIcon.png]] > Case Automation > Macros'''<br> | ||
'''[[File:GearIcon.png]] > Objects > {object} > Macros''' | '''[[File:GearIcon.png]] > Objects > {object} > Macros''' | ||
__TOC__ | __TOC__</noinclude> | ||
</noinclude> | ==About Macros== | ||
== | Macros appear in the list of actions that are available when working with a record. They can be set up to appear only when certain conditions are met, and they can perform one or more actions. Here, you see one of the default macros that comes with the system--one that marks a Case as Resolved and sends a note of appreciation for the report: | ||
Macros appear in the list of actions that are available when working with a record. | :[[File:CaseMacro_plain.png]] | ||
:[[File: | |||
{{Note| Macros also appear on the record list view under ''Action'' in the AgileApps new user interface.}} | |||
:[[File:Macros NewUI.png]] | |||
===Using Macros for Testing=== | |||
Macros can also be used for testing. For example, you can use a macro to: | Macros can also be used for testing. For example, you can use a macro to: | ||
:* Send an email, to test a template | :* Send an email, to test a template | ||
| Line 14: | Line 16: | ||
:* Invoke a method, to test code | :* Invoke a method, to test code | ||
==Working with Macros== | |||
# Go to '''[[File:GearIcon.png]] > Case Automation > Macros''' | # Go to '''[[File:GearIcon.png]] > Case Automation > Macros''' | ||
| Line 27: | Line 29: | ||
# To edit a macro, click either the macro name or the gear icon. | # To edit a macro, click either the macro name or the gear icon. | ||
#: [[File:CaseMacroEdit.png]] | #: [[File:CaseMacroEdit.png]] | ||
# You can also click items in the icon list to change the order of the macro in the list, delete it, or clone it.<br>(Hovering over the icons shows you which is which.) | # You can also click items in the icon list to change the order of the macro in the list, delete it, or clone it.<br>(Hovering over the icons shows you which is which.) | ||
#: | #: | ||
# When you're done, click '''[Save]'''. | # When you're done, click '''[Save]'''. | ||
#: The macro now appears in the [[Record#Record Actions List|Record Actions List]] when the specified conditions are satisfied. | #: The macro now appears in the [[Record#Record Actions List|Record Actions List]] when the specified conditions are satisfied. | ||
===Visibility Criteria=== | |||
Visibility criteria determines when the macro can be seen and selected. | |||
<blockquote> | |||
:{{:Common:LogicalCriteria}} | |||
</blockquote> | |||
===Actions=== | |||
The two actions defined for this macro are to set the Case status, and to send an email: | |||
: [[File:CaseMacroSettings.png]] | |||
When you choose the email option, you are prompted to select specify the template to use, and who to send it to. (In this example, the message is sent to the '''From Address''' -- the address of the person who reported the case.) | |||
<noinclude> | <noinclude> | ||
| Line 44: | Line 50: | ||
[[Category:Case Management]] | [[Category:Case Management]] | ||
[[Category:Object Aspects]] | [[Category:Object Aspects]] | ||
[[Category:Design]] | |||
</noinclude> | </noinclude> | ||
Latest revision as of 06:25, 29 July 2022
> Case Automation > Macros
> Objects > {object} > Macros
About Macros
Macros appear in the list of actions that are available when working with a record. They can be set up to appear only when certain conditions are met, and they can perform one or more actions. Here, you see one of the default macros that comes with the system--one that marks a Case as Resolved and sends a note of appreciation for the report:
Note: Macros also appear on the record list view under Action in the AgileApps new user interface.
Using Macros for Testing
Macros can also be used for testing. For example, you can use a macro to:
- Send an email, to test a template
- Execute a rule set, to test conditions
- Start a process, to test an execution path
- Invoke a method, to test code
Working with Macros
- Go to
> Case Automation > Macros
- A list of existing macros appears, showing the actions that are taken when each macro is selected.
- To enable or disable a macro, click the button that appears next to it:
- To create a macro, click [New Macro].
- To edit a macro, click either the macro name or the gear icon.
- You can also click items in the icon list to change the order of the macro in the list, delete it, or clone it.
(Hovering over the icons shows you which is which.) - When you're done, click [Save].
- The macro now appears in the Record Actions List when the specified conditions are satisfied.
Visibility Criteria
Visibility criteria determines when the macro can be seen and selected.
Unconditionally (Always)
- Use this option for actions that should occur whenever the Rule is invoked.
(This option is not present for Scheduled Rules.)When Specified Conditions are True
- Use this option to specify a series of conditions that determine whether the Rule's actions are carried out.
- All of the Conditions are met - Every condition in this category must be satisfied
- Any of the Conditions are met - At least one of the conditions in this category must be satisfied.
- For example, here are tests for a variety of conditions, to show the kinds of possibilities that exist:
- Learn more: Defining Conditions
When Specified Expression is True
- More complex conditions can be specified using the Formula Builder. For example, here is an expression that checks for either P1 or P2 priority on a new case:
- Expressions also allow the use of the platform's built-in Formula Functions. For example, this expression returns true only of a specific field has changed, and if had some specific value before it changed:
- AND( ISCHANGED('some_field'),
- IF(PRIORVALUE(some_field) == 'some_value', true, false) )
- Learn more:
- ISCHANGED function
- PRIORVALUE function
Actions
The two actions defined for this macro are to set the Case status, and to send an email:
When you choose the email option, you are prompted to select specify the template to use, and who to send it to. (In this example, the message is sent to the From Address -- the address of the person who reported the case.)