PropertyGroup samples

Aspectos básicos

En casi todos los métodos verá el parámetro llamado “nodeId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de documento, carpeta, correo o expediente.

La clase com.openkm.sdk4j.util.ISO8601 debe usarse para establecer y analizar (parse) campos de metadatos de tipo fecha. Los valores de los campos de metadatos de tipo fecha se almacenan en la aplicación en formato básico ISO-8601.

Para convertir un campo de metadatos de tipo fecha obtenido a una fecha válida, use:

DateTime date = ISO8601.parseBasic(metadataFieldValue);

Para guardar un valor de fecha en un campo de metadatos de tipo fecha, use:

DateTime date = DateTime.now; // Present date
String metadataFieldValue = ISO8601.formatBasic(date);
// metadataFieldValue can be saved into repository metadata field of type date

Métodos

addGroup

Descripción:

Método	Valores de retorno	Descripción
addGroup(String nodeId, String grpName)	void	Añade un grupo de metadatos vacío a un nodo.

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

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

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
            {
                ws.addGroup("/okm:root/logo.png", "okg:consulting");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

removeGroup

Descripción:

Método	Valores de retorno	Descripción
removeGroup(String nodeId, String grpName)	void	Elimina un grupo de metadatos de un nodo.

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

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

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
            {
                ws.removeGroup("/okm:root/logo.png", "okg:consulting");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getGroups

Descripción:

Método	Valores de retorno	Descripción
getGroups(String nodeId)	List	Recupera una lista de los grupos de metadatos asignados a un nodo.

Ejemplo:

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

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
            {
                foreach (PropertyGroup pGroup in ws.getGroups("/okm:root/logo.png"))
                {
                System.Console.WriteLine(pGroup);
              }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAllGroups

Descripción:

Método	Valores de retorno	Descripción
getAllGroups()	List	Recupera una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

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

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
            {
                foreach (PropertyGroup pGroup in ws.getAllGroups())
                {
                   System.Console.WriteLine(pGroup);
          }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPropertyGroupProperties

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupProperties(String nodeId, String grpName)	List	Recupera una lista de todos los elementos del grupo de metadatos junto con los valores del nodo.

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.bean.form;

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
            {
                foreach(FormElement fElement in ws.getPropertyGroupProperties("/okm:root/logo.png", "okg:consulting"))
                {
                    System.Console.WriteLine(fElement);
                }

             }
             catch (Exception e)
             {
                 System.Console.WriteLine(e.ToString());
             }
        }
    }
}

getPropertyGroupForm

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupForm(String grpName)	List	Recupera una lista con todas las definiciones de elementos del grupo de metadatos.

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using com.openkm.sdk4csharp.bean.form;

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
            {
                foreach (FormElement fElement in ws.getPropertyGroupForm("okg:consulting"))
                {
                    System.Console.WriteLine(fElement);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setPropertyGroupProperties

Descripción:

Método	Valores de retorno	Descripción
setPropertyGroupProperties(String nodeId, String grpName, List ofeList)	void	Cambia los valores del grupo de metadatos de un nodo.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                // Modify with a full FormElement list
                List<FormElement> fElements = ws.getPropertyGroupProperties("/okm:root/logo.pdf","okg:consulting");
                foreach (FormElement fElement in fElements)
                {
                    if (fElement.name.Equals("okp:consulting.name"))
                    {
                        Input name = (Input) fElement;
                        name.value = "new value";
                    }
                }
                ws.setPropertyGroupProperties("/okm:root/logo.pdf","okg:consulting", fElements);
                // Same modification with only affected FormElement
                fElements = new  List<FormElement>();
                Input n = new Input();
                n.name = "okp:consulting.name";
                n.value = "new value";
                fElements.Add(n);
                ws.setPropertyGroupProperties("/okm:root/logo.pdf","okg:consulting", fElements);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setPropertyGroupPropertiesSimple

Descripción:

Método	Valores de retorno	Descripción
setPropertyGroupPropertiesSimple(String nodeId, String grpName, Dictionary<String, String> properties)	void	Cambia los valores del grupo de metadatos de un nodo.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Consulting" name="okg:consulting">
    <input label="Name" type="text" name="okp:consulting.name"/>
    <input label="Date" type="date" name="okp:consulting.date" />
    <checkbox label="Important" name="okp:consulting.important"/>
    <textarea label="Comment" name="okp:consulting.comment"/>
  </property-group>
</property-groups>

Para añadir varios valores a un campo de metadatos de tipo “multiple” como este:

<select label="Multiple" name="okp:consulting.multiple" type="multiple">
  <option label="One" value="one"/>
  <option label="Two" value="two"/>
  <option label="Three" value="three" />
</select>

Debe hacer:

properties.Add("okp:consulting.multiple", "one;two");

Donde “one” y “two” son valores válidos y el carácter “;” se usa como separador.

El grpName debe ser un nombre de grupo de Metadata válido.

Ejemplo:

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

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8180/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                Dictionary<String, String> properties = new  Dictionary<String, String>();
                properties.Add("okp:consulting.name", "new name");
          //The date fields must be saved with basic ISO 8601 format
    properties.Add("okp:consulting.date", ISO8601.formatBasic(DateTime.Now));
          ws.setPropertyGroupPropertiesSimple("/okm:root/logo.pdf","okg:consulting", properties);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

hasGroup

Descripción:

Método	Valores de retorno	Descripción
hasGroup(String nodeId, String grpName)	Boolean	Devuelve un booleano que indica si el nodo tiene un grupo de metadatos.

Ejemplo:

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

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
            {
                System.Console.WriteLine("Have metadata group:"+ws.hasGroup("/okm:root/logo.png","okg:consulting"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getRegisteredDefinition

Descripción:

Método	Valores de retorno	Descripción
getRegisteredDefinition()	String	Devuelve la definición XML de los grupos de metadatos.

Ejemplo:

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

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
            {
                System.Console.WriteLine(ws.getRegisteredDefinition());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

registerDefinition

Descripción:

Método	Valores de retorno	Descripción
registerDefinition(InputStream is)	void	Establece la definición XML de los grupos de metadatos en el repositorio..

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:8180/OpenKM";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host, username, password);
            try
            {
                 FileStream fs = new FileStream("E:\\PropertyGroups.xml",FileMode.Open);
                 ws.registerDefinition(fs);
                 fs.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getSuggestions

Descripción:

Método	Valores de retorno	Descripción
getSuggestions(String nodeId, String grpName, String propName)	List	Recupera una lista de valores sugeridos para un campo de metadatos.

El siguiente ejemplo se basa en esta definición de grupo de metadatos:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.0//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.0.dtd">
<property-groups>
  <property-group label="Technology" name="okg:technology">
    <select label="Type" name="okp:technology.type" type="multiple">
      <option label="Alfa" value="t1"/>
      <option label="Beta" value="t2" />
      <option label="Omega" value="t3" />
    </select>
    <select label="Language" name="okp:technology.language" type="simple">
      <option label="Java" value="java"/>
      <option label="Python" value="python"/>
      <option label="PHP" value="php" />
    </select>
    <input label="Comment" name="okp:technology.comment"/>
    <textarea label="Description" name="okp:technology.description"/>
    <input label="Link" type="link" name="okp:technology.link"/>
  </property-group>
</property-groups>

Ejemplo:

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

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
            {
                foreach(String value in ws.getSuggestions("/okm:root/logo.png","okg:technology", "okp:technology.language"))
                {
                     System.Console.WriteLine(value);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPropertyGroupPropertiesSimple

Descripción:

Método	Valores de retorno	Descripción
getPropertyGroupPropertiesSimple(String nodeId, String grpName)	Dictionary<String, String>	Obtiene un diccionario de pares (clave, valor) con los valores del grupo de metadatos de un nodo.

Ejemplo:

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

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
            {
                Dictionary<String, String> properties = new  Dictionary<String, String>();
                properties = ws.getPropertyGroupPropertiesSimple("/okm:root/logo.pdf","okg:technology");
                foreach (KeyValuePair<String, String> pair in properties)
                {
                     System.Console.WriteLine(pair.Key + "-> " + pair.Value);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}