Document Integration

2025-12-28 01:12:45
Sanplex Content
29
Last edited by WANG JING on 2025-12-28 01:34:05
Share links
Summary : Sanplex Standard+ integrates Collabora and LibreOffice to preview/edit attachments online and compare document versions.

In Sanplex Standard and above (including Premium and Enterprise), Sanplex integrates Collabora Office. After Collabora Office is configured, users can use Collabora Online to preview and edit documents online. This integration supports online preview of attachments and document version comparison.

1. LibreOffice Online Preview

The online preview feature requires LibreOffice to be installed on the host where Sanplex is deployed.

Note: Do not install LibreOffice in a directory path that contains spaces or non-ASCII characters (for example, Chinese characters).

LibreOffice download: https://www.libreoffice.org/download/download/

After installing LibreOffice, enable the feature in Admin > System Settings > Office, and provide the path to the LibreOffice conversion program.

The path shown in the figure is an example for Windows. On Linux, enter a path similar to /usr/bin/libreoffice6.4 (use the actual executable name on your system).

On Windows, the copied LibreOffice path may look like D:\LibreOffice\program\soffice.com. You must change it to D:/LibreOffice/program/soffice.com before filling it in.

图1

After the configuration is enabled successfully, you can preview documents online. Attachments added under Requirements, Tasks, Bugs, Test Cases, and other modules can be opened directly by clicking the attachment to view its content.

2. Collabora Office Online Preview and Editing

2.1 Install Collabora Office

Install Collabora Office first, then configure its URL in Admin > System Settings > Office.

Choose the installation method that fits your environment: https://www.collaboraoffice.com/code-install-and-test/

2.2 Configure Collabora Office

2.2.1 To use Collabora Office, Sanplex must be accessed via PATH_INFO

  • Configure pseudo-static (URL rewrite) support in the installation/runtime environment so URLs can be rewritten.
  • In the Sanplex config directory, change the request type in my.php from $config->requestType = 'GET' to $config->requestType = 'PATH_INFO'.
  • After the change, restart the Sanplex service.
  • When Sanplex uses the GET access mode, the Collabora Office settings are hidden by default under Admin > System Settings > Office. They become visible only when PATH_INFO is enabled.

2.2.2 The Collabora Office path supports URL only

  • Collabora Office and Sanplex can be installed on the same server or on different servers.
  • The Collabora Office URL is typically https://<server-ip>:9980. The default port is 9980 (unless a reverse proxy is used).
  • The Sanplex server and the Collabora Office server must be network-reachable from each other.

2.2.3 Supported formats for online editing

Collabora Office currently supports online editing for: .doc, .docx, .xls, .xlsx, .ppt, .pptx.

After editing and saving, the document is updated directly. Other file types are supported for online preview only.

图2

2.3 Collabora Office Online Editing Example

Using a Word document as an example, this section illustrates online preview and editing.

Click a document attachment (for example, About Sanplex.doc).

图3

Collabora Online opens the document in preview mode.

Note: In Admin > General > Attachments, enable the permission for Attachment Editing (Rename); otherwise, the Edit button will not be shown.

图4

图5

Click Edit in the upper-right corner of the preview page to enter edit mode. Enable Edit > Track Changes > Record so that edits are recorded under the current Sanplex user account.

图6

After editing, changes made by different users are shown on the right side as tracked-change annotations. You can accept or reject each change. Once accepted or rejected, the corresponding annotation disappears.

After saving and exiting, the changes are automatically recorded and saved back into the original document.

图7

3. Create Word, PPT, and Excel Documents

Starting from Sanplex Standard and above, Sanplex supports creating Word, PowerPoint, and Excel documents directly.

图8

You can create documents in My Space, Product Space, Project Space, API Space, and Team Space, and choose Word / PPT / Excel as the document type.

图9

By default, Sanplex creates an empty Word/PPT/Excel document. On the document details page, click the document title to open the online preview page.

图10

4. Create Wiki Documents

Sanplex Standard and above supports Wiki documents. You can create Wiki documents in each space.

图11

5. Create Word, PPT, and Excel Documents (Enhanced Creation Entry)

In My Space, Team Space, Product Space, and Project Space, you can create Word, PPT, and Excel documents.

图12

图13

Sanplex creates a Word/PPT/Excel document by default. On the document details page, click the document title to open the online preview page.

图14

Write a Comment
Comment will be posted after it is reviewed.