Creating Module Instances
- 18 Jan 2022
- 1 Minute to read
- Print
- PDF
Creating Module Instances
- Updated on 18 Jan 2022
- 1 Minute to read
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
- Open N3uron and navigate to the “Config” view.
- Click on “Modules”, then create a new module. This instance can be given any name (except names with special characters like ‘.’, ‘/’, etc.), although users are recommended to name instances in a similar way to the name of the module being instantiated. In this example, it has been named Ufl Exporter.
Figure 1: Creating new module instances
By setting the module type to Ufl Exporter, the created instance will automatically become a Ufl Exporter instance. Once saved, Ufl Exporter should appear in bold in the module list because there are unsaved changes.
Figure 2: Setting the instance type
Note:
In addition to configuring this instance, each module has a Logger, which needs to be configured separately. The default settings will be sufficient for this, but users will need to actively open the Logger configuration settings and save the default values in order for the configuration file to be generated.
Additionally, each instance can be configured with the following options:
- Required: When enabled, all links will be paused when the module is offline to avoid data loss. If not enabled, this module will have no effect on links when offline.
- Start: This section controls how the module behaves when the N3uron service is started (which also includes service restarts).
- Enabled: If true, the module will automatically start when the N3uron services start. Otherwise, the module must be started manually.
- Start delay: When automatic start is enabled, this setting is used to control how much delay there should be between starting the N3uron service and starting the module. This value is in displayed in milliseconds.
- Monitor: This section is used to monitor the status of each module, as well as to enable it to automatically restart if it goes offline.
- Automatic restart: If true, whenever the module goes offline (except when manually stopped by the user) the module will automatically restart.
- Restart delay: Determines the delay before restarting the module after it has gone offline.
Was this article helpful?