NOTICE: From Avantra 24 automations are supplied via the new Add-ins library in Avantra. For customers on Avantra 23 and below please look at upgrading or request the required automations in ZIP format via raising a ticket with your CSM.
This Add-in contains specific types of workflows, that may be used to start and stop various managed enities in Avantra. The add-in will be constantly updated with new/changed workflows, as we are constantly improving this feature. Please share your experience with us. We strongly recommend copying delivered workflows to your namespace. This way you will get a modifiable workflow, which may be enhanced with additional steps/logic, if necessary.
TABLE OF CONTENTS
- 1.0 Requirements
- 2.0 Installation
- 3.0 startSapSystemOracle (Workflow)
- 4.0 stopSapSystemOracle (Workflow)
Add-in Version History
1.0 Requirements
| Avantra Versions: | 25.0.0 + |
| Transports: | - |
| Add-in dependencies: | global-functions |
2.0 Installation
- Use add-in library in your Avantra system to install the add-in.
- (recommended) Copy delivered workflows to your namespace to make them editable
- Navigate to your managed object (let's say SAP System or Database) and use monitoring parameters (WorkflowStartSAPSystem, WorkflowStopSAPSystem, WorkflowStartDatabase, WorkflowStopDatabase, etc) to choose from the avabilable workflows of the given type. The chosen workflow will be used for start/stop function of the managed object.
You may use parameter sets to perform this setup for multiple managed objects at once.
3.0 startSapSystemOracle (Workflow)
The workflow provides a way to start SAP system based on Oracle. This includes cloud servers, database itself (different startup methods), including listener service, and SAP system.
3.1 Prerequisites
For now we provide 2 different options to handle database part of the start and stop Automation: brtools and sqlplus. By default, our workflows are setup to use sqlplus. In the nearest future there will be a monitoring parameter presented, allowing switching between Oracle start and stop methods. For the moment to switch from sqlplus option to brtools, the workflow has to be copied to the customer namespace, and the following step parameter has to be changed:
3.1.1 Common prerequisites
- avantra.sapControl credentials are maintained for the system and/or instances.
- *nix systems: avantra.sapOsUser4StartStop SSH credentials are maintained to provide the user which is supposed to run Oracle listener
- cloud servers: cloud integration is set up.
3.1.2 SQLPLUS
- Avantra agent user is a part of OS group that allows operating the Oracle database (Windows: ORA*DBA, ORA*OPER, unix: dba, oper)
- Avantra agent user has to have the following environment variables set: TNS_ADMIN (if used), ORACLE_HOME, ORACLE_SID. You may use AgentEnvironment monitoring parameter of the respective server in Avantra. Later we will be handling this automatically by dynamically adding these variables if not set.
3.1.3 BRTOOLS
- Database server has sapstartsrv and brtools available.
- brspace is configured to work with Oracle database - under sidadm, you can start Oracle with
brspace(.exe) -u / -c force -f dbstart -s open
3.2 Workflow logic
3.3 Workflow inputs
All start and stop workflows have the same input/ouput interface for obvious reasons. Normally it is not needed to manually create any variants for this type of Workflows, as all inputs are submitted automatically, when start/stop function is triggered
| Parameter (* = Mandatory) | Type | Value/Comment |
|---|---|---|
| systemId (*) | SAP System | SAP system |
| checkDbState | Boolean | Check database connection with R3trans before starting SAP |
| setMonitoring | Boolean | Turns the monitoring on |
| include | String | Array containing what to start additionally to SAP itself. Can include 'db' and 'cloudserver' |
| waitSeconds | Integer | Pause between servers/db/SAP start steps |
3.4 Workflow outputs
| Parameter (* = Mandatory) | Type | Value/Comment |
|---|---|---|
| success | SAP System | whether WF execution was a success |
| message | Boolean | message passed from the workflow |
| details | Boolean | additional details passed from the workflow |
3.5 Workflow steps
| # | Step | Type | Comments |
|---|---|---|---|
| 1 | Read SAP system information | Server-side JS step | Uses Server-side API to gather all necessary information about SAP system to use it for further automation |
| 2 | Start cloud server | Built-in step | Standard step for starting cloud server |
| 3 | Start Oracle | Agent-side JS step | Starts Oracle with defined method. Currently we support sqlplus call under Avantra agent user and brconnect using SAP owner user |
| 4 | Start SAP system | Built-in step | Starts SAP system. Behind the scene calls Avantra legacy implementation of the start SAP system function |
| 5 | Merge results | Server-side JS step | Analyze various steps' output and produce overall result |
4.0 stopSapSystemOracle (Workflow)
The workflow provides a way to stop SAP system based on Oracle. This includes cloud servers, database itself (different shutdown methods), and SAP system.
4.1 Prerequisites
See 3.1
4.2 Workflow logic
3.3 Workflow inputs
All start and stop workflows have the same input/ouput interface for obvious reasons. Normally it is not needed to manually create any variants for this type of Workflows, as all inputs are submitted automatically, when start/stop function is triggered
| Parameter (* = Mandatory) | Type | Value/Comment |
|---|---|---|
| systemId (*) | SAP System | SAP system |
| setMonitoring | Boolean | Turns the monitoring on |
| include | String | Array containing what to start additionally to SAP itself. Can include 'db' and 'cloudserver' |
| softTimeout | Integer | Softtimeout specifies a timeout in seconds for a soft shutdown via SIGQUIT, if the timeout expires a hard shutdown is used. After the soft timeout, logged in users are automatically logged out. |
| informUsers | Boolean | Send a message to all users logged in with SAPGUI. Use this option with 'Soft timeout' setting! |
| forceStop | Boolean | Avantra checks for known running applications (ie. applications with monitoring turned on) and cancels a stop if some are found. With force stop enabled, the server will be stopped in any case. |
3.4 Workflow outputs
| Parameter (* = Mandatory) | Type | Value/Comment |
|---|---|---|
| success | SAP System | whether WF execution was a success |
| message | Boolean | message passed from the workflow |
| details | Boolean | additional details passed from the workflow |
3.5 Workflow steps
| # | Step | Type | Comments |
|---|---|---|---|
| 1 | Read SAP system information | Server-side JS step | Uses Server-side API to gather all necessary information about SAP system to use it for further automation |
| 2 | Stop SAP system | Built-in step | Stops SAP system. Behind the scene calls Avantra legacy implementation of the stop SAP system function |
| 3 | Stop Oracle | Agent-side JS step | Stops Oracle with defined method. Currently we support sqlplus call under Avantra agent user and brconnect using SAP owner user |
| 4 | Stop cloud server | Built-in step | Standard step for stopping a cloud server |
| 5 | Merge results | Server-side JS step | Analyze various steps' output and produce overall result |