Page History

Sometime Sometimes, you may found find that your plugin may need needs to make an AJAX call to retrieve data from an API that does not come default with Joget Workflow v3. So, normally And normally, in order to do that, you will need to write a Servlet or Web Service to handle the call.

In Joget, our plugin architecture provided provides an interface that enables you to enable you implement your Web Service in a plugin. 

For the The example below , I will used uses Form Element Plugin as example but the .  However, the interface can use be used with any other Plugin Types. 

package org.joget.sample.lib;

import java.io.IOException;
import org.joget.apps.form.model.Element;
import org.joget.plugin.base.PluginWebSupport;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class SimpleFormElement extends Element implements PluginWebSupport {

    //... Other Implemented Methods ...

    @Override
    public void webService(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {


        // Get Parameter
        String text = request.getParameter("say_something");


        // Write to response
        response.getWriter().write(text);
    }
}

After you done do your Web Service implemetationimplementation, you can may access to it by using the URL format as shown below:

{Context Path}/web/json/plugin/{Plugin Class Name}/service

...

http://localhost:8080/jw/web/json/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World

If your Web Service need needs to access to App Definition that make this the app definition that made the call, the URL format will take have to have an extra parameter, as shown below:

{Context Path}/web/json/app/{App Id}/{App Version}/plugin/{Plugin Class Name}/service

...

http://localhost:8080/jw/web/json/app/crm/1/plugin/org.joget.sample.lib.SimpleFormElement/service?say_something=Hello World

Then, you can get the App Definition You can then obtain the app definition in your implementation by using this code below:

AppDefinition appDef = AppUtil.getCurrentAppDefinition();

Sample Plugin 

sample.zip

There are 2 JSON APIs available in this sample plugin:

1. User List

{Context Path}/web/json/plugin/sample.JsonApiPlugin/service?action=userList&orgId={Organization Id}

2. Form Fields List

{Context Path}/web/json/app/{App Id}/{App Version}/plugin/sample.JsonApiPlugin/service?action=formFields&formId={Form Id}