Determining the Mapping of a Field

You can determine the mapping of a field by adding the request in the condition of an orchestration rule. From an asset that has an assigned integration or from AlienApps, you can determine the mapping between the property value and its property key. Once you know the property key, you can add the field as a condition in your rule.

To determine the mapping of a field from AlienApps

  1. Go to Data Sources > AlienApps > Available Apps.
  2. Locate the integration.
  3. Click theicon next to Data Sources Details.
  4. Search the property key inside the text box and copy the property value that maps with that property key.

    Note: In this example the field is “customfield_11“. This is only for this integration; the same field from another integration may be mapped to another field.

    Mapping

  5. Go to Settings > Rules.
  6. Select Create Orchestration Rule > Notification Rule.
  7. Select a Boolean operator.

    The options are AND, OR, AND NOT, and OR NOT.

  8. Select a packet type in the Match drop-down list.

    Match Drop Down List

  9. Click Add Conditions and paste the property value.
  10. Choose an operator and enter the value.

    Mapping a rule condition

    Note: The fields found in the integration code may be different from the fields used in the rule conditions. In the example, "customfield_11" is actually the "Custom Field 11" in rule conditions.

  11. Click Next.

    Rules Verifications Dialog Box

    Important: A dialog box opens if there are warning messages. Click Cancel to review the warning messages, or click Accept to continue creating the rule.

  12. Enter a name for the rule.
  13. (Optional.) Enter a description for identifying this rule.
  14. Select a notification method:

    • Amazon SNS: This method requires the setup of the Amazon Simple Notification Service (SNS) API call from the USM Anywhere server. There is no limit to the number of Amazon SNS endpoint notifications sent. However, this method requires having an Amazon Web Services (AWS) account for setup and use. The Amazon SNS allows the first 1000 email notifications per month to fall into the free messaging tier. See Sending Notifications Through Amazon SNS for more information.
    • Datadog: This method requires the creation of a Datadog API key and additional steps. See Sending USM Anywhere Notifications to Datadog for more information.
    • Email: This method sends the notification by email. You need to enter information for the email subject and enter a destination email address. Multiple comma-separated email addresses are possible. This method uses a built-in integration with the Amazon Simple Email Service (SES) function and is limited to a maximum of 200 emails per rolling 24-hour period. The only user-customizable information available is the email subject line.
    • Note: The rolling 24-hour, 200-email limit refers to all email accounts. For example, you can have a rule with multiple emails, which counts as a single email delivery. Alternately, if you have several rules with several emails, each of these counts as an individual email account. Sensor-disconnect emails do not count against this number because they are critical and are only sent to users whose role is manager.

      Select the Sanitize Email Content checkbox to replace detailed email contents with a generic message and a link that requires user authentication to view further information.

    • PagerDuty: This method is performed using an integration in the product, and user setup is required. See Sending USM Anywhere Notifications to PagerDuty for more information.
    • Slack: This method makes use of a user-created Slack Webhook integration. Slack integration can also be performed using Amazon SNS. See Sending USM Anywhere Notifications to Slack for more information.
  15. Modify these two options:

    • Occurrences: Specify the number of event occurrences that produce a match on the conditional expression to trigger the rule. You can enter the number of occurrences or use the arrow to scroll the value up or down. You need to enter a number between 1 and 100.
    • Length: Specify the length of the timespan used to identify a match for multiple occurrences. Enter the number and choose a value of seconds, minutes, or hours.

      This duration identifies the amount of time that transpires from the beginning to the end of the occurrence. If the number of occurrences is not met within this period, the rule is not a match.

      Specify multiple occurances to match for the rule

      In this example, the rule applies when the configured conditions happen five times every three hours.

    These two options function together to specify the number of occurrences within a time period that will produce a match for the rule. For example, you can define a rule to trigger an alarm Alarms provide notification of an event or sequence of events that require attention or investigation. for an unauthorized access An incident-type categorization that may be a precursor to other actions or stages of an attack. attempt when a failed SSH Program to securely log into another computer over a network, execute commands in a remote machine, and move files from one machine to another through Secure Copy (SCP). login Log in (verb): Process in which an individual gains access to a computer system after providing sufficient credentials to authenticate their unique identity. Login (noun): User credentials, typically a username and matching password. occurs three times within a five-minute window.

  16. Click Save.

    The created rule displays in the list of rules. You can see it from Settings > Rules. See Orchestration Rules for more information.

  17. Important: It takes a few minutes for an orchestration rule to become active.

To determine the mapping of a field from assets

  1. Go to Environment > Assets.
  2. Locate the asset that has the integration assigned.
  3. Next to the asset name, click the icon and select Full Details.
  4. Click the Assigned Apps tab.

    Details of an asset, AlienApps tab

  5. Click theicon next to Data Sources Details.
  6. Copy all the text under the Data pane.

    Details of an asset, AlienApps tab

  7. Search the property key inside the copied text and copy the property value that maps with that property key. For example, search the property key fromPort. This property key maps with customfield_11.

    Note: In this example the field is “customfield_11“. This is only for this integration; the same field from another integration may be mapped to another field.

    Mapping

  8. Go to Settings > Rules .
  9. Click Create Orchestration Rule > Notification Rules.

    See Notification Rules from the Orchestration Rules Page for more information.

  10. Select a Boolean operator.

    The options are AND, OR, AND NOT, and OR NOT.

  11. Select a packet type in the Match drop-down list.

    Match Drop Down List

  12. Click Add Condition and paste the property value.
  13. Choose an operator and enter the value.

    Create a notification rule

  14. Note: The fields found in the integration code may be different from the used in the rule conditions. In the example, “customfield_11“ is actually the “Custom Field 11“ in rule conditions.

  15. Click Next.

    Rules Verifications Dialog Box

    Important: A dialog box opens if there are warning messages. Click Cancel to review the warning messages, or click Accept to continue creating the rule.

  16. Enter a name for the rule.
  17. (Optional.) Enter a description for identifying this rule.
  18. Select a notification method:

    • Amazon SNS: This method requires the setup of the Amazon Simple Notification Service (SNS) API call from the USM Anywhere server. There is no limit to the number of Amazon SNS endpoint notifications sent. However, this method requires having an Amazon Web Services (AWS) account for setup and use. The Amazon SNS allows the first 1000 email notifications per month to fall into the free messaging tier. See Sending Notifications Through Amazon SNS for more information.
    • Datadog: This method requires the creation of a Datadog API key and additional steps. See Sending USM Anywhere Notifications to Datadog for more information.
    • Email: This method sends the notification by email. You need to enter information for the email subject and enter a destination email address. Multiple comma-separated email addresses are possible. This method uses a built-in integration with the Amazon Simple Email Service (SES) function and is limited to a maximum of 200 emails per rolling 24-hour period. The only user-customizable information available is the email subject line.
    • Note: The rolling 24-hour, 200-email limit refers to all email accounts. For example, you can have a rule with multiple emails, which counts as a single email delivery. Alternately, if you have several rules with several emails, each of these counts as an individual email account. Sensor-disconnect emails do not count against this number because they are critical and are only sent to users whose role is manager.

      Select the Sanitize Email Content checkbox to replace detailed email contents with a generic message and a link that requires user authentication to view further information.

    • PagerDuty: This method is performed using an integration in the product, and user setup is required. See Sending USM Anywhere Notifications to PagerDuty for more information.
    • Slack: This method makes use of a user-created Slack Webhook integration. Slack integration can also be performed using Amazon SNS. See Sending USM Anywhere Notifications to Slack for more information.
  19. Modify these two options:

    • Occurrences: Specify the number of event occurrences that produce a match on the conditional expression to trigger the rule. You can enter the number of occurrences or use the arrow to scroll the value up or down. You need to enter a number between 1 and 100.
    • Length: Specify the length of the timespan used to identify a match for multiple occurrences. Enter the number and choose a value of seconds, minutes, or hours.

      This duration identifies the amount of time that transpires from the beginning to the end of the occurrence. If the number of occurrences is not met within this period, the rule is not a match.

      Specify multiple occurances to match for the rule

      In this example, the rule applies when the configured conditions happen five times every three hours.

    These two options function together to specify the number of occurrences within a time period that will produce a match for the rule. For example, you can define a rule to trigger an alarm Alarms provide notification of an event or sequence of events that require attention or investigation. for an unauthorized access An incident-type categorization that may be a precursor to other actions or stages of an attack. attempt when a failed SSH Program to securely log into another computer over a network, execute commands in a remote machine, and move files from one machine to another through Secure Copy (SCP). login Log in (verb): Process in which an individual gains access to a computer system after providing sufficient credentials to authenticate their unique identity. Login (noun): User credentials, typically a username and matching password. occurs three times within a five-minute window.

  20. Click Save.

    The created rule displays in the list of rules. You can see it from Settings > Rules. See Orchestration Rules for more information.

  21. Important: It takes a few minutes for an orchestration rule to become active.