Configuring Vault Email Notifications through the Browser Interface

Последнее изменение: Jason Howie; 10.05.2017

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 Altium Vault 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 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.
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 Vault'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.

Supported Notifications

The following email notification events are supported by this feature:

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.
Click on the hyperlink text in the main summary area of a mail to open the detailed page for the Component Item, on the VAULT page of the Vault's browser-based interface. Additional links are provided in an email to view the revision of the Item in the Vault, either through the Vault's browser-based interface (Web link), or through the Vaults panel in Altium Designer (DXP link).
A notification email is sent to all users who are currently subscribed to the relevant Component Item. For more detail, see the section Following a Component Item.

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.
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 Vault's browser-based interface. Additional links are provided in an email to view the detailed page for the managed project in the Vault, through the Vault's browser-based interface (Web link), or to launch Altium Designer and open the project in the Projects panel (DXP 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.

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.
Click on the hyperlink text in the main summary area of a mail to open the detailed page for the Component Item, on the VAULT page of the Vault's browser-based interface. Additional links are provided in an email to view the revision of the Item in the Vault, either through the Vault's browser-based interface (Web link), or through the Vaults panel in Altium Designer (DXP 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.

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.
Click on the hyperlink text in the main summary area of a mail to open the detailed page for the Part Request, on the PART REQUESTS page of the Vault's browser-based interface. An additional link is provided in an email to view the Part Request in the Vault, through the Vault's browser-based interface (Web link).
The original requestor, and all members of the specified Librarian role, will receive notification. Once a specific librarian has been assigned to a request, only that librarian, and of course the original requestor, will receive notifications generated in relation to that request.

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:

  1. Browse to the required Component Item within the Vault, from the VAULT page of the interface.
  2. Right-click on the entry for the Item and choose the Full Item Info command from the context menu.
  3. 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:

  1. Browse to the required managed project within the Vault, from the PROJECTS page of the interface.
  2. Click the Open control () associated with the project - or click on its name - to access the detailed Project view.
  3. 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).

 

Обнаружили проблему в этом документе? Выделите область и нажмите Ctrl+Enter, чтобы оповестить нас.

Связаться с нами

Связаться с нашими Представительствами напрямую

Вы сообщаете о проблеме, связанной со следующим выделенным текстом
и/или изображением в активном документе:
Бесплатная пробная версия Altium Designer
Бесплатная пробная версия Altium Designer
Давайте приступим. Для начала, Вы или Ваше предприятие уже используете Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

В таком случае, для чего Вам необходима пробная лицензия?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вам для этого не нужна пробная лицензия.

Нажмите кнопку ниже, чтобы загрузить установщик самой новой версии Altium Designer

Загрузить установщик Altium Designer

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Пожалуйста, заполните форму ниже, чтобы получить ценовое предложение.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Если Ваша подписка Altium активна, у Вас нет необходимости в пробной лицензии.

Если у Вас нет активной подписки Altium, пожалуйста, заполните форму ниже, чтобы получить пробную версию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Для чего Вы хотите попробовать Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы нашли нужное место! Пожалуйста, заполните форму ниже, чтобы начать использование пробной версии.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Замечательно! Создавать новое - отличное занятие. У нас есть превосходная программа для Вас.

Upverter - бесплатная платформа, разработанная специально для любителей проектирования.

Нажмите здесь, чтобы попробовать!

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.