{"title":"Compress Files/Folder","nodeType":"Other","id":"*Zu6mLzbGtihImNIi","factoryName":"org.knime.filehandling.utility.nodes.compress.filechooser.CompressFileChooserNodeFactory","factoryId":"org.knime.filehandling.utility.nodes.compress.filechooser.CompressFileChooserNodeFactory","path":["IO","File Folder Utility","Archive (zip, tar, ...)"],"owner":"knime","ownerAccountId":"account:team:b5f0848f-496d-4e6a-b869-fa3532248db7","description":"<p>This node compresses files or a folder to an archive. If the compression format is being changed the file extension of the archive to create is adapted automatically.\n <br />\n <br />\n Supported archive formats are:</p><ul><li>.zip</li><li>.jar</li><li>.tar</li><li>.tar.gz</li><li>.tar.bz2</li><li>.cpio</li></ul>\n                 \n            \n             \n            <p><b>Note:</b> This node cannot compress KNIME artifacts such as workflows. In order to compress workflows please use a combination of <a href=\"https://hub.knime.com/knime/extensions/org.knime.features.buildworkflows/latest/org.knime.buildworkflows.reader.WorkflowReaderNodeFactory\" rel=\"ugc nofollow noopener noreferrer\"> <i>Workflow Reader</i> </a> and <a href=\"https://kni.me/n/ouYgT_6spFNuvnv_\" rel=\"ugc nofollow noopener noreferrer\"> <i>Workflow Writer</i> </a> instead.</p>\n                \n            <p><i>This node can access a variety of different</i> <a href=\"https://docs.knime.com/2021-06/analytics_platform_file_handling_guide/index.html#analytics-platform-file-systems\" rel=\"ugc nofollow noopener noreferrer\"> <i>file systems.</i> </a> <i>More information about file handling in KNIME can be found in the official</i> <a href=\"https://docs.knime.com/latest/analytics_platform_file_handling_guide/index.html\" rel=\"ugc nofollow noopener noreferrer\"> <i>File Handling Guide.</i> </a></p>\n            \n        \n        ","shortDescription":"Compresses a file, a folder or files in folder to an archive.","keywords":[],"deprecated":false,"streamable":false,"tags":["IO","File Folder Utility","Archive (zip, tar, ...)"],"icon":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA3BpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMDY3IDc5LjE1Nzc0NywgMjAxNS8wMy8zMC0yMzo0MDo0MiAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDowYjM2YWM5Ny01ZWJhLTQwZTctOTE4OS1iYmU4ZDdkMGYyNGUiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6QURBQUE4NEE4RkFCMTFFNTg1NzhENEEzQzA5OUQ0MUMiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6QURBQUE4NDk4RkFCMTFFNTg1NzhENEEzQzA5OUQ0MUMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUgKE1hY2ludG9zaCkiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDpDRDgzOUNENjJFMzAxMUU1OUMzRUMzQkRFMzNFNTk1RiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpENkFDNUE0NjJFMzAxMUU1OUMzRUMzQkRFMzNFNTk1RiIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PqLjjB8AAADCSURBVHjaYvz//z8DKYCRkRGmgRGkl4VEzRh8RmJdgKQZ7gK4M3qmrcYwpSQrlBHNRqw2MXZPXYXTCSBDcPgfIYTPAGygNDuMASMQk5OC4AqEOBHh+u77HxTNc+etYwBqQnEVE7oNMrJyDDy8vES7CCMaL926B3cJzDXoLsFrALIXyHIBHz8/w79//xi+fP6M12acBjx48ZYyL9iZGzH8+vWbfC9cuXQJZzRiAxjRCNIE04jsDbwuACUQfACfPECAAQB5Uk/mC1afNgAAAABJRU5ErkJggg==","views":[],"inPorts":[],"outPorts":[],"dynInPorts":[{"groupName":"Source File System Connection","groupDescription":"The source file system connection.","types":[{"objectClass":"org.knime.filehandling.core.port.FileSystemPortObject","color":"178ba5","dataType":"File System"}]},{"groupName":"Destination File System Connection","groupDescription":"The destination file system connection.","types":[{"objectClass":"org.knime.filehandling.core.port.FileSystemPortObject","color":"178ba5","dataType":"File System"}]}],"dynOutPorts":[],"additionalSiteInformation":{"url":"https://update.knime.com/analytics-platform/5.12","trusted":true,"enabledByDefault":true,"name":"KNIME Analytics Platform 5.12 Update Site","version":"5.12.0"},"dialog":[{"sectionName":"Options","fields":[{"name":"Type","description":"The selection mode.\n<ul><li><b>File</b> : Select a single file.</li><li><b>Folder</b> : Select a single folder.</li><li><b>Files in folders</b> : Select a folder and apply filters to select files within it.</li></ul>","optional":false},{"name":"Source","description":"The path to the file or folder to select.","optional":false},{"name":"Include subfolders","description":"Whether to include subfolders when selecting multiple files within a folder.","optional":false},{"name":"Filter by file extension","description":"Enable filtering files by their extension (e.g. &#39;xlsx;xlsm&#39;).","optional":false},{"name":"File extensions","description":"Semicolon-separated list of file extensions to include (e.g. &#39;xlsx;xlsm;xls&#39;). Case-insensitive unless &#39;Case sensitive (extensions)&#39; is enabled.","optional":false},{"name":"Case sensitive (extensions)","description":"Treat the entered extensions as case sensitive when matching.","optional":false},{"name":"Filter by file name","description":"Enable filtering by file name pattern with wildcards or regular expression.","optional":false},{"name":"File name filter pattern","description":"Pattern for file name filtering. With type &#39;Wildcard&#39;, use &#39;*&#39; and &#39;?&#39;. With type &#39;Regex&#39;, enter a Java regular expression.","optional":false},{"name":"File name filter type","description":"Choose how to interpret the file name pattern: wildcard or regular expression.","optional":false},{"name":"Case sensitive (names)","description":"Make file name filtering case sensitive.","optional":false},{"name":"Include hidden files","description":"Include hidden files in the selection.","optional":false},{"name":"Include special files","description":"Include special file types (workflows etc).","optional":false},{"name":"Filter by folder name","description":"Enable filtering of folders by name pattern before descending into them.","optional":false},{"name":"Folder name pattern","description":"Pattern for folder name filtering. Use &#39;*&#39; and &#39;?&#39; with filter type &#39;Wildcard&#39;. With type &#39;Regex&#39;, enter a Java regular expression.","optional":false},{"name":"Folder name filter type","description":"Choose how to interpret the folder name pattern: wildcard or regular expression.","optional":false},{"name":"Case sensitive (folders)","description":"Make folder name filtering case sensitive.","optional":false},{"name":"Include hidden folders","description":"Descend into folders that are hidden (if they otherwise pass filters).","optional":false},{"name":"Follow symlinks","description":"Follow symbolic links while traversing folders (only relevant when selecting a folder).","optional":false},{"name":"File","description":"Enter a valid path where the created archive should get saved. The required syntax of a path depends on the chosen file system, such as &#34;C:\\path\\to\\file&#34; (Local File System on Windows) or &#34;/path/to/file&#34; (Local File System on Linux/MacOS and Mountpoint). For file systems connected via input port, the node description of the respective connector node describes the required path format. You can also choose a previously selected folder from the drop-down list, or select a location from the &#34;Browse...&#34; dialog. Note that browsing is disabled in some cases: Custom/KNIME URL (always disabled), Mountpoint (disabled if not connected), and file systems provided via input port (disabled if connector node hasn&#39;t been executed).","optional":false},{"name":"Create missing folders","description":"If enabled, missing folders in the specified path will be created automatically.","optional":false},{"name":"If exists","description":"Specify the behavior of the node in case the output file already exists.\n<ul><li><b>Fail</b> : Will issue an error during the node&#39;s execution (to prevent unintentional overwrite).</li><li><b>Overwrite</b> : Will replace any existing file.</li></ul>","optional":false},{"name":"Archive entry path","description":"Depending on the selected mode the location of the files/folders to be copied to the destination folder will differ.\n<ul><li><b>File/folder only</b> : This mode ensures that when de-compressing the archive solely the selected source file/folder and its content will be created.</li><li><b>Full path</b> : This mode ensures that when de-compressing the archive the selected source file/folder, its content as well as the folders containing the selected source will be created. Note that those additional folders don&#39;t contain any other files/folders other than those to be compressed.</li><li><b>Path after prefix</b> : This mode behaves similar to the &#39;Full path&#39; option, except that the specified folder prefix (the beginning of the path) is being ignored, i.e., the folders in the prefix will not be created when de-compressing the archive. <b>Note:</b> This mode might create invalid archive entries, i.e., entries resulting in archives that would not be de-compressible. In this case the node will fail.</li></ul>","optional":false},{"name":"Folder prefix","description":"The folder prefix (the beginning of the path) to be ignored when using &#39;Path after prefix&#39; mode.","optional":false},{"name":"Compression","description":"Select the desired compression format.\n<ul><li><b>zip</b> : ZIP compression format</li><li><b>jar</b> : JAR compression format</li><li><b>tar</b> : TAR compression format (uncompressed)</li><li><b>tar.gz</b> : TAR with GZIP compression</li><li><b>tar.bz2</b> : TAR with BZIP2 compression</li><li><b>cpio</b> : CPIO compression format</li></ul>","optional":false},{"name":"Include empty folders","description":"This option allows to specify whether or not empty folders should be included in the archive.","optional":false}]}],"links":[],"kudos":[],"kudosCount":0,"bundleInformation":{"bundleVersion":"5.12.0.v202605041104","bundleName":"KNIME Filehandling Nodes","bundleSymbolicName":"org.knime.filehandling.utility.nodes","bundleVendor":"KNIME AG, Zurich, Switzerland","featureSymbolicName":"org.knime.features.base","featureName":"KNIME Base nodes","featureVersion":"5.12.0.v202606261225","featureVendor":"KNIME AG, Zurich, Switzerland","extensionId":"*bjR3r1yWOznPIEXS"},"frequentSuccessors":[]}
