EmailPlus package

The HCL Compass EmailPlus package provides enhanced email notification functions. EmailPlus includes the following support:

  • Customizing the content of the message subject and body with boilerplate text
  • Including dynamic content in emails in addition to field old or new values
  • Including rich content (HTML)
  • Providing access to SMTP restricted servers
  • Attaching files to email
  • Allowing enhanced conditions to construct the rules
  • Allowing the self-subscription of users to rule or record notifications
  • Enabling enterprise-wide configuration of email notifications, which can be enabled or disabled by users
  • Providing performance improvements through queries
  • Extending the rules and data displayed through customer-provided extensions

The EmailPlus package is implemented in Perl.
Note: To configure the EmailPlus in Perl:
  • Login to HCL Compass Designer and add EmailPlus package to schema.
  • Edit the global Perl Script EMP_Customisable and add to the start of the code:
    $MAX_FIELDPATH_RECURSE_DEPTH = 2;;
    
    $FIELDPATH_INCLUDE_STRINGS = 1;;
  • Configure EmailPlus to use SMTP Direct5 and create Email Rule that sends an email through the descriptionfield.

If you enter one (1) userid the EmailPlus works. If you enter, a newline or comma, the EmailPlus does not send the email.

Although the package is implemented in Perl, it can be used to enable VBScript-based schemas because packages have their own scripting language defined.

The package can be added to any HCL Compass schema. You can deploy the package in mixed environments to HCL Compass Web or to HCL Compass clients that run on Microsoft™ Windows™, UNIX™, or Linux™.

The possibility of name conflicts are minimized by prefixing routine names with EMP_ and by prefixing session name values with EMP::. Avoid using names like these to ensure that the package can coexist with other packages in your schema.

Note: The EmailPlus package is installed into the packages directory where it is available for the schema developer to incorporate into your schema.
Attention: If you are using the ALM 1.1 package, and you plan to upgrade to the latest EmailPlus package, references to EmailPlus 2.0 apply to you.