Adding documents to Paperight - Paperight/website GitHub Wiki
Document can be added to paperight.com in one of two ways. For both of these you will need to log in to paperight.com/server
1. By CSV
Once you have logged on to the server, select "New Import" under "Product Import" on the left hand side of the page. Select "choose file" and then select the CSV you want to upload. Click open. The name of the file will now show next to "choose file" and you can click upload. It is possible that there were some errors in the CSV that will stop some titles from uploading. You need to check and fix these by clicking on "History". If there are no errors the Status will reflect as COMPLETE. If there are errors it will say COMPLETE_WITH_ERRORS. Click on "view errors" to see what needs to be changed.
Some common errors:
- All fields of the CSV must be filled in correctly. Not all of the fields are required but others are including identifier and file name.
- file name not exactly the same as on FTP site
- Make sure that there are no separate paragraphs in the long and short descriptions.
Make the corrections to the CSV before re-uploading the it. Repeat the process until the Status says COMPLETE. This can take a few tries. Check the titles you have just uploaded for strange characters that may appear.
2. By individual upload
On the server click "New Product" under "Products". Fill out all of the information relating to the book you are uploading.
Select the availability of the item from the drop down menu. You can choose to make the item available as “On Sale” or “Embargoed”. If you select “On Sale” users of the site will be able to see the product page, download a preview, and buy the product. If you select “Embargoed” users will still be able to see the product page but they will not be able to purchase the product. They will see a notice saying “We're sorry, This book is not for sale at the moment. Please contact us if you need more information.”
Next you can select whether this is a premium product or not.
If you decide you want to upload the product to the site but don't want it to be visible to users you can tick the “Disabled” tick box. If at some point you decide you want to make this product available for download you simply have to uncheck this option.
If a publisher is inactive you can check the "Publisher inactive" box. This has the same effect as disabling the product.
If the full text of this product is not available for download, and it is only available for photocopy licence you need to check the box which says “Photocopy licence”
Fill in the rest of the metadata and when you are done click "Reset page extent and update"
3. Using the Bulk Uploader
Assets (PDF and HTML files) and jacket images (JPG and PNG files) must be uploaded to Paperight via FTP.
Metadata (CSV files) can be uploaded via server UI, or uploaded to Paperight via FTP.
- Metadata must be placed in the “product_file_uploads” folder, e.g.
/product_file_uploads /2014-08-17.csv - Assets must be placed in the “bulk_data” folder, e.g.
/bulk_data/9780801448157.pdf - Jacket images must be placed in the “bulk_data” folder, e.g.
/bulk_data/9780801448157.jpg
Asset and jacket image files must be uploaded before uploading your metadata.
If you upload the metadata first, it will be processed, and assumed to be a metadata-only import.
NOTE: Only one jacket image should be uploaded per asset.
NOTE: Metadata uploaded via FTP, or through Server UI, will only be processed after file was last written a minute or more ago. This is to prevent the processing of metadata during a manual upload.
Metadata formats
Paperight accepts your data the following formats:
- CSV File
Paperight recommends using CSVed 2.3.0 (http://csved.sjfrancke.nl/) to author your CSV files. It is NOT recommended to use Microsoft Excel to author your CSV files.
The table below describes the header columns required for the CSV file.
The CSV header must be included in your file. I.e. Your actual metadata starts on line 2.
The CSV header must include all columns.
| Name | Description | Example |
|---|---|---|
| COPYRIGHT_STATUS | ||
| IDENTIFIER | The product’s identifier | 9780801448157 |
| IDENTIFIER_TYPE | Identifier type | ISBN |
| PUBLISHER | The product’s publisher | Random House |
| TITLE | The title | Lord of the Rings |
| SUBTITLE | The subtitle | Two Towers |
| ALTERNATIVE_TITLE | An alternative title | |
| PRIMARY_CREATORS | Primary creators | JRR Tolkien; Bob Smith |
| SECONDARY_CREATORS | Secondary creators | Mr Min; George Smith |
| EDITION | The products edition | 1st, First, Revised, etc |
| PRIMARY_LANGUAGES | The product’s primary language | English |
| SECONDARY_LANGUAGES | The product’s secondary language | 19820426 |
| SUBJECT_AREA | Category/Genre/Subject | Fantasy |
| PUBLICATION_DATE | Date the product was published. Format: yyyy-MM-dd | 1980-12-23 |
| EMBARGO_DATE | Date the product can be sold. Format: yyyy-MM-dd | 1980-12-23 |
| LICENCE_FEE_IN_DOLLARS | Number of dollars | 5 |
| SHORT_DESCRIPTION | Short description | This is a short description |
| LONG_DESCRIPTION | Long description | This is a long description |
| PARENT_ISBN | Parent ISBN | true/false |
| ALTERNATE_ISBN | Alternate ISBN | 9788135131351 |
| AUDIENCE | Audience | Guitarists |
| DISALLOWED_COUNTRIES | Semi-colon separated ISO country codes where book may not be sold. | AU;NG |
| TAGS | Tags | VS, VSB |
| URL | ||
| URL_CALL_TO_ACTION | ||
| SUPPORTS_ADS | ||
| SAMPLE_PAGE_RANGE | ||
| LICENCE_STATEMENT | ||
| FORMATS | Semi-colon separated formats. Valid values: ONE_UP; TWO_UP; A5; PHOTOCOPY | ONE_UP; TWO_UP; PHOTOCOPY |
Files associated with metadata record
Filenames are inferred via the values of the field IDENTIFIER.
Images follow the same convention.
PDF files take preference over HTML files. That is, if the bulk_data folder contains a PDF file called 1234.pdf and an HTML file called 1234.html, and an import is done for IDENTIFIER 1234, the pdf file will be used in the conversion
Example
Asset file associated with this record will be 9780801448157.pdf/html.
Jacket image file associated with this record will be 9780801448157.jpg/png.
COPYRIGHT_STATUS,,IDENTIFIER, IDENTIFIER_TYPE, //snipped CSV header , 9780801448157, ISBN, //snipped other fields
##Product ownership
Once the upload is complete you need to assign the uploaded books to their respective publishers. Still on the server, click on "Product Ownership" under "Products" search for the publisher. Select the correct publisher. Scroll down. Under "assigned products" you will see a list of books that belong to that publisher that are already on the site. Scroll further down to "unassigned products". Select the books from the list that belong to the publisher you have selected, and click "assign". Those titles will move up to "assigned products". Do this for all of the books you have just uploaded so that no books are left unassigned.