Installation of the Atrium Orchestrator Components
This chapter describes all steps to perform the installation and basic configuration for the E-Bonding Runbook Core BAO component.
Prerequisites
For a successful installation of the Atrium Orchestrator E-Bonding Runbook Core the following requirements must be fulfilled:
- Atrium Orchestrator Platform 7.6.04 or higher
- Atrium Orchestrator Content 20.13.01.02 or higher
- Following Atrium Orchestrator OOTB modules in version 20.13.01.02 or higher
- AMP-AD-BMC-Remedy-ARS
- AutoPilot-AD-Utilities
- Following Atrium Orchestrator adapters in version 20.13.01.02 or higher
- Remedy actor adapter (ro-adapter-remedy-actor)
- SQL actor adapter (ro-adapter-sql-actor)
- SOAP adapter (ro-adapter-ws)
- File adapter (ro-adapter-file)
Hint: In combination with BMC Remedy ITSM 9, the following AO content version is required: 20.15.02
Validation JAR
E-Bonding Runbook requires additional Java libraries for the validation of xml objects.
File: eBonding_2.0.jar
Deployment Location: <AO_Installpath>/lib/shared/
Access rights (linux): 755
Example:

Important: The archive must be deployed into all peers of the Atrium Orchestrator server grid. After the deployment, the Atrium Orchestrator servers have to be restarted.
Adapter Configuration
Following BAO adapters must be activated and configured for E-Bonding Runbook.
Important: You have to enable all adapters on each Peer in your BAO grid.
Remedy Actor Adapter
The Remedy Actor adapter is used to access all E-Bonding Runbook internal Remedy forms (e.g. the partner configuration). You must enter the remedy server address where all the Remedy ARS E-Bonding Runbook components have been installed.
Setting | Value |
|---|---|
Name | ADAPTER NAME |
Description | ADAPTER DESCRIPTION TEXT |
Target | AR SYSTEM SERVER NAME |
Port | AR SYSTEM SERVER PORT |
User Name | REMEDY USER NAME* |
Password | REMEDY USER PASSWORD* |
Attachment Destination Dir | MOUNT POINT E-BONDING SHARE |
Download Attachments | true |
matching chapter 2.3.2
All other default settings can remain in place.SQL Actor Adapter
The SQL Actor adapter is used for the communication to the E-Bonding Runbook Transaction Database and requires full read/write permissions to the database schema.
Prerequisites
Depending on the used database (oracle or mysql), the corresponding JDBC Connector .jar libraries have to be downloaded and stored in this location of all BAO servers: <AO_Installpath>/lib/shared/
Example MySQL:

Example Oracle:

Important: The libraries must be deployed into all peers of the Atrium Orchestrator server grid. After the deployment, the Atrium Orchestrator servers have to be restarted.
Settings for an Oracle E-Bonding Runbook Transaction Database
Setting | Value |
|---|---|
Name | ADAPTER NAME |
Description | ADAPTER DESCRIPTION TEXT |
Target | ORACLE DATABASE SERVER |
Port | ORACLE PORT (DEFAULT 1521) |
User Name | E-BONDING RUNBOOK DATABASE USER NAME |
Password | E-BONDING RUNBOOK DATABASE USER PASSWORD |
Subprotocol | oracle:thin |
Database | E-BONDING RUNBOOK DATABASE NAME |
Driver | oracle.jdbc.driver.OracleDriver |
All other default settings can remain in place.
Settings for a mySQL E-Bonding Runbook Transaction Database
Setting | Value |
|---|---|
Name | ADAPTER NAME |
Description | ADAPTER DESCRIPTION TEXT |
Target | MYSQL DATABASE SERVER |
Port | MYSQL PORT (DEFAULT 3306) |
User Name | E-BONDING RUNBOOK DATABASE USER NAME |
Password | E-BONDING RUNBOOK DATABASE USER PASSWORD |
Subprotocol | mysql |
Database | E-BONDING RUNBOOK DATABASE NAME |
Driver | com.mysql.jdbc.Driver |
All other default settings can remain in place.
SOAP Adapter
The SOAP adapter is used for triggering the outbound enabler processes.
Setting | Value |
|---|---|
Name | ADAPTER NAME |
Description | ADAPTER DESCRIPTION TEXT |
All other default settings can remain in place.
File Adapter
The File adapter is used to read/write files on the peer server.
Setting | Value |
|---|---|
Name | ADAPTER NAME |
Description | ADAPTER DESCRIPTION TEXT |
All other default settings can remain in place.
Installation via BAO Repository Manager
To upload the E-Bonding Runbook BAO module you must use the BAO Repository Manager.
Upload the following BAO module file:
- VIP_BGI_Core.VERSION.roar
- VIP_BGI_Core_Configuration.VERSION.roar
- VIP_BGI_Enabler_Core.VERSION.roar
- VIP_BGI_Core_Incident.VERSION.roar
- VIP_BGI_Core_Change.VERSION.roar

Figure 6 BAO Repository Manager
Configuration of the E-Bonding Runbook Core Configuration Module
After the activation of the E-Bonding Runbook Core Configuration module you must adjust the module configuration to your environment.
Name | Description | Default |
Configuration Group: Adapters |
|
|
ARSAdapter | Name of the Remedy ARS actor adapter that is used to connect to the ITSM Suite for all E-Bonding Runbook internal procedures. | ARSAdapter |
SOAPAdapter | Name of the web services adapter. | WSAdapter |
SQLAdapter | Name of the SQL actor adapter. This adapter is used for the communication to the E-Bonding Runbook Transaction Database. | SQLAdapter |
FileAdapter | Name of the File adapter. The adapter is used to read/write files on each peer server. | FileAdapter |
Configuration Group: Settings |
|
|
ChunkSize | The chunk size defines the maximum concurrent E-Bonding Runbook operations per run. | 10 |
UniqueGridName | Important for load-balanced multi-grid environments. Defines a unique name of each single grid in the cluster. | DEVGRID1 |
DBMS | Type of the DBMS system
| MySQL |
ARLogging | Controls the complete AR logging function. If disabled, then no log entries are created in the E-Bonding Runbook Log Console.
| true |
Configuration Group: CustomAttributes |
|
|
Incident/BasicCIData | Configuration Custom fields | <CustomAttributes/> |
Incident/Task | Configuration Custom fields | <CustomAttributes/> |
Incident/Ticket | Configuration Custom fields | <CustomAttributes/> |
Incident/WorkInfo | Configuration Custom fields | <CustomAttributes/> |
Change/BasicCIData | Configuration Custom fields | <CustomAttributes/> |
Change/Task | Configuration Custom fields | <CustomAttributes/> |
Change/Ticket | Configuration Custom fields | <CustomAttributes/> |
Change/WorkInfo | Configuration Custom fields | <CustomAttributes/> |
Important: All Adapters have to be enabled on each Peer in the BAO Grid.
Note: An upgrade overwrites the module configuration. It's recommended to take a backup of the module configuration.
Configuration of BAO Roles and BAO Users
The following BAO roles must be created:
- BGI_AR
- BGI _AO
Afterwards the BGI_AR roles need the following execution permissions. You can grant these permissions by using the GridManager and navigate to Administration -> Permissions.
Grant execution permissions for all processes in the folder:
- View Grid Status
- VIP_BGI_Core:MessageLibrary:Outbound:ARCall
- VIP_BGI_Core:PartnerConfiguration:ARCall
The following figure shows the correct permissions:

Figure 7 BGI_AR role execution permissions
The E-BONDING RUNBOOK_AO role is used for the communication to the outbound enabler. The E-BONDING RUNBOOK_AO role needs execution permissions for all outbound enabler processes that are created with E-Bonding Runbook.
Grant permissions to the following process folder:
- View Grid Status
- VIP_BGI_Core:MessageLibrary:Inbound
Load-Balanced Multi-Grid BAO Environments
To enable E-Bonding Runbook for a load-balanced multi-grid environment you must set the value for LoadBalancedMultiGridEnvironment within the E-Bonding Runbook Core module configuration to "true".
Furthermore, ensure that each BAO Grid has a unique grid name in the E-Bonding Runbook Core configuration (see Figure 8 LBMG Environment configuration GRID1 and Figure 9 LBMG Environment configuration GRID2).

Figure 8 LBMG Environment Configuration GRID1 
Figure 9 LBMG Environment configuration GRID2
Important: Within a load-balanced multi-grid environment you have to activate and configure the adapters and modules on ALL grids that are part of the BAO cluster.
Configuration of the E-Bonding Runbook Scheduler
E-Bonding Runbook requires three BAO Schedulers for asynchronous processing of requests, retries and the recovery method. The Schedulers are deployed with the BGI_Core_Configuration module. 
Figure 10 E-Bonding Runbook Scheduler
The interval is set to "monthly" by default.
All schedulers have to be reconfigured in the customer environments.
Recommended intervals:
Name | Interval |
|---|---|
BGI Message Broker | 5 seconds |
BGI Retry Messages | 1 minute |
BGI Recovery | 1 hour |
The value can be different depending on the customer's requirements.
Important: The Schedulers have to be reconfigured on any involved BAO Grid.