Entity screen > Fields tab

Creates custom entity fields for a custom entity.

Video: Build Your First Custom Entity

Examples

Create a Custom Entity Field

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

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.
  • What Types of Entity Field Can I Use in a Form Control?.

How to Start

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

New Field screen

Specifies the type of data that the entity field contains.

Figure: New Field screen

New Field screen

Fields

Field Name Definition

Boolean
Function:
A value that supports True and False. In a checkbox, usually selected is True, deselected is False.

Date
Function:
A date. A runtime app user can enter a date or select a date from a calendar.
Example:
Refer to:

DateTime
Function:
A date and time of day. A runtime app user can enter a date or pick a date from a calendar, and enter a time of day. The time of day gives AM or PM notation.

Decimal
Function:
A numeric value with a specified number of decimal places.
Example:
Refer to:

Email
Function:
A text string in e-mail address format.
Example:
Refer to:

GUID
Function:
A GUID.

Numeric
Function:
A numeric value, up to 18 characters.
Example:
Refer to:

People Picker
Function:
Shows a list of users, groups, or roles.

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Percentage
Function:
A whole number that represents a percentage.

Phone
Function:
A phone number with up to 20 numbers or special characters.
Example:
Refer to:

Picklist
Function:
Uses a picklist to populate a list of values. A runtime app user can select a value from the list.

Range
Function:
A value that must be no lower than a minimum specified value, and no higher than maximum specified value.

Rich Text
Function:
Rich text in HTML format. You can set a maximum length, up to 4000 characters.

Text
Function:
Any combination of letters, numbers, or special characters in a single line of text. You can set a maximum length, up to 4000 characters.
Example:
Refer to:

Text Area
Function:
Any combination of letters, numbers, or special characters, with line breaks, up to 4000 characters.
Example:
Refer to:

URL
Function:
A web site address of up to 4000 characters. When a runtime app user clicks on the field, the URL opens in a separate browser window.

Sequence Number
Function:
Creates a unique, sequential number for each new record of the entity field.

Yes/No
Function:
A variation on a Boolean field type that allows the values Yes or No. You can use Yes for checked values and No for unchecked values.

Search Search icon
Function:
Does a search for the specified field type.

Next
Opens this Screen:
New Field screen: Common Fields
Function of this Screen:
Specifies the configuration for your field

New Field screen: Common Fields

Specifies the configuration for your field.

This topic gives the settings that are common to all field types. Refer to the next sections for information about the settings for specific field types.

Figure: Common Fields screen

Common Fields screen

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:

Description
Function:
A text description for your entity field.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Indexed Field
Function:
Specifies whether this entity field is searchable.
Accepted Values:
  • On - The entity field is searchable.
  • Off - The entity field is not searchable.
Default Value:
Off

Mark as Internal
Function:
Specifies whether the entity field shows in AgilePoint NX applications.
Accepted Values:
  • On - The field shows in applications.
  • Off - The field does not show in applications.
Default Value:
Off

Is Visible in Data Tab
Function:
Specifies whether the entity field is visible in the Entity screen > Data tab.
Accepted Values:
  • On - The entity field shows on the data tab.
  • Off - The entity field does not show on the data tab.
Default Value:
Off

Previous
Function:
Goes to the previous screen.

Save
Opens this Screen:
Saves the configuration for your entity field.

Save and New
Opens this Screen:
Saves the configuration for your entity field and opens New Field screen to create a new field.

New Field screen: Date

This topic gives the settings that are specific to the entity field type Date.

Figure: Date Field screen

Date Field screen

Fields

Field Name Definition

Min Date
Function:
Specifies the first date in a range for a Date entity field.
To Open this Field:
  1. On the New Field screen, select Date.
  2. Click Next.
Accepted Values:
A date from a calendar.
Default Value:
Mon Jan 01 1906
Limitations:

The default value Mon Jan 01 1906 is available in these releases:

Max Date
Function:
Specifies the last date in a range for a Date entity field.
To Open this Field:
  1. On the New Field screen, select Date.
  2. Click Next.
Accepted Values:
A date from a calendar.
Default Value:
Fri Dec 31 9999
Limitations:

The default value Fri Dec 31 9999 is available in these releases:

Default Value
Function:
Specifies the default value for a Date 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 Date.
  2. Click Next.
Accepted Values:
A date from a calendar.
Default Value:
The system date.

Date Format
Function:
Specifies the date format to show in a Date entity field.
Accepted Values:
A date format from the list.
Default Value:
None
Example:
  • 9/5/2019
  • Sep/5/2019
  • 2019/09/5
Limitations:

This field is available in these releases:

New Field screen: DateTime

This topic gives the settings that are specific to the entity field type DateTime.

Figure: DateTime Field screen

DateTime Field screen

Fields

Field Name Definition

Min Date
Function:
Specifies the first date and time in a range for a DateTime entity field.
To Open this Field:
  1. On the New Field screen, select DateTime.
  2. Click Next.
Accepted Values:
A date from a calendar and time from a spinner.
Default Value:
Mon Jan 01 1906
Limitations:

The default value Mon Jan 01 1906 is available in these releases:

Max Date
Function:
Specifies the last date and time in a range for a DateTime entity field.
To Open this Field:
  1. On the New Field screen, select DateTime.
  2. Click Next.
Accepted Values:
A date from a calendar and time from a spinner.
Default Value:
Fri Dec 31 9999
Limitations:

The default value Fri Dec 31 9999 is available in these releases:

Default Value
Function:
Specifies the default value for a DateTime 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 DateTime.
  2. Click Next.
Accepted Values:
A date from a calendar and time from a spinner.
Default Value:
The system date.

Date Format
Function:
Specifies the date format to show in a DateTime entity field.
Accepted Values:
A date format from the list.
Default Value:
None
Example:
  • 9/5/2019
  • Sep/5/2019
  • 2019/09/5
Limitations:

This field is available in these releases:

New Field screen: Decimal

This topic gives the settings that are specific to the entity field type Decimal.

Figure: Decimal Field screen

Decimal Field screen

Fields

Field Name Definition

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

New Field screen: Email

This topic gives the settings that are specific to the entity field type Email.

Figure: Email Field screen

Email Field screen

Fields

Field Name Definition

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 an E-mail 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 E-mail.
  2. Click Next.
Accepted Values:
A value in e-mail address format.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of an entity field.
To Open this Field:
  1. On the New Field screen, select Email.
  2. Click Next.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

New Field screen: Numeric

This topic gives the settings that are specific to the entity field type Numeric.

Figure: Numeric Field screen

Numeric Field screen

Fields

Field Name Definition

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

Default Value
Function:
Specifies the default value for a Numeric 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 Numeric.
  2. Click Next.
Accepted Values:
An integer.
Default Value:
None

New Field screen: People Picker

This topic gives the settings that are specific to the entity field type People Picker.

Figure: People Picker Field screen

People Picker Field screen

Prerequisites

Fields

Field Name Definition

People Source
Function:
Specifies the repository where your users are stored.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
Read only.
Default Value:
Registered Users

Enable Role Filtering
Function:
Specifies a list of roles to filter the users that show on the entity field.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
  • Off - Does not show a list of roles.
  • On - Shows a list of roles.
Default Value:
Off

Select Role(s)
Function:
Specifies a list of roles.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
  3. Set Enable Role Filtering field to ON.
Accepted Values:
The roles from the list.
Default Value:
None

Enable Group Filtering
Function:
Specifies a list of the groups to filter the users that show on the entity field.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
  • On - Does not show a list of the groups.
  • Off - Shows a list of the groups.
Default Value:
Off

Select Group(s)
Function:
Specifies a list of groups.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
  3. Set Enable Group Filtering field to ON.
Accepted Values:
The groups from the list.
Default Value:
None

Allow Multiple Selections
Function:
Specifies whether you can use more than one user for the entity field values.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
  • On - Lets you select more than one user.
  • Off - You can select only one user.
Default Value:
Off

Include Disabled Users
Function:
Specifies whether you can select users that are disabled in Manage Center.

For more information, refer to Disable a User.

To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
  • On - Lets you select disabled users.
  • Off - Lets you select only active users.
Default Value:
Off

Maximum Number of Users to Display by Default
Function:
Specifies the maximum number of users to show in the list by default.
To Open this Field:
  1. On the New Field screen, select People Picker.
  2. Click Next.
Accepted Values:
An integer.
Default Value:
100

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 People Picker.
  2. Click Next.
Accepted Values:
An integer.
Default Value:
256

New Field screen: Phone

This topic gives the settings that are specific to the entity field type Phone.

Figure: Phone Field screen

Phone Field screen

Fields

Field Name Definition

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 Phone 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 Phone.
  2. Click Next.
Accepted Values:
Any combination of numbers or special characters based on the local country phone number format.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of an entity field.
To Open this Field:
  1. On the New Field screen, select Phone.
  2. Click Next.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

New Field screen: Picklist

This topic gives the settings that are specific to the entity field type Picklist.

Figure: Picklist Field screen

Picklist Field screen

Fields

Field Name Definition

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

Allow Multiple Selections
Function:
Specifies whether more than one picklist item can be used for the entity field values.
Accepted Values:
  • On - Lets you select more than one picklist.
  • Off - You can select only one picklist.
Default Value:
Off

New Field screen: Range

This topic gives the settings that are specific to the entity field type Range.

Figure: Range Field screen

Range Field screen

Fields

Field Name Definition

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

Increment Step
Function:
Specifies the interval between range values.
To Open this Field:
  1. On the New Field screen, select Range.
  2. Click Next.
Accepted Values:
An integer.
Default Value:
1

Default Value
Function:
Specifies the default value for a Range 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 Range.
  2. Click Next.
Accepted Values:
An integer.
Default Value:
0

New Field screen: Rich Text

This topic gives the settings that are specific to the entity field type Rich Text.

Figure: Rich Text Field screen

Rich Text Field screen

Fields

Field Name Definition

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 Rich Text 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. More than one line of rich text in HTML format.
  2. Click Next.
Accepted Values:
More than one line of text in HTML rich text format.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of 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:
One line of text that can have spaces.
Default Value:
None

New Field screen: Text

This topic gives the settings that are specific to the entity field type Text.

Figure: Text Field screen

Text Field screen

Fields

Field Name Definition

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 Text 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 Text.
  2. Click Next.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of an entity field.
To Open this Field:
  1. On the New Field screen, select Text.
  2. Click Next.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

New Field screen: Text Area

This topic gives the settings that are specific to the entity field type Text Area.

Figure: Text Area Field screen

Text Area Field screen

Fields

Field Name Definition

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 Text Area 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 Text Area.
  2. Click Next.
Accepted Values:
More than one line of text.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of 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:
One line of text that can have spaces.
Default Value:
None

New Field screen: URL

This topic gives the settings that are specific to the entity field type URL.

Figure: URL Field screen

URL Field screen

Fields

Field Name Definition

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

Default Value
Function:
Specifies the default value for a URL 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 URL.
  2. Click Next.
Accepted Values:
The URL address.
Default Value:
None

Placeholder Text
Function:
Specifies short text that gives a suggestion for the value of an entity field.
To Open this Field:
  1. On the New Field screen, select URL.
  2. Click Next.
Accepted Values:
Any combination of letters, numbers, or special characters in a single line of text.
Default Value:
None

New Field screen: Sequence Number

This topic gives the settings that are specific to the entity field type Sequence Number.

Figure: Sequence Number Field screen

Sequence Number Field screen

Fields

Field Name Definition

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

Prefix
Function:
Specifies text to show before each incremented number in a sequence.
To Open this Field:
  1. On the Sequence Number screen, in the Field Configuration section, set Display Formatted Value in Data Tab to On.
Accepted Values:
One line of text that can have letters, spaces, and special characters.
Default Value:
None
Limitations:

This field is available in these releases:

Example:
INT-

If the prefix is INT-, the initial value is 1, and the increment is 1, the sequence number will be INT-1, INT-2, INT-3...

Suffix
Function:
Specifies text to show after each number in an incremented sequence.
To Open this Field:
  1. On the Sequence Number screen, in the Field Configuration section, set Display Formatted Value in Data Tab to On.
Accepted Values:
One line of text that can have letters, spaces, and special characters.
Default Value:
None
Limitations:

This field is available in these releases:

Example:
If the suffix is th, the initial value is 10, and the increment number is 1, the sequence number will be 10th, 11th, 12th...

New Field screen: Yes/No

This topic gives the settings that are specific to the entity field type Yes/No.

Figure: Yes/No Field screen

Yes No Field screen

Fields

Field Name Definition

Yes Value Label
Function:
Specifies the text label for Yes in a Yes/No entity field.

This text label shows on the Entity screen > Data tab if entity field associated with Yes/No field type is set to Yes.

To Open this Field:
  1. On the Yes/No screen, in the Field Configuration section, set Display Formatted Value in Data Tab to On.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Limitations:

This field is available in these releases:

No Value Label
Function:
Specifies the text label for No in a Yes/No entity field.

This text label shows on the Entity screen > Data tab if entity field associated with Yes/No field type is set to No.

To Open this Field:
  1. On the Yes/No screen, in the Field Configuration section, set Display Formatted Value in Data Tab to On.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Limitations:

This field is available in these releases: