MySource Matrix Developer

Content Tools

Main Content

Customisation of Workflow Emails

Summary

This document proposes a new functionality for the workflow notification emails.

Status: Draft
Key: draft -> approved proposal -> scheduled -> in development -> in testing -> complete -> released

Estimated Start Date: Fri, 19 May 2006
Estimated End Date: Fri, 19 May 2006

This feature is not scheduled for release

Problem Definition

Currently, workflow notification emails are generated by Matrix automatically and the message contents cannot be modified by users. Matrix System administrators should be able to customise the workflow email contents.

Technical Specification

Workflow Asset Changes

Two new bodycopies will be added to the workflow asset. These bodycopies will be created when the new option customise email contents in details screen of the workflow asset is enabled. If this option is not enabled then Matrix will continue to create emails with the usual workflow email content. Structure of the workflow asset when customise email contents is enabled shown below.

Workflow Asset (workflow)
|_ Email Formats (folder)
  |_ Main Body Format (bodycopy)
  |_ Asset List Format (bodycopy)
Workflow Email Keywords
Main Body Format Keywords

Following keywords will be available for the main body format:

  • current_user_name
  • current_user_name
  • current_datetime
  • recipient_user_name

Asset List Format Keywords

Following keywords will be available for the asset list format:

  • asset_name
  • asset_type_code
  • asset_workflow_url
  • asset_workflow_backend_url
  • asset_workflow_limbo_url
  • asset_preview_url

Messaging Service Changes

Matrix messaging service will need to accept a new parameter, message body contents parameter will have the contents of the email and if this parameter is set then Matrix messaging service will use this content for the message/email body instead of the getInternalMessageBody() function.