topic Re: Custom Document types / Models in RM in Alfresco Archive

Custom Document types / Models in RM

fpp — Tue, 19 Jan 2010 17:08:19 GMT

I'm trying to use custom document types / custom models in use within the document management inside the RM module.Changed the imports in the customRecordsModel.xml and trying to copy the files from the DM to the RM within an existing fileplan (DoD sample).When copying cm:content document type files

Re: Custom Document types / Models in RM

carlos_miguens — Thu, 21 Jan 2010 11:49:23 GMT

You should be able to edit the metadata on an undeclared record. If you declare the record first then you'll need a capability to edit metadata and so the action won't be present.

Re: Custom Document types / Models in RM

fpp — Thu, 21 Jan 2010 16:37:42 GMT

Carlos,

not being able to edit the meta data for documents with custom types (/ ? custom aspects) together with not being recognized as undeclared record is the problem here. You can do all what you describe when the document is of cm:content i.e. the built-in document type.

Documents that are copied into RM with a custom type from DM are not even recognized as undeclared records. The custom properties etc are nevertheless displayed on the document detail page.

Guess there's another day of debugging ahead of me to find out where the problem needs to be tweaked out so that this work. My current guessing is that I might have to tell the record management module "a bit more" about the document types than just importing the model (as mentioned in my earlier posting)

fpp

Re: Custom Document types / Models in RM

mikeh — Thu, 21 Jan 2010 18:03:13 GMT

It's likely the evaluator function getAssetType() in config/alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/dod5015-evaluator.lib.js

You can either add your custom type just above cm:content so the code falls through, or add some logic to the default case to check the node is a subtype of cm:content

if (asset.isSubType("cm:content")) …‍

and calculate the assetType in the same way as is currently done for cm:content.

Would be interested to hear what results you get.

Thanks,
Mike

Re: Custom Document types / Models in RM

fpp — Thu, 21 Jan 2010 18:11:26 GMT

Many thanks for the tip Mike, try that tonight - keep you posted.

fpp

Re: Custom Document types / Models in RM

fpp — Fri, 22 Jan 2010 11:40:19 GMT

Update:

Mike, right on the spot.

When adding cases for each of the custom document types within the asset type switch, copying documents from DM to RM works for these types as well.

I've just duplicated the cm:content case for each of the custom types and now dod5015-doclist.get.js (where the dod5015-evaluator.lib.js is imported) does not fall back to the general "document" asset type anymore which it can not process further.

         case "xx:CustomDocType":
            if (asset.hasAspect("rma:record"))
            {
               assetType = "undeclared-record";
               if (asset.hasAspect("rma:declaredRecord"))
               {
                  assetType = "record";
                  if (asset.hasAspect("dod:ghosted"))
                  {
                     assetType = "metadata-stub";
                  }
               }
            }
            break;
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Editing Meta Data as well as declaring the document a record works fine. All properties from the document management seem to be preserved including DM tags and DM categories. Based on the node browser it looks like there is a 1:1 copy created with the RM. There is no reference back to the DM node (good). Deleted the original node within the DM without a problem so far.

Now I just have to create another set of document detail forms to display the properties & aspects as the DoD5015 document details falls back to a default form (all node properties displayed).

fpp

Re: Custom Document types / Models in RM

mikeh — Fri, 22 Jan 2010 12:06:06 GMT

Thanks for the feedback. By the way, no need to duplicate the code for your custom type, just follow the "rma:nonElectronicDocument" example:

case "xx:CustomDocType":
   // Fall-through
case "rma:nonElectronicDocument":
   // Fall-through
case "cm:content":
   if (asset.hasAspect("rma:record"))
   …‍‍‍‍‍‍‍

Thanks,
Mike

Re: Custom Document types / Models in RM

fpp — Fri, 22 Jan 2010 16:29:03 GMT

Used the cm:content as base to be able to declare the document as record and later use it like other records. Might work otherwise as well but have not tried it.

So by that you get one case switch for all similar custom document types (based on cm:content)

case "xx:CustomDocType1": "xx:CustomDocType2": "xx:CustomDocType3":
            if (asset.hasAspect("rma:record"))
            {
….
‍‍‍‍‍

fpp

Re: Custom Document types / Models in RM

f_tasso — Fri, 05 Mar 2010 16:29:17 GMT

Hi,

I wanted to ask if you can explain in more detail the process to import documents of type "custom content" from the Alfresco Repository to RM.
I have created a custom content in this way:

<!– Definition of new Content Type: Fattura vendita –>
      <type name="my:fv">
         <title>Fattura vendita</title>
         <parent>cm:content</parent>
         <properties>
         <property name="my:NomeCliente">
            <type>d:text</type>
            <mandatory>true</mandatory>
         </property>
         <property name="myIVA">
            <type>d:text</type>
            <mandatory>true</mandatory>
         </property>
         <property name="my:CF">
            <type>d:text</type>
            <mandatory>true</mandatory>
         </property>
         <property name="my:Numero">
            <type>d:text</type>
            <mandatory>true</mandatory>
         </property>
            <property name="myata">
               <type>d:datetime</type>
            <mandatory>true</mandatory>
            </property>
         <property name="my:Importo">
            <type>d:int</type>
            <mandatory>true</mandatory>
         </property>
         <property name="my:Record">
            <mandatory-aspects>
            <aspect>rma:record</aspect>
            </mandatory-aspects>
         </properties>
         <associations>
         </associations>
      </type>

Then, when i import a content (in Alfresco DM, not in RM), i can choose this content type, and correctly i must insert the necessary info. If i import this content in "My Alfresco > Sites > rm > documentLibrary > … (from DM), i can't see this content as a Record from Share RM.
This is the problem that you've been resolving?
Can you help me? I'm new with Alfresco but this is the most important point to resolve for using this CMS.

Thank you so much.
Fabio

Re: Custom Document types / Models in RM

jperilla — Fri, 05 Nov 2010 23:36:47 GMT

I was having the same problem with my custom document type. No actions were showing up once I moved the file from DM to RM. I followed the instructions above and added my custom type to the switch statement so that it would fall through. Like this..

case "ciha:doc":
   // Fall-through
case "rma:nonElectronicDocument":
   // Fall-through
case "cm:content":
   if (asset.hasAspect("rma:record"))
   …‍‍‍‍‍‍‍

now my actions show up, but when I click on Edit Metadata only my custom properties show up for me to edit. I can't edit the required RM properties and therefore can't declare my document a record. It seems as if it is using my custom DM form template instead of using the RM form template (and adding my custom properties, which is what I would expect). Is there a proper way to fix this.

I suppose I could add all of the RM properties to my share-config-custom.xml, so that if it is a record they will show up, but that seems like a hack. Any ideas?

Re: Custom Document types / Models in RM

dk1 — Tue, 14 Dec 2010 18:44:50 GMT

I was having the same problem with my custom document type. No actions were showing up once I moved the file from DM to RM. I followed the instructions above and added my custom type to the switch statement so that it would fall through. Like this..
case "ciha:doc":
   // Fall-through
case "rma:nonElectronicDocument":
   // Fall-through
case "cm:content":
   if (asset.hasAspect("rma:record"))
   …‍‍‍‍‍‍‍
now my actions show up, but when I click on Edit Metadata only my custom properties show up for me to edit. I can't edit the required RM properties and therefore can't declare my document a record. It seems as if it is using my custom DM form template instead of using the RM form template (and adding my custom properties, which is what I would expect). Is there a proper way to fix this.

I suppose I could add all of the RM properties to my share-config-custom.xml, so that if it is a record they will show up, but that seems like a hack. Any ideas?

I tried to do this same thing and it didnt work for me

Re: Custom Document types / Models in RM

swithun — Thu, 03 Mar 2011 15:58:54 GMT

I'm not having any luck with this either. I have some custom aspects containing various properties and associations with custom types (no properties, just content). These work fine in regular Share. But I can't get this metadata to show up in RM, either to view or to edit.

The aspects look like:

    <aspect name="oais:MODSDigitalObjectAble">
      <title>MODS Digital Object aspect</title>
      <parent>cm:content</parent>
      <properties>
        <property name="mods:modsDigitalObjectIdentifiers">
          <type>d:mltext</type>
        </property>
        … more properties …
      </properties>
      <associations>
        <child-association name="oais:MODSDigitalObjectAssoc">
          <title>Link to MODS Digital Object</title>
          <target>
            <class>oais:MODSDigitalObjectType</class>
            <mandatory>false</mandatory>
            <many>true</many>
          </target>
        </child-association>
      </associations>
    </aspect>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

With types like:

    <type name="oais:MODSDigitalObjectType">
      <title>MODS Digital Object</title>
      <parent>cm:content</parent>
    </type>‍‍‍‍

I've tried adding lines like:

<show id="oais:MODSDigitalObjectAble"/>‍

to dod-5015-form-config.xml, and lines like:

       case "oais:MODSDigitalObjectType":
         // Fall-through ‍‍

to dod5015-evaluator.lib.js (both together and modifying just one of the files).

Either nothing changes (if I just modify the Javascript file), or I get the exception below (if I modify the XML file):

Exception: freemarker.template.TemplateException - Error executing macro: renderField required parameter: field is not specified.

as described in this thread.

I just want my aspect properties to be visible and editable inside RM. I thought maybe the exception was caused by my custom type not being recognised, though it has no properties and doesn't need to be visible/editable, so maybe editing the Javascript file was unnecessary (it has no effect anyway).

I'm using 3.4 CE, if it helps.

Re: Custom Document types / Models in RM

ericnk — Mon, 15 Aug 2011 18:31:07 GMT

The solution presented above works great for me, but I want to get away from modifying one of the core alfresco template scripts. Where would I place the modified dod5015-evaluator.js file. Perhaps under alfresco/extension? Does it follow the original file/folder structure, i.e.

…
alfresco/extension/alfresco/templates/webscripts/org/alfresco/slingshot/documentlibrary/dod5015-evaluator.js
… ?

Or, is it placed directly in alfresco/extension ? I've tried creating a similar file structure under extension, but that doesn't work. The only way I can get RM to recognize the custom file types is to modify the original core file, which I'm trying to avoid, so that I can retain my customizations when upgrading to a future release of alfresco. Any suggestions or comments are appreciated and welcome. Thank you.

Eric

Re: Custom Document types / Models in RM

softbless — Wed, 04 Apr 2012 09:12:59 GMT

If you want the RM metadata to be displayed for custom content type, you need to edit file : dod-5015-form-config.xml

Replicate this part :

<config evaluator="node-type" condition="cm:content">
…..
</config>
‍‍‍‍

change the condition into custom content type, for example :

<config evaluator="node-type" condition="custom:invoice">
     <forms>
        <form id="rm">
           <view-form template="record-metadata.ftl" />
           <edit-form template="record-metadata.ftl" />
           
           <field-visibility>
              <!– explicitly hide mandatory fields we don't want in edit mode –>
              <hide id="cm:automaticUpdate" />
              <hide id="sys:node-dbid" />
              <hide id="size" for-mode="edit" />
              <hide id="rma:dateFiled" for-mode="edit" />
              <hide id="rma:cutOffDate" for-mode="edit" />
              <hide id="rma:frozenBy" />
              <hide id="rma:frozenAt" />
           </field-visibility>
           
           <appearance>
              <set id="rm-custom" label-id="label.set.customMetadata" appearance="panel" />
              
              <field id="rma:identifier" label-id="label.recordIdentifier" read-only="true" />
              <field id="rmCategoryIdentifier" label-id="label.categoryIdentifier" />
              <field id="rmDeclared" label-id="label.declared" />
              <field id="rmRecordType" label-id="label.recordType" />
              <field id="rmDispositionInstructions" label-id="label.dispositionInstructions" />
              <field id="rma:recordSearchDispositionActionAsOf" label-id="label.dispositionAsOfDate" />
              <field id="cm:title" mandatory="true">
                 <control template="/org/alfresco/components/form/controls/textfield.ftl" />
              </field>
              <field id="cm:description">
                 <control>
                    <control-param name="activateLinks">true</control-param>
                 </control>
              </field>
              <field id="mimetype">
                 <control template="/org/alfresco/components/form/controls/mimetype.ftl" />
              </field>
              <field id="size">
                 <control template="/org/alfresco/components/form/controls/size.ftl" />
              </field>
              <field id="dod:webSiteURL">
                 <control>
                    <control-param name="activateLinks">true</control-param>
                 </control>
              </field>
           </appearance>
        </form>
     </forms>
  </config>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

By following the instruction above, and make changes to these files :
- dod5015-evaluator.lib.js
- dod-5015-form-config.xml

I accomplished :
- displaying RM related Action : Declare record, etc
- displaying RM Metadata : Originator, Originating organization, etc

But I haven't accomplished :
- displaying the custom metadata from custom content type

Anyone care to share how to do this?