Multi Object Lookup

Designer > Data > Objects > {object} > Fields > [New] / [Edit] > Display Type > Multi Object Lookup

A Multi Object Lookup lets you reference records in multiple objects. Instead of having a fixed target object, as for a normal Lookup, the target object can be specified before a target record is selected.

In use, a Multi-Object Lookup is a two-stage lookup. First you select the object to use for the Lookup, and then you select a record from that object.

For example, a distributor might take orders for products that come from different catalogs, where each catalog is provided by a different supplier. The Multi-object Lookup field type makes it possible for the order taker to first choose the catalog the product is in, and then choose the product from that catalog.

Considerations

• Multi Object Lookup fields can be created only in Custom Objects
• A Multi Object Lookup field can reference other Custom Objects, or one of these Built-in or CRM objects:

Account Contract Product User

Case Opportunity Project

Contact Price Book Prospect

• In the GUI, the value shown in the Lookup field is the Record Locator value for the selected record--the identifying information displayed for the record. But the value actually stored in the record consists of the object ID and the record ID.
• Therefore, to specify a value for a Multi Value Lookup field when doing a Search, you do not specify the value displayed in the GUI. Rather specify the target record using this format:

{object_id}:{record_id}

where:

• The syntax requires an object ID, followed by a colon (:), and the record id.
• The object's ID must be specified. An object name will not work.
• The record's ID must be specified, not the record locator value displayed in the GUI.

Note: For the moment, it is not possible for most users to search on a mult-object lookup field, since only admins and programmers will have access to the information needed to formulate the query.

• For Data Import:

• The value for a multi-object lookup field must similarly be specified as

{object_id}:{record_id}

• The object designated in the imported record must match one of the objects designated as a possible target for the multi-object lookup. Otherwise, the field is left empty in the imported record.

• That format generated by a Data Export is the same as that required for import:

{object_id}:{record_id}

• In a Form, it is not possible to include a Multi Object Lookup field in the criteria for a Layout Rule. (Only the Record ID is stored in the current record, so there is no value for the Layout Rule to compare to.)
• For the same reason, Multi Object Lookup fields cannot be used for Template Variables in, for example, print templates and email templates
• Like other Lookup fields, Multi Object Lookup fields are not available for use in

• Field Scripts (onChange and onFocus scripts in forms)
• Record Locators
• Web Forms

• In Views and Reports, a Multi Object Lookup field cannot be used:

• in a computed field
• for sorting
• for color coding
• to make a thumbnail

• When doing a Mass Update of Data from the GUI, or when Updating a group of records in a list view, it is not possible to specify a value for a Multi Object Lookup field.

Creating a Multi Object Lookup Field

This section describes the properties you can set for a Multi Object Lookup Field, when you are creating a field of that type in the GUI.

Basic Information

• Label - The field label the user will see in the GUI.
• Display Type: Multi Object Lookup
• Always Required - If checked, a value must be specified when adding or updating a record.
• Field name - The field name that will be used in the internal code.
• Objects

Use the arrow buttons to move entries between the two lists:

• Available Objects - The objects defined in the platform.
• Selected Objects - The objects the user can choose.

Display Attributes

• Section - The section the field will appear in, in the default layout.
• Required - If checked, the field is required in that layout.

Record Selection Information

• Standard Lookup - The choice is made directly from the target object.
• Custom Page - The choice is made by way of custom JSP page.
  Learn more: Using a Custom Page for a Lookup

Creating Related Information Sections in Target Objects

Unlike other Lookups, an object that is the target of a Multi Object Lookup does not have Related Information section generated automatically, for that relationshop.

A Related Information section can be manually created, however.

Learn more: Optional Related Information Sections

REST APIs

Multi Object Lookups can be manipulated using these REST APIs:

• field Resource

• record Resource

• record Add
• record Update
• record Fetch