Unpacks the content of FlowFiles that have been packaged with one of several different Packaging Formats, emitting one to many FlowFiles for each input FlowFile. Supported formats are TAR, ZIP, and FlowFile Stream packages.
Unpack, un-merge, tar, zip, archive, flowfile-stream, flowfile-stream-v3
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Packaging Format | Packaging Format | use mime.type attribute |
| The Packaging Format used to create the file |
| File Filter | File Filter | .* | Only files contained in the archive whose names match the given regular expression will be extracted (tar/zip only) | |
| Password | Password | Password used for decrypting Zip archives encrypted with ZipCrypto or AES. Configuring a password disables support for alternative Zip compression algorithms. Sensitive Property: true | ||
| Allow Stored Entries With Data Descriptor | allow-stored-entries-wdd | false |
| Some zip archives contain stored entries with data descriptors which by spec should not happen. If this property is true they will be read anyway. If false and such an entry is discovered the zip will fail to process. This Property is only considered if the [Packaging Format] Property has a value of "zip". |
| Name | Description |
|---|---|
| success | Unpacked FlowFiles are sent to this relationship |
| failure | The original FlowFile is sent to this relationship when it cannot be unpacked for some reason |
| original | The original FlowFile is sent to this relationship after it has been successfully unpacked |
| Name | Description |
|---|---|
| mime.type | If the <Packaging Format> property is set to use mime.type attribute, this attribute is used to determine the FlowFile's MIME Type. In this case, if the attribute is set to application/tar, the TAR Packaging Format will be used. If the attribute is set to application/zip, the ZIP Packaging Format will be used. If the attribute is set to application/flowfile-v3 or application/flowfile-v2 or application/flowfile-v1, the appropriate FlowFile Packaging Format will be used. If this attribute is missing, the FlowFile will be routed to 'failure'. Otherwise, if the attribute's value is not one of those mentioned above, the FlowFile will be routed to 'success' without being unpacked. Use the File Filter property only extract files matching a specific regular expression. |
| Name | Description |
|---|---|
| mime.type | If the FlowFile is successfully unpacked, its MIME Type is no longer known, so the mime.type attribute is set to application/octet-stream. |
| fragment.identifier | All unpacked FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute |
| fragment.index | A one-up number that indicates the ordering of the unpacked FlowFiles that were created from a single parent FlowFile |
| fragment.count | The number of unpacked FlowFiles generated from the parent FlowFile |
| segment.original.filename | The filename of the parent FlowFile. Extensions of .tar, .zip or .pkg are removed because the MergeContent processor automatically adds those extensions if it is used to rebuild the original FlowFile |
| file.lastModifiedTime | The date and time that the unpacked file was last modified (tar only). |
| file.creationTime | The date and time that the file was created. This attribute holds always the same value as file.lastModifiedTime (tar only). |
| file.owner | The owner of the unpacked file (tar only) |
| file.group | The group owner of the unpacked file (tar only) |
| file.permissions | The read/write/execute permissions of the unpacked file (tar only) |
| file.encryptionMethod | The encryption method for entries in Zip archives |