JSReport document generation API

The JsReportDocumentGenerator utility class in Brightspot simplifies the process of generating documents using JSReport. This utility class provides two distinct methods, catering to different use cases, allowing developers to seamlessly integrate JSReport document generation within their Brightspot projects. This topic describes each method and its use cases.

createDocument(String template, Object data)

Creates a Document for the specified JSReport template and input data.

• Parameters:
  
  • template: The JSReport template to use, specified by either the template name or short ID.
  • data: The data used to render the JSReport template, typically represented as a java.util.Map to convey JSON data.
• Return:
  
  • A Document object containing the document produced by JSReport, including the document's content and content type.

Usage example

String templateName = "myTemplate";
Map<String, Object> jsonData = // ... prepare JSON data
Document generatedDocument = JsReportDocumentGenerator.createDocument(templateName, jsonData);

createDocument(String template, Class dateEntryView, Object content)

Creates a Document using the specified template, dateEntryView, and content, leveraging the Brightspot view system.

• Parameters:
  
  • template: The entry view used to find an appropriate view model. If null, the DefaultJsReportTemplate annotation will be checked for a default template.
  • dateEntryView: The entry view used to find an appropriate view model.
  • content: The content providing data for document generation.
• Return:
  
  • A Document object containing the document produced by JSReport, including the document's content and content type.

Usage example

Object content = Query.from(MyRecord.class).first(); // contrived example for getting cotent from BSP DB
Document generatedDocument = JsReportDocumentGenerator.createDocument(null, JsReportViewModel.class, content);

@JsonView
@ViewInterface
@DefaultJsReportTemplate("myPdf")
public class JsReportViewModel extends ViewModel<MyRecord> {
    
    public String getTitle() {
        return model.getHeadline();
    }

    public String getCompany() {
        return model.getCompany();
    }
}