The messaging page governs the setup of the email and phone messaging systems needed to route all messages in the system.
Email Messaging
Enabling email messaging allows several systems to operate including publication distributions, alerts, conversation notifications, and administrative notifications.
Select the Mail Provider at the top of the page, the options are:
- None: Disable Email Messaging.
- SendGrid: Select this option to set up SendGrid email messaging.
- SMTP: Select this option to set up SMTP email messaging.
SendGrid
SendGrid is a convenient cloud hosted emailing service that is easy to set up and use. Plans start at $0 per month and do not require much effort to initialize and deploy.
- Description: Add some text that may be useful when you are using the logged data to tackle issues.
- Sender Email: The email address that will be used in emails as the "sender."
- API Key: The specialized key from SendGrid that enables the service and allows you to send emails from Pyramid using their framework.
- Test Recipient Address: The email to use for testing. For more information, see Testing Email.
SMTP Email Server
Use this option to set up a traditional link to an emailing server.
- Description: Describe the SMTP server (optional).
- Sender Email: The email address that will be used in emails as the "sender."
- SMTP: The host server address of the machine hosting the SMTP service (either its IP or FQDN).
- Test Recipient Address: The email to use for testing. For more information, see Testing Email.
- Port: The SMTP port that the host service operates under (usually 25).
Security Options
If required, the following security options can be added:
- User Name And Password: If the connection to the SMTP server requires authentication, enable this option and supply the relevant User Name and Password.
- Use TLS: If the connection will be secured via SSL, select the Use TLS checkbox.
Common Email Options
Testing Email
Once you have set up your email service, provide an email address for a test account to check if the system works. Click Test to send an email using the systems to the provided address.
Email Configuration
If authentication is through SAML, OpenID, or the internal "database," the Email Configuration options are enabled.
To allow users to change their own email address in the system, select the Enable Users to Edit Their Email Address checkbox. Selecting this option enables the users to Edit their email address in the User Info panel.
Mobile Messaging
Enabling SMS messaging allows several systems to operate including alerts and administrative notifications.
Select the SMS Provider at the top of the page, the options are:
- None: Disable SMS Messaging.
- Twilio: Enable mobile text messaging using Twilio.
Twilio
To enable mobile text messaging, select Twilio. Twilio is a cloud service that enables you to programmatically perform communication functions, including sending and receiving text messages.
- Send SMS: Select the Send SMS checkbox to enable phone messaging for SMS.
- Supply the Twilio details:
- Provide the Twilio Account SID.
- Provide the Twilio Authentication Token.
- Enter the Twilio Account Phone Number.
- Enter the Test Recipient Phone Number. This phone number will be used for testing. For more information, see Testing SMS.
Click Apply to confirm your settings.
Testing SMS
Once you have set up your mobile service, provide a test phone number to check if the system works. Click Test to send a text message to the provided number.
SMS Configuration
If authentication is through SAML, OpenID, or the internal "database," the SMS Configuration options are enabled.
To allow users to change their own phone number in the system, select the Enable Users to Edit Their Phone Number checkbox. Selecting this option enables the users to Edit their phone number in the User Info panel.
Administrative Alerts
The system can auto-email or text enterprise admins if resource limits have been exceeded on any machine in the cluster. Before this can be enabled, messaging needs to be configured in the system (either email, mobile or both).
- To enable this feature, click on the Administrative Alerts tab.
- Select the Enable administrative alerts checkbox.
- Select the target for receiving alerts: email, mobile, or both.
- Select the monitoring level: light, medium or high. Increasing the monitoring level can impact performance.
- Select the monitoring audience to receive the alerts: All admins, Selected admins, or All but selected admins.
- If selected admins is selected, select the admins to receive the emails. If the selected admins must not be sent emails, then click on the left arrow to move them to the Unselected admins group.
- If All but selected admins is selected, select the admins to not receive the emails. If the selected admins must be sent emails, then click on the right arrow to move them to the Selected admins group.
Note: This feature is only available in the Enterprise edition.
Server Status
There are three levels of classification regarding the status of the Pyramid server:
- Green - CPU, memory, and disk usage are below 60%
- Yellow - either the CPU, memory, or disk usage is between 60 and 85%.
- Red - either the CPU, memory, or disk usage is above 85%.
If the server status is red, Pyramid sends a daily notification email regarding this until it returns to green.
Pyramid also sends a notification email when status changes to yellow, and to green.
Check Server Status
Monitoring levels determine how often we check the Pyramid server status:
- Light - 10 minute delay
- Medium - 5 minute delay
- Heavy - 2 minute delay
These delays can change according to other factors.