Documentation Summary

Product Notifications

Troubleshooting

Compatibility

Only Kit Components are considered in within the document loop of Product Notifications. This means the top-level Kits never appear in the notifications.

If the Kit’s notification recipient Metadata Field is defined, then all of its components treat this address as their recipient email address, regardless of whether those products have a different email address defined in their metadata fields.

On the other hand, if the Kit’s email address is blank, then the email recipient in the Kit Component’s metadata is used to determine who to notify. If both of these values are blank, then no notifications are sent for the Kit Component.

Limitations

The extension does not take part in events raised by the Split-Payment nor Split-Shipping procedures.
Emails are sent right after an Order is placed.
In case download links to the final output artwork are included in the notification, the email notifications are delayed until the artwork has been rendered.

The extension rules out designs which are marked by other extensions by setting the designs’s PrintingField ExcludedFromProductNotifications.

This is the case with the RightMarket Document Workflow extension which marks Designs derived from Templates set up as a Download Product.

The communication with the SMTP mail server is configured on the page Administration > Notifications where the SSL port settings are hidden when the Use SMTP Authentication is set No. This Extension doesn’t use the Secure Sockets Layer (SSL) to send mails if the Use SMTP Authentication is set No even if the previous - and now invisible - configuration is still left Use SSL Yes, SSL Port 443. Instead, when Use SMTP Authentication is No, then this Extension leaves the default - no SSL and the standard port 25.

Known Issues

Not applicable.

Logging

The site-log contains messages recorded by the Extension as the ordered Designs are processed. Please look for the messages which contain the Product Notifications text. The messages contain the information on what has been sent to whom.

Debugging

The site-log should always contain any exceptions thrown during the Extension function. Please look for error messages which contain the text Product or Notifications.

When a user places an Order, this Extension checks each ordered Design. If there is a Design to be approved among the ordered Designs or if there’s a need to wait for the final rendering, then an Order Field value is recorded for that specific Order in the OrderFieldValues database table. It is called ProductNotificationsDocBatch and can be displayed using this query:

SELECT a.OrderGroupID, a.FieldValue
FROM OrderFieldValues a JOIN Names b ON b.NameID = a.FieldNameID
WHERE b.StringValue = 'ProductNotificationsDocBatch'
ORDER BY a.OrderGroupID DESC

The value itself may look like this:

120388:Done,120396: 120397:,120398:Done
The pipe “ ” character separates the “batches”, the comma “,” character separates the Designs. A batch represents one or more Designs referred to in one single email. The Extension sends the email after all of the Designs in a batch are rendered (or approved). In such a case, all of the values after the colon are “Done”.

In the example above, there are two batches, both of which have a design which is not “Done”, so neither would have sent notifications.