[BUG]: missing documentation for the backend export feature

[dwilches]

Company

Private Info

SDK Version

1.3.0

Client Framework

Angular

Server Platform

Java

Description

In version 1.3.0 there is a new method for exporting dashboards from the backend:

RevealEngineLocator.dashboardExporter.exportToPdf()

But I can't find the documentation for this.

Some questions about it:

• Where is the documentation for version 1.3.0? I can only find the "latest" documentation, but not the one for the version I'm using: 1.3.0
• The class RevealEngineLocator is part of a package that looks internal-user-only: com.infragistics.reveal.engine.init.internal. And I can't find the documentation for it. Is it really internal use? (this is the class that I saw in your release notes).
• Where is the documentation for IDashboardExporter? I don't see it in the package it belongs to according to the code

The documentation page I'm talking about is this one:
https://help.revealbi.io/api/java/latest/com/infragistics/reveal/sdk/api/package-summary.html

[brianlagunas]

Where is the documentation for version 1.3.0? I can only find the "latest" documentation, but not the one for the version I'm using: 1.3.0

Currently our docs only support the latest version of the SDK. We do not have docs for older versions at this time.

The class RevealEngineLocator is part of a package that looks internal-user-only: com.infragistics.reveal.engine.init.internal. And I can't find the documentation for it. Is it really internal use?

You are correct, the RevealEngineLocator is an internal class. It appears the code snippet for getting the IDashboardExporter is not using the correct code.

Use this instead: RevealEngineInitializer.getDashboardExporter()

We will update the samples and code snippets in the docs.

Where is the documentation for IDashboardExporter?

We have not been able to update our API docs. There are a lot of internal changes happening which is causing the delay in this area of our documentation. Is there something specific about the IDashboardExporter you have a question about? It only has a few export methods on it.

[dwilches]

Hello,

About the IDashboardExporter docs, I wanted to find what the second String parameter of this method was:

void exportToPdf(String var1, String var2, ExportCallback var3) throws IOException;

Thanks.

[brianlagunas]

The second string is used to save the export as a file on disk. Simply provide the file path of the location you would like to save the file on disk.

[dwilches]

Thanks.

For other people who may have similar doubts, even though the interface IDashboardExporter has methods where we can't read the argument names:

void exportToPdf(String var1, ExportStreamCallback var2) throws IOException;
void exportToPdf(String var1, IRVUserContext var2, PdfExportOptions var3, ExportStreamCallback var4) throws IOException;
void exportToPdf(String var1, String var2, ExportCallback var3) throws IOException;
void exportToPdf(String var1, String var2, IRVUserContext var3, PdfExportOptions var4, ExportCallback var5) throws IOException;

Looking at its implementing class DefaultDashboardExporter, it has the argument names:

public void exportToPdf(String dashboardId, ExportStreamCallback callback) throws IOException ...
public void exportToPdf(String dashboardId, IRVUserContext userContext, PdfExportOptions options, ExportStreamCallback callback) throws IOException ...
public void exportToPdf(String dashboardId, String filePath, ExportCallback callback) throws IOException ...
public void exportToPdf(String dashboardId, String filePath, IRVUserContext userContext, PdfExportOptions options, ExportCallback callback) throws IOException ...