Create an Archive Entity

Archive entities are the entities that can be archived using the Archiving Utility.

In order for an entity to be available to the Archiving Utility, it has to meet the following conditions:

1. Entities Metadata File

<isarchived> tag's value must be true.
<archivecollections> tag's value must be the main entity's collection entity id. If more than one collection entity exists, all collection entity ids must be defined separated by semicolons. Once the main entity is archived, all defined collection entities will be archived as well.
<archiverelatedentities> tag's value must be the archived entity's related entity id. If more than one related entity exists, all related entity ids must be defined separated by semicolons. Once the main entity is archived, all defined related entities will no longer be editable. For more information on related archive entities, go to Create a Related Archive Entity.

entities.xml

<entityconfig>
	<entities>		
		<entity>
			<id>CUSTOMRENTALS</id>
			<name>key_rental</name>
			<tablename>TRN_RENTALS</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORental</classname>
			<moduleid>CUSTOM_RENTALS</moduleid>
			<metadatafile>rentals</metadatafile>
		</entity>
		
		<entity>
			<id>CUSTOMRENTALTYPES</id>
			<name>key_rental_type</name>
			<tablename>TRN_RENTALTYPES</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORentalType</classname>
			<moduleid>CUSTOMRENTALS</moduleid>
			<metadatafile>rentaltypes</metadatafile>
			<isarchived>true</isarchived>
			<archivecollections>TRN_RENTTYPEPRODUCTS</archivecollections>
			<archiverelatedentities>CUSTOMRENTALS</archiverelatedentities>
		</entity>
		<entity>
			<id>CUSTOMRENTALTYPEPRODUCTS</id>
			<name>key_rental_type_product</name>
			<tablename>TRN_RENTTYPEPRODUCTS</tablename>
			<classname>com.crm.dataobject.rentals.CUSTOMCRMDORentalTypeProduct</classname>
			<moduleid>CUSTOMRENTALS</moduleid>
			<isarchived>true</isarchived>
		</entity>
		...
	</entities>
</entityconfig>