Crocodc Plugin 1.4
Description
Crocodoc plugin provides support of the Crocodoc service, posting service (HTML5) and annotation of Microsoft Office and PDF documents (https://crocodoc.com/)
This plugin requires JCMS 7.1.x.
Screenshots
1. Crocodoc viewer
|
Installation
Introduction
Crocodoc converts Microsoft Office and PDF documents to HTML5 so your users can view and collaborate right in a web app.
The Crocodoc plugin integrates the Crocodoc service into JCMS, posting service (HTML5) and annotation of Microsoft Office and PDF documents (https://crocodoc.com/). You can manage access rights to documents, annotations, comments.
Installation
Install Jalios Crocodoc plugin and restart JCMS.
Configuration
Crocodoc API Token
First, you must have a Crocodoc API token. If you don't have it, you can request an API token here.
If you can not remember it, you can find your API token in Dashboard.
Administration properties
Many options are available in the admin area of the plugin Crocodoc.
The following list of properties with descriptions:
| Property key | Description | Default value |
|---|---|---|
| Activated | Activate / Deactivate the Crocodoc plugin. If you deactivate the Crocodoc plugin, the viewer, rights management, starting and stopping of annotations, and historization of annotations are no longer available. |
Yes (Activated) |
| Crocodoc API Base URL | Base URL for all requests made with the Crocodoc API. This URL should not be changed unless the Crocodoc API were to change in the future. |
https://crocodoc.com/api/v2 |
| API token | API Token that you previously recovered. You need to paste your API Token in this field to be able to access the functionalities of the plugin. |
|
| Activate ESN Activities | If the ESN plugin is installed, the starting and stopping of annotations will be displayed in the activity stream. | Yes (Activated) |
| Quota | Maximum number allowed of uploaded documents to Crocodoc by month. If this number is reached at the end of the month, you can not upload other documents. Note: This number takes into account the uploads that have succeeded and those who have failed also. |
2500 |
| Accepted Content-Type | Content-Types for which you can use the Crocodoc plugin with the viewer in portrait mode. The Content-Types are separated with spaces or commas. | application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Accepted Content-Type for landscape orientation | Content-Types for which you can use the Crocodoc plugin with the viewer in landscape mode. The Content-Types are separated with spaces or commas. | application/vnd.ms-powerpoint, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Frame width in landscape orientation | Width in pixels of the viewer in landscape mode. | 800 |
| Frame height in landscape orientation | Height in pixels of the viewer in landscape mode. | 600 |
| Frame width in portrait orientation | Width in pixels of the viewer in portrait mode. | 600 |
| Height height in portrait orientation | Height in pixels of the viewer in portrait mode. | 600 |
| Activate Webhook notifications | Not implemented yet. | No (Not activated) |
Crocodoc ACL (Access Control Manager)
If you want to start Crocodoc annotations on a document, you must be a Member of a group with the ACL Crocodoc.
The Crocodoc ACL can be added as Global ACL or Workspace ACL.
Start Crocodoc annotations
After uploaded a Document or a DBDocument, go on the document fulldisplay and click on Annotate the document... in the right menu.
A modal dialog window opens.
You can add Members and Groups who will be allowed to annotate the document.
You can specify the level of visibility of annotations in the document.
You can notify by Alert all Members entitled to annotate.
Click the Annotate button.
A progress bar appears, representing the document uploading to Crocodoc.
When the upload is complete, the conversion of the document is then processed on the Crocodoc server.
If the upload of the document or the conversion of the document failed, an error message is displayed. You can view details error by clicking on the warning icon.
You can remove this error message by clicking on an error occurred or refreshing the page.
When the conversion is complete, the viewer is displayed. You can begin to annotate the document using the toolbar at the top of the viewer.
You can view the document in full screen mode by clicking the button at the top right of the viewer. 
Manage annotation rights
When the document is being annotated, click on Manage annotations rights...in the right menu.
A modal dialog window opens.
You can add or delete members and groups allowed to annotate.
You can also change the level of visibility of the annotations.
You can notify by Alert the new Members allowed to annotate.
Save annotation history
When the document is being annotated, You can save the annotations history at any time. To do this, click on Save annotation history....
The annotated document is downloaded from the Crocodoc server and a new PDF document containing the annotations will be created. It will be linked to the original annotated document.
Note: The historized document cannot be annotated.
Stop the annotations
If you want to stop the annotations, click on Stop the annotations... in the right menu.
A modal confirmation window opens.
You can stop and historize the current annotations, or just stop the annotations.
WARNING: if you stop the annotations, the annotated document can not be restarted with all the annotations already present. If you restart the annotations, Crocodoc will consider it as a new document and the annotation history will not be recovered.
Portlet
You can add a portlet that displays the documents on which the member attends as a manager or annotator.
You must enable the Crocodoc portlet in the Workspace. You can then create a portlet by specifying only the title of the portlet.
Statistics
In the Administration Area, you can access Crocodoc statistics.
The page of statistics presents as a graph the number of uploads of document to the Crocodoc server, per month or per year.
You can click on the graph for the details of the statistics.
The statistics are updated using a cron job that runs regularly. But it is possible that you display statistics while some annotated documents have not yet been taken into account in the statistics.
To manually update the statistics, you can click on one of the buttons Refresh the current month or Refresh all months...
