Built in Steps
There are several built in automation steps delivered with Avantra that can be used directly in an Automation workflow. These steps provide shortcuts to commonly used automation actions. This section documents their purpose and usage.
Sends a File Bundle created in Avantra to an Agent for subsequent use in a workflow.
Using this step, an entire file bundle can be sent or partially only the files that match specific tags can be sent.
In the workflow designer, choose the correct file bundle (either as a constant, or assign an appropriate variable). Optionally it is also possible to automatically make the distributed files executable and to specify a location to save the files.
|Be careful with cross-platform workflows to be sure that the file path is correct on each system.
This workflow step also delivers two output parameters, location and files, which, after successful execution of the step, contain the location that the files are now available at and an array of file names from the bundle in files.
Stop the workflow at a given point and request a user to interact with it. The user can either confirm the step and the workflow continues or the workflow can be stopped.
Starts the whole SAP System with all SAP application servers belonging to the SAP system.
|Please note that the SAP database is NOT started with this action.
The detailed start procedure is the following:
Avantra checks with
R3transcommand whether the database is up and running. If the database is not up and running, the SAP System will not be started.
cleanipc <instno> removeon all SAP instances. If the SAP instance is already running,
cleanipcis not executed.
Execute the SAPControl StartSystem function. After executing
SAPControl StartSystemfunction, Avantra waits until all SAP instances are up and running. To do that the
SAPControl GetSystemInstanceListfunction is executed. The maximum time to wait is 20 minutes. If not all SAP instances are up and running after 20 minutes, Avantra reports this automation action as failed.
This action stops an SAP system and all SAP instances belonging to that SAP system.
|Please note that the SAP database is NOT stopped with this action.
Avantra executes the
SAPControl StopSystem function to stop the SAP system.
SAPControl StopSystem function, Avantra waits until all SAP instances are stopped.
To do that the
SAPControl GetSystemInstanceList function is executed.
The maximum time to wait is 20 minutes. If not all SAP instances are stopped after 20 minutes,
Avantra reports this automation action as failed.
Starts the database belonging to an SAP System.
|Please note that only the database is started, the SAP instances are NOT started.
How the database is started depends on the database vendor. Avantra currently supports start/stop on the following databases and operating systems:
For SAP HANA database: this action starts only the HANA tenant. The HANA System DB is not started with this action.
The agent user might not have permission to start the database. In this case, you have to define the OS user for the SAP system. If set, this user is used to start the database.
On Windows, the database runs as Windows Services. The agent user must have permission to start a Windows service. You must give this permission before you execute this action.
Stops the database belonging to an SAP system.
|Please note that only the SAP database is stopped.
The SAP system is not stopped with this action. The supported databases and operating systems can be found in the Start SAP Database action. The SAP system must already be stopped before the database is stopped.
|Stopping an SAP database while SAP instances are running will result in fatal errors on your SAP system.
Starts the SAP database AND the SAP System (all SAP instances). Please read the comments for Start SAP System and Start SAP Database for details on start actions.
Starts the SAP HANA System DB, all SAP HANA tenants, and the SAP system. This is a special action for SAP HANA systems only. While non-HANA SAP systems run on a dedicated database that belongs to the SAP system, HANA SAP systems share one HANA database. Each HANA SAP system runs on a so-called HANA tenant which is part of the HANA database. This action starts the HANA platform (the HANA system DB). Based on your HANA settings, the HANA tenants are started as part of this procedure. Once the HANA system DB is up and running, this automation action starts the HANA tenant database (the database belonging to the SAP system). Based on your HANA settings, this HANA tenant might already be started during the start of the HANA platform. This is not an issue if this is the case, the HANA tenant will not be started again. Once the HANA tenant is up and running, the SAP System is started. Please refer to Start SAP System for details.
Stops the SAP System, the SAP HANA tenants database, and the SAP HANA System DB. This action stops the SAP system and SAP database, please refer to Stop SAP System and Database action. After that, the HANA platform (system DB) is stopped as well.
|Please be aware that stopping the HANA system DB will stop all running HANA tenants as well! Avantra does NOT warn you if another HANA tenant (for example, hosting another SAP system) is running. This HANA tenant will be stopped too with fatal errors for running applications on this HANA tenant.
So, please use this command with caution.
This action is only applicable when your SAP systems are running on cloud servers which can be started and stopped from Avantra (please refer to "xxx" how to start and stop servers). Since an SAP system might run on multiple servers, this action detects first all servers which are hosting the SAP system. Then those cloud servers are started. Once the cloud servers are up and running, the SAP system is started. Refer to Start SAP System and Database action.
This action is only applicable when your SAP systems are running on cloud servers. Please refer to Start SAP System, Database and servers for details.
Starts an SAP HANA System DB (HANA may start tenants depending on your HANA settings).
|Please note that starting HANA tenants requires a user with the DATABASE ADMIN or DATABASE START privilege in the system DB. You need to specify the name and password of that user in.
Stops SAP HANA System DB (all tenants are stopped too).
|Please note that stopping HANA tenants requires a user with the DATABASE ADMIN or DATABASE STOP privilege in the system DB. You need to specify the name and password of that user in.
Starts a single SAP Instance.
SAPControl Start function is used to start the SAP instance.
Stops a single SAP Instance.
SAPControl Stop function is used to start the SAP instance.
Starts a single cloud server. The cloud authentication must be correctly defined for this cloud server.
Stops a cloud server. The cloud authentication must be correctly defined for this cloud server.
Starts a standalone database.
Avantra currently supports start/stop on the following standalone databases and operating systems:
Stops a standalone database.
See Start Database for what databases are supported.
This action allows you to wait until a specific check from a specific system receives a defined state. In addition to static and dynamic checks, the Wait for Check Status automation action also supports the custom check type, including Composite Checks (the latter are supported since Avantra Version 20.11.6).
This automation action allows you to wait until the selected system gets its status.
Get the total number of processes of an SAP instance.
This action executes the
Get the detailed process list of an SAP instance
This action executes the
Get the detailed SAP instance list of the SAP system
This action executes the
This action allows the workflow to make use of the Avantra notification system to send a message or notification through any of the Available Output Channels through a WORKFLOW STEP EVENT notification action.
The correct notification action can be chosen and assigned to the parameter actionID and data from the workflow can be passed in a simple table format to the customData parameter for use in the notification action.
This action allows you to wait for a certain amount of time. For example, it can be useful to make sure that the previous action has time to finish.
Executes operating system commands The commands run with the agent user. Make sure that the agent user has the required permissions to execute the commands.
Executes an Ansible Playbook as a step in an Avantra workflow.
|The Ansible Step is only available if Ansible Core is installed on the system where the Avantra server is installed. This installation must be performed manually. Please also note that Ansible Playbooks can only be executed on Ansible Core which runs on Avantra Server.
Each Ansible Playbook is a list of tasks executed on hosts defined in an Ansible inventory. Each module within an Ansible Playbook performs a specific task and contains settings for when and where a task is executed and which user can execute it. Those modules must be installed on the Ansible Core.
An Ansible Playbook needs an inventory, which defines which hosts to execute the playbook. In an Avantra workflow step, you can define such an inventory in the corresponding inventory setting. Use the variables setting to specify additional variables passed to the Ansible Playbook. Additional Ansible settings like check, debug, and diff are optional and can be used to verify the Ansible script before the actual execution.
Executes a script with an ssh session.
You must define
SSH credentials that will be used to establish an ssh session. You can either use global credentials defined in Integrations
or you can define ad-hoc credentials which are only used and visible for this action.
Since the ssh script runs with the defined ssh credentials, it is no longer limited to the agent user permissions.
It runs with the permissions given to the ssh user.
Use this action if you want to execute script commands with a user other than the agent user.
|Starting with Avantra 20.11.5, this automation action depends on the global Avantra server setting Security.EnableOSCodeExec and can only be used if it is set to true.
Raising an SAP Event. The RFC function
RSSM_EVENT_RAISE is called. This automation action can be used for example to start an SAP job.
This step is deprecated. Please use the Step Library.
RFC capable) script.