Temporary Revisions and Supporting Documents
Last Updated on July 17, 2024 | 5 min read
Background
Temporary Revisions (TR) and Supporting Documents (SD) can be managed directly in the production (published) data or in the In-work copy of the CDR being revised.
- Supporting Documents (SD): These are supplementary materials attached to manuals or publications, providing additional information not officially approved as part of the primary documentation.
- Temporary Revisions (TR): These are urgent updates addressing immediate issues. TRs provide critical information swiftly and are usually incorporated into the next official document revision.
How to Add a TR or SD
- Select the
Temporary Revisions or
Supporting Documents icon from the top toolbar.
- Select the Create/Delete tab.
- Select whether to apply the TR/SD to the In-work or Production data by selecting the appropriate option from the Data Status drop-down list.
- Select an existing CDR from the CDR Name drop-down list. You can also type the CDR name, and the system will autocomplete and show results for quick reference.
- Select the
Expand icon or the manual name to expand the affected manual from the list of available manuals or publications.
- Click the CREATE BLOCK button or the + icon next to the manual name to load the TR/SD creation block (input form) and fill it with the required information:
- TR Details (SD Details): Input the details pertaining to the TR/SD.
- TR Number (only for TR): Unique number given to the TR for identification.
- SD Title (only for SD).
- Issue Date: Date the TR/SD was issued.
- Enter TR Reason: Reason for the TR/SD.
- File Upload: Upload the TR/SD file.
- Drag and Drop: Drag the file here to start the upload.
- Click to Browse: Click here to open your device’s file system. Choose the TR/SD file you want to upload.
- PB Details: Input the details pertaining to the affected page block.
- PB File Path: Select the path where the Page Block file is located. You can also type the path name, and the system will autocomplete and show results.
- PB File Name: Select the file within the selected path to the Page Block PDF file. You can also type the file name, and the system will autocomplete and show results.
- Page Block Title: Input the name or title to appear in the Affected Docs list within the Expanded TR/SD Block on the NIVOMAX Viewer.
- Section & Page Block (only for TR): Input the details to show under the Section and Page # within the Expanded TR Block on the NIVOMAX Viewer.
- Optional Fields: Customized fields specific to the ePubs Supplier.
- Select the radio button “01) Save Temporary Record(s)” and click the UPDATE button. Multiple TRs can be saved in the cache.
- Once all TRs/SDs are created and saved in the cache, select the radio button “02) Update CDR Data” and click the UPDATE button. This will process and incorporate them into the CDR, updating the NIVOMAX Web Viewer with the added TR/SD.
- Note: To create the downloadable ZIP archives for the Desktop and Network Viewers, you must build the required download archives (only if the TR is applied to the Production Data copy). See Building Downloads.
- Note: When working in production data, you can also apply the same TR/SD update to the In-work data copy.
How to Delete a TR or SD
- Select the
Temporary Revisions or
Supporting Documents icon from the top toolbar.
- Select the Create/Delete tab.
- Select whether to apply the TR/SD to the In-work or Production data by selecting the appropriate option from the Data Status drop-down list.
- Select an existing CDR from the CDR Name drop-down list. You can also type the CDR name, and the system will autocomplete and show results for quick reference.
- Select the
Expand icon or the manual name to expand the affected manual from the list of available manuals or publications.
- Click the
Delete icon to the right of the TR or SD block.
- Click the Yes button on the confirmation dialog box to delete the TR/SD record. Multiple TRs/SDs can be saved in the cache.
- Once all TRs/SDs are deleted and saved in the cache, select the radio button “02) Update CDR Data” and click the UPDATE button. This will process and remove them from the CDR and update the NIVOMAX Web Viewer accordingly.
Note: To create the downloadable ZIP archives for the Desktop and Network Viewers, you must build the required download archives (only if the TR is applied to the Production Data copy). See Building Downloads.
Update In-Work with Production TR / SD
This option can be used to update the In-work copy with all the TR/SD present in production.
- Select the
Temporary Revisions or
Supporting Documents icon from the top toolbar.
- Select the Update from Production tab.
- Select an existing CDR from the CDR Name drop-down list. You can also type the CDR name, and the system will autocomplete and show results for quick reference.
- Select the manuals by clicking the check box to the right of the manual name.
- Click the EXPORT button at the bottom of the list to begin exporting the TR/SD from the Production data copy to the In-work data copy.
Publishing TR / SD
- Create TR/SD in published data by following the steps above. Then go to Building Downloads and follow the steps.
- Create TR/SD in working data by following the steps above. This process should only be done during a revision. Once completed, run the Complete Processing Revision step and go to the Go LIVE menu to complete the publishing cycle of the revision.