Configuring the JSReport integration

import com.psddev.cms.db.ToolUi;
import com.psddev.cms.tool.CmsTool;
import com.psddev.dari.db.Modification;
import com.psddev.dari.db.Recordable;

@Recordable.FieldInternalNamePrefix("jsreport.")
public class JsReportGlobalSettings extends Modification<CmsTool> {

    private static final String TAB = "Integrations";
    private static final String CLUSTER = "JS Report";

    @ToolUi.Tab(TAB)
    @ToolUi.Cluster(CLUSTER)
    private String endpoint;

    @ToolUi.Tab(TAB)
    @ToolUi.Cluster(CLUSTER)
    private String username;

    @ToolUi.Tab(TAB)
    @ToolUi.Cluster(CLUSTER)
    @ToolUi.Secret
    private String password;

    public String getEndpoint() {
        return endpoint;
    }

    public void setEndpoint(String endpoint) {
        this.endpoint = endpoint;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

import java.time.Duration;

import com.psddev.cms.tool.CmsTool;
import com.psddev.dari.db.Singleton;
import com.psddev.jsreport.JsReportServiceProvider;
import net.jsreport.java.service.JsReportService;
import net.jsreport.java.service.JsReportServiceImpl;
import net.jsreport.java.service.ServiceTimeout;

public class JsReportGlobalSettingsServiceProvider extends JsReportServiceProvider {

    @Override
    public JsReportService getJsReportService() {
        JsReportGlobalSettings settings = Singleton.getInstance(CmsTool.class).as(JsReportGlobalSettings.class);
        if (settings != null && settings.getEndpoint() != null && settings.getUsername() != null && settings.getPassword() != null) {
            ServiceTimeout serviceTimeout = new ServiceTimeout();
            serviceTimeout.setCallTimeout(Duration.ofMinutes(1));
            serviceTimeout.setConnectTimeout(Duration.ofMinutes(1));
            serviceTimeout.setWriteTimeout(Duration.ofMinutes(1));
            serviceTimeout.setReadTimeout(Duration.ofMinutes(1));
            return new JsReportServiceImpl(
                settings.getEndpoint(),
                settings.getUsername(),
                settings.getPassword(),
                serviceTimeout);
        }
        return null;
    }
}

• A Modification on CMSTool allows us to add new fields to the Sites & Settings admin area. The class contains fields for configuring:
  

  • Endpoint URL
  • Username
  • Password
• An extension of JsReportServiceProvider allows us to create custom solution for providing configuration for JsReport.
• The JsReportGlobalSettings object is retrieved using the BSP Singleton API.
• A JsReportServiceImpl object is created with the configuration from the JsReportGlobalSettings object.