Configuring Notifications

This topic describes how email notification settings can be modified by adding custom property settings in a custom.properties file in the <APPIAN_HOME>/ear/suite.ear/conf/ directory.

  • Portal alerts are not modified by these properties.
  • Process error alert recipients can be configured by web administrators using the Alerts Tab of the Process Model Properties dialog box.
  • Server administrators can configure process error alert default recipients using a customized version of <APPIAN_HOME>/ear/suite.ear/web.war/WEB-INF/conf/process/exception-type-config-process.xml.

See also: Configuring Custom Properties

Notification Types and Default Values

The default values for system notifications sent using email can be configured in custom.properties for the following notification types. Each email notification can be set to one of the following intervals:

  • immediate
  • daily
  • weekly
  • hourly
  • never

These parameters set the default (global) value, not the value used by a particular user. If a user does not set a preference, then the global value is used. If the user has set a preference, then the user's preference is maintained.

In order to update a global notification setting, after Appian has already initialized default settings for each user, complete the following (the transaction log must be completely cleared before the change is fully applied to all users):

  1. Run stop-suite.bat (.sh).
  2. Run start-suite.bat (.sh).
    • The properties file is read with the new values, but initialization has already taken place.
  3. Run stop-suite.bat (.sh).
  4. Run start-suite.bat (.sh).
    • The new properties values are used when initializing default settings for users.
  5. Click My Alerts > Edit My Alert Settings to verify that the new default value appears.

The following table summarizes the notification types that can be set in a custom.properties file. The updated values are only used if the end user does not change his or her alert settings.

After applying these changes to custom.properties, the new properties only take effect after the services are started twice, or the next time a new server becomes the primary (in a distributed configuration).

Parameter Description
server.conf.notifications.group_membership_requested_timing Group Access Request
  • The default timing is immediate.
  • server.conf.notifications.group_invitation_timing Invitation to Join Group
  • The default timing is immediate.
  • server.conf.notifications.group_membership_removed_timing Group Membership Removed
  • The default timing is never.
  • server.conf.notifications.group_membership_request_approved_timing Group Access Request Approved
  • The default timing is immediate.
  • server.conf.notifications.group_membership_request_rejected_timing Group Access Request Denied
  • The default timing is immediate.
  • server.conf.notifications.group_invitation_accepted_timing Group Membership Invitation Accepted
  • The default timing is immediate.
  • server.conf.notifications.group_invitation_declined_timing Group Membership Invitation Declined
  • The default timing is immediate.
  • server.conf.notifications.send_link_msg_timing You have received a link to a page
  • The default timing is immediate.
  • server.conf.notifications.send_feedback_msg_timing Page Feedback from User
  • The default timing is immediate.
  • server.conf.notifications.page_approved_msg_timing Page Approved
  • The default timing is immediate.
  • server.conf.notifications.system_msg_timing You have received a message
  • The default timing is immediate.
  • server.conf.notifications.page_approval_req_msg_timing Page Approval Request
  • The default timing is immediate.
  • server.conf.notifications.collab_send_link_msg_timing You have received a link to a document
  • The default timing is immediate.
  • server.conf.notifications.collab_access_approved_msg_timing Knowledge Center Access Approved
  • The default timing is immediate.
  • server.conf.notifications.collab_access_rejected_msg_timing Knowledge Center Access Denied
  • The default timing is immediate.
  • server.conf.notifications.collab_access_request_msg_timing Knowledge Center Access Request
  • The default timing is immediate.
  • server.conf.notifications.collab_approved_changes_msg_timing Knowledge Center Change Approved
  • The default timing is immediate.
  • server.conf.notifications.collab_rejected_changes_msg_timing Knowledge Center Change Denied
  • The default timing is immediate.
  • server.conf.notifications.collab_export_completed_msg_timing Application Export Completed
  • The default timing is immediate.
  • server.conf.notifications.collab_import_completed_msg_timing Application Import Completed
  • The default timing is immediate.
  • server.conf.notifications.collab_change_request_msg_timing Knowledge Center Change Request
  • The default timing is immediate.
  • server.conf.notifications.collab_expiring_files_msg_timing Expiring files
  • The default timing is immediate.
  • server.conf.notifications.collab_invite_kc_msg_timing Invitation to Join Knowledge Center
  • The default timing is immediate.
  • server.conf.notifications.collab_accept_invite_msg_timing Knowledge Center Invitation Accepted
  • The default timing is immediate.
  • server.conf.notifications.collab_decline_invite_msg_timing Knowledge Center Invitation Declined
  • The default timing is immediate.
  • server.conf.notifications.process_escalation_msg_timing Task has been escalated
  • The default timing is immediate.
  • server.conf.notifications.process_sub_link_republished_timing Sub/linked process models are republished
  • The default timing is immediate.
  • server.conf.notifications.process_super_process_causes_publishing_timing Process model auto-published
  • The default timing is immediate.
  • server.conf.notifications.process_sub_link_disabled_deleted Sub/link process is disabled or deleted
  • The default timing is immediate.
  • server.conf.notifications.process_new_task_me_timing New task assigned to me
  • The default timing is immediate.
  • server.conf.notifications.process_new_task_others_timing New task assigned to me and others
  • The default timing is immediate.
  • server.conf.notifications.process_new_task_unassigned_timing A task is unassigned. A new task has been generated, but it is not currently assigned to anyone.
  • The default timing is immediate.
  • server.conf.notifications.process_cannot_delete_cancel_sub Cannot delete a sub-process
  • The default timing is immediate.
  • server.conf.notifications.process_exception_msg_timing An error in the process has occurred
  • The default timing is immediate.
  • server.conf.notifications.task_exception_msg_timing An error in a task of a process has occurred
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_message_commented_on_msg_timing This setting configures the email-only alert that is sent when a new comment is added to a message that you have commented on in Tempo.
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_post_commented_on_msg_timing This setting configures the email-only alert that is sent when a new comment is made to a post that you have commented on in Tempo.
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_system_post_commented_on_msg_timing This setting configures the email-only alert that is sent when a new comment is made to a system-event posting that you have commented on in Tempo.
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_post_msg_timing This setting configures the email-only alert that is sent when a new comment is made on a Tempo event that is sponsored by you.
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_message_msg_timing This setting configures the email-only alert that is sent when a new comment is made on a Tempo message that you posted, which targeted everyone.
  • The default timing is immediate.
  • server.conf.notifications.tempo_comment_on_message_to_group_msg_timing This setting configures the email-only alert that is sent when a new comment is made on your Tempo message to a group.
  • The default timing is immediate.
  • server.conf.notifications.tempo_hazard_on_post_commented_on_msg_timing This setting configures the email-only alert that is sent when a new hazard alert is added to a post that you have commented on in Tempo.
  • The default timing is immediate.
  • server.conf.notifications.tempo_hazard_on_system_post_commented_on_msg_timing This setting configures the email-only alert that is sent when a new hazard alert is added to a system-event post that you have commented on in Tempo.
  • The default timing is immediate.
  • server.conf.notifications.tempo_hazard_on_post_msg_timing This setting configures the email-only alert that is sent when a new hazard alert is added to a Tempo event that you sponsored.
  • The default timing is immediate.
  • server.conf.notifications.tempo_group_message_posted_msg_timing This setting configures the email-only alert that is sent when a new message is posted in Tempo to a group.
  • The default timing is never.
  • server.conf.notifications.tempo_post_attributed_to_you_msg_timing This setting configures the email-only alert that is sent when a new event that is sponsored by you is posted to Tempo.
  • The default timing is immediate.
  • Mailhandler Properties

    Mailhandler properties can be modified by adding custom configurations to custom.properties using the namespace prefix conf.mailhandler.

    See also: Configuring Custom Properties and Mail Server Setup

    Server Communication Settings

    The following properties take the server.conf.notifications namespace as a prefix.

    See also: Configuring Custom Properties

    Property Description
    server.conf.notifications.dt_host The name/IP address of the engine running the Discussion Threads services. This property does not configure engine connectivity. See Load Balancing an Engine Server to run the Forum Discussions Engine on a different server.
    NOTE: Appian recommends using Tempo instead of Discussion Forums for collaboration.
    server.conf.notifications.dt_port The accessible port on the engine running the Discussion Threads services. This property does not set the port number used by the notification engine. This can be set using a custom appian-topology.xml file. See Port Usage.
    NOTE: Appian recommends using Tempo instead of Discussion Forums for collaboration.
    server.conf.notifications.ps_host The name/IP address of the engine running the Portal server. This property does not configure engine connectivity. See Load Balancing an Engine Server to run the Notifications Engine on a different server.
    server.conf.notifications.ps_port The accessible port on the engine running the Portal server. This property does not set the port number used by the notification engine. This can be set using a custom appian-topology.xml file. See Port Usage.
    server.conf.notifications.default_ntf_ttl Default number of days to keep portal notifications before deleting them automatically (for those notifications where users have not specified the number of days explicitly in notifications preferences). The default is 10 days.
    server.conf.notifications.MAX_ADDRESSES_PER_EMAIL The maximum number of people that a notification is sent out to. This is defaulted to 100. For example, if there are a 1000 people who should be notified, then 10 separate notifications will be sent, with each notification being sent to 100 recipients, assuming that this property is set to 100.
    FEEDBACK