Class DocumentRenditionMetadata

Descriptors for a rendition of a Document. This is meant to include all the information about the document that is needed to enter it into the Document Management System.

Relation attachmentMetadata (<directional aggregation>)

Information describing an attachment included within a message.

Declaration :

Uml : + attachmentMetadata : AttachmentMetadata, multiplicity : *

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
1,unbounded
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
nc:BinaryType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/ecf:AttachmentMetadata
niem-profile:niem::
niem-profile:niem:Multiplicity:
1,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:Attachment
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment

Attribute colorRelevanceIndicator

Indicates whether color is or is not relevant for the presentation of the document.

Declaration :

Uml : + colorRelevanceIndicator : bool

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
niem-xs:boolean
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/ecf:ColorRelevantIndicator
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
ecf:ColorRelevantIndicator
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/ec:DocumentAugmentation/ecf:ColorRelevantIndicator

Attribute documentBinaryData

Embedded document data, in an encoded form acceptable to be included within XML.

Declaration :

Uml : + documentBinaryData : binary

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
nc:BinaryType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary
niem-profile:niem::
niem-profile:niem:Multiplicity:
1,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:Attachment
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:Attachment

Attribute documentContentTypeCode

IANA MIME type specifiying the format of the attachment. Example: application/msword; application/pdf.

Declaration :

Uml : + documentContentTypeCode : BinaryDescriptionCode

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
niem-xs:string
niem-profile:niem:CodeList:
application/pdf; application/vnd.openxmlformats-officedocument.wordprocessingml.document; application/vnd.oasis.opendocument.text;
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinaryCategoryText
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
Genericode code list MultimediaDataMIMEKindText.gc
niem-profile:niem:Property:
cbrn:MultimediaDataMIMEKindText
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/ecf:DocumentAugmentation/cbrn:MIMEContentCode

Relation documentSignature (<directional aggregation>)

Information describing or constituting the signature on a document submitted to a court for filing

Declaration :

Uml : + documentSignature : DocumentSignature, multiplicity : *

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,unbounded
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
ecf:DocumentSignatureType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentSignature
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
ecf:DocumentSignature
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentSignature

Attribute fileSize

Size of file expressed in kilobytes

Declaration :

Uml : + fileSize : int

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
nc:NonNegativeDecimalType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinarySizeValue
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:BinarySizeValue
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/nc:BinarySizeValue

Attribute language

The language in which the document is written.

Declaration :

Uml : + language : string

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:DocumentType
niem-profile:niem:BaseType:
iso_639-3:LanguageCodeType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentLanguageCode
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:DocumentLanguageAbstract, (nc:DocumentLanguageCode)
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentLanguageCode

Attribute redactedIndicator

An indicator that sensitive information has been removed from this rendition of the document.

Declaration :

Uml : + redactedIndicator : bool

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
ecf:DocumentRenditionType
niem-profile:niem:BaseType:
niem-xs:boolean
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/ecf:RedactedIndicator
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
ecf:RedactedIndicator
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/ecf:RedactedIndicator

Attribute documentBinaryURI

The location of a document, either a URL or attachment identifier.

Declaration :

Uml : + documentBinaryURI : string, multiplicity : *

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
niem-xs:anyURI
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinaryLocationURI
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:BinaryURI
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/nc:BinaryURI

Attribute documentBinaryContents

The binary contents of a document.

Declaration :

Uml : + documentBinaryContents : , multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,unbounded
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
niem-xs:base64Binary
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:Base64BinaryObject
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:BinaryObjectAbstract, (nc:Base64BinaryObject)
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/nc:Base64BinaryObject

Attribute documentBinaryCapturer

The person who capturer/scanned a document into binary format.

Declaration :

Uml : + documentBinaryCapturer : string, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
nc:EntityType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinaryCapturer
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:BinaryCapturer
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/nc:BinaryCapturer

Attribute documentBinaryFormat

The binary format of a document.

Declaration :

Uml : + documentBinaryFormat : string, multiplicity : 0..1

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
nc:TextType
niem-profile:niem:CodeList:
application/json=json; application/msword=doc; application/pdf=pdf; application/vnd.oasis.opendocument.text=odt; application/vnd.openxmlformats-officedocument.wordprocessingml.document=docx; application/xml=xml;
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinaryFormatStandardName
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
Genericode code list BinaryFormatText.gc
niem-profile:niem:Property:
nc:BinaryFormatText
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/

Attribute renditionDescription

A description of a rendition of a document.

Declaration :

Uml : + renditionDescription : string, multiplicity : *

Stereotype: niem-profile:niem

Properties:

niem-profile:niem:OldMultiplicity:
0,1
niem-profile:niem:Type:
nc:BinaryType
niem-profile:niem:BaseType:
nc:TextType
niem-profile:niem:CodeList:
niem-profile:niem:OldXPath:
ecf:Document/ecf:DocumentRendition/ecf:DocumentRenditionMetadata/nc:DocumentBinary/nc:BinaryDescriptionText
niem-profile:niem::
niem-profile:niem:Multiplicity:
0,1
niem-profile:niem:Notes:
niem-profile:niem:Property:
nc:BinaryDescriptionText
niem-profile:niem:XPath:
nc:Document/ecf:DocumentAugmentation/ecf:DocumentRendition/nc:DocumentBinary/