Houdini 20.5 Nodes TOP nodes

Work Item Import TOP node

Import work items from a .json file or another TOP node.

Since 19.5

This node imports work item(s) from a .json file on disk or from another TOP node in the scene file, including any attribute data or output files listed on the source work item(s).

Parameters

Source

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 work items are imported from.

TOP Node

Work items are imported from the TOP node specified by the TOP Path parameter. The TOP node is also cooked if necessary.

Upstream Output File(s)

Work items are imported from upstream output files that match the specified File Tag.

Upstream Work Item ID Attribute

Work items are imported using their unique ID from the integer attribute array specified by the Attribute Name parameter.

Custom File Path

Work items are imported from the .json file specified by the File Path parameter.

Upstream Dictionary Attribue

Work items are imported from an upstream Dictionary attribute, which can contain either a single work item or a work item array. If the dictionary attribute itself is an array, each dictionary is imported indepenently.

TOP Path

Specifies the path to the TOP node to import. The TOP node must be in a different TOP graph than this Work Item Import TOP node.

This parameter is only available when Work Item Source is set to TOP Node.

File Tag

Specifies which file tag to apply to the upstream output files.

This parameter is only available when Work Item Source is set to Upstream Output File(s).

ID Attribute

Specifies the name of the upstream integer array attribute that contains the work item IDs to import.

This parameter is only available when Work Item Source is set to Upstream Work Item ID Attribute.

Dictionary Attribute

Specifies the name of the upstream dictionary attribute that contains the serialized work items to import.

This parameter is only available when Work Item Source is set to Upstream Work Item Dictionary Attribute.

File Path

Specifies the path to the .json file to import.

This parameter is only available when Work Item Source is set to Custom File Path.

TOP Cook Options

These parameters allow you to configure how the TOP node is cooked, and they are only available when Work Item Source is set to TOP Node.

Evaluation Time

Determines the time (in seconds) at which to cook the TOP.

Work Item Frame

The TOP is evaluated at the frame value specified on the upstream work item.

Custom Time

The TOP is evaluated at the Custom Time value.

Network Evaluation Time

The TOP is evaluated at the Houdini playbar time that was set when this TOP network began to cook.

Custom Time

Configures the time value at which the target TOP node is evaluated.

This parameter is only available when Evaluation Time is set to Custom Time.

Dirty Before Cook

Determines if or when the TOP node should be dirtied before it is cooked.

None

The TOP node is not dirtied.

Work Items

The work items on the TOP node are deleted, but their output files are not removed from disk.

Work Items and Output Files

The work items on the TOP node are deleted and their outputs are removed from disk.

Generate Only

The TOP node is generated instead of cooked. However, if the TOP node is dynamic, then its input nodes will still cook.

Evaluate with Work Item Attributes

The attributes of the upstream work items are applied to the scene before cooking the TOP node. This also means that the TOP node is invalidated and may need to recook for each input work item for this node.

Import Options

These parameters allow you to configure how imported work items are processed.

On Attribute Collision

Determines what should happen if an imported work item has an attribute that already exist on an upstream input work item. By default, this node prefers to keep upstream attribute values, but you can change this parameter to Keep Imported Attribute instead to ensure that upstream attributes are overwritten by the values found on the imported work item.

Keep Upstream Attribute

When an upstream work item and an imported work item have an attribute with the same name, work items on this node will keep the upstream attribute data.

Keep Imported Attribute

When an upstream work item and an imported work item have an attribute with the same name, work items on this node will keep the imported attribute data.

Report Warning

When an upstream work item and an imported work item have an attribute with the same name, work items on this node will keep the upstream attribute data and a warning is issued.

Preserve Work Item DataType

When on, PDG will attempt to preserve the custom data type of the imported work items (if possible). Otherwise, the work items will be imported as generic work items.

Add Status AttributeS

When on, the imported work items will have itemname, itemid, and cookedsuccess attributes created on them to track the names, IDs, and statuses of the original work items.

Schedulers

TOP Scheduler Override

This parameter overrides the TOP scheduler for this node.

Add Job Parms

Opens the Edit Parameter Interface window for the purpose of adding scheduler parameters to the node’s interface.

In-Process Scheduler

The Edit Parameter Interface window opens with the In-Process Scheduler’s parameter folder selected in the Create Parameters column.

Local Scheduler

The Edit Parameter Interface window opens with the Local Scheduler’s parameter folder selected in the Create Parameters column.

HQueue Scheduler

The Edit Parameter Interface window opens with the HQueue Scheduler’s parameter folder selected in the Create Parameters column.

Schedule When

When enabled, this parameter can be used to specify an expression that determines which work items from the node should be scheduled. If the expression returns zero for a given work item, that work item will immediately be marked as cooked instead of being queued with a scheduler. If the expression returns a non-zero value, the work item is scheduled normally.

Work Item Label

Determines how the node should label its work items. This parameter allows you to assign non-unique label strings to your work items which are then used to identify the work items in the attribute panel, task bar, and scheduler job names.

Use Default Label

The work items in this node will use the default label from the TOP network, or have no label if the default is unset.

Inherit From Upstream Item

The work items inherit their labels from their parent work items.

Custom Expression

The work item label is set to the Label Expression custom expression which is evaluated for each item.

Node Defines Label

The work item label is defined in the node’s internal logic.

Work Item Priority

This parameter determines how the current scheduler prioritizes the work items in this node.

Inherit From Upstream Item

The work items inherit their priority from their parent items. If a work item has no parent, its priority is set to 0.

Custom Expression

The work item priority is set to the value of Priority Expression.

Node Defines Priority

The work item priority is set based on the node’s own internal priority calculations.

This option is only available on the Python Processor TOP, ROP Fetch TOP, and ROP Output TOP nodes. These nodes define their own prioritization schemes that are implemented in their node logic.

See also

TOP nodes