Custom Type Component Metadata

Overview

Component level metadata can be added by placing additional attributes in your content type's opening cfcomponent element. Adding metadata can alter the default behaviour of the framework and help you leverage hidden services.

For example: ./core/packages/types/dmHTML.cfc

<cfcomponent 
  extends="types" 
  displayname="HTML Page" 
  hint="Forms the basis of the content framework of the site.  HTML objects include containers and static information." 
  bObjectBroker="1" 
  bUseInTree="1" 
  bFriendly="1">

Metadata

Attribute	Description	Default
bSystem	Flags content type as a system only component. That is the component represents soemthing that is not content. For example, a log, order record and so on.	false
bFriendly	Activates the "Friendly URL" service for this content type.	false
bObjectBroker	Activates the Object Broker for this content type.	false
objectbrokermaxobjects	Determines the maximum number of objects to broker in Object Broker.	100
lObjectBrokerWebskins	Specifies which webskin templates will be cached and for how long in Object Broker	None
bUseInTree	Allows the content type to be used within the FarCry site overview tree.	false
bAudit	Activates audit logging for creation, update and deletes on this content type.	true
bAbstract	Nominates component as an abstract class. This will prohibit the type being deployed to the data persistence layer, and being invoked directly by the framework.	false

Deprecated Metadata

Do not use this metadata. This is provided for backward compatibility only and will be removed in later revisions of the code base.

Attribute	Description	Default
bCustom	Originally designed to differentiate between custom and core content types. Modern versions of FarCry dynamically make this distinction on application initialisation.	false
bSchedule	Indicates whether or not publishing rules that scan for eligible content types for publishing should consider the components data for scheduling. For example, FarCry CMS plugins "Hand Picked Rule".	false