data-service
latest
false
  • Getting started
    • Introduction
    • Exploring the user interface
    • Regions and instances
  • Licensing
  • Setup and configuration
  • Using the service
  • Reference
    • Studio activities
    • API access
  • Examples and tutorials
UiPath logo, featuring letters U and I in white

Data Fabric user guide

Last updated Jun 10, 2025

Customizing an entity

Introduction

Data Fabric contains System built-in fields. When you create a new entity a set of default fields is automatically created still you can customize the entities you defined by adding specific fields.



Field types

You can create the fields of the following field types.

  • Text : this field can be used to store a small amount of text.
  • Number : this field can be used to store a number value. Number values can be positive or negative. You must specify the number of decimal places that you want to use.
  • Yes/No : this field is used to choose between a Yes or No value.
  • Date-Time : this field is used to store a value that contains a date and time. A date picker can be used to select a date and time.
  • Relationship : this field is used to create a relation between two entities.
  • Choice Set : this field is used to store a list of enumerated values from which one or more values can be selected.
  • File : this field is used to store a file.

  • Auto-number: this field is used to automatically increase record indexes.

  • Multi-line Text: this field can be used to store a larger amount of text on multiple rows.

Note: Each type of field requires different details that must be specified. For more information, refer to Entity Field Types .

Creating fields

To add fields to your entity data, take the following steps:

  1. In the Entities list, select the entity for which you want to add a field.
  2. Select Manage Entity.
  3. In the source section, either Local fields or the chosen external system, select Add field.
    • If you select Add field in the Local field section, follow steps 4 to 10.


    • If you select Add field in the chosen external system, check the fields you want to add to your entity from the provided list. Select Save.


  4. Enter a Display Name for the new field. The Display Name is the name displayed when you import the entity in Studio. This field can be modified after the entity is created.
  5. Enter a Name for the new field. The Name is can be alpha-numeric, but it must start with a letter. It must have between 3 and 30 characters.
    Note:

    The Name field is automatically populated with the same value provided for the Display Name. You can only change its value during the entity creation process. Once the entity is created, the Name field cannot be edited.

  6. Select the field Type using the dropdown list.
  7. To enforce users to provide a value for the field, select the Required checkbox.
  8. To enforce unique values for the field records, select the Unique values only checkbox.
    Important:

    The option is available for Text and Number field types.

    When needed, use the maximum decimal places configured for numbers. Otherwise, Data Fabric rounds up the number to the maximum value of decimals, causing uniqueness failure. For example, if you set a precision of three decimals and input values such as 3.015 and 3.0148, the latter value is rounded up to 3.015, leading to uniqueness failures.

    The option is case insensitive, meaning "Unique Value" and "unique VALUE" are identified as duplicates.

  9. Select More details to configure optional field record properties, such as:
    OptionDescription
    Maximum Length

    For Text fields, set the maximum number of characters a user can provide.

    By default, up to 200 characters are allowed.

    Maximum Value

    For Number fields, set the maximum value a user can provide.

    Default maximum value is 1,000,000,000,000.

    Minimum Value

    For Number fields, set the minimum value a user can provide.

    Default maximum value is -1,000,000,000,000.

    Decimal Places

    For Number fields, set how many decimal digits a user can provide.

    Default value is 2, which allows numbers with two decimal digits, such as 23,45.

    Default Value

    Set a default value in case users do not provide data.

    Description

    Add a description for the field.

    Role based field access

    Select this option to restrict data access by granting explicit permissions.

  10. Select Proceed.
    The new field is displayed in the Local fields list.

Updating the fields

To update the fields you created, take the following steps:

Note:
  • You cannot update system built-in fields.
  • You cannot change the Name and the Type of customized fields.
  1. In the Overview tab, select Manage Entity, or select the Edit icon corresponding to the field you want to update.
  2. Apply your field updates in the Local fields section or the chosen external system section.
    Note:

    If the field was created with the Unique values only option on, you can turn it off, allowing duplicates once again. Be aware that clearing the Unique values only checkbox refrains you from selecting it again later.

  3. Select Save.

Deleting fields

To delete fields that you have created, take the following steps:

Note: You cannot delete system built-in fields.
  1. In the Overview tab, select Manage Entity, or select the More options menu corresponding to the field you want to delete, and then select Delete.
  2. If you select Manage Entity, then select the Delete icon the Local fields section, or the chosen external system section corresponding to the field you want to delete.
  3. Select Save.

Enabling or disabling role-based field access

Role based field access (RBAC) can be used to restrict data access. It is possible to enable Role based field access for custom fields only, it is not available for system built-in fields.

After the Role based field access option is enabled for a field, the roles need to be updated to grant explicit permissions for users to access the field. Refer to Manage access for more information.

Note: Standard roles will no longer have access to data in fields that are enabled for Role based field access. Users who need access to this data will need to be assigned a Custom role that grants permissions to access the data in the field.
  1. In the Overview tab, select Manage Entity, or select the More options menu corresponding to the field you want to enable or disable RBAC, the select Enable Role based field access or select Disable Role based field access.
  2. If you select Manage Entity, then use the RBAC toggle in the Local fields section, corresponding to the field for which you want to enable or disable RBAC.


  3. Select Save.
Note: The RBAC option is only available for local fields.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2025 UiPath. All rights reserved.