Installing the Event Orchestration run book

The TrueSight Orchestration content installation wizard automates the installation of the adapters and modules required for the run book.

Notes

The Event Orchestration runbook is only supported on TrueSight Orchestration Platform 8.1.00 and the previous BMC Atrium Orchestrator platform version 8.0.01. This is due to an issue where REST API based processes fail if process names contain spaces, which impacts this new runbook. A fix for this issue is not available for versions earlier than 8.0.01.
If you are deploying the Event Orchestration runbook onto version 8.0.01, you must replace the webservices-rt-2.2.0.jar with webservices-rt-2.4.0.jar file to ensure that the Event Orchestration run book processes are successfully executed. Updating the JAR file is required because webservices-rt v2.1 or v2.2 contains an issue that causes NullPointerException while performing Java<->XML translation while processing events as part of Event Orchestration runbook. This issue is fixed in v2.4.0.
The webservices-rt-2.4.0.jar also has features that make the runbook more extensible and allow adding new use cases with ease. It also enables a seamless upgrade of the runbook framework, without impacting any custom workflows that you choose to develop.
For downloading and updating the JAR file, see webservices-rt-2.4.0.jar on BMC Communities.
If your current TrueSight Orchestration Platform version is 8.1.00, do not make any changes to the JAR files.

This topic describes how to install the Event Orchestration run book by using the GUI or the silent installation methods.

Before you begin

Before installing the run book, ensure that the following tasks are complete:

TrueSight Infrastructure Management and BMC Remedy ITSM is installed and running.
TrueSight Orchestration Platform is installed and the peer on which you want to install the runbook is up.
Configuration Distribution Peer (CDP) is running with administrative permissions.

Perform the following steps to log on to CDP as an administrator:

1. On the server where the CDP is installed, go to the services list by running the services.msc command.
2. From the list of services running, select TrueSight Orchestration Configuration Distribution Peer service, right-click and select Properties.
3. Click the Logon tab and select This account option.
4. Click Browse and select the Administrator user account.
5. Specify the password for the account.
6. Save and restart the service.
If you current TrueSight Orchestration Platform version is 8.0.01, you must ensure that you replace the webservices-rt-2.2.0.jar with the webservices-rt-2.4.0.jar file to ensure that the Event Orchestration run book processes are successfully executed.

Perform the following steps to update the .jar file in your TrueSight Orchestration Platform

1.Download the webservices-rt-2.4.0.jar file.
To download, see webservices-rt-2.4.0.jar on BMC Communities.
2. Stop the service on the peer that is used for the Event Orchestration run book.
3. Go to the AO_HOME/tomcat/baocdp/WEB-INF/lib location and replace the webservices-rt-2.1.0.jar file with the webservices-rt-2.4.0.jar file that you downloaded.
4. Restart the service.
5. Perform steps 1 to 4 on all the peers.
TrueSight Orchestration Content installation files are downloaded from the BMC Electronic Product Download website.

Supported product versions

The following table lists the product versions for the products involved in the run book:

Product	Version
TrueSight infrastructure Management	11.0
BMC Remedy AR System	9.1.03
TrueSight Orchestration Platform	8.1.00 8.0.01 (Update required. See Before you begin)

Installing the run book

The following table describes how to install the Event Orchestration run book by using the GUI.

Installing the run book by using the GUI method
Step	Action	Screenshot
1.	Navigate to the folder where you have downloaded the installation files and start the installation program. Windows: setup.cmd Linux or Solaris: setup.sh
2.	On the Welcome to TrueSight Orchestration panel, review the information and click Next.
3.	On the license agreement panel, select I agree to the terms of the license agreement; then click Next.
4.	On the Directory Selection panel, accept the default location, or click Browse to select a different location; then click Next.
5.	On the Repository Communications Settings panel, enter the repository settings, and click Next: Web Server Protocol: Select https or http. Host Name or IP Address: Enter the fully qualified domain name of the repository. Web Server Port Number: Enter the port number where the repository is installed. Repository User: Enter the user name of the account created in Remedy Single Sign-On that you use to log on to the repository. Ensure that the repository user is not the same as the default Remedy Single Sign-On user. Repository Password: Enter the password that matches the specified user account.
6.	On the Installation Type panel, select BSM Solutions and click Next. Use the Custom feature set option to select adapters and modules based on your requirements. For example, if you use IBM Tivoli Netcool/OMNIbus as your event management tool, you can choose the IBM Tivoli Netcool/OMNIbus application adapter to receive events. Note If you choose the Custom feature set option, ensure that all adapters and modules required for the Event Orchestration run book are selected. For a complete list of adapters and modules required for the run book, Adapters and modules installed with the run book.
7.	On the Solution feature selection panel, select Event Orchestration and click Next.
8.	On the Adapter feature selection pane, the adapters to be installed as part of the solution are displayed. Click Next. The adapters that are mandatory for the run book are pre-selected. You can choose to install any more adapters that match your requirement. For more information about the adapters and modules that are installed as part of the run book, see Adapters and modules installed with the run book.
9.	On the Module feature selection pane, theAutoPilot OA modules to be installed as part of the solution are displayed. Click Next. The modules that are mandatory for the run book are pre-selected. You can choose to install any more modules that match your requirement. For more information about the adapters and modules that are installed as part of the run book, see Adapters and modules installed with the run book.
10.	On the Installation preview panel, review the features to be installed, and then click Install.
11.	When the installation finishes, click Done. The Event Orchestration run book is installed successfully and you can view the install log at the location displayed on the installer.

The following table describes how to install the Event Orchestration run book by using the command-line options.

Installing the run book by using the command-line options
Step	Action
1.	On a computer that has network access to the repository, navigate to the directory that contains the installation program
2.	From the command line, execute one of the following commands to start the installation program in silent mode. Note When you specify the options file name, specify the full path to the options file; do not specify a path that is relative to the installation program. Commands: Linux: sh setup.sh -i silent -DOPTIONS_FILE="fullPathToOptionsFile/optionsFile" Windows: windows_bao_content_installer_20_18_02\Content\Disk1\setup.cmd -i silent -DOPTIONS_FILE="fullPathToOptionsFile/optionsFile" Note Type the command carefully. If you type the command incorrectly, you might invoke an installation mode that is unsupported.

The following figure shows a sample options file for installing and configuring the Event Orchestration run book.

-P installLocation=C:\Program Files\BMC Software\Content20.18.01
-J AO_INSTALLING_FEATURES=BMC-SA-Event_Orchestration,BMC-SA-Event_Orchestration_Configuration,BMC-SA-Event_Orchestration_Service_Down,AutoPilot-OA-Credentials_Store,AO-AD-VitalQIP,AutoPilot-AD-Utilities,AutoPilot-OA-BAOGridManagement,AutoPilot-OA-Applications_Utilities,AutoPilot-OA-Common_Utilities,AutoPilot-OA-Errors,AutoPilot-OA-Directory_Services_Utilities,AutoPilot-OA-DNS_Integration,AutoPilot-OA-File_Utilities,AutoPilot-OA-Network_Utilities,AutoPilot-OA-Operating_System_Utilities,AutoPilot-OA-Physical_Device_Utilities,AutoPilot-OA-ITSM_Automation,adapter-http,adapter-rest,adapter-terminal,adapter-windows-command,adapter-ws,adapter-ars,adapter-bmc-atrium-cmdb,adapter-truesight-operations-manager,adapter-service-now
-J AO_REPOSITORY_PROTOCOL=https
-J AO_REPOSITORY_HOST=<bao-repo-host-fqdn>
-J AO_REPOSITORY_PORT=48080
-J AO_REPOSITORY_USER_NAME=aoadmin
-J AO_REPOSITORY_PASSWORD=DES\:097133405e7ea7a641f019bca8781280
-J AO_CONTENT_INSTALL_TYPE=INSTALL_TYPE_SOLUTIONS
-J INSTALL_REMEDY_ITSM_INTEGRATIONS=false
-J REMEDY_PORT_NUMBER=0
-J REMEDY_USER_NAME=<BMCRemedyITSMUserForTSO>
-J REMEDY_HOSTNAME=<BMCremedyITSM-hostname-fqdn>
-J REMEDY_PASSWORD=DES\:facfe8dfd0743920d8d901de05557886
-J ITSM_AUTHORING_COMPANY=Calbro Services
-J ITSM_AUTHORING_ORGANIZATION=IT Support
-J ITSM_AUTHORING_GROUP=Backoffice Support

Content install log file

The BAO_content_install_log file contains the logs of the content installation, which you can use for troubleshooting installation problems.

When you install an adapter that does not have a corresponding module, the content installation program writes the following warning message to the log file:

LOG EVENT {Description=[Source roar folder does not exist for this adapter],
Detail=[Not all adapters have roar files so this may or may not be an error]}

This warning message is informational and does not indicate that a problem occurred during the installation.

To troubleshoot problems that might have occurred during the installation, search for the BAO_content_install_log file for error messages.

Adapters and modules installed with the run book

Note

This list describes the artifacts required to run the Service Down event type available out-of-the-box with the Event Orchestration run book. You can choose to install any adapters and modules that match your requirement.

No artifacts for BMC Remedy ITSM are installed when you install the run book.

When you install the Event Orchestration run book, the following adapters are installed out-of-the-box:

BMC Remedy AR System
TrueSight Operations Manager actor adapter
TrueSight Operations Manager monitor adapter
Windows Command adapter
Command Line adapter
SSH adapter
Web Services adapter
REST adapter

When you install the Event Orchestration run book, the following modules are installed out-of-the-box:

AO AD BMC ProactiveNet Performance Management
AutoPilot AD Utilities
AutoPilot OA Common Utilities
AutoPilot OA Grid Management
AutoPilot OA Credentials Store
AutoPilot OA Event Orchestration
AutoPilot OA ITSM Automation
AutoPilot OA Network Utilities
Event Orchestration
Event Orchestration Configuration
Event Orchestration Service Down

Where to go from here

After installing the run book, you can now configure each of the products installed as part of the run book. For more information, see Configuring-the-Event-Orchestration-run-book.