Introduction to SurgeSuppressor

SurgeSuppressor is an application that bridges the gap between BroadWorks and SurgeMail by automating the creation, deletion, and modification of email accounts. It accomplishes this task by monitoring the OCI-P audit logs generated by the application server of a BroadWorks installation for needed changes. It then performs the tasks on Surge Mail, turning a multi-step operation into one.

Tasks Of Automation

SurgeSuppressor is looking for specific changes within BroadWorks as triggers.

1. Mail Account Creation
   • Accounts are created on the mail server when the voicemail settings are correctly configured for a user within the BroadWorks web interface.
   • The page is located at - /User/Messaging/Voice Management/Advanced Settings
   • The three fields that must be entered correctly are located under Group’s Mail Server. They are, E-mail Address, User ID, and Password.
   • Three Email Creation Modes:
     • USERID
       • The User portion of the e-mail address must match the User portion of their BroadWorks User ID. The domain portion of the e-mail address must match the domain specified within the SurgeSuppressor configuration file.
       • The User Id field must match the user portion of the e-mail address.
     • PATTERN
       • The SurgeMail account will be created with an ID that matches the pattern provided in the properties file. The UserId of the email field and the UserId field need to match the pattern generated UserId. The domain portion of the e-mail address must match the domain specified within the SurgeSuppressor configuration file.
       • The User Id field must match the user portion of the e-mail address.
     • PERMISSIVE
       • SurgeSuppressor will create a SurgeMail email account based on the UserId provided by the provisioner.
       • The User Id field must match the user portion of the e-mail address.
   • The password can be chosen, but cannot match the user id as SurgeMail does not allow it. We recommend random letters and numbers.
   • Upon submitting the page, the mailbox will be created.
2. Mail Account Modification
   • If a mail account already exists and the password is modified on the Advanced Voice Management Settings, SurgeSuppressor will change the password within SurgeMail.
3. Mail Account Deletion
   • This option is not available when using the PERMISSIVE Email Creation Mode.
   • There are two triggers for Mail Account Deletion.
     • If the user is deleted from BroadWorks or
     • if the Voice Messaging User service is removed from the user.
   • If the option to rename accounts rather than delete them is enabled in the configuration file, then the old mail account will be renamed with the convention - [Old Name]_[Date]_[Time] - Where date and time refer to the time of “deletion.”

Setup

• Refer to the full installation guide.