telerik / reporting-docs

Public Documentation for Reporting
Apache License 2.0
8 stars 26 forks source link

Report Server for .NET Documentation #1370

Open ighristov opened 4 months ago

ighristov commented 4 months ago
### Tasks
- [ ] https://github.com/telerik/reporting-docs/issues/1394
- [ ] https://github.com/telerik/reporting-docs/issues/1395
- [ ] https://github.com/telerik/reporting-docs/issues/1396
ighristov commented 3 months ago

This is a draft for the initial release of RS.NET docs. Please edit them as you wish.

RS.NET is in PREVIEW mode and this documentation is a subject of change. The documentation for RS.NET reflects the latest released version of our product.

Installation on Windows

1) Installation Process

[MSI screenshot].

2) Installed Assets

3) Automatic Configuration

MSI will do the initial configuration of RS.NET and RSA.NET on Windows, making them ready-to-run. For configuring RS.NET and RSA.NET on non-windows platforms please check this article (link to other article with linux/docker docs)

4) Troubleshooting

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="dotnet" arguments=".\Telerik.ReportServer.Web.Core.dll" stdoutLogEnabled="true" stdoutLogFile=".\logs\stdout" hostingModel="inprocess" >
            <handlerSettings>
              <handlerSetting name="debugFile" value=".\logs\aspnetcore-debug.log" />
              <handlerSetting name="debugLevel" value="FILE,TRACE" />
            </handlerSettings>
      </aspNetCore>
    </system.webServer>
  </location>
</configuration>

Initialization process (not sure where this should be!) (Manual Configuration)

  1. When the server is started and passes the ConfigureStorage and Register Administrator pages, it stores those settings in a file named ReportServerAdmin.json.
  2. THen RS checks its appsettings.json for the key "InitialAgentUrl". If the installation has passed successfully, the key must exist and must have a valid value like "http://localhost:84". This is where the MSI has registered the RSA app.
  3. The RS calls this URL and passes the storage settings to the agent. The storage settings for the agent will be saved in a file in the Agent's directory, named \Services.NET\ServiceAgent.json. If such a file does not exist, the agent was not initialized or registered in IIS.

    Reset procedure: 1) Delete the file \Services.NET\ServiceAgent.json from Agent's folder; 2) CHeck if RSA works, by calling "http://localhost:84/api/system/isalive" from browser (where localhost:84 is the URL of TSA). If the agent is working, the result must be HTTP ERROR 401 - Unauthorized. If the agent is not working, the result should be 404 - Not Found. 3) Open RS's appsettings.json and add/edit the key "InitialAgentUrl": "http://localhost:84". 4) Restart the RS and RSA. 5) Check the RS' COnfiguration -> ServiceAgent page. THe entry "DefaultServiceAgent" with the url http://localhost:84 should now be present. 6) To check the TSA, ensure the Mail Server settings in Configuration page are valid.