Lookup Another Collection

The lookup function allows us to access collections within another collection.

Syntax

From within a collection, use the lookup function and a shared unique variable to connect the two collections.

{#collection 1}{#collection 2 | lookup:shared unique variable | [insert filters] | [insert functions]}{/}{/}

Example 1:  Amalgamation

Desired Result:

If we want to find and list the officers within each amalgamating entity, we would start by opening the entities collection to identify the different entities that are now amalgamating together and then use the shared unique variable, entityID, to identify the officers and their positions from the affiliations collection for each entity.

Code:

 {#tasks | grab:1:'amalgamatingEntities'}{entityName}

{/}

Result:

City Bank LLC

Accounting LLC

Example 2: Shareholdings

In this use case, we will begin with the shareholdings collection and pulling the shareholding name and number of shares and then pulling the class name and voting rights from the shareclasses collection.  Below is the sample share data:

Desired Result:

In sentence format, the name each shareholder, followed by the number of shares, voting rights and class of shares they hold.

Code:

{#shareholdings}{shareholdingName} holds {numShares | commaSeparate} {#shareclasses | lookup:shareclassID}{#votingRights}voting {/}{#!votingRights}non-voting {/}{className} shares.{/}

{/}

Looping the shareholdings collection, insert the name of each shareholding, the number of shares, the voting rights, and the name of the class they hold.  The lookup function will connect these two collections by the shareclassID (shared unique variable).  This allows you to pull the relevant data that is pertinent to each specific shareholder that is contained in the shareclasses collection. 

Result:

Michael Scott holds 100 voting Common shares.

Dunder Mifflin Paper Co. holds 1,000 voting Common shares.

Jim and Pam Halpert, jointly holds 250 voting Common shares.

Darryl Philbin holds 100 non-voting Special shares.