Adding a State Model Component

The New State Model Component wizard configures one set of configuration templates. The templates are applied to all states in the state model component.

The state model component created in the wizard is deployable. Depending on the need, you may not need to do any additional configuration. For example, if data sources are parameterized, Dashboard users can do their own personalization

You can modify each state’s settings as needed in the State Model Component Editor (see Editing a State Model Component).

Tip: You can skip wizard pages and use the editor to complete the configuration. See Editing a State Model Component.

The exception is that if a data source is parameterized, you must provide default values before finishing the wizard.

Prerequisites: A state model component is based on a state model resource. Ensure that your project contains a state model on which to base the state model component.

A state model component specifies one or more metrics and data sources. Add the resources you need before adding the component.

Procedure

  1. In TIBCO BusinessEvents Studio Explorer, select the folder where you want to store the state model component. Click the New State Model Component toolbar button, in the Component drop-down list.

    You see the The New State Model Component wizard.

  2. Name the state model component, and optionally, provide a description.
    Tip: The description is shown to Dashboard users. Use this field to provide a useful description, keeping the needs of Dashboard users in mind.
  3. In the State Model field, select the state model for which you are defining this state model component. Click Next.
  4. You see the Template for Indicator Data Settings page. Indicator data settings define the data used for the indicator in the state’s title area.
    1. In the Measure field select an appropriate metric.
    2. In the Data Source field, select a data source for that metric. Only valid data sources for the selected metric display.

      The data source query displays. It is not editable.

    3. If the data source uses parameters, provide default values for each one.
    4. In the Value Field, select one field to use as the value field for the indicator.
    5. Click Next.
  5. You see the Template for Content Data Settings page. Content data settings define the data used for the state’s content area (under the title area).
    1. In the Measure field select an appropriate metric.
    2. In the Data Source field, select a data source for that metric. Only valid data sources for the selected metric display.

      The data source query displays. It is not editable.

    3. If the data source uses parameters, provide default values for each one.
    4. In the Value Field, select one field to use as the value field for the content area.
  6. Define how to display the value. Do one of the following:
    • In the Show as field select Text, to display the content area data as a text value. From the Format field, select a text formatting option from the drop-down list. The list displays the options - Unformatted, Default, and a list of appropriate options for the value field’s data type (for example, for a Long field, you can choose Integer, Currency, or Percent).

      The option Unformatted is available for numeric and DateTime datatypes and displays the raw, unformatted value. The option Default displays the value in the default format for the datatype.

      If the options shown do not meet your needs, or if you want to do other advanced formatting, or add text as well as the field value, select Pattern from the drop-down list and use the Pattern text box to define the field format manually. See Java Syntax Field and Screen Tip Formatting Options for details.

    • In the Show as field select Progress bar, to display the content data value as a bar showing a percentage value.

      Specify the minimum and maximum values for the progress bar as a constant value, or using a metric field. See Progress Bar Settings for details.

    1. Click Next.
  7. You see the Template for Indicator Alert Settings. The procedure is the same as it is for charts. However for indicator alerts the only valid visual alert action is Fill Color. See Adding Alerts Settings for details. When you have configured all the ranges required, click Next.
  8. You see the Template for Content Alert Settings. The procedure is the same as it is for charts. See Adding Alerts Settings for details. When you have configured all the ranges required, click Finish.

Result

The State Model Component editor displays, showing the graphical display of the states. To configure the individual states, or to specify options not available in the wizard, edit the state component model. See Editing a State Model Component.