The Altium NEXUS Server provides the ability to configure email notifications from the NEXUS Server - 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 NEXUS Server's browser-based interface.
Enabling & Configuring the Feature
The feature to send notification emails from your Altium NEXUS Server is enabled and configured on the Email Notifications page (Admin - Settings - Email Notifications) of the NEXUS Server's browser interface. This page is an element of the interface that can only be accessed by Administrative users of the NEXUS Server - those who are part of the Administrators role.
The Altium NEXUS Server supports mail notifications using SMTP (Simple Mail Transfer Protocol) only, since the majority of email systems that send mail over the internet use this protocol.
The Email Notifications page of the Admin - Settings area provides the interface for enabling and configuring the NEXUS Server's email notifications functionality.
By default, the NEXUS Server 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 firstname.lastname@example.org, for sending notifications through Gmail).
Smtp User Name - this is the full originating email address, from which the notification emails are sent (for example email@example.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.
It is recommended to set this interval to a value greater than 10000.
Send email notifications interval (ms) - the periodic checking interval for mail, specified in milliseconds. By default this is set to 35000ms.
It is recommended to set this interval to a value greater than 30000.
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.
In case there are issues with using a Google account, try allowing access to less secure applications. For example, with this setting OFF, you may encounter the following issue when running the email test check: The SMTP server requires a secure connection or the client was not authenticated. The server response was: 5.5.1 Authentication Required.
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 NEXUS Server's notifications service, as received by the target email supplied for the check.
With the notifications email configured and tested successfully, be sure to click the button at the top-right of the page.
A number of email notification events are supported by this feature:
Project Commit - notification when a project has been commited to the NEXUS Server.
Project Update - notification when the properties of a project have changed in some way (the project's Name and/or Description).
Project Release - notification when a project has been released to the NEXUS Server.
Project Revision State Change - notification when there is a change in the lifecycle state for a project.
Project Delete - notification when a project has been deleted.
Click on the hyperlink text in the main summary area of a mail to open the detailed page for the managed project, on the Projects page of the NEXUS Server's browser-based interface. Additional links are often provided in an email to view the project or revision through the NEXUS Server's browser interface (Web link), or in an instance of Altium NEXUS (X2 link).
A notification email is sent to all users who are currently collaborators for the project AND who are actively watching that project. For more detail, see the section Watching a Managed Project.
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.
Click on the hyperlink text in the main summary area of a mail to open the detailed page for the Component Item, on the Explorer page of the NEXUS Server's browser-based interface. Additional links are often provided in an email to view the revision of the Item through the NEXUS Server's browser interface (Web link), or through the Explorer panel in Altium NEXUS (X2 link).
For a New Approval Request and Approval Request Reminder, the members of the relevant approval group receive the email notifications. When a state change request has been processed, both the original requestor and all members of the next approval group (where multiple approval groups have been defined), receive the notification email. If the approval request has been approved by a member of the approval group (or a member of the final approval group, where multiple have been defined), the state transition will be effected automatically, and all stakeholders will receive a mail notification of the state change.
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 NEXUS Server's browser-based interface. To do so:
Browse to the required managed project within the NEXUS Server, 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 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).