Report samples

Aspectos básicos

La siguiente tabla muestra cómo deben pasarse las variables según el tipo de campo:

Tipo de campo	Tipo	Descripción
Date	String	Use el patrón yyyy-MM-dd (año-mes-día). 2018-10-04
Select multiple	String	Use ‘,’ para separar cada valor. “value1,value2,value3”

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los servicios web, la sesión se mantiene en el objeto webservice. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto, puede usar todos los métodos de Report desde la clase “report”, tal y como se muestra a continuación:

ws.report.getReports(true)

Métodos

getReports

Descripción:

Método	Valores de retorno	Descripción
getReports(boolean active)	List	Devuelve una lista de informes.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Report;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            for (Report rep : ws.report.getReports(true)) {
                System.out.println(rep);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getReport

Descripción:

Método	Valores de retorno	Descripción
getReport(long rpId)	Report	Devuelve un informe.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Report;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Report rep = ws.report.getReport(1);
            System.out.println(rep);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

generateDownloadReportToken

Descripción:

Método	Valores de retorno	Descripción
generateDownloadReportToken(long rpId)	String	Devuelve el token para descargar el informe.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            String token = ws.report.generateDownloadReportToken(1);
            System.out.println(token);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

execute

Descripción:

Método	Valores de retorno	Descripción
execute(long rpId, Map<String, String> params, String format, String uuid)	InputStream	Devuelve un documento resultante de ejecutar un informe.

Nota

Formatos disponibles:

• Report.FORMAT_CSV
• Report.FORMAT_DOCX
• Report.FORMAT_HTML
• Report.FORMAT_ODT
• Report.FORMAT_PDF
• Report.FORMAT_RTF
• Report.FORMAT_TEXT

El parámetro uuid es el UUID de un nodo (este parámetro es opcional; suele ser útil en informes ejecutados desde la interfaz de usuario, donde los resultados dependen del nodo seleccionado).

Ejemplo:

package com.openkm;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.io.IOUtils;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Report;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Map<String, String> params = new HashMap<>();
            params.put("from_date", "2021-01-01");
            params.put("to_date", "2021-05-01");

            long rpId = 1;
            String format = Report.FORMAT_PDF;
            String dstId = "c5c87bd3-0c03-4bba-ab2f-7184c23a26d8";
            String uuid = "";
            InputStream is = ws.report.execute(rpId, params, format, dstId, uuid);
            OutputStream fos = new FileOutputStream("/home/openkm/report/document Create.pdf");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

executeSql

Descripción:

Método	Valores de retorno	Descripción
executeSql(long rpId)	InputStream	Devuelve un documento resultante de ejecutar un informe SQL.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;
import org.apache.commons.io.IOUtils;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);

            // executeReportSql
            long rpdId = 1;
            InputStream is = ws.report.executeSql(rpdId);
            OutputStream fos = new FileOutputStream("/home/openkm/report/activity.csv");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
}

save

Descripción:

Método	Valores de retorno		Descripción
save(long rpId, Map<String, String> params, String format, String dstId, docName, String uuid)	Document	Ejecuta el informe y guarda el documento resultante.

Nota

Formatos disponibles:

• Report.FORMAT_CSV
• Report.FORMAT_DOCX
• Report.FORMAT_HTML
• Report.FORMAT_ODT
• Report.FORMAT_PDF
• Report.FORMAT_RTF
• Report.FORMAT_TEXT

El valor del parámetro dstId debe ser el UUID de una carpeta o de un expediente.

El parámetro docName es el nombre de fichero del informe.

El parámetro uuid es el UUID de un nodo (este parámetro es opcional; suele ser útil en informes ejecutados desde la interfaz de usuario, donde los resultados dependen del nodo seleccionado).

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;
import com.openkm.sdk4j.bean.Report;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.HashMap;
import java.util.Map;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Map<String, String> params = new HashMap<>();
            params.put("from_date", "2021-01-01");
            params.put("to_date", "2021-05-01");

            long rpId = 1;
            String format = Report.FORMAT_PDF;
            String dstId = "c5c87bd3-0c03-4bba-ab2f-7184c23a26d8";
            String docName = "Document create.pdf";
            String uuid = "";
            Document documenReport = ws.report.save(rpId, params, format, dstId, docName, uuid);
            System.out.println(documenReport);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

saveSql

Descripción:

Método	Valores de retorno		Descripción
saveSql(long rpId, Map<String, String> params, String dstId, docName)	Document	Ejecuta el informe SQL y guarda el documento CSV resultante.

Nota

El valor del parámetro dstId debe ser el UUID de una carpeta o de un expediente.

El parámetro docName es el nombre de fichero del informe.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Document;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.HashMap;
import java.util.Map;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);

            // saveSql
            long rpId = 1;
            String dstId = "8f64d889-1600-4cbc-8245-de6fb62214eb";
            String docName = "activity.csv";
            Document documenReport = ws.report.saveSql(rpId, new HashMap<>(), dstId, docName);
            System.out.println(documenReport);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
}

getSqlReports

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.SqlReport;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);

            // getSqlReports
            List<SqlReport> sqlReports = ws.report.getSqlReports(true);
            for (SqlReport sqlReport : sqlReports) {
                System.out.println(sqlReport);
            }
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }
}