User Mode GUI¶

User Mode grants logged-in users full access to policy management functionalities.
Unlike Guest Mode, where only statistics are visible, users in this mode can view, filter, create, edit, activate/deactivate, and delete policies.

The main sections in User Mode include:

• List of all policies – Displays all available policies with filtering options.
• View details – Provides an in-depth view of a specific policy.
• Create – Allows users to define new policies.
• Delete – Enables users to remove policies.
• Modify/Edit – Lets users update existing policies.
• Activate/Deactivate – Controls the status of policies.

Policy List View¶

Once logged in, users are presented with the Policy List Table, which contains all existing policies.
This table provides a structured overview with the following columns:

• Policy Type – Identifies whether the policy applies to a host or an app.
• App Name / Host ID – Displays either the application name or the host ID.
• Policy Name – A unique identifier for each policy.
• Created – The date when the policy was created.
• Phase – Represents the policy lifecycle phase.
• Status – Shows if the policy is active or inactive.
• Actions – A set of available operations for managing each policy.

Above the table, users have access to a dropdown filter, which allows filtering policies by App Name or Host ID.
Selecting an option updates the table dynamically, displaying only the relevant policies.

Managing Policies¶

The Actions column in the Policy List provides several management options, each represented by an icon button.
These buttons allow users to interact with policies directly from the table.

Action Buttons¶

1. View Policy Details – Opens a detailed view of the selected policy.
2. Activate/Deactivate Policy – Toggles the policy status between active and inactive.
3. If the policy is active, the button appears red, indicating that clicking it will deactivate the policy.
4. If the policy is inactive, the button appears green, indicating that clicking it will activate the policy.
5. Edit Policy Variables – Allows modification of policy parameters.
6. Delete Policy – Opens a confirmation modal before deleting the policy.

Tooltips on Hover¶

Each action button displays a tooltip when hovered over, providing a description of its function.
In the example below, the "Delete Policy" button is hovered, showing the corresponding tooltip.

Policy Details View¶

When a user clicks on the View Policy Details button in the "Actions" column, a new page opens, displaying detailed information about the selected policy.

The Policy Details Page is structured into multiple grid cards, each containing specific policy-related information:

• General Information → Displays key details such as Policy Name, Host ID, Agent ID.
• Specification → Defines the policy type, expression, and threshold values (Warning & Critical).
• Action → Specifies the webhook URL, HTTP method, and access token inclusion.
• Subject → Identifies whether the policy applies to a host or app.
• Variables → Lists parameters such as thresholdTimeSeconds and maxCpu.
• Status → Shows whether the policy is active or inactive.
• Events → Logs policy creation & processing timestamps.
• Measurement Backends → Lists any available measurement backends (if none exist, displays "No measurement backends available").

Read-Only Information¶

The Policy Details Page is read-only, meaning users can view all details but cannot make changes directly.
To edit a policy, users must return to the Policy List and use the Edit Policy Variables option.

To exit the Policy Details page, users can:
- Click the Back button.
- Click the Home button in the sidebar.

Create a Policy¶

To create a new policy, users must be logged in.
If an unauthenticated user attempts to create a policy, they will receive a warning message:

Policy Creation Form¶

The policy creation process consists of several sections, each containing specific configuration options.

Basic Information¶

Users must provide key details about the policy:

• Policy Name – A unique identifier for the policy.

• Subject Type – Determines whether the policy applies to a host or an application.

• If Host is selected → Users must enter Host ID and Agent ID.

• If App is selected → Users must enter App Name, App Instance, and App Component.

Specification¶

Defines the policy logic, including:

• Expression – The rule that determines when the policy is triggered.
• Warning Threshold – The value at which a warning is issued.
• Critical Threshold – The value at which a critical alert is issued.

Action & Webhook¶

Defines what happens when a policy is triggered:

• Webhook URL – The endpoint that will receive the event.
• HTTP Method – Defines the request type (POST or GET).
• Include Access Token – Determines if an authentication token should be included.

Validation and Error Handling¶

Some fields are required. If a required field is empty or incorrectly formatted, the input field will display a red border, and an error message will appear below the field.

If a user submits the form with invalid data:
- The form will not be submitted.
- Users will see a validation message explaining the issue.

If the request to create a policy fails due to a server error:
- A notification message appears: "Failed to create policy. Please try again."
- No redirection occurs, and users remain on the form page.

Submitting the Policy¶

Once all required fields are filled out, users can click the "Create Policy" button.
- If successful, they receive a confirmation message: "Policy created successfully!"
- The user is then automatically redirected to the Policy List Table.

Deleting a Policy¶

Users can find a Delete button in two locations:

1. From the Policy List Table¶

Clicking the delete button in the "Actions" column will attempt to delete the entire policy.

2. From the Edit Policy Page¶

Inside the Edit Policy Page, users can delete specific variables from an existing policy.

In both cases, clicking the Delete button will open a confirmation modal asking the user to confirm the action.

Delete Confirmation Modal¶

Before the deletion is executed, a confirmation pop-up appears with the message:
"Are you sure you want to delete this policy?"

• Clicking "Yes, delete" will proceed with the deletion.
• Clicking "Cancel" will close the modal without making changes.

Delete Success & Failure Handling¶

Successful Deletion¶

If the policy is deleted successfully, a notification appears confirming the action:

"Policy deleted successfully!"

Deletion Failed¶

If an error occurs (e.g., server issue or policy dependency restriction), the user receives an error notification:

"Failed to delete policy."

Modifying a Policy¶

Users can modify a policy by editing its variables, but they cannot edit the policy itself.
The Edit Policy option is available in the Actions column of the Policy List Table.

Editing Policy Variables¶

Once the Edit Policy button is clicked, users are redirected to the Manage Variables page.
At the top of the page, the policy name is displayed, indicating which policy is being modified.

Modifying a Variable¶

To modify a variable, users need to:

1. Click the edit icon next to the variable's value.
2. The value field will turn into an editable input field.
3. Two action buttons will appear next to the input field:
4. Green checkmark – Saves the changes and updates the variable.
5. Red X – Cancels the edit and restores the previous value.

Saving Changes¶

When a new variable is added to the policy, it immediately appears at the bottom of the list as a newly created variable.
Additionally, a notification is displayed confirming the change:

"Variable <variable_name> set to <variable_value>."

Handling Errors¶

If a variable fails to be added, the system displays an error notification:

"Failed to set variable."

Activating and Deactivating a Policy¶

Users can change the status of a policy using the Activate/Deactivate button, which is available in the Actions column of the Policy List Table.

Activation and Deactivation Logic¶

• If a policy is deactivated, the Activate Policy button appears green.
• Clicking the button activates the policy, changing the icon to red.
• A notification appears:
  "Policy activated!"

• If a policy is activated, the Deactivate Policy button appears red.
• Hovering over the button displays a tooltip: "Deactivate Policy".
• Clicking the button deactivates the policy, changing the icon to green.
• A notification appears:
  "Policy deactivated!"

Status Column Indicators¶

• The Status column visually distinguishes active and inactive policies:
• If a policy is activated, the "Activated" label appears green.
• If a policy is deactivated, the "Deactivated" label appears in default text color.

Error Handling¶

If the activation or deactivation fails due to a server issue or other error, the system displays an error notification:

"Failed to activate policy."