Skip to main content

Settings Tab

The Settings tab contains user-level preferences and, for project admins, the full project configuration. Project settings control how documents are numbered, which fields are required, how file names are validated, and how external systems receive event notifications. Changes to project settings apply to new records; existing records retain the values they were created with.

Workflows settings tab

My Preferences

Available to all users. Controls your personal display and communication settings:

SettingDescription
Display nameYour visible name across reviews, transmittals, and correspondence.
TimezoneControls all date/time display in Workflows.
Date formatRegional date format preference (DD/MM/YYYY, MM/DD/YYYY, YYYY-MM-DD).
LanguageInterface language (where translations are available).
Notification preferencesPer-event email frequency. See Notifications.

Project Settings (Admin)

Visible and editable only by project admins and org admins.

General

SettingDescription
Numbering prefixA short alphanumeric prefix prepended to every document number in this project (e.g., PRJ-A).
Default review daysThe default step duration (in calendar days) used when no SLA is specified in the review matrix or template.
Mandatory reviewerWhen enabled, workflows cannot be created without at least one named reviewer.
Reset review status on new revisionWhen enabled, uploading a new revision resets the document's review status to Draft.

Document field configuration

Project admins can add, edit, reorder, and deactivate the pick-list options for each document metadata field. Access via Settings → Document fields.

Field configurableOptions you can manage
Document typesAdd new types (Drawing, Specification, Report, etc.), rename, set a type code, reorder.
DisciplinesAdd disciplines (Structural, Mechanical, Civil, etc.), set discipline code, reorder.
Zones / areasAdd zone options with zone codes.
StagesAdd programme stages or delivery phases.
Packages / contractsAdd work package or contract references as selectable options.

For each option: set a Label (displayed in the UI), a Code (used in auto-numbering), and an Active toggle (inactive options are hidden from the pick-list but remain on records that used them).


Mandatory fields

Configure which document metadata fields must be completed before a document upload or edit can be saved. Access via Settings → Mandatory fields.

BehaviourDetail
Mandatory fieldsUpload and edit forms show a red asterisk; save is blocked until all mandatory fields are filled.
Per-document-type overridesDifferent mandatory field sets can be configured for each document type (e.g., drawings require Zone; reports do not).

File naming pattern

Enforce a project-level filename format to prevent non-standard file uploads. Access via Settings → File naming.

SettingDescription
Pattern (regex)A regular expression that all uploaded filenames must match. Leave blank to allow any filename.
Error messageA human-readable message shown when the filename fails validation (e.g., "File name must follow the format DIS-TYPE-NNNN.pdf").
Apply toNew documents only, or new documents and new revisions.

Webhook configuration

Webhooks let Workflows push real-time event notifications to external systems (project management tools, data lakes, custom dashboards). Access via Settings → Webhooks.

Configuring a webhook:

  1. Go to Settings → Webhooks → New webhook.
  2. Enter the Endpoint URL (HTTPS required).
  3. Enter a Shared secret used to sign the webhook payload (HMAC-SHA256). The receiving system uses this to verify authenticity.
  4. Select which Events to subscribe to (see event list below).
  5. Toggle Active and save.

Supported webhook events:

EventFires when
workflow.createdA new workflow is started on a document.
workflow.completedA workflow reaches its final state (approved, rejected, or auto-completed).
workflow.step_completedAny workflow step is completed by an assignee.
document.createdA new document record is added to the register.
document.status_changedA document's status is changed.
transmittal.issuedA transmittal is formally dispatched to recipients.
transmittal.acknowledgedA recipient acknowledges a transmittal.

Delivery and failure handling:

  • Webhooks are delivered with a 5-second timeout. If the endpoint returns a non-2xx status or times out, delivery is retried up to 3 times with exponential backoff.
  • The webhook delivery log (in Settings → Webhooks → Delivery log) shows each delivery attempt, response status, and payload.
  • After 10 consecutive failures, the webhook is automatically deactivated and a notification is sent to the project admin.