--- title: "Integrating DocuVieware into SharePoint 2019" canonical_url: "https://www.nutrient.io/guides/docuvieware/other-technologies/integrating-docuvieware-into-sharepoint-2019/" md_url: "https://www.nutrient.io/guides/docuvieware/other-technologies/integrating-docuvieware-into-sharepoint-2019.md" last_updated: "2026-05-18T15:55:45.958Z" description: "Integrate DocuVieware into SharePoint 2019 through an add-in with a secure and scalable deployment process." --- # Integrating DocuVieware into SharePoint 2019 This guide creates an add-in instead of a SharePoint solution. A SharePoint add-in has many advantages compared to farm solutions when you consider the safety, scaling, and integration of the deployment environment. Below are important notes regarding SharePoint apps when compared with SharePoint solutions: - App code doesn’t run in the SharePoint host environment. - They can work within the scope of a SharePoint site, and also in a special SharePoint site (App Catalog). - No downtime is required for the whole environment when an app is being upgraded. ## Prerequisites This guide uses the following tools: - Microsoft Visual Studio Enterprise 2019 - Microsoft.NET Framework Version 4.8.04084 - SharePoint 2019 - DocuVieware 3.1.0.75 or higher The SharePoint 2019 solution is hosted in an Azure cloud environment. ## Creating your application Add the **Office Developer Tools for Visual Studio** component using the Visual Studio installer to make the add-in application work.![Visual Studio installer showing Office Developer Tools component](@/assets/guides/docuvieware/tutorial_sharepoint_1.png) Then, create the app as described below: - Launch Visual Studio. - Create a new project.![Visual Studio start window with Create a new project option](@/assets/guides/docuvieware/tutorial_sharepoint_2.png) - Select **SharePoint Add-in** and C# as the language.![Project template selection showing SharePoint add-in option](@/assets/guides/docuvieware/tutorial_sharepoint_3.png) - Configure the projects.![Configure your new project dialog](@/assets/guides/docuvieware/tutorial_sharepoint_4.png) - Click **Create**. - Specify your SharePoint Add-in settings: - **Provider-hosted** — Selecting this hosts the app externally from SharePoint and uses all the options available with the client-side object model. - **SharePoint-hosted** — Selecting this hosts the app within SharePoint and uses the JavaScript client-side object model.![SharePoint Add-in settings dialog](@/assets/guides/docuvieware/tutorial_sharepoint_5.png) - Specify the target SharePoint version.![SharePoint hosting type selection](@/assets/guides/docuvieware/tutorial_sharepoint_6.png) - Type your login/password for the SharePoint server.![SharePoint server credentials dialog](@/assets/guides/docuvieware/tutorial_sharepoint_7.png) - Choose **ASP.NET MVC Web Application**.![Web application type selection showing ASP.NET MVC option](@/assets/guides/docuvieware/tutorial_sharepoint_8.png) - Set the STS certificate location’s field to the path where the created certificate is. Learn how to create/replace the certificate by referring to the [replace the STS certificate for SharePoint Server](https://docs.microsoft.com/en-us/sharepoint/administration/replace-the-sts-certificate) guide. Type your password and your issuer ID (creator’s ID).![STS certificate configuration dialog](@/assets/guides/docuvieware/tutorial_sharepoint_9.png) - Click **Finish**. Your add-in is generated. ## SharePoint configuration To declare an application in SharePoint, create an App Catalog Site Collection. Check out the Microsoft [documentation](https://docs.microsoft.com/en-us/sharepoint/use-app-catalog#:~:text=Under%20Apps%2C%20select%20Open.,info%2C%20and%20then%20select%20OK) for this step. To deploy your application from Visual Studio to SharePoint, link the two of them. You can deploy or publish solutions to a local SharePoint server on your development computer. The deployment process copies the `.wsp` file to the SharePoint server, installs the solution, and then activates the features. The publishing process only copies the `.wsp` file to the server and installs it. You must manually activate it to enable it in SharePoint. By following the MSDN documentation, you’ll be able to have a well-implemented solution in your SharePoint environment: - [Developing SharePoint Solutions - Visual Studio](https://docs.microsoft.com/en-us/visualstudio/sharepoint/developing-sharepoint-solutions?view=vs-2019) - [Set up a general development environment for SharePoint](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/set-up-a-general-development-environment-for-sharepoint) Below is the environment used to develop this solution.![Development environment configuration](@/assets/guides/docuvieware/tutorial_sharepoint_10.png) ## DocuVieware integration For the DocuVieware integration, the process is similar to other implementations: - Right-click **References** (in the Solution Explorer). - Add reference. - Click **Browse**. - Select `GdPicture.NET.14.NET.WEB.DocuVieware.dll`. You also need to set your `Global.asax` for: - Setting your DocuVieware API key (if you don’t have one, go to the download page) - Setting `SESSION_TIMEOUT` (number value, set `-1` to handle session timeout through ASP.NET session mechanism) - Setting `STICKY_SESSION` (Boolean) - Loading the assembly correctly ```csharp public class MvcApplication : HttpApplication { public const int SESSION_TIMEOUT = 20; private const bool STICKY_SESSION = true; private const DocuViewareSessionStateMode DOCUVIEWARE_SESSION_STATE_MODE = DocuViewareSessionStateMode.InProc; public static string GetCacheDirectory() { return HttpRuntime.AppDomainAppPath + "\\Cache"; } protected void Application_Start() { try { Assembly.Load("GdPicture.NET.14.WEB.DocuVieware"); } catch (System.IO.FileNotFoundException) { throw new System.IO.FileNotFoundException(" The system cannot find the DocuVieware assembly. Please set the Copy Local Property of the GdPicture.NET.14.WEB.DocuVieware reference to true. More information: https://msdn.microsoft.com/en-us/library/t1zz5y8c(v=vs.100).aspx"); } DocuViewareLicensing.RegisterKEY("YOUR_API_KEY"); DocuViewareManager.SetupConfiguration(STICKY_SESSION, DOCUVIEWARE_SESSION_STATE_MODE, GetCacheDirectory()); AreaRegistration.RegisterAllAreas(); FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters); RouteConfig.RegisterRoutes(RouteTable.Routes); BundleConfig.RegisterBundles(BundleTable.Bundles); } } ``` Once the assembly is implemented, add the JavaScript client library. Add these files: - `docuvieware-min.css` - `docuvieware-min.js` Reference them in the code. There are two different ways to do this. Implement them into the `BundleConfig` as demonstrated below: ```csharp public class BundleConfig { public static void RegisterBundles(BundleCollection bundles) { bundles.Add(new ScriptBundle("~/bundles/jquery").Include( "~/Scripts/jquery-{version}.js")); bundles.Add(new ScriptBundle("~/bundles/bootstrap").Include( "~/Scripts/bootstrap.min.js")); bundles.Add(new ScriptBundle("~/bundles/docuvieware").Include( "~/Scripts/docuvieware-min.js")); bundles.Add(new ScriptBundle("~/bundles/spcontext").Include( "~/Scripts/spcontext.js")); bundles.Add(new StyleBundle("~/Content/css").Include( "~/Content/bootstrap.min.css")); bundles.Add(new StyleBundle("~/Content/css").Include( "~/Content/docuvieware-min.css")); } ``` Or implement them in the `cshtml` main page: ```html DocuVieware - SharePoint Documents Reading Made Simple ``` Declare the client ID in the application to make the communication work. Set the client ID in the `AppRegNew.aspx` at `/_layouts/15/AppRegNew.aspx`.![AppRegNew.aspx page for setting Client ID](@/assets/guides/docuvieware/tutorial_sharepoint_11.png) After this, declare the client ID in the `AppManifest.xml` as mentioned below: - Right-click `App.manifest.xml`. - Click **Open with**. - Choose **XML (Text) Editor**. Declare the `` with the client ID: ```xml DocuVieware DEMO ~remoteAppUrl/?{StandardTokens} ``` Finish the configuration with one of the most specific requirements. To create a plugged.NET application to SharePoint, set a security certificate for the communication between SharePoint and your add-in. In the `TokenHelper.cs` file, set the username, the password, and the domain name to make the demo work. This information is used by SharePoint only to generate a temporary security token to enable the `POST` request between the application and the SharePoint server. Below is the specific line for creating a token and giving the client app the authorization to communicate with the SharePoint server with the `POST` method: ```csharp var dig = clientContext.GetFormDigestDirect().DigestValue; ``` ```csharp public static ClientContext GetClientContextWithAccessToken(string targetUrl, string accessToken) { ClientContext clientContext = new ClientContext(targetUrl) { AuthenticationMode = ClientAuthenticationMode.Anonymous, FormDigestHandlingEnabled = false }; CredentialCache myCache = new CredentialCache(); myCache.Add(new Uri(clientContext.Url), "NTLM", new NetworkCredential("sharepoint_demo", "Sharepoint2019", "SHAREPOINT")); clientContext.Credentials = myCache; var dig = clientContext.GetFormDigestDirect().DigestValue; clientContext.ExecutingWebRequest += delegate(object oSender, WebRequestEventArgs webRequestEventArgs) { webRequestEventArgs.WebRequestExecutor.WebRequest.PreAuthenticate = true; webRequestEventArgs.WebRequestExecutor.WebRequest.KeepAlive = true; webRequestEventArgs.WebRequestExecutor.WebRequest.UnsafeAuthenticatedConnectionSharing = true; webRequestEventArgs.WebRequestExecutor.WebRequest.Headers.Add("X-FORMS_BASED_AUTH_ACCEPTED", "f"); webRequestEventArgs.WebRequestExecutor.WebRequest.Headers[/fusion_text][/fusion_builder_column][/fusion_builder_row][/fusion_builder_container][fusion_builder_container hundred_percent="yes" overflow="visible" type="legacy"][fusion_builder_row][fusion_builder_column type="1_1" layout="1_1" background_position="left top" background_color="" border_color="" border_style="solid" spacing="yes" background_image="" background_repeat="no-repeat" padding_top="" padding_right="" padding_bottom="" padding_left="" margin_top="0px" margin_bottom="0px" class="" id="" animation_type="" animation_speed="0.3" animation_direction="left" hide_on_mobile="no" center_content="no" min_height="none" align_self="flex-start" border_sizes_undefined="" first="true" last="true" hover_type="none" link="" border_position="all" type="1_1"][fusion_text]["Authorization"] = "Bearer " + accessToken; if (webRequestEventArgs.WebRequestExecutor.WebRequest.Method == "POST" &&!webRequestEventArgs.WebRequestExecutor.WebRequest.Headers.AllKeys.Contains("X-RequestDigest")) { webRequestEventArgs.WebRequestExecutor.WebRequest.Headers.Add("X-RequestDigest", dig); } }; return clientContext; } ``` ## Implementation This section shows the custom development for saving on the server. Specify where SharePoint should save files by configuring the `defaultFolder` path in `web.config`. > This way of setting the `defaultFolder` is for demonstration purposes only and not production due to security issues. ```xml … ``` Implement the call method on the main page: ```html @{ Model.Control.RenderControl(Output); Model.Control.Dispose(); } ``` ```csharp public class SharePointContextFilterAttribute : ActionFilterAttribute { public override void OnActionExecuting(ActionExecutingContext filterContext) { if (filterContext == null) { throw new ArgumentNullException("filterContext"); } Uri redirectUrl; switch (SharePointContextProvider.CheckRedirectionStatus(filterContext.HttpContext, out redirectUrl)) { case RedirectionStatus.Ok: return; case RedirectionStatus.ShouldRedirect: filterContext.Result = new RedirectResult(redirectUrl.AbsoluteUri); break; case RedirectionStatus.CanNotRedirect: filterContext.Result = new ViewResult { ViewName = "Error" }; break; } } } ``` The `SharePointContext.cs` file is a class generated by Visual Studio when it links SharePoint with the MVC projects. This guide was developed outside of an Active Directory environment, so the auto-generated classes (`TokenHelper.cs` and `SharePointContext.cs`) were modified to work in that setup. If you face issues (for example, a 401 error on the `POST` request to the SharePoint server), you’ll find the modifications in the SharePoint sample delivered with the SDK on your computer’s main drive. [Contact Support](https://support.nutrient.io/hc/en-us/requests/new) if you have any questions. --- ## Related pages - [Integrating DocuVieware in your AngularJS client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-angularjs-client-application.md) - [How to set up and use DocuVieware with React](/guides/docuvieware/other-technologies/how-to-set-up-and-use-docuvieware-with-react.md) - [DocuVieware guide for Blazor](/guides/docuvieware/other-technologies/docuvieware-tutorial-for-blazor.md) - [Introduction](/guides/docuvieware/other-technologies.md) - [Integrating DocuVieware in your Angular2 client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-angular2-client-application.md) - [Integrating DocuVieware in your JavaScript/jQuery client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-javascript-jquery-client-application.md) - [Integrating DocuVieware in your Java client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-java-client-application.md) - [Integrating DocuVieware in your PHP client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-php-client-application.md) - [Integrating DocuVieware in your Node.js client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-nodejs-client-application.md) - [Integrating DocuVieware in your ASP.NET Core MVC Razor client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-asp-dotnet-core-mvc-razor-client-application.md) - [Use and handling of the selection area](/guides/docuvieware/other-technologies/rest-use-and-handling-of-the-selection-area.md) - [Custom snap-in implementation](/guides/docuvieware/other-technologies/rest-custom-snap-in-implementation.md) - [Client/server coming and going with custom actions](/guides/docuvieware/other-technologies/rest-client-server-coming-and-going-with-custom-actions.md) - [Integrating DocuVieware in your ASP.NET MVC Razor client application](/guides/docuvieware/other-technologies/integrating-docuvieware-in-your-asp-dotnet-mvc-razor-client-application.md) - [Your first Angular 10 application with DocuVieware](/guides/docuvieware/other-technologies/your-first-angular-10-application-with-docuvieware.md) - [Serving DocuVieware through a REST API](/guides/docuvieware/other-technologies/serving-docuvieware-through-a-rest-api.md) - [Integrating DocuVieware with Electron](/guides/docuvieware/other-technologies/integrating-docuvieware-with-electron.md)