nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Convert CGI task from Perl to Java URL Task

TeamsiteDev

Hi,

I am using PLC workflow for deployments where I have added my own CGI task which sets the complete Vpath of a file into a EA called TeamSite/Metadata/Path . This task checks for .page files and sets this EA and skips other files. It is working fine but when large number of files are added to single job, this task takes very long to complete & sometimes even times-out. So to make it faster I want to convert it to Java. I have been checking the CSSDK APi and have written a code but not sure how to set it in External task in workflow. Please can you suggest how to go ahead with it ?

The OOTB workflow tasks work on beans which are defined in workflow-resource-config.xml file but I am not sure how to run my custom code in external task.

Thanks!

Regards,

Ankit

Find more posts tagged with

Comments

Adam Stoller

I did something like this (adding a custom CGI Task to [a copy of] the PLC workflow) about a year or so ago - from my notes, I did the following:

Modified the customer_src/web.xml file

<web-app>
  <filter-mapping>
    <filter-name>authentication</filter-name>
    <servlet-name>name-of-servlet</servlet-name> 
  </filter-mapping>
  <servlet>
    <servlet-name>name-of-servlet</servlet-name>
    <servlet-class>com.****.wfm.name-of-class-sans-extension</servlet-class>
  </servlet>
</web-app>

Modified the customer_src/etc/conf/customer/log4j.xml file so my code's diagnostic messages would have somewhere (that I wanted) to go

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false"> 
  <appender name="CUSTOM" class="org.apache.log4j.RollingFileAppender">
    <param name="File" value="${iw.client.log.path}/custom.log"/>
    ...
  </appender>
  <logger name="com.****" additivity="false">
    <level value="debug"/>
    <appender-ref ref="CUSTOM"/>
  </logger>
</log4j:configuration>

Created a JSP front-end in customer_src/web/custom/
Created the class files in customer_src/src/com/****/.../
In my case, the custom CGI went between "Attach Dependencies" and "Check Migration Status", so I adjusted the transition links in the WFM appropriately, including to/from "Resolve Job Errors"
For the task properties, I set the CGI Script Name to: /iw-cc/custom/my-custom.jsp

That's all I have in my notes - obviously your situation may be different, but hopefully that will help.

TeamsiteDev

Hi Adam,

Thanks for the details. I will try to work it out.

Kalam

Hi Ankit,

Addition to Ghoti's solution.

If you do not want to open any window or page during this task i.e if it does not need any inputs from the user then you can go ahead and use URL external task instead of the JSP . If you want to only set the EA to the .page then you can go for the URLExternal task.

For this you will need

1.Place the class at <<iw-home>>\local\config\lib\content_center\customer_src\src folder.

2. Run iw-home/bin/make_toolkit.ipl.

3. In URLExternalTask, in the class name variable, give this fully qualified classname i.e with complete package name

Thanks

Kalam

Adam Stoller

If the intention is to add this task in between two of the existing CGI tasks in the PLC workflow, it needs to be a CGI Task, not a URL ExternalTask.

If the intention is to add this task after all the existing CGI tasks in the PLC workflow, then it can be CGI Task (if it requires user-interaction), or URL External Task or even just plain-old External Task (if it does not require user-interaction)

Kalam

Hi Adam,

Thank you for the clarification.

Regards

Kalam

TeamsiteDev

Thanks Adam & Kalam for your responses.

I used a URL Task in between two CGI tasks. I gave complete path of JAVA class in a task variable named "ClassName". I created a jar for the java code and copied it directly to iw-cc.war/WEB/lib and restarted JBoss. Now my code is running fine, it is fetching the file type & if its a page then sets the complete the vpath as EA. I am only facing problem with task transition. All the steps are running fine but the workflow job fails giving a popup in browser saying "...task connot be finished because it is no longer active". Below is my code transition methods .

--------------------

public class presetMetadata implements CSURLExternalTask
{
private static Logger logger = Logger.getLogger(presetMetadata.class);

public void execute(CSClient csclient, CSExternalTask task, Hashtable params) throws CSException
{

String trs[] = task.getTransitions();

//task.chooseTransition("presetURLTask Success", "Preset Metadata in JAVA");
task.chooseTransition(trs[0], "Preset Metadata in JAVA");

}

------------------------------------------------------------

both task transition statements are giving same problem.

I will have to refer CSCGITask to convert it to CGI task to implement Adam's suggestion

Thanks!

Adam Stoller

There are two parts to the transition, at least there was in my code when I did this. I've tried to extract the relevant pieces from my code, you may have to play around with it a bit since this isn't exactly the code - but it should be pretty close:

// Java Classprivate void _doTransition(CSTask task, String transition, String msg, HttpServletRequest request)
    throws Exception {
            try {
                CSTransitionableTask t = (CSTransitionableTask) task;
                int nextTaskId         = t.chooseTransition(transition, msg);
                String transitionUrl   = "/iw-cc/transitiontask?taskid=" + nextTaskId + "&done_page=/iw-cc/base/util/close_or_home.html";
                request.setAttribute("transitionUrl", transitionUrl);
            }
            catch (Exception e) {
                if (transition.matches("Failure")) {
                    /* preserve original message, and don't continue to propagate transition failures */
                    throw new Exception(msg, e);
                }
                String msg2 = "Unable to perform '" + transition + "' transition:\n\t" + e.getMessage();
                request.setAttribute("error", msg + "\n" + msg2 + "\nNotify your TeamSite Admin");
                throw new Exception(msg2, e);
            }
        }

// JSP ...
<%
  String htmlTunnel = new HtmlTunnel().getHtmlTunnel(request);
  // #=# BEGIN(A): Unclear if this code works [as intended, if at all], but left in, just in case
  // Trap error if any
  String error = (String) request.getAttribute("error");
  if (error != null) {
    // display error, perform transition, if possible (in Java) and then (below) complete the transition in the UI, if possible
    error = error.replaceAll("\\'", " ");
    out.println("<script language='javascript'>alert('" + error + "');</script>");
    String transitionUrl = (String) request.getAttribute("transitionUrl");
    response.sendRedirect(transitionUrl);
    return;
  }
  ...
  String transitionUrl = (String) request.getAttribute("transitionUrl");
  response.sendRedirect(transitionUrl);
  return;
  ...
%>

Essentially, chooseTransition (in the Java code) provides you the ID of the task to which you intend to transition - from which you construct a transitiontask URL, and response.sendRedirect (in the JSP code) actually performs the transition using the URL

I don't recall if the error-code actually worked, hopefully it never goes down that path anyway since it's only for when you are unable to get the proper transition...

Hope that helps.

TeamsiteDev

Is there a way to auto submit URL task / prevent URL Task from stopping at "Add Comments" screen ?

My workflow is running fine with new task, only problem is that the URL task stops at "Add Comments" screen and the user has to click on "Next" to move to the next task, I dont want the workflow to stop at URL task , is there a way to do that ? Can I set some variable in the task so that it does not stop at "Add Comments" screen ?

Thanks!

Adam Stoller

Why are you using a URL ExternalTask for doing a submit? Why not just use a Submit Task?

Submit Tasks don't prompt for anything and require no interaction unless it detects a conflict.

TeamsiteDev

Hi Adam,

I dont want to do any Submit action. I have used URL External task, I have defined the java class in a variable named "ClassName" , code is running fine but once it comes to task.chooseTransition() method , it is showing the "Add Comments" screen, when I click on "Next" it goes to the next task which is File Tagging task. So my workflow is completing without any issues. Only thing is that I dont want it to stop at the URL task I have added. Please see attached image of the "Add Comments" screen I m getting. Its the OOTB form, I have not added it.

Thanks !

Adam Stoller

I guess I misread "Is there a way to auto submit URL task / prevent URL Task from stopping at "Add Comments" screen ?"

Did you read the documentation for the transitiontask URL in the User Interface Customization Guide? You should be able to adjust the parameters for that URL to include a canned "comment" and that should avoid the screen you're seeing (I haven't verified this - just reading the documentation - which you should have done)

Rick Poulin

Your query doesn't make sense though.. a URLExternalTask runs on the server side -- there's no browser in which to show this comments message. I think you need to take a second look at where the problem is actually occurring, before we start throwing suggestions at you.

Adam Stoller

rpoulin wrote:
Your query doesn't make sense though.. a URLExternalTask runs on the server side -- there's no browser in which to show this comments message. I think you need to take a second look at where the problem is actually occurring, before we start throwing suggestions at you.

Hmm - missed that - I was going under the assumption that this was still the CGI Task converted from Perl to Java (the original intent of this thread). If that is not the case, then absolutely it makes no sense and probably belongs in a separate thread.

Kalam

Hi Ankit,

Are you sure that the task comment screenshot you have attached is from the URL task? Because this task comment screen comes after the tagging screen in PLC or if the OOTB metadata task is used.

Thanks

Kalam

TeamsiteDev

Yes the Add Comments screen comes after tagging task in PLC . I have placed my URL task between "Validate Files" task (CGI task) and Tagging task but I am getting Add Comments task before transition to tagging task. After I click on Next it goes to tagging task. I dont know if Validate files or URL task is showing it. Before adding URL task there was a CGI task in its place and didnt used to see Add commnets before tagging task. need to spend more time on it.

Topic 37257__HTML5 Charts -- Bar Negative Label Formatting__cwong.rptdesign

Adam Stoller

If you're modifying [hopefully a copy of] the PLC workflow and trying to insert a non-CGI task in between two of the initial set of 6-or-7 CGI Tasks that are in there - you're going to run into some complications, not the least of which is that the CGI Tasks that come after your non-CGI task would require the user to go to the Task Details screen and initiate it via the "Start Input Task" button.

You're better off with a CGI Task - even if you don't really do anything in terms of a UI other than sending the message "working ..." or some such.

Rick Poulin

I think OP is actually confusing the terms -- the only way the problem description makes sense is if he's using a CGI task.

I think the issue stems from how op is using /iw-cc/transitiontask. If you're extending the AbstractAjaxWebTask class, then you should be calling completeTask() and passing the returned task ID to /iw-cc/transitiontask. If you're NOT using that, then you want to execute task.chooseTransition() on the server side, get the ID of the next task and pass that to /iw-cc/transitiontask.

Bottom line is if you pass it the current task ID, then the task completion screen will ask for comments.

If you transition on the server side, and then call it with the next task ID, then it does nothing more than redirect to the next task (without comments box).

TeamsiteDev

Hi Rick,

My apologies for a wrong description. I have changed the heading of this post.

I have placed my URL task after Validate files , name is "presetMeta" , the default link coming out of this task is named "presetMeta Success" , id of Default link is "Flow2" , this default link goes into the gateway "Is tag Required" as in PLC.

So if I use:

task.chooseTransition("presetMeta Success", "Preset Metadata in JAVA");

it takes me to /iw/blank.jsp & a popup comes up in content center saying "...task connot be finished because it is no longer active". Java code is also executed because I am able to see code Sysouts in server.log

If I use :

task.chooseTransition("Flow2", "Preset Metadata in JAVA");

Java code is executed & workflow goes to "Add Comments" window. clicking next goes to "tag file" & workflow completes without any issue.

from your post - "If you're NOT using that, then you want to execute task.chooseTransition() on the server side, get the ID of the next task and pass that to /iw-cc/transitiontask."

I can get the ID of next task , which is "Tag Files" but how do I pass it /iw-cc/transitiontask ?

I have checked the classes in OOTB jars , everywhere I find only task.chooseTransition() method being used for task transition. My last attempt to make it work in a URL task if not then will try it in CGI task.

Thanks!

Adam Stoller

Since you're sticking this task inbetween two existing CGI Tasks, you will be breaking the chain of CGI Tasks requiring your users to go into Task Details to click on the "Start Input Task" button to continue the process flow. IMO - that's just bad design and you should rewrite your URL task to be a CGI Task.

The UI aspect of the CGI can be kept pretty minimal such that most of your existing URL Task code could probably be re-used with little to no changes - but the fact that it is a CGI task means that it preserves the chain of CGI tasks and does not require manual interaction to start it up again after your code runs.

With regard to the /iw-cc/transitiontask parameters - I already told you to read the User Interface Customization Guide for some details in that regard - have you bothered to read the manual?

TeamsiteDev

Hi Adam,

yes I did go through the UI guide, also checked the JSPs in customer_samples_src/web/ folder . Working on it now .

I just wanted to avoid running make_toolkit on production teamsite so I was looking to complete this in URL task as it would only require copying jar to WEB-INF/lib folder & JBoss restart. but it seems there is no option so working on JSP simultaneously.

Thanks!

Rick Poulin

....why are you developing on your production server?

I agree with ghoti, the use of URLTask here is a bad idea and making that work in a CGI chain is feasible but unnecessarily complicated.

I suggest you look at the implementation of the other tasks in the PLC and use that as your starting point. The stuff in customer_samples_src probably won't help you a whole lot in this situation.

TeamsiteDev

I am developing on Dev server only. I meant to say that if I succeed in ruuning the CGI task then eventually I will have to run make toolkit on production server to implement the CGI task.

Seems there's no option , so working on CGI task. never wrote a servlet/JSP so struggling with that Smiley Sad

TeamsiteDev

Hi Rick, Adam,

Is it possible to call the servlet directly in CGI task or the servlet should be called from a jsp only?

I have wriiten a servlet with below settings in web.xml :

<filter-mapping>
<filter-name>authentication</filter-name>
<servlet-name>presetMetaServlet</servlet-name>
</filter-mapping>

<servlet>
<servlet-name>presetMetaServlet</servlet-name>
<servlet-class>com.****.tasks.presetMetaServlet</servlet-class>
</servlet>

<servlet-mapping>
<servlet-name>presetMetaServlet</servlet-name>
<url-pattern>/presetmeta</url-pattern>
</servlet-mapping>

If I give the URL in CGI task as "/iw-cc/presetmeta" , I get class not found error and if I give "/presetmeta" it goes into a workarea path & fails. Attached is my servlet code. please dont mind if I am doing something stupid here, this is my first attempt at servlet Smiley Happy

Thanks!

Rick Poulin

Yes, you can access the servlet directly and the correct URL per your config would be /iw-cc/presetmeta

Check your logs -- is the CNF asking for presetMetaServlet? If yes, then you're building the JAR wrong. If no, then provide the name of the class that it thinks is missing.

demoLineChart.rptdesign