topic Re: How do I create custom record types? in Alfresco Archive

How do I create custom record types?

beavis74 — Wed, 20 Oct 2010 08:47:23 GMT

Hi, this is my first post to this forum.Can anyone tell me how to create new types of record in the Alfresco RM fileplan?Currently it has "Default" plus 4 others…PDF Record, Digital Photograph, etc. How do I add to this list?What we want to do is have different meta data fields for different records

Re: How do I create custom record types?

rwetherall — Mon, 25 Oct 2010 14:07:48 GMT

Hi,

Unfortunately there isn't yet an easy way to do this. The best approach would be to edit/extend the DOD5015 content model to add the additional record information you want.

Longer term we would definitely like to make it easy for people to define custom record types and extend this area of the product.

Cheers,
Roy

Re: How do I create custom record types?

beavis74 — Wed, 27 Oct 2010 09:37:29 GMT

Thanks for your reply Roy.

Could you possibly be so kind as to give me some pointers on how to "edit the content model". I have the Professional Alfresco book, and followed the 'knowledge base' example on how to modify DOCUMENT management, but doing this in the records management module has stumped me. I tried editing some of the XML files but this seemed to break it! I got an error when trying to set the Record Type. Also, I read somewhere on this forum that doing this is not supported by Alfresco, is that correct?

Many thanks
Scott

Re: How do I create custom record types?

croc — Thu, 28 Oct 2010 11:45:33 GMT

Hi,
I am not sure if you talk about a type which is part of [dod:filePlan, dod:recordSeries, dod:recordCategory, ….]
Or you talking about type, like when you click on File in a folder level. We have a Record Types that you select. And if it's those on Upload files window.
Here is the possible solution
START
There is couple of files that you'll need to check. But the most important are: dod5015-flash-upload.get.js and dod5015Model.xml

dod5015-flash-upload.get.js


/**
 * Custom content types
 */
function getContentTypes()
{
   // TODO: Data webscript call to return list of available types
   var contentTypes = [
   {
      id: "cm:content",
      value: "cm_content"
   }];

   return contentTypes;
}

/**
 * Record types
 */
function getRecordTypes()
{
   var recordTypes = [
   {
      id: "-",
      value: "default"
   },
   {
      id: "dod:scannedRecord",
      value: "scannedRecord"
   },
   {
      id: "dod:pdfRecord",
      value: "pdfRecord"
   },
   {
      id: "dod:digitalPhotographRecord",
      value: "digitalPhotographRecord"
   },
   {
      id: "dod:webRecord",
      value: "webRecord"
   }];
   
   return recordTypes;
}

model.contentTypes = getContentTypes();
model.recordTypes = getRecordTypes();‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

If you check the code above you'll realise that all the types that you have in RM, are there. and for testing you can add a new the code below:

   {
      id: "dod:testingType",
      value: "Testing Type"
   }‍‍‍‍

After restarting the application you will be able to see the new type added.

Though the name won't be correct because you'll have to add labels in your properties file.

I am sure you know that, the file/content you add, if it's of a certain type, it will have different fields to others if they aren't of the same type.
So you now need to have those fields declared somewhere, and that when dod5015Model.xml
I won't paste it here.

All those types are also there, and their fields.

They are declared in the form of aspects.
END

Re: How do I create custom record types?

beavis74 — Wed, 03 Nov 2010 11:34:27 GMT

Thank you croc. I'll give this a go and report back.

Regards
Scott

Re: How do I create custom record types?

croc — Wed, 03 Nov 2010 12:30:42 GMT

Good luck!

Re: How do I create custom record types?

rascio — Wed, 16 Feb 2011 11:05:38 GMT

Hi! I've a similary problem but i want to create a custom type instead of rma:recordFolder i've to create a custom folder. I've seen how it creates the folder and change with my custom type in dod5015-toolbar.js all functions, but when i try to click the button to create the folder a javascript exception is thrown and i can't see the dialog with the form. I've check the XHR request and all seems function correctly.

I think that there are some other files that i've to customize…someone has already made it?

Re: How do I create custom record types?

vytbr2 — Thu, 17 Mar 2011 08:15:51 GMT

Hello,
I have one more question about integrating the new record type.
I tried to add a new record type as described above, that is:
    - modified the model file dod5015Model.xml adding new aspect with properties
    - modified the dod5015-flash-upload.get.js to display this new type
    - modified the record-metadata.ftl template file to display the newly added properties

After restarting the application and trying to File new record - the new document type appeared in the drop-down list of record types.
But, when I file the record and select the Default type, then on the actions menu select 'Set Record Type' - the custom type doesn't show up in the drop-down list. It seemes that there is yet another file which needs to be modified… Is there another file or am i doing something wrong ?

thanks,
Vytas

Re: How do I create custom record types?

luisfernando — Thu, 02 Jun 2011 19:13:27 GMT

Hi guys,

I followed the steps and it worked, only now to create the fields for this new type created I have to go in file dod5015Model.xml and add aspect, but when I add it gives an error.

  <aspect name=""dod:testingType">
            <title>Testing Type</title>      
            <properties>       
                <property name="dod:webFileName">
                    <title>Web File Name</title>
                    <type>d:text</type>
                    <mandatory>true</mandatory>
                    <index enabled="true">
                     <atomic>true</atomic>
                     <stored>false</stored>
                     <tokenised>false</tokenised>
                 </index>
                </property>
            </properties>
            <mandatory-aspects>
                <aspect>rma:filePlanComponent</aspect>
            </mandatory-aspects> 
          </aspect>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

could someone help me?

And another question, because when I add only that the file-flash-dod5015 upload.get.js

{
          id: "dod:testingType",
          value: "Testing Type"
    } ‍‍‍‍

and run the alfresco and I will do in the Records Management and upload a new file with the new record type created it gives error and do not let upload file?

Thank you in advance

Luis Fernando

Re: How do I create custom record types?

mautidavis — Fri, 28 Sep 2012 11:14:40 GMT

Hi,

Thanks for the provided guidance.

I've just added the necessary record types and it is working okay but when I go to the metadata I cannot see the fields which I added. What might be the issue?

Any ideas most welcome.

Davis

Re: How do I create custom record types?

mrogers — Fri, 28 Sep 2012 12:15:52 GMT

If you have added your own types you will need to configure the forms for share to display those types and properties.