Skip to Main Content

Breadcrumb

Examples

Custom Event

You can fire custom events against a single or multiple affected elements defined in your dynamic action. The plug-in offers a simple or advanced configuration. In the custom event examples we used an advanced configuration to set a page item with the event name so we can tell which event is firing in the notifications. You could use this item value in your conditional logic as we show in the "Conditional Event Triggering" demo below.

Event Data

You can pass text or an object into the "data" object which can be accessed in your dynamic action that listens to the custom event using "this.data".

Multiple Events (Advanced)

When defining multiple events where each requires their own object data, you can use Javascript logic to pass unique values to each event e.g.


if ($v('P1040_EVENT_NAME') === 'custom-event-1') {
    return {
        "event1": '1st Event Date: ' + (new Date()).toLocaleDateString()
    };
} else if ($v('P1040_EVENT_NAME') === 'custom-event-2') {
    return {
        "event2": '2nd Event Date: ' + (new Date()).toLocaleString()
    };
}

Cancel Following Actions

This action can be used like branching logic so you can avoid actions running after triggering an event e.g. just like you can redirect to a page using page branches.

Conditional Event Triggering

You have the ability to provide a condition to determine whether you fire the event or not. These conditions allow you to use additional logic to determine if an event really needs to fire. For added flexibility, you can optionally specify an alternative event name to fire when the condition evaluates to FALSE.

This conditional logic is determined client-side in the browser at the time of execution. You have a number of built-in condition checks, the same ones that APEX provides in the actual dynamic action "Client-side Condition".

You can use the page items below to control whether the event fires or not e.g. for the checks to work please change the page item value and condition value according to the test you want to check.

Additional Conditions

In addition to regular client-side conditions we have included several additional page API checks. The following conditions can be used to control whether the following actions continue:

  • Page is Valid
  • Page is Invalid
  • Page has Changed
  • Page has not Changed

Note: these conditions are based on the Javascript API that APEX provides, so you can be safe in the knowledge that you are using something well tested and used. We also welcome user feedback as to what other conditions you would like us to include, so please let us know.

Multiple Events (Advanced Conditions)

When defining multiple events that each requires their own logic you can set a page item with the event name and use this in your "Javascript Expression" condition logic e.g.


(function() {
   if ($v('P1040_EVENT_NAME') === 'custom-event-1') {
      return check1();
   } else if ($v('P1040_EVENT_NAME') === 'custom-event-2') {
      return check2();
   }
})()

You can use the page items above to control whether the event fires or not e.g. for the checks to work "event 1" will fire when the values are equal and "event 2" will fire when the values are NOT equal.

FAQ

  • Does it matter if I use upper or lowercase for my event names?

    No it does not matter what case you use for your event names, it's a personal choice. The preferred standard though is to use lowercase and use "-" hyphens for spaces to make them easier to read. We suggest that you just stick to letters and hyphens and no other special characters. Note: if you use a "." in your event name you will be defining a namespace. Please see the following documentation for more information on event namespaces.

  • Why do you provide an "Advanced Configuration" option?

    You might think we provide too many settings for our plug-ins. In our experience we have run into many situations where hit limits with existing functionality and have to resort to writing Javascript code. We prefer the declarative nature of APEX as we don't need to support the code that APEX provides us. So when we create plug-ins we want you to have the ability to do what you need to do declaratively without having to resort to custom code. This means that you don't need to resort to writing code and can rely on us to support the plug-ins we provide, saving you valuable time.

    Of course all these settings can seem a little overwhelming to novice developers, but in most cases it is greatly appreciated by experienced developers. We do our best by providing trying to separate the functionality for novices and experienced developers by providing an "Advanced Configuration" setting.