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.
How the pieces relate
Section titled “How the pieces relate”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 for | Configuration section | Required |
|---|---|---|
| Object Type | Project configuration | Yes |
| Artifact Type | SharePoint configuration | Optional |
| Object Type | Path configuration | Yes |
Classes
Each belongs to one of the object types above.
| Needed for | Configuration section | Required |
|---|---|---|
| Class | Project configuration | Yes |
| Artifact Class | SharePoint configuration | Optional |
Properties
The data type is not advice. A property of the wrong type cannot be selected for the setting at all.
| Needed for | Configuration section | Data type | Required |
|---|---|---|---|
| Relationship Property | Project configuration | Multi Select Lookup or Lookup | Yes |
| Template Property | Project configuration | Multi Select Lookup or Lookup | Yes |
| Document Object Templates Property | Project configuration | Multi Select Lookup | Optional |
| Error Property | Project configuration | Multi Line Text | Yes |
| Artifact Document Object Template Property | SharePoint configuration | Lookup or Multi Select Lookup | Optional |
| Property | Property copy mapping | Any | Optional |
| Document Template Property | Document template configuration | Lookup | Optional |
| Version Property | Document template configuration | Multi Select Lookup or Lookup | Optional |
| Full Path | Path configuration | Lookup | Optional |
| Partial Path Title | Path configuration | Multi Line Text | Yes |
| Directory Structure | Path configuration | Lookup or Multi Select Lookup | Yes |
| SharePoint URL Property | Graph configuration | Multi Line Text | Yes |
| SharePoint ID Property | Graph configuration | Text or Multi Line Text | Yes |
| Sync Is Active Property | Graph configuration | Boolean | Optional |
Workflows
One per object type that the application drives through states.
| Needed for | Configuration section | Required |
|---|---|---|
| Workflow | Project workflow config | Yes |
| Workflow | SharePoint workflow config | Optional |
Workflow states
States within the workflows above. Entering one is what triggers the work.
| Needed for | Configuration section | Required |
|---|---|---|
| Generate Baseline | Project workflow config | Optional |
| Baseline Generated | Project workflow config | Optional |
| Activate | Project workflow config | Yes |
| Activated | Project workflow config | Yes |
| Activation Error | Project workflow config | Yes |
| Baseline Generation Error | Project workflow config | Optional |
| Generated State | SharePoint workflow config | Optional |
| Activated State | SharePoint workflow config | Optional |
| Error State | SharePoint workflow config | Optional |
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.