Package com.thingworx.metadata.annotations

Annotation Interface ThingworxConfigurationTableDefinition

@Target(ANNOTATION_TYPE) @Retention(RUNTIME) @ThingworxExtensionApiAnnotation(since={6,6}) public @interface ThingworxConfigurationTableDefinition

Defines a configuration table to contain settings and other configurable information. Configuration table data may belong to a specific entity, or to all entities that implement the same thing template.

Note that while configuration tables may belong to any root entity, only some are designed to expose it in the Composer.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    ThingworxDataShapeDefinition
    dataShape


    Required parameter: defines the fields that compose the configuration table.
    String
    name


    Required parameter: the name of the configuration table.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    aspects


    Optional parameter: defines the aspects for configuration table, each aspect is string in format of ('key:value').
    String
    category


    Optional parameter: a category that conceptually groups together related configuration tables.
    String
    description


    Optional parameter: a short description of the configuration table and its purpose.
    boolean
    isHidden


    Optional parameter: controls whether the configuration table should be hidden by Composer (e.g.
    boolean
    isMultiRow


    Optional parameter: controls whether the configuration table should accept tabular entry of data or key/value entry.
    int
    ordinal


    Optional parameter: controls the order in which the configuration tables should be rendered.

  • Element Details

    • name

      String name


      Required parameter: the name of the configuration table. This name should be used when retrieving values from the configuration table during execution. Configuration tables must have unique names that obey standard ThingWorx entity naming conventions. It is strongly recommended that you always specify a non-empty configuration table name.

    • description

      String description


      Optional parameter: a short description of the configuration table and its purpose.
      Default:
      ""

    • category

      String category


      Optional parameter: a category that conceptually groups together related configuration tables.
      Default:
      ""

    • isMultiRow

      boolean isMultiRow


      Optional parameter: controls whether the configuration table should accept tabular entry of data or key/value entry. When set to true, the fields in the data shape provided will be interpreted as column descriptors. When set to false or omitted, the fields are interpreted as row descriptors.
      Default:
      false

    • ordinal

      int ordinal


      Optional parameter: controls the order in which the configuration tables should be rendered. Any non-negative integer is permitted, where lower values take higher precedence over larger values. If several tables share the same ordinal, then the order is non-deterministic.
      Default:
      0

    • dataShape

      ThingworxDataShapeDefinition dataShape


      Required parameter: defines the fields that compose the configuration table. Each field must specify at minimum the name and base type, although it is recommended to also include ordinality and default values when possible. Configuration tables do not support references to data shape entities.

    • isHidden

      boolean isHidden


      Optional parameter: controls whether the configuration table should be hidden by Composer (e.g. if the configuration is for internal purposes only).
      Default:
      false

    • aspects

      String[] aspects


      Optional parameter: defines the aspects for configuration table, each aspect is string in format of ('key:value'). If value is JSON then give Stringified JSON
      Returns:
      aspects array
      Default:
      {}