KBA-01107: Adding Custom Alert Types

Question:

How do I create a custom Alert Type?

Answer:

Adding a custom alert is an advanced administrative task that requires administrative access to Spitfire and SQL Server and perhaps other tools.

1. Use the Alert Types tool on the System Admin Dashboard to add a new Alert type:
   • Name your alert.
   • Specify defaults for Recurrence and Lead Time.
   • Check Edit Name if the Alert name should be editable by the user when the alert is added to a document.
   • Check Show Date if the Alert Date should be editable by the user when the alert is added to a document.
   • Check Allows Recurs if the user should be able to change the default you specified for recurrence when the alert is added to a document.
   • Check Allows LeadTime if the user should be able to change the default you specified for lead time when the alert is added to a document.
   • Check Active if your alert should be offered to users on documents. (You might define an inactive alert for some custom scenario where the alert is created and processed externally.)
2. Use SQL Server to determine the GUID of your new Alert in the xsfAlertType table.
3. Use the Rule Management Tool on the System Admin Dashboard to define Alert text for your new Alert through the AlertText rule group.  You can skip this if your custom alert generation will be so custom that it does not make use of the SQL function f_AlertText.
4. You need to create code to process your Alert.  See the SQL stored procedur pas_DocOverdue for an example.

Additional Comments:

The generic Other alert provided by Spitfire should satisfy most needs.

KBA-01107; Last updated: April 22, 2020 at 9:41 am;