dotnetreport

Thank you for installing dotnetreport.

The nuget package adds client side code to your project, which calls a remote service at https://www.dotnetreport.com.

Installing this package adds app setting keys to your web.config, and you have to replace the dummy values with your Account Api tokens. You must create an online account get the Api tokens.

You can run your project and navigate to: http://localhost/dotnetreport for the Report Builder http://localhost/dotnetreport/dashboard for the Reports Dashboard http://localhost/dotnetsetup for the Admin Setup

To start the Scheduler Job, add the following line to your Program.cs:

JobScheduler.Start();

For .NET 8, Dotnet Report uses npm packages for all the client side libraries, and uses gulp to place them in the Scripts/lib folder.

---------------------------------------------------------------IMPORTANT------------------------------------------------------------------

With .NET 8 nuget package, there are some additional steps to get dotnet Report running locally in your project. It's always a good idea to checkin your code before adding the dotnetreport nuget package.

• UPDATE PROJECT TO COPY FILES LOCALLY

To get files locally in your project, do the following:

Edit your project file, and add GeneratePathProperty="true" to dotNetReport package reference:

Next, add the following to your project to copy front end files included in your project directly rather than as a reference.

$(PkgdotNetReport)\contentFiles\any\any\

Third, build the project, don't worry about errors, but you should notice that the references are gone and these files are now part of the project.

Finally, remove the entire CopyDotNetReportContent block, otherwise the project will keep overwriting your file changes. We don't need it anymore.

• BUILD CLIENT SIDE LIBRARIES USING NPM AND GULP

Client side packages need to be added to your package.json file.

The list of libraries dotnet Report uses from npm is included package.dotnetreport.json. Please manually merge the contents in to your project's actual package.json. If you don't have one, just rename this file to package.json. You can delete the package.dotnetreport.json file.

After merging, right-click on packagejson in Visual Studio and click "Restore Packages" or run:

    npm install

Then merge gulpfile.dotnetreport.js in with your gulpfile. If you don't have one, just rename this file to gulpfile.js. You can delete the gulpfile.dotnetreport.json file.

You can run the gulp file by right clicking on it in Visual Studio and choose "Task Manager". Then run the 'scripts' gulp task, or run:

	gulp scripts

If it doesn't load, you would have make sure npm is installed in your folder. You can do so by running "npm install" from project directory. The purpose of the gulp file is to take js libraries copied by npm and add them to wwwroot/lib folder, and that's where the layout file references them from.

• UPDATE PROGRAM.CS

Add the following line manually to your Program.cs file:

JobScheduler.Start(); //<--- Add this line manually if you want to run scheduled jobs from your app

If your project is not using controller with Views, you would also need to add Controller with Views and set NewtonSoft Json setting in your Startup.cs

	services.AddControllersWithViews();

4. ADD API KEYS AND CONNECTION STRING TO APPLICATION SETTINGS:

Finally, add dotnet report keys to your appsettings.json file:

"dotNetReport": { "apiurl": "https://dotnetreport.com/api", "accountApiToken": "Your Account API Key", "dataconnectApiToken": "Your Data Connect Key", "privateApiToken": "Your Private API Key" }, "ConnectionStrings": { "ConnectionKey": "Data Source=;Initial Catalog=;User ID=;Password=;" },

You should be able to build and run the project after the above changes.

For more details and documentation, you can visit https://www.dotnetreport.com/docs.