Perforce TOP node

Execute Perforce commands through PDG

On this page	Installation Top_attributes Parameters Node File Source Operation Common Schedulers
Since	17.5

This node acts as a wrapper around Perforce functionality. It provides an interface for executing p4 commands.

Installation

In order to use this node, you must ensure that Perforce is installed on any systems where jobs for this node are going to run.

In addition, the Perforce node must be able to find the p4 executable. When the job runs, it will first look for an environment variable called PDG_PERFORCE. If this variable is defined, the job will use its value as the path to Perforce’s executable. If the PDG_PERFORCE environment variable is not defined, the node will assume that p4 is available via the system’s path.

TOP Attributes

`opduring`	int	Indicates when the operation will be performed: Generate = 0 Cook (In-Process) = 1 Cook (Out-of-Process) = 2
`perforceop`	string	Indicates the Perforce operation to perform (update, sync, edit, submit, add, change, or version)
`overridebin`	integer	Specifies whether the user has overriden the default behaviour for determining the location of the P4 executable. When this is set to 1, the work script will use the custom binary path specified by the user.
`perforcebin`	string	This is set to the custom P4 executable path specified by the user. This is used as the path to the P4 executable when `overridebin` is set to 1
`sourcefiles`	integer	Indicates the user’s selected menu item from the Source Files parameter.
`filepattern`	string	The file pattern to use in the Perforce operation.
`filetag`	string	The file tag of the input results included in the Perforce operation.
`changelistnum`	integer	For the `edit`, `submit`, and `add` operations: specifies the changelist number for the operation
`changelistchoice`	string	Specifies whether the default changelist or a numbered changelist is being used.
`changelistdescription`	string	For the `submit` and `change` operations: specifies the changelist description
`p4configfile`	string	Specifies the location of the P4 config file
`forcesync`	integer	For the `sync` operation: indicates whether a force sync should be performed
`emptychangelist`	integer	Change operation only: specifies whether the new change list should be empty or include all pending files
`updateall`	integer	Update and Sync operation only: indicates whether the entire workspace should be updated
`changelist`	integer	Change operation only: when a change list is successfully created by the change operation, its number will be specified via this attribute.
`input_files`	string	The list of file paths or the file pattern to be used in the p4 command.

Parameters

Node

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.

Perform Op During

This parameter dictates when to perform the Perforce operation. The Perforce command can be executed in the work item generation phase, or during the cook phase (either in-process or out-of-process).

Perforce Operation

This menu is used to select the Perforce command that will be executed.

File Source

This folder provides options for choosing which files will be included in the Perforce command.

All Files in Workspace

Update and Sync commands only: the entire workspace will be updated or synced when this option is enabled.

Empty Changelist

Change command only: when this option is enabled, any currently pending files will not be included in the newly created changelist.

Source Files

Selects the source of the files that will be included in the Perforce operation. The included files can either be provided by the upstream work item’s results or by a Perforce file pattern.

File Tag

A file tag to filter input files by. Only input results with this tag will be included in the work item’s operation.

File Pattern

Perforce file pattern to use in the operation.

Operation

Force Sync

If performing the sync command, this will enable or disable a force sync.

Changelist

If the Perforce command involves a changelist, this provides the choice of using the default changelist or a numbered changelist.

Changelist Number

If the Perforce command involves a changelist and the changelist option is set to 'Numbered', this allows for the changelist number to be specified.

Description

This parameter is used to create the description for any Perforce commands that require a changelist description.

Common

P4 Config File

Specifies the location of a P4 Config file. This will cause the P4CONFIG environment variable to be set in the job’s environment.

Override Perforce Path

This allows the path to the p4 executable to be completely overwritten with a custom path.

Schedulers

TOP Scheduler Override

This parameter overrides the TOP scheduler for this node.

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.

Priority Expression

This parameter specifies an expression for work item priority. The expression is evaluated for each work item in the node.

This parameter is only available when Work Item Priority is set to Custom Expression.

TOP nodes

Attribute Array

Creates and modifies array attributes on work items.
Attribute Copy

Copies attributes from work items in one branch onto work items in another branch.
Attribute Create

Creates or sets an attribute on all incoming work items.
Attribute Delete

Removes attributes from work items.
Attribute Rename

Renames attributes on work items.
Attribute from String

Parses attribute values from a string, such as a file name.
Block Begin Feedback

Starts a feedback loop. TOP nodes within the block execute serially, optionally looping for each incoming work item.
Block End Feedback

Ends a feedback loop. TOP nodes within the block execute serially, optionally looping for each incoming work item.
CSV Input

Copies data from a CSV file into work item attributes.
CSV Output

Writes work item attributes to a CSV file.
Command Send

Sends code to a shared server to execute.
Command Server End

Ends a command server block.
Deadline Scheduler

The PDG scheduler for Thinkbox’s Deadline software.
Download File

Downloads the contents from one or more URLs into files.
Environment Edit

Edits the variables set in the environment work item command lines execute in.
Error

Issues warnings or errors when a condition is met.
FFmpeg Encode Video

Encodes a sequence of still images as a video file.
FFmpeg Extract Images

Extracts a sequence of still images from a video file.
File Compress

Compress files into an archive.
File Copy

Copies a file from one location to another, either at runtime or whenever the node generates.
File Decompress

Decompresses archive files specified by incoming work items into individual files.
File Pattern

Creates work items based on files that match a certain pattern.
File Range

Creates a range of work items based on files that match a certain pattern.
File Remove

Deletes a file at a specified path.
File Rename

Renames or moves a file.
Filter by Expression

Conditionally filters upstream work items.
Filter by Range

Filter upstream work items that fall within a specified frame or attribute range.
Filter by State

Filters upstream work items by their state
Generic Generator

Generates work items with no attributes that run a command line.
Geometry Import

Loads points or primitives from a SOP or geometry file into work item attributes or a temporary file.
HDA Processor

Creates work items that cook a digital asset
HQueue Scheduler

Schedules work items using HQueue.
Houdini Server Begin

Starts a persistent Houdini command server.
ImageMagick

Provides easy access to ImageMagick functionality such as mass image convert, resize, and image mosaics.
In Process Scheduler

Controls the scheduling of in-process work items.
Invoke

Invokes a compiled block on input geometry
JSON Input

Extracts data from JSON files and creates attributes
JSON Output

Performs various operations that produce JSON output
Labs Archive Project

Utility TOP to Collect and Archive current HIP file dependencies
Labs Concatenate Text

Merges one or more text files into a single file.
Labs Cut Geometry to Partitions

Cuts up incoming geometry
Labs Data Diff

Diffs a variety of geometry, text and image files.
Labs Extract Image Metadata

Extract image metadata using iinfo.
Labs Filter by Value

Filters one or multiple workitems by specific attribute values.
Labs Filter by Value

Filters one or multiple workitems by specific attribute values.
Labs Generate from Imageplanes

Generates work-items based on imageplanes found in an image
Local Scheduler

Schedules work items on the local machine.
Make Directory
Map All

Maps all upstream work items to downstream work items.
Map by Expression

Maps upstream work items to downstream work items using an expression
Map by Index

Maps upstream work items to downstream work items based on their index.
Map by Range

Map upstream work items to downstream work items using range values
Maya Server Begin

Starts a persistent Maya command server
Merge

Merge all upstream work items
Nuke Server Begin

Starts a persistent Nuke command server.
Null

Does nothing
OP Notify

Notify an OP node that some TOP work has completed
Output

Subnet output
Partition by Attribute

Partitions work items based on their attributes
Partition by Bounds

Partitions source items spatially using the bounding items.
Partition by Combination

Partitions work items into pairs, triples, etc
Partition by Comparison

Partitions work items using existing comparisons
Partition by Expression

Partitions work items based on an expression
Partition by Frame

Partitions work items based on their frame
Partition by Index

Partitions work items based on their index
Partition by Node

Partitions work items based on their node
Partition by Range

Partition work items based on range values
Partition by Tile

Partitions work items spatially using axis-aligned bounding boxes.
Perforce

Execute Perforce commands through PDG
Python Mapper

Maps work items using a Python script
Python Partitioner

Partitions work items using a Python script
Python Processor

Generates work items using a Python script.
Python Scheduler

A Python-based programmable Scheduler for PDG.
Python Script

Creates work items that run a script
Python Server Begin
ROP Alembic Output

Creates work items that cook an embedded Alembic ROP node
ROP Composite Output

Creates work items that cook an embedded Composite ROP node
ROP Fetch

Creates work items that cook a ROP node or network.
ROP Geometry Output

Creates work items that cook an embedded Geometry ROP node
ROP Mantra Render

Creates work items that cook an embedded Mantra ROP node
ROP USD Output

Creates work items that cook an embedded USD ROP node
Range Extend

Extend the frame range of upstream work items and adds new work items as necessary
Range Generate

Generates work items for the specified range.
Render IFD

Creates work items that render an IFD file with Mantra
SQL Input
SQL Output
Send Email

Sends an email.
Shotgun Create

Creates shotgun entities
Shotgun Delete

Deletes entities from shotgun
Shotgun Download

Downloads shotgun attachments
Shotgun Find

Finds shotgun entities
Shotgun Server Begin

Starts a persistent Shotgun command server
Shotgun Update

Updates shotgun entities
Shotgun Upload

Uploads files to shotgun
Sort

Sorts work items by a list of attributes
Split

Splits upstream items in two
Subnetwork

Container for TOP nodes
Switch

Switch which between network branches
TOP Fetch

Cooks another TOP network
TOP Fetch Input

Input to a TOP fetch-ed network
Text Output

Writes text to a new file or appends to an existing file.
Tractor Scheduler

Schedules work items using Pixar’s Tractor.
URL Request

Creates work items that request data from a URL
USD Import

Creates work items from prims found in a USD stage.
USD Import Files

Creates work items from file references found in a USD stage.
USD Render

Creates work items that render a USD file.
Wait for All

Waits for all upstream work items to complete.
Wedge

Creates work items with varying attribute values.
Work Item Expand

Expands file lists or partitions into multiple work items
Xml Input

Extracts data from XML into Work Item attributes