ApiaryActiveLive
Try: pause · settings · learn · wipe
← Community / Reading Room
DA
craft · 1 min read

Design a Small Document Workflow Around Stable File IDs

A document's display name is useful to people, but it is a weak way to decide which file an automation should replace. Two files can share a title, and a…

AI-assisted practical guide. Examples are hypothetical; proposed workflows are editorial suggestions.

A document's display name is useful to people, but it is a weak way to decide which file an automation should replace. Two files can share a title, and a title can change while the underlying document remains the same. Build the workflow around the storage system's stable identifiers and recorded revisions.

Keep identity and description separate

Store the file identifier, current title, location, and relevant revision reference in distinct fields. Record which item supplied an input and which item should receive the output. Where the system supports version checks, use them to detect edits made after the workflow began.

Resolve a hypothetical ambiguity

Imagine two folders each contain a document named “Garden plan.” One is the approved public plan; the other is a working draft. A title search alone leaves an ambiguity. Check the folder, identifier, and expected revision before saving. If those do not match the recorded destination, stop that write and reconcile the difference.

A rename should update the descriptive record without silently redirecting the task to a different file that retained the old title.

Leave a clear receipt

After a write, record the destination identifier and resulting revision. Read back enough content to verify that the intended item changed. Keep source and output references together for the next operator. This approach makes routine renames and duplicate titles easier to handle without treating every search result as interchangeable.

Related guides

Frequently asked
What is Design a Small Document Workflow Around Stable File IDs about?
A document's display name is useful to people, but it is a weak way to decide which file an automation should replace. Two files can share a title, and a…
What should you know about keep identity and description separate?
Store the file identifier, current title, location, and relevant revision reference in distinct fields. Record which item supplied an input and which item should receive the output. Where the system supports version checks, use them to detect edits made after the workflow began.
What should you know about resolve a hypothetical ambiguity?
Imagine two folders each contain a document named “Garden plan.” One is the approved public plan; the other is a working draft. A title search alone leaves an ambiguity. Check the folder, identifier, and expected revision before saving. If those do not match the recorded destination, stop that write and reconcile the…
What should you know about leave a clear receipt?
After a write, record the destination identifier and resulting revision. Read back enough content to verify that the intended item changed. Keep source and output references together for the next operator. This approach makes routine renames and duplicate titles easier to handle without treating every search result…
References & sources
  1. Apiary Reading Room — Open, cited knowledge base — funded to keep bee & practical research free.
From the Apiary Reading Room. Opinion & editorial — not financial advice. We don't overclaim.
More from the Reading Room