Document location (asset)

The document folder bound to a plant or equipment asset.

Part of Documents in the register catalog.

Register ID

document_location:assetUse this name to ask for the register. The API calls it a shelf ID.

Each record is

A stateThe current value of something, replaced when it changes.

Status

DeclaredDefined, and fills when a source produces its first record.

Data

OrganisationPrivate to each organisation's own workspace.

Version

v1Current version.

Download JSON SchemaSee an example record

Connectors

Connected today

Demiton keeps this register current from these systems now.

No system fills this register yet.

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

None planned yet.

Fields

18 fields: 6 required, 8 optional, 4 defined by each organisation.

Required

Every record carries these fields.

entity_typeText

The entity kind whose documents this binding locates; the discriminator that makes the key document_location:asset

Example: asset

coordinate_keyText

The override discriminator stored in the fact identity — bare when there is no coordinate override, else an 8-hex hash of the coordinate selector.

Example: asset:9301

sourcesList

The ordered list of places to look; each element is one complete declarative locator.

systemText

The storage system of one source; only SharePoint and Dropbox are crawlable.

Example: SHAREPOINT

connector_refText

The logical alias of the connector that reaches this source; also the export/import scope filter.

Example: sharepoint:bridgeworks-assets

source_systemText

The producing system of the fact — an operator authoring, not a harvest.

Example: SHAREPOINT

Optional

Present when the source system records them.

doc_typeText

The specific document type this binding locates, or null for the asset type's general home; part of the supersede key.

Example: service_record

store_site_idText

The store's site identifier; needed to reach a source on systems addressed by site.

Example: bwg-plant-01

store_drive_idText

The store's drive identifier.

Example: drv-001

store_drive_nameText

The drive's display name, used to translate between the store root and display paths.

Example: Documents

store_rootText

The path under the store root to start from (null/empty for systems addressed by site+drive)

Example: /sites/BridgeworksPlant

file_globText

The file match for this doc type, either * (no filter) or a single *.ext glob.

Example: *.pdf

binding_statusText

Whether the operator has confirmed the binding or it is still a candidate.

Example: active

authored_byText

Who authored the binding and when, carried inside the authored-metadata wrapper.

Example: AUTHORED

Defined by each organisation

Their contents come from the organisation's own forms or systems, so they differ between organisations.

entity_folder_patternText

How each asset's own folder is named, binding a folder to the asset by its number token.

lifecycle_foldersList

The status-tagged folders to traverse, each a folder name plus the entity status it holds.

doc_subpathText

An optional fixed sub-path inside the asset folder where this doc type's files sit.

folder_patternText

A case-insensitive regex matched against folder names at any depth, used where no single sub-path name holds.

Example: /Plant/{asset_id}/Service

Example record

A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.

document_location:asset.example.json

{
  "authored_by": "AUTHORED",
  "binding_status": "active",
  "connector_ref": "sharepoint:bridgeworks-assets",
  "coordinate_key": "asset:9301",
  "doc_type": "service_record",
  "entity_type": "asset",
  "file_glob": "*.pdf",
  "folder_pattern": "/Plant/{asset_id}/Service",
  "source_system": "SHAREPOINT",
  "sources": [
    "service_records",
    "inspection_reports"
  ],
  "store_drive_id": "drv-001",
  "store_drive_name": "Documents",
  "store_root": "/sites/BridgeworksPlant",
  "store_site_id": "bwg-plant-01",
  "system": "SHAREPOINT"
}

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

Schema URL

https://docs.demiton.io/registers/document_location--asset/v1.json

Show the full JSON Schema

Loading the schema…