AX2718

Run Event command

Use the Run Event command to execute one or more matching Scheduler jobs. The event name is used to determine which jobs to run. This command works in a similar manner as the RunEvent function.

Can be used in

  • Axiom forms
  • Ribbon tabs
  • Task panes

When the Run Event command is selected from the Command Library as the shortcut target, it displays as command://RunEvent or command://RunEventCommandAdapter.

Shortcut parameters

This command uses the following shortcut parameters:

Item Description

Event Name

The name of the event handler that you want to trigger. Any job with an active event handler of the same name will be placed in the Scheduler queue for immediate execution (pending Scheduler thread availability and other jobs already in the queue).

Confirmation Message

Optional. A confirmation message to present to the user before scheduling the jobs for execution. The user has the choice to cancel the execution at this point. If omitted, the standard generic message is used.

NOTE: This parameter does not apply when using the command in an Axiom form. Instead, you can use the confirmation message for the Button component to display a confirmation before executing the command.

Result Message

 Optional. A confirmation message to present to the user after the jobs have been scheduled. If omitted, the standard generic message is used.

Processing Step

Specifies when the command will be executed during the form update process. This option only applies when using the command in an Axiom form.

By default, this is set to Form - After Updating Values, which means that the command will be performed on the form source file, after updated values have been submitted back to the source file.

If desired, you can specify a different processing step for the command. For more information, see Timing of command execution and Axiom form update process.

Event variables

You can define one or more optional Event Variables to impact the job execution. These variables and their values are passed to the Scheduler jobs.

To define event variables:

  • Click the plus button to add a new variable/value pair to the Event Values section.

  • In the left-hand box, type the name of the variable. For example: Filter. Do not use place the variable in curly brackets (you are not using the variable here, you are defining its value).

  • In the right-hand box, type the value to be used for this variable, or enter a cell reference in brackets to read the value from the current spreadsheet. For example: [Sheet1!A1].

    If the command is used in a form, the cell reference is read from the form source file. If the command is used in a task pane or a ribbon tab, the cell reference is read from the currently active spreadsheet. For task panes and ribbon tabs, the cell reference is only useful if you know which spreadsheet will be the currently active spreadsheet when the command is used—for example, when using an associated task pane with a particular file.

Visibility

In task panes or ribbon tabs, items using this command are always visible and available for use. The command is not dependent on any particular security permission.

In Axiom forms, the command used does not impact whether the button is visible or enabled.

Remarks

For more information on using this command in an Axiom form, see Executing Scheduler jobs from an Axiom form.

See also