diff --git a/content-accelerator/images/ACA_amp-custom-aspect.png b/content-accelerator/images/ACA_amp-custom-aspect.png new file mode 100644 index 0000000000..eb9b164f1e Binary files /dev/null and b/content-accelerator/images/ACA_amp-custom-aspect.png differ diff --git a/content-accelerator/images/ACA_amp-custom-model.png b/content-accelerator/images/ACA_amp-custom-model.png new file mode 100644 index 0000000000..41be4ccecc Binary files /dev/null and b/content-accelerator/images/ACA_amp-custom-model.png differ diff --git a/content-accelerator/latest/configure/notifications-and-notes.md b/content-accelerator/latest/configure/notifications-and-notes.md index 511e9dcc69..87c0e8720d 100644 --- a/content-accelerator/latest/configure/notifications-and-notes.md +++ b/content-accelerator/latest/configure/notifications-and-notes.md @@ -226,3 +226,48 @@ The default note object type is "hpi_note". To configure otherwise, replace this Ensure that the Note Relationship option is configured to : `hpi:folder_note (alfresco)` + +## Subscription and Distribution + +Subcriptions and distributions can be utilized to notify users about changes to documents. + +### Subscription + +ACA allows users to subscribe to a document. + +Actions to configure: + +* Subscribe (allows a user to subscribe to a document) +* Unsubscribe (allows a user to unsubscribe to a document) + +Dashlets to configure: + +* My Subscriptions (allows users to see all documents they are subscribed to on the ACA dashboard) + +When a user is subscribed to a document they will receive an ACA notification and an email when the document they are subscribed to is modified in a way that meets the configured notification criteria for the subscription action (for more information see [Configuring Notifications for Subscription and Distribution](#configuring-notifications-for-subscription-and-distribution)). + +### Distribution + +Distribution lists allow users to define (at index time or later) what users and groups should be notified about changes to a document. + +### Configuring Notifications for Subscription and Distribution + +The following properties define when notifications should be sent for subscriptions and distributions: + +```text +# Configuration for the Distributions List and Subscription List behaviors, which will send users and/or groups a notification when a +# property is updated to a given value. The users and groups that will receive the notification are based on +# values on the properties set in the tsg:distributionsAttrs and tsg:subscriptionAttrs aspects. +# The list of QNames of the properties to check. If this property does not exist on the node, no notifications will be sent. +# Example {http://www.tsgrp.com/model/tsg/1.0}status|{tsg.engineering}status +alfresco.notifications.criteriaProperty= +# A pipe separated list of comma-separated lists of values; each value list corresponds to the above property list +# When a node's property is set to one of these values, a notification is sent +# Example: Approved,Effective,Obsolete|Released +alfresco.notifications.criteriaPropertyValues= +# The QName of the attribute that will identify the document in the notification and email. For example, this could be +# the QName for the node name or document number. If the document doesn't have this property the cm:name will be used. +alfresco.notifications.identificationPropQName= +``` + +In summary, these properties allow to configure according to the statament: "when X property changes to value Y I want an email to be sent to subscribed users and I want the document name in the email to be Z property value". \ No newline at end of file diff --git a/content-accelerator/latest/develop/extension-content-accelerator.md b/content-accelerator/latest/develop/extension-content-accelerator.md index 5ad44f4b25..4213e692a6 100644 --- a/content-accelerator/latest/develop/extension-content-accelerator.md +++ b/content-accelerator/latest/develop/extension-content-accelerator.md @@ -33,4 +33,21 @@ When you add a new document type extension for use in Alfresco Content Accelerat > **Note:** In many ACA Policy and Procedure implementations, dedicated per-version renditions are a regulatory requirement. -If, however, the `tsg:renditioned` aspect is not desired, or the model already exists and cannot be updated, it is possible to turn on view time renditioning in the [Document Viewer]({% link content-accelerator/latest/configure/admin-guide.md %}#document-viewer) config in the Stage. \ No newline at end of file +If, however, the `tsg:renditioned` aspect is not desired, or the model already exists and cannot be updated, it is possible to turn on view time renditioning in the [Document Viewer]({% link content-accelerator/latest/configure/admin-guide.md %}#document-viewer) config in the Stage. + +## How to deploy Alfresco custom content model in Alfresco Content Accelerator + +Once you create a custom AMP, the next step is to deploy it to an Alfresco container and validate that the AMP is applied correctly. For more information see [Install Alfresco Module Package]({% link content-services/latest/install/zip/amp.md %}). + +When the custom AMP is deployed successfully: + +* If a default AMP custom model was installed, a `sample_document` is deployed. The custom content type can be found in the **ACA Admin Console**. +![AMP custom model]({% link content-accelerator/images/ACA_amp-custom-model.png %}) + * Select the document type and configure the properties as required. + * Click **Save Config** at the bottom of the page to save and apply the changes. +* If a default AMP custom aspect was installed, a `sample_aspect` is deployed. It can be added to the **Non-Mandatory Aspect** section in the **ACA Admin Console**. +![AMP custom aspect]({% link content-accelerator/images/ACA_amp-custom-aspect.png %}) + * Select the aspect and configure the properties as required. + * Click **Save Config** at the bottom of the page to save and apply the changes. + +The newly created Object Type and Non-Mandatory Aspect can be used to create new forms in ACA. For more information see [Admin Guide]({% link content-accelerator/latest/configure/admin-guide.md %}). \ No newline at end of file