How to Use referenceData.fileKey for Inserting External Data

[yejin]

---

Do you want to: Ask a how-to question
Document Server version: 9.0.4(docker)

Additional information:

Hello,

I am trying to add a feature for referencing external data by following this document:

Inserting external data | ONLYOFFICE

However, I am a bit confused about the referenceData.fileKey described in the documentation.

According to the document, fileKey is referred to as a unique document identifier, with examples such as a key value:

Document | ONLYOFFICE

Of course, this may vary depending on how the integration is implemented, but I believe that when opening a document, additional information such as the document key or other details might be required. I thought this information could be stored in referenceData, but it seems that only referenceData.fileKey and referenceData.instanceId are actually recognized, while other fields are not reflected.

This makes me wonder whether I should include the required information inside referenceData.fileKey. At the same time, the way the documentation explains it gives me the strong impression that fileKey is intended purely as a unique identifier for retrieving the file link.

So, I would like to confirm: is it the correct and intended way in OnlyOffice to put additional information required for opening a document into referenceData.fileKey?

[Constantine]

Hello @yejin

The example of usage of this method in terms of IMPORTRANGE formula can be found here:

IMPORTANGE formula in spreadsheet

Thanks. I saw your PM, it does not contain any sensitive information, so I am providing information here. Question is related to the data that must be provided for onRequestReferenceData event. Event itself handles following parameters as in example: const link = event.data.link // Link to the source file const referenceData = event.data.referenceData // reference data for the file const path = event.data.path // A name to be displayed for external links For the setReferenceData method …

If you have questions after reading, please let me know.

[yejin]

Hello

I have reviewed the content of the link you provided, but I still have some questions.
The link also explains that fileKey is a Unique key .
In that case, is it acceptable to use a JSON string as shown below, as long as the value is unique?

referenceData.fileKey = '{"fileName":"sample.xlsx","documentFileKey":"xxxx"}';

I have also seen Example provided by OnlyOffice where JSON data is used as a string.

However, the parameter name fileKey and the description of it as a “unique identifier” in the official documentation are somewhat confusing.
I would like to confirm whether using a JSON string to store the actual required data is an intended usage.

[Constantine]

@yejin

In that case, is it acceptable to use a JSON string as shown below, as long as the value is unique?

Yes, you can.

@yejin

I would like to confirm whether using a JSON string to store the actual required data is an intended usage.

This is not intended way to manage the data. It’s just an identifier for the document you are referencing.
If you are not trying to reference another document inside currently opened one, then only document.key can be provided. Otherwise, both are required with unique values.