Form Building Standards

TLP:AMBER - Limited disclosure, recipients can only spread this on a need-to-know basis within their organization and its clients. Recipients may share TLP:AMBER information with members of their own organization and its clients, but only on a need-to-know basis to protect their organization and its clients and prevent further harm 

Overview:

This document outlines the best practices and guidelines for creating and managing forms using Rewst's form functionality. Rewst's tools allow for the creation of interactive, responsive, and customizable forms that can be integrated into various web pages and automated workflows.

 

Naming Best Practices

1. Prefix with Organization Name

  • Format: [OrganizationName]
  • Application: Each workflow must be prefixed with the name of the organization it is developed for, enclosed in square brackets.
  • Example: [eTop] Workflow Name

2. Descriptive Naming

  • Requirement: Workflow names must concisely yet accurately describe the function and purpose of the workflow.
  • Guidelines:
    • Use clear and simple language.
    • Avoid technical jargon unless it is widely understood within the organization.

3. Length and Readability

  • Maximum Length: Workflow names should not exceed 30 characters, including the organization prefix and version numbers.
  • Clarity: Ensure the name remains readable and understandable, even with length constraints.

4. Special Characters and Case Sensitivity

  • Allowed Characters: Use only alphanumeric characters and underscores.
  • Case Sensitivity: Workflow names should be in Camel Case for better readability.
  • Example: [eTop] Invoice Processing

5. Categories and Sub-Categorization

  • Categorization: Where applicable, include a category or sub-category prefix.
  • Example: [eTop]HR_Onboarding Process

 

Form Building Best Practices

1. Build for Repeatability

  • When building forms, keep reusability in mind. Does this form need to be specific to a client? How can it be re-adapted to work for multiple later on? 

2. Utilize Conditional Fields

  • Rewst allows you to set conditions for when a form field should be visible, required, and/or set by default.
  • Utilize these conditions wherever possible to keep the length of forms short unless additional fields are needed and provide an easier "on rails" experience to the end user.

3. Provide specific options in dropdown components

  • Where possible, always provide a list of pre-approved options in a dropdown field rather than a free text entry.
    • For example, allow free text entry for a new user's username, but require the user submitting the form to select the email domain from a dropdown list of options.

4. Utilize Option Generator Workflows

  • When providing dropdown or multi-select fields, populate them dynamically via an option generator workflow where possible.
  • If a static list should always be presented, consider populating it via an organization variable list.

 

Form Triggered Workflows

1. Input Variable Alignment

  • When utilizing a form as a workflow trigger, create input variables in the workflow for ALL form fields.
  • Ensure the required checkbox on the input variables also match if the field is required in the form.
  • This allows for easier recall of form names through auto-complete in the workflow, and ensures all required information is entered when testing the workflow.