File Compress TOP node

Compress files into an archive.

On this page	Top_attributes Parameters Node Schedulers Examples
Since	17.5

This node generates a work item for each incoming work item that takes all file results tagged file and compiles them into a compressed archive. The output result of each work item is the archive file.

TOP Attributes

`method`	string	The compression method (for example, `"zip"` or `"tar.gz"`).
`output_file`	string	File path to the output archive file.
`input_files`	string	Array of path strings representing the source files compiled into the archive.

Parameters

Node

Mode

How do decide what file(s) to compress:

Custom File Path

Set the path to the file to compress in the File Path parameter.

Upstream Output Files

Compress any file paths in the output attributes of incoming work items if they have the given file tag.

File To Compress

When Mode is "Custom File Path", the path of the file to be compressed.

File Tag

When Mode is "Upstream Output Files", compress paths in the output attributes of incoming work items if they have this file tag.

Compression Method

The archive method/format, ZIP or tar.gz.

Output File

Specify the file path of the generated archive file. The file extension will be added if not specified.

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.

Examples

example_top_filecompress Example for File Compress TOP node

This example demonstrates how to compress files using TOPs / PDG.

input1 Example for File Compress TOP node

input2 Example for File Compress TOP node

See also

File Decompress

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