TOP Fetch Input TOP node

Input to a TOP fetch-ed network

On this page	Parameters Examples
Since	17.5

This node can be used to receive input data from a TOP Fetch node in a different network. The TOP Fetch node in the original network will write its attributes and input file list to JSON file. The path to that file is available in this node via the $PDG_FETCH_JSON_FILE environment variable.

Tip

The $HH/help/files/pdg_examples/top_topfetch example shows how you can use this node to retrieve input work items from a TOP Fetch node.

Parameters ¶

Generate When

Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.

All Upstream Items are Generated

This node will generate work items once all of the input nodes have generated their work items.

All Upstream Items are Cooked

This node will generate work items once all of the input nodes have cooked their work items.

Each Upstream Item is Cooked

This node will generate work items each time a work item in an input node is cooked.

Automatic

The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.

Work Item Source

Determines where the node should look for work item attribute data.

JSON File

Work item attributes are loaded from a serialized .json file. The TOP Fetch node sets the $PDG_FETCH_JSON_FILE environment variable so that it refers to the full path to the work item associated with the fetch task itself.

Active Work Item

Work item attributes are loaded from the current active work item. This option is useful when the TOP Fetch is embedded in a network that’s cooked within another network that’s already being cooked by TOPs. For example, a TOP Network embedded inside of a SOP asset cooked using the HDA Processor TOP.

Automatic

The node will first attempt to load work item data from the file path specified using the JSON File Path parameter. If the file doesn’t exist, it will fallback to loading the active work item, and then finally use the On Missing Input error condition if no work item is found using either source.

JSON File Path

The file path to the JSON data pack produced by the TOP Fetch node. The TOP Fetch Input will load the work item attributes and inputs from the file and create a copy of the work item in this node.

On Missing Input

Determines what the node should do if the JSON File Path isn’t found.

Report Error

The node fails to cook an error is reported.

Report Warning

The node successfully cook, but no work items are created and a warning is reported.

Generate Empty Work Items

The node generates zero or more empty work items.

Work Item Count

When On Missing Input is set to Generate Empty Work Items, this parameter determines the number of empty work items to create.

Examples ¶

FetchingATopNetworkWithInput Example for TOP Fetch Input TOP node

This example demonstrates how to use Top Fetch to fetch results from other top networks (using Top Fetch Input).

Parameters ¶

Examples ¶

TOP nodes