Configuring BMC-SA-Event_Orchestration_Configuration module
This topic describes the steps to configure the BMC-SA-Event_Orchestration_Configuration module and lists the configuration items included in the module.
Use this topic to understand the module configuration items and the configuration items that you must update to use the runbook. See the Update required column to understand whether to update the values.
To configure BMC-SA-Event_Orchestration_Configuration module
This module contains data for the event management tool and the IT Service Management system. For the out-of-the-box actions, you must configure the connection details for the endpoint systems.
- On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Configuration module.
- Expand the configuration tree until you can navigate to the configuration item that you want to modify.
- Click the configuration item that you want to modify, edit the value, and click OK to save changes.
- After successfully configuring the module, click the Modules tab and from the Modules in Repository list, select the module and click Activate. Module with the updated changes is successfully activated on the grid.
General configuration items
Contains configuration items for specifying the event source and the IT Service Management system.
Configuration item | Description | Update required? | Valid values |
|---|---|---|---|
EventSourceType | Specifies the name of the event management tool from which the event is generated. | No | BMC_TrueSight |
ITSMType | Specifies the ITSM application to be used to create incidents, change, or tasks for an event. | No | BMC_AR_System |
Specifics > Adapters configuration items
Specifies the adapter names for the adapters configured and enabled on the TrueSight Orchestration grid.
Configuration item | Description | Update required? |
|---|---|---|
Adapter_Invocation_Mechanism_Mappings | Contains mappings to map adapter invocation mechanism (used by AD Utilities and Common Utilities workflows) to adapter names. This enables change in adapter names but no need to change workflow logic, in dependent modules like Credentials Store. | No |
CommandLineAdapter | Specifies the name of the command line adapter that is used to invoke shell commands on the local server. | Yes |
ITSMActorAdapter | Specifies the name of the BMC Remedy AR System actor adapter. The adapter is used to invoke actions in BMC Remedy AR System. | Yes |
ITSMWebServiceAdapter | Specifies the name of the web services adapter. The adapter is used to invoke SOAP based actions to Remedy AR System for creating and updating change requests. If any action is not supported by the Web Services adapter, the BMC Remedy AR System adapter is used. | Yes |
RESTAdapter | Specifies the name of the REST adapter used for invoking REST API requests to TrueSight Orchestration and TrueSight Presentation Server targets. | Yes |
SSHAdapter | Specifies the name of the SSH adapter used to invoke UNIX commands, such as accessing remote UNIX machines to perform remediation actions. | Yes |
WindowsCommandAdapter | Specifies the name of the Windows Command adapter used to invoke remote Windows commands from a Windows server. | Yes |
WindowsPowerShellAdapter | Specifies the name of the PowerShell adapter used to invoke commands. | Yes |
Specifics > BAO configuration items
Specifies the connection details to connect to the TrueSight Orchestration peer.
Configuration item | Description | Update required? | Default values |
|---|---|---|---|
URL | Specifies the URL to the configuration distribution peer where the modules required for the use case are enabled. For example, specify the host name and port of the Configuration Distribution Peer (CDP), where you have activated the BMC-SA-Event_Orchestration_Service_Down module. Example: https://hostname:port/baocdp | Yes | - |
Username | Specifies the username required to log on to the CDP. | Yes | aoadmin |
Password | Specifies the password that matches the CDP. | Yes | - |
Specifics > BMC_AR_System configuration items
Contains the connection details and default values that get updated in the incident in BMC Remedy ITSM.
Configuration item | Description | Update required? | Default values |
|---|---|---|---|
WebServiceConnectionData | Contains connection data used to invoke SOAP requests to AR Server via the mid-tier | ||
Change_CreateInterface | Specifies the ITSM form name used to create change and tasks in BMC Remedy ITSM. | No | CHG_ChangeServiceInterface |
Change_CreateSOAPAction | Specifies the SOAP action URI used to create in Change management management application | No | urn:CHG_ChangeServiceInterface/ |
Change_GetSOAPAction | Specifies the ITSM form name used to retrieve change and task tickets information from Remedy ITSM | No | CHG_ChangeOutboundInterface |
Incident_CreateInterface | Specifies the ITSM form name used to create incident tickets in Remedy ITSM | No | HPD_IncidentServiceInterface |
Incident_UpdateInterface | Specifies the ITSM form name used to update incidents in Remedy ITSM | No | HPD_IncidentServiceInterface |
URL | Specifies the BMC AR System or BMC Helix mid-tier URL. | Yes | - |
New in 20.19.02RestURL | Specifies the URL used to access the REST API endpoint for BMC Helix Remedy ITSM. | Yes | - |
Username | Specifies the username required to log on to the URL. | Yes | Orchestrator |
Password | Specifies the password that matches the username, in a secure format. | Yes | |
Change Management Defaults | Contains default values used while interacting with BMC Remedy ITSM Change Management application | ||
ReportedSource | Specifies the value that appears in the Reported source field for a change request in BMC Remedy ITSM. | No | EventOrchestration |
IncidentManagementDefaults | Contains default values used in the incidents created in BMC Remedy Incident Management | ||
AssignedGroup | Specifies the default value for the Assigned Group field when an incident is created. | Yes | Service Desk |
AssignedSupportCompany | Specifies the default value for the Contact Company field when an incident is created. | Yes | Calbro Services |
AssignedSupportOrganization | Specifies the default value for the Support Organization field when an incident is created. | Yes | IT Support |
Assignee | Specifies the default value for the Contact Company field when an incident is created. | Yes | Allen Allbrook |
DefaultImpact | Specifies the impact to be assigned when an incident is created. | No | 3-Moderate/Limited |
DefaultIncidentStatus | Specifies the status to be assigned when an incident is created. | No | Assigned |
DefaultServiceType | Specifies the service type to be assigned when an incident is created. | No | Infrastructure Event |
DefaultUrgency | Specifies the urgency to be assigned when an incident is created. | No | 3-Medium |
EventIncidentAssociationMaxPollCount | Specifies the default value for the Event Incident Association Max Poll Count field | No | 3 |
EventIncidentAssociationPollIntervalSecs | Specifies the default value for the Event Incident Association Poll Interval Secs field | No | 30 |
EventSourceIntegrationEnabled | Specifies the default value for the Event Source Integration Enabled field | No | true |
IncidentType | Specifies the type of incident to be created in BMC Remedy ITSM for an event. | No | Infrastructure Event |
ReportedSource | Specifies the reported source of the event when an incident is created. | No | Event Orchestration |
StatusReason | Specifies the status reason to be assigned when an incident is created. | No | Infrastructure Change |
WorkInfoLocked | Specifies the default value to be added to the workInfo source to be assigned when an incident is created. | No | No |
WorkInfoSource | Specifies the default value for the WorkInfoSource to be assigned when an incident is created. | No | BMC TrueSight Event |
WorkInfoType | Specifies the default value for the WorkInfoType to be assigned when an incident is created. | No | General Information |
WorkInfoViewAccess | Specifies the default value to be added to the WorkInfoViewAccess field of the incidents WorkInfo record when a WorkInfo is created. | No | Public |
Mappings | Contains enumerations defined in BMC Remedy ITSM server. If your environment requires any changes, you may update the values. | ||
ChangeClassMappings | No | ||
ChangeTimings | No | ||
ImpactMappings | No | ||
StatusMappings | No | ||
StatusReasonMappings | No | ||
UrgencyMappings | No | ||
WorkInfoSecureLogMappings | No | ||
WorkInfoTypeMappings | No | ||
WorkInfoViewAccessMappings | No | ||
BMC_AR_System | |||
ITSMLocaleLanguage | Specifies the Locale Language of the Event Source Type | No | default |
ITSMLocaleCountry | Specifies the Locale Country of the Event Source Type. | No | default |
ITSMTimeZone | Specifies the timezone (standard Java time zones) 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. | No | Asia/Kolkata |
Specifics > BMC_TrueSight configuration items
Contains the connection details and mappings for TrueSight Presentation Server.
Configuration item | Description | Update required? | Default values |
|---|---|---|---|
EventSourceDefaults> IncidentIntegrationEnabled | Specifies whether BMC Service Resolution is implemented at the event source. Valid values: true (default), false If true, it is assumed that BMC Service Resolution integration is enabled at the event source, and TrueSight Infrastructure Management is creating incidents for events and TrueSight Orchestration does not create or update incidents. If false, BMC Service Resolution is not integrated. | Custom; specify false if not using BMC Service Resolution to create incidents | true |
EventTypes > HostDown | Contains configuration information related to all supported event types | ||
HostDown > Configurations | Contains the configuration for the Host Down use case. An event type can support more than one configuration based on the type of actions. Each configuration has the following parameters:
| Custom; required if customizing for your requirements | |
HostDown > ModuleName | Specifies the module name that contains the workflow processes for the Host Down event. | No | :BMC-SA-Event_Orchestration_Host_Down |
EventTypes > ServiceDownViaTSSA | Contains configuration information required if you want to restart services using TrueSight Server Automation. Applicable only for 20-19-02-003-Patch-3-for-version-20-19-02 and later. | ||
ServiceDownViaTSSA >Configurations | Contains the configurations for all the services supported with TrueSight Server Automation. New in 20.19.02.003Each configuration has the following parameters:
| Conditional; required if using TrueSight Server Automation to restart services. | |
ServiceDownViaTSSA >ModuleName | Specifies the module name that contains the workflow processes for the Service Down event to be remediated using TrueSight Server Automation. | Conditional; required if using TrueSight Server Automation to restart services. | :BMC-SA-Event_Orchestration_Service_Down_Via_TSSA |
EventTypes > ServiceDown | Contains configuration information related to all supported event types | ||
ServiceDown > Configurations | Contains the configurations for the out-of-the-box service down use case. New in 20.19.02The following services are included:
Each configuration has the following parameters:
| Custom; required if customizing for your requirements | |
ServiceDown > ModuleName | Specifies the module name that contains the workflow processes for the Service Down event. | Custom; required if customizing for your requirements | :BMC-SA-Event_Orchestration_Service_Down |
Mappings | Used to convert input event data into common event model | ||
EventMappings | Contains the mappings used to convert the event data into a common event model. | No | |
WebServiceConnectionData | Contains the connections details to connect to TrueSight Presentation Server | ||
BASE_URL | Specifies the URL to the TrueSight Presentation Server or a load balancer server, if used. | Yes | |
EVENT_URI | This will be appended to BASE_URL to create a related event in the TrueSight Presentation Server. | No | /CI/-1/event |
LOGIN_URI | This will be appended to BASE_URL to invoke login request with the TrueSight Presentation Server. | No | /authenticate/login |
Tenant | Specifies the realm in Remedy SSO used by the TrueSight Presentation Server. | Yes | * |
Username | Specifies the username in the TrueSight Presentation Server with super admin privileges and application administration roles. | Yes | |
Password | Specifies the password, in an encrypted format, to log on to TrueSight Presentation Server. | Yes | - |
Specifics > Defaults configuration items
Configuration item | Description | Update required? | Default values |
|---|---|---|---|
BypassEventNotes | Used to bypass updating event source update. | No | false |
NotfoundWorkflowName | Specifies the default value returned by the logic when required workflow is not found | No | NOT_FOUND |
RunSchedules | Used to turn of polling for task tickets. Used for debug purposes only. | No | true |
SupportedActionsDelimiter | Used to form action ID string used by TrueSight Presentation Server | No | - |
RESTRequestTimeout | Default timeout, in seconds, for REST adapter connection timeout and socket connection timeout. | Custom; update if the request takes longer to complete | 900 |
New in 20.19.02CloseIncident | If you specify None, incident status is not updated after the remediation is successful. If you specify Close, incident status is set to Closed after the remediation is successful. If you specify Resolve, incident status is set to Resolved. | No | Resolve |
New in 20.19.02ComponentType | Sets the operating system type if the event data does not provide the information about the target operating system. | No | unix |
New in 20.19.02UseRemedyJavaAPI | By default, the value is false. Uses the REST API exposed by the Jetty server. Specify true if you want to use the BMC Remedy Java API, using BMC Remedy AR System adapter. | No | false |
Specifics > Workflow Definitions configuration items
Configuration item | Description | Update required? | Default values |
|---|---|---|---|
CommonWorkflows | Contains the names of the workflows invoked when using the REST API requests | No | <workflows> <workflow action="PerformRemediationOnTaskApproval">:BMC-SA-Event_Orchestration:Remediate:Perform Remediation on Task Approval</workflow> </workflows> |