Integrating with CA UIM

As a tenant administrator, it's important that you can monitor the connected systems and quickly identify and resolve any issues. The BMC Helix Intelligent Integrations CA UIM connector collects alarms and metrics data from CA UIM .

You can view the collected data in various BMC Helix application and derive the following benefits:

BMC Helix applicationType of data collected or viewedBenefits

BMC Helix Operations Management

Events (from CA UIM ) alarms

Use a centralized event view to monitor, filter, and manage events, and perform event operations in one place. 

Process events to help identify actionable events quickly from a large volume of event data.

For more information, see  Monitoring events and reducing event noise. Open link

BMC Helix Operations Management

Metrics

Use alarm and variate policies to detect anomalies and eliminate false positives for more accurate results while monitoring the health of your system.

For more information, see Detecting anomalies by using static and dynamic thresholds. Open link

BMC Helix AIOps

Situations (created from events)

Improve the mean time to resolve (MTTR) based on the situation-driven workflow.

Lower the mean time to detect or discover (MTTD) and the time required for investigating tickets.

For more information, see Monitoring situations. Open link

BMC Helix Dashboards

Events and metrics

Create dashboards to get a consolidated view of data collected from third-party products across your environment. 

Improve the efficiency of your system by monitoring the key performance metrics and r espond to issues quickly to minimize the down time.

For more information, see Creating custom dashboards Open link


As a tenant administrator, perform the following steps to configure a connection with CA UIM , verify the connection, and view the collected event and metric data in various BMC Helix applications.


Supported versions

This connector supports version 20.3.3 of CA UIM  for data collection:

Planning for the connection

Review the following prerequisites to help you plan and configure a connection with CA UIM.

CA UIM prerequisites

Ensure that you have the following permissions to access CA UIM REST API: 

  • Alarm Details
  • Basic Management

  • Web Service

BMC Helix Intelligent Integrations prerequisites

  • Depending on the location (SaaS, on-premises) of the third-party product, choose one or more BMC Helix Intelligent Integrations deployment modes and review the corresponding port requirements. For information about various deployment modes and port requirements, see Deployment scenarios.
  • Based on the deployment modes, use the BMC Helix Intelligent Integrations SaaS deployment or the BMC Helix Intelligent Integrations on-premises gateway or both. For more information about the gateway, see Deploying the BMC Helix Intelligent Integrations on-premises gateway.

  • The on-premises gateway must be able to reach the third-party product on the required port (default is 80).

In the preceding list, third-party product refers to CA UIM.

Configuring the connection with CA UIM

  1. Access BMC Helix Intelligent Integrations:

    • BMC Helix Intelligent Integrations SaaS – Log on to BMC Helix Portal, and click Launch on BMC Helix Intelligent Integrations.
    • BMC Helix Intelligent Integrationson-premises gateway – Use one of the following URLs to access BMC Helix Intelligent Integrations:
      • http://<hostName>:<portNumber>/swpui
      • https://<hostName>:<portNumber>/swpui
  2. On the CONNECTORS tab, click in the SOURCES panel.
  3. Click the CA UIMtile.
  4. Specify the following details for the source connection:
    1. Specify a unique instance name.

      Best practice

      We recommend that you specify the instance name in the following format: 

      <sourceType>_<sourceControllerServerName>{_<InstanceQualifier>}

      The instance qualifier helps you to distinguish the multiple instances configured from the same source server. For example, you can name your instances as CAUIM_Host_PROD, CAUIM_Host_TEST, and so on.

    2. Specify the CA UIM host name.
    3. Specify the CA UIM HTTP or HTTPS port number depending on the connection protocol (default port number is 80).
    4. Select the HTTPS option to use an https connection to the CA UIM host.
    5. Enter the user name and password for the CA UIM host.
    6. Specify the time, in seconds, after which no attempt should be made to establish the connection (default value is 30 seconds).
    7. Click Proxy and specify whether you want to configure a proxy server.
      If yes, specify the host name and port number (default value is 8888).
  5. Click VALIDATE AND CREATE.
    The specified connection details are validated and the corresponding source connection is created in the Source Connection list.
  6. Select the source connection that you created from the list if it is not selected already.

    Important

    The destination host connection is created and configured automatically when the source connection is created.


  7. Ensure that the options for the datatypes for which you want to collect data are selected.
  8. Configure the collectors for the selected data types by clicking the respective data type in the Collectors section. Specify the parameters for the selected data type, as explained in the following table:

    Note: The (tick)  symbol indicates that this field is applicable to the data type.

    Parameter name and descriptionData Type

    CA UIM Alarms

    CA UIM Metrics

    Collection Schedule

    Specify the data collection frequency using one of the following methods:

    • Constantly by specifying the schedule in minutes, hours, or day using the Duration option
      Default: 5 minutes

      Example:
      Collection Schedule
       is set to 5 mins. 
      Current time is 00:30.

      If you run the collector just after 00:30, data is collected every 5 mins, first at 00:30 and next at 00:35, and so on.  

    • Periodically by specifying the schedule through a cron expression using the Cron schedule option 

      A cron expression is a string consisting of five subexpressions (fields) that describe individual details of the schedule.  These fields, separated by white spaces, can contain any of the allowed values with various combinations of the allowed characters for that field.
      Default: */5 * * * * (evaluates to 5 minutes)

      Format:

      Minutes Hours (24-hour format) Day of Month Month Day of Week

      Example:

      If you specify 10 15 3 7 *, data is collected at 15:10 hours every third day in the month of July.

    For more information about how this parameter affects data collection, see Data collection schedule.

    (tick)

    (tick) 

    Data Collection Window

    Specify the historical time period (in minutes) from the current time for which the data should be collected. 

    Default: 5 minutes

    Example:

    Collection Schedule is set to 5 mins.
    Data Collection Window is set to 5 mins.
    Current time is 00:30.

    If you run the collector just after 00:30, data is collected first at 00:30 for the interval, 00:25 - 00:30, and next at 00:35 for the interval, 00:30 - 00:35, and so on.

    For more information about this parameter, see Data collection window .

    (tick)


    (error)


    Severities

    Select one or more severities from the list. 

    This list is automatically updated from CA UIM.

    (tick)

    (error)

    Devices

    Select one or more devices from the list. 

    This list is automatically updated from CA UIM.

    (error)

    (tick)

    Probes

    Select one or more probes from the list. 

    This list is automatically updated from CA UIM.

    (error)

    (tick)

    Metrics

    Select one or more metrics from the list that you want to collect

    This list is automatically updated from CA UIM.

    (error)

    (tick)

  9. Click CREATE COLLECTORS to create the required collector streams for the selected data types.

  10. Configure the distributors for the selected data types by clicking the respective data type in the Distributors section.
    Specify the parameters for the selected data type, as explained in the following table:

    Parameter name and description

    Max Batching Size

    Specify the maximum number of data items to send in a single POST request to the destination API.
    The batch size
    depends on the destination’s ability to buffer the incoming data.

    Default: 250

    Max Batching Delay

    Specify the maximum time (in seconds) to wait before building a batch and processing.

    Default: 3 seconds 

    Base Retry Delay

    Specify the initial time (in seconds) for which to wait before retrying to build a batch and processing.
    The waiting time increases in the following sequence: n1, n2, n3, and so on, where n indicates the number of seconds.

    Default: 2 seconds

    Example:

    Base Retry Delay is set to 2 seconds.

    Retry is performed after 2, 4, 8, 16, ... seconds.

    Max Intra-Retry Delay

    Specify the maximum limit for the base retry delay. 

    Default: 60 seconds

    Example:

    Max Intra-Retry Delay is set to 60 seconds.
    Base Retry Delay is set to 2 seconds.

    Retries are performed 2, 4, 8, 16, 32, 64,... seconds later again.

    Max Retry Duration

    Specify the total time for retrying a delivery. For REST destinations, a delivery is a batch of data items in one POST request. 

    Default: 5 minutes

    Example:

    Max Retry Duration is set to 8 hours.
    Base Retry Delay is set to 2 seconds.

    Requests are sent for 2+4+8+16+32+64+132... until 8 hours in total duration is reached. After that, no subsequent attempts are made to retry the delivery.

    The assumption here is that if there is an outage or other issue with the destination tool, recovery should take less than the value of the Max Retry Duration parameter to be completed.


  11. Click CREATE DISTRIBUTORS to create the required distributor streams for the selected data types.
  12. Click one of the following buttons:
    • SAVE STREAM : Click this button if you want to edit the integration details before creating the instance. After you save the stream, the connector that you just created is listed in the SOURCES panel. Move the slider to the right to start the data stream.
    • SAVE AND START STREAM : Click this button if you want to save the integration details and start receiving data immediately.

          For more information about the data streams, see Starting or stopping data streams.


Verifying the connection

From BMC Helix Intelligent Integrations , on the SOURCES panel, confirm that the data streams for the connection you created are running. Data streaming is indicated by moving colored arrows.

  • A moving blue arrow ( ) indicates that the event stream is running. Event data will be pushed according to the configured Collection Schedule interval.
  • A moving red arrow ( ) indicates that the metric stream is running. Metric data will be pushed according to the configured Collection Schedule interval.

Viewing data in BMC Helix applications

View data collected from CA UIM in multiple BMC Helix applications.

Important

If the event or metric data is ingested by using BMC Helix Intelligent Integrations, and the topology data is ingested through some other means, all the use cases in BMC Helix AIOps might not work as expected because the external IDs generated by BMC Helix Intelligent Integrations and BMC Helix Discovery differ. In addition, host name might differ in both the products. 

To view events in BMC Helix Operations Management

  1. In BMC Helix Operations Management, select Monitoring > Events.
  2. Filter the events by the CA_UIM_Alarm class.

Incoming events from CA UIM are processed in BMC Helix Operations Management through a set of deduplication rules to determine whether the incoming event is a duplicate event or a new event. For more information, see Event deduplication and suppression for reducing event noise.

For more information about events, see Monitoring and managing events. Open link

To view metrics in BMC Helix Operations Management

  1. In BMC Helix Operations Management, select Monitoring > Devices.
  2. Click the links for the required device.
  3. On the Monitors tab, click the required monitor.
    The Performance Overview tab shows the metrics graph.


For information about metrics, see Viewing collected data. Open link

Viewing Situations in BMC Helix AIOps

Before you view situations in BMC Helix AIOps, ensure that the following prerequisites are met: 

  1. CIs are present in BMC Helix Discovery or BMC Helix AIOps for the events that are being collected from CA UIM .
  2. Create a Business Service model in one of the following applications:
    • BMC Helix Discovery. For more information, see Managing models. Open link
    • BMC Helix AIOps. For more information, see Modeling services. Open link  
  3. Perform one of the following tasks:
    • To view ML-based situations, the AIOps Situations feature is enabled in BMC Helix AIOps. For more information, see Enabling the AIOps features. Open link
    • To view policy-based situations, the correlation policy is created in BMC Helix Operations Management. For more information, see Creating and enabling event policies. Open link

To view Situations

  1. In BMC Helix AIOps , go to the Situations page.
    This page shows the Situations created from the events that are ingested into BMC Helix Operations Management
  2. Click the required Situation to view the messages contained in the Situation and other details such as priority and severity of the message. 

For information about Situations, see Monitoring situations. Open link

Mapping between CA UIM and BMC Helix Operations Management

The following table shows the mapping between CA UIM and BMC Helix Operations Management:

Event attributeCA UIMBMC Helix Operations Management
StatusClosedClosed
OpenOpen
SeverityCriticalCritical
InfoInfo
Minor Minor
MajorMajor
WarningWarning
TitleTitleMessage
Was this page helpful? Yes No Submitting... Thank you

Comments