Wizard samples

 Basics

Tip

Example of UUID:

• Using UUID -> “373bcdd0-c082-4e7b-addd-e10ef813946e”;

Suggested code sample

First, you must create the webservice object:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

Then you should log in using the method “login”. You can access the “login” method from the webservice object “ws” as shown below:

ws.login(user, password);

Caution

Once you are logged in with the web services, the session is kept in the webservice object. Then you can use the other API methods.

At this point you can use all the wizard methods from “wizard” class as shown below:

ws.wizard.findByUser();

Methods

findByUser

Description:

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

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                List<WizardNode> list = ws.wizard.findByUser();                foreach (WizardNode wizardNode in list)                {                    Console.WriteLine(wizardNode.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

findByUserAndUuid

Description:

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

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                WizardNode wn= ws.wizard.findByUserAndUuid("5458e52a-58a5-4b5d-ac89-e4e5837924a9");                Console.WriteLine(wn.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

hasWizardByUserAndNode

Description:

Method	Return values	Description
hasWizardByUserAndNode(String uuid)	bool	Checks if a node has a wizard.

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);                Console.WriteLine("Has a wizard active: " + ws.wizard.hasWizardByUserAndNode("5458e52a-58a5-4b5d-ac89-e4e5837924a9").toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteAll

Description:

Method	Return values	Description
deleteAll()	void	Removes all wizards for the user.

Caution

Only wizards assigned to the user session will be removed.

Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                ws.wizard.deleteAll();                Console.WriteLine("Delete all");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addShowWizardCategories

Description:

Method	Return values	Description
addShowWizardCategories(String uuid, int order)	void	Adds show wizard categories to the wizard of a node.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);                int order = 0;
                ws.wizard.addShowWizardCategories("055b5206-35d0-4351-ba92-c304bbba7ddf", order);                Console.WriteLine("addShowWizardCategories");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

removeShowWizardCategories

Description:

Method	Return values	Description
removeShowWizardCategories(String uuid)	void	Removes show wizard categories from the wizard of a node.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                ws.wizard.removeShowWizardCategories("055b5206-35d0-4351-ba92-c304bbba7ddf");                Console.WriteLine("removeShowWizardCategories");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addShowWizardKeywords

Description:

Method	Return values	Description
addShowWizardKeywords(String uuid, int order)	void	Adds show wizard keywords to the wizard of a node.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);                int order = 0;
                ws.wizard.addShowWizardKeywords("055b5206-35d0-4351-ba92-c304bbba7ddf", order);                Console.WriteLine("addShowWizardKeywords");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

removeShowWizardKeywords

Description:

Method	Return values	Description
removeShowWizardKeywords(String uuid)	void	Removes show wizard keywords from the wizard of a node.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                ws.wizard.removeShowWizardKeywords("055b5206-35d0-4351-ba92-c304bbba7ddf");                Console.WriteLine("removeShowWizardKeywords");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addGroup

Description:

Method	Return values	Description
addGroup(String uuid, String group, int order)	void	Adds a metadata group to the wizard.

Note

The parameter uuid is the unique node identifier.

The parameter group is the group name.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);                int order = 0;
                ws.wizard.addGroup("055b5206-35d0-4351-ba92-c304bbba7ddf", "okg:testing", order);                Console.WriteLine("addGroup");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

removeGroup

Description:

Method	Return values	Description
removeGroup(String uuid, String group)	void	Removes a metadata group from the wizard.

Note

The parameter uuid is the unique node identifier.

The parameter group is the group name.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                ws.wizard.removeGroup("055b5206-35d0-4351-ba92-c304bbba7ddf", "okg:testing");                Console.WriteLine("removeGroup");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setAutostart

Description:

Method	Return values	Description
setAutostart(String uuid)	void	Sets auto-start for the wizard.

Caution

Autostart should always be set as the last wizard option.

 Example:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;
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);

            try
            {
                ws.login(user, password);
                ws.wizard.setAutostart("055b5206-35d0-4351-ba92-c304bbba7ddf");                Console.WriteLine("setAutostart");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}