Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section describes the configuration settings required in order for a field to adopt a particular field type on a generated entity form. For each field type, follow the steps in General Steps for Creating a Field and modify the Fields record as described in each section below.

Anchor
Standard Text Field
Standard Text Field
Standard Text Field

...

  • Name: Aptify's standard naming convention for link boxes is the name of the linked entity (in its singular form) and the linked entity field. For example, the name of a field linked to the Applications entity's ID field would be ApplicationID.
  • Display Name: Specify the name that you want users to see as the link box's caption on generated forms.
  • Linked Entity: Select an entity from the drop-down list.

    Note

    When you save a linked field for the first time, a message box appears asking if you want to create a virtual field for the linked field. See 373561615 Joined Virtual Field for details. Likewise, when you delete a linked field and one or more virtual fields exist for the linked field, a message box appears asking you if you want to delete the virtual fields as well.


  • Linked Entity Field: Select a field in the Linked Entity from the drop-down list; this field is used as the foreign key. In general, the Linked Field is the ID field of the Linked Entity. However, other fields also appear in the drop-down list. To qualify as a Linked Field, a field in a related entity must meet the following criteria:
    • The Linked Field must be a primary key (the ID field) or a unique key in the Linked Entity. (This is a SQL Server requirement.)
    • The field in the Linked Entity must have the Is Required option selected. (This is an Aptify requirement.)

  • Values Tab: You only need to configure the Values tab if you want to enable the Multiple Selection dialog for In List filters. See Values Tab for details.
  • Options Tab: Do not select the Default in View if you intend to create a Joined Virtual Field.
  • Validation Tab: To create a required foreign key, select the Is Required field; a user will need to specify a value for the link box before he or she can save a new record in this service. To create an optional foreign key, clear the Is Required field; a user does not need to specify a value for the link box before saving a new record in this service.

...

Note

When you create a joined virtual field using the wizard, Aptify automatically sets the virtual field's Join Type to Required or Optional depending on whether or not the linked field is required.

Note that if you modify the Is Required option for a linked field at a later date, the system does not automatically update the Join Type for that field's virtual fields. In this case, you need to manually edit the Join Type for each virtual field related to the linked field you modified. See Join Type for more information on this parameter. 

...

  • Name: Aptify's standard naming convention for virtual fields associated with a link box is the name of the link box field plus _Name. For example, the virtual field for an ApplicationID link box would be named ApplicationID_Name. The name cannot -contain spaces or dashes.

  • Display Name: Specify the name that you want users to see as this field's column heading in a view.

  • SQL Server settings: You do not need to specify these settings since this field will not be in the table. However, typically the SQL Data Type and SQL Field Size should be the same as the field to which the virtual field refers.

  • Options Tab: Configure the following options:
    • In Table: Clear the In Table option under the Options tab. A Virtual Field tab displays automatically.
    • Default In View: Select the option to display the virtual field in list views of this entity by default.

  • Virtual Field Tab: Configure the following fields on this tab:
    • Virtual Field Type: Select Joined.
    • Joined Entity: Select the entity that appears in the link box's Linked Entity field.
    • Joined Field: Select the field from the Joined Entity whose value you want to display in views.
    • Join Foreign Key: Enter the name of the corresponding link box field you created (such as ApplicationID). This field fills in automatically when you specify a Joined Entity.

  • Join Type: Select a Join Type. See Join Type for details. In general, use Optional for if the related linked field is not required and Required if the related linked field is required.

...

Note

When you save a linked field for the first time, a message box appears asking if you want to create a virtual field for the linked field. See 373561615 Joined Virtual Field for details. Likewise, when you delete a linked field and one or more virtual fields exist for the linked field, a message box appears asking you if you want to delete the virtual fields as well.

...