Glossary

Type

  • A blueprint that defines the structure and behaviour of a particular kind of data or process

  • Purpose: Used to model entities such as documents, workflows, or tasks.

  • Relevance: Templates are created based on Types; Instances are executions of these Templates.

Template

  • A predefined configuration of a Type, serving as a starting point for creating Instances.

  • Purpose: Ensures consistency and standardization across similar processes or documents.

  • Relevance: Derived from a Type; used to generate Instances.

Instance

  • A specific execution or occurrence of a Template, representing a real-world process or document.

  • Purpose: Tracks the progress and data of individual workflows or documents.

  • Relevance: Created from Templates; can be part of a Workflow.

Entity

  • Are types, templates, or instances.

  • Purpose: Represents the various components that interact within the system.

  • Relevance: Entities are defined by Types; Instances represent specific Entities.

Work Instructions

  • A sequence of steps or stages that an Instance progresses through, often involving multiple users or systems.

  • Purpose: Manages the flow and approval processes of documents or tasks.

  • Relevance: Instances follow Work Instructions; Work Instructions are defined within Templates.

Change Set

  • A collection of modifications made to Templates and/or Instances, grouped together for review, to be published.

  • Purpose: Facilitates controlled updates and versioning within the platform.

  • Relevance: Applied to Templates and/or Instances; once approved, changes are Published.

Publish

  • The action of publishing and/or making a Template or Instance active, done via change sets.

  • Purpose: Finalises and deploys configurations or updates.

  • Relevance: Follows the approval of a Change Set, all entities in Change Sets are published together

Last updated