Getting Started with Custom Attributes

Custom attributes are configurable fields that allow you to capture data specific to your organization beyond TeamDynamix's standard fields. They can be added to forms, included in reports, and used to filter and organize information across various applications.

Custom attributes are available in the following areas:

In this article, we'll cover:

• Where to Find This
• Available Custom Attribute Options
• Configuring Custom Attributes
  • Creating Custom Attributes
  • Configuring Attribute Choices
• Deactivating Custom Attributes
• Example Custom Attributes

Where to Find This

Custom attributes are created and managed in TDAdmin or within application admin interfaces. The specific location depends on the type of custom attribute:

Available Custom Attribute Options

TeamDynamix supports a variety of custom attribute types for different data collection scenarios. Checkbox lists, dropdowns, radio button lists, and multiselects allow admins to provide valid choices. Choices cannot be added to the attribute until after it has initially been saved.

Attribute Types

Currently, the following attribute types are supported for the ticketing application:

Attribute Settings

Each attribute type offers different configuration options tailored to its purpose. The following settings appear when configuring most custom attributes. Specific options vary by attribute type and application.

Core Fields (Available for All Attributes)

• Attribute Name – The name of the attribute as it will display in component forms and attribute configuration pages.
• Header Text – The text that will appear in the header if this attribute is included in a report for the component.
• Attribute Type (only available on creation) – The type of data that the custom attribute stores. See the Related Articles section for further details about supported attribute types.
• Sort Order – The order in which the attribute will appear relative to other attributes on the component form. Each Attribute Section is ordered by the Sort Order, and then alphabetically.
• Description or Help – Text that explains the purpose of the attribute in terms of the data it is supposed to represent.

Options

Different combinations of these options are available depending on the attribute type:

• Required - Makes the field mandatory when it appears on forms
• Active - Determines if the attribute is available for use. Only active attributes appear on forms.
• Updatable (Editable on update forms) - Controls whether the attribute appears on update forms so its value can be changed
• Client Visible - Controls visibility in Client Portal
• Protected - Restricts visibility to authorized users who must enter a PIN to view the value. Protected attributes cannot be deleted.

Special Settings

Some attributes have additional configuration options:

• Person Attributes include Person Filtering options:
  • Person Type(s)
  • Account/Department Membership
  • Group Membership
  • Employee Status
• Account Attributes can be organized into:
  • Section - Groups related attributes together on forms (select from configured Account Attribute Sections)
• Project Attributes support:
  • Section - Groups related attributes together on forms (select from configured Project Attribute Sections)
  • Associated Type(s) - Links the attribute to specific Project Types. When configured, the attribute only appears for projects of those types.
• Some Text Area, and Text Box Attributes can have a Default Value - A value pre-populated in the field when the attribute appears on forms. See the **Default Values box above for details.

Configuring Custom Attributes

Creating Custom Attributes

Choose your Attribute Type carefully during creation, as this determines how data will be captured and cannot be changed later. If you need a different type, create a new attribute with the desired configuration.

Attributes that use choices (dropdown, multiselect, radio buttons, checkbox list) follow a two-step process: first, create the attribute, then configure its choices on the Choices tab. This allows you to set up the attribute structure before defining specific options.

To create custom attributes:

1. Navigate to the appropriate Attributes configuration page (see "Where to Find This" above)
2. Click the +New button
3. In the New Attribute window:
   • Enter the Attribute Name
   • Select the Attribute Type (this cannot be changed later)
   • Configure Sort Order, Description/Help, and other available fields
   • Set the desired Options (Required, Active, etc.)
   • Configure application-specific settings if available
4. Click Save
5. If the attribute type requires choices, configure them on the Choices tab

For detailed instructions specific to each application, see the related articles.

Configuring Attribute Choices

For attribute types that use predefined options (checkbox list, dropdown, multiselect, radio button list, Yes/No dropdown), you'll need to configure the available choices.

To add a new choice:

1. After creating the attribute, click the Choices tab
2. Click + Add Choices
3. Enter a choice Name in the text box, or select Copy Configuration From to copy choices from a similar attribute
4. Click Save

To manage existing choices:

On the Choices tab of the attribute, click the option for the choice you want to modify as follows:

• Active – Controls whether the choice appears when the attribute is used. Only active choices display on forms. Click the Yes/No text to toggle the setting. Deactivating a choice does not affect existing data.
• Action:
  • Edit - Click to edit the Order and Name.
  • Delete - Remove the choice from the attribute. Note that choices cannot be deleted from protected custom attributes, so the Delete option will not appear.

Project and Account attribute types support grouping related attributes into sections for better form organization. You can select a section when creating or editing an attribute. Attributes without an assigned section will appear in the General section of forms.

• Account Attribute Sections can be created at:  TDAdmin > Organization Settings > Account Attribute Sections
• Project Attribute Sections can be created at: TDAdmin > Projects > Project Attribute Sections

Deactivating Custom Attributes

Note that these custom attributes cannot be deleted, so the only option is to deactivate:

• Protected custom attributes (PCAs)
• Attributes currently in use on forms

To deactivate a custom attribute:

1. Open the Attributes page for the attribute type
2. Click the attribute Name link.
3. In the attribute window, scroll down to the Options, and uncheck the Active option.
4. Click Save

Example Custom Attributes