| On this page | |
| Since | 17.5 |
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 (.zip or .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,
$PDG_DIR/sources/*.zip. -
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 taggedfile/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.
Warning
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
|
|
string |
A list of input archives that will be decompressed. |
|
|
string |
A list of directories where archives will be extracted into. |
Parameters
Node
Output Folder
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.
Schedulers
TOP Scheduler Override
This parameter overrides the TOP scheduler for this node.
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.
No Label
The work items on this node do not have a label.
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.
Examples
example_top_filedecompress Example for File Decompress TOP node
This example demonstrates how to decompress files using TOPs / PDG.
| See also |
