Document location (project)

The document folder bound to a project.

Part of Documents in the register catalog.

Register ID

document_location:projectUse 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

AvailableFilled today from connected systems, uploads or public data.

Data

OrganisationPrivate to each organisation's own workspace.

Version

v1Current version.

Download JSON SchemaSee an example record

Standards

This register holds records these standards and laws ask for. Holding them does not by itself certify compliance.

• ISO 19650Information management using building information modellingInternational

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.

• Procore

Fields

18 fields: 5 required, 9 optional, 4 defined by each organisation.

Required

Every record carries these fields.

entity_typeText

The entity kind whose documents this binding locates; fixed by the shelf key for this member, and part of the supersede key.

Example: project

sourcesList

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

sources[].systemText

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

Example: SHAREPOINT

sources[].connector_refText

The logical alias of the connector that reaches this source; also the field the operator export filter compares.

Example: bridgeworks-sharepoint

source_systemText

The producing system of the fact; no harvested origin exists.

Example: AUTHORED

Optional

Present when the source system records them.

doc_typeText

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

coordinateGroup of fields

A per-entity override selector; null for the default binding.

sources[].store_site_idText

The store's site identifier; required in practice when system = SHAREPOINT

Example: bridgeworksgroup.sharepoint.com,11111111-2222-3333-4444-5…

sources[].store_site_nameText

The operator-facing site label; no reader touches it

Example: Bridgeworks Group

sources[].store_drive_idText

The store's drive identifier; required in practice when system = SHAREPOINT

Example: b!AAAABBBBCCCCDDDDEEEEFFFF0000111122223333

sources[].store_drive_nameText

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

Example: Documents

sources[].root_folderText

The path under the store root to start from (null/empty for systems addressed by site+drive); required in practice when system = DROPBOX

Example: Projects

sources[].file_globText

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

binding_statusText

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

Example: confirmed

Defined by each organisation

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

sources[].lifecycle_foldersList

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

sources[].entity_folder_patternText

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

Example: {job_number} - {name}

sources[].doc_subpathText

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

sources[].folder_patternText

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

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:project.example.json

{
  "binding_status": "confirmed",
  "entity_type": "project",
  "source_system": "AUTHORED",
  "sources": [
    {
      "connector_ref": "bridgeworks-sharepoint",
      "entity_folder_pattern": "{job_number} - {name}",
      "root_folder": "Projects",
      "store_drive_id": "b!AAAABBBBCCCCDDDDEEEEFFFF0000111122223333",
      "store_drive_name": "Documents",
      "store_site_id": "bridgeworksgroup.sharepoint.com,11111111-2222-3333-4444-555555555555,66666666-7777-8888-9999-aaaaaaaaaaaa",
      "store_site_name": "Bridgeworks Group",
      "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--project/v1.json

Show the full JSON Schema

Loading the schema…