Perforce TOP node

Execute Perforce commands through PDG

On this page

Installation
Top_attributes
Parameters
- Node
Examples

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

Work Item Generation

Whether this node generates static or dynamic work items. You should generally leave this set to "Automatic" unless you know the node’s work items can be computed statically, or that they need to be generated dynamically.

Dynamic

This node always creates dynamic work items: it waits until the upstream work items are known, and generates new work items from the upstream work items.

Static

This node always creates static work items: it creates the number of work items it thinks it needs based on the parameters (and any upstream static items) before the network runs.

Automatic

If the input is static (a static processor, or a partitioner with only static inputs, or a mapper), this node generates static work items, otherwise it generates dynamic work items.

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.

Examples

example_top_perforce Example for Perforce TOP node

This example demonstrates how to perform multiple perforce operations.

TOP nodes

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 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

PDG Scheduler for Thinkbox’s Deadline software.
Download File

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

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

Error handler for failed work items.
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 Remove

Deletes a file at a specified path.
File Rename

Renames or moves a file.
Filter by Expression

Conditionally filter upstream work items
Filter by Range

Filter upstream work items that fall within a specified frame or attribute range
Generic Generator

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

Load points or primitives from SOP or file geometry 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.
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
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
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

Generate 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

Starts a python command server.
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
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.
USD Import Files

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

Creates work items from prims 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 an XML file and creates a string attribute containing the data