Extract Archives – Archive Extractor

Install Archive Extractor

Extracting archives requires Reveal’s Archive Extractor, which can be downloaded using the link in the upper-right corner of the Archives tab (see below). Archive Extractor is available for MacOS, Windows, and Linux.

Run a Test Extraction

The Archive Extractor lets you run a Text Extraction to see whether or not the extraction process would encounter any errors, and provide you the total file count and file size. In addition, the -inventory.json file you select for the extraction contains the expected file sizes of all your .tgz files, and will present an error message if file sizes don’t match during the test extraction.

To run a test extraction:

1. Follow the same steps used in the Extract your Archive section, but do not select an output folder.

2. Click the Test button.

   • If you selected an output folder, the “Test” button will change to “Extract”. Close the application and re-open to start the process over.

3. Interpret your results to see:

   1. Whether there were any errors with the extraction process (TGZ Files column)

   2. How many total files would extract from the archives (Extracted column)

   3. The total size of all of your extracted files (Extracted column)

If you want, you can perform a quality control check on your test extraction by following the steps in our Archives Quality Control Checks article.

Extract your Archives

Extraction allows you to easily open up the zipped archive files downloaded from Reveal.

1. Open Archive Extractor.

2. Click the first ellipses [ … ] in the upper right corner to choose the -inventory.json file among your downloaded files.

   • This is the only .json file Archive Extractor accepts. If you select a different .json file, the status log will prompt you with “ERROR: Please choose an inventory file, with the name ending in -inventory.json."

3. Click the second ellipses [ … ] in the upper right corner to choose an output folder for your extracted files.

   • We recommend using an empty folder to extract your archived project.

4. Use the slider to choose the number of threads you want during the download.

   • The maximum number of threads for the extractor is equal to the number of core CPUs in your computer.

     Important

     A greater number of threads leads to faster downloads. However, be mindful that using a high number of threads could cause network connection or router issues depending on your bandwidth.

5. Click Extract.

6. The status log will let you know when the job starts and completes.

If you want, you can perform a quality control check on your extracted archive by following the steps in our Archives Quality Control Checks article.

Expected Files after Extraction

Once the extraction process completes, your folder will contain the following files:

Depending on the condition of your project, you may also encounter the below file: