OKMReport

Basics

You can set several report formats based on document MIME type:

Tip

Constants defined in the Report class:

• Report.FORMAT_TEXT = “text/plain”
• Report.FORMAT_HTML = “text/html”
• Report.FORMAT_CSV = “text/csv”
• Report.FORMAT_PDF = “application/pdf”
• Report.FORMAT_RTF = “application/rtf”
• Report.FORMAT_ODT = “application/vnd.oasis.opendocument.text”
• Report.FORMAT_XLSX = “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet”
• Report.FORMAT_DOCX = “application/vnd.openxmlformats-officedocument.wordprocessingml.document”

Methods

list

Description:

Method	Return values	Description
list(String token, boolean active)	List	Returns a list of reports.

• When the active variable is set to true, only the active reports are returned; otherwise all reports are returned.

Example:

package com.openkm;

import com.openkm.api.OKMReport;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);
            System.out.println(okmReport.list(null, true));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

get

Description:

Method	Return values	Description
get(String token, long rpId)	Report	Returns a Report object.

• The variable rpId is the long value used to identify the report.

Example:

package com.openkm;

import com.openkm.api.OKMReport;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);
            System.out.println(okmReport.get(null, 1));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

execute

Description:

Method	Return values	Description
execute(String token, String pluginName, Map<String, String> params)	PageInfo	Returns a PageInfo object.

• The variable pluginName is the name of a plugin defined in OpenKM.

Example:

package com.openkm;


import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMReport;
import com.openkm.bean.PageInfo;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);

            Calendar yesterday = Calendar.getInstance();
            yesterday.add(Calendar.DATE, -1);
            Calendar today = Calendar.getInstance();

            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

            Map<String, String> params = new HashMap<>(); // report parameters
            params.put("from_date", sdf.format(yesterday.getTime()));
            params.put("to_date", sdf.format(today.getTime()));
            PageInfo pageInfo = okmReport.execute(null, "pluginName", params);
            System.out.println(pageInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

execute

Description:

Method	Return values	Description
execute(String token, long rpId, Map<String, Object> params, String format)	InputStream	Returns the InputStream of the report.

• The variable rpId is the long value used to identify the report.

Example:

package com.openkm;

import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMReport;
import com.openkm.bean.Report;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);

            Calendar yesterday = Calendar.getInstance();
            yesterday.add(Calendar.DATE, -1);
            Calendar today = Calendar.getInstance();

            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");

            Map<String, Object> params = new HashMap<>(); // report parameters
            params.put("from_date", sdf.format(yesterday.getTime()));
            params.put("to_date", sdf.format(today.getTime()));
            InputStream is = okmReport.execute(null, 1, params, Report.FORMAT_PDF);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSqlReport

Description:

Method	Return values	Description
getSqlReport(String token, long rpId)	SqlReport	Returns a SqlReport object.

• The variable rpId is the long value used to identify the SQL report.

Example:

package com.openkm;

import com.openkm.api.OKMReport;
import com.openkm.db.bean.SqlReport;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);
            SqlReport sqlReport = okmReport.getSqlReport(null, 1);
            System.out.println(sqlReport);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

listSqlReports

Description:

Method	Return values	Description
listSqlReports(String token, boolean active)	List	Returns a list of SQL reports.

• When the active variable is set to true, only the active SQL reports are returned; otherwise all SQL reports are returned.

Example:

package com.openkm;

import com.openkm.api.OKMReport;
import com.openkm.db.bean.SqlReport;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);
            for (SqlReport sqlReport : okmReport.listSqlReports(null, true)) {
                System.out.println(sqlReport);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeSqlReport

Description:

Method	Return values	Description
executeSqlReport(String token, long rpId)	InputStream	Executes a SQL report and returns the result as an InputStream.

• The variable rpId is the long value used to identify the SQL report.

Example:

package com.openkm;

import java.io.InputStream;

import com.openkm.api.OKMReport;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMReport okmReport = ContextWrapper.getContext().getBean(OKMReport.class);
            InputStream is = okmReport.executeSqlReport(null, 1);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}