Call Function

This it one of the basic action types used in AggreGate Server. The primary objective of this action is to allow a user to perform an operation with the hardware device or system object by calling a single function from the corresponding context.

Non-Interactive Mode:

Supported

Permissions:

Accessible at Observer permission level

Execution Parameters:

Dashboard Properties of function output window

Location of function output window

Action Flow

  • [Optional] User is prompted to confirm the execution using the Confirm UI Procedure.
  • [Optional] User is prompted to edit input parameters of a function to be called using an Edit Data UI Procedure. If the user cancels this UI Procedure (i.e. by clicking Cancel in the Data Table Editor dialog), the action is aborted.
  • The function specified by the Call action is now invoked, and the server performs all necessary operations (like creating a new Alert, or reading a list of all <Device Servers and returning it as its output). If function input parameters were not specified on step 2, the function is called using its default parameters.
  • If the function returns an error, it is shown to the user using a Show Error UI Procedure. If the user was prompted for input parameters on step 2, the flow now returns back to step 2 so that the user could specify different parameters.
  • [Optional] If the function returned any data, it may be shown to the user using an Edit Data UI Procedure in read-only mode.
  • [Optional] In some cases, a "Successfully Completed" or other message may be shown to the user using a Show Message UI Procedure to indicate that the function has been successfully called.
  • Grouping Support

    This action supports action grouping.

    • If confirmation is required, it may be applied to all actions in the group.
    • The same input parameters may be applied to all actions in the group.
    • All "Successfully Completed" messages for the actions in the group are shown in a single window.

    Examples:

    Connect Device Server to AggreGate Server in External Device Server context (prompts for input parameters, has "Successfully completed" message)

    View Users Summary in Users context (doesn't prompt for input, shows output)

    Delete Query in Query context (doesn't prompt for input and output, requires confirmation)

    Buzz in Device Server context (no user interaction at all, just performs the requested operation)