Change a Custom Entity

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

Entity Details screen


Entity Details screen

Video: Build Your First Custom Entity

Prerequisites

How to Start

  1. On the Entities screen, click an entity.
  2. Click the 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.

    Description

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

    Category

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

    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

    Active

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

    Use the Default Event Logging for AgilePoint NX Applications / 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 application.
    Default Value:
    Off

    Entity Permission is Disabled / Entity Permission is Enabled

    Function:
    Specifies who can change the custom entity.
    Accepted Values:
    • On - All users who have access can change the custom entity.
    • Off - Only users with the system administrator and entity owner roles can change the custom entity.
    Default Value:
    Off

    Allow Entity Model Import

    Function:
    Lets which users can import entity model to AgilePoint NX Data Entities.
    Accepted Values:
    Default Value:
    Off

    Allow Entity Model Export

    Function:
    Specifies which users can export an entity model.
    Accepted Values:
    Default Value:
    Off

    Allow Record Export

    Function:
    Specifies which users can export the records from an entity.
    Accepted Values:
    Default Value:
    Deselected

    Allow Record Import

    Function:
    Specifies which users can import records to an entity.
    Accepted Values:
    Default Value:
    Off
  2. Click Update.