READynamic

Integrating READynamic into your local environment

We provide here a high-level summary for integrating READynamic into your local eBook retail or business platform.

Auditing your environment before installing READynamic

Before you install READynamic:

  1. Check the system requirements under “Installing the Software.”
  2. Check for applications that you are currently running on your system that might need to be updated or replaced to avoid conflicts. When you install READynamic, you might be buying the product to replace another eBook platform. Or you might simply be a new process in your server environment. Either way you should consider how you might need to reconfigure your systems to work with READynamic.
  3. Review your workflow related to managing eBooks. If you are using custom batch processes and running scripts when adding or removing accounts related to eBooks, or buying, adding, or removing eBooks, or generating reports, you might need to update them to make sure that they will work with the new READynamic environment.

The user environment

READynamic supports EPUB3 and PDF documents.

A Reader account in READynamic would be limited to reading eBook content. A Reader may be granted permission to access individual eBook titles directly, or made part of a group. In that case the Reader can access any eBooks assigned to the group (that the group has permission to read). A group could refer to a college class, for example, or to a department in a company.

The Uploader, or Publisher, is the account that is authorized to upload eBooks into the local READynamic environment. This can be an administrator or an account created by an administrator and granted the authority to add eBook content.

Commonly a READynamic administrator would buy eBooks using the web site of an online book vendor. The vendor would offer a shopping cart or checkout system where a user could log on, browse through titles, and purchase books. READynamic would be integrated into the online store platform so that books purchased from the store could be accessed and read using the READynamic portal.

The online store must enable Single Sign On using OAuth2, and must be able to upload existing eBook titles into READynamic to make them available to READynamic users.

See Description of User Roles.

Using your own portal in place of the READynamic user portal

Many READynamic users can open and display eBooks in browser windows or on mobile devices. They access EPUB or PDF documents managed by READynamic by logging on to the READynamic user portal, or will access the READynamic portal using a mobile app designed for that purpose.

But some clients do not want their users to log on to the READynamic user portal. Some colleges or universities might want their students to download eBooks using a web page accessed through their university web site, and branded to match. Or a business might want their employees or customers to access READynamic eBooks through their own custom portal or online bookstore.

You can launch a Reader to view content directly from your own web service, bypassing the READynamic user portal. You can also provide a user access to an eBook using a custom mobile client you provide, or redirect the reader to display eBook content in an iFrame. An iFrame is an embedded window within the current screen. This is helpful if the reader wants to be able to look at pages within an eBook while still having access to other options on the screen. For example, a student might open her account page in the local Learning Management System and open an eBook text to look at an assignment, while also participating in an online discussion with other members of the class on a recent lecture and accessing the library web page to search for an article using an online vendor database tool.

This sample JavaScript code demonstrates how to redirect a user so that he or she does not access the READynamic user portal, but is redirected to your own custom platform.

The sample code opens with the function “buildURL.” This function creates the web address to use when redirecting the READynamic system to display content on your own web site. To build the URL to use you will need to provide your web domain, the server directory structure where the READynamic software is stored, the ID code for the eBook in question, and the annotation set or version, if any.

The program might build a custom URL that looks like this:

http://boxcollege.readynamic.com+3009+2254

This directs the page to find book #3009 with annotation #2254.

Note the Hide statement at the end of the sample code:

hide([UIUpload, UICreate, UIGrant, UIAccess]);

This function blocks the READynamic user portal from appearing.

The sample code is provided below.

$("#read").click(readBook);
function readBook(event) {
      function buildURL() {
            var url = domainUrl;
            url += "/readynamic/";
            url += state.book.bookID;
            url += "/annotation_sets/";
            url += state.book.versionID;
            return url;
      }
      function loginAsClient() {
            var url = domainUrl + "login.json";
            var clientEmail = state.user.email;
            var clientPassword = state.user.password;
            var data = {"login": clientEmail, "password": clientPassword};
            function success(data) {
            }
            $.ajax({
                  url: url,
                  data: data,
                  type: 'POST',
                  xhrFields: {
                        withCredentials: true
                  },
                  success: success,
                  error: error
           });
     }
     var url = buildURL();
     loginAsClient();
     window.open(url);
     hide([UIUpload, UICreate, UIGrant, UIAccess]);
}

Uploading bulk documents

We recommend that the local READynamic administrator upload eBooks into your system, create groups, assign individual users to groups, and grant permissions to access eBooks to groups and to individual users.

You can also access the upload feature using the READynamic user portal, and you can integrate the upload process into your back office workflow functions.

Purchasing content

When buying an eBook, a user would purchase the title through a an online store.

Note that with READynamic, in an academic setting, it is likely that faculty for various departments would select eBook titles that they want to assign to students in their classes for the coming term. These faculty would send these lists of titles to an administrative department, such as the Dean’s office. A staff member in that department would complete the purchases collectively on behalf of the faculty, and then distribute the eBooks after they are received. In a business setting, department or division heads may purchase eBooks for internal use, or all eBook purchases may be handled by a Human Resources group or purchasing department.

After the purchase is complete, the back office for the online store notifies READynamic that the purchaser has been granted access to the eBook. See Granting Access to a Restricted eBook.

The online store will display a “Read” link, replacing the former “Purchase” link for the eBook. Clicking on the Purchase link redirects the user to the browser based reader for READynamic. The link includes the ID code for the eBook. It might look something like this:

http://reader.storex.com/books/75658

Books may be granted temporarily to readers, in the form of a loan. See Book Lending.

Reading content

With READynamic applications, users may open and display eBook content directly or embedded in a frame.

With redirect, a user can click on a link on a browser or a mobile device and the eBook is redirected to a full screen reader view. The user can click Exit to return to the previous page.

Or the user can open an eBook in an iframe, embedded as a window within the current screen. This is helpful if the reader wants to be able to look at pages within an eBook while still having access to other options on the screen. For example, a student might open her account page in the local Learning Management System and open an eBook text to look at an assignment, while also participating in an online discussion with other members of the class on a recent lecture and accessing the library web page to search for an article using an online vendor database tool.

You can look up detailed information about reading behavior by looking at reading sessions.  See Retrieve a User’s Reading Sessions.

Building a custom READynamic eReader app for mobile devices

Included with READynamic is an eReader app designed to allow your users to open PDF or EPUB files on their iOS or Android mobile devices. If you like, we can brand your READynamic eReaders for you, including a color scheme and graphics files that include your logo and custom icons.

Contact your Datalogics customer representative, and we will send you a list of what we will need from you to complete your branded eReader apps. Note that this eReader app can only access a single site for downloading eBooks, and cannot be used to upload eBooks to another device or create customer accounts.

You may prefer to provide your own eReader app for use with READynamic instead. If you don’t have one already available, you can buy the READynamic Software Development Kit (SDK). This SDK includes the source code needed to build a custom eReader app.