|On this page|
This node looks in the
output attribute on each incoming work items for file paths tagged
file/archive. If the file name’s extension is supported (
.tar.gz), the node extracts the files inside the archive into a given directory.
(Nodes that produce file results (for example, File Pattern or File Compress) should automatically tag archive files as
file/archive based on the extension.)
If you just want to extract files from one or more pre-existing archive files, do the following:
Create a File Pattern node.
Set the Pattern to match the archive(s) you want to extract. For example,
Make sure Split results into separate items is on.
The node will generate work items for each archive, with its
outputattribute set to the archive path. The path should automatically be tagged
file/archivebased on the extension.
Connect a File Decompress node. Turn on Output file and set it to the directory you want to extract files into.
The File Decompress node sets each work item’s
output to the path of the directory it extracted into, not to the list of extracted files, as you might expect.
TOP Attributes ¶
A list of input archives that will be decompressed.
A list of directories where archives will be extracted into.
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.
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.
Determines how work items in the node should cook, e.g. if they should run in process, out of process, or using services.
Turn this on and set it to the path to the directory you want to extract files into. The node will create the directory if it does not exist.
TOP Scheduler Override
This parameter overrides the TOP scheduler for this node.
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.
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.
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.
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.
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.
example_top_filedecompress Example for File Decompress TOP node
This example demonstrates how to decompress files using TOPs / PDG.