Creating automation policies

Automation engineers or developers create automation policies for a requested event by using a new event JSON, or for existing events saved in the database. Automation policies contain actions that connect with the automation applications supported by BMC Helix Intelligent Automation to perform remediation actions for events. A policy executes only if it is in a published state. You can also create a change request in BMC Helix ITSM as part of the policy execution.

To create an automation policy

Perform the following steps to create an automation policy.

Step 1: To provide the policy information and specify the execution mode

In the BMC Helix Intelligent Automation console, go to Policies and click Create Automation Policy.
In the Policy Information section, enter a unique name and an optional description for the policy.
Select the execution mode as Manual or Automatic depending upon whether you want to execute the policy manually or automatically based on the incoming events.
Can I change the execution mode later?
Yes, you can edit the policy and change the mode anytime.

Create policy step 1.png

Step 2: To define the trigger condition to match the incoming event

In the Trigger section, click Browse, and do one of the following:
- From the Select Event Type tab, select an existing event type and click Done.
  The trigger condition from the event is listed in the following format: <eventCategory>: <eventName>.
  Why don't I see any existing event types to choose from?
  has not received any event from an event source such as or so far.
- On the Paste Event JSON tab, enter the event information in the JSON format, and click Done.
When you select an event, all parameters in the event appear in the right pane.
Click anywhere in the Trigger Condition box to start building the expression for a trigger condition, and use the suggested parameters, values, and operators to complete the expression.
For sample expressions, see Trigger condition expression.

Create policy step 2_GIF.gif

Step 3: To select actions to be run as part of the policy

To add action to the policy, click Add Action and perform the following steps using the action wizard:
1. From the Pick an automation tool section, click the connector name.
  Only configured connectors are displayed here. The wizard takes you to the next step to select an action.
2. Click Sync Actions.
  All actions available in the selected connector appear.
3. Click Select against the action that you want to add to the policy.
  The wizard takes you to the next step to configure an action.
4. Depending on the selected action, provide the information and click Done.
  Note
  Based on the selected event, the event slots with the values specified in the event appear under the Parameters section on the UI. You can click any of the parameters and its value gets copied. You can paste it while defining the action in the policy.
  The added action appears in the Action Configuration section. You can add multiple actions in a policy.
  Adding action for supported applications
  To add action for a specific automation application, see the following documentation for an example for each of the supported connections:
  - Terminating-starting-or-stopping-an-EC2-instance (AWS)
  - Launching-a-job-template (Ansible Tower)
  - Resizing-a-deployment (Kubernetes)
  - Executing-a-workflow (TrueSight Orchestration)
  - Running a job in Jenkins (Generic REST API)
  - Invoking-a-process-in-BMC-Helix-Innovation-Studio ()

Step 4: To add tags

To add system or custom tags to the policy, perform the following steps:
1. System tags: Select one or more tags from the list of available system tags.
  Based on the event, some system tags are displayed.
2. Custom tags: In the Tags (Optional) section, enter a key-value pair.
  Tag key should start with an alphabet and end with an alphanumeric character. Key supports alphanumeric characters and periods, dashes, and underscores.

Custom tags.png

Step 5: To configure change management for creating change requests

To create a change request as part of this policy, perform the following steps:

If not enabled already, use the Enable change ticket creation toggle button and then click Modify to add change request values.
Select the appropriate values for the following fields and click Save:
1. Impact
2. Urgency
3. Company
4. First Name: By default, first and last name of the logged-in user appears.
  When you enter the first name, based on the selected company, the list of user names belonging to that company appear in a list in the <username-firstname-lastname> format. If there are multiple users with the same first name, you can select the correct user from the list. When you select the first name, the last name gets selected.
5. Last Name
6. Description: By default, contains the name of the product, BMC Helix Intelligent Automation. The description is updated in the Summary field in the change request in BMC Helix ITSM. Ensure that the description is up to 100 characters only.
  The selected values are displayed. When a change is created in BMC Helix ITSM, it will contain the values specified in the policy.
  
  Note
  In case the user credentials for the get changed for the tenant, it takes 15 minutes to reflect the changes in BMC Helix Intelligent Automation. In this time period, if the the policies with change management options are triggered, they fail and display an authentication failed error. After 15 minutes, if the policies are triggered again, they will successfully run.
  After the change request is approved in , the policy is triggered and runs the actions.

Step 6: To provide estimated savings and to publish the policy

In the Estimated Savings section, enter an approximate time (in minutes) and money (in USD) that you may save by automating the actions.
(Optional) Before you save a policy, do the following steps to test a policy to ensure that the event and the policy match and can be run later:
1. Click Test Policy.
  You are prompted to save the policy.
2. Click Confirm.
3. On the Test Inputs tab, enter parameter values for testing (if required by the policy being tested), and click Execute.
  The results appear in the Test Results tab.
  If the policy test is successful, the policy instance is created and executed on the resource you provide during testing.
  Can I test a policy later?
  Yes, however, you need to change a policy status to draft and edit the policy to test it. BMC recommends that you test a policy while creating it.
Select Publish Policy and click Save to publish the policy.

Create policy step 6.png

Trigger condition expression

To build a trigger condition expression, you can use the expression builder provided by BMC Helix Intelligent Automation while creating an automation policy. To learn more, see Trigger condition.

The following table lists sample conditions and the events that will match to those conditions.

Trigger condition	Description	Sample matching event
"trigger_condition_expression": "$?((($.\"event\".\"sourceNodeID\" == 271878215 && $.\"event\".\"componentalias\" == \"\" \|\| $.\"event\".\"location\" == null && $.\"event\".\"al_parameter_threshold\" == 1.5) \|\| $.\"event\".\"source_identifier\" == \"02c30a2f- e092-ce81-e5f8-be21b57d9760//00092f62-824//a-11ec-b626-0e8f35be3981\" && $.\"event\".\"source_hostname\" == \"02c30a2f- e092-ce81-e5f8-be21b57d9760#00092f62-824a#11ec-b626-0e8f35be3981\") \|\| $.\"event\".\"allow_operations\" == true)",	Matches any event with sourceNodeID that has the number 271878215, location as null, al_parameter_threshold as 1.5, and allow_operations as true.	{ "sourceNodeID": 271878215, "componentalias": "", "location": null, "al_parameter_threshold": 1.5, "source_identifier": "02c30a2f- e092-ce81-e5f8-be21b57d9760//00092f62-824//a-11ec-b626-0e8f35be3981", "source_hostname": "02c30a2f- e092-ce81-e5f8-be21b57d9760#00092f62-824a#11ec-b626-0e8f35be3981", "allow_operations": true }
( tags.event_type == "IDLE_VM_RECOMMENDATION" )	Matches any event with event_type having value, IDLE_VM_RECOMMENDATION	{ "tags": { "event_type": "IDLE_VM_RECOMMENDATION", "cloud_provider": "aws" } }
( tags.event_type == OVERALLOCATED_CONTAINER_RECOMMENDATION ) && ( tags.platform == kubernetes )	Matches any event with event_type having value, OVERALLOCATED_CONTAINER_RECOMMENDATION and platform having value, kubernetes.	{ "tags": { "platform": "kubernetes", "event_type": "OVERALLOCATED_CONTAINER_RECOMMENDATION " } }
( event.eventID == '749f50e3-015f-44b0-9acc-c737c337af4a' ) \|\| ( event.userIdentity.type != 'AWSService' ) && ( event.resources[*].accountId == '262766734334' )	Matches any event with eventID having value, 749f50e3-015f-44b0-9acc-c737c337af4a or event.userIdentity.type not equal to AWSService and event.resources[*].accountId having value, 262766734334.

Where to go from here

After successfully creating policies, you can view the automation policies in the console, see Viewing-editing-and-copying-automation-policies.