Configuring Vault Email Notifications through Browser Interface

Old Content - visit altium.com/documentation

Altium Vault 2.5 brought the ability to configure email notifications from the vault - flagging a variety of events to key stakeholders, relating to Component Items, Managed Projects, Approval Requests, and Part Requests. However, enabling and configuring the feature required the user to interact with the LocalVault.ini file - not difficult, but rather obscure and not so user-friendly. With Altium Vault 2.6, setting up to use this feature is a breeze, with configuration performed through the vault's browser-based interface.

With administrative rights to your company's Altium Vault you can simply sign in, click on Admin at the top-right of the page, and choose the Settings entry from the associated menu (which provides all browser-based functionality accessible to Admins). Then, use the available navigation tree for the Settings area of the interface to locate and open the Email Notifications page. It is from here that you will enable and configure the email notifications feature.

While Altium Vault 2.5 supported mail notifications using SMTP (Simple Mail Transfer Protocol) or Amazon SES API, Altium Vault 2.6 focuses on, and supports only SMTP, since the majority of email systems that send mail over the internet use this protocol.


The Smtp page of the Admin - Settings area provides the interface for setting up email notifications from the vault.

By default, the vault email notifications feature is disabled. Configure the fields of the page (detailed below) to set up the feature for your organization:

  • Send Mail Enabled - used to actually enable the feature. Check the box to enable.
  • Email From - the email account from which the emails will originate (appearing in the From field of an email).
  • Smtp User Name - this is the full originating email address, from which the notification emails are sent (for example simon.entist@gmail.com, for sending notifications through Gmail).
  • Smtp User Password - this is the password portion of the email access credentials.
  • Smtp Host - the SMTP server address (for example smtp.gmail.com when sending mail through Gmail).
  • Smtp Port - the SMTP port (for example 587 when sending mail through Gmail).
  • Smtp SSL Enabled - used to enable SMTP communications. Check the box to enable.
  • Interval to check notification - the periodic checking interval for standard notifications (in the Stream), specified in milliseconds. By default this is set to 20000ms.
  • Send email notifications interval - the periodic checking interval for mail, specified in milliseconds. By default this is set to 350000ms.


Example email configuration, when using SMTP to send email notifications from a defined Gmail account.

Once enabled and configured as required, use the Check button to test sending of emails from the nominated account. The Check Email Settings dialog will appear, use this to enter an email address and click Check. The dialog will show progress of Checking... and, if the sending account has been configured correctly, the final message of Sent Successful. And of course, checking the target email will yield a Notifications Service Test Email, from the sending email account.

With the notifications email configured and tested successfully, be sure to click the Save button at the top-right of the page.

 

You are reporting an issue with the following selected text and/or image within the active document: