Document Profile
Tracing the Lifecycle of a Document with DataTrails
The DataTrails document profile is a set of suggested Asset and Event attributes that allow you to trace the lifecycle of a document.
Profile Attribute Namespace
The
document_prefix is used to designate attributes that are part of the profile. Some of these are interpreted by DataTrails and others are guidelines.
Document Profile Asset Attributes
| Asset Attributes | Meaning | Requirement |
|---|---|---|
| arc_profile | Designates that the Asset follows the document profile | Required, set as Document |
| document_hash_value | Hash of the most recently published version of the document | Required |
| document_hash_alg | Algorithm used to compute document_hash_value (currently, only SHA-256 is supported) | Required |
| document_document | Attachment containing the most recently uploaded version of the document being traced. | Optional |
| document_version | Specific version string for the most recent version of the document | Optional, but encouraged |
| document_status | Label for filtering and accommodating critical document lifecycle events (Published, Withdrawn) | Optional, enforced when using lifecycle events |
| document_portable_name | Formal name or identifier for document that persists across boundaries and throughout versions | Optional, not interpreted by DataTrails |
Publish Event
Publish a new version of the document using special attributes interpreted by DataTrails for this event type.
| Event Attributes | Meaning | Requirement |
|---|---|---|
| arc_display_type | Tells DataTrails how to interpret Event | Required, must be set to Publish |
| document_version_authors | List of authors on this version of the document | Optional, see format below |
Document Version Authors
You must express
document_version_authorsas a list of objects that havedisplay_nameas a property.[ { "display_name": "Alice", "email": "", ... } ]
| Asset Attributes | Meaning | Requirement |
|---|---|---|
| document_hash_value | Hash of this version of the document | Required |
| document_hash_alg | Algorithm used for hashing. We only officially support SHA-256. | Required |
| document_status | Label for filtering and accommodating critical document lifecycle events | Required, must be Published |
| document_document | Attachment containing this version of the document | Optional |
| document_version | Version string for the this version of the document | Optional |
Withdraw Event
If a document is no longer required, or if for any reason it is decided that it should no longer be used, then a document can be withdrawn. Withdrawal is optional and it is usually the final event in the document lifecycle. It can be reversed in DataTrails by publishing a new version.
Withdraw an entire document (mark that it is no longer considered current.)
| Event Attributes | Meaning | Requirement |
|---|---|---|
| arc_display_type | Tells DataTrails how to interpret Event | Required, must be set to Withdraw |
| document_withdrawal_reason | Reason why document has been withdrawn | Optional, but encouraged |
| Asset Attributes | Meaning | Requirement |
|---|---|---|
| document_status | Label for filtering and accommodating critical document lifecycle events | Required, must be Withdrawn |