Getting Started with Web UI Actions
    • Dark
      Light
    • PDF

    Getting Started with Web UI Actions

    • Dark
      Light
    • PDF

    Article Summary

    You can perform actions on your environment directly from the web UI.

    Prerequisites

    • Real-Time DX version 8.7 or higher
    • Monitors must be able to access https://solve.controlup.com/ over TCP port 443.

    Permissions

    By default, all users can run actions from the web UI. You can Deny a user permission to run a specific action using the Security Policy

    Limitation with the Local Admin role

    In the Security Policy Pane, the Local Admin role represents local administrators on remote machines. If a user belongs ONLY to the Local Admin role even if the permission for an action is set to Allow, running the action fails due to missing permissions.

    Setting the permission for the Local Admin user role to Deny on a specific action affects all other user roles. Other users, even those whose permissions are set to Allow, are not allowed to run the web UI action in this case.

    Solution

    Any user running actions from the web UI must belong to more than just the Local Admin role. Ensure that the permission to run the action for both roles is set to Allow.

    No permission on the selected object

    If the user doesn't have permission to run the action on the object, the following error message is displayed:
    image.png

    Partial permissions on selected objects

    If the user doesn't have permissions on all selected objects, a "Missing Partial Permissions" error is displayed with the object on which the user is missing permissions. This error appears if the user has permission to run an action on a machine in a specific folder, but not on the other selected machine.
    image.png

    At this stage, you can either click Run or Cancel. To run an action only on objects a user has permission to, click Run.
    image.png

    Click Cancel to abort the action. In this case, Action aborted by the user is displayed.
    image.png

    How to perform an action

    Right-click an object in the Details grid to open the actions menu. All of the available actions are organized into categories.

    image.png

    Click on the action you want to perform.

    Select multiple objects with the checkboxes before right-clicking to perform the action on all selected objects.

    See action status and details

    After you perform an action, an overlay appears on the grid to show the status of your action. The status can either be:

    • Success.
      StatusOverlaySuccess

    • Failure.
      StatusOverlayFailed

    • Partial success. This occurs when the action was successful on some targets, but failed on others.
      StatusOverlayPartialSuccess

    • Running.
      StatusOverlayRunning

    Run multiple actions at the same time

    If an action takes a while to run, you don’t have to wait for it to finish. You can continue using the web UI, and even launch other actions while waiting for the first action to finish.

    Click More Info on the action status overlay to open the action details window, including the results and output for each target of the action. The action details are different for built-in actions and script actions.

    Built-in action details

    The details window for built-in actions shows you only which targets you performed the action on, and if each action was successful.
    DetailsWindowBuiltIn

    Script action details

    The details window for script actions shows you the output from the script, including any errors, for each target of the action. You can also see details about the script action, such as when it ran, how long it took, and the script exit code.

    The Group column indicates groups of targets that have the same output result from the script action. For example, if two targets belong to group 1, then those targets have the same output. You can filter the displayed targets based on their group by selecting the three dots next to the Group column.
    DetailsWindowScriptBased

    Action Errors vs. Script Errors

    A script action might be successful, even if the script output has errors. This means that the web UI successfully launched the action, but the script itself returned errors. Errors in launching the action from the web UI are displayed in the Error column. Errors from the script are shown in the output box.

    Script timeout

    If the monitor does not respond within a minute, the following error is displayed:
    image.png

    For both types of actions, you can select a target from the bottom of the window to see the details for that target. To see a history of the actions that were performed in your organization, use the Audit Log.


    Was this article helpful?