Configuring Certificate Expiry Alerts over ITSM

Prerequisites

Ensure that the ITSM tool you want to receive alerts on is integrated with AppViewX via tha Integration Hub. For instructions, you can refer to the ITSM Vendor Configuration documentation.

Configuring Expiry Alerts over ITSM

Important: Expiry alerts over email can be configured for end certificates as well as CA certificates. Expiry alerts over ITSM channels can be configured only for end certificates.
  1. Go to ( Menu) > CERT+ > ALERTS & LOGS > Expiry Alerts.
    The expiry alerts inventory is displayed.
  2. To create a new ITSM expiry alert, click + Create.
    The Expiry Alert > Expiry Alert Add page is displayed.
    Tip: This page has a list of best practices you are advised to follow when creating a new expiry alert.
  3. For the new alert, enter a unique Alert Name (mandatory) and a description (optional) with additional details about the alert.
  4. In the Alert Configuration section, click + Add.
    The Add Configuration pane is displayed.
  5. From the Certificate Type field, select End Certificate.
  6. Enter the Filter Configuration details.
    Table 1. Field descriptions for the Filter Configuration section
    Field Description
    Certificate Expiry Period To filter certificates based on their expiry:
    • Range in days: Sends an expiry alert email for certificates that will expire within the specified range of days from the current date

      For example, to set an alert for certificates that will expire between 10 and 40 days from the current calendar date, enter 10 and 40.

      Alerts will be sent for all certificates expiring between 00:00:00 AM on the start day and 11:59:59 on the end day.
    • On specified days: Sends an expiry alert email for certificates that will expire on the nth day from the current date

      For example, to send an alert for certificates expiring on the 50th day from the current calendar date, enter 50.

      Alerts will be sent for all certificates expiring between 00:00:00 AM and 11:59:59 PM of the specified day.
    • Range in dates: Sends an expiry alert email for all certificates expiring in a specific duration

      Use the calendar widget to select the Start date and End date for this duration.

      Alerts will be sent for all certificates expiring between 00:00:00 AM on the start date and 11:59:59 on the end date.
    Additional Filters To add a filter in addition to the certificate expiry period:
    1. Select the required filter from the Select option dropdown list.
    2. Enter the corresponding value in the Type to enter value field.
    3. Click Add.

    The selected filter option and its value are displayed.
    Notification Method To send an expiry alert over ITSM, select Others.
    Ignore renewed/regenerated certificate When this field is enabled, results returned after the alert is triggered will not include certificates that have already been renewed or regenerated, even though they match the filter criteria.
    *ITSM Tool This field is displayed only when Notification Method = Others.From the following options in the dropdown list, select an ITSM tool to raise a ticket for the alert:
    • ServiceNow
    • JIRA
  7. To receive expiry alerts on ServiceNow:
    1. From the following options, select the Configuration Type:
      • Basic: Create a ticket by specifying the minimum details in the Configuration section.
      • Advanced: Based on the organization policy, fill the required values for a ticket using a JSON. In this case, a JSON editor will replace the Configuration section. The JSON is editable and can be customized as per requirement.
    2. From the following options, select the Issue Type:
      • Incident (Tickets will be listed on the Incidents page)
      • Service Request (Tickets will be listed on the My requests page)
    3. Enter the Configuration details.
      Table 2. Field description for Incident requests
      Field Description
      Short Description* Enter a title/short description for the ticket alert using the following (recommended) format:
      Expiry Alert :: |Common Name| certificate| expiring on |Valid Until|
      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Description* Enter a detailed description of the incident event here (for example, certificate details and operation links) using the following (recommended) format:

      Certificate with Common Name |Common Name|

      Serial number |Serial Number|

      issued by |Issuer Common Name|

      is about to expire on |Valid Until|

      The field will retain all line breaks as added.

      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Urgency* From the dropdown list, select the urgency level of the incident.
      Impact* From the dropdown list, select the impact level of the incident.
      Assignment Group* Enter the name of the group this incident will be assigned to.
      Table 3. Field description for Service Requests
      Field Description
      Short Description* Enter a title/short description for the ticket alert using the following (recommended) format:
      Expiry Alert :: |Common Name| certificate| expiring on |Valid Until|
      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Description* Enter a detailed description of the incident event here (for example, certificate details and operation links) using the following (recommended) format:

      Certificate with Common Name |Common Name|

      Serial number |Serial Number|

      issued by |Issuer Common Name|

      is about to expire on |Valid Until|

      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Priority* From the dropdown list, select the priority assigned to the incident.
      Assigned to* Enter the name of the user this incident will be assigned to.
      Due Date* Using the calendar widget, select a due date for the ticket.
    4. Click Validate.
    OR

    To receive expiry alerts on JIRA:

    1. From the following options, select the Configuration Type:
      • Basic: Create a ticket by specifying the minimum details in the Configuration section.
      • Advanced: Based on the organization policy, fill the required values for a ticket using a JSON. In this case, a JSON editor will replace the Configuration section. The JSON is editable and can be customized as per requirement.
    2. Enter the Configuration details.
      Table 4. Field descriptions for the Configuration details
      Field Description
      Project Id* Enter the unique identifier of the project in JIRA under which the JIRA ticket will be created.
      Note: For instructions on how you can find the JIRA project ID, click here.
      Issue Type* From the dropdown list, select the type of JIRA issue.
      Summary* Enter a title/short description for the JIRA ticket using the following (recommended) format:
      Expiry Alert :: |Common Name| certificate| expiring on |Valid Until|
      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Description Enter additional details related to the ticket using the following (recommended) format:

      Certificate with Common Name |Common Name|

      Serial number |Serial Number|

      issued by |Issuer Common Name|

      is about to expire on |Valid Until|

      Note:
      • Specify the dates in the mm/dd/yyyy format.
      • The full list of placeholders and their corresponding values is given here.
      Priority* From the dropdown list, assign a priority to the ticket.
      Reporter Enter the name of the user who reported the issue.
      Important: For the JIRA server, only the AD user name (in the format name.lastname) is the accepted value for this field. Email ID or user name are invalid values.
      Assignee* Enter the name of the user to whom this JIRA ticket will be assigned.
      Important: For the JIRA server, only the AD user name (in the format name.lastname) is the accepted value for this field. Email ID or user name are invalid values.
    3. Click Validate.
  8. Click Add.
    The created alert is listed in the table below the + Create button.
    Tip: To edit/delete an alert, use the Edit/Delete button, as required.
  9. Under Alert Execution Type:
    Note: The settings configured here will be applicable to all expiry alerts listed in the above table.
    1. To configure a manual alert that will be triggered immediately, select Run Now and click Save.
    OR
    1. To trigger the alert at a scheduled time, select Schedule and enter the following details:
      • Time Zone*
      • Frequency (daily/weekly/monthly/yearly)
      • Starts On*
      • Ends
        • For ends ON, use the calendar widget to select the date on which the last expiry alert email will be sent.
        • For ends After, enter the number of Occurrences after which the expiry alert will be discontinued.
      Note: Once an alert has been created, it's execution type cannot be modified.
  10. Click Save.
    Once the expiry alerts are configured with Allow certificate renewal option, the individual certificate renewal email will be sent to the stakeholders with two links:
    • Link for certificate renewal
    • Link for unsubscribing from the alerts for that specific certificate
    Tip: You can repeat steps 4 to 9 to add more than one Alert Configuration under a Alert Name.
  11. To renew the certificate:
    1. Click on the renewal link and login to AppViewX.
      You will be redirected to the holistic view for the certificate and the following renewal alert will be displayed:
    2. For instructions on how to renew a certificate, refer to the documentation forrenewing a certificate.
      To unsubscribe from the alerts for the certificate, click the unsubscribe link from the alert email.
      You will be redirected to the certificate inventory page and the following unsubscribe alert will be displayed: