Skip to main content

Building a Form

Using the Web​

The Carium Web Interface for building forms is located at /forms/ and accessible by the Forms item in the left navigation bar.

info

If the Forms navigation item isn't visible to you, please contact your Carium success manager.

Create a Spec​

  1. Click the Add form button to bring up a modal.
  2. Enter a name for the Spec
  3. Click Create to create the Spec and be redirected to the Form builder.

Create a SpecVersion​

If this Form will have Sections, all Fields must exist within a Section. If the Form won't have Sections, all Fields will exist directly within the Form.

With Sections​

  1. Click Add section to create the first Section
  2. Enter the Section name and click Add field to <section name> to add a Field to the Section
  3. Enter the Label for the Field and choose the appropriate Input type as well as any other options based on the selected Input type.
  4. Repeat steps 1 through 3 until all desired Sections and Fields have been entered.
  5. Click Save to save the new SpecVersion.

Without Sections​

  1. Click Add field to create the first Field
  2. Enter the Label for the Field and choose the appropriate Input type as well as any other options based on the selected Input type.
  3. Repeat steps 1 and 2 until all desired Fields have been entered.
  4. Click Save to save the new SpecVersion.

Using the Command Line​

Before attempting to use the command line to create a Form, one must install the Carium CLI and log in.

Create a Spec​

The fm-spec create command is used to create a new Spec. The first positional argument is the name of the Spec. To include spaces in the name, simply wrap the name in quotes.

$ crm fm-spec create "My Form"

The UUID of the newly created Spec will be returned from the above command. That UUID will be used to add a SpecVersion in the next command.

Create a SpecVersion​

The fm-spec add-version command is used to create a new SpecVersion for an existing Spec. Before running the command, create a schema.json file that contains the Form schema.

$ crm fm-spec add-version <spec-uuid> @schema.json --current

The @ symbol is used to denote that the following argument is a file path.