Differences

This shows you the differences between two versions of the page.

--- public:nnels:mp3todaisy:batch-download [2024/02/23 19:33]
rachel.osolen created
+++ public:nnels:mp3todaisy:batch-download [2024/03/07 23:13]
rachel.osolen
@@ Line 3: / Line 3: @@
 <note important>Under Construction</note>
-Mark a project for download on the project page.
+When you are managing a large project with dozens of titles, the Batch Downloader is a useful tool to help expedite your work. You can mark all the titles for download, run the downloader program on your computer, and then work on other priorities as all the titles download in a single batch onto a folder on your computer!
-This will open the project status page where you can see the projects that are marked for download. You can use the filter at the top to limit the listing.
+<note tip>You also have the option to Download a Single Title. This option only downloads one title at a time.</note>
-If a DAISY project is marked for download but then is modified, it won't be downloaded when you download the batch. There is no check for this yet for EPUB, and any EPUB projects that are listed will include a warning under the status table.
+<note>This function is only available in the QA account.</note>
+Before you get started you will need to download the ''Batch Downloader Client''.
-The program is linked under the account menu for admin accounts and QA.
+To download the program to your computer:
+  * The program is linked under the account menu for admin accounts and QA.
+  * Download the file for Windows or mac, and unzip it.
+  * It downloads projects from the QA account to a projects folder by default, but you can change these if you want. There's information in the readme file included in the zip file
+  * Extract it.
+  * Right click removeQuarantine.command and choose open. You'll get a confirmation about running untrusted software. Allow it to run. You should get a terminal window with a message about removing the quarantine attribute.
+  * Close the terminal once it's done.
-Download the file for Windows or mac, and unzip it.
+The configuration is set to download from QA to the projects folder. You can change the path in copdl.ini if you want, otherwise leave as is.
-It downloads projects from the QA account to a projects folder by default, but you can change these if you want. There's information in the readme file included in the zip file, but let me know if something doesn't make sense.
+<note>The removeQuarantine step only needs to be done the first time after you extract it. You can just run copdl the next time and it should download the next batch.
+</note>
+Next you will need to Manage the titles and Mark them for Download.
-When you run it, it creates a log file that lists the projects that are downloaded. This is overwritten each time it is run. You likely don't need to do anything with this in most cases unless something doesn't work properly, and then it may help to include the contents in a bug report. On the server, it also logs the list of projects that are available for download and when each is completed, but any errors in the client aren't sent back to the server.
+To Manage Titles:
+  * Log into the QA account
+  * Select the navigation link ''Manage Projects'' at the bottom of the page
+  * This will take you to the ''Manage Projects Page''
+  * Select the title you wish to QA and Download
+  * QA the title with the [[public:nnels:mp3todaisy:qa-checklist|QA Checklist]]
+  * Once the title passes QA navigate back to the ''Project Page'' for that title
+  * Select ''Mark for Download'' from the list of options (it is the sixth option in the list.)
+  * This will take you back to the ''Manage Projects'' page
+  * Repeat until you have marked all the titles you wish to download
-There's no way to cancel a batch in progress except with a keyboard interrupt command, but you can leave the terminal window open in the background while you do something else.
+Once you have finished the ''QA'' and ''Mark for Download'' process for all the titles, you are ready to run the Batch Downloader on your computer. Keep the browser window open to the ''Manage Projects'' page during this process.
+To run the Batch Downloader:
+  * Navigate to the copdl folder on your computer
+  * Open the copdl into your Terminal (This can be down with a double click)
+  * This will automatically run the program and download the files from the QA account into the folder on your computer
+  * Once it is finished, there will be a message in your terminal window that reads: ''# of # downloads completed. logout''
+  * Close the Terminal window
-After the downloads are finished, reload the project page. They will have a status of Downloaded. There is a section at the bottom of the status page that lists the downloaded projects, and will let you delete them. The status filter at the top doesn't apply to the Delete Downloaded Projects section, only to the projects table.
+<note>Sometimes the program will stall, or quit in the middle of a batch. If this happens, just close the terminal window, and reopen the program again. If it is happening often, reach out to the developer for support.</note>
-I haven't done a lot of work to check that the downloaded status gets cleared properly if the project is changed, though it does get cleared if the export is reset. I should probably also clear it on export, and will add that to a future update soon. For now, if you download using the batch downloader and then find you need to edit a project further, you can manually set the status on the project page to either unmark it or mark for download again.
+Now all the files have been downloaded to the ''projects'' subfolder on your computer. You can now clear the downloads from the QA Account.
-Sorry about the manual steps here. There will likely be another manual download after I get the updater working, but that won't be immediate priority at the moment since I am going to document the producer's note feature and work on Laetitia's issue with the export page.
+To clear the downloads:
+  * Stay on the ''Manage Projects'' page and refresh your browser
+  * The status for all the titles will update to ''Downloaded''
+  * Navigate down to the ''Delete Downloaded Projects'' section
+  * There is now a list of all the titles you downloaded
+  * Select the ''Remove Downloaded Projects'' button
+  * This will remove the files from Converter Plus
-Steps:
+Here is a video tutorial on How to Manage Projects and Use the Batch Downloader.
-Move or delete any files out of the projects folder to make sure you don't lose any you've already downloaded.
+<note>You will have to manually upload all titles to our server via Cyberduck. There is limited access to the server, so this job is mainly for supervisor and coordinator positions.</note>
-I realized I was a bit unclear on the individual project pave versus the Manage Projects page that lists the status for all of them. When you use the mark for download option on an individual project page, it opens the Manage Projects page. The Manage Projects page is the one to refresh once the downloads are finished.
+<note>You can use the filter at the top to limit the listing to one of the following: All, Exported, Mark for Download, or Downloaded.</note>
-There's also a link to the Manage Projects page on the home page which you've likely seen already.
+<note>If a DAISY project is marked for download but then is modified, it won't be downloaded when you download the batch.
+</note>
+<note>When you run it, it creates a log file that lists the projects that are downloaded. This is overwritten each time it is run. You likely don't need to do anything with this in most cases unless something doesn't work properly, and then it may help to include the contents in a bug report. On the server, it also logs the list of projects that are available for download and when each is completed, but any errors in the client aren't sent back to the server.
+</note>
-The old downloader won't work anymore so you can delete the zip and extracted folder if you like.
+<note>There's no way to cancel a batch in progress except with a keyboard interrupt command, but you can leave the terminal window open in the background while you do something else.
+</note>
-Download the version from the website: go to Account menu > Batch Download Client and download the Mac version.
+Navigate back to
-Extract it.
-Right click removeQuarantine.command and choose open. You'll get a confirmation about running untrusted software. Allow it to run. You should get a terminal window with a message about removing the quarantine attribute.
-Close the terminal once it's done.
-The configuration is set to download from QA to the projects folder. You can change the path in copdl.ini if you want, otherwise leave as is.
-Double click copdl and it should start downloading files.
-The removeQuarantine step only needs to be done the first time after you extract it. You can just run copdl the next time and it should download the next batch.
-Let me know if you have any trouble with it.

User Tools

Differences

Page Tools

BC Libraries Coop wiki

Site Tools