HQ Documentation#

This repository is the maintained internal documentation set for Altia HQ. The Markdown in this repo is the source of truth going forward.

Product Overview#

Introduction - Purpose, audience, and intended use of this documentation.
Overview - Current overview of Altia HQ product areas, architecture, and documentation scope.
Platform architecture - Current Altia HQ product structure based on the active HQ repository.
Solution Overview - Consolidated architecture insights from dependency and domain analysis outputs.

Web User Workflows - Core browser-based workflows such as adding items, searching, attachments, and personal menus.
Mobile Workflows - Mobile browser and mobile-app guidance with current caveats for offline and synchronised use.

Solution Delivery Checklist - Practical checklist for shaping and rolling out an Altia HQ solution.
Information Types and Data Model - How Altia HQ models business data using internal and external information types.
Layout, Views, Access, and Documents - Hub page for screen design, mappings, generated documents, and access controls.
Layout and Screen Design - Guidance for designing usable HQ forms and record layouts.
Mappings and Generated Documents - How data flows between records and into templated outputs.
Information-Based Access - How to think about configured access controls at record level.
Process Automation - Hub page for process structure, lifecycle visibility, and activity design.
Process Overview and States - How lifecycle stages and process-overview presentation should be designed.
Process Activity Design - How to design activities, outputs, branching, and execution modes.

The System - Core platform capabilities, authentication, extensibility, and data model concepts.
General - General user experience behaviours such as passwords, switching systems, and idle timeout.
Expression Definitions - Reference material for literals, variables, functions, and operators.
Saved Searches and Dashboards - Saved search behaviour and dashboard concepts.
Building Systems: Field Options - Field configuration options, validation, and variations by field type.

Administration and Configuration - Configuration topics including email, SMS, auditing, password policy, users, and packages.
Extensions and Plugin Development - Hub page for extension patterns in the current HQ repo.
Plugin Contracts - The main extension interfaces and when to use them.
Custom Item Providers - Guidance for surfacing external data through HQ plugin contracts.