Skip to main content

Key Concepts

Understanding a few core concepts makes the rest of the Docwize documentation easier to follow.

Exploring how documents connect to metadata, relationships, and workflows in Docwize

What this page covers​

  • What a document means in Docwize
  • How metadata is used, and how it organises documents
  • How workflows bring work to you
  • Why access and permissions change what you can see and do

Documents​

In Docwize, a document is more than just a file. It usually combines:

  • one or more files
  • metadata
  • relationships to other documents and to the work done on it, such as revisions, attachments, cross references, transmittals and workflows

To see all three for one document, right-click it in Explorer and select Document details. The Details section holds its metadata, and sections such as Revisions, Attachments, Transmittals and Workflows show its relationships. See Document Details.

Metadata​

Metadata is the structured information attached to a document, such as its Description, Type, Document Date, Reference Number, Status, the project it belongs to, and who it is From and To.

Some metadata is standard on every document, while other fields are added by your organisation through custom field configuration.

How metadata organises documents​

Metadata lets you find and group documents without anyone filing them by hand. The illustrations below use a construction project where an administrator has set up custom fields for WBS element (the part of the project a document belongs to), discipline (the engineering field, such as mechanical or electrical), and document type (such as a drawing or a specification). The fields, codes, and views available in each organisation depend on how Docwize has been configured.

Taken together, a document's codes work like an address. Each combination points to one document, and the document number can be built from the same codes.

A 3D grid with WBS element, discipline, and document type axes, with one highlighted document at WBS 2400, discipline ME, type SPE

Each document's codes place it at one point in the project

Fixing one code gives a slice of the project. For example, filtering on WBS 2400 returns every document for that WBS element, whatever its discipline or type.

The same grid with the WBS 2400 plane highlighted, containing documents from three disciplines and three types

Filtering on one code returns a slice of the project

Fixing two codes narrows the slice further. A dataview that filters on discipline ME and type SPE lists every mechanical specification across the project. A dataview runs its query each time it is opened, so the list stays current as documents are added or changed. The exception is a dataview whose settings have Cacheable turned on: it keeps its results for a set time, so it opens faster but may not show the latest changes until then.

The same grid with a row highlighted where discipline is ME and type is SPE, spanning three WBS elements

A dataview filtering on two codes returns a row

A tag works like an extra code. Because a tag is another code on the document, one tag can gather documents from anywhere in the project without moving them. For example, a package tag can pull together every deliverable for one contract, whatever its WBS element or document type. A handover tag can do the same across every discipline.

A package tag, ME02, linked to four documents spread across two WBS elements and three document types

A tag gathering documents from across a project

A transmittal is a set of documents chosen for issue. It records which documents were issued, to whom, and when.

A transmittal, TRN-0042, linked to three documents and addressed to a mechanical contractor

A transmittal records a chosen set of documents and who it went to

A folder is where a team goes to find its documents. One document can sit in several folders at once, so each team can find it in the place it expects. Every folder shows the same document, so nothing is copied. When the document's file is replaced with an updated one, the updated file is the current file in every folder.

One document, a crane hire agreement, linked to three folders: Plant, Tenders And Estimating, and Financial

One document can appear in several folders

The same codes can also be counted. A chart in an interface can count documents by a metadata field such as discipline. Because the chart counts the codes on the documents themselves, it keeps up as documents change. Select Refresh (the circular arrow) on the chart to count again with the latest data.

A bar chart counting documents by discipline, built from the discipline codes on each document

A chart counting documents by discipline

Workflows​

Workflows route documents or tasks between users, or through machine-based steps, for review, approval, sign-off, data capture, or automated processing.

An administrator builds a workflow once, as a process map. Each time it runs, the document passes through people and system steps, and each reply decides which step comes next. For example, a rejection can send the document back to its author for correction.

A contract approval workflow: legal review, an approve or reject decision, finance sign-off, conversion to PDF, an email, and completion, with rejections routed back to the author

A workflow is built once and routes each run by the replies given

You usually meet workflows in the Inbox, where the work they send you waits for your reply. Administrators build workflow templates under New > Workflow Setup. See Workflows in the configuration docs.

Permissions and visibility​

Two people can open the same folder or run the same search and see different documents, or different buttons. What you can see and do depends on two things: access and permissions.

Access decides which documents you can see. You can see a document when:

  • it has been shared with you, or with a group you belong to, directly; or
  • it is filed in a folder you have access to and, if it belongs to a project, you also have access to that project; or
  • it is in no folder, and you have access to its project; or
  • it is linked to a register row you have been given access to.

Access is only ever granted. A folder or project that nobody has been given access to is visible to no one, so a document you expect to see may simply not have been shared with you yet.

Permissions decide which modules, features and actions you can use, such as the Admin Console or the review tools. An administrator gives them to your groups or to you. If a module or button described in this documentation is not shown for you, ask your administrator whether you have the permission for it.

For configuration details, see Access Control and Permissions.