Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Display Models

Display Models provides a mechanism to define the display text for elements in the TIBCO BusinessEvents WebStudio classic user interface, such as, properties. Instead of displaying the default element name, a more user readable name in any selected language could be displayed.

You can provide a name for the artifact and its properties in your preferred language using Display Model. Thus, you can see the artifact and its properties name in your language while using the WebStudio. See theTIBCO BusinessEvents WebStudio User Guide for how it would appear in the WebStudio.

Display Models are defined inside the TIBCO BusinessEvents Studio, similar to Concepts, Events, and Rules. A Display Model is a specialized type of property file, and follows the familiar name/value pair syntax for property files in Java. Display Models are the first class citizens inside the BusinessEvents Studio project, and their file extension is .DISPLAY.

## Naming

TIBCO BusinessEvents assigns the Display Model name that matches with the associated BusinessEvents project artifact (Concept or Event). For instance, for the Concept named Person.concept, the corresponding Display Model artifact is named Person.display. This naming method simplifies the syntax and allows for a loose coupling of the artifacts. However, the Display Model follows the standard Java I18N naming conventions if language and country values are specified, that is the name of the file is <artifact_name>_<language_code>_<country_code>.display. For example, if English is selected as the language and the United States is selected as the country, for the Concept named Person.display, the Display Model file is saved with the file name Person_en_US.display.

The Display Model also supports code refactoring. If an artifact is renamed, then the Display Model file associated with the artifact is automatically renamed. If the properties of the artifact is renamed, then the properties are also updated in the Display Model.

## Syntax

The syntax for the Display Model files follows the standard Java property file syntax, that is, specifying name and value pairs. There are three major parts of the file:

- For each artifact property, there is an optional text that is displayed in the WebStudio UI. The simple syntax is as follows:

      <property_name>=<display_text>

  For example,

       Name.displayText=User Name

  Note: In the case of Arabic characters, do not use accents, as they are not supported in TIBCO BusinessEvents.
- Additionally, there is an optional property that allows properties to be hidden entirely from the WebStudio UI, so that they are not accessible from the builder-based Business Rule editor or Decision Table editor.

      <property_name>.hidden=true | false

  For example,

       Name.hidden=true

- Finally, there is an optional property to specify the text to be displayed wherever the artifact itself is shown in the WebStudio UI, for instance inside of the Group Contents window. The syntax for this setting is:

      displayText=<display_text>

  For example, for an Applicant concept

       displayText=Credit Card Applicant

## Overriding Behaviors

As Concepts and Events can inherit properties from the parent Concepts and Events, any visible property from the artifact's hierarchy is also visible to the Display Model. For example, if the Concept Employee inherits a property called Name from the Concept Person, it is valid to specify the display text for the Name property inside of the Display Model for the Employee Concept. The Name property can have different meanings for different concepts, and you can use display text to differentiate them.

You can also override a display text inside a Rule Template. This overriding behavior provides another level of meaningful, context-aware specification of properties. A new `display` section could be added to the Rule Template source, and the context-sensitive display text for each accessible property can be specified using the dot notation. For example,

    display {
                 account.AccountID = "Personal Checking Account ID";
           }

Subtopics

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.