Defining a new document type

  Previous topic Next topic JavaScript is required for the print function Mail us feedback on this topic! Mail us feedback on this topic!  

In this example, you will learn how to define a new custom document type.


1. Go to Site Manager -> Development -> Document types and click the AddNewDocumentType New document type link. You will be redirected to the New document type wizard. In the first step, enter the following values:


Document type display name: Computer (this name will be displayed to the users)
Document type code name: (custom is your namespace to distinguish your document types from system types that use the cms namespace, computer is the document type). You will use this value in web part properties later.


Click Next.




2. In Step 2, you need to choose the name of the database table that will be used for storing computer details. You also need to enter the name of the primary key in this table. Enter the following values:


Table name: CUSTOM_Computer
Primary key name: ComputerID


Click Next.




3. The wizard has created a new database table for computers. Now you need to define the fields (columns of the table). Click New attribute (AddWebPart) to create a new field. Enter the following values:


Attribute name: ComputerName
Attribute type: Text
Attribute size: 200
Field caption: Computer name
Field type: Text box


Click OK. Click New attribute (AddWebPart). Enter:


Attribute name: ComputerProcessorType
Attribute type: Text
Attribute size: 200
Field caption: Processor type
Field type: Drop-down list, choose to use Options instead of SQL Query
Options: enter the following options, one per line:


Pentium XEON;Pentium XEON

Pentium Core 2 Duo;Pentium Core 2 Duo


Click OK. Click New attribute (AddWebPart). Enter:


Attribute name: ComputerRamSize
Attribute type: Integer number
Field caption: RAM (MB)
Field type: Text box


Click OK. Click New attribute (AddWebPart). Enter:


Attribute name: ComputerHddSize
Attribute type: Integer number
Field caption: HDD (GB)
Field type: Text box


Click OK. Click New attribute (AddWebPart). Enter:


Attribute name: ComputerImage
Attribute type: File
Field caption: Image
Field type: Upload file
Allow empty value: check the box


Click OK.




Please note that you can also define system fields to be displayed on the documents' Form tab. This can be done by clicking the Add system attribute icon. Using the Group drop-down list, you can then choose from the following two groups of system fields:


Document attribute - offers the document's system fields
Node attribute - offers the document node's system fields


Document or node system fields will then be offered in the Attribute name drop-down list. If you leave the Display attribute in the editing form check-box checked, the field will be visible on the documents' Form tab.


Click Next.




4. Now you need to choose the field that will be used as document name. Choose the Use document name field option from the drop down list. It means that when you create a new computer document, its name will be automatically taken from the ComputerName value and this value will appear in site navigation and in the CMS Desk content tree.


Click Next.




5. In Step 5, you need to select the document types under which computer documents will be displayed. Check only the Page (menu item) value, which means that editors will be able to create computer documents only under some page, not under an article or news document in the content tree.


Click Next.




6. In Step 6, you need to choose which websites will use this document type. Check the appropriate website and click Next.




7. In Step 7, you are asked to specify how documents of this type will be indexed and displayed in the search results. For more information on these settings, please refer to this topic. Make your choice and click Next.




8. The wizard has finished the configuration of the new document type. It has automatically created not only the database table, but also the SQL queries for SELECT, INSERT, UPDATE and DELETE operations and a default transformation.


Click Finish. Congratulations, you have learned how to define a new document type.






How the content is stored


As you already know, the new document type Computer has its own database table. Each document is stored in three tables: CMS_TREE (tree structure), CMS_Document (document properties and metadata) and the custom table - in this case CUSTOM_Computer:




The system automatically ensures all operations are performed correctly on these tables. The advantage of this storage is that it is very fast and you can easily write standard SQL SELECT queries to retrieve data from the repository (i.e. from the Microsoft SQL Server database).





Changing the document type icon


If you create a new document type, documents of this type will appear with the default document icon (DocumentDefault) in the administration interface. To change the document type icon:


1. go to <web project folder>\App_Themes\Default\Images\DocumentTypeIcons\

2. find your document type's icon named <namespace>_<document type>.png

3. open the file in your image editor and modify it, or create a new image with the same name and format and replace the original one with it


After doing so, all documents of this type should appear with the new icon. You can also change any other document types' icons this way, as all document type icons are stored in the location mentioned above.



Page url: