Page tree
Skip to end of metadata
Go to start of metadata

The Email Address Dashboard Widget is a Registry Dashboard plugin that allows for self service management of Email Addresses.

1.1. Configuration

  1. This is a non-core plugin, see Installing and Enabling Registry Plugins for more information.

  2. The Email Address Widget must be attached to a suitable Dashboard, create one if there is not one already available.
  3. Create a Message Template with a Context of Plugin, with the contents of the message to be sent to confirm control of the Email Address being added. (The substitution (@TOKEN) will be replaced with the actual token.)
  4. Add a new Dashboard Widget, with the Plugin set to EmailAddressWidget.
  5. On the plugin configuration page, set the Default Email Type to the Email Address Type that will be assigned to Email Addresses using this instantiation of the Widget. Set the Message Template appropriately.
    1. (info) It is possible to allow multiple address types to be collected by instantiating the widget multiple times.

1.2. Considerations

As this plugin manages the Email Addresses of the currently logged in user, Dashboards Visibility configurations control who has access to this capability.

When a new Email Address is added, a verification message will be sent to confirm the address. The Email Address will not be visible on the CO Person record until the address is confirmed.

To manage multiple types of Email Addresses, the plugin can be instantiated additional times.

The Email Address Widget can be used with the Elector Data Filter Plugin to allow for a self-selected Email Address to be given priority when provisioning to downstream systems.

1.3. Screenshots

The Email Address widget displays a simple list of email addresses.

When "Edit" is activated, a user may interact with an email address (delete it) or add a new email address.

Upon adding a new Email Address, the user is immediately prompted for verification. The duration of the verification token's validity can be set in the widget configuration.

1.4. See Also