OKMDashboard

Conceptos básicos

En todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” utilizando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

getUserCheckedOutDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserCheckedOutDocuments(String token)	List	Obtiene la lista de documentos con checkout del usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserCheckedOutDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastModifiedDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserLastModifiedDocuments(String token)	List	Obtiene la lista de los últimos documentos modificados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserLastModifiedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserLockedDocuments(String token)	List	Obtiene la lista de los documentos bloqueados modificados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserLockedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLockedRecords

Descripción:

Método	Valores devueltos	Descripción
getUserLockedRecords(String token)	List	Obtiene la lista de los registros bloqueados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardRecordResult dashboardRecordResult : OKMDashboard.getInstance().getUserLockedRecords(null)) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserSubscribedDocuments(String token)	List	Obtiene la lista de los documentos a los que está suscrito el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserSubscribedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedFolders

Descripción:

Método	Valores devueltos	Descripción
getUserSubscribedFolders(String token)	List	Obtiene la lista de las carpetas a las que está suscrito el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardFolderResult dashboardFolderResult : OKMDashboard.getInstance().getUserSubscribedFolders(null)) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSubscribedRecords

Descripción:

Método	Valores devueltos	Descripción
getUserSubscribedRecords(String token)	List	Obtiene la lista de los registros a los que está suscrito el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardRecordResult dashboardRecordResult : OKMDashboard.getInstance().getUserSubscribedRecords(null)) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserLastCreatedDocuments(String token)	List	Obtiene la lista de los últimos documentos creados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserLastCreatedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedFolders

Descripción:

Método	Valores devueltos	Descripción
getUserLastCreatedFolders(String token)	List	Obtiene la lista de las últimas carpetas creadas por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardFolderResult dashboardFolderResult : OKMDashboard.getInstance().getUserLastCreatedFolders(null)) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastCreatedRecords

Descripción:

Método	Valores devueltos	Descripción
getUserLastCreatedRecords(String token)	List	Obtiene la lista de los últimos registros creados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardRecordResult dashboardRecordResult : OKMDashboard.getInstance().getUserLastCreatedRecords(null)) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastDownloadedDocuments

Descripción:

Método	Valores devueltos	Descripción
getUserLastDownloadedDocuments(String token)	List	Obtiene la lista de los últimos documentos descargados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserLastDownloadedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMails

Descripción:

Método	Valores devueltos	Descripción
getUserLastImportedMails(String token)	List	Obtiene la lista de los últimos correos importados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardMailResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardMailResult dashboardMailResult : OKMDashboard.getInstance().getUserLastImportedMails(null)) {
                System.out.println(dashboardMailResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserLastImportedMailAttachments

Descripción:

Método	Valores devueltos	Descripción
getUserLastImportedMailAttachments(String token)	List	Obtiene la lista de los últimos adjuntos de correo importados por el usuario.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getUserLastImportedMailAttachments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserDocumentsSize

Descripción:

Método	Valores devueltos	Descripción
getUserDocumentsSize(String token)	long	Devuelve el tamaño total en bytes de los documentos del usuario.

Nota

Cuando un usuario sube o modifica un documento, el tamaño completo del contenido (y de las versiones del historial en caso de actualización) se asigna a los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.util.FormatUtil;

public class Test {
    public static void main(String[] args) {
        try {
            long sizeInBytes = OKMDashboard.getInstance().getUserDocumentsSize(null);
            System.out.println(FormatUtil.formatSize(sizeInBytes));

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getUserSearchs

Descripción:

Método	Valores devueltos	Descripción
getUserSearchs(String token)	List	Obtiene la lista de todas las “novedades de usuario” guardadas por el usuario.

Nota

Las búsquedas “guardadas por el usuario” se ejecutan periódicamente para obtener novedades basadas en consultas del repositorio.

Más información en las vistas Trabajar con el panel de control y Trabajar con la búsqueda.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.dao.bean.QueryParams;

public class Test {
    public static void main(String[] args) {
        try {
            for (QueryParams qp : OKMDashboard.getInstance().getUserSearchs(null)) {
                System.out.println(qp);
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

find

Descripción:

Método	Valores devueltos	Descripción
find(String token, int qpId)	List	Ejecuta una “novedad de usuario”.

• El parámetro qpId es el identificador único de la búsqueda de “novedades de usuario”.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardNodeResult;
import com.openkm.bean.Document;
import com.openkm.bean.Folder;
import com.openkm.bean.Mail;
import com.openkm.bean.Record;

public class Test {
    public static void main(String[] args) {
        try {
            int qpId = 12;
            for (DashboardNodeResult dashboardNodeResult : OKMDashboard.getInstance().find(null, qpId)) {
                if (dashboardNodeResult.getNode() instanceof Document ) {
                    Document doc = (Document) dashboardNodeResult.getNode();
                    System.out.println(doc);
                } else if (dashboardNodeResult.getNode() instanceof Folder ) {
                    Folder fld = (Folder) dashboardNodeResult.getNode();
                    System.out.println(fld);
                } else if (dashboardNodeResult.getNode() instanceof Record ) {
                    Record rec = (Record) dashboardNodeResult.getNode();
                    System.out.println(rec);
                } else if (dashboardNodeResult.getNode() instanceof Mail ) {
                    Mail mail = (Mail) dashboardNodeResult.getNode();
                    System.out.println(mail);
                }
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopDownloadedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastWeekTopDownloadedDocuments(String token)	List	Obtiene la lista de los documentos más descargados durante la última semana por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastWeekTopDownloadedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopDownloadedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastMonthTopDownloadedDocuments(String token)	List	Obtiene la lista de los documentos más descargados durante el último mes por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastMonthTopDownloadedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastWeekTopModifiedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastWeekTopModifiedDocuments(String token)	List	Obtiene la lista de los documentos más modificados durante la última semana por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastWeekTopModifiedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastMonthTopModifiedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastMonthTopModifiedDocuments(String token)	List	Obtiene la lista de los documentos más modificados durante el último mes por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastMonthTopModifiedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastModifiedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastModifiedDocuments(String token)	List	Obtiene la lista de los últimos documentos modificados por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastModifiedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastCreatedDocuments(String token)	List	Obtiene la lista de los últimos documentos creados por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastCreatedDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCheckedOutDocuments

Descripción:

Método	Valores devueltos	Descripción
getLastCheckedOutDocuments(String token)	List	Obtiene la lista de los últimos documentos en edición por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardDocumentResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardDocumentResult dashboardDocumentResult : OKMDashboard.getInstance().getLastCheckedOutDocuments(null)) {
                System.out.println(dashboardDocumentResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedFolders

Descripción:

Método	Valores devueltos	Descripción
getLastCreatedFolders(String token)	List	Obtiene la lista de las últimas carpetas creadas por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardFolderResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardFolderResult dashboardFolderResult : OKMDashboard.getInstance().getLastCreatedFolders(null)) {
                System.out.println(dashboardFolderResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getLastCreatedRecords

Descripción:

Método	Valores devueltos	Descripción
getLastCreatedRecords(String token)	List	Obtiene la lista de los últimos registros creados por todos los usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMDashboard;
import com.openkm.bean.DashboardRecordResult;

public class Test {
    public static void main(String[] args) {
        try {
            for (DashboardRecordResult dashboardRecordResult : OKMDashboard.getInstance().getLastCreatedRecords(null)) {
                System.out.println(dashboardRecordResult);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

visiteNode

Descripción:

Método	Valores devueltos	Descripción
visiteNode(String token, String source, String node, Calendar date)	void	Marca un nodo como visitado.

• Orígenes disponibles:

Nota

Desde la interfaz, los nodos se muestran en negrita hasta que el usuario los visita. Este método marca el nodo como visitado por el usuario en la base de datos.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMDashboard;

public class Test {
    public static void main(String[] args) {
        try {
            Calendar cal = Calendar.getInstance();
            OKMDashboard.getInstance().visiteNode(null, "LastWeekTopDownloadedDocuments", "/okm:root/sample.pdf", cal);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}