Defining Foreign Key References

The topics in this section describe the transaction that allows you to define foreign key references.

Refer to Foreign Key References for more information.

You can access the portal from the Admin Menu, and then Database, and then FK Reference. You are brought to a query portal with options for searching for a specific foreign key reference. Once a foreign key reference has been selected you are brought to the maintenance portal to view and maintain the selected record.

Caution:

Important! If you introduce a new foreign key reference, carefully consider its naming convention. Refer to System Data Naming Convention for more information.

The following zones may appear as part of the portal's Main tab page.

• Foreign Key Reference. This zone provides information about the selected foreign key reference.

  • Navigation to the referenced entity may be dynamic. The page associated with the specified Navigation Option is used when a dynamic option is not available. Refer to Navigation Information Is Dynamically Derived for more information.

  • The information description of the referenced entity may be composed dynamically depending on the specified Info Program Name. Refer to Information Description Is Dynamically Derived for more information.

  • Certain restrictions apply when displaying the context menu for a referenced entity.

    Note:

    Context Menu Name is not applicable to user interface elements displaying a generic collection using a foreign key characteristic type. It is only applicable for pages utilizing the foreign key compound element type for fixed page user interface and for data displayed in a portal based user interface where the foreign key reference is defined as an attribute for an element. Report parameters that reference foreign key characteristics are an example of a user interface where a context menu is not displayed even if the foreign key reference defines one.

  • Certain restrictions apply to search features on fixed page user interfaces.

    Note:

    Search Type and Search Tooltip attributes are only applicable to user interface elements utilizing the foreign key compound element type on fixed page user interfaces. Report parameters that reference foreign key characteristics are an example of a user interface where this information is not used even if the foreign key reference defines them.

The following zones may appear as part of the portal's References tab page.

• Foreign Key References. This zone list various configuration entities referencing the current foreign key reference.

Actions

The page supports the following special actions:

• View the source. If the foreign key information program is shipped with the base package, you can use the adjacent button to display the source code of this program in the Javadocs viewer.