- Maintained by: ACTIWARE Development GmbH
- Markdown: Used Markdown Reference
- Docker Settings: Docker Quick Reference
- Documentation: Module Documentation
- Globale Documentation: Global Documentation Examples
- Code Guidelines: Code Guidelines
The module automatically detects the browser language in the configuration and changes the display language for the configuration accordingly. If the configuration is loaded into another application, the language may have to be indicated as query parameter lng=en|en|.... must be given.
To edit existing languages, the Excel-File provides the current values for the translations. It is also mandatory to keep this file up to date, since the language files should always be generated from the Excel-File.
To update the languages in this project, the generated language files must be placed in the directory ./module-definition/languages. When building the application, the language files are then additionally transferred to the output directory for the configuration.
The ZIP file for the modules is automatically generated in the build process and deployed in the Docker image. When the Docker image is configured with the respective environment variables, the module tries to deploy the module definition file on every startup.
If the module is developed in Dotnet, it should be ensured that Dotnet 6 is used, because the respective workflows for Dotnet are set to the 6.0.x version.
The following sections explain the other individual adjustments to be made.
The project files (*.csproj) must be renamed. Here the term iotemplate must be replaced with io<modulename> and the namespace Module.IOTemplate must be replaced with Module.<ModuleName> as well.
Note that when renaming the project files, the module name is written in lower-case and when renaming the namespaces, it is written in camel-case.
For deploying the module to Windows, the repository includes the setup-module-dotnet.aip project file. This is used to generate the Windows setups during the Github action and make them available on S3 for our QA. In order for the setups to be generated correctly some changes need to be made beforehand.
The following changes need to be made:
- Adjustment of the ProductCode for the identification of the product below the Windows-Setups.
- Adaptation of the UpgradeCode for the identification of the product in order to update it with newer versions.
- Replacing the IOTemplate name with the name of the new module.
- Replacing the property DefaultPort 30100 with module default port.