Schema Document Properties
Schema Document Properties
| Target Namespace | http://www.ademero.com/XmlSchemas/ContentCentral/XmlCaptureDescriptorV1.7 |
| Version | 1.7 |
|
Element and Attribute Namespaces |
|
| Documentation | Schema for capturing documents in Content Central. |
Declared Namespaces
| Prefix | Namespace |
| Default namespace | http://www.ademero.com/XmlSchemas/ContentCentral/XmlCaptureDescriptorV1.7 |
| xml | http://www.w3.org/XML/1998/namespace |
| xs | http://www.w3.org/2001/XMLSchema |
<xs:schema elementFormDefault=”qualified” targetNamespace=”http://www.ademero.com/XmlSchemas/ContentCentral/XmlCaptureDescriptorV1.7” version=”1.7“>
</xs:schema>
Global Declarations
Global Declarations
Element: document
| Name | document |
| Type | Locally-defined complex type |
| Nillable | no |
| Abstract | no |
| Documentation | Root element containing document capture settings. |
<document>
Start Choice [1]
<imageFiles> imageFiles </imageFiles> [1]
<electronicFile> electronicFile </electronicFile> [1]
End Choice
<captureForm> captureForm </captureForm> [0..1]
Start Group: appendOrReplaceDocument [0..1]
Start Choice [1]
<documentBaseNameForAppend> documentBaseNameForAppend </documentBaseNameForAppend> [1]
<documentBaseNameForReplace> documentBaseNameForReplace </documentBaseNameForReplace> [1]
<documentIdForAppend> documentIdForAppend </documentIdForAppend> [1]
<documentIdForReplace> documentIdForReplace </documentIdForReplace> [1]
End Choice
End Group: appendOrReplaceDocument
<totalPages> totalPages </totalPages> [0..1]
<destination> destination </destination> [0..1]
<fields> fields </fields> [0..1]
</document>
<xs:element name=”document”>
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element name=”imageFiles” type=”imageFiles”/>
<xs:element name=”electronicFile” type=”electronicFile”/>
</xs:choice>
<xs:element name=”captureForm” type=”captureForm” minOccurs=”0″ maxOccurs=”1″/>
<xs:group ref=”appendOrReplaceDocument” minOccurs=”0″ maxOccurs=”1″/>
<xs:element name=”totalPages” type=”totalPages” minOccurs=”0″ maxOccurs=”1″/>
<xs:element name=”destination” type=”destination” minOccurs=”0″/>
<xs:element name=”fields” type=”fields” minOccurs=”0″/>
</xs:sequence>
</xs:complexType>
</xs:element>
Global Definitions
Simple Type: deleteInputFiles
Simple Type: deleteInputFiles
| Super-types | xs:boolean < deleteInputFiles (by restriction) |
| Sub-types | None |
| Name | deleteInputFiles | |
| Content |
|
|
| Documentation | Determines whether input file(s) will be deleted when processed. |
<xs:simpleType name=”deleteInputFiles”>
<xs:restriction base=”xs:boolean”/>
</xs:simpleType>
Simple Type: username
Simple Type: username
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < username (by restriction) |
| Sub-types | None |
| Name | username |
| Content |
|
| Documentation | Specifies a user name. For Content Central 4.6.3170 and later, use domain\username for Active Directory users (e.g., mycompany.com\username). |
<xs:simpleType name=”username”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: totalPages
Simple Type: totalPages
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < totalPages (by restriction) |
| Sub-types | None |
| Name | totalPages |
| Content |
|
| Documentation | Specifies the total number of pages in this document (electronic only). |
<xs:simpleType name=”totalPages”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: requiredNormalizedString
Simple Type: requiredNormalizedStringfile
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) |
| Sub-types |
|
| Name | requiredNormalizedString |
| Content |
|
| Documentation | Specifies a normalizedString with a minLength of 1. |
<xs:simpleType name=”requiredNormalizedString”>
<xs:restriction base=”xs:normalizedString”>
<xs:minLength value=”1″/>
</xs:restriction>
</xs:simpleType>
Simple Type: file
Simple Type: file
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < file (by restriction) |
| Sub-types |
|
| Name | file |
| Content |
|
| Documentation | Specifies a relative or full path to a file. |
<xs:simpleType name=”file”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: documentIdForReplace
Simple Type: documentIdForReplace
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < documentIdForReplace (by restriction) |
| Sub-types | None |
| Name | documentIdForReplace |
| Content |
|
| Documentation | Specifies the ID of an existing document that this document will replace. |
<xs:simpleType name=”documentIdForReplace”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: documentIdForAppend
Simple Type: documentIdForAppend
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < documentIdForAppend (by restriction) |
| Sub-types | None |
| Name | documentIdForAppend |
| Content |
|
| Documentation | Specifies the ID of an existing document that this document will append. |
<xs:simpleType name=”documentIdForAppend”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: documentCreator
Simple Type: documentCreator
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < documentCreator (by restriction) |
| Sub-types | None |
| Name | documentCreator |
| Content |
|
| Documentation | Specifies a valid domain\username creator of the new document. |
<xs:simpleType name=”documentCreator”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: documentBaseNameForReplace
Simple Type: documentBaseNameForReplace
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < documentBaseNameForReplace (by restriction) |
| Sub-types | None |
| Name | documentBaseNameForReplace |
| Content |
|
| Documentation | Specifies a BaseName of an existing document that this document will replace. |
<xs:simpleType name=”documentBaseNameForReplace”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Simple Type: documentBaseNameForAppend
Simple Type: documentBaseNameForAppend
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < documentBaseNameForAppend (by restriction) |
| Sub-types | None |
| Name | documentBaseNameForAppend |
| Content |
|
| Documentation | Specifies a BaseName of an existing document that this document will append. |
<xs:simpleType name=”documentBaseNameForAppend”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Complex Type: Catalog
Complex Type: catalog
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < catalog (by extension) |
| Sub-types | None |
| Name | catalog |
| Abstract | no |
| Documentation | Specifies a catalog name and an optional document type. |
<…
documentType=”requiredNormalizedString [0..1] ?”>
requiredNormalizedString
</…>
<xs:complexType name=”catalog”>
<xs:simpleContent>
<xs:extension base=”requiredNormalizedString”>
<xs:attribute name=”documentType” type=”requiredNormalizedString” use=”optional”/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
Simple Type: captureForm
Simple Type: captureForm
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < captureForm (by restriction) |
| Sub-types | None |
| Name | captureForm |
| Content |
|
| Documentation | Specifies the name of a capture form to assign to this document (electronic only). |
<xs:simpleType name=”captureForm”>
<xs:restriction base=”requiredNormalizedString”/>
</xs:simpleType>
Model Group: appendOrReplaceDocument
Model Group: appendOrReplaceDocument
| Name | appendOrReplaceDocument |
| Documentation | Specifies a document to either append or replace, either by name or id. |
Start Choice [1]
<documentBaseNameForAppend> documentBaseNameForAppend </documentBaseNameForAppend> [1] ?
<documentBaseNameForReplace> documentBaseNameForReplace </documentBaseNameForReplace> [1] ?
<documentIdForAppend> documentIdForAppend </documentIdForAppend> [1] ?
<documentIdForReplace> documentIdForReplace </documentIdForReplace> [1] ?
End Choice
<xs:group name=”appendOrReplaceDocument”>
<xs:choice>
<xs:element name=”documentBaseNameForAppend” type=”documentBaseNameForAppend”/>
<xs:element name=”documentBaseNameForReplace” type=”documentBaseNameForReplace”/>
<xs:element name=”documentIdForAppend” type=”documentIdForAppend”/>
<xs:element name=”documentIdForReplace” type=”documentIdForReplace”/>
</xs:choice>
</xs:group>
Complex Type: postCapture
Complex Type: postCapture
| Super-types | None |
| Sub-types | None |
| Name | postCapture |
| Abstract | no |
| Documentation | Specifies a post-capture queue. |
<…
queue=”requiredNormalizedString (value comes from list: {‘catalog’|’user’}) [0..1] ?”>
<catalog> catalog </catalog> [0..1] ?
<username> username </username> [0..1] ?
</…>
<xs:complexType name=”postCapture”>
<xs:sequence>
<xs:element name=”catalog” type=”catalog” minOccurs=”0″/>
<xs:element name=”username” type=”username” minOccurs=”0″/>
</xs:sequence>
<xs:attribute name=”queue” default=”catalog”>
<xs:simpleType>
<xs:restriction base=”requiredNormalizedString”>
<xs:enumeration value=”catalog”/>
<xs:enumeration value=”user”/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
Complex Type: imageFiles
Complex Type: imageFiles
| Super-types | None |
| Sub-types | None |
| Name | imageFiles |
| Abstract | no |
| Documentation | Specifies a collection of one or more image files (tif, jpg, pdf, etc.). |
<…
deleteInputFiles=”xs:boolean [0..1] ?”
documentCreator=”requiredNormalizedString [0..1] ?”>
<file> file </file> [1..*]
</…>
<xs:complexType name=”imageFiles”>
<xs:sequence>
<xs:element name=”file” type=”file” maxOccurs=”unbounded”/>
</xs:sequence>
<xs:attribute name=”deleteInputFiles” type=”xs:boolean” use=”optional”/>
<xs:attribute name=”documentCreator” type=”requiredNormalizedString” use=”optional”/>
</xs:complexType>
Complex Type: Fields
Complex Type: fields
| Super-types | None |
| Sub-types | None |
| Name | fields |
| Abstract | no |
| Documentation | Specifies a collection of one or more field items. |
<…>
<field> field </field> [1..*]
</…>
<xs:complexType name=”fields”>
<xs:sequence>
<xs:element name=”field” type=”field” maxOccurs=”unbounded”/>
</xs:sequence>
</xs:complexType>
Complex Type: Field
Complex Type: field
| Super-types | xs:string < field (by extension) |
| Sub-types | None |
| Name | field |
| Abstract | no |
| Documentation | Specifies a name/value pair. |
<…
name=”requiredNormalizedString [1]”>
xs:string
</…>
<xs:complexType name=”field”>
<xs:simpleContent>
<xs:extension base=”xs:string”>
<xs:attribute name=”name” type=”requiredNormalizedString” use=”required”/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
Complex Type: ElectronicFile
Complex Type: electronicFile
| Super-types | xs:normalizedString < requiredNormalizedString (by restriction) < file (by restriction) < electronicFile (by extension) |
| Sub-types | None |
| Name | electronicFile |
| Abstract | no |
| Documentation | Specifies one electronic file. |
<…
deleteInputFiles=”xs:boolean [0..1] ?”
documentCreator=”requiredNormalizedString [0..1] ?”>
file
</…>
<xs:complexType name=”electronicFile”>
<xs:simpleContent>
<xs:extension base=”file”>
<xs:attribute name=”deleteInputFiles” type=”xs:boolean” use=”optional”/>
<xs:attribute name=”documentCreator” type=”requiredNormalizedString” use=”optional”/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
Complex Type: Destination
Complex Type: destination
| Super-types | None |
| Sub-types | None |
| Name | destination |
| Abstract | no |
| Documentation | Specifies the document destination. |
<…>
Start Choice [1]
<catalog> catalog </catalog> [1] ?
<folderOverride> requiredNormalizedString </folderOverride> [0..1] ?
<filenameOverride> requiredNormalizedString </filenameOverride> [0..1] ?
<postCapture> postCapture </postCapture> [1] ?
End Choice
</…>
<xs:complexType name=”destination”>
<xs:choice>
<xs:sequence>
<xs:element name=”catalog” type=”catalog”/>
<xs:element name=”folderOverride” type=”requiredNormalizedString” minOccurs=”0″/>
<xs:element name=”filenameOverride” type=”requiredNormalizedString” minOccurs=”0″/>
</xs:sequence>
<xs:element name=”postCapture” type=”postCapture”/>
</xs:choice>
</xs:complexType>
Legend
Complex Type: AusAddress
Complex Type: AusAddress
Schema Component Type : Schema Component Name
| Super-types | Address < AusAddress (by extension) |
| Sub-types |
|
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
| Name | AusAddress |
| Abstract | no |
The table above displays the properties of this schema component.
<… country=”Australia”>
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]
</…>
The XML Instance Representation table above shows the schema component's content as an XML instance.
- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice … End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type’s content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country=”Australia”.
- Otherwise, the type of the element/attribute is displayed.
- If the element/attribute’s type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
<complexTypename=”AusAddress”>
<complexContent>
<extensionbase=”Address”>
<sequence>
<elementname=”state” type=”AusStates”/>
<elementname=”postcode”>
<simpleType>
<restrictionbase=”string”>
<patternvalue=”[1-9][0-9]{3}”/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename=”country” type=”string” fixed=”Australia”/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
Glossary
Glossary
| Abstract | (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used. |
| All Model Group | Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all. |
| Choice Model Group | Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice. |
| Collapse Whitespace Policy | Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters. |
| Disallowed Substitutions | (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration’s type using the specified derivation methods. Normally, element instances can override their declaration’s type by specifying an xsi:type attribute. |
| Key Constraint | Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions. |
| Key Reference Constraint | Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions. |
| Model Group | Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups. |
| Nillable | (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content. |
| Notation | A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations. |
| Preserve Whitespace Policy | Preserve whitespaces exactly as they appear in instances. |
| Prohibited Derivations | (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition. |
| Prohibited Substitutions | (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition. |
| Replace Whitespace Policy | Replace tab, line feed, and carriage return characters with space character (Unicode character 32). |
| Sequence Model Group | Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence. |
| Substitution Group | Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced. |
| Substitution Group Exclusions | (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element’s type using the specified derivation methods. |
| Target Namespace | The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace. |
| Uniqueness Constraint | Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions. |
