OKMWorkflow

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

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

Methods

registerProcessDefinition

Description:

Example:

package com.openkm;

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

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            InputStream is = new FileInputStream("/opt/files/Purchase.par");
            OKMWorkflow.getInstance().registerProcessDefinition(null, is);
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteProcessDefinition

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long pdId = 5; // Valid workflow process definition
            OKMWorkflow.getInstance().deleteProcessDefinition(null, pdId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProcessDefinitionImage

Description:

Example:

package com.openkm;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileOutputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long pdId = 5; // Valid workflow process definition
            byte[] img = OKMWorkflow.getInstance().getProcessDefinitionImage(null, pdId, "/okm:root/sample.pdf");
            ByteArrayInputStream in = new ByteArrayInputStream(img);
            FileOutputStream out = new FileOutputStream(new File("/home/test/img.jpg"));
            IOUtils.copy(in, out);
            IOUtils.closeQuietly(in);
            IOUtils.closeQuietly(out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProcessDefinitionForms

Description:

Example:

package com.openkm;

import java.util.List;
import java.util.Map;

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

public class Test {
    public static void main(String[] args) {
        try {
            long pdId = 5; // Valid workflow process definition
            Map<String,List<FormElement>> map = OKMWorkflow.getInstance().getProcessDefinitionForms(null, pdId);
            for (String key : map.keySet()) {
                System.out.println("group:"+key);
                for (FormElement fe : map.get(key)) {
                    System.out.println(fe);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

runProcessDefinition

Description:

Example:

package com.openkm;

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

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.form.FormElement;
import com.openkm.bean.form.Input;
import com.openkm.bean.form.TextArea;

public class Test {
    public static void main(String[] args) {
        try {
            long pdId = 8041; // Some valid workflow process definition id
            List<FormElement> feList = new ArrayList<>(); // Case as part of starting workflow are required form parameter
            Input price = new Input();
            price.setName("price");
            price.setValue("1000");
            feList.add(price);
            TextArea textArea = new TextArea();
            textArea.setName("description");
            textArea.setValue("some description here");
            feList.add(textArea);
            OKMWorkflow.getInstance().runProcessDefinition(null, pdId, "f86cc22d-9b50-434f-a940-b04cea9c0048", feList);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendProcessInstanceSignal

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long pId = 1046; // Some valid process instance id
            OKMWorkflow.getInstance().sendProcessInstanceSignal(null, pId, "jump2");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

endProcessInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long pId = 1046; // Some valid process instance id
            OKMWorkflow.getInstance().endProcessInstance(null, pId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteProcessInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long pId = 1046; // Some valid process instance id
            OKMWorkflow.getInstance().deleteProcessInstance(null, pId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findProcessInstances

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessDefinition;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all workflow definitions
            for (ProcessDefinition pd : OKMWorkflow.getInstance().findAllProcessDefinitions(null)) {
                System.out.println("WF definition: "+pd);
                
                // Get all process of some workflow definition
                for (ProcessInstance pi : OKMWorkflow.getInstance().findProcessInstances(null, pd.getId())) {
                    System.out.println("PI: "+pi);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllProcessDefinitions

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessDefinition;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all workflow definitions
            for (ProcessDefinition pd : OKMWorkflow.getInstance().findAllProcessDefinitions(null)) {
                System.out.println("WF definition: "+pd);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findLatestProcessDefinitions

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessDefinition;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all workflow definitions
            for (ProcessDefinition pd : OKMWorkflow.getInstance().findLatestProcessDefinitions(null)) {
                System.out.println("WF definition: "+pd);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findLastProcessDefinition

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessDefinition;

public class Test {
    public static void main(String[] args) {
        try {
            ProcessDefinition pd = OKMWorkflow.getInstance().findLastProcessDefinition(null, "purchase");
            System.out.println("WF definition: " + pd);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllProcessDefinitionVersions

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessDefinition;

public class Test {
    public static void main(String[] args) {
        try {
            for (ProcessDefinition pd : OKMWorkflow.getInstance().findAllProcessDefinitionVersions(null, "purchase")) {
                System.out.println("WF definition: " + pd);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProcessInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long piId = 8108; // Some valid process instance id
            ProcessInstance pi = OKMWorkflow.getInstance().getProcessInstance(null, piId);
            System.out.println("PI: " + pi);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

suspendProcessInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long piId = 8108; // Some valid process instance id
            OKMWorkflow.getInstance().suspendProcessInstance(null, piId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

resumeProcessInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long piId = 8108; // Some valid process instance id
            OKMWorkflow.getInstance().resumeProcessInstance(null, piId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addProcessInstanceVariable

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long piId = 8108; // Some valid process instance id
            OKMWorkflow.getInstance().addProcessInstanceVariable(null, piId, "key", "value");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteProcessInstanceVariable

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.ProcessInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long piId = 8108; // Some valid process instance id
            OKMWorkflow.getInstance().deleteProcessInstanceVariable(null, piId, "key");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findUserTaskInstances

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.TaskInstance;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all user task intances
            for (TaskInstance ti : OKMWorkflow.getInstance().findUserTaskInstances(null)) {
                System.out.println(ti);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findPooledTaskInstances

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.TaskInstance;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all user task intances
            for (TaskInstance ti : OKMWorkflow.getInstance().findPooledTaskInstances(null)) {
                System.out.println(ti);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findTaskInstances

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.TaskInstance;

public class Test {
    public static void main(String[] args) {
        try {
            // Get all user task intances
            long piId = 8108; // Some valid process instance id
            for (TaskInstance ti : OKMWorkflow.getInstance().findTaskInstances(null, piId)) {
                System.out.println(ti);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTaskInstanceValues

Description:

Example:

package com.openkm;

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

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

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            List<FormElement> feList = new ArrayList<>();
            OKMWorkflow.getInstance().setTaskInstanceValues(null, tiId, "approve", feList);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addTaskInstanceComment

Description:

Example:

package com.openkm;

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

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().addTaskInstanceComment(null, tiId, "here the comment");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getTaskInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.TaskInstance;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            TaskInstance ti = OKMWorkflow.getInstance().getTaskInstance(null, tiId);
            System.out.println(ti);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTaskInstanceActorId

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().setTaskInstanceActorId(null, tiId, "okmAdmin");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addTaskInstanceVariable

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().addTaskInstanceVariable(null, tiId, "key", "value");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteTaskInstanceVariable

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().deleteTaskInstanceVariable(null, tiId, "key");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

startTaskInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().startTaskInstance(null, tiId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

endTaskInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().endTaskInstance(null, tiId, "end");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

suspendTaskInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().suspendTaskInstance(null, tiId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

resumeTaskInstance

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;

public class Test {
    public static void main(String[] args) {
        try {
            long tiId = 8110; // Some valid task instance id
            OKMWorkflow.getInstance().resumeTaskInstance(null, tiId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getToken

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            Token tk = OKMWorkflow.getInstance().getToken(null, tkId);
            System.out.println(tk);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addTokenComment

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            Token tk = OKMWorkflow.getInstance().addTokenComment(null, tkId, "here the comment");
            System.out.println(tk);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

suspendToken

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            Token tk = OKMWorkflow.getInstance().suspendToken(null, tkId);
            System.out.println(tk);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

resumeToken

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            Token tk = OKMWorkflow.getInstance().resumeToken(null, tkId);
            System.out.println(tk);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendTokenSignal

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            Token tk = OKMWorkflow.getInstance().sendTokenSignal(null, tkId, "end");
            System.out.println(tk);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTokenNode

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            OKMWorkflow.getInstance().setTokenNode(null, tkId, "formA");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

endToken

Description:

Example:

package com.openkm;

import com.openkm.api.OKMWorkflow;
import com.openkm.bean.workflow.Token;

public class Test {
    public static void main(String[] args) {
        try {
            long tkId = 8110; // Some valid token id
            OKMWorkflow.getInstance().setTokenNode(null, tkId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}