Skip to main content

How to open Documents in Office Web Apps in SharePoint apps (Provider Hosted and SharePoint Hosted)

Office web apps are now getting more and more popular with the SharePoint 2013 environment. In native SharePoint environment when you click on a document it will open in a office online (OWA) based on configuration.

But it you a writing a SharePoint Hosted app or a Provider Hosted app; you might wonder how to open it in office web apps and what is the URL you are going to use it.

You can use JSOM and SharePoint REST services to archive this.

Frist you need to send a REST request by mentioning file name.

url: AppWebUrlUrl + "/_api/web/GetFileByServerRelativeUrl('server relative file name')",
method: "GET",
contentType: "application/json;odata=verbose",
headers: { "Accept": "application/json; odata=verbose" }

You should carefully give the sever relative file name for this operation. regardless of app type (Provider hosted or a SharePoint Hosted ) file name it coming with app web url


Ex:


Absolute File Url


https://oapp-bfb82901075d6b.sharepoint.com/sites/dev/myapp/lists/lcrdocs/file1.doc


Relative File Url


/sites/dev/myapp/lists/lcrdocs/file1.doc


Depending on the App type either you need to use the RequestExecutor or normal rest approach.


Using RequestExecutor in Provider Hosted Apps



var executor = new SP.RequestExecutor("app web url"); // you need to pass app web url
 
executor.executeAsync({
url: "app web url" + "/_api/web/GetFileByServerRelativeUrl('relative doc url')",
method: "GET",
contentType: "application/json;odata=verbose",
headers: { "Accept": "application/json; odata=verbose" },
success: function (data) {
    var arry = JSON.parse(data.body).d;
    if (arry.LinkingUrl) {
        // can open with office web apps
        var owaurl = "app web url" + "/_layouts/15/WopiFrame.aspx?sourcedoc={" + arry.UniqueId + "}&file=" + encodeURIComponent(arry.Title) + "&action=default";                   
    } else {
        // can not open with office web apps (ex:txt)
    }
},
error: function (data, errorCode, errorMessage) {
// error
}
});

if the LinkingUrl available it indicates it can be open via office web apps. LinkingUrl some times returns direct web app url ; thus you don’t need to create the Url by amending items but some times it returns absolute document Url. mentioned approach will be suits for both occasions.  


Ajax Request in SharePoint Hosted Apps



$.Ajax({ // Jquery needed
url: "app web url" + "/_api/web/GetFileByServerRelativeUrl('relative doc url')",
method: "GET",
contentType: "application/json;odata=verbose",
headers: { "Accept": "application/json; odata=verbose" },
success: function (data) {
    var arry = JSON.parse(data.body).d;
    if (arry.LinkingUrl) {
        // can open with office web apps
        var owaurl = "app web url" + "/_layouts/15/WopiFrame.aspx?sourcedoc={" + arry.UniqueId + "}&file=" + encodeURIComponent(arry.Title) + "&action=default";                   
    } else {
        // can not open with office web apps (ex:txt)
    }
},
error: function (data, errorCode, errorMessage) {
// error
}
});

Comments

Popular posts from this blog

How to Link Two List and Create a combine view in the SharePoint 2010

In this way you can join multiple list together and can create a combine view. for an example assume that you are managing a list for some events. And also you are having a participants in separate list. Thus you want to join the two list and create a composite view. SharePoint 2010 allows you to create this kind of view using  Linked Data Source. in this approach you can create your own custom list in the SharePoint. How to Create a Linked Data source Go to SharePoint designer and  go to the link called data sources. And Click the Linked Data Source button in the ribbon. Then SharePoint designer will prompt following kind of a dialog. In there add two list, that you wan to linked together. I'm adding airline schedule and booking list. those are the two list that i wan to merge. then click next. And it will guide you another screen. it will ask you to select either Merge Merge use to combine list which are having same columns definition. for and example we can s...

How to Improve Workflow Performance in SharePoint Server 2010

SharePoint workflows are getting  slow for several reasons. in my environment I'm having a problem with following performance issues, therefore in my environment i got following problems. When a item added to the library it takes some times to initiate the workflow. Workflow mail generating is not very fast sometimes. Workflows takes more time to process “Due to heavy load, the latest workflow operation has been queued. It will attempt to resume at a later time” is coming sometimes. I had a custom workflow approval web part and it is taking more than 30 seconds to proceed. Work Done I had a custom workflow approval web part and it is taking more than 30 seconds to proceed. here in my custom web part there is the function which is programmatically updating the workflow. SPWorkflowTask.AlterTask(item, data, false) the last parameter mentioning whether it is synchronous asynchronous. if  is it true it it will wait until workflow schedule accept the workflow task. ...

Motion Eye Docker compose File

Docker compose files are comes in handy when considering container orchestration. Below example shows my docker compose files and folder structure. ---- Your Folder (motioneye)   -- etc   -- lib   -- docker-compose.yaml You can run the docker compose file using docker-compose -d , and etc and lib folder will be automatically populated in the initiation. --- Below shows the content of the docker-compose.yaml file. version: '3' services:   nodered:    image: "ccrisan/motioneye:master-amd64"    container_name: motioneye    restart: always    user: root    ports:      - 8765:8765    volumes:      - "/etc/localtime:/etc/localtime:ro"      - "./etc:/etc/motioneye"      - "./lib:/var/lib/motioneye"