Change a Custom Entity

To change the configuration for a custom entity, do the procedure in this topic.

Figure: Entity Details screen

Entity Details screen

Video: Build Your First Custom Entity

Prerequisites

How to Start

  1. On the Entities screen, click an entity.

    Entities screen
  2. Click the Details tab.

    Click Details tab
  3. On the Details tab, click Edit Edit icon.

Procedure

  1. Change these details for your custom entity as necessary.
    Field Name Definition

    Display Name

    Function:
    Specifies the name that shows for the custom entity in AgilePoint NX.
    Accepted Values:
    One line of text that can have spaces.
    Default Value:
    None
    Example:
    Refer to:

    Plural Name

    Function:
    Specifies the name that shows for the custom entity when there is more than one. In other words, this is the plural version of the entity name.
    Accepted Values:
    One line of text that can have spaces.
    Default Value:
    None
    Example:
    If entity name is Country, you may want to use the plural name Countries.

    Also refer to:

    Description

    Function:
    Specifies an optional text description for your custom entity.
    Accepted Values:
    More than one line of text.
    Default Value:
    None
    Example:
    Refer to:

    Category

    Function:
    Specifies a category for your custom entity.
    Accepted Values:
    A category from the list.
    Default Value:
    None
    Example:
    Refer to:

    Owner

    Function:
    Specifies the name of the user to be an owner of your custom entity.
    Accepted Values:
    A user name from the list.
    Default Value:
    None
    Limitations:

    This field is available in these releases:

    Publish Status

    Function:
    Specifies whether an entity is ready to use.
    Accepted Values:
    • On - An entity is ready to use.
    • Off - An entity is in draft.
    Default Value:
    Off
    Example:
    Refer to:

    Record Limit

    Function:
    Specifies the maximum number of records to get from an entity.
    Accepted Values:
    A positive integer up to 1000000.
    Default Value:
    1000000
    Example:
    Refer to:

    Active

    Function:
    Specifies whether an entity can be used by an app.
    Accepted Values:
    • On - The entity can be used in apps.
    • Off - The entity can be viewed or changed in Data Entities, but it does not show in the App Builder.
    Default Value:
    On
    Example:
    Refer to:

    Use The Default Event Logging For AgilePoint NX Apps / Create Detailed Audit Logs For This Entity

    Function:
    Specifies the audit level to track and store events that occur for the custom entity.
    Accepted Values:
    • On - Tracks and stores all events that occur on the entity.
    • Off - Does not store events for the entity except normal error logging for your app.
    Default Value:
    Off
    Example:
    Refer to:

    Allow Entity Model Import

    Function:
    Lets which users can import entity model to AgilePoint NX Data Entities.
    Accepted Values:
    • On - All users who have access can import an entity model.
    • Off - Only Administrator and Entity Owners can import an entity model.
    Default Value:
    On
    Example:
    Refer to:
    Limitations:
    By default, this field is enabled in these releases:

    Allow Entity Model Export

    Function:
    Specifies which users can export an entity model.
    Accepted Values:
    • On - All users who have access can export the entity model.
    • Off - Only Administrator and Entity Owners can export the entity model.
    Default Value:
    On
    Example:
    Refer to:
    Limitations:
    By default, this field is enabled in these releases:

    Allow Record Export

    Function:
    Specifies which users can export the records from an entity.
    Accepted Values:
    Default Value:
    On
    Example:
    Refer to:
    Limitations:
    By default, this field is enabled in these releases:

    Allow Record Import

    Function:
    Specifies which users can import records to an entity.
    Accepted Values:
    Default Value:
    On
    Example:
    Refer to:
    Limitations:
    By default, this field is enabled in these releases:
  2. Click Update.