Admin Interface
Intro
In every DocViewer environment, there is an Admin Panel that provides an interface for adding new documents and managing existing documents. The Admin Panel is automatically spun up when you bring up the project, so it is available when you run the project locally at canvadocs.docker/admin.
Adding a Document
You may want to load test documents in DocViewer, to experiment with features, try and replicate a problem, etc. The Admin Panel supports adding documents either by URL or by direct upload.
- Click "Add Document"
- Select either "File Upload" or "URL" and fill out and submit the form
- You will be redirected to an information page for the document you added
- Wait a couple seconds for the conversion to finish before viewing the document
Viewing a Document
On a document's information page (reached by clicking the document ID in the Recent Documents list, adding a document, or searching for a document) beneath the PDF.js label there are three options for viewing the document:
- View: View the document in annotations disabled mode
- View with annotations: View the document in readwrite mode
- View with annotations as Admin: View the document in manage mode
- Custom Session: In this view you can annotate with a custom account, submiting the data for the account you wish to act as manage mode
Please note that annotations created in other settings (i.e. Canvas Speedgrader) will not be shown when viewing a document from the Admin Panel, and visa versa. See the context page for more details.
Re-rendering a Document
From time to time, there are improvements to our document conversion. If there is a document that was converted poorly, and you believe a recent update to our conversion service may do a better job, you may wish to re-render the document.
For instructions on getting Document IDs and Source URLs from Canvas, please see the Re-rendering Canvas Files page.
If you have several (or many, or even lots) of documents to re-render, there is an Re-render API endpoint to facilitate this.
To re-render a document:
- Go to the Admin Panel for the correct environment
- Search for the Document ID. This should pull up the document information page
- Click "Rerender"
- If you believe LibreOffice may do a better job than Groupdocs (our standard converter), click "Rerender with LibreOffice"
- If the original Document URL that Docviewer was given has expired:
- Click "New Source URL"
- Enter a new URL for the document, and press "Save"
- Proceed to "Rerender" or "Rerender with LibreOffice"