SFTP file naming convention
- Tim Peterson
Instead of using the admin web interface, you can upload files via SFTP for ingestion. The ingest directory of the SFTP account is processed on regular basis. The files will appear in the ingestion list if properly processed. The file naming convention determines how the file is processed (see table below). If the file does not adhere to the naming convention, the ingestion associated with the file will be marked as failed.
Important:
Be certain to follow the general SFTP ingestion rules.
Product data must exist in the TitleLeaf database prior to ingestion of assets (eg, covers, spreads, ebooks) to be associated with the products. The assets are named by ISBN or proprietary_id. If TitleLeaf doesn't have the ISBN or proprietary_id in its database, then it will fail to ingest the asset, marking it as "unrecognized".
Create a support ticket for SFTP account credentials.
Jump to:
Data files
Templates for the data files listed below are available via Google Drive.
File Name | Ingestion Type | Description |
|---|---|---|
default.csv | Default | To create/update products and their associated formats. As indicated by the name, it is the most widely used template. |
awards.csv | Awards | To create/update awards conferred to products. |
assembly_assignments.csv | Assembly Assignments | Assembly is the internal TitleLeaf term for Sets. This file associates titles to sets. |
bestsellers-products.csv | Products Only | To define the sales rate of products. The sales rate is used to compose the best sellers list. |
bisac_subjects.csv | Bisac Subjects | Internal use only |
categories.csv | Categories | The internal TitleLeaf term for Subjects. |
categories_products.csv | Categories to Products | To associate products to categories. |
collections.csv | Collections | The internal TitleLeaf term for Series. |
common_core_ela.xml | Common Core ELA | Internal use only |
common_core_math.xml | Common Core Math | Internal use only |
contributors.csv | Contributors | To create/update contributors (eg, Authors, Illustrators, Editors, etc). |
contributor_assignments.csv | Contributor Assignments | To associate products to contributors. |
contributor_interviews.csv | Contributor Interviews | To associate interviews to contributors. |
editorial_reviews.csv | Editorial Reviews | To create/update editorial reviews. |
editorial_reviews_products.csv | Editorial Review Products | To associate products to editorial reviews. |
links.csv | Links | To create/update website links. |
links_products.csv | Link Products | To associate products to website links. |
postal_codes.csv | Postal Codes | To create/update postal codes. |
price_changes.csv | Price Changes | Internal use only. |
products.csv | Products Only | To update product data only (as opposed to product format data). See also default.csv. |
product_formats.csv | Product Formats | To update product format data only (as opposed to product data). See also default.csv. |
products_standards.csv | Product Standards | To associate products to standards such as the Common Core. |
related_product_assignments.csv | Related Product Assignments | To create a relation between 2 products. |
teaching_guides.csv | Teaching Guides | To create/update teaching guides. |
testimonials.csv | Testimonials | To create/update testimonials. |
Image files
File Name | Ingestion Type | Description |
|---|---|---|
DOE_JOHN_pic.jpg | Contributor Portraits | A photo of a contributor |
ISBN_fc.jpg | Front Covers | Stored on the Product level |
ISBN_fc2.jpg | Front Covers 2 | Stored on the Product Format level |
ISBN_int.jpg | Spreads | Stored on the Product level |
ISBN_int2.jpg | Spreads 2 | Stored on the Product Format level |
ISBN_bc.jpg | Back Covers | Stored on the Product Format level |
DESCRIPTION_web.jpg, DESCRIPTION_web.png | Web Images | Stored in the Image model |
Ebook/Draft files
File Name | Ingestion Type | Description |
|---|---|---|
ISBN_draft.pdf | Drafts | A draft file in PDF format containing multiple pages of the designated title. |
ISBN.epub | Ebooks | An Epub file to be distributed and sold. |
ISBN.mobi | Ebooks | A Mobi or KF8 file to be distributed and sold. |
ISBN.mp3 | Ebooks | A MP3 file to be distributed and sold. |
ISBN.wav | Ebooks | A WAV file to be distributed and sold. |
ISBN_ebook.pdf | Ebooks | A PDF file to be distributed and sold. Optionally (if requested during site setup), TitleLeaf will create an excerpt from the PDF file. |
ISBN_ebook_cvr.pdf | Ebook Covers | A one-page PDF file of the front and back cover combined. It should contain crop marks. Along with the interior, it is used to create a final, salable PDF ebook. |
ISBN_ebook_int.pdf | Ebook Interiors | A multi-page PDF file of the interior of a book. It should NOT contain crop marks. Along with the cover, it is used to create a final, salable PDF ebook. |
ISBN_excerpt.pdf | Excerpts | An excerpt file in PDF format containing multiple pages of the designated title. |
Other files
File Name | Ingestion Type | Description |
|---|---|---|
PID_ho.[txt|rtf|pdf|doc|docx|csv|xml|xls|xlsx|xltx|zip] | Handout Documents | A handout document. |
ISBN_bdy.txt | Manuscripts | A product manuscript. |
PID_tg.[txt|rtf|pdf|doc|docx|csv|xml|xls|xlsx|xltx|zip] | Teaching Guide Documents | A teaching guide document. |