DataLab workspace capsule terms

Namespace: https://datalab-platform.com/capsule/terms# (JSON-LD prefix dlc), used by the DataLab workspace capsule profile. Status: experimental. Terms are only added; a published term keeps its meaning.

Classes

TermDefinition
EnvironmentExecution environment of activities: DataLab edition and version, Python implementation and version, platform, Pyodide version; package versions are listed as softwareRequirements.
RoleBindingOne input or output of an action: its role (name), its position among the action's inputs or outputs (0-based) and the bound state or artifact, or, for a legacy activity, the bound object (objectUuid) whose state at execution time is unknown.

Properties of the root dataset

TermDefinition
manifestFingerprintsha256: digest of the RFC 8785 canonical JSON of the manifest, computed without this property.
workspaceIdIdentifier of the workspace ledger.
revisionOfManifest fingerprint (sha256: digest) of the parent revision of this capsule; at most one. Part of the manifest fingerprint of the child.

Properties of the workspace file

TermDefinition
referencedtrue when the workspace is not included in the archive but referenced by the absolute IRI of its File entity; its sha256 and contentSize must match the bytes obtained (defined in the profile).

Properties of attachments

TermDefinition
attachmenttrue on a File stored as attachments/<name>: a light file chosen by the author, used by no activity, checked against its sha256 and contentSize and never executed (defined in the profile).

Properties of actions

TermDefinition
inputsOrdered inputs of the action, as RoleBinding entities.
outputsOrdered outputs of the action, as RoleBinding entities.
parametersParameters of the operation call, as PropertyValue entities.
replayabletrue when the call names an operation contract (identifier and version): a reader may recompute it when its computation library qualifies that contract version for replay; false for an opaque call (no operation identity).
originHow the activity was started: ordinary, recompute_in_place or history_replay; legacy_metadata for an activity rebuilt from processing metadata of a workspace saved without provenance (defined in the profile).
environmentThe Environment in which the activity ran.
limitsReasons why the activity cannot be replayed, e.g. parameters_not_encoded.
legacyFor a legacy_metadata activity, RFC 8785 canonical JSON text of the processing record as stored, the object holding it, the version that saved the file and the issues found at import (defined in the profile).
observedStateFor a legacy_metadata activity, the state of the object holding the record, observed when the workspace was opened; not attested as the historical result and not produced by the activity.
commandIdIdentifier shared by the activities of one user command.
xAlignmentX-alignment rule applied to the inputs before the call, as RFC 8785 canonical JSON text: rule identifier, version, and interpolated (true when the operand was resampled on the source grid). Absent when no alignment applies. A replay refuses an unknown rule or version.

Properties of role bindings and parameters

TermDefinition
stateThe state bound to the role.
artifactThe non-state result (e.g. an analysis table) bound to the role.
jsonValueParameter value as RFC 8785 canonical JSON text (lossless, including null and encoded non-finite numbers).

Properties of states and artifacts

TermDefinition
kindKind of the object: signal or image.
objectUuidPersistent identifier of the DataLab object.
sequenceObservation order of the state in the ledger.
fingerprintContent fingerprint of the state (e.g. sha256: digest).
fingerprintSchemeScheme of the fingerprint: datalab-signal-v1, datalab-signal-v2 or datalab-image-v1 (defined in the profile).
locatorHDF5 path of the object holding the state in workspace.h5; absent when the state is not stored.
roiRegion of interest of the object, as RFC 8785 canonical JSON text of its definition; masks derive from it. Absent when the object has none.
producedByThe action that produced the state.
artifactKindKind of an artifact, e.g. table.
keyKey of an artifact within its object.
resultDigestsha256: digest of the value an artifact held when it was recorded (defined in the profile); a different current value means the result was replaced.

Properties of software and environments

TermDefinition
operationIdStable identifier of an operation contract, e.g. sigima.signal.normalize.
contractVersionInteger version of the operation contract.
packagePython distribution providing an implementation.
editionDataLab edition: desktop or web.
editionVersionVersion of the DataLab edition.
pythonPython implementation and version.
platformPlatform identifier (e.g. win32, emscripten).
pyodidePyodide version, or null outside Pyodide.