diff --git a/source/reference/modules/studio.rst b/source/reference/modules/studio.rst index 52fc2a2cb..eaf067b9c 100644 --- a/source/reference/modules/studio.rst +++ b/source/reference/modules/studio.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.4.3 +:last-updated: 5.0.0 .. highlight:: xml @@ -97,10 +97,12 @@ In this section, we will highlight some of the more commonly used properties in - Configure capabilities for CloudFormation stack * - :ref:`Validations Regex ` - Configure the regex used for validating various inputs + * - :ref:`Notification Service Configuration ` + - Configure the notification service for workflow * - :ref:`Disk Monitoring ` - Configure the disk monitoring notifications and thresholds * - :ref:`Workflow Notification Configuration ` - - Configure the workflow notifications + - Configure the HTML notifications sent at each point in the workflow * - :ref:`Commit Message ` - Configure the commit messages used by Crafter Studio * - :ref:`Audit Log ` @@ -2878,7 +2880,7 @@ All configuration for the notification system is done by a site admin (on a per Where ''''' .. code-block:: xml - :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notifications.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* ... @@ -2956,7 +2958,7 @@ Configure Who Gets Notifications Configure who gets notifications by entering the email addresses of the people you want to send notifications to, in between the tags ```` and/or ```` .. code-block:: xml - :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notifications.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* :linenos: @@ -2979,7 +2981,7 @@ Configure Studio Workflow Dialog Messages Below is a sample of Studio workflow dialog messages defined in our notifications configuration file. .. code-block:: xml - :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notifications.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* :linenos: @@ -3018,10 +3020,16 @@ Below is a sample of Studio workflow dialog messages defined in our notification ~~~~~~~~~~~~~~~~~~~ Configure Templates ~~~~~~~~~~~~~~~~~~~ -Below is an example of a configured email messages for each point in the workflow, found in between the tag in the notifications configuration file. +Below is an example of a configured email messages for each point in the workflow, found in between the tag +```` in the notifications configuration file. + +.. raw:: html + +
+ Configured email messages in the notifications configuration file .. code-block:: xml - :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notifications.xml* + :caption: *CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/notification-config.xml* :linenos: @@ -3040,15 +3048,15 @@ Below is an example of a configured email messages for each point in the workflo The following content was unable to deploy:
    <#list files as file> -
  • ${file.internalName!file.name}
    • +
  • ${file.action}: ${file.path} from package ${file.packageId}. + <#if file.liveError != 0>Live error: ${file.liveError?c}<#if file.stagingError != 0>Stage error: ${file.stagingError?c}
- Error:
- ${deploymentError.toString()} + <#if deploymentError?has_content> + Error:
+ 
${deploymentError}
+

- - -

@@ -3056,7 +3064,7 @@ Below is an example of a configured email messages for each point in the workflo - Content Scheduled <#else>Content Approved]]> + Content Scheduled <#else>Content Approved]]> @@ -3066,29 +3074,37 @@ Below is an example of a configured email messages for each point in the workflo

- <#if scheduleDate??> - The following content has been scheduled for publishing on ${scheduleDate?string["MMM dd, yyyy 'at' hh:mm a"]} Eastern Time. + <#if publishPackage.packageType == 'INITIAL_PUBLISH'> + ${reviewer.first_name!submitter.username} ${reviewer.last_name} has approved your initial publish request. + <#elseif publishPackage.packageType == 'PUBLISH_ALL'> + ${reviewer.first_name!submitter.username} ${reviewer.last_name} has approved your publish all request. <#else> The following content has been reviewed and approved by ${approver.firstName!approver.username} ${approver.lastName!""}:


+ Site: ${siteName} +
<#if scheduleDate??> - Click Here to View Your Published Content -
+ Scheduled date: ${publishPackage.schedule?datetime.iso?string["MMM dd, yyyy 'at' hh:mm a"]} Eastern Time. +
- - - + Target: ${publishPackage.target} +
+ Reviewer comment:
+ ${publishPackage.reviewerComment!""} +

@@ -3105,28 +3121,44 @@ Below is an example of a configured email messages for each point in the workflo

- ${submitter.firstName!submitter.username} ${submitter.lastName} has submitted items for your review: -

- <#if submissionComments?has_content> + <#if publishPackage.packageType == 'PUBLISH_ALL'> + ${submitter.first_name!submitter.username} ${submitter.last_name} has submitted a 'publish all' request for your review. + <#elseif publishPackage.packageType == 'INITIAL_PUBLISH'> + ${submitter.first_name!submitter.username} ${submitter.last_name} has submitted an 'initial publish' request for your review. + <#else> + ${submitter.first_name!submitter.username} ${submitter.last_name} has submitted items for your review: + + <#if files?? && files?size gt 0> + + +
+ Site: ${siteName} +
+ <#if publishPackage.submitterComment?has_content> Comments:
- ${submissionComments!""} + ${publishPackage.submitterComment!""} +
+ + <#if publishPackage.schedule??> + Scheduled date: ${publishPackage.schedule?datetime.iso?string["MMM dd, yyyy 'at' hh:mm a"]} Eastern Time.
-
- Click Here to View Content Waiting for Approval + + Target: ${publishPackage.target} +
+ Click Here to View Content Waiting for Approval

- - -

@@ -3143,24 +3175,40 @@ Below is an example of a configured email messages for each point in the workflo

- The following content has been reviewed and requires some revision before it can be approved: -

+ <#if publishPackage.packageType == 'INITIAL_PUBLISH'> + ${reviewer.first_name!submitter.username} ${reviewer.last_name} has reviewed your initial publish request and it requires some revision before it can be approved: + <#elseif publishPackage.packageType == 'PUBLISH_ALL'> + ${reviewer.first_name!submitter.username} ${reviewer.last_name} has reviewed your publish all request and it requires some revision before it can be approved: + <#else> + ${reviewer.first_name!submitter.username} ${reviewer.last_name} has reviewed the following content that requires some revision before it can be approved: + + <#if files?? && files?size gt 0> + + +
+ Site: ${siteName} +
+ <#if publishPackage.schedule??> + Scheduled date: ${publishPackage.schedule?datetime.iso?string["MMM dd, yyyy 'at' hh:mm a"]} Eastern Time. +
+ + Target: ${publishPackage.target} +
Reason:
- ${rejectionReason!""} -

- - - + ${publishPackage.reviewerComment!""} +

@@ -3170,6 +3218,10 @@ Below is an example of a configured email messages for each point in the workflo +.. raw:: html + +
+ |hr| .. _studio-validations-regex: @@ -3212,6 +3264,56 @@ The following section of Studio's configuration overrides allows you to configur |hr| +.. _notification-service-configuration: + +"""""""""""""""""""""""""""""""""" +Notification Service Configuration +"""""""""""""""""""""""""""""""""" +CrafterCMS can send out notification emails on each point of the workflow. +The following allows you to configure the notification service: + +.. list-table:: Notification Service Properties + :header-rows: 1 + + * - Property + - Description + * - studio.workflow.notification.maxItemCount + + .. version_tag:: + :label: Since + :version: 5.0.0 + + - The maximum number of items included in the notification messages + + * - studio.workflow.notification.enabled + - Enables/disables notification messages on workflow events + * - studio.notification.configurationFile + - The location of the workflow notifications configuration file + * - studio.notification.timezone + - The timezone used in the notification emails + +| + +The notification service properties listed above can be customized by overriding them using one of the override +files. Here are the default values configured: + +.. code-block:: yaml + + ############################################################## + ## Notification Service ## + ############################################################## + # Maximum number of items to include in the workflow notification messages + studio.workflow.notification.maxItemCount: 10 + # Enable/disable notification messages on workflow events + studio.workflow.notification.enabled: true + # Path where the notification configuration is located + studio.notification.configurationFile: workflow/notification-config.xml + # Timezone for the email template engine (which determines how FreeMarker interprets `now` etc.) + studio.notification.timezone: UTC + +To learn more on configuring the workflow notification emails being sent, see +:ref:`Workflow Notification Configuration `. + .. _studio-disk-monitoring: """""""""""""""