Microservices
Microservices are independent components that execute to prevent or solve frequent issues on devices, improve performance, or speed up tasks that might require a lot of time to do manually. Microservices can be executed autonomously or as part of a broader functionality within a system.
The Microservices section allows you to create, enable, and publish microservices so they can be executed at the organizational level, as a prevention or self-remediation mechanism —through flows or alerts—, or directly by the end user.
This document describes in general terms what microservices are and how to execute them. The following articles provide more precise information about their behavior and configuration:
- Enabled. Describes how to activate a microservice for execution by an end user or from Workspaces.
- Marketplace. Shows the catalog of available microservices.
- Designer. Explains how to create new microservices and configure existing ones.
- Audit log. Describe what the user microservices execution tracking consists of.
Main characteristics of microservices in Portal
The Microservices section offers a number of key advantages. The most relevant ones are described below:
Access to a centralized catalog
The available microservices are organized in the Marketplace section, where users can explore the catalog, select, and enable specific microservices according to the needs of their organization or particular use cases.
Creation of customized microservices
Portal allows users to easily create microservices via the Designer section. This tool guides the user, as long as they have the appropriate permissions, through all the necessary phases to build and configure their own microservice.
Execution scope configuration
Each microservice can be defined to run in one of the following contexts, configurable from the Designer section.
Execution from the local administrator
It allows direct interaction with operating system services, processes, and other resources requiring elevated privileges. It's ideal for operations that must be executed with administrator permissions, but it may restrict access to specific user information or their session.
Execution from user session
Useful for accessing user information such as their log or information contained in their profile. The script will run with the permission level the user has, so if they do not have local administrator privileges, they will not be able to perform actions requiring system access.
Ways to consume microservices
Microservices can be created and enabled in Portal, and from there configured to be executed by the end user, launched via a flow or executed with automated or support actions from Workspaces.
On-demand execution from Workspaces
Any microservice that has previously been enabled in Portal can be executed from Workspaces.
- Access the
Workspaces
module ->Workspaces
orSessions
section. - Select the devices where you want to apply the microservice.
- In the top menu, click on the Microservices icon (
>_
). - Select the microservice you want to execute.
Microservices will be visible in the Workspaces
section when they have been configured to execute in the System context, and in the Sessions
section when the configuration has selected the Session context.
Management of the execution scope of the microservice and permissions can be done from the Designer section. It should be noted that the ability to execute certain microservices will depend on the user's role in the platform.
Scheduled execution through Flows
Flows is a feature that allows automating and executing a microservice automatically when certain conditions are met on the device. Its main characteristic is that it simplifies diagnostic actions and quickly resolves problems through the execution of a microservice.
For more information on executing a microservice through a flow, please consult this guide.
Scheduled execution through Alert Settings
Through Alert Settings, it is possible to link events (event logs) to one or more microservices to prevent device issues or resolve problems promptly.
- Go to
Portal
->Monitor
->Alert Settings
. - In the table, select an alert name to access its detailed information.
- In the left side menu, click on the
Microservices
tab. - Click on
Link
. - In the form, choose the microservice to link to the alert and the execution order (useful when linking more than one microservice).
- In the form, click on
Link
.
For more information on linking an alert to a microservice, please refer to the Alert Settings documentation.
End-user execution
When a microservice is created, it is not automatically enabled for execution by the end user. To be available, the following configuration needs to be completed:
- Go to
Portal
->Enabled
. - Click on a microservice from the list.
- In the
Targets
tab, go to theEnd user execution
section. - Click
Edit
and activate theEnd user execution
option.
Rename the microservices folder
When microservices are enabled for execution by the end user, they are automatically added to a device folder called Flexxible; however, this name can be changed.
- Go to
Portal
->Settings
->Organization
. - On the left side menu, click the
Microservices configuration
tab ->Edit Microservices configuration
. - Rename the folder.
- Click on
Save
.
The chosen name must be between 3 and 50 characters, and can only contain letters, numbers, hyphens, and underscores.
If the device has Windows 11 as the operating system and only one microservice is enabled for an end user, the folder will not be displayed; instead, only the microservice icon will be visible in the Start menu.
For more information on how to enable a microservice for the end user, please refer to this guide.