Attributes and Attribute Groups

The Attribute Setup Workbench enables you to create set of operational user defined attributes that display at predefined locations in the application pages. Once you have decided upon the attributes you require, and the levels at which you require them, you can group sets of attributes, that need to display on the same set of levels, into attribute groups in a meaningful way based on your requirements. All operations on UDAs happen at the Attribute Group level.

In CLM, attributes are supported at the following levels:

An attribute group can be single-row or multi-row. Single row attribute groups displays a text field with a value. Multi-row attribute groups enable you to associate multiple sets of attribute values with the same object instance. For multi-row attribute groups, you can define which attributes or combination of attributes will maintain uniqueness of records in cases where the attribute group is displayed as multi-row.

You can set up as many attribute groups as necessary, with the following limitations on the number of attributes within each attribute group:

Attributes are defined by their names and values, and are saved within attribute groups. Attributes cannot exist outside an attribute group. You can create user-defined attributes that more specifically identify their characteristics and specifications, and capture information. At this point, decide on the allowable set of values for each attribute and how you would like to render the attribute. For example, you might want to display one attribute as a text field and another as a check box, and so on.

If you want to configure the behavior of UDAs beyond simple data capture, then define actions on your attribute group. You can define UDAs to possess certain validation logic (for example, value sets) and indexes. You can control where your attribute groups render based on the usages you define on the attribute template. There are however, predefined locations on the application pages where you can display UDAs.

Creating Attribute Groups

You create attribute groups to combine attributes in a logical, functional manner.

To create attribute groups:

  1. On the Attribute Setup Workbench page, click the Attribute Groups tab. Click Create.

  2. On the Create Attribute Group page that displays, enter an Internal Name for the attribute group.

  3. Enter a Display Name. This is the name of the attribute group as it will be displayed in the user interface.

  4. Optionally, enter the Description of the attribute group.

  5. Select the Behavior of the attribute group:

  6. Click Maintain Unique Key to view, update , and delete unique key attributes. If the attribute group is multi-row, the Maintain Unique Key check box determines whether or not the attribute is part of the key that uniquely identifies a row. A unique key is any set of attributes whose values can be used to uniquely identify a row within the attribute group. You can define the unique key on the attribute group Detail page. You can add/edit the unique key as long as doing so does not destroy the uniqueness (creating duplicates) of existing records. You can specify that each attribute is part of a unique key when creating the attribute, or--more conveniently--you can specify all unique key attributes in the group via the attribute group Detail page.

    Note: This is applicable for multi row attribute groups only.

  7. Enter a value in the Number of columns shown in the table field. This field determines the number of columns that display in the attribute group page. The default value is 5.

  8. Enter a value in the Number of rows shown in the table field. This field only appears for multi-row attribute groups and determines the number of rows that display in the attribute group page before the Next and Previous links display. The default value is 5.

    This field only appears for multi-row attribute groups and determines the number of rows that display in the attribute group page

  9. Select the Business Entities to which you want to apply the attribute group.

    Note: When you enable an attribute group at multiple levels, the attribute data will flow as a target document is auto-created from a source document.

    You can select all or choose from:

  10. Click Apply and Add Attributes to add user-defined attributes to your attribute group.

  11. On the Create Attribute page that displays, enter the internal name of the attribute. This the name by which the attribute is tracked internally.

  12. Enter the Display Name. This is the name of the attribute as it appears within the user interface.

  13. Enter the Sequence number for the attribute. The sequence determines the order in which the attribute is displayed on the page, and also determines the order in which the attribute is processed.

  14. Enter a Tip for the attribute. This is the description of the attribute; this description also appears as tip text on pages that have attributes that can be updated.

  15. Select a value for the Data Type. The data type you select determines the values that are available in the column and value set. An attribute's data type must match the data type specified for that attribute's value set. The list of values for a value set only displays value sets whose data type matches the data type of the attribute.

    Note: Selecting a data type always clears the column and value set. For example, say you selected the Number data type. Then you select your column and value set--remember that your column and value set choices are determined by the data type you chose. Then you decide to change the data type from Number to Date. Notice that after you change the data type, your column and value set are cleared; you need to select new ones based on your new data type. Additionally, the data type determines the values that are available in the Display As field. You cannot change the data type once an attribute is created.

    Note: The maximum number of characters for a character type attribute and translatable text fields is 2000 characters. Number type fields have a maximum size and precision of 22.5 (22 digits to the left of the decimal and 5 digits to the right).

  16. Select a value for the Column to select where the attribute is stored in the database table. The column list of values only returns columns with the data type you specified in Data Type. The list of values also indicates whether or not the column is indexed.

  17. The Enabled check box determines whether or not the attribute is enabled (and available for use) or disabled (and not available for use). By default, the Enabled check box is selected. If the attribute is enabled, specify whether or not the attribute is optional or required. If required, the user cannot save data for an object using the attribute group without entering a value for that attribute. You can always disable attributes. However, you cannot delete attributes after an attribute group has been associated with an Attribute Template or a CLM document.

  18. Select the Read Only check box to specify whether or not the user can update the attribute value.

  19. Select the Required check box to specify whether or not the user must enter an attribute value.

  20. Select a value in the Display As list to determine how the attribute appears within the user interface. The available values for Display As are determined by the data type selected.

    Note that Personalization is not supported. If you wish to display / hide an attribute, select Hidden from the Display As dropdown.

  21. Select a Value Set that will serve as a set of constraints for an attribute.

  22. Enter a Default Value for the attribute. If you've selected a value set, the value set's constraints apply to the default value. This value defaults upon object creation.

    Note: In an attribute group with at least one required attribute, no default values are applied for any attributes when a required attribute does not have an assigned default value.

  23. Click Apply and Add Another to save and create another attribute.

  24. Once done, click Apply.

Copying Attribute Groups

When you copy an attribute group, all of the attribute group's field values and attributes default to the new attribute group. You can override all defaulted values and attributes except for the attribute group Behavior field.

To copy attribute groups:

  1. On the Attribute Setup Workbench: Attribute Groups page, search for the attribute group you want to duplicate and click the Copy icon adjacent to it.

  2. On the Create Attribute Group page that displays, the field values from the original attribute group appear. You must enter a new Internal name and Display Name for the copied attribute group. You have the option to change all field values except for the Behavior field; you cannot change the original Single-Row, Multi-Row in the Behavior field.

  3. Click Apply. The Attribute Details page displays. The attributes from the original attribute group are attached to the newly copied attribute group. From this page, you can edit or delete the existing attributes and add new attributes.