Book Submission Process
Books may be submitted by SFTP, using the browser-based Upload Portal (HTTPS), or via a distribution agency (contact content@oreilly.com for more information).
SFTP Uploads
Connect to the SFTP using the hostname sftp://upload.oreilly.com
. If you need a username and password created, please contact content@oreilly.com.
Content should be delivered to the root folder of your SFTP account by uploading the individual asset files (epub and cover) first. When those files have fully finished loading, the metadata XML file should be added. The metadata file is required for ingestion of a submission and is the file that signifies a title is ready to be grabbed by the upload process.
Warning | Adding the metadata file before the other files are finished loading could result in a partial upload of the title. |
File Naming
The filename of the submitted book files should match the FPID, referred to in the metadata XML file, along with a file extension appropriate to the file’s format. The filename convention is FPID.ext
so that the system knows which FPID to associate them with. Here are a few additional file-naming requirements:
-
case sensitive
-
cannot contain any spaces
A file named 12345CMSDEMO.epub would be fine but 12345CMSDEMO .epub or 12345cmsdemo.epub are not.
Each asset file should be named according to the FPID described within the metadata. There are three file types:
FPID.xml
-
This is the metadata file that provides book title information.
FPID.jpg
-
This is the cover image for the title.
FPID.epub
-
This is the epub book file.
For example, a submission of a book of the FPID 12345CMSDEMO is outlined below:
-
12345CMSDEMO.xml
-
12345CMSDEMO.jpg
-
12345CMSDEMO.epub
Warning | After the cover and book files are uploaded, the FPID.xml file should be uploaded. |
Portal UI Uploads
Log in to https://upload.safaribooksonline.com/safari-portal with your username and password. These are the same credentials used for the SFTP.
For full instructions on using the portal UI, see the Portal Submission Guide.
Ingestion Process
After you’ve submitted a new product to the O’Reilly Learning platform, our systems will process the submitted files, check for validity, and prepare the content for availability. Uploaders are encouraged to check that their submissions are successful and make any necessary changes or updates.
Confirm the Title Was Uploaded Successfully
Once the system has received all the required files, it will begin to validate the metadata and run EPUBCheck 5.1.0 on the epub file.
To tell if the submission was successfully ingested, you can log in to the portal at https://upload.safaribooksonline.com/safari-portal and look at the Portal Home page. Anything listed as “Failed QA” was successfully recognized but had a problem that needs to be fixed before we can continue the title along the ingestion process. To see what the error is (and fix it immediately) you can click on the Edit button next to the status. The red banners at the top of the page will tell you what was wrong with the submission.
Note | If you prefer to fix the submission via the SFTP, you’ll need to reload all of the title’s assets, not just the broken one or the metadata file. |
When a title has a status of "Submitted" it means that the file has been ingested and passed our automated QA checks to make sure the files are valid.
Logging
Error logging of past submissions is available in the Upload Portal. When you submit a title, you will be able to see it in your list of past submissions. Click the "View" or "Edit" link the the right of the submission listing as shown here:
When you click that link, you will see a page that calls out the specific errors with your submission:
Logging is also available for files delivered via SFTP.
New Title Acceptance
Submissions that pass automated validity checks are made available on the new O’Reilly Learning platform immediately following the completion of ingestion. This process can take only minutes to several hours dependent upon the size/complexity of the submitted work and general system load.