Wizard Samples

Basics

Example of uuid:

Using UUID -> "373bcdd0-c082-4e7b-addd-e10ef813946e";

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

Then should login using the method "login". You can access the "login" method from webservice object "ws" as is shown below:

ws.login(user, password);

Once you are logged with the webservices the session is keep in the webservice Object. Then you can use the other API method

At this point you can use all the Wizard methods from "wizard" class as is shown below:

ws.wizard.findByUser();

Methods

findByUser

Description:

Method	Return values	Description
findByUser()	List<WizardNode>	Returns a list of nodes with a wizard.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            List<WizardNode> list = ws.wizard.findByUser();
            for (WizardNode wizardNode : list) {
                System.out.println(wizardNode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllByUser

Description:

Method	Return values	Description
findAllByUser()	List<WizardNode>	Returns a list of all nodes with an assigned wizard.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.List;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            List<WizardNode> list = ws.wizard.findAllByUser();
            for (WizardNode wizardNode : list) {
                System.out.println(wizardNode);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findByUserAndUuid

Description:

Method	Return values	Description
findByUserAndUuid(String uuid)	WizardNode	Get the wizard of a node

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            WizardNode wizardNode = ws.wizard.findByUserAndUuid("11225723-883f-4c12-8816-650b2c82c89b");
            System.out.println(wizardNode);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasWizardByUserAndNode

Description:

Method	Return values	Description
hasWizardByUserAndNode()	boolean	Know if a node has a wizard

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            System.out.println("The node has a wizard: " + ws.wizard.hasWizardByUserAndNode("11225723-883f-4c12-8816-650b2c82c89b"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteAll

Description:

Method	Return values	Description
deleteAll()	void	Remove all wizards of the user.
Only wizards assigned to the user session will be removed.

Method

Return values

Description

deleteAll()

void

Remove all wizards of the user.

Only wizards assigned to the user session will be removed.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.deleteAll();
            System.out.println("Delete all");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

postponeNode

Description:

Method	Return values	Description
postponeNode(String uuid, Calendar date)	void	Postpones the node specified UUID to the given date

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

import java.util.Calendar;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Calendar calendar = Calendar.getInstance();
            calendar.set(Calendar.DAY_OF_MONTH, 15);
            ws.wizard.postponeNode("cd4f69ed-e517-408b-b7eb-95cfe371ecba", calendar);
            System.out.println("postponeNode");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

cancelPostponeNode

Description:

Method	Return values	Description
cancelPostponeNode(String uuid)	void	Cancels the postponement of the node with the specified UUID

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.cancelPostponedNode("cd4f69ed-e517-408b-b7eb-95cfe371ecba");
            System.out.println("cancelPostponedNode");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteByNode

Description:

Method	Return values	Description
deleteByNode(String uuid)	void	Delete the wizard node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.deleteByNode("cd4f69ed-e517-408b-b7eb-95cfe371ecba");
            System.out.println("deleteByNode");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addDigitalSignature

Description:

Method	Return values	Description
addDigitalSignature()	void	Add digital signature in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.addDigitalSignature("055b5206-35d0-4351-ba92-c304bbba7ddf");
            System.out.println("addDigitalSignature");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeDigitalSignature

Description:

Method	Return values	Description
removeDigitalSignature	void	Remove digital signature in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeDigitalSignature("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("removeDigitalSignature");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addShowWizardCategories

Description:

Method	Return values	Description
addShowWizardCategories	void	Add show wizard categories in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeDigitalSignature("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("removeDigitalSignature");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeShowWizardCategories

Description:

Method	Return values	Description
removeShowWizardCategories	void	Remove show wizard categories in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeShowWizardCategories("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("removeShowWizardCategories");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addShowWizardKeywords

Description:

Method	Return values	Description
addShowWizardKeywords	void	Add show wizard keywords in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.addShowWizardKeywords("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("addShowWizardKeywords");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeShowWizardKeywords

Description:

Method	Return values	Description
removeShowWizardKeywords	void	Remove show wizard keywords in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeShowWizardKeywords("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("removeShowWizardKeywords");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addShowWizardOCRDataCapture

Description:

Method	Return values	Description
addShowWizardOCRDataCapture	void	Add show wizard OCR data capture in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.addShowWizardOCRDataCapture("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("addShowWizardOCRDataCapture");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeShowWizardOCRDataCapture

Description:

Method	Return values	Description
removeShowWizardOCRDataCapture	void	Remove show wizard OCR data capture in the wizard of a node.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeShowWizardOCRDataCapture("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("removeShowWizardOCRDataCapture");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addGroup

Description:

Method	Return values	Description
addGroup(String uuid, String group)	void	Add metadata group in the wizard.
The parameter uuid is the unique node identifier. The parameter group is the group name.

Method

Return values

Description

addGroup(String uuid, String group)

void

Add metadata group in the wizard.

The parameter uuid is the unique node identifier.

The parameter group is the group name.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.addGroup("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "okg:tpl");
            System.out.println("addGroup");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeGroup

Description:

Method	Return values	Description
removeGroup(String uuid, String group)	void	Remove metadata group in the wizard.
The parameter uuid is the unique node identifier. The parameter group is the group name.

Method

Return values

Description

removeGroup(String uuid, String group)

void

Remove metadata group in the wizard.

The parameter uuid is the unique node identifier.

The parameter group is the group name.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeGroup("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "okg:tpl");
            System.out.println("removeGroup");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addWorkflow

Description:

Method	Return values	Description
addWorkflow(String uuid, String workflow)	void	Add a workflow in the wizard.
The parameter uuid is the unique node identifier. The parameter workflow is the workflow name.

Method

Return values

Description

addWorkflow(String uuid, String workflow)

void

Add a workflow in the wizard.

The parameter uuid is the unique node identifier.

The parameter workflow is the workflow name.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.addWorkflow("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "purchase");
            System.out.println("addGroup");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeWorkflow

Description:

Method	Return values	Description
removeWorkflow(String uuid, String workflow)	void	Remove a workflow in the wizard.
The parameter uuid is the unique node identifier. The parameter workflow is the workflow name.

Method

Return values

Description

removeWorkflow(String uuid, String workflow)

void

Remove a workflow in the wizard.

The parameter uuid is the unique node identifier.

The parameter workflow is the workflow name.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.removeWorkflow("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae", "purchase");
            System.out.println("addGroup");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setAutostart

Description:

Method	Return values	Description
setAutostart	void	Set auto start to the wizard.
Autostart should be always set as the last wizard options.

Method

Return values

Description

setAutostart

void

Set auto start to the wizard.

Autostart should be always set as the last wizard options.

Example:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.wizard.setAutostart("02add6bf-e5ac-4f4a-8f3f-922958f5b6ae");
            System.out.println("setAutostart");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Table of contents [ Hide Show ]

Basics

Suggested code sample

Methods

findByUser
findAllByUser
findByUserAndUuid
hasWizardByUserAndNode
deleteAll
postponeNode
cancelPostponeNode
deleteByNode
addDigitalSignature
removeDigitalSignature
addShowWizardCategories
removeShowWizardCategories
addShowWizardKeywords
removeShowWizardKeywords
addShowWizardOCRDataCapture
removeShowWizardOCRDataCapture
addGroup
removeGroup
addWorkflow
removeWorkflow
setAutostart

SDK for Java 4.14

Wizard Samples

Basics

Suggested code sample

Methods

findByUser

findAllByUser

findByUserAndUuid

hasWizardByUserAndNode

deleteAll

postponeNode

cancelPostponeNode

deleteByNode

addDigitalSignature

removeDigitalSignature

addShowWizardCategories

removeShowWizardCategories

addShowWizardKeywords

removeShowWizardKeywords

addShowWizardOCRDataCapture

removeShowWizardOCRDataCapture

addGroup

removeGroup

addWorkflow

removeWorkflow

setAutostart