OKMPropertyGroup

Basics

On most methods you’ll see a parameter named “nodeId”. The value of this parameter can be a valid document, folder, mail or record UUID or path.

The class com.openkm.util.ISO8601 should be used to set and parse metadata date fields. The metadata field of type date values is stored in the application in ISO-8601 basic format.

To convert the retrieved metada field of type date to a valid date use:

Calendar cal = ISO8601.parseBasic(metadataFieldValue);

To save the date value in the metadata field of type date use:

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

Also on all methods you’ll see parameter named “token”. When accessing application across SOAP the login process returns a token, what is used to identify the user on all the exposed methods. From default application execution context you must use “null” value what indicates to the application must use the “user session”.

Methods

addGroup

Description:

Method	Return values	Description
addGroup(String token, String nodeId, String grpName)	void	Adds an empty metadata group to a node.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().addGroup(null, "/okm:root/logo.png", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeGroup

Description:

Method	Return values	Description
removeGroup(String token, String nodeId, String grpName)	void	Removes a metadata group of a node.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().removeGroup(null, "/okm:root/logo.png", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroups

Description:

Method	Return values	Description
getGroups(String token, String nodeId)	List	Retrieves a list of metadata groups assigned to a node.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.PropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (PropertyGroup pg : OKMPropertyGroup.getInstance().getGroups(null, "/okm:root/logo.png")) {
                System.out.println(pg);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllGroups

Description:

Method	Return values	Description
getAllGroups(String token)	List	Retrieves a list of all metadata groups set into the application.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.PropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (PropertyGroup pg : OKMPropertyGroup.getInstance().getAllGroups(null)) {
                System.out.println(pg);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Description:

Method	Return values	Description
getProperties(String token, String nodeId, String grpName)	List	Retrieves a list of all metadata group elements and its node values.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;

public class Test {
    public static void main(String[] args) {
        try {
            for (FormElement fe : OKMPropertyGroup.getInstance().getProperties(null,"/okm:root/logo.png", "okg:consulting")) {
                System.out.println(fe);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertiesSimple

Description:

Method	Return values	Description
getPropertiesSimple(String token, String nodeId, String grpName)	Map<String, String>	Retrieves a list of all metadata group elements and its node values.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import java.util.Map;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            Map<String, String> properties = OKMPropertyGroup.getInstance().getPropertiesSimple(null,"/okm:root/logo.png", "okg:consulting");
            for (String key : properties.keySet()) {
                System.out.println(key + ":" + properties.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setProperties

Description:

Method	Return values	Description
setProperties(String token, String nodeId, String grpName, List properties)	void	Changes the metadata group values of a node.

The sample below is based on this Metadata group definition:

<?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>

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;
import com.openkm.bean.form.Input;

public class Test {
    public static void main(String[] args) {
        try {
            List<FormElement> fElements = OKMPropertyGroup.getInstance().getProperties(null, "/okm:root/logo.pdf","okg:consulting");
            for (FormElement fElement : fElements) {
                if (fElement.getName().equals("okp:consulting.name")) {
                    Input name = (Input) fElement;
                    name.setValue("new value");
                }
            }

            OKMPropertyGroup.getInstance().setProperties(null, "/okm:root/logo.pdf", "okg:consulting", fElements);

            // Same modification with only affected FormElement
            fElements = new ArrayList<>();
            Input name = new Input();
            name.setName("okp:consulting.name");
            name.setValue("new value");
            fElements.add(name);
            OKMPropertyGroup.getInstance().setProperties(null, "/okm:root/logo.pdf","okg:consulting", fElements);

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

setPropertySimple

Description:

Method	Return values	Description
setPropertySimple(String token, String nodeId, String propGroup, String propName, String propValue)	void	Changes the metadata group field value of a node.

The sample below is based on this Metadata group definition:

<?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>

To add several values on a metadata field of type multiple like this:

<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>

You should do:

"one;two";

Where “one” and “two” are valid values and character “;” is used as separator.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            OKMPropertyGroup.getInstance().setPropertySimple(null, "/okm:root/logo.pdf","okg:consulting", "okp:consulting.name", "new name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setPropertiesSimple

Description:

Method	Return values	Description
setPropertiesSimple(String token, String nodeId, String grpName, Map<String, String> properties)	void	Changes the metadata group valuea of a node.

The sample below is based on this Metadata group definition:

<?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>

To add several values on a metadata field of type multiple like this:

<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>

You should do:

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

Where “one” and “two” are valid values and character “;” is used as separator.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.util.ISO8601;

public class Test {
    public static void main(String[] args) {
        try {
            Map<String, String> properties = new HashMap<>();
            properties.put("okp:consulting.name", "new name");

            // Date fields must be saved with basic ISO 8601 format
            properties.put("okp:consulting.date", ISO8601.formatBasic(Calendar.getInstance()));
            OKMPropertyGroup.getInstance().setPropertiesSimple(null, "/okm:root/logo.pdf","okg:consulting", properties);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupForm

Description:

Method	Return values	Description
getPropertyGroupForm(String token, String grpName)	List	Retrieves a list of all metadata group elements definition.

The grpName should be a valid Metadata group name.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;
import com.openkm.bean.form.FormElement;

public class Test {
    public static void main(String[] args) {
        try {
            for (FormElement fe : OKMPropertyGroup.getInstance().getPropertyGroupForm(null, "okg:consulting")) {
                System.out.println(fe);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasGroup

Description:

Method	Return values	Description
hasGroup(String token, String nodeId, String grpName)	boolean	Returns a boolean that indicate if the node has or not a metadata group.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            boolean found = OKMPropertyGroup.getInstance().hasGroup(null, "/okm:root/logo.pdf", "okg:consulting");
            System.out.println(found);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestions

Description:

Method	Return values	Description
getSuggestions(String token, String nodeId, String grpName, String propName)	List	Retrieves a list of a suggested metadata field values.

The sample below is based on this Metadata group definition:

<?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>

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            for (String value : OKMPropertyGroup.getInstance().getSuggestions(null, "/okm:root/logo.pdf","okg:technology", "okp:technology.language")) {
                System.out.println(value);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

registerDefinition

Description:

Method	Return values	Description
registerDefinition(String token, String pgDef)	void	Set the XML Metada groups definition into the repository.

Example:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            is = new FileInputStream("/home/files/PropertyGroups.xml");
            String pgDef = IOUtils.toString(is);
            OKMPropertyGroup.getInstance().registerDefinition(null, pgDef);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

getRegisteredDefinition

Description:

Method	Return values	Description
getRegisteredDefinition(String token)	String	Returns the XML Metada groups definition.

Example:

package com.openkm;

import com.openkm.api.OKMPropertyGroup;

public class Test {
    public static void main(String[] args) {
        try {
            String pgDef = OKMPropertyGroup.getInstance().getRegisteredDefinition(null);
            System.out.println(pgDef);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}