Create an Entity Field

To create an entity field, do the procedure in this topic.

Figure: New Field screen

New Field screen
Figure: Entity Fields screen

Entity Fields screen

Video: Build Your First Custom Entity

Examples

Prerequisites

Good to Know

  • All entities create 5 standard fields by default. These fields are read-only. You can not change or delete these fields, and you can not give them values:
    • ID
    • Created Date
    • Last Modified Date
    • Created By
    • Last Modified By
  • After you configure the field type, you can not change it.

How to Start

  1. On the Entities screen, click an entity.
  2. Click the Fields tab.
  3. Click Add Field Add Field icon.

Procedure

  1. On the New Field screen, do one of these.
    • Select Boolean.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Default Value
        Function:
        Specifies the default value for a Boolean entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Boolean.
        2. Click Next.
        Accepted Values:
        • True - The default value is True.
        • False - The default value is False.
        Default Value:
        False
    • Select Date.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select DateTime.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Decimal.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        18

        Decimal Places
        Function:
        Specifies the number of digits permitted to the right of the decimal point.

        The system shows a validation error if the decimal numbers you enter do not match with the specified decimal places. For example, if you set 2 in this field and enter 5.875 in your form, the system shows a validation error.

        If you enter a number in your form field without a decimal, the system adds the decimal point as you specified in this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        2
        Example:
        If you enter 4.986 in a field with Decimal Places set to 2, the system shows an exception.

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Email.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select Email.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        256

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Guid.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:
    • Select Numeric.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select Numeric.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        4

        Decimal Places
        Function:
        Specifies the number of digits permitted to the right of the decimal point.

        The system shows a validation error if the decimal numbers you enter do not match with the specified decimal places. For example, if you set 2 in this field and enter 5.875 in your form, the system shows a validation error.

        If you enter a number in your form field without a decimal, the system adds the decimal point as you specified in this field.

        To Open this Field:
        1. On the New Field screen, select Numeric.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        0
        Example:
        If you enter 4.986 in a field with Decimal Places set to 2, the system shows an exception.

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Percentage.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:
    • Select Phone.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select Phone.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        20

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Picklist.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Picklist
        Function:
        Specifies a picklist to use for the entity field values.
        To Open this Field:
        1. On the New Field screen, select Picklist.
        2. Click Next.
        Accepted Values:
        A picklist from the list.
        Default Value:
        None
    • Select Range.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Range Start
        Function:
        Specifies the first value of the range in an entity field.
        To Open this Field:
        1. On the New Field screen, select Range.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        0

        Range End
        Function:
        Specifies the last value of the range in an entity field.
        To Open this Field:
        1. On the New Field screen, select Range.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        100
    • Select Rich Text.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select one of these:
          • Rich Text
          • Text Area
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        1000

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Text.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select Text.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        100

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select Text Area.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select one of these:
          • Rich Text
          • Text Area
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        1000

        Default Value
        Function:
        Specifies the default value for a Decimal entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        To Open this Field:
        1. On the New Field screen, select Decimal.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        None
    • Select URL.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Max Length
        Function:
        Specifies the maximum number of characters you can enter in an entity field.
        To Open this Field:
        1. On the New Field screen, select URL.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        256
    • Select Sequence Number.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Initial Value
        Function:
        Specifies the first number in the sequence.
        To Open this Field:
        1. On the New Field screen, select Sequence Number.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        1

        Increment Step
        Function:
        Specifies the interval between sequence numbers.
        To Open this Field:
        1. On the New Field screen, select Sequence Number.
        2. Click Next.
        Accepted Values:
        An integer.
        Default Value:
        1
    • Select Yes/No.
      1. Click Next.
      2. Complete these fields.
        Field Name Definition

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

        Internal Name
        Function:
        Specifies a unique, technical name for the entity field.
        Accepted Values:
        One line of text with no spaces.
        Default Value:
        None
        Example:
        Refer to:

        Default Value
        Function:
        Specifies the default value for a Yes/No entity field.

        If a default value is specified for the entity field, applications use this value if no other value is provided at design time or runtime. The default value shows on form controls associated this field.

        .
        To Open this Field:
        1. On the New Field screen, select Yes/No.
        2. Click Next.
        Accepted Values:
        • Yes - The field is checked.
        • No - The field is unchecked.
        Default Value:
        No
  2. Click Save.