Getting Started: Difference between revisions

From iDigBio
Jump to navigation Jump to search
No edit summary
 
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Appliance]][[Category:CYWG]][[Category:Image ingestion]]
[[Category:Appliance]][[Category:CYWG]][[Category:Image ingestion]]


== Signing In with Your Account Information ==
The Documentation for the idigbio media applaince has been moved to the [https://github.com/iDigBio/idigbio-media-appliance/wiki GitHub repository] for the new version.
* If this is the first time you are using this application, you need to log in with your iDigBio Account UUID and the API Key. You may request the login combination from iDigBio. You can get a account UUID / API key pair by [[https://www.idigbio.org/wiki/index.php/CYWG_iDigBio_Image_Ingestion_Appliance#How_can_I_get_the_account_UUID_and_API_key_pair.3F following this]].
* Fill in your login information in the dialog box after you launch the application, as shown below.
<center>[[File:sign_in.png | 500px]]</center>
* Once you have successfully signed in, your Account UUID and API Key are saved on your computer and you don't need to sign in again next time you open the appliance.
 
== Image Ingestion Tool at a Glance ==
<center>[[File:main_page2.png|550px]]</center>
* Upload via CSV : Upload media files using a CSV file.
* Upload History : View the history of previous uploads from user's computer.
* Generate CSV : Create a CSV file for the images in a folder.
 
== Image Ingestion Procedures ==
# At first, you want to make a CSV(Comma Separated Value) file. CSV should contain the information about the media files that you are about to upload. We recommend to use the "generate CSV" tab, if you are not aware about a CSV file.
# After the CSV file is ready either by manually or by the generation, you can upload media files through "Upload via CSV" tab.
# You can always check the previous uploads through the "Upload History" tab.
* Hereafter, we present an example of uploading bunch of image files from the folder is presented in a step by step manner. It consists of two steps. One is generating a CSV file and then uploading image files with CSV file.
 
=== Generate a CSV File ===
* At first, click the "generate CSV" tab.
<center>[[File:generate_csv_0.png | 500px]]</center>
* When you type in the path of the folder, it would be easier to copy the path from the address bar.
<center>[[File:generate_csv_1.png | 500px]]</center>
* Then you specify the GUID syntax. If you are not aware about the difference among the drop down menu, you can simply use "hash of the record information". Finally, you type in the destination path to which the CSV file is stored.
* A complete list of all fields in the CSV file can be found here: [[Input CSV Format]].
 
=== Upload Images using a CSV File ===
* Now you upload folder of images through CSV file. At first, you specify the image license and record set GUID. Then type in the path of CSV file that you created. Finally, you click the upload button.
<center>[[File:upload_via_csv_0.png | 500px]]</center>
* On successful upload, you should see the result similar to the one shown below.
<center>[[File:success_result.png | 500px]]</center>
 
=== Resuming a Failed Upload Batch ===
* If not all the images in the batch are successfully upload, you would see table of which what media is failed to upload.
<center>[[File:falure_result.png | 500px]]</center>
* To continue the batch, just click the yellow "Retry failed upload" button. Note that the previously uploaded images are "skipped" (as shown above the progress bar).
 
=== Show the History of Previous Uploads ===
* When you click on the <b>"Upload History"</b> tab, you will see all the previous upload batches shown like this.
<center>[[File:history_0.png | 500px]]</center>
* See the details of each upload batch by clicking on each of entries.
<center>[[File:history_1.png | 500px]]</center>
== Go Back to Appliance Main Page ==
* [[CYWG iDigBio Image Ingestion Appliance]]

Latest revision as of 10:41, 13 September 2016


The Documentation for the idigbio media applaince has been moved to the GitHub repository for the new version.

Retrieved from "http://www.idigbio.org/wiki/index.php?title=Getting_Started&oldid=21875"