Attribute Customization (2024)

Attribute Panel

The UI for displaying attributes as name-value pairs according to the Attribute Layout definition.

Client / Screen

The end user UI in which the attributes will be displayed. Example: Create Wizard Attributes Step.

Info Page Primary attributes

The attributes panel in the information page that is primarily used for displaying a small set of the attributes. This is normally displayed at the top of the info page.

Info Page Full attributes list

The attribute panel that is primarily used for displaying a larger set of attributes on an information page.

GUI component / UI component

The UI widget (or a composite of UI widgets) displayed on the screen for the user to enter a value for an attribute or to display the value of an attribute.

Attribute Properties

Properties that can be set on attributes either in the Type and Attribute Management utility or using other configuration points to customize the display and data acquisition for an attribute.

Rendered as:

Rendered as:

UI Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Controlling the Size of Input Fields for String Attributes

• Limiting the Length of Values Entered for a String Attribute

UI Configurations:

• Visibility (see Visibility and Modifiability section in this topic )

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Create Hyperlinks (see Configuration Points section in this topic )

• Making a String Value All Upper Case or All Lower Case

Data Acquisitions Configurations:

• Configuring the source of data (see Customizing Data Acquisition section in this topic for more information)

• Configuring the data utility (see Data Utilities section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see Customizing Data Acquisition section in this topic for more information)

• Configuring the data utility (see Data Utilities section in this topic for more information)

Rendered as:

Rendered as:

UI Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists)

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Date Input Field Type (see Configuration Points section in this topic for more information)

• Local Time Zone (see Configuration Points section in this topic for more information)

UI Configurations:

• Visibility (see Visibility and Modifiability)

• Multiple Values (Global IBAs Only))

• Defining Custom Labels

• Date Display Format (see Configuration Points section in this topic for more information)

• Local Time Zone (see Configuration Points)

Data Acquisitions Configurations:

• Configuring the source of data (see Customizing Data Acquisition section in this topic for more information)

• Configuring the data utility (see Data Utilities section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see Customizing Data Acquisition section in this topic for more information)

• Configuring the data utility (see Data Utilities section in this topic for more information)

Rendered as:

Rendered as:

Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

Configurations:

• Visibility (see “Visibility and Modifiability” section in this topic for more information)

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Percent (see “Configuration Points” section in this topic for more information)

• Currency (see “Configuration Points” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition for more information” section in this topic for more information)

• Configuring the data utility (see “Data Utilities for more information” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition for more information” section in this topic for more information)

• Configuring the data utility (see “Data Utilities for more information” section in this topic for more information)

Rendered as:

Rendered as:

Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

Configurations:

• Visibility (see “Visibility and Modifiability” section in this topic for more information)

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Percent (see “Configuration Points” section in this topic for more information)

• Currency (see “Configuration Points” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (See “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Rendered as:

Rendered as:

Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Measurement System (see “Configuration Points” section in this topic for more information)

Configurations:

• Visibility (see “Visibility and Modifiability” section in this topic for more information)

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

• Percent (see “Configuration Points” section in this topic for more information)

• Currency (see “Configuration Points” section in this topic for more information)

• Measurement System (see “Configuration Points” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” in this topic for more information)

• Configuring the data utility (see Data Utilities” in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see Customizing Data Acquisition in this topic for more information)

• Configuring the data utility (see Data Utilities in this topic for more information)

Rendered as:

Rendered as:

Configurations:

• Required Input

• Default Values

• Visibility and Modifiability

• Defining Custom Labels

Configurations:

• Visibility (see “Visibility and Modifiability” section in this topic for more information)

• Defining Custom Labels

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Rendered as:

Rendered as:

Configurations:

• Required Input

• Default Values

• Validating Input Values and Legal Value Lists

• Visibility and Modifiability

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

Configurations:

• Visibility (see “Visibility and Modifiability” section in this topic for more information)

• Multiple Values (Global IBAs Only)

• Defining Custom Labels

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Data Acquisitions Configurations:

• Configuring the source of data (see “Customizing Data Acquisition” section in this topic for more information)

• Configuring the data utility (see “Data Utilities” section in this topic for more information)

Required Constraint

This configuration will be applied to an attribute on all the UIs in which the attribute is displayed. This rule is enforced both in the UI and during persistence in the DB. For exceptions see the javadoc for com.ptc.windchill.annotations.metadata.PropertyConstraints.

The constraint can be set using one the following configuration points:

For modeled attributes:

• Required Constraint in the Type and Attribute Management utility (see Constraints Tab for more information)

For global attributes & local attributes:

• Required Constraint in the Type and Attribute Management utility (see Constraints Tab for more information)

Input required Property

The property Input Required can be set on a modeled, global or local attribute.

Scope: This configuration is applied to this attribute only on the specific attribute panel for which the property is set. This setting is purely a UI only rule and is not enforced during persistence in the DB.

The Input Required property cannot be used to disable mandatory input on an attribute that already has a Required constraint.

Make input required on all UIs in which the attribute is displayed for entry/editing

Use the Required Constraint

Make input required when the attribute does not have a UI for entering the value, like import of data, programmatic creation of objects objects/attributes

Use the Required Constraint

Make input required for the attribute only on a specific UI

Use the Input Required property

Make input required for the attribute only in the UI; do not enforce this outside the UI, like when a value is provided programmatically

Use the Input Required property

In tables that allow input of data, the “*” will not be added to the column headers. This is because if a table displays more than one object type, for any given column, some types might have the attribute configured as required and others may not.

initialValue

A property used to specify default value(s) for an attribute. Applies to modeled attributes only.

See the javadoc for com.ptc.windchill.annotations.metadata.GeneratedProperty and Modeling Business Objects for more information.

Default Value

A configuration in the Type and Attribute Management utility.

Object Initialization Rule

Default Value Display Mode

A property used to configure how default values will be displayed in the UI. See “Default Value Display Mode” in Configuration Points for more information.

Provide default value(s) for use in create UI only.

You do not want this value to be automatically persisted when a value is not provided in the UI.

For a modeled attribute, use the initial value property

For global and local attributes, provide the default value in the Type and Attribute Management utility.

Provide default value(s)s for use in the Create UI and persistence

You want this value to be automatically persisted for that attribute when a value is not provided until the point of persistence.

Specify the default values using an Object Initialization Rule.

Provide default values for attributes that are not displayed in the Create UI and use this value for persistence

This applies when you want to create an object programmatically (without a UI) or, when some attributes of an object are not added to the Create UI of an attribute.

Specify the default values using an Object Initialization Rule.

Specify how default values should be presented in the UI

Use the Default Value Display Mode property.

Immutable constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Changeable constraint

A property constraint. Applies to modeled attributes only.

See the javadoc for com.ptc.windchill.annotations.metadata.PropertyConstraints and Modeling Business Objects for more information.

Visibility setting in the Type and Attribute Management utility

A configuration in the Type and Attribute Management utility. See Visibility Tab for more information.

Role-based Attribute Visibility

A configuration in the Profiles Management tool. See Managing Profiles for more information.

Attribute validator

Java classes that can be used to perform attribute validation and filtering. See UI Validation for more information

Hidden attribute

The attribute (both label & value) is not displayed.

Column header will be displayed. For those row objects for which the attribute is hidden, the UI displays “(Secured Information)”

Value hidden

Read-Only

When the attribute does not have a value

When the attribute has a value

When the attribute does not have a value:

When the attribute has a value:

Read-Write

When the attribute does not have a value yet

When the attribute has value

When the attribute does not have a value yet:

When the attribute has value:

Always hide an attribute from a specific UI, for all profiles

Simply exclude it from the UI (i.e. do not add it to an attribute panel or a table configuration).

Hide an attribute from a specific UI, for all profiles, based on specific business logic

Use the validation service.

Hide an attribute from all UIs, for specific profiles only

Use Role-based Attribute Visibility.

Limitation: This feature is available only for global attributes. See Creating a New Attribute for more information.

Always make an attribute not modifiable in any of the UIs it is displayed on

Use the Immutable constraint / changeable constraint.

Limitation: If the attribute is immutable on create or edit, do not add it to an area of the UI where fields that will be updated are placed.

Control the modifiability (hide value, make value editable or read-only) of an attribute in a specific UI, for all profiles

Use the visibility settings in the Type and Attribute Management utility to control the modifiability of an attribute in the end user UI. See visibility settings in the Type Manager for more information.

Limitations: This feature is limited to Create and Edit UIs only.

Also, at this point, the visibility & modifiability settings are honored only for those attributes that have local attribute behavior (All local attributes, global attributes and some modeled attributes). Modeled attributes with special OOTB behavior like Name, Number and Principal may not reflect this configuration.

Control the modifiability (hide value, make value editable or read-only) of an attribute in all UIs, for specific profiles only

Use Role-based Attribute Visibility.

Limitation: This feature is available only for global attributes. See Creating a New Attribute for more information.

in the Profiles Management tool:

Value Hidden

in the Type and Attribute Management utility, for Create Screen:

Read-only

Resulting visibility setting applied in the Create UI:

Value-Hidden (this is the most restrictive of the two settings)

Legal value list Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Enumerated list Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

EnumeratedType in Modeled class definitions

Cascading Attributes

Dependencies between attributes defined in the Type and Attribute Management utility. See Cascading Attributes Tab.

Valid Range Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

upperLimit, lowerLimit Constraints

A constraint defined when defining the modeled class. See Modeling Business Objects for more information on PropertyConstraints. Same functionality as the range constraint when used with Numeric attributes.

Wildcard Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Regular expression constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

String format constraint

A constraint defined in the Type and Attribute Management utility. SeeAttribute Constraint Rules for more information.

No Duplicate Values constraint

A constraint defined in the Type and Attribute Management utility. SeeAttribute Constraint Rules for more information.

Selection List Style

A property to specify how the legal values should be displayed in the UI. See “Select List Style” in “Configuration Points” section in this topic for more information.

Include Blank Option

A property to specify whether to include a blank option in the legal value list . See “Include Blank Option” in “Configuration Points” section in this topic for more information.

Display a Dropdown list (also configurable as a group of radio buttons) with the set of legal values for the attribute; do not allow the user to type in a value.

For global and local attributes, use:

• Legal value list for non-localized lists

• Enumerated list for localized lists.

For modeled attributes, use:

• EnumeratedType in Modeled class definitions.

• To define a legal value list on an existing modeled attribute without having the need to recompile, use the Legal Value list constraint (localized list) or the Enumerated list constraint(non-localized list) in the Type and Attribute Management utility.

Allow the user to type in a value, but restrict the value to be within a given range.

For modeled attributes, use upper limit, lower limit constraints.

For local and global attributes, use the Range constraint.

Allow the user to type in a value, but define more than one range for validating the value.

Significant figures constraint

This is applicable only to Real Numbers and Real Numbers with Units.

Allow the value of one attribute to define the value of another attribute.

You want to limit the value entered by the user to conform to a given pattern.

Use the wildcard constraint, the regular expression constraint or the string format constraint

You want to require the set of values entered for a single business object to be unique.

Use the No Duplicate Values constraint.

Specify how the legal values should be displayed in the UI

Use the property Selection List Style.

Provide a blank option to clear the current value of the attribute, when using legal value lists.

Use the property Include Blank Option.

Legal value list(s) + Enumerated list(s) + Enumerated type

The list displayed will be an intersection of all the constraints i.e. the list will have entries that are common to all the defined lists.

Example:

Given the following constraints:

1. Enumeration:

COLOR_RED = Red

COLOR_BLUE = Blue

COLOR_GREEN=Green

2. Non-localized legal value list:

COLOR_RED

COLOR_BLUE

3. Non-localized legal value list:

Red

Blue

If the user were to apply 1 and 2, the resulting legal values should be:

COLOR_RED = Red

COLOR_BLUE = Blue

If the user were to apply 1 and 3, the result would be an empty set (no legal values).

When all the legal value lists specified for an attribute are combined, the resulting list will be an intersection of all the lists (i.e. only those entries that are common to all the lists will be added to the resulting list). So it is possible to end up with an empty legal values list when multiple legal value lists have been defined. When the legal value list is empty, the end-user UI displays an input field.

Legal value list + Range constraint

Drop down populated with only those values in the legal value list that satisfy the range constraint. (configurable as a group of radio buttons). No tool-tip message.

Legal value list + Significant figures constraint

Drop down populated with only those values in the legal value list that satisfy the range derived from the significant figures constraint. (configurable as a group of radio buttons). No tool-tip message.

Range constraint + Significant figures constraint

Input field with tool-tip indicating the valid range(s). Validation message will indicate the valid range(s).

The valid range(s) will be the range(s) derived from the intersection of these 2 constraints.

Legal value list + Range constraint + Significant figures constraint

Drop down populated with only those values in the discrete set that satisfy both the range(s) of the “Range constraint” and the range(s) of the “Significant figures” constraint. No tool-tip message.

upperLimit, lowerLimit Constraints

A constraint defined when defining the modeled class. See the information on PropertyConstraint in Modeling Business Objects for more information.

String length Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Character Entry Limit

The property Character Entry Limit can be set on a modeled, global or local attribute. See “Configuration Points” section in this topic for more information.

Restrict input to a certain number of characters on all the UIs in which the attribute will be displayed for editing.

Also apply this restriction during persistence. This applies when you want to create an object programmatically (without a UI) or, when some attributes of an object are not added to the Create UI of an attribute.

For modeled attributes, use upper limit, lower limit constraints.

For global and local attributes, use the String length constraint.

The string length constraint can be used on modeled attributes also to make configurations without requiring Java code compilation.

Limitation: The length of the Name attribute conforms to Windchill UI standards and so cannot be overridden using this constraint.

Restrict input to a certain number of characters on a specific UI only.

Also, do not apply this restriction during persistence.

Use the property Character Entry Limit.

Note: This limit has to be less than the maximum string length.

String Length Threshold For Multiple Line Input

Provided as a property or a preference. See String Length Threshold For Multiple Line Input in Configuration Points section in this topic for more information.

Input Field Type

Provided as a property. See Input Field Type in Configuration Points section in this topic for more information.

Text Input Rows

Provided as a property. See Text Input Rows in Configuration Points section in this topic for more information.

Text Input Columns

Provided as a property. See Text Input Columns in Configuration Points section in this topic for more information.

Customize the height of all input fields automatically based on the string length constraint

Use String Length Threshold For Multiple Line Input

Override the automatic behavior provided by the String Length Threshold For Multiple Line Input for a specific attribute only

Use Input Field Type

Always display a certain type of field(either single line or multi line) for a specific attribute

Use Input Field Type

Specify the actual number of rows visible without scrolling, in a multi-line text input field.

Use Text Input Rows.

Customize the width of the input field

Use Text Input Columns.

Note: For most fields, the width of the field defaults to that specified by Windchill UI standards and the attribute’s String Length Constraint.

Single Value Constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Delimiter for multi-valued attributes.

A preference. See “Delimiter for multi-valued attributes” in “Configuration Points” section in this topic for more information.

No Duplicate Values

A constraint that requires the set of values for a multi-valued attribute to be distinct. Duplicate values are not allowed.

Lower case constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Upper case constraint

A constraint defined in the Type and Attribute Management utility. See Attribute Constraint Rules for more information.

Create Hyperlinks preference

This preference is available in the Attribute Handling category. See “Create Hyperlinks” in “Configuration Points” section in this topic for more information.

Create Hyperlinks property

Available in the Type and Attribute Management utility Attribute Definition. See “Create Hyperlinks” in “Configuration Points” section in this topic for more information.

The value of the property overrides the value of the preference.

Label property

A property defined in the Type and Attribute Management utility. See “Label” in “Configuration Points” section in this topic for more information.

Display Name property

A property defined in the Type and Attribute Management utility Attribute Definition. See the Type and Attribute Management utility help topic Attribute Information Page for more information.

rbInfo files

• componentRB.rbInfo

• tableRB.rbInfo

• com.ptc.core.htmlcomp.jstable.jstableResource

• com.ptc.core.ui.tableRB

• wt.enterprise.enterpriseResource (this is also used as the default)

• wt.identity.identityResource

• wt.templateutil.table.tableResource

• com.ptc.windchill.cadx.ws.wsResource

Use a custom label on one specific attribute panel only

Use the Label property

Use a custom column header for an attribute on a specific table only

If the table is defined using a Java builder class, set the custom label using the setLabel() method when defining the com.ptc.mvc.components.ComponentConfig for the column representing the attribute. See the JavaDoc for more information.

Use the same custom label in all the attribute panels in which this attribute will be displayed

For attributes of TypeManaged objects, use the Display Name property.

Use the same custom column header for an attribute, on all tables in which this attribute will be displayed.

If the attribute has an entry on one of the following rbInfo files, modify the rbInfo file entry

com.ptc.core.htmlcomp.jstable.jstableResource

com.ptc.core.ui.tableRB

wt.enterprise.enterpriseResource (this is also used as the default)

wt.identity.identityResource

wt.templateutil.table.tableResource

com.ptc.windchill.cadx.ws.wsResource

For all other attributes, set the Display Name property of the attribute to the custom label using the Type and Attribute Management utilities Attribute Information Page.

For all other attributes, set the Display Name property of the attribute to the custom label using the Type and Attribute Management utilities attribute information page

Determine the source of the label of an attribute

Enable the logger com.ptc.core.components.labels

Data Utility ID

A property defined in the Type and Attribute Management utility or component builder. See “Data Utility Id” in Configuration Points section in this topic for more information.

Need property

A property defined in the Type and Attribute Management utility. See “ Need“ in Configuration Points section in this topic for more information.

Target Object property

A property defined in the Type and Attribute Management utility. See “Target object” in Configuration Points section in this topic for more information.

Specify the source of data for a composite attribute or a reference attribute

Example

The value of the state attribute actually comes from State.state. The attribute that is defined on the type is State. When defining the component configuration, to indicate that the source of data for this attribute is State.state, set the value of the Need property of the State attribute to State.state.

Specify a different source of data for a specific to the UI only

When defining the component configuration, set the value of the Need property of the attribute.

Use data from multiple attributes and assemble them using custom logic, to form the value to be displayed in the UI.

Wherever possible, define a calculated attribute.

If the required calculation is outside the scope of the current support provided for calculated attributes, use a custom data utility. When defining the component configuration, set the value of the Need property of the attribute to the list of attributes that need to be fetched for calculating the value.

Example:

attributeConfig.setNeed("name, number, creator");

Data Utility ID

A property defined in the Type and Attribute Management utility or component builder. See “Data Utility Id” in Configuration Points section in this topic for more information.

Need property

A property defined in the Type and Attribute Management utility. See “Need” in Configuration Points section in this topic for more information.

Target Object property

A property defined in the Type and Attribute Management utility. See “Target object” in Configuration Points section in this topic for more information.

Use a custom data utility to render an attribute for the scope of a specific UI only and that attribute already has a data utility mapped to it and, the UI is one of the following:

• an Attribute panel defined using the Type and Attribute Management utility or a builder class

• an Table defined using the Type and Attribute Management utility or a builder class

Example:

To render Number using a custom data utility called MyNumberDataUtility

1. Define your custom data utility (MyNumberDataUtility)

2. In an xconf file, map the custom data utility to a custom attribute id(myNumber). For more information see “Map the Data Utility to the Attribute ID” section in this topic .

3. Set the Data Utility Id property of that attribute to myNumber

Use an existing data utility to render an attribute in all the UIs in which the attribute is rendered

In an xconf file, map the custom data utility to a custom attribute id(myNumber)

In a specific UI only, render an attribute using an existing data utility; the existing DU might be already mapped to one or more attributes

To render myNumber using using a custom data utility called MyNumberDataUtility

1. Define your custom data utility (MyNumberDataUtility)

2. In an xconf file, map the custom data utility to a custom attribute id(myNumber)

3. Set the Data Utility Id property of that attribute to myNumber

Rendering the same attribute for multiple objects within the same table

The column ids must be unique, so you need to use Target Object and Data Utility Id properties to accomplish this. For example, a table could have 3 columns that all render the Name attribute, but from 3 different objects:

1. Add all the three attributes to the attribute panel or table definition

2. For the attributes that belong on objects that are not the backing object, set the value of the property Data Utility Id to “name” and the Target Object to the attribute that represents the object

Example:

To display the name attributes of the roleAObject and roleBObject the same way the name attribute of the backing object is displayed, for each of those attributes, set the properties as follows:

• For roleAName

◦ Data Utility Id = name

◦ Target Object = roleAObject

• For roleBName

◦ Data Utility Id = name

◦ Target Object = roleBObject

Specifying different renderers for the same attribute id for different object types

Example:

You need to render the render the state attribute of a Document differently than the state attribute of a Part.

Type-based lookup of data utilities is currently not supported by the infrastructure. If this type of behavior is needed, and if your UI displays objects of the same type, then use the Data Utility Id property to accomplish this. On a UI that displays objects of multiple types, like the Folders page, you may use a custom data utility and do the type-based checking within that custom data utility.

Always use the server generated value and, do not allow the user to enter a value.

<Value algorithm="com.ptc.core.rule.server.impl.GetImmutableConstraint"/><Value algorithm="com.ptc.core.rule.server.impl.GetServerAssignedConstraint"/>

Always use the pre- generated value configured in the Object Initialization Rules and, display this value in the UI and, do not allow the user to modify this value.

<Value algorithm="com.ptc.core.rule.server.impl.GetImmutableConstraint"/><Value algorithm="com.ptc.core.rule.server.impl.GetServerPreGeneratedValue"/>

Pre-generated value with no override

Use the pre- generated value defined in the Object Initialization Rules and, display this value in the UI and, want to allow the user to modify this value.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerPreGeneratedValue"/>

Pre-generated value with override.

Always require the user to provide the value

If there are no other OIR constraints defined for Number, this needs an empty constraints list to work as expected.

<AttrConstraint id="number"

algorithm="com.ptc.core.rule.server.impl.GatherAttributeConstraints"/>

Allow the user to enter a value and, if a value is not provided by the user, auto-generate a value on the server.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerAssignedConstraint"/>

If the above configurations do not yield the results listed above, check the following values of these other configurations which also affect the editability of Number in a Create or Edit UI:

• The changeable Property Constraint for a Modeled attribute. See Modeling Business Objects for more information.

• The Type and Attribute Management utility Visibility settings. See Visibility Tab for more information.

• The Type and Attribute Management utility Visibility settings. See the “Visibility Tab” online help topic for more information.

Always use the ‘server assigned’ folder and, do not want to allow the user to specify a folder.

<Value algorithm="com.ptc.core.rule.server.impl.GetImmutableConstraint"/><Value algorithm="com.ptc.core.rule.server.impl.GetServerAssignedConstraint"/>

Always use the pre-generated folder defined using Object Initialization Rules and, display this value in the UI and, do not want to allow the user to modify this value.

<Value algorithm="com.ptc.core.rule.server.impl.GetImmutableConstraint"/><Value algorithm="com.ptc.core.rule.server.impl.GetServerPreGeneratedValue"/>

Allow the user to select a folder manually, and to display the launch context folder as the default value.

If there are no other OIR constraints defined for Location, this needs an empty constraints list to work as expected.

<AttrConstraint id="folder.id" algorithm="com.ptc.core.rule.server.impl.GatherAttributeConstraints"/>

The field is populated with the folder from the launch context.

Provide the following options to the user

• Use the pre-generated folder defined using Object Initialization Rules or,

• Select a folder manually; display the launch context folder as the default value for this.

• Pre-select the launch context folder as the default option.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerPreGeneratedValue"/>

The value of Autoselect Folder is the pre-generated value defined using Object Initialization rules.

Provide the following options to the user

• Use the pre-generated folder defined in Object Initialization Rules or,

• Select a folder manually. display the launch context folder as the default value for this

• Pre-select the pre-generated folder as the default option.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerPreGeneratedValue"/><Value algorithm="com.ptc.core.rule.server.impl.GetRendererConstraint"><Arg>SelectGeneratedFolderByDefault</Arg></Value>

The value of Autoselect Folder is the pre-generated value defined in Object Initialization rules.

Provide the following options to the user

• Use the ‘server assigned’ folder or,

• Select a folder manually; display the launch context folder as the default value for this

• Pre-select the launch context folder as the default option.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerAssignedConstraint"/>

Provide the following options to the user

• Use the ‘server assigned’ folder or,

• Select a folder manually; display the launch context folder as the default value for this.

• Pre-select the server-assigned folder as the default option.

<Value algorithm="com.ptc.core.rule.server.impl.GetServerAssignedConstraint"/><Value algorithm="com.ptc.core.rule.server.impl.GetRendererConstraint"><Arg>SelectGeneratedFolderByDefault</Arg></Value>

This configuration is applied only when the attribute is displayed on a table or on a component whose com.ptc.core.ui.resources.ComponentType is SIMPLE.

Avoid making database calls in getDataValue(), because when dealing with tables, the method is called once for every cell in the column. If they must be done, try to do work in setModelData() which is called once per column and cache the results so the database does not have to be called more often than necessary.

com.ptc.core.components.forms.AttributePropertyProcessorHelper

Java class

Provides helper APIs to assist in authoring the custom data utility to retain user-entered values. For more information, see Windchill Javadoc.

CarambolaAttributeBooleanDataUtility

Boolean

CarambolaAttributeDateDataUtility

Date and Time

CarambolaAttributeHyperlinkDataUtility

URL

CarambolaAttributeRealNumberDataUtility

Real Number

CarambolaAttributeRealNumberWithUnitsDataUtility

Real Number with units

CarambolaAttributeStringDataUtility

String

CustomCarambolaAttributeStringDataUtility

String where column name is non-standard

CarambolaAttributeStringMultiValueDataUtility

String that supports multiple values

Default Value Display Mode

All data types

Configures how to populate the default value, if any, in the input field for the attribute.

Defaults to “Pre-populate”.

Possible values:

• None – the default value will not be used to populate the input field

• Pre-Populate – the default value, if one is set, will be set in the input field

• Button – A button will be displayed after the input field, the user can click the button to add the default value to the input field.

Available as a Site level preference in the Attribute Handling category.

If not specified, the value of the preference “Default Value Display Mode” will be used.

If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.

OR

setDefaultValueDisplayMode()

Selection List UI Style

All attributes that have a Legal Value List constraint or an Enumerated Value List constraint defined.

Specifies whether the legal values (selection list) for the attribute should be displayed as a drop-down list or as a set of radio-buttons, when the attribute is presented for data entry.

Defaults to “Drop Down List”.

Possible values:

• Drop Down List – the values will be rendered in a drop down list, where the user can select one option

• Radio Buttons – the values will be rendered as a set of radio buttons, where the user can select one option

Available as a Site level preference.

Note: Applies to all attributes, except Boolean attributes. AT this level, the style for Boolean attributes is controlled by the preference Boolean Style.

If not specified, the value of the preference “Selection List Style” will be used.

If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.

OR

setSelectionListStyle()

Boolean Style

Boolean

Controls how Boolean attributes are displayed for input, either as radio buttons or as a dropdown list.

Defaults to “Radio Buttons”.

Possible values:

• Drop Down List – the values will be rendered in a drop down list, where the user can select one option

• Radio Buttons – the values will be rendered as a set of radio buttons, where the user can select one option

Available as a Site level preference.

Use the property “Selection List Style” to override the value of this preference for a specific attribute.

If not specified, the value of the preference “Boolean Style” will be used.

If not specified, the value of the property “Selection List Style” from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.

OR

setSelectionListStyle()

String Length Threshhold For Multiline Input

String

Specifies the threshold for rendering a multi-line input field for a String attribute. The value can be any positive number. If the maximum length of the attribute in characters exceeds this value, a multiline input field will be displayed for data entry.

Defaults to 60.

Available as a Site level preference.

If not specified, the value of the preference “String Length Threshold for Multiline Input” will be used.

If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.

setStringLengthThreshholdForMultilineInput()

Input Field Type

String

Specifies whether the input field for the attribute should be single-line or multi-line. This directive will override that of the stringLengthThresholdForMultilineInput.

Possible values:

• Single Line – a textbox will be rendered for this attribute

• Multiple Lines – a text area will be rendered for this attribute

Not available at this level

If not specified, this property is not assigned a default value.

If not specified, the value of this property from the Attribute Definition will be used, if one has been specified.

OR

setInputFieldType()

Date Input Field Type

Date

Specifies whether the input field for a Timestamp attribute is of type date-only or date & time, so that the UI components can be created accordingly.

The default is “Date Only”.

Possible values:

• Date Only – Allow the user to only set the date portion.

• Date and Time – Allow the user to set both the date and time portion.

Not available at this level.

If not specified, the default will be used.

If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.

OR

setDateInputFieldType()

Date Display Format

Date

A date format string (i.e. yyyy-mm-dd) to use when displaying the value of this attribute in View mode. This does not affect the format used to set the value in input mode.

Please refer to the Java class java.text.SimpleDateFormat for the full set of valid characters.

If not set, one of the following formats will be used from the rbInfo file componentRB:

• STANDARD_DATE_DISPLAY_FORMAT – if the value of the property “Date Input Field Type” is set to “Date Only”, this format will be used.

• STANDARD_DATE_TIME_ZONE_DISPLAY_FORMAT – if the value of the property “Date Input Field Type” is not set or is set to “Date and Time”, this format will be used.

Not available at this level.

If not specified, the default will be used.

If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.

OR

setDateDisplayFormat()

Local Time Zone

Date

Specifies the time zone to use for Date attributes that display both the Date and Time portions (i.e. yyyy-MM-dd hh:mm zzz). This is only used in view mode; it is not used for input mode.

Available as a User level preference

Not available at this level.

Not available at this level.

Measurement system

Real Number with Units

Specifies the measurement system to use for Real Numbers with Units.

Available as a User level preference

Not available at this level.

Not available at this level.

Create Hyperlinks

(in 9.x this was called Ignore URL values in strings)

String

Specifies whether URL style text embedded in the value of a String attribute should be displayed as a hyperlink in the view mode (example: http://www.ptc.com).

Defaults to ‘true’.

Available as a Site level preference

Note: When upgrading from 9.x to 10.0, if this property were customized using the file AllClient.xml, manual migration is needed.

If not specified, the value of the preference “Create Hyperlinks” will be used.

Not available at this level.

Percent

Numeric

Specifies if a numeric value is to be displayed as a percentage or not. This property is only used in view mode. When specified, the notation used will be locale-specific.

Defaults to false.

Not available at this level.

If not specified, the default will be used.

If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.

OR

setPercent()

Currency

Numeric

Specifies if a numeric value is to be displayed as currency value or not. This property is only used in view mode. When specified, the notation used will be locale-specific.

Defaults to false.

Not available at this level.

If not specified, the default will be used.

If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.

OR

setCurrency()

Input Required

All

Used to mark attributes as ‘Required fields’ even though they may not have a ‘Required’ constraint. This property is used purely for the UI rendering.

Unlike the “Required constraint”, this will not trigger any server-side validation.

Note: If an attribute that has a ‘Required constraint’ is marked as “not required” using this property, a server-side exception will be thrown, unless the server-side code takes care of setting the value for the attribute by some other means.

The most common usage of this property is to force the user to provide a value for an attribute that does not have a “required constraint” defined on it.

Not available at this level.

Not available

If not specified, the default will be used.

OR

setInputRequired()

Is Info Page Link

‘Name’,

‘Number’ and Principal attributes only

Specifies if the attribute is to be displayed as a hyperlink to the Information Page. In the case of Principal attributes, this will be displayed as a link to the principal’s info page.

When not specified, the following defaults are used:

• ‘true’ for Number and Container name

• ‘false’ for all other attributes

Not available at this level.

Not available at this level.

If not specified, the default will be used.

OR

setInfoPageLink()

Delimiter for multivalued attributes

Specifies the character(s) to use as a separator when displaying the values of an attribute that contain multiple values. This applies only to Global Attributes since they are the only type of attributes that can have multiple values assigned to an attribute. Defaults to a comma followed by a space.

Available as a Site level preference

Not available at this level.

Not available

Text Input Columns

An integer value that specifies the width to render the Text Area in create or edit mode. This only applies to String attributes and is only used when the property “Input Field Type” is set to “Multiple Lines”

Not available at this level.

Not available at this level.

If not specified, the width defaults to the value specified by Windchill UI standards and the attribute’s String Length Constraint.

Text Input Rows

An integer value that specifies the height to render the Text Area in create or edit mode. This only applies to String attributes and is only used when a multi-line input field is required based on the properties String Length Threshhold For Multiline Input and Input Field Type.

Not available at this level.

Not available at this level.

If not specified, the number of rows is based on the String Length Constraint and the width of the column. The max number of rows is limited to 3. A scroll bar is added when the input exceeds 3 rows.

OR

setTextInputRows()

Include Blank Option

Specifies whether a blank option should be added as the first entry of a dropdown list that displays the legal value list of an attribute.

When the legal values are displayed as a set of radio-buttons, a button with the label “Undefined” will be added as the first button in the list.

Default to true.

Not available at this level.

Not available at this level.

If not specified, the value defaults to true.

OR

setIncludeBlankOption()

isRenderAllStates

Lifecycle state attributes only

Specifies whether to render all the lifecycle states instead of just the current state.

NOTE: This attribute is applicable to components with component type of SIMPLE or TABLE only.

Default to false.

Not available at this level.

Not available at this level.

If not specified, the value defaults to false.

OR

setRenderAllStates()

Distinguish WIP Versions

Revision attribute only

Specifies whether to distinguish between the checked-out original and the working copy.

Not available at this level.

Not available at this level.

If not specified, the value defaults to false.

OR

setDistinguishWIPVersions()

Character Entry Limit

Species the maximum number of characters that can be entered in the UI for a String attribute.

Not available at this level.

Not available at this level.

setCharacterEntryLimit()

Data Utility ID

The id to use for data utility lookup. When unspecified, the descriptor id is used for the lookup.

Not available at this level.

Not available at this level.

setDataUtilityId()

Need

The logical name of an object attribute needed to create the display value for a column cell.

Used by data utilities for retrieving the cell value when the property/column id is not an attribute name defined by introspection or logical attributes. Use a comma-separated list if multiple attributes are needed.

Not available at this level.

Not available at this level.

setNeed()

Target Object

The target object to use for this column when it is processed by the Windchill Client Architecture infrastructure. By configuring the targetObject property, the developer tells the infrastructure to use an alternate row object that is derived from the backing row object returned by the underlying api.

Not available at this level.

Not available at this level.

ComponentConfig.setTargetObject()

Label

Used to set the label of an attribute

Not available at this level.

Use the display name on the attribute definition.

setLabel()

Mode

The mode in which the attribute will be displayed. There are 3 modes available: Create, Edit and View

Not available at this level.

Not available at this level.

setMode()