Custom-metadata

As we transition to the new Hyland Community, some post links may be temporarily disrupted as we finalize redirects. We apologize for the inconvenience and are working to resolve this as quickly as possible. Details.

rise_mini

Hi,
I have added some custom fields in MS-Word doc and try to upload that file into Alfresco using 'add content' wizard.
I have created custom model and follow the steps that are given in  http://ecmarchitect.com/images/articles/alfresco-content/content-article.pdf.
But the custom properties are showing; their values are not shown.
I have searched a lot but there is no help that i found.
I guess i have to create Custom metadata extractor but what should I write in that java class. There is not a single tutorial regarding that.
Please help.

Thanks

rise_mini

Hi,
At last i have done what i wanted. 
These are the steps that I have followed.
1- Create Java Project in Eclipse. Project structure should be as-
    /config/alfresco/extension/model
    /lib
    /src/java
   
2- Download sdk of your version of alfresco.

3- Import Sdk AlfrescoEmbedded project into eclipse.

4- Add Sdk AlfrescoEmbedded into your project's build path.

5- Create custom model.xml at /config/alfresco/extension/model.

6- Create all the below files at /config/alfresco/extension
    i- custom context xml -  define path for your model xml file.
    ii- web-client-config-custom.xml - define custom content model at different location like- Action Wizard, Advance Search etc.
    iii- custom extracter xml - define path of custom mapping properties files.
    1v- custom mapping properties file - define mapping of properties.

7- I have to extract custom properties of MS-Doc, i.e. I have written java class.
    i- create package in /src/java.
    ii- good practice is to create package structure as com/<company-name>/extracter.

8- Create property file with the name of your java class and paste the content given below-
  

#
# OfficeMetadataExtracter - default mapping
#
# author: Derek Hulley

# Namespaces
namespace.prefix.cm=http://www.alfresco.org/model/content/1.0


# Mappings
author=cm:author
title=cm:title
subject=cm:description
createDateTime=cm:created
lastSaveDateTime=cm:modified‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

9- Create build.xml. Sample code can be found from the link given in alfresco developer guide.

<?xml version="1.0" encoding="UTF-8"?>
<project name="Custom Content Model Extensions" default="deploy" basedir=".">
&nbsp;&nbsp;&nbsp;<property file="build.properties" />

&nbsp;&nbsp;&nbsp;<property name="label" value="ch4" />
&nbsp;&nbsp;&nbsp;<property name="project.dir" value="." />
&nbsp;&nbsp;&nbsp;<property name="build.dir" value="${project.dir}/build" />
&nbsp;&nbsp;&nbsp;<property name="bin.dir" value="${project.dir}/bin" />
&nbsp;&nbsp;&nbsp;<property name="lib.dir" value="${project.dir}/lib" />
&nbsp;&nbsp;&nbsp;<property name="project.name" value="custom-client-extensions" />
&nbsp;&nbsp;&nbsp;<property name="package.file.zip" value="${build.dir}/${project.name}.zip" />
&nbsp;&nbsp;&nbsp;<property name="package.file.jar" value="${build.dir}/${project.name}.jar" />
&nbsp;&nbsp;&nbsp;<property name="project.file.zip" value="${build.dir}/${project.name}-project-${label}.zip" />
&nbsp;&nbsp;&nbsp; <property name="package.file.amp" value="${build.dir}/${project.name}.amp" />
&nbsp;&nbsp;&nbsp;<property name="source.dir" value="${project.dir}/src" />
&nbsp;&nbsp;&nbsp;<property name="config.dir" value="${project.dir}/config" />
&nbsp;&nbsp;&nbsp;<property name="web.dir" value="${source.dir}/web" />
&nbsp;&nbsp;&nbsp;<property name="extension.dir" value="/alfresco/extension" />

&nbsp;&nbsp;&nbsp;<path id="classpath.server">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<fileset dir="${alfresco.sdk.dir}/server" includes="**/*.jar" />
&nbsp;&nbsp;&nbsp;</path>

&nbsp;&nbsp;&nbsp;<path id="classpath.remote">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<fileset dir="${alfresco.sdk.dir}/remote" includes="**/*.jar" />
&nbsp;&nbsp;&nbsp;</path>&nbsp;&nbsp;&nbsp;

&nbsp;&nbsp;&nbsp;<path id="classpath.local">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<fileset dir="${project.dir}/lib" includes="**/*.jar" />
&nbsp;&nbsp;&nbsp;</path>

&nbsp;&nbsp;&nbsp;<path id="classpath.build">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <fileset dir="${build.dir}" includes="**/*.jar" />
&nbsp;&nbsp;&nbsp; </path>
&nbsp;&nbsp;&nbsp; 
&nbsp;&nbsp;&nbsp;<target name="clean" description="Removes all generated files">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${build.dir}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${bin.dir}" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;</target>

&nbsp;&nbsp;&nbsp;<target name="clean-tomcat" description="Removes deployed extension directory, lib/someco*.jar, and someco/" >
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${alfresco.web.dir}/WEB-INF/classes/alfresco/extension" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${alfresco.web.dir}/WEB-INF/classes/alfresco/module" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${alfresco.web.dir}/jsp/extension" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete dir="${alfresco.web.dir}/someco" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete file="${alfresco.web.dir}/WEB-INF/lib/someco-alfresco.jar" />
&nbsp;&nbsp;&nbsp;</target>

&nbsp;&nbsp;&nbsp;<target name="setup" description="Creates the ${build.dir} and ${bin.dir} directories">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<mkdir dir="${build.dir}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<mkdir dir="${bin.dir}" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;</target>

&nbsp;&nbsp;&nbsp;<target name="package-extension" depends="setup, package-jar" description="Creates a zip called ${package.file.zip} which can be unzipped on top of an exploded Alfresco web app">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete file="${package.file.zip}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zip destfile="${package.file.zip}" update="true">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${config.dir}${extension.dir}" prefix="WEB-INF/classes${extension.dir}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset file="${package.file.jar}" prefix="WEB-INF/lib" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${lib.dir}" prefix="WEB-INF/lib" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${web.dir}" excludes="META-INF/**" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</zip>
&nbsp;&nbsp;&nbsp;</target>
&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;<target name="package-amp" depends="setup, package-jar" description="Packages the customizations as an Alfresco module in ${package.file.amp}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete file="${package.file.amp}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zip destfile="${package.file.amp}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset file="${package.file.jar}" prefix="lib" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${web.dir}" prefix="web" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${config.dir}${extension.dir}/model" prefix="config${module.dir}/${module.id}/model" />
 &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<!–<zipfileset file="${config.dir}${extension.dir}/someco-model-context.xml" prefix="config${module.dir}/${module.id}" />–>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset file="${config.dir}${extension.dir}/web-client-config-custom.xml" prefix="config${module.dir}/${module.id}/ui" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</zip>
&nbsp;&nbsp;&nbsp;</target>
&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;<target name="install-amp" depends="package-amp" description="Uses the Alfresco MMT to install the AMP into ${alfresco.war.path}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <java dir="." fork="true" classname="org.alfresco.repo.module.tool.ModuleManagementTool">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<classpath refid="classpath.server"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <arg line="install ${package.file.amp} ${alfresco.war.path} -force -verbose"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </java>
&nbsp;&nbsp;&nbsp; </target>
&nbsp;&nbsp;&nbsp; 
&nbsp;&nbsp;&nbsp; <target name="deploy-amp" depends="install-amp" description="Unzips the AMP'd WAR file into ${alfresco.web.dir}">
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<unzip src="${alfresco.war.path}" dest="${alfresco.web.dir}" />
&nbsp;&nbsp;&nbsp; </target>

&nbsp;&nbsp;&nbsp;<target name="deploy" depends="package-extension" description="Unzips the ${package.file.zip} into ${alfresco.web.dir}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<unzip src="${package.file.zip}" dest="${alfresco.web.dir}" />
&nbsp;&nbsp;&nbsp;</target>

&nbsp;&nbsp;&nbsp;<target name="zip-project" depends="setup" description="Zips the entire Eclipse project as-is into ${project.file.zip}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete file="${project.file.zip}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zip destfile="${project.file.zip}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<zipfileset dir="${project.dir}" excludes="build/** bin/**" prefix="${project.name}-${label}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</zip>
&nbsp;&nbsp;&nbsp;</target>&nbsp;&nbsp;&nbsp;

&nbsp;&nbsp;&nbsp;<target name="compile" description="Compiles src to ${bin.dir}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<mkdir dir="${bin.dir}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<javac srcdir="${source.dir}/java" destdir="${bin.dir}" source="1.5" target="1.5" debug="on" fork="yes" deprecation="on">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<classpath refid="classpath.server"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<classpath refid="classpath.remote"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<classpath refid="classpath.local"/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</javac>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<!– copy in non-compiled files like props if needed –>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<copy todir="${bin.dir}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<fileset dir="${source.dir}/java" excludes="**/*.java"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</copy>
&nbsp;&nbsp;&nbsp;</target>
&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;<target name="package-jar" depends="setup, compile"
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description="Jars up the compiled classes and ${web.dir}/META-INF into ${package.file.jar}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<delete file="${package.file.jar}" />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<jar destfile="${package.file.jar}">
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<fileset dir="${bin.dir}" includes="com/**" />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</jar>
&nbsp;&nbsp;&nbsp;</target>
&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;
</project>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

10- Create build.properties and define two path-
      i- alfresco.sdk.dir= <path to sdk dir >
      ii- alfresco.web.dir= <path to webapps/alfresco folder of tomcat dir >

11- Right click on build.xml and select run as ant build. This will create jar with name custom-client-extension.jar(as defined in build.xml) and copy it into alfresco lib under tomcat.
It also create model folder and all other file at extension dir inside webapps/alfresco/WEB-INF/classes/alfresco/extension.

12- restart the tomcat and create one space and define rule on that space.
      i- condition
            # item of type or sub-type
      ii- action
           # special type
           # add aspect
           # extract common metadata fields

13- Upload any file into that space and select custom content model from type field and see the result.

Note- Try to read 2nd and 3rd chapter of Alfresco developer guide before starting the work.