This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2022/02/22 11:30] mn1a [Preparing and Running the Batch Job] |
preparing_books_and_magazines_for_use_with_gutenberg_and_klas_uids_e-documents [2022/09/13 10:43] mn1a [UID Locations] |
||
---|---|---|---|
Line 4: | Line 4: | ||
In most cases, books and magazines should be formatted for use with Gutenberg if NLS guidelines for metadata are followed during resource creation. However, in some cases it may be necessary to reformat older book and/or magazine Unique Identifiers (UIDs) to enable use with Gutenberg and KLAS. | In most cases, books and magazines should be formatted for use with Gutenberg if NLS guidelines for metadata are followed during resource creation. However, in some cases it may be necessary to reformat older book and/or magazine Unique Identifiers (UIDs) to enable use with Gutenberg and KLAS. | ||
- | Additionally, | + | Information on the formatting process is contained in the following sections.(( Information in this guide is primarily based on procedures/ |
- | Information on the above topics is contained within the sections below.(( Information in this guide is primarily based on procedures/ | ||
= UID Locations = | = UID Locations = | ||
- | In order to enable recognition by Gutenberg and KLAS, formatted UIDs must be added to/appear in component files (.opf, .ppf, etc.) in 10 specific locations. | + | In order to enable recognition by Gutenberg and KLAS, formatted UIDs must be added to/appear in 10 specific locations of component files (.opf, .ppf, etc.). |
- | The ten locations and their associated file extensions have been listed in the table below. Each location can be changed manually by opening the files in a text editor (such as [[ https:// | + | The ten locations and their associated file extensions have been listed in the table below. Each location can be changed manually by opening the files in a text editor (such as [[ https:// |
- | Automation/partially | + | Automation/partial |
Line 29: | Line 28: | ||
- | = UID Format = | ||
- | Formatting examples are included in each of the sub-sections below. | + | |
+ | Formatting examples are included | ||
== Book UIDs == | == Book UIDs == | ||
Line 50: | Line 49: | ||
''' | ''' | ||
- | * For magazines, formatting | + | * For magazines, |
- | * Examples in the following sections assume that issue names in the Issues tab are formatted as <tt>YYYY_MM | + | * Examples in the following sections assume that Issue names in the Issues tab of the KLAS Serials module |
Line 75: | Line 74: | ||
= Uploading Books to Gutenberg = | = Uploading Books to Gutenberg = | ||
- | After fixing | + | After the UID has been properly formatted, simply adding the book or magazine to the <tt>Local Books</ |
In some cases, an E-Document may not be generated automatically. While this can be caused by UID formatting errors, it can also occur even if the UID has been formatted correctly. In these cases, it may be necessary to manually create an E-Document and its associated E-Package. For more information on the process, please refer to '' | In some cases, an E-Document may not be generated automatically. While this can be caused by UID formatting errors, it can also occur even if the UID has been formatted correctly. In these cases, it may be necessary to manually create an E-Document and its associated E-Package. For more information on the process, please refer to '' | ||
- | = Synchronize Gutenberg | + | = Synchronize Gutenberg |
- | New E-Documents are often available in KLAS approximately 24 - 48 hours after .zip files are uploaded to Gutenberg. However, in some cases, quickly confirming that E-Documents have been successfully generated may be desirable, and the KLAS Batch Manager enables users to run the process on demand. | + | New E-Documents are often available in KLAS approximately 24 - 48 hours after .zip files are uploaded to Gutenberg. However, in some cases, quickly confirming that E-Documents have been successfully generated may be desirable. The KLAS Batch Manager enables users to run the process on demand. |
''' | ''' | ||
* Running the KLAS Batch Manager may require elevated user privileges. | * Running the KLAS Batch Manager may require elevated user privileges. | ||
- | * For Keystone-hosted libraries, it may take approximately 24 hours after new contents have been added to the Gutenberg workstation before | + | * For Keystone-hosted libraries, it may take approximately 24 hours after new contents have been added to the Gutenberg workstation before |
- | * UID formatting, correspondence (within tolerance) between file names in KLAS and UIDs, and other system-level considerations may also be necessary to enable E-Documents | + | * UID formatting, correspondence (within tolerance) between file names in KLAS and UIDs, and other system-level considerations may also be necessary to enable |
== Displaying the KLAS Batch Manager == | == Displaying the KLAS Batch Manager == | ||
Line 101: | Line 100: | ||
== Preparing and Running the Batch Job == | == Preparing and Running the Batch Job == | ||
- | When the KLAS Batch Manager is opened by a user for the first time, many of the fields may be empty. In this case, please proceed in order through the steps below. Users that have already worked through the steps for ' | + | When the KLAS Batch Manager is opened by a user for the first time, many of the fields may be empty. In this case, please proceed in order through the following |
\\ | \\ | ||
\\ | \\ | ||
Line 140: | Line 139: | ||
In the event that an E-Document is not generated after a book file has been uploaded to the Local Books directory on the Gutenberg workstation, | In the event that an E-Document is not generated after a book file has been uploaded to the Local Books directory on the Gutenberg workstation, | ||
- | The procedures for creating E-Documents (and associated E-Packages) are explained in the sections | + | The procedures for creating E-Documents (and associated E-Packages) are explained in the following |
''' | ''' | ||
- | * In some cases, manually created E-Documents may not be recognized, especially in cases where the Issue title is changed | + | * In some cases, manually created E-Documents may not be recognized, especially in cases where the Issue Title is manually |
* Using the KLAS Batch Manager to Synchronize Gutenberg Edocs prior to attempting to manually create an E-Document is recommended. | * Using the KLAS Batch Manager to Synchronize Gutenberg Edocs prior to attempting to manually create an E-Document is recommended. | ||