Skip to end of metadata
Go to start of metadata

Version Warning

The content below is for Apache Syncope <= 1.2 - for later versions the Reference Guide is available.

Introduction

Syncope workflow process supports e-mail notification sending to deliver information and requests for action to administrators, approvers, and users.

This wiki page aims to show how to manage notifications by using Syncope console.

Create new notification

  1. Click on Configuration tab.
  2. Click on Notifications subtab.
  3. Click on Create new notification button.
  4. Click on Notification tab and provide the following information
    • Sender
      e-mail sender.
    • Subject
      e-mail subject.
    • Recipients e-mail attribute type
      type of schema from which to get recipient mail.
    • Recipients e-mail attribute schema
      schema from which to get recipient mail. 
    • Template
      e-mail template.
    • Trace level
      trace level.
    • Enabled
      flag to enable/disable notification, if not flagged notification tasks won't be created and e-mail(s) will not be sent. 
  5. Click on About subtab and provide a condition to filter users or roles interested by the specified events. Filter condition can be expressed as combination of "and", "or" and "not" conditions; for each condition you can specify different matching criteria:
    1. User/Role attribute matching criteria
    2. Resource matching criteria
    3. Role matching criteria (without inheritance: users of child roles are not included) for Users, for Roles instead you can specify Entitlements matching criteria
  6. Click on Events subtab and provide events to be notified.
    Events are divided into 6 macro-categories:
    1. REST
      events triggered by controllers (UserController, RoleController, etc.) 
    2. TASK
      events triggered by jobs associated to tasks
    3. PROPAGATION
      events triggered by user, role, membership propagation on some resource.
    4. SYNCHRONIZATION
      events triggered by user, role, membership synchronization from some resource.
    5. PUSH
      events triggered by push actions on user, role, membership towards some resource.
    6. CUSTOM
      events created by user (needs implementation of custom events). 
  7. Click on Recipients subtab and provide filter to search for e-mail recipients. Recipients can be a combination of:
    1. users matching About (optionally selectable)
    2. additional recipients (optionally selectable) based on search filter condition like About described above.
    3. static recipients (optionally selectable): a list of one or more recipients specified (manually) by user.
  8. Click on Save button.

Edit notification

  1. Click on Configuration tab.
  2. Click on Notifications subtab.
  3. Click on Edit link and provide information
  4. Click on Save button.

Delete a notification

  1. Click on Configuration tab.
  2. Click on Notifications subtab.
  3. Click on Delete link.
  4. Confirm operation.

Customize notification e-mail message

Refer to Customize notification e-mail templates to customize email message body.