Cameo Collaborator for Teamwork Cloud allows you to create a comment backup for a specific document. You can save the backup as a plain text file for future use, e.g, system recovery.

Prerequisites

In order to create a comment backup and import comments from the backup file, the comments must be stored in a document (not in the project).



To create the comment backup for a Cameo Collaborator document

  1. Use an HTTP client to send an HTTP GET request with the following URL and headers:

    • URL: https://<host>:<port>/collaborator/api/collaborator/document/<uuid>/branch/<uuid>/comments/export. Learn to find document and branch IDs (UUIDs) you need to add to the URL.

      Make sure that you replace the placeholders in the URL (between angle brackets (<>) with the actual data, e.g., Cameo Collaborator for TWC host, port, document, and branch IDs, etc.

    • Headers: Cookie, Connection, User-Agent. Learn to find headers for the HTTP request.
  2. Save the retrieved data as a plain text file.


The text file with retrieved data is your comment back up. You can use that backup to import comments to a Cameo Collaborator document published from the same project.


To import comments to a Cameo Collaborator document from the backup file

  1. Use an HTTP client to send an HTTP POST request with the following URL, headers, and body:

    • URL: https://<host>:<port>/collaborator/api/collaborator/document/<uuid>/branch/<uuid>/comments/import. Learn to find document and branch IDs (UUIDs) you need to add to the URL.

      Make sure that you replace the placeholders in the URL (between angle brackets (<>) with the actual data, e.g., Cameo Collaborator for TWC host, port, document, and branch IDs, etc.

    • Headers: Cookie, Connection, User-Agent. Learn to find headers for the HTTP request.

    • Body: the data you retrieved from an HTTP GET request when exporting comments from the document.

      When you specify the body of the HTTP request, select the raw data type and JSON data format.

  2. Reload the document to which you have imported comments.


After completing the above steps and reloading the document, the imported comments should be visible in the comments pane.

How to find document and branch IDs

When creating an HTTP request to import comments to a Cameo Collaborator document, you need to form a URL with document and branch IDs. The following steps explain how to find these IDs.


To find document and branch IDs

  1. In a web browser, open a network monitor in developer tools and go to the document from which you want to export comments.
  2. Select the "comments" HTTP request and locate Request URL in the request headers.
  3. Find the target document and target branch IDs in the Request URL.


How to find HTTP request headers

When creating an HTTP request to import comments to a Cameo Collaborator document, you need to know the Cookie, Connection, and User-Agent headers. The following steps explain how to find them.


To find Cookie, Connection, and User-Agent request headers

  1. In a web browser, open a network monitor in developer tools and go to the document from which you want to export comments.
  2. Select the "comments" HTTP request.
  3. Find the Cookie, Connection, and User-Agent request headers.