Function VariableSet

Returns { $id: string | number | ExplicitKey<string> } & {
    protectionPolicy?: "read" | "protected";
} & OverrideProperties & {
    createRoles?: (string | Role)[];
    description?: string;
    displayTitle?: boolean;
    internalName?: string;
    layout?: "normal" | "2across" | "2down";
    name?: string;
    order?: number;
    readRoles?: (string | Role)[];
    setAttributes?: string;
    title: string;
    type?: "singleRow" | "multiRow";
    variables?: V;
    version?: number;
    writeRoles?: (string | Role)[];
} & { variables: V }

• $id: string | number | ExplicitKey<string>

• OptionalprotectionPolicy?: "read" | "protected"

  Controls edit/view access for other developers after the application is installed.

  • read: Others can see the script logic but not change it.
  • protected: Others cannot change this record.
  • Omit to allow other developers to customize this record.

• OptionalcreateRoles?: (string | Role)[]

  Roles that can create instances of this variable set An array of role names or Role references

• Optionaldescription?: string

  Description of the variable set

• OptionaldisplayTitle?: boolean

  Whether to display the title

  Default

  false
  Copy

• OptionalinternalName?: string

  Optional : this is auto generated if not provided

• Optionallayout?: "normal" | "2across" | "2down"

  Layout style for the variable set Common values: 'normal', '2down', '2across'

  Default

  'normal'
  Copy

• Optionalname?: string

  Optional name field

• Optionalorder?: number

  Display order of the variable set

  Default

  100
  Copy

• OptionalreadRoles?: (string | Role)[]

  Roles that can read this variable set An array of role names or Role references

• OptionalsetAttributes?: string

  Set attributes (additional configuration)

• title: string

  Display title of the variable set (translated field)

• Optionaltype?: "singleRow" | "multiRow"

  Type of variable set

  • 'singleRow': Single Row (default)
  • 'multiRow': Multi Row

  Default

  'singleRow'
  Copy

• Optionalvariables?: V

  The variables for the variable set

• Optionalversion?: number

  Version number of the variable set

• OptionalwriteRoles?: (string | Role)[]

  Roles that can write/modify this variable set An array of role names or Role references

• variables: V

Returns VariableSet