After creating or importing a module, you can make changes to it on the Manage page.
You can make changes to modules that are not part of paid business solution. These modules are marked with a lightning icon:
.
This article explains how to open the module management page and what settings are available on its tabs. It also covers how to capture and restore module versions when versioning of structures is enabled in the system.
Open the module management page
- If the module is part of a free solution, unlock the solution first.
- Go to the Administration > Modules page.
- Hover over the required module and click the gear icon that appears. If the module is already open, click Manage at the bottom of its page.
- The module management page opens. On its separate tabs, you can configure the module's logic to perform specific tasks for your company.
Module management features
Each tab provides tools for configuring the module:
- Main. Specify general information about the module, including its name, icon, brief and detailed descriptions, a link to documentation explaining how the module works, the developer’s name, and a link to the developer’s website.
- Settings. Add global module properties.
- Widgets. Create custom widgets for business process forms, apps, workspace pages, and more.
- API Methods. Create module methods that can be accessed from external systems, for example, to start a business process from an external app. You can also call these methods from scripts on the forms of widgets, processes, or pages in the system.
- Business Process Activities. Add new activities to business processes.
- Processes. Create business processes that run within the module and are used to configure activities.
- Services. Integrate custom portable microservices into the module to extend its functionality and handle a wide range of tasks in BRIX.
- Event Handling. Create and configure activities that the system performs when specific events occur. You can handle events using scripts , configure processes to start, or send notifications about events to an external service.
- External App. Connect an external app to allow third-party services to access protected resources in BRIX using the OAuth2 authorization protocol. Data from BRIX can then be used as a method of authentication on a third-party service, as well as a source for requests via Web API.
- External Services. Configure integration with a web service that uses the SOAP (Simple Object Access Protocol) protocol to exchange data with BRIX. This provides access to the web service description language (WSDL), allowing you to use the service's methods and data types in server-side scripts to handle tasks in BRIX.
- Translations. Add .po files containing translations of module resources into languages other than the module's source language.
- Performance Indicators. Crate and publish an indicator to evaluate the efficiency of business process instances based on specific parameters.
You can download a configured module as an .e365 file. For more information, see Export a module. After the module is imported into another company, users can manage it.
Module version control
If versioning of structures is enabled in the system, you can manually capture a module version after creating it.
A module version includes the current versions of its widgets, processes, and API methods. Other module structures and settings are not included because versioning is not supported for them.
If you later make changes to widgets, processes, or API methods and an error occurs in the module’s operation, you can quickly restore its previous version. Other structures within the module and its settings will not be modified or deleted.
Suppose you save Version 1. You then add a custom widget and a Business Process Activity to the module and save Version 2. Later, you discover an error in the widget and restore Version 1.
The restored module version will not include the widget added in Version 2, but it will still include the Business Process Activity as it is not part of module versions.
To learn more about working with versions, see Manage configuration versions.