Working with Event Policies and Actions › Create an Event Policy with an Enrichment Action › Create a Java Method Enrichment Action

Create a Java Method Enrichment Action

Create an event policy with a Java method enrichment action to run a Java method and enrich an event based on the method output values. The Java method must return a comma-separated list of properties and returned values as follows for the enrichment to work:

propertyname,value,propertyname,value...

Java method enrichments require the following information:

• Method name and class path
• Values to use for the method parameters based on event properties
• Script output values to assign as enrichment output values

The method must exist on the SA Manager and on every connector system to which you want to deploy the event policy.

Follow these steps:

1. Create an event policy based on a search pattern, and select Enrich Event as the action type.

   The Enrichment Configuration page opens.

2. Select Java method in the Type drop-down list and enter information in the following fields:

   Note: The text at the bottom of the page indicates if any required information is missing.

   Java Class Path

   Defines the full class path and jar file of the method to use for the enrichment.

   Example: C:\Program Files\CA\SOI\lib\ivy\epluscore.jar

   Class Name

   Defines the class name of the Java method, including the package, to use for the enrichment.

   Example: com.ca.eventplus.catalog.methods.CMDBEnrich

   User

   (Optional) Defines the user name to run the Java method, if necessary.

   Password

   (Optional) Defines the password for the specified Java method user name, if necessary.

   Note: If the method requires user authentication in its parameters, enter the credentials here and reference them on the following page to ensure that the data is protected.

   Method

   Defines the name of the Java method to run from the referenced class.

   Example: performCMDBEnrichment_v2

3. (Optional) Click Test.

   A confirmation dialog opens.

4. (Optional) Click Yes.

   The Java method connection is verified. The Configuration Test Result dialog indicates whether the connection was successful.

   Note: If you have to change this information after deploying the policy, restart the CA SAM Integration Services service on the connector system to ensure that the change takes effect. For information about how to configure enrichment value caching, see Configure Enrichment Cache Timeout.

5. Click Next.

   The Enrichment Policy page opens. Right-click each column on this page for additional help information.

6. Enter the following in the Parameter Configuration table to determine how the input parameters to the enrichment process are assigned according to method parameter values and event properties:

   Input Parameter

   Defines placeholder names for each required method input parameter. The enrichment always reads the parameters sequentially; therefore, the names that you enter for each parameter can be anything (param1, param2, and so on). Create an entry for each required input parameter to ensure that the method runs successfully.

   Assigned Value

   Defines the event property or other value to use for the corresponding method parameter value. Use the right-click menu to assign the value of a property from any matching event pattern. The value for each method parameter can take any of the following forms:

   • A full event property
   • Multiple combined event properties
   • Part of an event property
   • Modified event properties

   Use the right-click menu to add provided functions to perform common data conversions on the search value to use for each method parameter.

   To enter user credentials, use the following substitution characters to reference the credentials entered on the previous page:

   ${user}
   

   ${password}
   

   Note: Entering a password value manually on this page creates an unencrypted record of the password.

   The Preview cell displays the result of the entered value based on the selected event in the Event Log table. You must run an event search before creating the policy to get its results in the Event Log table for previewing enrichment values based on existing event content.

   Include all required parameters for the method to run. If the Java method does not run successfully based on the entered parameters or does not return a comma-separated list of properties and values, the enrichment does not occur for that event.

7. Enter the following in the Enrichment Property Assignment table to specify how enrichment output values are assigned to event properties, and click Next:

   Assigned Value

   Defines the Java method output property values to assign to the event properties in the Event Property column. This value determines the property value to use for the enrichment from the comma-separated list of properties and values that the method returns.

   References to output properties must be in the following format: ${propertyname}, where propertyname is the name of the property in the comma-separated output list whose value you want to return. For example, for a method that returns the string 'user,value,role,value,department,value', ${role} uses the returned value from the role output property for the enrichment. Any values entered without this format appear directly in the event as written. You can add enrichments to as many event properties as necessary.

   Note: You can change the names of the User Attribute properties if you want them to accurately represent the enrichment properties that you assign to them. However, these properties appear under their original names in the Event Policy dialog, even if you renamed them. Assigning values to these original names properly displays the values under the renamed properties in the Operations Console.

   The method property-based value can be a single property value, multiple values, or a modified property value. Use the right-click menu to add provided functions to perform common data conversions on the enrichment value before assigning it to the specified property. The return value cannot contain an embedded comma.

   Note: Only the properties that support enrichment value assignment appear in the Event Property column.

   The Select Data Sources page opens.

8. Save or deploy the policy.