OKMReport

Conceptos básicos

Puede establecer varios formatos de informe según el tipo MIME del documento:

Consejo

Constantes definidas en la clase Report:

• 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”

Métodos

list

Descripción:

Método	Valores de retorno	Descripción
list(String token, boolean active)	List	Devuelve una lista de informes.

• Cuando la variable active está establecida en true, solo se devuelven los informes activos; en caso contrario, se devuelven todos los informes.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
get(String token, long rpId)	Report	Devuelve un objeto Report.

• La variable rpId es el valor long usado para identificar el informe.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
execute(String token, String pluginName, Map<String, String> params)	PageInfo	Devuelve un objeto PageInfo.

• La variable pluginName es el nombre de un plugin definido en OpenKM.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
execute(String token, long rpId, Map<String, Object> params, String format)	InputStream	Devuelve el InputStream del informe.

• La variable rpId es el valor long usado para identificar el informe.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
getSqlReport(String token, long rpId)	SqlReport	Devuelve un objeto SqlReport.

• La variable rpId es el valor long usado para identificar el informe SQL.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
listSqlReports(String token, boolean active)	List	Devuelve una lista de informes SQL.

• Cuando la variable active está establecida en true, solo se devuelven los informes SQL activos; en caso contrario, se devuelven todos los informes SQL.

Ejemplo:

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

Descripción:

Método	Valores de retorno	Descripción
executeSqlReport(String token, long rpId)	InputStream	Ejecuta un informe SQL y devuelve el resultado como un InputStream.

• La variable rpId es el valor long usado para identificar el informe SQL.

Ejemplo:

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();
        }
    }
}