Conversion samples

Methods

doc2pdf

Description:

Method	Return values	Description
doc2pdf(FileStream is, String fileName)	Stream	Retrieve the uploaded document converted to PDF format.

Caution

The OpenOffice service must be enabled in OpenKM server to get it running.

• The parameter fileName is the document file name. The application uses this parameter to identify by document extension the document MIME TYPE.

Example:

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, username, password);
            try
            {
                BeanHelper beanHelper = new BeanHelper();
                FileStream fileInput = new FileStream("C:\\Documents\\test.docx", FileMode.Open);
                Stream stream = ws.doc2pdf(fileInput, "test.docx");
                Byte[] data = beanHelper.ReadToEnd(stream);
                FileStream fileStream = new FileStream("C:\\Documents\\out.pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                foreach (byte b in data)
                {
                    fileStream.WriteByte(b);
                }
                fileStream.Close();
                fileInput.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

pdf2swf

Description:

Method	Return values	Description
pdf2swf(FileStream fs, String fileName)	Stream	Retrieve the uploaded document converted to SWF format.

Caution

The pdf2swf tool must be enabled in OpenKM server to get it running.

• The parameter fileName is the document file name. The application uses this parameter to identify by document extension the document MIME TYPE.

Example:

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, username, password);
            try
            {
                FileStream fileInput = new FileStream("C:\\Documents\\bitcoin.pdf", FileMode.Open);
                Stream stream = ws.pdf2swf(fileInput, "bitcoin.pdf");
                BeanHelper beanHelper = new BeanHelper();
                Byte[] data = beanHelper.ReadToEnd(stream);
                FileStream fileStream = new FileStream("C:\\Documents\\out.swf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                foreach (byte b in data)
                {
                    fileStream.WriteByte(b);
                }
                fileStream.Close();
                fileInput.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

imageConvert

Description:

Method	Return values	Description
imageConvert(FileStream fs, String fileName, List params, String dstMimeType)	Stream	Retrieve the uploaded image with transformation.

Tip

Using this method you are really executing on the server side the ImageMagick convert tool.

You can set a lot of parameters - transformations - in the params variable. Take a look at ImageMagick convert tool to get a complete list of them.

Caution

The image convert tool must be enabled in OpenKM server to get it running.

When params value is not empty always must contain ends with the chain “${fileIn} ${fileOut}”.

Ensure there is only a white space as a separator between two parameters.

When building your integrations, we suggest installing ImageMagic software locally and check your image transformations first from your command line.

• The variable fileName is the document file name. The application uses this variable to identify by document extension the document MIME TYPE.
• The parameter dstMimeType is the expected document MIME TYPE result.

Example:

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, username, password);
            try
            {
                FileStream filestream = new FileStream("C:\\Documents\\test.png", FileMode.Open);
                List<string> param = new List<string>();
                param.Add("-resize 50% ${fileIn} ${fileOut}");
                Stream stream = ws.imageConvert(filestream, "test.png", param, "image/jpeg");
                BeanHelper beanHelper = new BeanHelper();
                Byte[] data = beanHelper.ReadToEnd(stream);
                FileStream fileStream = new FileStream("C:\\Documents\\test.png", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                foreach (byte b in data)
                {
                    fileStream.WriteByte(b);
                }
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

html2pdf

Description:

Method	Return values	Description
html2pdf(String url)	Stream	Retrieve the PDF of an URL.

Caution

The HTML to PDF conversion tool must be enabled in OpenKM server to get it running

Example:

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, username, password);
            try
            {
                BeanHelper beanHelper = new BeanHelper();
                Stream stream = ws.html2pdf("http://www.openkm.com");
                Byte[] data = beanHelper.ReadToEnd(stream);
                FileStream fileStream = new FileStream("C:\\Documents\\test.pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
                foreach (byte b in data)
                {
                    fileStream.WriteByte(b);
                }
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

doc2txt

Description:

Method	Return values	Description
doc2txt(FileStream fs, String fileName)	String	Extracts the text from the uploaded document.

Caution

Must be enabled a Text Extractor for the document MIME TYPE in OpenKM server to get it running.

Example:

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, username, password);
            try
            {
                FileStream fileStream = new FileStream("C:\\Documents\\test.docx", FileMode.Open);
                System.Console.WriteLine(ws.doc2txt(fileStream, "test.docx"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

img2txt

Description:

Method	Return values	Description
img2txt(FileStream fs, String fileName)	String	Extracts the text from the uploaded image.

Caution

The OCR engine must be enabled in OpenKM server to get it running.

Example:

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, username, password);
            try
            {
                FileStream fileStream = new FileStream("C:\\Images\\test.png", FileMode.Open);
                System.Console.WriteLine(ws.img2txt(fileStream, "test.png"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

barcode2txt

Description:

Method	Return values	Description
barcode2txt(FileStream fs, String fileName)	String	Extracts the barcode text from the uploaded image.

Caution

The Bar Code tool must be enabled in OpenKM server to get it running.

Example:

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, username, password);
            try
            {
                FileStream fileStream = new FileStream("C:\\Images\\test.png", FileMode.Open);
                System.Console.WriteLine(ws.barcode2txt(fileStream, "test.png"));
                fileStream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}