File Plan XML Schema Documentation

Table of Contents

• Schema Document Properties
• Global Declarations
  • Element: FilePlan
• Global Definitions
  • Complex Type: ChoiceListSet
  • Complex Type: ChoiceListType
  • Complex Type: ClassDescription
  • Complex Type: CustomClassSet
  • Complex Type: CustomPropertySet
  • Complex Type: LocalizedStringType
  • Complex Type: ObjectEntryType
  • Complex Type: ObjectRefSet
  • Complex Type: ObjectRefType
  • Complex Type: ObjectValue
  • Complex Type: PropertyDescription
  • Complex Type: PropertyDescriptionRefSet
  • Complex Type: PropertyDescriptionRefType
  • Complex Type: PropertyType
  • Complex Type: RecordCategorySet
  • Complex Type: RecordFolderObjectType
  • Complex Type: RecordFolderSet
  • Complex Type: RelationSet
  • Complex Type: RelationType
  • Complex Type: RMContainableObjectType
  • Complex Type: RMEntityObjectType
  • Complex Type: RMEntitySet
  • Complex Type: RMPropertySet
  • Complex Type: RMPropertyType
  • Complex Type: WithObjectIdentityType
  • Simple Type: AllowedActionType
  • Simple Type: CardinalityType
  • Simple Type: ChoiceTypeType
  • Simple Type: DataModelType
  • Simple Type: DataTypeType
  • Simple Type: EntityAction
  • Simple Type: FilePlanInputType
  • Simple Type: GuidType
  • Simple Type: RMEntityType
  • Simple Type: SettabilityType
  • Simple Type: TemplateType

---

Schema Document Properties

Target Namespace	FilePlan.xsd
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Documentation	This schema supports the FileNet Import/Export/Update Tool.

Declared Namespaces

Prefix	Namespace
Default namespace	FilePlan.xsd
xml	http://www.w3.org/XML/1998/namespace
xsd	http://www.w3.org/2001/XMLSchema

---

Global Declarations

Element: FilePlan

Name	FilePlan
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Root element. Each sub-element is a collection of the same entity type. Most of the sub-elements are optional. Since entities have to be defined and imported first before they can be used or referenced, the order of these collections is defined according to their relative dependencies.

---

Global Definitions

Complex Type: ChoiceListSet

Super-types:	None
Sub-types:	None

Name	ChoiceListSet
Abstract	no
Documentation	Collection of ChoiceList elements.

---

Complex Type: ChoiceListType

Super-types:	None
Sub-types:	None

Name	ChoiceListType
Abstract	no
Documentation	Specifies the type for ChoiceList element. Each Choice of Choices list should have the same data type as the ChoiceList. If the Choice element does not provide the ChoiceType attribute, the ChoiceList DataType will be used. If the ChoiceType is a String, StringValue should be provided with a string value. If the ChoiceType is a Integer, IntValue should be provided with a integer value.

---

Complex Type: ClassDescription

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < ObjectValue (by extension) < ClassDescription (by extension)
Sub-types:	None

Name	ClassDescription
Abstract	no
Documentation	The class description can be used to: 1. Subclass existing classes (Supporting RecordFolder and its subclasses). 2. Add custom property definitions for RecordCategory and RecordInfo classes.

---

Complex Type: CustomClassSet

Super-types:	None
Sub-types:	None

Name	CustomClassSet
Abstract	no
Documentation	Collection of CustomClass elements.

---

Complex Type: CustomPropertySet

Super-types:	None
Sub-types:	None

Name	CustomPropertySet
Abstract	no
Documentation	Collection of CustomProperty elements.

---

Complex Type: LocalizedStringType

Super-types:	None
Sub-types:	None

Name	LocalizedStringType
Abstract	no
Documentation	Specifies a LocalizedString type. It is used to define the DisplayName and DescriptiveText properties of ClassDescription and PropertyDescription.

---

Complex Type: ObjectEntryType

Super-types:	None
Sub-types:	WithObjectIdentityType (by extension) RMEntityObjectType (by extension) RMContainableObjectType (by extension) RecordFolderObjectType (by extension) ObjectRefType (by extension) ObjectValue (by extension) ClassDescription (by extension) PropertyDescriptionRefType (by extension)

Name	ObjectEntryType
Abstract	yes

---

Complex Type: ObjectRefSet

Super-types:	None
Sub-types:	None

Name	ObjectRefSet
Abstract	no
Documentation	Collection of ObjectRef elements. This is used for applying multiple holds to an entity.

---

Complex Type: ObjectRefType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < ObjectRefType (by extension)
Sub-types:	None

Name	ObjectRefType
Abstract	no
Documentation	An ObjectRefType can be used in an entity that needs an Object Reference. The Index attribute is used if the ObjectId is not sufficient to uniquely identify an entity. Currently it is only used when referencing a DisposalTrigger. For a Disposal Trigger entity, the index represents the event type. Possible event types are: Index="1" - indicates a predefined date event. Index="2" - indicates an external event. Index="3" - indicates an internal event. Index="4" - indicates a recurring event.

---

Complex Type: ObjectValue

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < ObjectValue (by extension)
Sub-types:	ClassDescription (by extension)

Name	ObjectValue
Abstract	no
Documentation	Specifies an Object Value type.

---

Complex Type: PropertyDescription

Super-types:	None
Sub-types:	None

Name	PropertyDescription
Abstract	no
Documentation	This type defines a new property template.

---

Complex Type: PropertyDescriptionRefSet

Super-types:	None
Sub-types:	None

Name	PropertyDescriptionRefSet
Abstract	no
Documentation	Collection of ObjectRef elements for the PropertyDescriptions of CustomClass. Each ObjectRef represents a Custom Property.

---

Complex Type: PropertyDescriptionRefType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < PropertyDescriptionRefType (by extension)
Sub-types:	None

Name	PropertyDescriptionRefType
Abstract	no
Documentation	This is a reference type for a property template specified by the PropertyDescription. The RequiredClassId is required when the property template is a PropertyTemplateObject class.

---

Complex Type: PropertyType

Super-types:	None
Sub-types:	None

Name	PropertyType
Abstract	no

---

Complex Type: RecordCategorySet

Super-types:	None
Sub-types:	None

Name	RecordCategorySet
Abstract	no
Documentation	Collection of RecordCategory elements.

---

Complex Type: RecordFolderObjectType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < RMContainableObjectType (by extension) < RecordFolderObjectType (by extension)
Sub-types:	None

Name	RecordFolderObjectType
Abstract	no
Documentation	Specifies the object type for record folders. It is based on RMContainableObjectType with an addition attribute for RMFolderType.

---

Complex Type: RecordFolderSet

Super-types:	None
Sub-types:	None

Name	RecordFolderSet
Abstract	no
Documentation	Collection of RecordFolder elements.

---

Complex Type: RelationSet

Super-types:	None
Sub-types:	None

Name	RelationSet
Abstract	no
Documentation	Collection of Relation elements.

---

Complex Type: RelationType

Super-types:	None
Sub-types:	None

Name	RelationType
Abstract	no
Documentation	Specifies the object type for Relation elements.

---

Complex Type: RMContainableObjectType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < RMContainableObjectType (by extension)
Sub-types:	RecordFolderObjectType (by extension)

Name	RMContainableObjectType
Abstract	no
Documentation	Specifies the object type for RM containers such as record categories or record folders.

---

Complex Type: RMEntityObjectType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension) < RMEntityObjectType (by extension)
Sub-types:	None

Name	RMEntityObjectType
Abstract	no
Documentation	Specifies an RM entity object.

---

Complex Type: RMEntitySet

Super-types:	None
Sub-types:	None

Name	RMEntitySet
Abstract	no
Documentation	Specifies a collection of RM entities with the same entity type.

---

Complex Type: RMPropertySet

Super-types:	None
Sub-types:	None

Name	RMPropertySet
Abstract	no
Documentation	Collection of Property elements.

---

Complex Type: RMPropertyType

Super-types:	None
Sub-types:	None

Name	RMPropertyType
Abstract	no
Documentation	Specifies a property type. The property can have a single value, a list of values, an object value (ObjectValue), a list of object values, or an object reference (ObjectRef). For example, the AlternateRetentions property of a Phase entity is a list of object values. Each object value represents an alternate retention of the AlternateRetentions property. Note that a property may store a value in XML format, such as the "ConditionXML" property in AlternateRetention, DisposalTrigger and RecordHold entities. It stores the search conditions in XML format. When setting the property value of ConditionXML, the special characters (<, >, &, " ') need to be converted to the standard representation. For details of the ConditionXML format, please refer to File Plan Import and Export Troubleshooting and Tips.

---

Complex Type: WithObjectIdentityType

Super-types:	ObjectEntryType < WithObjectIdentityType (by extension)
Sub-types:	RMEntityObjectType (by extension) RMContainableObjectType (by extension) RecordFolderObjectType (by extension) ObjectRefType (by extension) ObjectValue (by extension) ClassDescription (by extension) PropertyDescriptionRefType (by extension)

Name	WithObjectIdentityType
Abstract	yes
Documentation	Specifies the base for all representations of the object. The ClassId is the name of the class for the object and ObjectId is the name of the object (for example, ClassId="DisposalTrigger" ObjectId="Date Closed").

---

Simple Type: AllowedActionType

Super-types:	string < AllowedActionType (by restriction)
Sub-types:	None

Name	AllowedActionType
Content	Base XSD Type: string value comes from list: {'PlaceHolds'|'RemoveHolds'|'RemoveAllHolds'|'RemoveEntitiesOnHold'|'RemoveAllEntitiesOnHold'}
Documentation	Specifies the actions acceptable for the relations.

---

Simple Type: CardinalityType

Super-types:	string < CardinalityType (by restriction)
Sub-types:	None

Name	CardinalityType
Content	Base XSD Type: string value comes from list: {'Single'|'Enum'|'List'}
Documentation	Specifies the acceptable types for the Cardinality.

---

Simple Type: ChoiceTypeType

Super-types:	string < ChoiceTypeType (by restriction)
Sub-types:	None

Name	ChoiceTypeType
Content	Base XSD Type: string value comes from list: {'Integer'|'String'}
Documentation	Specifies the acceptable types for choices.

---

Simple Type: DataModelType

Super-types:	string < DataModelType (by restriction)
Sub-types:	None

Name	DataModelType
Content	Base XSD Type: string value comes from list: {'Base'|'DoD'|'PRO'}
Documentation	Specifies the acceptable RM data models.

---

Simple Type: DataTypeType

Super-types:	string < DataTypeType (by restriction)
Sub-types:	None

Name	DataTypeType
Content	Base XSD Type: string value comes from list: {'Binary'|'Boolean'|'Date'|'Double'|'Guid'|'Integer'|'Object'|'String'}
Documentation	Specifies the acceptable data types for the properties.

---

Simple Type: EntityAction

Super-types:	string < EntityAction (by restriction)
Sub-types:	None

Name	EntityAction
Content	Base XSD Type: string value comes from list: {'Add'|'Delete'|'Modify'}
Documentation	Specifies the actions acceptable for the entity.

---

Simple Type: FilePlanInputType

Super-types:	string < FilePlanInputType (by restriction)
Sub-types:	None

Name	FilePlanInputType
Content	Base XSD Type: string value comes from list: {'Import'|'ReImport'|'Update'}
Documentation	Specifies the acceptable input types.

---

Simple Type: GuidType

Super-types:	string < GuidType (by restriction)
Sub-types:	None

Name	GuidType
Content	Base XSD Type: string pattern = \{[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}\}

---

Simple Type: RMEntityType

Super-types:	string < RMEntityType (by restriction)
Sub-types:	None

Name	RMEntityType
Content	Base XSD Type: string value comes from list: {'Action'|'DisposalSchedule'|'RecordHold'|'PatternSequence'|'Location'|'Pattern'|'PatternLevel'|'Phase'|'RecordCategory'|'RecordFolder'|'RecordType'|'AlternateRetention'|'DisposalTrigger'|'Volume'}
Documentation	Specifies the acceptable RM types for RMEntity.

---

Simple Type: SettabilityType

Super-types:	string < SettabilityType (by restriction)
Sub-types:	None

Name	SettabilityType
Content	Base XSD Type: string value comes from list: {'ReadWrite'|'SettableOnlyBeforeCheckin'|'SettableOnlyOnCreate'|'ReadOnly'}
Documentation	Specifies the acceptable types for the Settability property of the custom property's property descriptions.

---

Simple Type: TemplateType

Super-types:	string < TemplateType (by restriction)
Sub-types:	None

Name	TemplateType
Content	Base XSD Type: string value comes from list: {'PropertyTemplateBinary'|'PropertyTemplateBoolean'|'PropertyTemplateDateTime'|'PropertyTemplateFloat64'|'PropertyTemplateId'|'PropertyTemplateInteger32'|'PropertyTemplateString'|'PropertyTemplateObject'}
Documentation	Specifies the acceptable property template types for custom property.

---

Generated by xs3p.

---

Feedback

© Copyright IBM Corporation 2013.
This information center is powered by Eclipse technology. (http://www.eclipse.org)