none
Use external files - Online office RRS feed

  • Question

  • Hello,

    I want to know if it's possible to edit external microsoft office file, in my OnlineOffice Integration ? Can pass a url in the CheckFile info ? How the WOPI Rest know which file to open ?

    Thanks,

    Baptiste C.

    Wednesday, October 4, 2017 12:54 PM

Answers

  • Hi Baptiste, 

    I'm not sure I fully understand what you require but I'll take a guess. The files being viewed and edited by Office Online Server are supplied as URL's in the WOPISrc parameter of the action URL's found discovery xml file provided by Office Online Server. These items are discussed in the following two pages of the WOPI documentation: 

    http://wopi.readthedocs.io/en/latest/discovery.html

    http://wopi.readthedocs.io/en/latest/hostpage.html

    What happens is that the host (meaning the WOPI protocol file host, for example Sharepoint) will build a host page that contains for example, the Word view action URL from the discovery xml. In that action URL, it supplies the WOPISrc paramter that is a URL pointing to the file on the host's file server. 

    Here is an example action URL built by a WOPI host server:

    http://jeebsoossvr/wv/wordviewerframe.aspx?WOPISrc=http%3A%2F%2Fjeebsx1carbon:8888%2Fwopi%2Ffiles%2FTest2.docx&access_token=DEADBEEFDEADBEEFDEADBEEF&access_token_ttl=0"

    In this case, 

    http://jeebsoossvr/wv/wordviewerframe.aspx?

    is the action URL supplied by the deployment of Office Online Server on the host jeebsoossvr.

    The following WOPISrc paramter:

    WOPISrc=http%3A%2F%2Fjeebsx1carbon:8888%2Fwopi%2Ffiles%2FTest2.docx&access_token=DEADBEEFDEADBEEFDEADBEEF&access_token_ttl=0

    identifies the file served by the WOPI protocol host running on jeebsx1carbon: 

    http://jeebsx1carbon/wopi/files/Test2.docx

    (cleaned up a bit for clarification).

    While viewing this host html page, the user can then click on the link containing the entire URL (first URL I pasted) and it will navigate to Office Online Server's Word web app, passing the WOPISrc URL which is then used by Office Online Server to GET the file from the file host.

    Is this what you were asking?

    Best regards,
    Tom Jebo 
    Sr Escalation Engineer
    Microsoft Open Specifications Support

    Wednesday, October 4, 2017 10:07 PM
    Moderator

All replies

  • Bravo671,

    Thank you for your question.  An engineer from the protocols team will contact you soon.


    Bryan S. Burgin Senior Escalation Engineer Microsoft Protocol Open Specifications Team

    Wednesday, October 4, 2017 7:06 PM
    Moderator
  • Hi Baptiste, 

    I'm not sure I fully understand what you require but I'll take a guess. The files being viewed and edited by Office Online Server are supplied as URL's in the WOPISrc parameter of the action URL's found discovery xml file provided by Office Online Server. These items are discussed in the following two pages of the WOPI documentation: 

    http://wopi.readthedocs.io/en/latest/discovery.html

    http://wopi.readthedocs.io/en/latest/hostpage.html

    What happens is that the host (meaning the WOPI protocol file host, for example Sharepoint) will build a host page that contains for example, the Word view action URL from the discovery xml. In that action URL, it supplies the WOPISrc paramter that is a URL pointing to the file on the host's file server. 

    Here is an example action URL built by a WOPI host server:

    http://jeebsoossvr/wv/wordviewerframe.aspx?WOPISrc=http%3A%2F%2Fjeebsx1carbon:8888%2Fwopi%2Ffiles%2FTest2.docx&access_token=DEADBEEFDEADBEEFDEADBEEF&access_token_ttl=0"

    In this case, 

    http://jeebsoossvr/wv/wordviewerframe.aspx?

    is the action URL supplied by the deployment of Office Online Server on the host jeebsoossvr.

    The following WOPISrc paramter:

    WOPISrc=http%3A%2F%2Fjeebsx1carbon:8888%2Fwopi%2Ffiles%2FTest2.docx&access_token=DEADBEEFDEADBEEFDEADBEEF&access_token_ttl=0

    identifies the file served by the WOPI protocol host running on jeebsx1carbon: 

    http://jeebsx1carbon/wopi/files/Test2.docx

    (cleaned up a bit for clarification).

    While viewing this host html page, the user can then click on the link containing the entire URL (first URL I pasted) and it will navigate to Office Online Server's Word web app, passing the WOPISrc URL which is then used by Office Online Server to GET the file from the file host.

    Is this what you were asking?

    Best regards,
    Tom Jebo 
    Sr Escalation Engineer
    Microsoft Open Specifications Support

    Wednesday, October 4, 2017 10:07 PM
    Moderator
  • Hey,

    Thanks a lot for your help !

    Best regards,

    Baptiste C.

    Monday, October 9, 2017 8:36 AM
  • I'm bit lost now, I'm searching on the internet and I really don't know how does all things work. What I understood, is that I need WOPI server like SharePoint or I can implement it my self. I also need a WOPI client, I don't now how to make one and finally the OOS. 

    I know how it work at a high level but I'm lost programmatically.

    Am I right ? Or did I misunderstand something ?

    Thanks

    Monday, October 9, 2017 2:22 PM
  • Hi Baptiste,

    >>I also need a WOPI client, I don't now how to make one and finally the OOS. 

    Office Online Server *is* a WOPI client that uses the  [MS-WOPI] protocol to communicate with WOPI hosts like Sharepoint (and others) to retrieve and store documents that are being viewed and edited via it's Word, PowerPoint, OneNote, Excel, etc... web applications. So, Office Online Server hosts the (for example) Word web application that you interact with as well as contains the logic in that web application to retrieve and store the documents via WOPI to the host.

    If you are planning to implement the client side of the [MS-WOPI] protocol, then typically you are planning a web application. However, that doesn't have to be the case. Fundamentally, this will be an application that consumes and produces files and persists them by calling the WOPI host endpoints (CheckFileInfo, GetFile, PutFile, Lock/Unlock, etc...). Most implementers of the [MS-WOPI] protocol are not implementing the client side of the protocol. Most are implementing the WOPI host or file store and making use of Office Online Server's web application functionality.

    If you are planning to implement the WOPI host side of the [MS-WOPI] protocol, then most commonly, you are planning a file storage host. Under the implementations of the REST endpoints (CheckFileInfo, GetFile, PutFile, Lock/Unlock, etc...) that you will be implementing, you can use whatever mechanism you require to permanently store the file data. You might choose a database or flat file or something else.

    Does that help at all?

    Tom

    Monday, October 9, 2017 9:31 PM
    Moderator
  • Thank you very much !!

    So I will implement the host side and use OOS as a client. I guess that OOS is running on a Windows Server.

    Another question, do I still need to be a Office 365 - Cloud Storage Partner ?

    Thanks again !

    Tuesday, October 10, 2017 7:08 AM
  • >>Another question, do I still need to be a Office 365 - Cloud Storage Partner ?

    Only if you plan to integrate with Office Online (cloud) as opposed to deploying Office Online Server 2016 locally.

    Tom

    Tuesday, October 10, 2017 5:16 PM
    Moderator
  • By 'locally' you say, on my own server ? 
    Tuesday, October 10, 2017 6:04 PM
  • Yes, Office Online Server product is a download server product that you deploy on your own server. 

    Tom

    Tuesday, October 10, 2017 6:44 PM
    Moderator
  • Hi Tom,

    Thanx for the explanation.

    I am having a requirement to open and edit SharePoint online/ onerdrive documents in a separate web application hosted on a separate server.

    I was able to open and edit files which has been stored locally using a wopi host application, created using c#. but I want to open/edit files which has been stored on shrepoint online and onedrive. Is there a way to to do it?

    Thanx in advance!

    Saturday, March 9, 2019 1:18 PM
  • Hi darshiJa, 

    I'm not sure I understand your scenario. Sharepoint *is* a file host. If you are using a WOPI host application of our own, then you need a WOPI *client* to do the Office editing and viewing. That would be Office Online Server. 

    Also, this forum doesn't cover the cloud Office Online or Sharepoint product integrations. Only the Office Online Server and Sharepoint Server (on-prem) versions. 


    Best regards,
    Tom Jebo 
    Sr Escalation Engineer
    Microsoft Open Specifications Support

    Saturday, March 9, 2019 3:41 PM
    Moderator