Configuring the Event Orchestration Configuration module


The Event Orchestration Configuration module contains configuration data for the event management tool and ITSM system. For the out-of-the-box Service Down event, you must configure the TrueSight Infrastructure Management and BMC Remedy ITSM details in the module. 

Note

Values enclosed in { } are variables, that you must change based on your requirements.

For example, if the EventSourceType is BMC_TrueSight, then to access the configuration item EventType follows path Specifics->BMC_TrueSight→EventTypes.

It is important to note that while adding new event types, the structure of the event type configuration item group and the access path maintains the same format.

The following table describes the configuration items and values that you can specify for the Event Orchestration Configuration module. 

Configuration group/item

Configuration item

Description

General

EventSourceType

Specifies the name of the event management tool from which the event is generated. You must update the EventSourceType based on your environment.

EventSourceType is a high-level configuration item. Connection details and other information about the event source system appears in the Specifics configuration group.

Default value: BMC_TrueSight

ITSMType

Specifies the ITSM application to be used to create incidents, change, or tasks for an event.

Specifies the high-level configuration item. Connection details and other information about the event source system appears in the Specifics configuration group.

Default value: BMC_AR_System

Specifics > BMC_TrueSight > EventTypes > ServiceDown








{EventType}

Specifies the event type generated in the event.

By default, EventTypes contains the configuration items for the Service Down event type, which is supported out-of-the-box.

Important

Currently, the Event Orchestration run book only supports the Service Down event type out-of-the-box.

When you want to add more event types to be used by the run book, add new configuration items and configure the event types in the module configuration.

IncidentEnabled

Specifies whether to create an incident in the BMC Remedy ITSM system when the event is reported.

Valid values: true (default), false

ChangeEnabled

Specifies whether to create a change in the BMC Remedy ITSM system when the event is reported. If false, change and task tickets are not created for events.

Set to false if:

  •  event is not associated with a CI
  • remediation does not require a change approval process.

Set to true if:

  • the event is associated with a CI
  • remediation process involves change in the CI's configuration
  • change approval process is required

Default value: true (default), false

ChangeTemplateName

Specifies the name of the change template (in BMC Remedy Change Management application) based on which a change will be created for an event.

You can use any existing change template in your BMC Remedy ITSM environment that matches your criteria.

Sample value: EventOrchestration_ServiceDown_ChangeTemplate

RemediationEnabled

Specifies whether to perform remediation for an event. If false, only triage is performed and remediation and verification actions are skipped.

Default value: true

IsITSMDataCustom

Default value: true

IncidentIDFieldName

Default value: itsm-incident-id

ChangeIDFieldName

Default value: itsm-change-id

TaskIDFieldName

Default value: itsm-task-id

ChangeType

Specifies whether the change created for the event needs approval. By default, a change ticket that does not need approval is created in BMC Remedy ITSM.

Default value: normal

Specifics > Adapters






EventActorAdapter

Specifies the name of the actor adapter, which updates the notes in the event management tool. If your event management tool is TrueSight Infrastructure Management, specify the TrueSight Operations Manager adapter.

Default value: TruesightActor

Note

Ensure that the name of the adapter matches the adapter configured on the grid.

For more information, see Configuring-TrueSight-Orchestration-adapters.

RESTAdapter

Specifies the name of the adapter, which is used to make REST API web service calls to the target application. The REST adapter is used to invoke triage and remediation workflows in TrueSight Orchestration.

Ensure that the name of the adapter matches the adapter configured on the grid.

Default value: RESTAdapter

ITSMActorAdapter

Specifies the name of the adapter, which uses non-web service calls to communicate with the ITSM application. This adapter invokes BMC Remedy AR System.

Default value: ARSAdapter

WindowsCommandAdapter

Specifies the name of the adapter, which contains commands that perform triage and remediation actions on a target host running on a Windows operating system.

Note

You must configure and enable the Windows Command adapter on a TrueSight Orchestration peer running on Windows OS only. In addition, ensure that the Windows Command adapter is enabled on a peer with administrative privileges.

Default value: WindowsCommandAdapter

SSHAdapter

Specifies the name of the adapter, which performs triage and remediation actions on a target host running on a UNIX operating system.

Default value: SSHAdapter

ITSMWebServiceAdapter

Specifies the name of the adapter, which uses the web service calls to communicated with the ITSM application.

Default value: SOAPAdapter

Specifics > BAO

URL

Specifies the URL to the TrueSight Orchestration Configuration Distribution Peer (CDP) in an FQDN format, where the modules required for the Event Orchestration run book are activated.

Sample URL format: https://FullyQualifiedDomainName:CDPWebServerPort/baocdp

UserName

Specifies the user name required to log on to the TrueSight Orchestration CDP.

Password

Specifies the password that matches the username.

Specifics > BMC_AR_System > WebServiceConnectionData



URL

Specifies the URL to the target BMC Remedy ITSM system. The ITSM type is defined in the General > ITSMType configuration item.

UserName

Specifies the username required to log on to the BMC Remedy ITSM system to invoke web service requests.

Password

Specifies the password that matches the username, in a secure format.

Specifics > BMC_AR_System > ChangeManagementDefaults

ReportedSource

Specifies the value to be updated in the CHG:Infrastructure Change form when a change ticket is created for the event.

The value in this field is used to query approved change tickets that is specific to Event Orchestration solution.

Default value: EventOrchestration

Specifics > BMC_AR_System > IncidentManagementDefaults

IncidentType

Specifies the type of incident to be created in BMC Remedy ITSM for an event.

Default value: Infrastructure Event


DefaultIncidentStatus

Specifies the status to be assigned when an incident is created.

Default value: Assigned


DefaultServiceType

Specifies the service type to be assigned when an incident is created.

Default value: Infrastructure Event


DefaultImpact

Specifies the impact to be assigned when an incident is created.

Default value: 3-Moderate/Limited


DefaultUrgency

Specifies the impact to be assigned when an incident is created.

Default value: 3-Medium


ReportedSource

Specifies the reported source of the event when an incident is created

Default value: Event Orchestration


StatusReason

Specifies the status reason to be assigned when an incident is created.

Default value: Infrastructure Change


WorkInfoType

Specifies the default value for the WorkInfoType to be assigned when an incident is created.

Default value: General Information


WorkInfoSource

Specifies the default value for the WorkInfoSource to be assigned when an incident is created.

Default value: BMC TrueSight Event


WorkInfoLocked

Specifies the default value to be added to the workInfo source to be assigned when an incident is created.

Default value: No


WorkInfoViewAccess

Specifies the default value to be added to the WorkInfoViewAccess field of the incident ticket's WorkInfo record when a WorkInfo is created.

Default value: Public


AssignedSupportCompany

Specifies the default value for the Contact Company field when an incident is created.

Default value: Calbro Services


AssignedSupportOrganization

Specifies the default value for the Support Organization field when an incident is created.

Default value: IT Support


AssignedGroup

Specifies the default value for the Assigned Group field when an incident is created.

Default value: Service Desk


Assignee

Specifies the default value for the Contact Company field when an incident is created.

Default value: Allen Allbrook

Specifics > BMC_AR_System > Mappings


Contains the mapping for each of the configuration item:

Urgency mappings
<mappings>
 <mapping key="Critical">1-Critical</mapping>
 <mapping key="High">2-High</mapping>
 <mapping key="Medium">3-Medium</mapping>
 <mapping key="Low">4-Low</mapping>
</mappings>
ChangeTimings
<change-timings>
 <pre-approved>Emergency</pre-approved>
 <normal>Normal</normal>
</change-timings>
StatusMappings
<status-mappings>
 <mapping name="New" type="string">0</mapping>
 <mapping name="Assigned" type="string">1</mapping>
 <mapping name="In Progress" type="string">2</mapping>
 <mapping name="Pending" type="string">3</mapping>
 <mapping name="Resolved" type="string">4</mapping>
 <mapping name="Closed" type="string">5</mapping>
 <mapping name="Cancelled" type="string">6</mapping>
</status-mappings>
StatusReasonMappings
<status-reason-mappings>
 <mapping name="Infrastructure Change Created" type="string">1000</mapping>
 <mapping name="Local Site Action Required" type="string">2000</mapping>
 <mapping name="Purchase Order Approval" type="string">3000</mapping>
 <mapping name="Registration Approval" type="string">4000</mapping>
 <mapping name="Supplier Delivery" type="string">5000</mapping>
 <mapping name="Support Contact Hold" type="string">6000</mapping>
 <mapping name="Third Party Vendor Action Reqd" type="string">7000</mapping>
 <mapping name="Client Action Required" type="string">8000</mapping>
 <mapping name="Infrastructure Change" type="string">9000</mapping>
 <mapping name="Request" type="string">10000</mapping>
 <mapping name="Future Enhancement" type="string">11000</mapping>
 <mapping name="Pending Original Incident" type="string">12000</mapping>
 <mapping name="Client Hold" type="string">13000</mapping>
 <mapping name="Monitoring Incident" type="string">14000</mapping>
 <mapping name="Customer Follow-Up Required" type="string">15000</mapping>
 <mapping name="Temporary Corrective Action" type="string">16000</mapping>
 <mapping name="No Further Action Required" type="string">17000</mapping>
 <mapping name="Resolved by Original Incident" type="string">18000</mapping>
 <mapping name="Automated Resolution Reported" type="string">19000</mapping>
 <mapping name="No longer a Causal CI" type="string">20000</mapping>
 <mapping name="Pending Causal Incident Resolution" type="string">21000</mapping>
 <mapping name="Resolved by Causal Incident" type="string">22000</mapping>
</status-reason-mappings>
WorkInfoTypeMappings
<workinfo-type-mappings>
 <mapping name="Customer Communication" type="string" version="default">2000</mapping>
 <mapping name="Customer Follow-up" type="string" version="default">3000</mapping>
 <mapping name="Customer Status Update" type="string" version="default">4000</mapping>
 <mapping name="Closure Follow Up" type="string" version="default">6000</mapping>
 <mapping name="Detail Clarification" type="string" version="default">7000</mapping>
 <mapping name="General Information" type="string" version="default">8000</mapping>
 <mapping name="Resolution Communications" type="string" version="default">9000</mapping>
 <mapping name="Satisfaction Survey" type="string" version="default">10000</mapping>
 <mapping name="Status Update" type="string" version="default">11000</mapping>
 <mapping name="Incident Task / Action" type="string" version="default">13000</mapping>
 <mapping name="Problem Script" type="string" version="default">14000</mapping>
 <mapping name="Working Log" type="string" version="default">15000</mapping>
 <mapping name="Email System" type="string" version="default">16000</mapping>
 <mapping name="Paging System" type="string" version="default">17000</mapping>
 <mapping name="BMC Impact Manager Update" type="string" version="default">18000</mapping>
 <mapping name="Chat" type="string" version="default">35000</mapping>
 <mapping name="Vendor Communication" type="string">37000</mapping>
</workinfo-type-mappings>
WorkInfoSecureLogMappings
<workinfo-securelog-mappings>
 <mapping name="Yes" type="string">0</mapping>
 <mapping name="No" type="string">1</mapping>
</workinfo-securelog-mappings>
WorkInfoViewAccessMappings
<workinfo-viewaccess-mappings>
 <mapping name="Internal" type="string">0</mapping>
 <mapping name="Public" type="string">1</mapping>
</workinfo-viewaccess-mappings>

Specifics > BMC_AR_System > Templates

Templates

Contains a list of templates to be used based on the event type. 

ChangeTemplates
<templates>
 <template eventType="Default">Event Orchestration Change Template</template>
 <template eventType="OSDiskSpaceFull">Event Orchestration Default OS Disk Full Template</template>
 <template eventType="ESXHostNotResponding">Event Orchestration Default ESX Host Not Responding Template</template>
 <template eventType="ServerDown">Event Orchestration Default Server Down Template</template>
 <template eventType="ServiceDown">Event Orchestration Default Service Down Template</template>
 <template eventType="DBTablespaceFull">Event Orchestration Default DB Tablespace Full Template</template>
 <template eventType="FailedBackupRecovery">Event Orchestration Default Failed Backup Recovery Template</template>
 <template eventType="PatrolAgentDown">Event Orchestration Default Patrol Down Template</template>
</templates>

Specifics > BMC_AR_System

TSMLocaleLanguage

Specifies the Locale Language of the Event Source Type.

Specifics > BMC_AR_System

TSMLocaleCountry

Specifies the Locale Country of the Event Source Type.

Specifics > BMC_AR_System

ITSMTimeZone

Specifies the timezone (standard Java timezones) where ITSM application is running.

This field is used to determine the EPOCH time. EPOCH time is used queries to retrieve approved tasks by scheduled dates.

For example, Asia/Kolkata or Europe/Paris.

Specifics > WorkflowDefinitions

CommonWorkflows

Contains the workflow definitions for all the common workflows, which are used to invoke the remediation actions in an asynchronous manner.

CommonWorkflowsDefinition
<workflows>
 <workflow action="UpdateEventNotes">:BMC-SA-Event_Orchestration:Event_Integration:Update Event Notes Local</workflow>
 <workflow action="CreateIncident">:AutoPilot-OA-ITSM_Automation:Incident_Management:Process Incident</workflow>
 <workflow action="CreateChange">:AutoPilot-OA-ITSM_Automation:Change_Management:Process Change</workflow>
 <workflow action="GetUnassignedApprovedTasks">:AutoPilot-OA-ITSM_Automation:Task_Management:Get Unassigned Approved Tasks</workflow>
 <workflow action="GetTaskById">:AutoPilot-OA-ITSM_Automation:Task_Management:Do Get Task</workflow>
 <workflow action="UpdateTaskJobID">:AutoPilot-OA-ITSM_Automation:Task_Management:Update Task Job ID</workflow>
 <workflow action="CloseTask">:AutoPilot-OA-ITSM_Automation:Change_Management:Do Update</workflow>
 <workflow action="CloseIncident">:AutoPilot-OA-ITSM_Automation:Incident_Management:Update Incident Status</workflow>
 <workflow action="PerformRemediationOnTaskApproval">:BMC-SA-Event_Orchestration:Remediate:Perform Remediation on Task Approval</workflow>
 <workflow action="AssociateChangeAndIncident">:AutoPilot-OA-ITSM_Automation:Associations:Process Change and Incident Association</workflow>
 <!--
 <workflow action="AddTaskNotes">:BMC-OA-Event_Orchestration:ITSM:Update Task Notes</workflow>
 <workflow action="AddChangeStatus">:BMC-OA-Event_Orchestration:ITSM:Update Change Status</workflow>
 <workflow action="AddIncidentStatus">:BMC-OA-Event_Orchestration:ITSM:Update Incident Status</workflow>
 <workflow action="AddTaskStatus">:BMC-OA-Event_Orchestration:ITSM:Update Task Status</workflow>
-->
</workflows>

WorkflowsByEventType

Contains the workflows by event types, which are used to invoke triage, remediation and verification workflows via REST APIs.

You can update the list of workflows to add more workflow names as new event types are added to solution.

WorkflowsByEventType
<workflows>
 <workflow eventType="ServiceDown" action="triage">:BMC-SA-Event_Orchestration_Service_Down:Perform Triage</workflow>
 <workflow eventType="ServiceDown" action="remediate">:BMC-SA-Event_Orchestration_Service_Down:Perform Remediation</workflow>
 <workflow eventType="ServiceDown" action="validation">:BMC-SA-Event_Orchestration_Service_Down:Perform Validation</workflow>
</workflows>

Where to go from here

After successfully configuring the Event Orchestration Configuration module, you can now configure the Credentials Store Management module for storing the credentials to be used in the run book. For more information, see Configuring-the-Credentials-Store-module

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*