User Guide

Table of Contents

• User Guide
  • Table of Contents
  • 1. Introduction
  • 2. Quick comissioning
  • 3. Registration
  • 4. Main Features
    • 4.1. Plugins
      • 4.1.1 Plugins importation
      • 4.1.2 Plugins dependencies
    • 4.2. Components
      • 4.2.1 View
      • 4.2.2 Available components
      • 4.2.3 Existing components
    • 4.3. Dashboard
      • 4.3.1. Widget selection
      • 4.3.2. Widget base configuration
      • 4.3.3. Widget cyclic configuration
      • 4.3.4. Manage widgets
    • 4.4. Cyclic
      • 4.4.1 View
      • 4.4.2 Components
    • 4.5. Notifications
      • 4.5.1 Active tab
      • 4.5.2 History tab
      • 4.5.3 Configuration tab
  • 5. Manage your account
  • 6. Customization

---

1. Introduction

Welcome to Lionk! This guide will help you navigate the application's key features. We'll cover the Dashboard for an overview of your system, Notifications to keep you updated, and Manage your account to personalize your settings. You'll also learn about the Plugins, Components, and Cyclic views, which offer additional tools and functionalities to enhance your experience with Lionk. By the end, you'll be well-equipped to use each view effectively.

---

2. Quick comissioning guide

To quickly get started with Lionk, follow these steps:

1. Register an account: Create a new account to access the application.
2. Import Plugins: Add external plugins to enhance the application's functionality. To test the plugin importation, you can use the provided Lionk.TestComponent.dll file and Lionk.Core.dll file and Lionk.Core.Razor.dll file. This will give you 2 components to work with and default views. plugins available here
3. Add Components: Choose from the available components to add to your application.
4. Configure Widgets: Customize your dashboard by selecting widgets and configuring their settings.

---

3. Registration

g)

Before you can start using the Lionk application, you need to register an account.

If you are the first user to register, you will automatically be assigned the Admin role, giving you full access to manage the application. If you are not the first user, you will be registered as a standard user with regular access rights.

Make sure to complete this step first to ensure you can fully explore and utilize everything Lionk has to offer.

---

4. Main Features

4.1. Plugins

4.1.1 Plugins importation

The Plugin import section allows you to add external plugins to enhance the functionality of your application. Follow these steps to successfully import a plugin:

File Selection: Begin by clicking the BROWSE button to open the file explorer. Navigate to the directory where your plugin .dll file is located, select it (e.g., Lionk.TestComponent.dll), and click Open.

You can also simply drag and drop the plugin file into the designated area to import it.

4.1.2 Plugins dependencies

Once the plugin is loaded, it will appear in the list of loaded plugins, displaying key details such as the name, version, and author of the plugin.

After the plugin is loaded, you can click on the SHOW DEPENDENCIES button to see a list of all the dependencies associated with the plugin. This section provides a detailed view of the required libraries and their specific versions, ensuring that all necessary components are present.

If some dependencies are missing, the depedency will be highlighted in red, indicating that it needs to be resolved before the plugin can be used. It's important to import dependencies before using the plugin to avoid any issues with its functionality. So if a dependency is missing, you must delete your plugin, restart the app and then import the dependencies before importing the plugin again.

---

4.2. Components

4.2.1 View

The Components section allows you to manage and organize components within your application. This interface provides an overview of available and existing components, enabling you to add or remove them as needed.

4.2.2 Available components

In the Available components section, you can see a list of all the components that can be added to your application. Each component is listed with its type and description. To add a component to your application, select it and click the ADD SELECTED button.

4.2.3 Existing components

The Existing components section displays the components that have already been added to your application. You can search, rename, and delete components from this list. To remove a component, select it and click the DELETE SELECTED button.

---

4.3. Dashboard

The Dashboard section allows you to manage and configure widgets that display various components and their data within your application. Here’s how you can set up and customize your widgets

4.3.1. Widget selection

By clicking on the + floating button, you can choose from a list of available components to add to your dashboard. Each component is listed with its name. Select the desired component and click on CHOOSE WIDGET to proceed.

View selection:

After selecting a component, you will be prompted to select the available widget. Choose the widget by clicking SELECT. Then, click on OK to proceed.

Now you can see the selected component within the selected widget in the dashboard.

4.3.2. Widget base configuration

By clicking on the configuration button, you can configure the component's base settings. To have access to the default configuration view, you must import the plugin Lionk.Core and Lionk.Core.Razor.

then you will be prompted to configure the component.

Widget base configuration:

This configuration is accessible by each component and allows you to set the name of the component directly in the widget.

This modification will affect the component name in the component tab.

4.3.3. Widget cyclic configuration

If the component that you want to configure is cyclic, a cyclic configuration will be available. by clicking on the left or right arrow.

At this point, you can configure the cyclic settings of the component as you wish. You can update the period of the component and the "next execution" computation.

When you pass your mouse over the selection of the "Next execution computation" selection radio buttons, you will see a tooltip that explains the different options.

4.3.4. Manage widgets

Once the widget is configured and added to the dashboard, you can see it in action on the main dashboard view. The widget will display real-time data based on the component’s performance, and you can interact with it directly, including options to configure, acknowledge, or delete the widget.

---

4.4. Cyclic

4.4.1 View

The View displays the current state of the cyclic executor.T he cyclic executor is the service responsible for regularly executing cyclic components. This page include key metrics such as:

• State: Indicates whether the process is currently running or paused.
• Mean Cycle Time: The average time taken for one complete cycle, measured in milliseconds.
• Max Cycle Time: The maximum duration recorded for a single cycle.
• Watchdog Time: A configurable time threshold that monitors the maximum allowable cycle time before triggering an error which abort components cycle.

You can pause the cyclic processes using the Pause button, and adjust the Watchdog Time as necessary to ensure optimal performance.

4.4.2 Components

The Components section lists all the active components that participate in the cyclic process. Each component is displayed with the following details:

• Period: The time interval at which the component operates.
• Cycle Count: The number of cycles the component has completed.

Components in error state will prompt an action button (e.g., RESET) allowing you to address issues directly from this view, ensuring that all components function correctly within the cyclic system.

---

4.5. Notifications

Actually this feature is not completely implemented, all the channels and notifiers are here for demonstration purposes. The notifications are not sent to the channels.

4.5.1 Active tab

The Active section displays notifications that are currently unresolved or require your attention. Each notification is listed with the following details:

• Date: The timestamp when the notification was triggered.
• Severity: The level of importance, such as Information, Warning, or Critical.
• Title: A brief title summarizing the notification.
• Message: A more detailed description of the notification.
• Status: Indicates

whether the notification has been read or remains unread.

• Actions: You can take immediate action on the notification by clicking the MARK AS READ button, which will change its status and move it out of the active notifications list.

You can also access active notifications by clicking the bell button in the app bar which also indicates the number of unread notifications:

4.5.2 History tab

The History section displays all notifications that have been received, regardless of their current status. This includes both read and unread notifications, providing a complete log of all alerts for your reference.

Together, these sections provide a comprehensive view of both ongoing and past notifications, allowing for efficient monitoring and management of alerts within your application.

4.5.3 Configuration tab

In this view, you can manage the various Notifiers and Channels within your application. This interface allows you to configure how notifications are handled and which channels are used to deliver them.

Notifiers:

The Notifiers section lists the different notification triggers that you have set up. Each notifier is represented by its name, and you have the following options:

• Edit: Clicking the pencil icon allows you to modify the settings of an existing notifier such as disabling a channel.
• Delete: The trash bin icon allows you to remove a notifier completely.

You can search for specific notifiers using the search bar located at the top right of this section.

Channels:

The Channels section lists the platforms through which notifications are sent, such as Discord, Telegram, and Pushbullet. For each channel, you have the following options:

• Edit Settings: The gear icon allows you to configure the specific settings for each channel.
• Delete: The trash bin icon allows you to remove a channel from the list.

Add: You can add a new channel by clicking the + ADD button.

---

5. Manage your account

In this section, you can view the basic information about your username and email. Both the Email and Password are editable and can be modified in their respective sections.

You can also manage the roles of different users in your application. The table displays the usernames, their associated email addresses, and the roles assigned to each user. You can also delete a user by clicking the red DELETE button in the "Actions" column. This interface allows for quick and easy role management to ensure that users have the appropriate level of access within the application.

---

6. Customization

Dark Mode: Customize the application's appearance by toggling Dark Mode. This option allows you to switch between the default light theme and a dark theme, which may be easier on the eyes, especially in low-light environments.