OKMImport

Fundamentos

En la mayoría de los métodos verá un parámetro llamado “parentUuid”. El valor de este parámetro puede ser un UUID de nodo de documento válido.

Consejo

Ejemplo de docId:

• Usando UUID -> “c41f9ea0-0d6c-45da-bae4-d72b66f42d0f”

Además, en todos los métodos verá un parámetro llamado “token”. Como la tarea Cron se ejecuta en segundo plano sin autenticación, los métodos usados en ese escenario pueden usar el parámetro token. Desde el contexto de ejecución por defecto de la aplicación, debe usar el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Consejo

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

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

Métodos

createDocument

Descripción:

Método	Valores de retorno	Descripción
createDocument(String token, String parentUuid, String docName, File file)	NodeDocument	Crea un nuevo documento.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• El parámetro file es el fichero del documento.

Ejemplo:

package com.openkm;

import java.io.File;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeDocument;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            File file = new File("/home/openkm/sample.pdf");
            NodeDocument nodeDoc = okmImport.createDocument(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "document.pdf", file);
            System.out.println(nodeDoc);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createDocument (con metadatos)

Descripción:

Método	Valores de retorno	Descripción
createDocument(String token, String parentUuid, String name, Calendar created, String author, File file)	NodeDocument	Crea un nuevo documento conservando la fecha de creación y el autor originales.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• Use esta sobrecarga cuando migre contenido desde sistemas externos y necesite conservar la fecha de creación y el autor originales.

Ejemplo:

package com.openkm;

import java.io.File;
import java.util.Calendar;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeDocument;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            File file = new File("/home/openkm/sample.pdf");
            Calendar created = Calendar.getInstance();
            NodeDocument nodeDoc = okmImport.createDocument(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "document.pdf", created, "okmAdmin", file);
            System.out.println(nodeDoc);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createFolder

Descripción:

Método	Valores de retorno	Descripción
createFolder(String token, String parentUuid, String fldName)	NodeFolder	Crea una nueva carpeta.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• El parámetro fldName es el nombre de la carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeFolder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            NodeFolder nodeFld = okmImport.createFolder(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "newFolderName");
            System.out.println(nodeFld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createFolder (con metadatos)

Descripción:

Método	Valores de retorno	Descripción
createFolder(String token, String parentUuid, String name, Calendar created, String author)	NodeFolder	Crea una nueva carpeta conservando la fecha de creación y el autor originales.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• Use esta sobrecarga cuando migre contenido desde sistemas externos y necesite conservar la fecha de creación y el autor originales.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeFolder;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            Calendar created = Calendar.getInstance();
            NodeFolder nodeFld = okmImport.createFolder(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "newFolderName", created, "okmAdmin");
            System.out.println(nodeFld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createRecord

Descripción:

Método	Valores de retorno	Descripción
createRecord(String token, String parentUuid, String recName)	NodeRecord	Crea un nuevo expediente.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• El parámetro recName es el nombre del expediente.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeRecord;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            NodeRecord nodeRec = okmImport.createRecord(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "newRecordName");
            System.out.println(nodeRec);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createRecord (con metadatos)

Descripción:

Método	Valores de retorno	Descripción
createRecord(String token, String parentUuid, String name, Calendar created, String author)	NodeRecord	Crea un nuevo expediente conservando la fecha de creación y el autor originales.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• Use esta sobrecarga cuando migre contenido desde sistemas externos y necesite conservar la fecha de creación y el autor originales.

Ejemplo:

package com.openkm;

import java.util.Calendar;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeRecord;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            Calendar created = Calendar.getInstance();
            NodeRecord nodeRec = okmImport.createRecord(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", "newRecordName", created, "okmAdmin");
            System.out.println(nodeRec);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createMail

Descripción:

Método	Valores de retorno	Descripción
createMail(String token, String parentUuid, File file)	NodeMail	Crea un nuevo correo.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• El parámetro file es el fichero del correo.

Ejemplo:

package com.openkm;

import java.io.File;

import com.openkm.api.OKMImport;
import com.openkm.db.bean.NodeMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            File file = new File("/home/openkm/message.eml");
            NodeMail nodeMail = okmImport.createMail(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", file);
            System.out.println(nodeMail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

importFolder

Descripción:

Método	Valores de retorno	Descripción
importFolder(String token, String parentUuid, File folder, int threads)	int	Importa una jerarquía de carpetas local. Devuelve el número de errores encontrados durante la importación.

• El parámetro parentUuid debe ser un UUID de carpeta o expediente válido.
• El valor threads establece el número de hilos concurrentes usados por la funcionalidad de importación. Este valor nunca debe superar el número de núcleos del servidor. Si tiene 20 núcleos, un buen punto de partida podría ser usar 10 hilos; tenga en cuenta que otro software, como la base de datos y el SO, también usa el hardware.

Ejemplo:

package com.openkm;

import java.io.File;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMImport okmImport = ContextWrapper.getContext().getBean(OKMImport.class);
            File fld = new File("/home/openkm/import/");
            int errors = okmImport.importFolder(null, "0a19e616-1d11-4ef7-a7c7-f1e109f8ea3c", fld, 4);
            System.out.println("Import errors: " + errors);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}