Setting the audit configurations

Last Updated : Nov 24, 2021 |
Prolog information
Metadata
Keywords:
When the third party sends a REST API request, all the enabled attributes selected from the metrics are sent as a response.
Before you begin
Ensure that you have administrative access with Security Admin role permissions to the System Manager web console.
  1. Log in to the System Manager web console.
  2. Navigate to ElementsCluster Administration.
  3. In the Service URL column of the desired cluster, click Presence Services Admin.
    STEP RESULT:
    The system displays the Avaya Aura® Presence Services login page in a new tab.
  4. Log in using the same credentials as the System Manager web console.
  5. Click Metrics API Configuration.
  6. Enable or disable the required attributes.
    ADDITIONAL INFORMATION:
    All the attributes are listed in the following table:
  7. Attributes
    Description
    Total size of messages
    Size of total messages in the database. This attribute is enabled by default.
    Total messages
    Total count of the messages in the database. This attribute is enabled by default.
    Text only messages
    Count of the text-only messages. This attribute is enabled by default.
    Messages with attachment
    Count of the messages with attachments. This attribute is enabled by default.
    Active users
    Count of active users who have sent messages in the given time. This attribute is enabled by default.
    Conversations started
    Count of conversations started. This attribute is enabled by default.
    Closing Conversations
    Count of the closed conversations. This attribute is enabled by default.
    Idle Conversations
    Count of idle conversations, that is conversations in which messages are not sent for the given period. This attribute is enabled by default.
    Open Conversation
    Count of active conversations in the database irrespective of any specific time. This attribute is enabled by default.
    Closed Conversation
    Count of closed conversations in the database irrespective of any specific time. This attribute is enabled by default.
    Users in system
    Count of users in the database. This attribute is enabled by default.
    Messages sent per user
    URL to download the csv file, which has the information of messages sent per active user.
    Messages sent per device
    Count of messages sent per device (Android, IOS, MAC, Windows, Others, Unknown).
    Messages read
    Count of messages sent between the time period for which report is generated and are read.
    Messages ignored
    Count of messages sent and delivered between the time period for which report is generated but not read.
    Peak hours for days
    Provides the intervals when the maximum amount of messages sent for each day, in the given time interval.
    Peak hours of Interval
    The number of hours is considered as an interval. The valid inputs range is [1-24]. The default value is 1.
    Example:
    • If set to 4, the peak interval is 4 hours, 24 hours is splitted into 6 slots each of 4 hours. Then, the system provides the slot when the maximum number of messages is sent.
  8. Metrics from the selected attributes are collected depending on the following data from the Audit Configuration section:
    ADDITIONAL INFORMATION:
    • Metrics Audit hour: Hour of the day at which the audit should collect the data of the selected attributes and store it in the database.
    • Collect Data: Specify the number of days for which the data of the selected attributes should be collected. Maximum date range allowed is 30 days.
      Note:
      For more than one day, metrics may not be accurate depending upon the deletion of old messages attribute.
    • Enable Metrics Audit: Enable the audits to collect a report of the selected attributes daily.
    • Use Default Time Frame: The time for which data should be considered (00.00 to 23.59).
  9. Click Commit Changes.