Skip to content

Vault structure

Every setting in the PDS configuration that names a piece of vault structure is listed here. None of them can be filled in until the thing it names exists, so this is the work that comes before configuration rather than during it.

Beyond the individual objects, PDS expects a particular shape:

  • A project object type, with a class, a workflow, and a property linking documents and artefacts back to a project.
  • A path object type, where each object is one folder. A path holds its own name in the partial path title property and its parent in the directory structure property, so a folder hierarchy is a chain of objects.
  • A template object type. Project object templates and document object templates are normally the same object type separated by class — PDS reads them through properties rather than through the type, so it does not require them to be separate.
  • An artefact object type, only if the deployment creates starting documents. A folders-only deployment leaves the artefact settings empty and does not need this.

PDS binds 30 settings to something that has to exist in the vault, 14 of them required. Everything below is generated from the shipping application, so nothing it needs is missing from this list.

Object types

Create these first; classes and properties hang off them.

Needed forConfiguration sectionRequired
Object TypeProject configurationYes
Artifact TypeSharePoint configurationOptional
Object TypePath configurationYes

Classes

Each belongs to one of the object types above.

Needed forConfiguration sectionRequired
ClassProject configurationYes
Artifact ClassSharePoint configurationOptional

Properties

The data type is not advice. A property of the wrong type cannot be selected for the setting at all.

Needed forConfiguration sectionData typeRequired
Relationship PropertyProject configurationMulti Select Lookup or LookupYes
Template PropertyProject configurationMulti Select Lookup or LookupYes
Document Object Templates PropertyProject configurationMulti Select LookupOptional
Error PropertyProject configurationMulti Line TextYes
Artifact Document Object Template PropertySharePoint configurationLookup or Multi Select LookupOptional
PropertyProperty copy mappingAnyOptional
Document Template PropertyDocument template configurationLookupOptional
Version PropertyDocument template configurationMulti Select Lookup or LookupOptional
Full PathPath configurationLookupOptional
Partial Path TitlePath configurationMulti Line TextYes
Directory StructurePath configurationLookup or Multi Select LookupYes
SharePoint URL PropertyGraph configurationMulti Line TextYes
SharePoint ID PropertyGraph configurationText or Multi Line TextYes
Sync Is Active PropertyGraph configurationBooleanOptional

Workflows

One per object type that the application drives through states.

Needed forConfiguration sectionRequired
WorkflowProject workflow configYes
WorkflowSharePoint workflow configOptional

Workflow states

States within the workflows above. Entering one is what triggers the work.

Needed forConfiguration sectionRequired
Generate BaselineProject workflow configOptional
Baseline GeneratedProject workflow configOptional
ActivateProject workflow configYes
ActivatedProject workflow configYes
Activation ErrorProject workflow configYes
Baseline Generation ErrorProject workflow configOptional
Generated StateSharePoint workflow configOptional
Activated StateSharePoint workflow configOptional
Error StateSharePoint workflow configOptional

Generated from PDS 0.25.11.0.

  • A path object can be created with a partial path title and a parent, and a second path object can name the first as its parent.
  • A project object template can name a directory structure and a list of document object templates.
  • The SharePoint URL property here is the one CtrlSync reads on its connections.

Set up PDS — step three, configuring the project and path sections.