test-suite
latest
false
UiPath logo, featuring letters U and I in white
Test Suite User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 20, 2024

Custom fields

Define project-specific custom attributes and assign them to your requirements, test cases, and test sets, to further categorize or prioritize them.

Custom fields can have the following data types:
  • Text: Use custom fields of type Text in your testing projects when you need to capture unique or detailed information that doesn't have predefined values.
  • Label: Use custom fields of type Label when you want to categorize test objects using a predefined list of values for consistency across your project.


Supported object types

You can assign custom fields to the following object types in your project:

  • Requirements
  • Test Cases
  • Test Sets

You can assign all data types of custom fields (Text and Label) to multiple object types simultaneously.

Custom fields conditions

  • Only Administrators can create and configure custom fields.
  • Custom fields are project-specific and apply only to the object types for which they have been defined.
  • Custom field defined for objects synchronized from 3rd party applications are not added to Test Manager. For example, if you have synchronized a Jira requirement for which you had defined a custom field, you will not see an entry in the Details tab of your object, in Test Manager.
  • Custom field names must be unique and are limited to 20 characters.
  • Custom fields are applied to existing and newly created objects.
  • Deleted custom fields are still applied to your existing objects. The value is set to free-form text and it does not retain any previously defined value. Deleting the value flags the custom field with an asterisk symbol.

Creating custom fields

  1. Log in to Test Manager and open your project.
  2. Navigate to Project Settings and then Custom Field Definitions.
  3. Select Create and configure the following settings:
    • Name: Enter a name for your custom field.
    • Description (Optional): Add a description for reference.
    • Object Type: Select one or multiple object types.
    • Data type: Choose whether to create a Text or Label type for your custom field.

      Depending on the type of custom field you choose, the fields where you can input potential values vary:

      • For custom fields of type Text, input in Value Hints the data that the custom field could take.
      • For custom fields of type Label, list the potential values in the Possible values section.
      To add values, type and press Enter. For example, you can input numerical values such as: 1, 2, 3, if you assess priority.
    • Default Value: Enter a value that is going to be set as default for your object. For example: Medium, as part of a Low to High scale.
  4. Select Save to confirm.

    You can view custom fields applied to your objects in the Details tab of each object.



Working with custom fields

To understand how custom fields can help you, consider a scenario in which you want to assess the risk type, and define a custom field to support your decision. Now, you can identify and label a specific object based on the risk type.

SAP Change Impact Mining labels

SAP Change Impact Mining labels are applied to test cases automatically when you run an SAP Change Impact Mining execution template. Labels such as transaction information can later be viewed in Labels section of a test case.

For more information on SAP Change Impact Mining, see SAP Testing Project.

Custom fields actions

Check out the following sections to learn how you can manage your custom fields.

Editing custom fields

Any changes that you bring to the definition of a custom field don't affect existing assignments. Specifically, when you change the definition, the field name and values, which are already set on objects, remain unchanged.

To change the definition of a custom field:

  1. Open your project in Test Manager.
  2. Navigate to Project Settings and then to Custom field definitions.
  3. Select More Options for a custom field, and then Edit.
    Note:
    • You can't select a custom field to support an object type if another custom field with the same name already supports that type. For instance, if you have a custom field named Priority, which can be assigned to Requirements and Test cases, then a custom field with the same name can only be assigned to the remaining object type, which is Test sets.
    • For custom fields of type Label, you can only add or remove possible values, but not rename the existent ones.
  4. Change the configuration and select Save to confirm.

Deleting custom field definitions

If you delete a custom field definition in use within your testing project, the custom field values remain assigned to the respective objects. You have the option to remove some values or delete the custom field completely by removing all values.

To delete one or multiple custom fields:

  1. Open your project in Test Manager.
  2. Navigate to Project Settings and then to Custom field definitions.
  3. Select one or more custom fields.
  4. Select Delete.

Changing the default value

To change the default value of a custom field within an object:

  1. Open your project in Test Manager.
  2. Open an object (requirement, test case, test set) for which you have defined custom fields.
  3. Go to Details.
  4. Select the value within a custom field and choose a different one from the dropdown list.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2024 UiPath. All rights reserved.