OKMReport
Basics
You can set several reports formats based in document mime type:
Contants defined into 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<Report> |
Returns a list of reports. |
|
When variable active when is set to true will be returned only the active reports otherwise all the reports. |
||
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 an object Report. |
|
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, Object> 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.Report;
import com.openkm.util.ContextWrapper;
import com.openkm.bean.PageInfo;
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");
PageInfo pageInfo = new HashMap<>(); // report parameters
params.put("from_date", sdf.format(yesterday.getTime()));
params.put("to_date", sdf.format(today.getTime()));
System.out.println(okmReport.execute(null, "pluginName", params));
} 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();
}
}
}
