Conversion samples

Básico

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

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

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el servicio web, la sesión se mantiene en el objeto del servicio web. 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 Conversion de la clase “conversion”, tal y como se muestra a continuación:

ws.conversion.doc2pdf(is, "test.docx");

Métodos

doc2pdf

Descripción:

Método	Valores de retorno	Descripción
doc2pdf(FileStream is, String fileName)	Stream	Recupera el documento subido, convertido a formato PDF.

El parámetro fileName es el nombre del fichero del documento. La aplicación usa este parámetro para identificar el tipo MIME del documento a partir de su extensión.

Precaución

El servicio de OpenOffice debe estar habilitado en el servidor de OpenKM para que esto funcione.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream inputFile = new FileStream("C:\\Documents\\test.docx", FileMode.Open);
                Stream tmpFile= ws.conversion.doc2pdf(inputFile, "test.docx");
                inputFile.Close();
                FileStream outputFile = new FileStream("C:\\Documents\\out.pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                tmpFIle.CopyTo(outputFile);
                outputFile.Close();
                tmpFIle.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

imageConvert

Descripción:

Método	Valores de retorno	Descripción
imageConvert(FileStream fs, String fileName, List params, String dstMimeType)	Stream	Recupera la imagen subida con las transformaciones aplicadas.

La variable fileName es el nombre del fichero del documento. La aplicación usa esta variable para identificar el tipo MIME del documento a partir de su extensión.

El parámetro dstMimeType es el tipo MIME esperado del documento resultante.

Consejo

Al usar este método, en realidad está ejecutando la herramienta de conversión ImageMagick en el lado del servidor.

Puede establecer muchos parámetros -transformaciones- en la variable params. Consulte ImageMagick convert tool para ver el listado completo.

Precaución

La herramienta de conversión de imágenes debe estar habilitada en el servidor de OpenKM para que esto funcione.

Cuando el valor de params no esté vacío, siempre debe terminar con la cadena “${fileIn} ${fileOut}”.

Asegúrese de dejar un único carácter de espacio como separador entre dos parámetros.

Al desarrollar sus integraciones, le recomendamos instalar el software ImageMagick en local y comprobar primero sus transformaciones de imagen desde la línea de comandos.

Ejemplo:

using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fileStream = new FileStream("C:\\Documents\\test.jpg", FileMode.Open, FileAccess.Read);
                List<string> param = new List<string>();
                param.Add("-resize 50% ${fileIn} ${fileOut}");
                Stream tmpFIle = ws.conversion.imageConvert(fileStream, test.jpg, param, "image/png");
                fileStream.Close();
                FileStream destFile = new FileStream("C:\\Documents\\test.png", FileMode.OpenOrCreate);
                tmpFIle.CopyTo(destFile);
                destFile.Close();
                tmpFIle.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

html2pdf

Descripción:

Método	Valores de retorno	Descripción
html2pdf(String url)	Stream	Recupera el PDF a partir de una URL.

Precaución

La herramienta de conversión de HTML a PDF debe estar habilitada en el servidor de OpenKM para que esto funcione.

Ejemplo:

using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Stream tmpFile = ws.conversion.html2pdf("http://www.openkm.com");
                FileStream destFile = new FileStream("C:\\Documents\\test.pdf", FileMode.OpenOrCreate);
                tmpFile.CopyTo(destFile);
                destFile.Close();
                tmpFile.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

doc2txt

Descripción:

Método	Valores de retorno	Descripción
doc2txt(FileStream fs, String fileName)	String	Extrae el texto del documento subido.

Precaución

Debe haber un extractor de texto habilitado para el tipo MIME del documento en el servidor de OpenKM para que esto funcione.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fileStream = new FileStream("C:\\Documents\\test.docx", FileMode.Open);
                System.Console.WriteLine(ws.conversion.doc2txt(fileStream, "test.docx"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

img2txt

Descripción:

Método	Valores de retorno	Descripción
img2txt(FileStream fs, String fileName)	String	Extrae el texto de la imagen subida.

Precaución

El motor OCR debe estar habilitado en el servidor de OpenKM para que esto funcione.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fileStream = new FileStream("C:\\Images\\test.png", FileMode.Open);
                System.Console.WriteLine(ws.conversion.img2txt(fileStream, "test.png"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

barcode2txt

Descripción:

Método	Valores de retorno	Descripción
barcode2txt(FileStream fs, String fileName)	String	Extrae el texto del código de barras de la imagen subida.

Precaución

La herramienta de códigos de barras debe estar habilitada en el servidor de OpenKM para que esto funcione.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                FileStream fileStream = new FileStream("C:\\Images\\test.png", FileMode.Open);
                System.Console.WriteLine(ws.conversion.barcode2txt(fileStream, "test.png"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}