b4A Package B4A.BASE

Details

Name
B4A.BASE
Version
1.2.1
Description
Objects and actions for using best4Automic in automation processes
Supported
yes
Dependencies
BBC.SHARED ~= 1.0.0
Number of objects
69

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

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.2.1
Web https://docs.best4automic.de
Built On 2024-02-26 12:28:44
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#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-GROOVY Runs a b4A Groovy script

Configuration

Name Title
B4A.BASE.DOCU.MAIL-FOOTER Defines the default mail footer
B4A.BASE.VARA.CONFIG#BASIC Basic configuration for b4A modules
B4A.BASE.VARA.CONFIG#BASIC$$$AE21A-0020 Basic configuration for b4A modules
B4A.BASE.VARA.CONFIG#BASIC$$$AE21A-0021 Basic configuration for b4A modules
B4A.BASE.VARA.CONFIG#BASIC$$$AE21A-0060 Basic configuration for b4A modules
B4A.BASE.VARA.CONNECTIONS All available connections
B4A.BASE.VARA.CONNECTIONS$$$AE21A-0019 All available connections
B4A.BASE.VARA.CONNECTIONS$$$AE21A-0020 All available connections
B4A.BASE.VARA.CONNECTIONS$$$AE21A-0021 All available connections
B4A.BASE.VARA.CONNECTIONS$$$AE21A-0022 All available connections
B4A.BASE.VARA.MODULES All available modules
B4A.BASE.VARA.SETTINGS Basic settings
B4A.BASE.VARA.SETTINGS$$$AE21A Basic settings
B4A.BASE.VARA.SETTINGS$$$AE21A-0020 Basic settings
B4A.BASE.VARA.SETTINGS$$$AE21A-0021 Basic settings
B4A.BASE.VARA.SETTINGS$$$AE21A-0032 Basic settings
B4A.BASE.VARA@XML.LOGIN-TYPES Login parameter settings

Sources & Documentation

Name Type Subtype Folder
B4A.BASE.DOCU.LICENSES DOCU /DOCUMENTATION
B4A.BASE.DOCU.RELEASE-NOTES DOCU /DOCUMENTATION
B4A.BASE.JOBI.CONFIG-ADD JOBI /SOURCE/CONFIGURATION
B4A.BASE.JOBI.CONFIG-ADD-TEMP JOBI /SOURCE/CONFIGURATION
B4A.BASE.JOBI.CONFIG-ADD-VARA JOBI /SOURCE/CONFIGURATION
B4A.BASE.JOBI.CONFIG-CREATE JOBI /SOURCE/CONFIGURATION
B4A.BASE.JOBI.CONFIG-READ-PROMPTSET JOBI /SOURCE/CONFIGURATION
B4A.BASE.JOBI.DEFINE-ALIAS JOBI /SOURCE/RUN
B4A.BASE.JOBI.EXIT JOBI /SOURCE/RUN
B4A.BASE.JOBI.GET-CREDENTIALS JOBI /SOURCE/RUN
B4A.BASE.JOBI.PROCESS-RESULTS JOBI /SOURCE/RUN
B4A.BASE.JOBI.RESOLVE-AGENTGROUP JOBI /SOURCE/SETTINGS
B4A.BASE.JOBI.RUN-GROOVY@UNIX JOBI /SOURCE/RUN
B4A.BASE.JOBI.RUN-GROOVY@WIN JOBI /SOURCE/RUN
B4A.BASE.JOBI.RUN@UNIX JOBI /SOURCE/RUN
B4A.BASE.JOBI.RUN@WIN JOBI /SOURCE/RUN
B4A.BASE.JOBI.SETTINGS JOBI /SOURCE/SETTINGS
B4A.BASE.JOBI.VARIABLES JOBI /SOURCE/SETTINGS
B4A.BASE.JOBS@UNIX.RUN JOBS UNIX /SOURCE/RUN/STANDARD
B4A.BASE.JOBS@UNIX.RUN#DOCU-OPTION JOBS UNIX /SOURCE/RUN/DOCU
B4A.BASE.JOBS@UNIX.RUN#LOGIN JOBS UNIX /SOURCE/RUN/LOGIN
B4A.BASE.JOBS@UNIX.RUN#STR-OPTION JOBS UNIX /SOURCE/RUN/STRING
B4A.BASE.JOBS@UNIX.RUN#VARA-OPTION JOBS UNIX /SOURCE/RUN/VARIABLE
B4A.BASE.JOBS@UNIX.RUN-GROOVY JOBS UNIX /SOURCE/RUN/GROOVY
B4A.BASE.JOBS@WIN.RUN JOBS WINDOWS /SOURCE/RUN/STANDARD
B4A.BASE.JOBS@WIN.RUN#DOCU-OPTION JOBS WINDOWS /SOURCE/RUN/DOCU
B4A.BASE.JOBS@WIN.RUN#LOGIN JOBS WINDOWS /SOURCE/RUN/LOGIN
B4A.BASE.JOBS@WIN.RUN#STR-OPTION JOBS WINDOWS /SOURCE/RUN/STRING
B4A.BASE.JOBS@WIN.RUN#VARA-OPTION JOBS WINDOWS /SOURCE/RUN/VARIABLE
B4A.BASE.JOBS@WIN.RUN-GROOVY JOBS WINDOWS /SOURCE/RUN/GROOVY
B4A.BASE.PRPT.DATASTREAM PRPT /SOURCE/DATASTREAM
B4A.BASE.PRPT.DATASTREAM#LOGIN PRPT /SOURCE/DATASTREAM
B4A.BASE.PRPT.RUN PRPT /SOURCE/RUN/STANDARD
B4A.BASE.PRPT.RUN#DOCU-OPTION PRPT /SOURCE/RUN/DOCU
B4A.BASE.PRPT.RUN#LOGIN PRPT /SOURCE/RUN/LOGIN
B4A.BASE.PRPT.RUN#STR-OPTION PRPT /SOURCE/RUN/STRING
B4A.BASE.PRPT.RUN#VARA-OPTION PRPT /SOURCE/RUN/VARIABLE
B4A.BASE.PRPT.RUN-GROOVY PRPT /SOURCE/RUN/GROOVY
B4A.BASE.SCRI.DATASTREAM SCRI /SOURCE/DATASTREAM
B4A.BASE.SCRI.DATASTREAM#LOGIN SCRI /SOURCE/DATASTREAM
B4A.BASE.SCRI.GET-SETTINGS SCRI /SOURCE/SETTINGS
B4A.BASE.VARA.METADATA VARA STATIC
B4A.BASE.VARA@EXEC.DATASTREAM#EXAMPLE VARA EXEC /SOURCE/DATASTREAM
B4A.BASE.VARA@EXEC.DATASTREAM#EXAMPLE#LOGIN VARA EXEC /SOURCE/DATASTREAM
B4A.BASE.VARA@EXEC.GET-SETTINGS VARA EXEC /SOURCE/SETTINGS