Implementing the custom Metadata Template for the acme:document type - Alfresco Content Services - 23.4 - 23.4 - Ready - Alfresco - external

Call the file add-metadata-template-doclib-extension-modules.xml and save it in the aio/aio-share-jar/src/main/resources/alfresco/web-extension/site-data/extensions directory (note. it is important to give this file a unique name when several Share JARs are installed, otherwise the last one wins).

Then define the custom Metadata Template as follows:

<extension>
    <modules>
        <module>
            <id>Add Acme Document Metadata Template</id>
            <version>1.0</version>
            <auto-deploy>true</auto-deploy>
            <configurations>
                <config evaluator="string-compare" condition="DocumentLibrary">
                    <metadata-templates>
                        <template id="acmeDocMetadataTemplate">
                            <evaluator>alfresco.tutorials.evaluator.isAcmeDocument</evaluator>
                            <banner index="10" id="lockBanner" evaluator="evaluator.doclib.metadata.hasLockBanner">{lockBanner}</banner>
                            <banner index="20" id="syncTransientError" evaluator="evaluator.doclib.metadata.hasSyncTransientErrorBanner">{syncTransientError}</banner>
                            <banner index="30" id="syncFailed" evaluator="evaluator.doclib.metadata.hasSyncFailedBanner">{syncFailed}</banner>
                            <line index="10" id="date">{date}{size}</line>
                            <line index="20" id="description" view="detailed">{description}</line>
                            <line index="30" id="tags" view="detailed">{tags}</line>
                            <line index="40" id="categories" view="detailed" evaluator="evaluator.doclib.metadata.hasCategories">{categories}</line>
                            <line index="50" id="acmeDocId" view="detailed">{acme_documentId org.alfresco.tutorial.label.acme_documentId}</line>
                            <line index="60" id="social" view="detailed">{social}</line>
                        </template>
                    </metadata-templates>
                </config>
            </configurations>
        </module>
    </modules>
</extension>

What we have done here is basically copied the metadata template with the identifier <template id="default"> from the /alfresco/tomcat/webapps/share/WEB-INF/classes/alfresco/share-documentlibrary-config.xml configuration file. Then added the line with id="acmeDocId" just before the social properties. We have also added a custom evaluator to the template that will only return true if the node in question has the type acme:document applied.

The different attributes and sub-elements for the template element have the following meaning:

We can use the existing aio/aio-share-jar/src/main/resources/alfresco/web-extension/messages/aio-share-jar.properties file for this. Add the following property to it:

org.alfresco.tutorial.label.acme_documentId=Acme Doc ID

This evaluator should return true if the node is of type acme:document. This is done in the aio/aio-share-jar/src/main/resources/alfresco/web-extension/aio-share-jar-slingshot-application-context.xml Spring context file:

...
    <beanid="alfresco.tutorials.evaluator.isAcmeDocument"parent="evaluator.doclib.action.nodeType">
        <property name="types">
            <list>
                <value>acme:document</value>
            </list>
        </property>
    </bean>
</beans>

Here we are using a built in evaluator called evaluator.doclib.action.nodeType. It can be used to evaluate if a node is of a specific type. We set the bean id so it matches what we specified above as <metadata-template><evaluator>. We add only the content type QName for the Acme Document type (i.e. acme:document) in the list.

There are a number of predefined evaluators (i.e. out of the box evaluators ready to use):

• Has aspect
• Is mimetype
• Property not Null
• Site preset
• Site / No Site
• Container Type
• Node Type
• Always false
• Value-based
• Metadata value
• Is Browser (type)
• Is Portlet mode

See the slingshot-documentlibrary-context.xml file located in the alfresco/tomcat/webapps/share/WEB-INF/classes/alfresco directory of your Content Services installation for more information about out-of-the-box evaluators.

/all-in-one$ ./run.sh build_start

Clicking the new menu item brings up a form that looks like this:

Note the custom field for the document identifier at the bottom of the form. Fill in some values for the Name, Title, and Descriptor fields. Give the Document Identifier a value of DOC001 and then click the Create button.