Package com.inductiveautomation.ignition.gateway.dataroutes.openapi.annotations

Annotation Interface FormId

@Target(FIELD) @Retention(RUNTIME) public @interface FormId
An annotation to include the "id" form setting in the schema for a field. Generated forms otherwise derive a field's dom id from its own name, which collides when a nested field shares a leaf name with another field in the same form. The value is used verbatim.

Apply this to a leaf field; on a record component holding a nested group it has no effect.

The form control renders <id>-input-group on its root. The control's own id varies by FormField type, so check the rendered dom before writing a locator.

Only reaches forms generated from a backend schema, not those built from a hand-written FormConfig. Unrelated to SchemaUtil.Builder#id(String), which sets JSON-Schema $id.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    A dom id, unique within the form that contains the annotated field.

  • Element Details

    • value

      String value
      A dom id, unique within the form that contains the annotated field.