Action Sequences

Action sequences are sets of actions configured at the page level, instead of being associated with a single, specific trigger area. These sequences can be activated by the Run action sequence action, events, or hotkeys.

Working with action sequences

Create a new action sequence

  1. From the Elements pane on the left side of the Composer, click action-sequences Action Sequences.
  2. Click add Add Action Sequence to create a new sequence.
  3. Add a Sequence name and Description to identify the sequence.
  4. Add the desired actions.

Note

As your library of action sequences grows, a descriptive name and useful identification of the sequence’s purpose will help you locate the sequence you require.

Edit an action sequence

Edit an action sequence from the action-sequences Action Sequences pane. Click the sequence name, and then add, delete, or move actions.

Warning

Once changes are made to an action sequence, those changes become part of that sequence wherever it is used.

Clone an action sequence

To make a copy of an action sequence, select its name in the action-sequences Action Sequences pane, and click copy Clone. Rename the sequence and edit the actions.

Break down an action sequence instance for editing

If you invoke an action sequence using the Action Framework, but realize you don’t need all the actions in the sequence, the sequence can be broken down into its constituent actions—effectively serving as a template for individual action scripts.

  1. Navigate to the element in the canvas containing the Run action sequence action invoking the action sequence.
  2. Click the dots-vertical More actions menu.
  3. Click Break up into individual actions.

This converts this instance of the sequence into a script of individual actions, while the original action sequence remains intact. Edit these individual actions as needed.

Actions

When a sequence is created, the Actions tab is highlighted. The sequence’s properties can be updated, and actions can be added, edited, and delete.

Standard actions are available.

Properties

  • Sequence name: The identifying label of the action sequence.
  • Description: An extended description of the purpose of the sequence.

Events

By configuring a sequence’s initiating events in the Events tab, action sequences that will execute when their particular event is published.

Default Published Events

  • Skuid Page: Rendered: Published when a Skuid page has finished rendering. Can be used for page load actions that should occur whenever end users visit the page.
  • Network: Connected: Published when the end user establishes or reestablishes connection to the internet.
  • Network: Disconnected: Published when when the end user loses connection to the internet.

Interacting with other contexts

By using the Publish event action, it’s possible to communicate between Skuid pages.

You can also use this action type to publish standard Lightning Experience events and communicate with custom Lightning components.

Properties

  • Event name: The name of the event to listen for
  • Listen for events published from: Determines how “far” from the Skuid page this event subscription should listen for events
    • All active pages and Lightning Components
    • All active pages
    • Only this page (default)
  • Event channel: Sets the channel—another event property to further narrow scope—where Skuid listens for events. If an identically named event is published on a channel other than the one specified in this property, that event is ignored.

Inputs

Inputs allow each instance of an action sequence to have different values. Each time the action sequence is called, the various inputs can be set.

Note

Input value can only be set through the Run action sequence action or specified as event parameters. Inputs are not avaiable to sequences triggered by hotkeys because there is no method to clarify their value.

To add inputs to an action sequence:

  1. Click the action-sequences Action Sequences pane.
  2. Click the action sequence.
  3. Click the Inputs tab in the Properties pane.
  4. Click add Add Input.

To use the value of an input within the action sequence—for example, to use a Value-type input within a Model Condition-type input—use the name of your input, namespaced within the $Input merge variable, in merge syntax.

For example:

{{$Input.TheInputToUse}}

Note

Ensure that $Input is capitalized.

Whenever the action sequence is called within another action script, the various inputs will appear.

Note

To see an example of inputs in action, see the Inputs How-To: Activate and Set a Condition and Requery Model topic.

Properties

  • Name: The name that Skuid displays as an input property on the action sequence wherever it is called. Multi-word names may be used.

    Warning

    • Periods are not supported in input names.
    • Whenever possible, do not change input names after their action sequence is used in a page. If you change the names of your inputs, you may need to set them again within each action or dependent input in the action sequence, as well as any individual action sequence instance.
  • Type: Determines where the input property can be used within various action types.

    • Value: For use within any arbitrary value properties.
    • Model: For use within any model properties.
    • Model field: (Requires a Model type input) For use within any model field properties.
    • Model condition: (Requires a Model type input) For use within any model condition properties.

Hotkeys

Hotkeys, sometimes called shortcut keys, are predefined combinations of keys that activate a series of actions. A sequence’s initiating hotkeys can be configured in the Hotkeys tab.

Properties

  • Modifiers (optional): The key or keys to be pressed in combination with a standard key, to execute a specified action or set of actions. Though modifier keys are optional, it is best practice to pair a modifier with a standard key to avoid accidental activation of a sequence. Modifer keys include:
  • Alt
  • Control
  • Command
  • Shift
  • Key: The standard key that is paired with the modifier to start the action sequence. Standard keys include:
    • Letters A-Z
    • Any arrow key
    • Any function key (F1-F12)
    • Backspace/Delete
    • Delete Right
    • End
    • Home
    • Page Down/Up
    • Tab
  • Ignore hotkey if end user is typing in input element: If checked, the action sequence will not activate if the user’s cursor is within an input field, such as a Table or search form. This ensures the action sequence is not triggered accidentally and prevents a hotkey from potentially overriding a system-level hotkey combination, like copy/paste or arrow keys.