SoftType: Document
Represents a text, a drawing, a presentation that is created and stored on a computer in order to record details of an event, a process, etc. A document is a versionable artifact on which configuration change management can be associated.
A document is usually used for managing the metadata of a digital file.
Diagrams
Properties
The properties for the SoftType are described in the following tabbed displays:
- Properties The public properties of the SoftType instance that can be set and modified by the user or by data import.
- Meta data Meta data about the SoftType instance that are set by the ShareAspace application.
applicabilities [0..*] : Applicability
The set of products, product configurations, concepts or projects for which this document is restricted to i.e. applicable to.
approval [0..1] : ApprovalReference
The approval of the document.
children [0..*] : DocumentHierarchy
The set of hierarchical relationships that relate the document to its sub documents.
countryOfOrigin [0..1] : CountryOfOrigin
A code according to ISO 3166 that identifies the country of origin.
createdByOrganization [0..1] : OrganizationReference
The organization that is primarily responsible for the content of the document version. Initially this is the organization who created the document version. However, responsibility for the document may change over time.
Note
this is the equivalent of Dublin Core: Document.creator
createdByPerson [0..1] : PersonReference
The person that is primarily responsible for the content of the document version. Initially this is the person who created the document version. However, responsibility for the document may change over time.
Note
this is the equivalent of Dublin Core: Document.creator
dateCreated [0..1] : DateTimeAssignment
The date and time on which the document version was created.
dateReleased [0..1] : DateTimeAssignment
The date and time on which the document version was issued or published. Typically this is when the document is formally completed and deemed fit for use.
derivedFromDocument [0..1] : DerivedFromDocument
The document from which this document has been derived.
description [0..1] : String
A text based description of the document.
documentId [0..1] : Identifier
The identifier for the document. The combination of the identifier string and the organization that allocates the identifier provides an unambiguous reference to the document in ShareAspace
equivalentDocuments [0..*] : EquivalentDocument
The set of documents that this document is equivalent to. For example an exact copy of the document
exportControlCodes [0..*] : ExportControlCode
A set of codes that identify a categorization of items based on the nature of the product, i.e. type of commodity, software, or technology and its respective technical parameters for export control purposes. The codes are typically defined by a countries export control authority. Hence a country is associated with the code. So for ITAR ECCN code the country would be US. It is also the case that the organization exporting material may have a different view on the categorization to the organization importing it and integrating the material into a higher assembly. Hence an import or export qualifier is used to differentiate between the two codes.
exportControlled [0..1] : ExportControlConstraint
An indication as to whether the document is subject to export control regulations. If so, it "may" have a ECCN specified and "may" be subject to an explicit export licence.
externalFiles [0..*] : ExternalFile
The set of files external to ShareAspace that are referenced by the document.
files [0..*] : DigitalFile
The set of files that are managed by the document.
id [0..1] : String
The identifier for the document. The identifier string provides an unambiguous reference to the document in ShareAspace.
intellectualPropertyConstraint [0..1] : IntellectualPropertyRightConstraint
An indication as to whether the document is subject to any intellectual property rights that might need to be considered when sharing the information.
intellectualPropertyOwners [0..*] : OrganizationReference
The organizations that own the intellectual property contained within the document.
keyValues [0..*] : KeyValue
A set of user defined name and strings value pairs. Note that these name value pairs are not indexed and therefor cannot be searched for.
language [0..1] : Language
The language of the document.
name [0..1] : String
The name of the document is a human readable label used to refer to the document. The name is not an identifier and so does not uniquely identify a document in ShareAspace.
originCommonDef [0..1] : OriginatingSystem
The origin of the common definition of the document. If an origin is provided then the system representing the origin is the "master" system and the common definition can only be updated via an input from that system. If no origin is provided, the origin is assumed to be ShareAspace and the common definition can be edited in ShareAspace.
originMaster [0..1] : OriginatingSystem
The origin of the of the document. If an origin is provided then the system representing the origin is the "master" system and the document can only be updated via an input from that system. If no origin is provided, the origin is assumed to be ShareAspace and the document can be edited in ShareAspace.
originPrivateDef [0..1] : OriginatingSystem
The origin of the private definition of the document. If an origin is provided then the system representing the origin is the "master" system and the private definition can only be updated via an input from that system. If no origin is provided, the origin is assumed to be ShareAspace and the private definition can be edited in ShareAspace.
originSharedDef [0..1] : OriginatingSystem
The origin of the shareable definition of the document. If an origin is provided then the system representing the origin is the "master" system and the shareable definition can only be updated via an input from that system. If no origin is provided, the origin is assumed to be ShareAspace and the shareable definition can be edited in ShareAspace.
privateFiles [0..*] : DigitalFile
The set of files that are managed by the document and are not to be shared.
relatedDocuments [0..*] : RelatedDocument
The set of documents that are in some way related to this document.
releasedByOrganization [0..1] : OrganizationReference
The organization that is responsible for making the document version available. I.e.publishing or releasing the document version.
Note
this is the equivalent of Dublin Core: Document.publisher
releasedByPerson [0..1] : PersonReference
The person that is responsible for making the document version available. I.e. publishing or releasing the document version.
Note
this is the equivalent of Dublin Core: Document.publisher
securityClassifications [0..*] : GenericSecurityClassification
The set of security data classification levels for the document.
sharedFiles [0..*] : DigitalFile
The set of files that are managed by the document and can be shared. The files need to be shared separately to the sharing of the document.
status [0..1] : DocumentStatus
The status of the document where the status represents the state, or stage within a process, of the document at a particular time.
systemDataSourceCommonDef [0..1] : SystemDataSource
The system from which the document's common definition was loaded.
systemDataSourceMaster [0..1] : SystemDataSource
The system from which the document was loaded.
systemDataSourcePrivateDef [0..1] : SystemDataSource
The system from which the document's private definition was loaded.
systemDataSourceSharedDef [0..1] : SystemDataSource
The system from which the document's shareable definition was loaded.
type [0..1] : DocumentType
The category of the document.
versionId [1] : String
An identifier for a version of the document. Note that the identifier string provides an unambiguous reference to one version of the document in ShareAspace.
compliant [1] : Boolean
A flag indicating if the Unit of Information is valid in regards to the SoftType data section and rules.
coOwners [0..*] : ObjectId
The list of internal ShareAspace key of Participants that have currently read write access to the object via a share pack.
coOwnersCommonDef [0..*] : ObjectId
The set of internal ShareAspace keys identifying participants that have currently read write access to the object's common definition via a share pack.
coOwnersSharedDef [0..*] : ObjectId
The set of internal ShareAspace keys identifying participants that have currently read write access to the object's shareable definition via a share pack.
coReaders [0..*] : ObjectId
The list of internal ShareAspace key of Participants that have currently read only access to the object via a share pack.
coReadersCommonDef [0..*] : ObjectId
The set of internal ShareAspace keys identifying participants that have currently read only access to the object's common definition via a share pack.
coReadersSharedDef [0..*] : ObjectId
The set of internal ShareAspace keys identifying participants that have currently read only access to the object's shareable definition via a share pack.
created [1] : DateTime
The date and time when the Unit of Information was created in the ShareAspace store.
creator [1] : String
The user that created the Unit of Information in the ShareAspace store.
lockedBy [0..1] : String
lockingHistory [0..*] : LockingHistory
oId [1] : ObjectId
The internal ShareAspace store key for the object instance.
owner [1] : ObjectId
The internal ShareAspace key of the Participant owning the object.
ownerCommonDef [1] : ObjectId
The internal ShareAspace key of the participant owning the object's common definition.
ownerSharedDef [1] : ObjectId
The internal ShareAspace key of the participant owning the object's shareable definition.
owningHistory [0..*] : OwnershipHistory
The historical record of owners for the object.
owningHistoryCommonDef [0..*] : OwnershipHistory
The set of historical records of the ownership of the object's common definition.
owningHistorySharedDef [0..*] : OwnershipHistory
The set of historical records of the ownership of the object's shareable definition.
sharingHistory [0..*] : SharingHistory
The historical record of sharing information for the object.
sharingHistoryCommonDef [0..*] : SharingHistory
The set of historical records of the sharing and unsharing of the object's information stored on the common definition.
sharingHistorySharedDef [0..*] : SharingHistory
The set of historical records of the sharing and unsharing of the object's information stored on the shareable definition.
softType [0..1] : String
The SoftType identifier associated with the Unit of Information.
transactionOn [1] : DateTime
The date and time when the last change on the Unit of Information was performed (anywhere in the Unit of Information) in the ShareAspace store.
updated [0..1] : DateTime
The date and time when the Unit of Information was updated in the ShareAspace store.
updater [0..1] : String
The last user that updated the Unit of Information in the ShareAspace store.
versionCoReaders [0..*] : ObjectId
The list of internal ShareAspace key of Participants that have currently read only access to the version via a share pack.
versionCreated [1] : DateTime
The date and time when the version was created in the ShareAspace store.
versionCreator [1] : String
The user that created the version in the ShareAspace store.
versionOId [1] : ObjectId
The internal ShareAspace store key for the version instance.
versionOwner [1] : ObjectId
The internal ShareAspace key of the Participant owning the version object.
versionUpdated [0..1] : DateTime
The date and time when the version was updated in the ShareAspace store.
versionUpdater [0..1] : String
The last user that updated the version in the ShareAspace store.