Quick Start Guide

Start Building Reports

Follow the steps below to begin building and testing reports using the JHReporting platform.

Prerequisites

• .NET Runtime 6.0.26+ (x64, Arm64)
• .NET SDK 7.0.405+ (x64, Arm64)
• VSCode version 1.78.0+

Install Steps

1. Download the latest version of the VSCode Reporting Extension from https://reporting.jhaea.com/tools.

2. Open VSCode and select the 'Extensions' tab. Drag the downloaded VSIX file to the Extensions window to install.

   

3. Open the explorer window and create a new folder for your reports.

4. Right-click the new folder and select 'JH-Reporting: Create new report'. Follow the prompts to create a report template and data file.

   

5. Again right-click the report folder and select 'JH-Reporting: Start Previewer'. This will launch the Live Previewer tool.

   

6. Open the report template and then save the file to see the report render in the Live Previewer window.

7. Add a 'fontColor' option to the 'Title' style:

   {
       "type": "Component",
       "id": "Title",
       "textOptions": {
           "fontSize": 24,
           "weight": "bold",
           "alignment": "center",
           "fontColor": "Red"
       }
   }
   

8. Save the report template file to see the changes in the Live Previewer window

Viewing JH Reporting output

The JH-Reporting engine will output status, information and errors in VS Code. This is helpful for viewing errors, seeing report render progress and troubleshooting layout problems. To view output: 1. If the output window is not already visible, go to 'View' menu, then 'Output' 2. Select ‘JH-Reporting’ in the drop-down menu on the right

Embedding the Report Generator in Your Application

The report rendering engine can be embedded in your application. Add the following NuGet Package to your project file (requires private feed access):

$ dotnet add package JackHenry.Reports

You can get started generating reports with the sample code below:

// get app config
var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json", optional: false)
    .Build();

// use dependency injection to enable reporting services
var serviceProvider = new ServiceCollection()
    .AddSingleton<IConfiguration>(configuration)
    .AddReportingConfig(configuration)
    .AddReportRendererServices()
    .AddReportLoaderServices()
    .BuildServiceProvider();

// get the render service
var renderService = serviceProvider.GetRequiredService<ReportRenderService>();

// render the report
var memoryStream = await renderService.RenderReportAsync("gs://bucket/my-report.rpt.json", "gs://bucket/my-report.json");
...

Creating a GitHub PAT for Package Access

In order to access JHReporting Packages, a GitHub Personal Access Token must be created. Follow the steps below.

1. Ensure that you have read access to https://github.com/JHAEA/reporting. If not, create a Help Desk ticket and request access to the JHAEA Organization.

2. Create a GitHub Personal Access Token (classic).

   1. Go to your GitHub account settings.
   2. Select 'Developer Settings' at the bottom of the list.
   3. Click 'Personal access tokens', then 'Tokens (classic)'.
   4. Click 'Generate new token', then 'Generate new token (classic)'.
   5. Enter a name for the token.
   6. Set the expiration time.
   7. Check the 'read:packages' box.
   8. Click 'Generate token'.
   9. Save the generated PAT for later use. NOTE: The PAT is a secret so do not commit to source code repos!

3. Configure SSO Authorization for the JHAEA org.

   1. Click 'Configure SSO' next to the token you just created.
   2. Click 'Authorize' on the JHAEA organization.
   3. Follow the steps to complete authentication.

4. Add the feed as a nuget source using the following command (be sure to substitute your GitHub username and the PAT token you just created):

       dotnet nuget add source \
       --username [your-github-username] \
       --password [your-pat] --store-password-in-clear-text \ 
       --name jhaea "https://nuget.pkg.github.com/JHAEA/index.json"