Skip to main content

Introduction

The Carium Forms Framework offers a robust way for developers to configure complex, dynamic web forms with a minimal understanding of HTML/CSS and no need to write any code.

Terminology

A Form can be defined as a collection of Fields and Labels, organized into Sections. These terms will be used throughout this documentation.

ComponentDescription
FieldA part of the Form requesting information to be entered by the user.
LabelRead-only text that's meant to communicate information to the user, independent of any Field.
SectionA collapsible, named collection of Fields and/or Labels.

Data model

ComponentDescription
SpecA named Form, nothing else can exist unless/until a Spec exists.
SpecVersionA specific named version of a Spec, (names like v1, v2, etc.) Form schemas are associated with a particular spec version.
InstanceWhen a SpecVersion is assigned to a particular participant, an Instance is created. The Instance associates the SpecVersion with the participant.

In these guides, the focus will mainly be on Spec and SpecVersion records.