| On this page | |
| 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 ¶
|
|
string |
The compression method (for example, |
|
|
string |
File path to the output archive file. |
|
|
string |
Array of path strings representing the source files compiled into the archive. |
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.
Cook Type
Determines how work items in the node should cook, e.g. if they should run in process, out of process, or using services.
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.
Compress Archive
When Compression Method is set to ZIP, this parameter determines whether or not the .zip archive is compressed.
Append to Existing Archive
When Compression Method is set to ZIP, this parameter determines if files should be appended to an existing .zip archive if the Output File already exists on disk. If appending is disabled, existing .zip archives are overwritten.
Compression Level
When Compression Method is set to TAR GZ, this parameter determines how compressed the archive should be. A larger value will take longer to compress, but results in a smaller file size. The value can range between 1 and 9.
Schedulers ¶
TOP Scheduler Override
This parameter overrides the TOP scheduler for this node.
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.
Label Expression
When on, this parameter specifies a custom label for work items created by this node. The parameter can be an expression that includes references to work item attributes or built-in properties. For example, $OS: @pdg_frame will set the label of each work item based on its frame value.
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.
Work Item Command
By default, work items use a command line string determined by the node. It’s possible to override the command line by setting this parameter, either by providing a custom script that’s invoked instead of the default one, or by specifying a completely custom command line string.
Use Default
Use the default command line string for the work item, as determined by the node
Custom Script
Override the job script used to cook tasks in this node. The script is invoked with the same argumentas as the default script. The script will be added a file dependency, and is copied in the working directory of the graph automatically.
Custom Command
specifies a completely custom command line string that fully replaces the default string.
Command
The command line (executable and arguments) to run when the work item runs. If this field is empty the work item will not be scheduled, and will be instantly marked done once all of its dependencies finish.
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
