LibreOffice Wire Protocol

The LibreOffice plugin uses a simple wire protocol to communicate with Zotero. (The Word for Mac and Word for Windows plugins both run in process, and use AppleEvents and COM respectively to communicate with the word processor.) The below documentation applies to Zotero 6.0 and newer.

The Zotero client process operates a server on port 23116, which the extension residing within LibreOffice connects to. All frames consist of a 32 bits specifying the transaction ID, a big-endian 32-bit integer specifying the length of the payload, and the payload itself, which is either UTF-8 encoded JSON or an unescaped string beginning with “ERR:”.

There are two types of commands: integration command, sent by the word processor to Zotero initiate an operation (e.g., to add a new citation), and word processor commands, sent from Zotero to the word process to retrieve data from a document or to make changes to the document. Integration commands are sent from the word processor to Zotero, and must never receive a response. Word processor commands are sent from Zotero to the word processor, and must always receive a response.

The transaction ID allows Zotero to determine whether the given frame is a response to another frame. When the client sends an integration command, it must send 0 as the transaction ID. Word processor commands always specify a non-zero transaction ID, and the response to these commands must maintain the same transaction ID.

In order to add a citation to a document, LibreOffice sends the following:

                TRANS ID    LENGTH      PAYLOAD
HEXADECIMAL     00 00 00 00 00 00 00 0C 22 61 64 64 43 69 74 61 74 69 6F 6E 22
INTERPRETATION  0           11          {"command": "setDocPrefs", "templateVersion": 1} 

Zotero then responds by asking for the active document, and supplying the API version it supports:

                TRANS ID    LENGTH      PAYLOAD
HEXADECIMAL     00 00 00 01 00 00 00 24 5B 22 41 70 70 6C 69 63 61 74 69 6F (...)
INTERPRETATION  1           36          ["Application_getActiveDocument", 3]

The client then sends a response consisting of the API version it supports and the document ID:

                TRANS ID    LENGTH      PAYLOAD
HEXADECIMAL     00 00 00 01 00 00 00 24 5B 33 2C 20 31 5D
INTERPRETATION  1           6           [3, 1]

You can observe frame payloads sent between Zotero and LibreOffice in the Zotero debug output.

These commands are sent from the word processor to Zotero, and do not receive a response. The command payload is always a JSON object with a `command` property, which is described below and a `templateVersion` property which is a number. The templateVersion number is used by Zotero to notify the integration user if the plugin installed in LibreOffice is outdated. The current up-to-date version is “1”.

An up-to-date command list is always available by looking at the methods of Zotero.Integration.Interface.

These commands are sent from Zotero to the word processor. They must always receive a response. The command payload is always JSON-encoded in the form

[COMMAND_NAME, [...PARAMETERS...]]

If the request is successful, the client must send a response with a JSON-encoded payload. This response is often null if the command returns no output, but may also be an array, an integer, a string, or a boolean value depending on the command.

If the request is unsuccessful, the client must send a response with the payload:

ERR:(Error string goes here).

Zotero will cancel the current operation, log this error, and present it to the user using the Document_displayAlert command if possible. If the subsequent Document_displayAlert command fails, Zotero will present the error using its own dialog box.

A full and up-to-date API of commands is available as part of Zotero Integration tests and |LibreOffice plugin code.

Gets information about the client and the currently active document.

Shows an alert.

(Integer) The index of the button pressed, according to the value of buttons sent as a parameter.

OK = 1

CANCEL = 0
OK = 1

NO = 0
YES = 1

CANCEL = 0
NO = 1
YES = 2

Brings the document to the foreground. This is a no-op on non-Mac systems.

null

Indicates whether a field can be inserted at the current cursor position.

(Boolean) Whether a field can be inserted.

Stores a document-specific persistent data string. This data contains the style ID and other user preferences.

(Array)

null

Retrieves data string set by setDocumentData. NOTE: If the document has been converted to the transfer format and the first line of the document reads “ZOTERO_TRANSFER_DOCUMENT”, then this method should return “ZOTERO_TRANSFER_DOCUMENT”.

(String) The document data string or “ZOTERO_TRANSFER_DOCUMENT”

Indicates whether the cursor is in a given field. If it is, returns information about that field.

Either null, indicating that the cursor isn't in a field, or (Array)

Inserts a new field at the current cursor position.

(Array)

Inserts rich text (HTML) at cursor position. The rich text may contain citation placeholder hyperlinks (to https://www.zotero.org/?[placeholderID]) which are later converted to citations via Document_convertPlaceholdersToFields.

null

Get all fields present in the document, in document order.

(Array)

Converts all fields in a document to a different fieldType or noteType. Called upon style change from a an in-text to note type or vice-versa

null

Converts placeholders (which are text with links to https://www.zotero.org/?[placeholderID]) to fields and sets their field codes to strings in `codes` in the reverse order of their appearance

Array of fields after conversion

(Array)

Called to convert Zotero document transfer format links to fields after Document_getDocumentData returns “ZOTERO_TRANSFER_DOCUMENT”. Should reverse the export procedure. Note that citation links may contain trailing parameters, e.g. “https://www.zotero.org/google-docs/?q15df3”

`true` if field links and document data were found and imported, `false` otherwise

Converts the document to the Zotero transfer document format. The format is: 1. Insert 4 paragraphs at the beginning of the document, where first one reads “ZOTERO_TRANSFER_DOCUMENT” and third one has the `transferDocumentInstructions` supplied via a parameter. 2. Convert all citations to links that point to “https://www.zotero.org/” and the link text is set to the citation code. 3. At the end of the document insert a link that points to “https://www.zotero.org/” with the text set to documentData.

null

Provides parameters for the dedicated bibliography formatting style (usually called “Bibliography”).

[1, -720, 720, 240, 0, [], 0]
[1, -720, 720, 240, 0, [1], 720]

null

Indicates that the given documentID will no longer be used and associated resources may be freed.

null

Deletes a field from the document (both its code and its contents).

null

Moves the current cursor position to encompass a field.

null

Removes the field code from a field, leaving it as plain text.

null

Sets the (visible) text of a field.

null

Gets the (visible) text of a field. Note that any RTF information from setText is not returned, just the visible plaintext.

(String) The (visible) text

Sets the (hidden, persistent) code of a field.

null

Converts a field from one type to another.

null