Archived - How do I integrate Entuity with BMC Helix?

To send events and data from Entuity to BMC Helix, you will need to do the following:

• obtain the Helix user account API Key and the Tenant ID.
• Create the Helix custom classes that the ENA integration will use.
• Configure ENA to send data to BMC Helix.

1. Obtain the Helix user account API Key and the Tenant ID. This is used for identifying the tenant details.
   • The API Key can be retrieved from the BMC Helix server. Click Administration, and then Repository. Click Copy API Key.
     
     
     
     
   • The API Key and Tenant ID are needed for creating the Helix custom classes, and for authorizing connections from the Helix server.
2. Create the Helix custom classes that the Entuity integration will use: ENA_EV and ENA_INC. A number of custom slots are created for the Entuity data. The classes must be created before Entuity is configured to forward data, and class creation is currently undertaken using curl. Once the Helix custom classes for ENA_EV and ENA_INC exist, they do not need to be created again.
   • To create ENA_EV, run the below curl command with the actual values for the authorization identifiers LB, apiKey and tenantId, or place in a shell script and execute that.
     • Note that $tenantId is enclosed in extra inner quotes, but if you are replacing a string directly into the curl command, then only the outer double quotes are required.
     • The curl command will return a response to indicate if the class creation succeeded.
     • LB is the Helix server host name.
     • apiKey is the key that was copied from the Helix server.
     • tenantId is the tenant ID for this Helix user account.
       

       curl --insecure --header "Content-Type: application/json" --header "Authorization: apiKey $apiKey" --request POST --data '{"tenantId": "'"$tenantId"'", "name": "ENA_EV", "parentClassName": "EVENT", "attributes": [ { "name": "ENA_description", "dataType": "STRING", "default": "Unknown", "enum": false, "allFacet":[ ] }, { "name": "ENA_details", "dataType": "STRING", "default": "", "enum": false, "allFacet":[ ] }, { "name": "ENA_event_key", "dataType": "STRING", "default": "", "enum": false, "allFacet":[ ] }, { "name":"ENA_timestamp", "dataType":"DATE", "default":"0", "enum":false, "allFacet":[ ] }, { "name":"ENA_severity", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_state", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_type", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_id", "dataType":"STRING", "default":"0", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_source", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_event_source", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] } ] }' https://$LB:443/tsws/api/v1.0/events/class

   • To create the class ENA_INC, run the below curl command with the same values for authorization:

     • curl --insecure --header "Content-Type: application/json" --header "Authorization: apiKey $apiKey" --request POST --data ' { "tenantId": "'"$tenantId"'", "name": "ENA_INC", "parentClassName": "EVENT", "attributes": [ { "name":"ENA_description", "dataType": "STRING", "default": "Unknown", "enum": false, "allFacet":[ ] }, { "name":"ENA_details", "dataType": "STRING", "default": "", "enum": false, "allFacet":[ ] }, { "name":"ENA_event_key", "dataType": "STRING", "default": "", "enum": false, "allFacet":[ ] }, { "name":"ENA_timestamp", "dataType":"DATE", "default":"0", "enum":false, "allFacet":[ ] }, { "name":"ENA_severity", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_state", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_type", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_id", "dataType":"STRING", "default":"0", "enum":false, "allFacet":[ ] }, { "name":"ENA_object_source", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] }, { "name":"ENA_event_source", "dataType":"STRING", "default":"", "enum":false, "allFacet":[ ] } ] }' https://$LB:443/tsws/api/v1.0/events/class

3. Configure Entuity to send events to BMC Helix.
   1. Within the Entuity installation etc directory, locate the file Helix-example.cfg, and copy it to the file Helix.cfg (which is also in the Entuity installation etc directory).
   2. Edit the Helix.cfg file to configure the desired connection parameters. You can do this by either editing the [default] section, or creating a new section as a copy of the default one. Next you will need to complete its values (in particular, the required change to the example is to provide the name of the Helix server as the value of the host variable), and then name it in the EMS Send to BMC Helix Action parameter 'cname'
   3. To forward the content of Entuity events to Helix, you will need to navigate to the Rules tab of the Event Administration page, and create a new rule that contains the action step 'Send to BMC Helix':
      
      
      
      
      
      
       
      
      
      Edit the action step by setting the value of the apiKey parameter to that of the API Key retrieved from the Helix server:
      
      
      
      
      
      
   4. To forward the content of Entuity incidents to Helix, you will need to navigate to the Incidents tab of the Event Administration page, and create a new trigger that contains the action step 'Send to BMC Helix':
      
      
      
      
      
      
      
      As with the event process above, you will need to edit the action step by setting the value of the apiKey parameter to that of the API Key retrieved from the Helix server.