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

Invoking OD through CSSDK?

Adam Stoller

Environment:

There are probably a bunch of other questions, but hopefully answers to the above might make it all clearer...

Find more posts tagged with

Comments

Migrateduser

[size=2][color=#7f0055]
public[/color][/size][size=2][color=#7f0055]class[/color][/size] OpenDeployTask [size=2][color=#7f0055]extends[/color][/size] DeployURLExternalTask

The execute() method for this class can include some special processing (for instance, we build the filelist here and set a task variable to the path of the filelist, but I removed that code for clarity) but here is the crux of it:

[left]

 



public void execute(CSClient client, CSExternalTask task, Hashtable params)

throws CSException 

{

setCurrentTask(task);

setClient(client);







//Execute the deployment

super.execute(client, task, params);



log.debug("Deployment END: " + " [Deployment: " + getDeploymentName() + ", Deployment Area: " + getDeploymentAreaPath() + "]");



//Delete filelist after deployment (if one was created)

deleteFilelist();


[/left]




}

[left]

[/left]

The task that executes the OpenDeployTask is an externaltask whish is defined with the following variables. Keep in mind this is a snippet of code that builds a job spec and embeds values from java variables, so that's why it looks like this:

[HTML] [left]"" +

"" +

"" +

"" +

"" +

"" +

"" +

"" +
[/left]
"" +

[left][/HTML] [/left]

As you can see, you can set predefined variable names in your task that represent your standard OD variables needed for your deployment config and substitution variables.

I believe that DeployURLExternalTask understands these predefined variable names and does the right thing with them. It is a little bit of voodoo, but this works.

vpatel

Adam,

Have a look at the OD Dev guide -- Chapter 1: Web Services. It talks about this in detail along with how to set it up. OOTB, you have all relevant Java classes, JAR files, etc. It walks you through the steps to set it up.

Your specific questions:

It isn't clear how to go about this

Are there javadocs for OD jar files?

Do we have to go through the WSDL interface and make http requests to/from there in order to initiate the deployments?

Is there another (perhaps better) way?

Read the chapter that I have stated above and it'll answer some of these.

Do we need to write custom WSDL code (like ODHOME/websvc/1.1/examples/client_java/*)? [indent]Or is just activating the WSDL service sufficient from the OD side of things?[/indent]

OOTB samples are provided including WS Client. I usually write my own WS Client just so that I have full control over things.

Are there jar files and javadocs for interacting with the OD WSDL interface? [indent]Or do we have to construct our own http / lwp code for sending requests and retreiving results?[/indent]

If you look at the WSDL itself, it'll provide you with available methods. Pull it up in the browser and you'll see all available methods. Additionally, OOTB classes also provide you with the Java source. If you are using any IDE (i.e. Eclipse) it'll aide you with what methods are available on what objects as you are developing your Java code.

From the CSSDK side, can I use an existing authenticated CSClient object to initiate the deployment, or do I have to go through some other means to gain authentication on the OD side of the equation?

OD WS has its own authentication using CSF Access Service. It is defined in the WSDL as well. There is a method called "authenticateUser" available for this.

HTH!

Migrateduser

If anything in my post has any relevance for you, I can email you the full java files we've used to implement OD from our workflows. It's a lot easier for me to send you files than cut and paste in here - especially if there's XML involved since I am still horrible at knowing how to make XML look correct in posts.

I can tell you that this works like a charm and it's everything we did in WFTs using perl externaltask scripts, just in Java.

Crsb

I had to get around a limitation before in the OOTB deploy task (failure transition). What I did is decompiled the existing code in teamsite.jar and just renamed and modified com\interwoven\ui\teamsite\workflow\task\urltask\DeployURLExternalTask.java to CustomDeployURLExternalTask.java. I added some extra variables to the java class that I pass as task variables, and changed the way the task decides failure vs success. That was enough for me to achieve what I wanted and I didn't have to worry about authentication or how OD is being invoked since everything work the same way as the OOTB task. I don't know if that will be enough for your requirements or if you still have to rewrite the whole thing, but if you need something like this let me know and I will give you more details.

Adam Stoller

I'm not sure this will answer all your questions, in fact I'm sure it won't, but hopefully this will help some. To perform an actual deployment, we have create a Java class called OpenDeployTask which extends the DeployURLExternalTask class, which as far as I can tell, is not documented anywhere. Surprise!

anything I'm trying to write right now, but this is definitely food for thought.Thanks.

Adam Stoller

Adam,

Have a look at the OD Dev guide -- Chapter 1: Web Services. It talks about this in detail along with how to set it up. OOTB, you have all relevant Java classes, JAR files, etc. It walks you through the steps to set it up.

Your specific questions:

Read the chapter that I have stated above and it'll answer some of these.

I did read it - and that was where I started having most of my questions - the problem is that the documentation is written with a particular mind-set and that doesn't happen to fit with what I'm trying to understand.

The response that Smitty (and to some extent Crsb) provided is much more in-line with my trying to write CSSDK code for the workflow - the fact that the

DeployURLExternalTask

is not documented in the javadocs is (to put it mildly) annoying - if it were, I probably wouldn't have had to start this thread.

Can you find out why this is missing from the javadocs - and, perhaps, post a version of what it should be here so we don't have to wait for 7.2 to be released before we get it?

vpatel

I'll try and see what I can do...

In any case DeployURLExternalTask is described briefly (along w the variables) in the WFM guide. Take a look at that.

Migrateduser

Have you filed a bug report on the absence of documentation for this class?

No - this was originally written by the consultants, so I inherited the code. It was already there, so I didn't have to deal with finding it. I think they told me they discovered it in a DevNet post.

The methods/functions being called there (e.g.: setCurrentTask, setClient, deleteFilelist) are those yours or something that comes OOTB (I'm guessing the former). It might help to have some idea of what those methods are doing.That's sounds nice - I'm especially liking the odDeploymentInst piece since I was wondering whether there was a way to set that. I imagine I can set [some] of these programmatically via the CSTask (derived) object interface.

I'll play around with this for a bit - it may be a little while before I actually get to test anything I'm trying to write right now, but this is definitely food for thought.

Thanks.

The methods are all just setters and getters embedded within OpenDeployTask. I will email you the code and you can see the whole thing in context. It is really pretty sweet.

Crsb

... the fact that the
DeployURLExternalTask
is not documented in the javadocs is (to put it mildly) annoying - if it were, I probably wouldn't have had to start this thread.

Can you find out why this is missing from the javadocs - and, perhaps, post a version of what it should be here so we don't have to wait for 7.2 to be released before we get it?

IMO, There is probably some internal documentation for that but it is not released to the public/customers since it is part of the application core "confidential?" where CSSDK is meant for the public to use.

vpatel

IMO, There is probably some internal documentation for that but it is not released to the public/customers since it is part of the application core "confidential?" where CSSDK is meant for the public to use.

You are correct. This class is available OOTB as-is and is documented in the WFM guide. If you want to do anything advanced or customize it then you have the option to write your own custom class that will use OD WS directly.

Migrateduser

You are correct. This class is available OOTB as-is and is documented in the WFM guide. If you want to do anything advanced or customize it then you have the option to write your own custom class that will use OD WS directly.

That's typical Interwoven documentation failure and utter BS not to provide javadocs for ALL provided classes/interfaces. Providing javadocs for a standard interface/class that you need to use to do something in your code is not going to harm anything or upset the balance of what we can do. Javadocs are just standard documentation for a feature that is expected to be used - providing that would only help and could not possibly hurt.

Adam Stoller

I'll try and see what I can do...

In any case DeployURLExternalTask is described briefly (along w the variables) in the WFM guide. Take a look at that.

The documentation in the WFM guide is rather limited:[indent] part of the CSSDK (com.interwoven.ui instead of com.interwoven.cssdk)

Crsb

The documentation in the WFM guide is rather limited..

The documentation in WFM only describes how to use the deploy task in terms of class name to use and available task variables. It is not javadoc type of documentation, but when you get your hands on DeployURLExternalTask.java source code you will be able to figure out things and how to use/extend it.

Migrateduser

The documentation in WFM only describes how to use the deploy task in terms of class name to use and available task variables. It is not javadoc type of documentation, but when you get your hands on DeployURLExternalTask.java source code you will be able to figure out things and how to use/extend it.

That's the thing - you shouldn't have to decompile the source code to figure out how to use a class that they expect you to use! Interwoven sometimes does it's very best to deter people from being able to use it's products. Simple documentation would make life so much easier.

And where are the special task variables for DeployURLExternaltask defined in the documentation as you claimed? EDIT: Never mind - they do show most of those.

Crsb

That's the thing - you shouldn't have to decompile the source code to figure out how to use a class that they expect you to use! Interwoven sometimes does it's very best to deter people from being able to use it's products. Simple documentation would make life so much easier.

I agree, but by not making it easy for you, they give you a chance to call IWOV tech support for help who are more trained to offer you professional services than to resolve technical issues. Not all of them though, some of them are great when you are lucky enough to get them.

mart2001

If you also try to use OpenDeploy Web Services through TeamSite workflow, you'll also get incompatible axis.jar files....

Bjorn

We would like to do this within the Java code as opposed to having the Java code exec a CLT.[/indent]

I was just curious why this is a requirement. Thanks.

Adam Stoller

I was just curious why this is a requirement. Thanks.

The running of OD through an API as opposed to via an exec of a CLT that then turns around and runs java to invoke OD - is not so much of a requirement, as just an obvious (to me) desire - it tends to be "cleaner", and have less overhead.

The code that Smitty provided did the trick - I've been able to test my code in a simple workflow and the deployment that we want gets kicked off as desired and the correct transition gets called (actually, I need to test a failed deployment too - hopefully on Monday, but I'm reasonably confident the correct transition will get called).

anu3

Hi,

I have recently started working in teamsite and have developed Java code for CSSDK . I use CSSDK code to "submit the modified files to staging".
Now, i need to deploy these files to the staging area on our server.

This process is already being done through teamsite code to Open Deploy the files to staging. Now, it needs to be done through CSSDK code.
I have read the OD guide : OD_621_dev_V03_EN.pdf for the web services portion and the referenced docs mentioned there. There are some configuration file changes mentioned there. I am new to OpenDeploy and wanted to know how OpenDeploy works and would changing the configuration of files only work for me considering my requirement to do it with CSSDk or do i have to write some java code ?If so ,how do i go about it?

teamsite version : 6.5
OD : 6.2.1

Please help me for this ......

Thanks ..

Adam Stoller

Hi,

I have recently started working in teamsite and have developed Java code for CSSDK . I use CSSDK code to "submit the modified files to staging".
Now, i need to deploy these files to the staging area on our server.

This process is already being done through teamsite code to Open Deploy the files to staging. Now, it needs to be done through CSSDK code.
I have read the OD guide : OD_621_dev_V03_EN.pdf for the web services portion and the referenced docs mentioned there. There are some configuration file changes mentioned there. I am new to OpenDeploy and wanted to know how OpenDeploy works and would changing the configuration of files only work for me considering my requirement to do it with CSSDk or do i have to write some java code ?If so ,how do i go about it?

teamsite version : 6.5
OD : 6.2.1

Please help me for this ......

Thanks ..

You're in a bit of a pickle because I don't believe that the CSSDK for workflows, and especially the DeployTask exists in 6.5 - so you'll have to go through the web services route where you configure some aspect of the web services on the BaseServer side and then write the calling code in Java using basic HTTP requests and such.

I skipped that route - and went with a more direct CSSDK route because I had the option to do so.

anu3

oh!! is it so ??

hmmm......can you elaborate a little bit more on the possible solution u described ? from which docs could i get help on it from ?

please help...

Adam Stoller

oh!! is it so ??

hmmm......can you elaborate a little bit more on the possible solution u described ? from which docs could i get help on it from ?

please help...

I cannot elaborate on something I haven't done - all I can do is point you to the ODHOME directory, in which (somewhere) there may be examples of how to use the WSDL interface.

Otherwise you have to write a program (Java, Perl, whatever) that invokes the CLT -- crude, yes - but ultimately functional.

anu3

ok ,
thanks ... i vil try that ...

ManojK

I'm not sure this will answer all your questions, in fact I'm sure it won't, but hopefully this will help some. To perform an actual deployment, we have create a Java class called OpenDeployTask which extends the DeployURLExternalTask class, which as far as I can tell, is not documented anywhere. Surprise!

Code:

publicclass OpenDeployTask extends DeployURLExternalTask

The execute() method for this class can include some special processing (for instance, we build the filelist here and set a task variable to the path of the filelist, but I removed that code for clarity) but here is the crux of it:

Code:

public void execute(CSClient client, CSExternalTask task, Hashtable params)

throws CSException

{

setCurrentTask(task);

setClient(client);

//Execute the deployment

super.execute(client, task, params);

log.debug("Deployment END: " + " [Deployment: " + getDeploymentName() + ", Deployment Area: " + getDeploymentAreaPath() + "]");

//Delete filelist after deployment (if one was created)

deleteFilelist();

}

The task that executes the OpenDeployTask is an externaltask whish is defined with the following variables. Keep in mind this is a snippet of code that builds a job spec and embeds values from java variables, so that's why it looks like this:

HTML Code:
[left]"" +

"" +

"" +

"" +

"" +

"" +

"" +

"" +
[/left]
"" +

[left][/left]

As you can see, you can set predefined variable names in your task that represent your standard OD variables needed for your deployment config and substitution variables.

I believe that DeployURLExternalTask understands these predefined variable names and does the right thing with them. It is a little bit of voodoo, but this works

Hi Smith,

We have same use case, we want to deploy the files from work area to production server, however using CSSDK.
It would be great if you share sample code with relevant java file.
My mailid is - manojbk2@gmail.com

Thanks in advance
-Regards
Manoj K