B4A.BASE
b4A Package B4A.BASE
Details
| Detail | Value |
|---|---|
| Name | B4A.BASE |
| Version | 1.3.0 |
| Description | Objects and actions for using best4Automic in automation processes |
| Supported | yes |
| Dependencies | BBC.SHARED ~= 1.0.0 |
| Number of objects | 89 |
Description
This package provides utilities for starting b4A modules and creating services using several b4A modules. All actions can be used on Unix/Linux and Microsoft Windows systems.
Requirements
- Unix/Linux
- a bash 2 compatible shell
- Unix tools: cat, rm, mktemp
- Windows
- Powershell 5.0
Initialization
In order for the input masks of the actions to be filled in a meaningful way, the the Connections variable and the Modules variable must be adapted.
Connections variable
The b4A connections that are configured in defaults.conf and should be available from the client must be stored in the VARA B4A.BASE.VARA.CONNECTIONS. The util.ConnectionsSaveTo module can be used for this purpose.
- Key and Value1: b4A connection name
- Value2: System
- Value3: Client
- Value4: User name
- Value5: Department
Modules variable
The VARA B4A.BASE.VARA.MODULES contains the available b4A modules that are to be available via the actions. The list must be compared with the modules available for the b4A installation. The util.ModulesSaveTo module can be used here.
Configuration
The main configuration object is B4A.BASE.VARA.SETTINGS. All settings in this variable are described briefly by the text in value 2. Further details can be found in the following sections.
Credentials
Credentials for the b4A connections are read from the defaults.conf file by default. With the setting CREDENTIALS_OBJECT there is an alternative, that is supported by all actions but the action B4A.BASE.JOBP@IF.RUN#LOGIN. If a login object is defined in value 1 of key CREDENTIALS_OBJECT, than the credential are read from that object. Therefore an entry with a type named like the b4A connection must exist. For example: If the connection AE21-0099 is selected an entry with the type AE21-0099 must exist. The username and department must be found the login info field (separated by a slash). If there is no slash in the login information the department is left empty. If no matching entry can be found in the login object the b4A actions will try to connect without additional credentials.
Release Notes
Version 1.0.0
- Initial release
Version 1.1.0
- [B4APKG-175] New Action to start b4A Groovy scripts
Version 1.2.0
- [B4APKG-200] B4A.BASE.JOBS@WIN.RUN#LOGIN: Getting git username fails
- [B4APKG-191] Groovy Action: Optionale Angabe des b4A Script-Verzeichnisses
Version 1.3.0
- [B4APKG-205] Login and vara option action generate at activation time* [B4APKG-211] Return Code of RUN action is always 0
- [B4APKG-233] B4A.BASE.JOBI.CONFIG-ADD: debug message may cause problems with special characters
- [B4APKG-206] Example for datastream with login action
Metadata
| Key | Value |
|---|---|
| Compatible with | b4A >= 5.0.0 |
| Company | best-blu consulting with energy GmbH |
| Description | Objects and actions for using best4Automic in automation processes |
| Categories | BEST4AUTOMIC |
| Version | 1.3.0 |
| Web | https://docs.best4automic.de |
| Built On | 2025-04-22 16:41:24 |
| Dependencies | BBC.SHARED ~= 1.0.0 |
| Initialized On | 2020-11-09 12:44:16 |
| Installed On | 2021-06-09 11:24:02 |
| Supported | yes |
| Name | B4A.BASE |
Content
Service
| Name | Title |
|---|---|
| B4A.BASE.JOBP.SMOKE-TEST | [Service] A smoke test to verify basic configuration of b4A |
Actions
| Name | Title |
|---|---|
| B4A.BASE.JOBP@IF.RUN | Starts a b4A module |
| B4A.BASE.JOBP@IF.RUN#DOCU-OPTION | Starts a b4A module and reads option data from a DOCU object |
| B4A.BASE.JOBP@IF.RUN#LOGIN | Starts a b4A module using credentials from a login object |
| B4A.BASE.JOBP@IF.RUN#LOGIN-STR-OPTION | Starts a b4A module using credentials from a login object and reads data from a string to create a file for an option |
| B4A.BASE.JOBP@IF.RUN#STR-OPTION | Starts a b4A module and reads data from a string to create a file for an option |
| B4A.BASE.JOBP@IF.RUN#VARA-OPTION | Starts a b4A module and reads option data from a VARA object |
| B4A.BASE.JOBP@IF.RUN-CUSTOM-SOLUTION | Runs a b4A custom solution |
| B4A.BASE.JOBP@IF.RUN-GROOVY | Runs a b4A Groovy script |