Document Management — User Guide

1. What Document Management does

Document Management turns your reusable source material into finished documents, one per project. You set up a library once. After that, choosing a document type in a project pulls in the matching files and your pre-written language, then assembles a draft you can edit and export as a PDF.

The tool has two halves that work together:

  • A shared library. Team folders hold the PDF files for each document type, tagged with their details, plus the reusable passages (document blocks) for each type.
  • A project workspace. The Documents tab inside each project is where you pick document types, choose which files apply, build the draft, edit it and export it.

The essential rule: every supporting file is a PDF. The library, project attachments and the combined export all depend on it. Word files, images and scans saved in other formats can't be previewed reliably and will stop a combined export.

2. Finding your way

Everything lives under Documents in the left-hand menu. Click it to open the list of pages below. Administrators see every item; other staff see File management if their role allows it.

Menu item

What you do there

File management

Store, organize, share and approve your files and folders. This is where your library of PDFs lives.

Documents

Maintain your list of document types (for example, Purchase Agreement or Loan Application).

Document Blocks

Write the reusable passages for each document type.

Block Types

Define the sections a document is built from, and their order.

PDF / Letterhead

Set the header that appears at the top of every exported PDF.

Settings

Custom fields, approval settings and other module options.

Inside each project, the Documents tab is where you assemble and export a project's document.

Menu item missing? If Documents shows no list of pages beneath it, an administrator can open Setup → Menu Setup → Main Menu and click Save once to refresh the menu.

3. Before you begin: where files go

Where a file is stored decides whether a project can use it. This is the most common cause of confusion, so set it up correctly from the start.

Location in File management

Who can see it

Can a project use it?

A team section

Your team

Yes. Files can be attached, previewed and merged into a combined PDF.

Your Inbox

Only you

No. A project can't preview or attach these files, and a preview says the file is not accessible.

Use your Inbox only as a staging area while uploading. Move each file into its document-type folder in a team section before you rely on it.

4. One-time setup

An administrator does these five steps once, in this order. After that, they only need changes when your business adds a new kind of document.

4.1 PDF / Letterhead

Where: Documents → PDF / Letterhead.

This controls the top of every exported PDF. Pick one of two letterhead modes:

  • Built-in. Turn on and align your company logo, and choose which company lines to show (name, an extra header line, address, phone). You can also add a standing document title (for example, "Agreement Package"), set the divider line's color and thickness, and set the body font size.
  • Custom HTML letterhead. Paste your own header HTML for full control. Shortcodes work here too (see section 7).

Use your dark logo, the one meant for light backgrounds. A white logo is invisible on a white page.

End-of-document citations: when this setting is on, every attached file's citation is listed at the end of the document automatically. Turn it off if you'd rather place {citations} yourself.

The letterhead applies to every document in every project. Export a test PDF after changing it to check the logo and spacing.

4.2 Custom fields (file details)

Where: Documents → Settings → Custom field.

Every library file already has Notes, Citation and Source URL fields on its edit screen. Custom fields let you record anything else. Available types are text field, text area, number field, select, multi-select, check box and radio button. These are the details that matter most for document assembly:

Detail

Where it comes from

What it feeds

Citation

Built-in field on each file

{citations} and {file_N_citation}

Notes

Built-in field on each file

{file_N_notes}

Rationale (as many as you need)

Custom field, type Text Area

Every text-area custom field on an attached file is gathered into {rationales}

Any custom field can also be pulled from a specific file with {file_N_<slug>}.

4.3 Documents (your document types)

Where: Documents → Documents.

A document type is the backbone of the system: it links files, folders and document blocks together. Add one for each kind of document you produce. To add several at once, use Bulk import and type one name per line.

Keep names consistent. The name is what you tag files with and choose in a project.

4.4 Block Types (the sections of a document)

Where: Documents → Block Types.

Block types are the sections every document is built from, such as Introduction, Background, Terms & Provisions, Supporting Statement and Conclusion. Each has a name, an order number and an active switch.

  • Order decides where the section falls in the draft. Lower numbers appear first.
  • The name prints as a heading in the draft above that section's blocks. Name block types the way you want those headings to read.
  • Turn a block type inactive to leave it out of every draft without deleting it.

4.5 Document Blocks (reusable language)

Where: Documents → Document Blocks. Choose a document type first to see its blocks.

A document block is a pre-written passage, such as a standard clause, boilerplate or a fill-in table. Each block belongs to one document type and one block type, and has its own order number within that block type.

  • Rich text. Headings, bold, lists, tables and other formatting carry through into the draft.
  • Shortcodes. Use the Insert picker above the editor to place a shortcode at your cursor. Shortcodes fill in when the draft is built.
  • Per type. A block appears only in projects that use its document type.
  • Active switch. Turn a block inactive to leave it out of new drafts without deleting it.

5. Building your document library

Build the library once, then add to it as new material comes in.

  1. In File management, open a team section and create one folder per document type.
  2. Upload the files that support each document type into its folder, as PDFs only.
  3. Edit each folder and tag it with its document type. Files inside a folder inherit the folder's document types unless you tag a file with its own.
  4. Edit each file to fill in its Notes, Citation and any custom fields, such as your rationale sections.

As soon as a file is tagged, it appears automatically in every project that uses that document type. Projects don't need to be updated when you add files.

6. Creating a document in a project

Open the project and go to its Documents tab. The tab runs top to bottom in the same order as these steps.

  1. Choose the document types. Under Project Documents, pick one or more document types and click Save Documents. The page reloads with the matching files listed.
  2. Add a secondary reference (optional). Type a free-text detail for this project in Secondary Reference and click Save. Place it in your blocks with {additional_needs}.
  3. Review the attached files. Under Attached Documents, every library file tagged with your document types appears automatically.
    • Click Remove from this project on any file that doesn't apply.
    • Manually attach a file that wasn't matched, if you need one.
    • Use Visible to customer to let the client's contacts see a file in their portal.
    • Use Preview to open a file.
  4. Build the draft. Click Generate Draft. Your blocks are assembled section by section in block-type order, and shortcodes are filled in. A notice lists any fields that couldn't be filled and any attached files without a citation.
  5. Edit and save. Change the wording, reorder it or add anything specific to this project, then click Save Draft. Clicking Generate Draft again replaces your edits, so the tool asks you to confirm first.
  6. Export. Both options save the PDF to the project's Files.
    • Save as PDF creates the document alone, with your letterhead.
    • Save Combined PDF creates the document followed by every attached file's pages, merged into one file.

Combined PDF checks every file first. If any attached file isn't a valid PDF, the export stops, names the file to convert, and saves nothing.

7. Shortcode reference

Shortcodes are placeholders that fill in with real values when a draft or PDF is built. They work in document blocks, in the draft, in file details (such as a rationale field) and in a custom HTML letterhead. A shortcode inside another value is filled in too, so {contact_lastname} written in a rationale resolves correctly.

Document

Shortcode

Fills in with

[CLIENT NAME]

The first and last name of the project customer's primary contact

[DATE]

Today's date

{need}

The project's document type (several are listed with commas)

{needs}

All of the project's document types

{additional_needs}

The project's Secondary Reference

{citations}

A numbered list of every attached file's citation

{rationales}

Every text-area custom field from each attached file, grouped by file

Per file, by position

Attached files are numbered alphabetically by name, so N is 1, 2, 3 and so on.

Shortcode

Fills in with

{file_N_name}

The Nth file's name

{file_N_citation}

The Nth file's citation

{file_N_notes}

The Nth file's notes

{file_N_<slug>}

Any custom field on the Nth file, by the field's slug

Contact and company

These fill in from the customer linked to the project and its primary contact.

Shortcode

Fills in with

{contact_firstname}, {contact_lastname}, {contact_email}, {contact_phonenumber}, {contact_title}

The primary contact's details

{client_company}, {client_phonenumber}, {client_address}, {client_city}, {client_state}, {client_zip}, {client_country}, {client_website}, {client_vat_number}

The customer's details

{companyname}

The customer's company name (same as {client_company})

{<slug>}

Any customer or contact custom field, by its slug

The Insert picker in Document Blocks lists these shortcodes, including your own custom fields.

Any other text in square brackets, such as [REFERENCE], is left exactly as written. Use it for details you fill in by hand while editing the draft.

8. Troubleshooting

What you see

Usual cause

What to do

Documents in the menu has no pages beneath it

The saved menu layout hasn't picked up the pages yet

An administrator opens Setup → Menu Setup → Main Menu and clicks Save

No files appear under Attached Documents

Files aren't tagged with the project's document type, or a file has its own tags that leave the type out

Tag the folder or file with the exact document type, then reload the project

A preview says the file is not accessible

The file is in your Inbox

Move it into a team section

Save Combined PDF stops and names a file

That file isn't a valid PDF

Convert it to PDF, replace it in the library, and export again

The draft notice lists unresolved fields

A shortcode is misspelled, or the customer or contact has no value for it

Check the spelling, then fill in the missing detail on the customer or contact

The notice says files have no citation text

Those attached files have an empty Citation

Add a citation on each file, or ignore it if you don't use {citations}

A section heading you don't want appears in the draft

Block type names print as headings

Rename the block type, or set it inactive

Your draft edits disappeared

Generate Draft was clicked again

Click Save Draft after editing; Generate Draft rebuilds from your blocks

The logo doesn't show on the PDF

A white or light logo on a white page

Upload your dark logo, the one meant for light backgrounds

9. Quick reference

The everyday loop

  1. Keep the library current: PDFs in team-section folders, tagged with their document type.
  2. In the project's Documents tab, choose the document types and check the attached files.
  3. Generate the draft.
  4. Edit it and click Save Draft.
  5. Save as PDF, or Save Combined PDF for the document plus its files.

Golden rules

  • PDF only for every file used in Document Management.
  • Team sections, never the Inbox, for anything a project must preview or merge.
  • Exact document-type names. A file's tag must match the document type it supports.
  • Block type names are headings. Name them the way you want each section titled.
  • Set the letterhead once. It applies to every export.
  • Save Draft before you leave. Generate Draft replaces unsaved edits.

Did you find this article useful?