Configuring Vault Email Notifications through the Browser Interface_AV
Parent page: Browser-based Access & Management
The Altium Vault provides the ability to configure email notifications from the Vault - flagging a variety of events to key stakeholders. This feature works in addition to the event notifications presented to relevant users on the STREAM page of the Vault's browser-based interface.
Enabling & Configuring the Feature
The feature to send notification emails from your Altium Vault is enabled and configured on the Email Notifications page - part of the Settings area of the Vault's browser-based interface. This page is an element of the interface that can only be accessed by Administrative users of the Vault - those who are part of the Administrators role. Access is through the dedicated ADMIN menu (ADMIN » SETTINGS), located to the far right of the standard page headers.
The Email Notifications page of the ADMIN - SETTINGS area provides the interface for enabling and configuring the Vault's email notifications functionality.
By default, the Vault email notifications feature is disabled. Enable the Send Mail Enabled option to turn it on.
Configure the fields of the page (detailed below) to set up the feature for your organization:
- Email From - the email account from which the emails will originate, appearing in the From field of an email (for example mycompanynotifications@gmail.com, for sending notifications through Gmail).
- Smtp User Name - this is the full originating email address, from which the notification emails are sent (for example mycompanynotifications@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 (typically 25, or 587 when sending mail through Gmail).
- Smtp SSL Enabled - used to enable SMTP communications. Check the box if your SMTP server uses TLS/SSL.
- Interval to check notification (ms) - the periodic checking interval for standard notifications (in the STREAM), specified in milliseconds. By default this is set to 20000ms.
- Send email notifications interval (ms) - the periodic checking interval for mail, specified in milliseconds. By default this is set to 35000ms.
Example email configuration, when using SMTP to send email notifications from a defined Gmail account.
Once enabled and configured as required, click the 
button to test sending of emails from the nominated account. The Check Email Settings dialog will appear, use this to enter a target email address and click 
. The dialog will show progress of Checking... and, if the sending account has been configured correctly, the final message of Sent Successful.
Checking the email notifications setup, by sending a test email to a target account. Hover over the image to see the successful result of the check.
And of course, checking the target email will yield a Notifications Service Test Email, from the sending email account.
Test email from the Vault's notifications service, as received by the target email supplied for the check.
button at the top-right of the page.Supported Notifications
The following email notification events are supported by this feature:
Events Related to a Component Item
Related page: Working with Vault Components
Notifications include:
- New Item Revision - notification about the release of a new revision of a Component Item.
- Lifecycle State Change - notification about a transition between lifecycle states for a revision of a Component Item.
Events Related to a Managed Project
Related Page: Managed Projects
Notifications include:
- Project Commit - notification when a project has been commited to the Vault.
- Project Properties Change - notification when the properties of a project have changed in some way (for example the project's Name, or Description).
- Project Release - notification when a project has been released to the Vault.
Events Related to an Approval Request
Related page: Controlling Lifecycle State Transitions
Notifications include:
- New Approval Request - notification when a request for transition between lifecycle states for a revision of a Component Item has been submitted for approval.
- Approval Request Reminder - notification when the original requestor uses the Reminder feature for a pending approval request.
- State Change Request Processed - notification when a pending approval request has been processed by a member of the relevant approval group. The type of action that has been taken with respect to the request can be one of the following:
- Cancelled - the original requestor for approval has decided to cancel the request.
- Rejected - a member of the relevant approval group has rejected the request.
- Approved - if the request is being passed through multiple defined approval groups, this action will be applied if a member of an intermediate approval group has approved the request.
- Completed - a member of the approval group (or final approval group where multiple groups have been defined) has approved the request.
Events Related to Part Requests
Related page: Part Requests
Notifications include:
- Part Request Created - notification when a new part request has been submitted.
- Part Request Properties Change - notification when a change to an existing part request is made.
Following a Component Item
Related page: Managed Components in an Altium Vault
To receive email notifications with respect to a Component Item, you need to be 'subscribed' to that Item. This is done by following that Component Item. Following Component Items is performed only through the Vault's browser-based interface. To do so:
- Browse to the required Component Item within the Vault, from the VAULT page of the interface.
- Right-click on the entry for the Item and choose the Full Item Info command from the context menu.
- On the subsequent detailed page for the Item, click the
button at the top-right of the page.
Accessing the control to Follow a Component Item.
You will receive applicable notifications related to the Component Item on the main HOME and STREAM pages of the browser interface, and also through the email notifications system (if enabled).
To stop following a Component Item, simply click the 
button.
Click UnFollow to essentially unsubscribe to getting notifications (including email notifications) for a Component Item.
No further notifications relating to that particular Component Item will be received on the main HOME and STREAM pages of the browser interface. You will also no longer receive applicable notifications for that Component Item through the email notifications system (if enabled).
Watching a Managed Project
Related page: Managed Projects
To receive email notifications with respect to a managed project, you need to not only be a collaborator on that project, but also be 'subscribed' to that project. This is done by watching that managed project. Watching managed projects is performed only through the Vault's browser-based interface. To do so:
- Browse to the required managed project within the Vault, from the PROJECTS page of the interface.
- Click the Open control (
) associated with the project - or click on its name - to access the detailed Project view. - Click the
button at the top-right of the page.
Accessing the control to Watch a managed project.
You will receive applicable notifications related to the project (e.g. updated, released, permission changes) on the project's Stream tab, as well as the main HOME and STREAM pages of the browser interface, and also through the email notifications system (if enabled).
To stop following a managed project, simply click the 
button.
Click UnWatch to essentially unsubscribe to getting notifications (including email notifications) for a Managed Project.
No further notifications relating to that particular project will be received on the project's Stream tab, nor the main HOME and STREAM pages of the browser interface. You will also no longer receive applicable notifications for that project through the email notifications system (if enabled).