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; } } }

WFM: CGI Task - Java

Adam Stoller

Environment

Find more posts tagged with

Comments

ISCBorisB

URL Task is a Java-based External Task that implements "CSURLExternalTask" Interface. You are correct, it is not interactive.
I never did CGI Task in Java so can not help more Smiley Sad

Migrateduser

Assuming CGI Task, I look at some of the sample code in iwhome/local/config/lib/content_center/customer_samples_src/src/com/corp/custom/ and see that they're basically simple frameworks that extend the HttpServlet class which presumably is tied to the import javax.servlet.http.*; entry in the code.
What jar file contains this class?
I'm looking in iwhome/httpd/webapps/content_center/WEB-INF/lib - should I be looking somewhere else?
I already have commons-httpclient-3.1.jar as an external jar but that doesn't seem to satisfy Eclipse
I don't see any jar file whose name begins with javax, http, or servlet

Usually the file you are looking for is servlet.jar. But iwhome\servletd\common\lib\servlet-api.jar should work. javax.servlet.http is the name of the package. You could open that jar file up and see the directory structure inside that matches it. The * in the code will import all the classes within that package.

Continuing this assumption, the sample source code appears to be, as I said, a simple framework that invokes a JSP file
Is this the right approach? or should I be trying to write the entire thing within the Java class?

You could use a jsp that uses methods from a class file. It make the jsp easier to work with having the separation of code.

Adam Stoller

Usually the file you are looking for is servlet.jar. But iwhome\servletd\common\lib\servlet-api.jar should work. javax.servlet.http is the name of the package. You could open that jar file up and see the directory structure inside that matches it. The * in the code will import all the classes within that package.

I think I found it in

iwhome/servletd/lib/servlet-api.jar

- which gets me past the first issue.

The second issue may be a matter of preference, though I guess using the JSP approach makes sense - we'll see how long it takes me to write something that works ;-)

Adam Stoller

More Questions / Issues[indent]Okay, we'll take as given that I'm going to use a CGI Task and write a Java class that looks something like the samples that come with TS, a simple wrapper to a JSP file.

Now:

Migrateduser

Note: I haven't done anything with WFM yet. What I am telling you is based upon my Java experience outside of TeamSite.

That location you specified for your java file should work.

I think you need to add a reference inside the web.xml for your servlet(s). Then you should be able to call them via http://$IW_SERVER/iw-cc/cgi_class_name.

iwhome/local/config/lib/content_center/customer_src/etc/web.xml

mart2001

You should not need to put any of your java files on the TeamSite server (classname.java). You need to compile it on your development machine (most like your everyday computer), into a .class file or more likely a .jar file if you have multiple classes.
Place that in the iw-home/local/config/lib/content_center/customer_src/lib directory.

Then edit the web.xml file in
iw-home/local/config/lib/content_center/customer_src/etc

In the web.xml file, you'll need the filter-mapping, servlet-mapping, and servlet elements to point to your class.

Then you should be able to call your class from your servlet mapping in something like:
http://tsserver/iw-cc/customservlet

[QUOTE=ghoti]More Questions / Issues[indent]Okay, we'll take as given that I'm going to use a CGI Task and write a Java class that looks something like the samples that come with TS, a simple wrapper to a JSP file.

Now:

Adam Stoller

Aside[indent]What are the pros/cons of compiling the java files on the TS server as opposed to just placing the finished product into the customer_src/lib/ directory?
I still need to run make_toolkit.ipl, which still disrupts [GUI] services temporarily.
Is the "downtime" significantly shorter by just putting the jar file there?[/indent]
Back to the issue currently at hand[indent]Okay, so I edit the

web.xml

file to look something like what I found semi-documented on page 102 of the UICG:

...
<web-app>
  <filter-mapping>
    <filter-name>authentication</filter-name>
    <servlet-name>cgi_class_name</servlet-name>
  </filter-mapping>
  <servlet>
    <servlet-name>cgi_class_name</servlet-name>
    <servlet-class>com.company_name.wfm.cgi_class_name</servlet-class>
  </servlet>
</web-app>

and I run make_toolkit.ipl (wow - this took over 7 minutes, it usually only takes about 1 minute)

I change the property on my CGI Task:[indent]CGI Script Name:

http://$IW_SERVER/iw-cc/cgi_class_name

[/indent] send the modified WFM to the server, publish it, and then try to run it and I get an error:[indent]TeamSite : Wrapper
Error: Error trying to open a pipe to iwhome/httpd/iw-bin/http: (1).[/indent]Any ideas on this one?[/indent]Note: nothing shows up in servletd_out.log nor in my custom.log to which I send all my custom code diagnostic messages. So the error seems to be occurring before my code actually gets executed.

ISCBorisB

Aside[indent]What are the pros/cons of compiling the java files on the TS server as opposed to just placing the finished product into the customer_src/lib/ directory?
I still need to run make_toolkit.ipl, which still disrupts [GUI] services temporarily.
Is the "downtime" significantly shorter by just putting the jar file there?[/indent]
Back to the issue currently at hand[indent]Okay, so I edit the
web.xml
file to look something like what I found semi-documented on page 102 of the UICG:
...
<web-app>
  <filter-mapping>
    <filter-name>authentication</filter-name>
    <servlet-name>cgi_class_name</servlet-name>
  </filter-mapping>
  <servlet>
    <servlet-name>cgi_class_name</servlet-name>
    <servlet-class>com.company_name.wfm.cgi_class_name</servlet-class>
  </servlet>
</web-app>
and I run make_toolkit.ipl (wow - this took over 7 minutes, it usually only takes about 1 minute)

I change the property on my CGI Task:[indent]CGI Script Name:
http://$IW_SERVER/iw-cc/cgi_class_name
[/indent] send the modified WFM to the server, publish it, and then try to run it and I get an error:[indent]TeamSite : Wrapper
Error: Error trying to open a pipe to iwhome/httpd/iw-bin/http: (1).[/indent]Any ideas on this one?[/indent]Note: nothing shows up in servletd_out.log nor in my custom.log to which I send all my custom code diagnostic messages. So the error seems to be occurring before my code actually gets executed.

I've illustrated web.xml servlet settings in [thread=31953]this[/thread] thread, perhaps it may help.
You *may* miss Servlet mapping, etc. Note though that thread illustrates JS Page <=> Servlet Schema

Migrateduser

Also, just to make sure, you do have

package com.company_name.wfm;

on beginning of your java file.

Sorry, have to ask since I'm not sure if you're just getting started with java.

Adam Stoller

I've illustrated web.xml servlet settings in [thread=31953]this[/thread] thread, perhaps it may help.
You *may* miss Servlet mapping, etc

Sigh - yes, I didn't scroll far enough down in the customer_samples_src/etc/web.xml when I was creating the one in customer_src/etc/ - and thus missed the additional section:

...
<web-app>
  <filter-mapping>
    <filter-name>authentication</filter-name>
    <servlet-name>cgi_class_name</servlet-name>
  </filter-mapping>
  <servlet>
    <servlet-name>cgi_class_name</servlet-name>
    <servlet-class>com.company_name.wfm.cgi_class_name</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>cgi_class_name</servlet-name>
    <url-pattern>/url_alias</url-pattern>
  </servlet-mapping>
</web-app>

In my case, I used the same name for cgi_class_name as I did for url_alias - I rebuilt the toolkit and I can access the URL directly via the browser - http://servername/iw-cc/url_alias (after going through the login page) - but when I try to invoke it through the CGITask in my workflow I get the error I showed before.[indent] TeamSite : Wrapper
Error: Error trying to open a pipe to iwhome/httpd/iw-bin/http: (1).[/indent]
Ideas?

Adam Stoller

...- but when I try to invoke it through the CGITask in my workflow I get the error I showed before.[indent] TeamSite : Wrapper
Error: Error trying to open a pipe to iwhome/httpd/iw-bin/http: (1).[/indent]
Ideas?

RESOLVED - the CGI Script Name needs to be:

/iw-cc/url_alias

not

http://$IW_SERVER/iw-cc/url_alias

YAY - I now have a CGI Task running a Java class that runs a totally useless JSP ;-) Now I get to work on making that JSP useful....

(thanks to one of my local colleagues here for suggesting that fix)

ISCBorisB

Sigh - yes, I didn't scroll far enough down in the customer_samples_src/etc/web.xml when I was creating the one in customer_src/etc/ - and thus missed the additional section:
...
<web-app>
  <filter-mapping>
    <filter-name>authentication</filter-name>
    <servlet-name>cgi_class_name</servlet-name>
  </filter-mapping>
  <servlet>
    <servlet-name>cgi_class_name</servlet-name>
    <servlet-class>com.company_name.wfm.cgi_class_name</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>cgi_class_name</servlet-name>
    <url-pattern>/url_alias</url-pattern>
  </servlet-mapping>
</web-app>
In my case, I used the same name for cgi_class_name as I did for url_alias - I rebuilt the toolkit and I can access the URL directly via the browser - http://servername/iw-cc/url_alias (after going through the login page) - but when I try to invoke it through the CGITask in my workflow I get the error I showed before.[indent] TeamSite : Wrapper
Error: Error trying to open a pipe to iwhome/httpd/iw-bin/http: (1).[/indent]
Ideas?

This looks like an Error thrown by iw_cgi_wrapper, see for example here. In the traditional CGI Task WF Engine applies impersonation automatically.
There is however nothing for it to look in the httpd/iw-bin thus the problem. Perhaps there exist WFM Syntax to indicate CGI Task JSP/Servlet rather
than the Command?

Migrateduser

Ghoti,
Did you go with putting your java files into the src directory, or your class or jar files into the lib directory? Wondering for future reference for when I get to that point.

Adam Stoller

Ghoti,
Did you go with putting your java files into the src directory, or your class or jar files into the lib directory? Wondering for future reference for when I get to that point.

Thus far I copy all my source files into the src/ directory and run make_toolkit.ipl to build, jar, and install them into their proper location within TeamSite.

It works - though its possible there may be benefits to doing it the other way that I'm not [currently] aware of that may make me switch down the road.

Thus far, doing it my way seems to take roughly 1 minute when compiling the classes and about 7 minutes when making changes to the web.xml file.

HeMan10

Ghoti,

I was able to make the Java class work as CGI task. But so far it doesn't do much. I am able to access various request parameters like task_id from the class.


taskID : 427200
iw_locale : en
iw_taskid : 427200
done_page : /iw-cc/base/util/close_or_home.html
taskid : 427200
full_redirect : true
banner.flag : false
cgi_transition : true
task_id : 427200
area_path : //server3/default/main/test/WORKAREA/test
session : 52616e646f6d4956fc4a2c9a36a837d646e6b94cdc960469cdfc8bdc493cd941fe75874f787b751d6ab4bdd4445a62cdc6dc3cd398c087932ffcd0c1d59d9dcc2b2ecf2ba23fe6ee
session_string : 52616e646f6d4956fc4a2c9a36a837d646e6b94cdc960469cdfc8bdc493cd941fe75874f787b751d6ab4bdd4445a62cdc6dc3cd398c087932ffcd0c1d59d9dcc2b2ecf2ba23fe6ee
iw_user : SERVER3\Administrator

How were you able to access the task information from the class?

Based on the examples I tried something like:

CSClient csClient = null;
          csClient = (CSClient) request.getAttribute("iw.csclient");

It throws a null pointer exception.


Exception at com.corp.teamsite.workflow.task.WebServletTask.doPost(WebServletTask.java:67) at javax.servlet.http.HttpServlet.service(HttpServlet.java:647) at javax.servlet.http.HttpServlet.service(HttpServlet.java:729) at 
org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:269) at 
org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:188) at 
com.interwoven.ui.base.util.SetRequestEncodingFilter.doFilter(SetRequestEncodingFilter.java:105) at
 org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:215) at 
org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:188) at 
org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:213) at 
org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:172) at 
org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:127) at 
org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:117) at 
org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:108) at 
org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:174) at 
org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:875) at 
org.apache.coyote.http11.Http11BaseProtocol$Http11ConnectionHandler.processConnection(Http11BaseProtocol.java:665) at 
org.apache.tomcat.util.net.PoolTcpEndpoint.processSocket(PoolTcpEndpoint.java:528) at 
org.apache.tomcat.util.net.LeaderFollowerWorkerThread.runIt(LeaderFollowerWorkerThread.java:81) at 
org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:689) at java.lang.Thread.run(Thread.java:595)

I am on 6.7.2/Windows.

Thanks,
-H

Adam Stoller

You're asking about code I wrote over a year ago for a project that I haven't worked on for about the same amount of time - but looking through some code I have I see the following in my JSP:[html]<%@ page language="java"
contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<%@ page import="com.interwoven.cssdk.common.CSClient"%>
<%@ page import="com.interwoven.cssdk.access.CSUser"%>
<%@ page import="java.util.ArrayList"%>
<%@page import="java.util.Enumeration"%>

...

<%
// get the cs client
CSClient client = (CSClient) request.getAttribute("iw.csclient");
...
%>

[/html]Unfortunately, nowhere in the code that I'm looking at do I actually use

client

nor do I see any references to the task object - so I'm not sure how much value the above is (since it's largely what you posted too.

Sorry.

ssharma48

Hi Ghoti,

I seen you response on the thread and we are also facing the similar kind of issue.
We have CGITask from where we are calling a servlet which in turn calls a java class.

The issue is we are unable to extract the workflow details (like workflow id, global variable) in the java class.

Please suggest how we can get the workflow details in the java class.

We are using TS 7.3.2.

Regards,
Sh

Adam Stoller

Please read this thread

Rick Poulin

You're responding to a 3yr old thread that doesn't really even match your problem. Read [thread=39499]this[/thread] and consider opening a new thread next time. You'll get better answers that way.

Anyway, your structure sounds a little off, but your servlet should be able to get the incoming task ID from request.getParameter("taskid"), perhaps with a variation on the case of that parameter name. You'll also need a reference to a CSClient object, which highly depends on how you set up your servlet (so again, you should create a new thread with further details about your use case).