Session in a Job

Do not create sessions on Jobs, methods, Components and SBO that the session is already available from parent classes.

A. For Jobs that implement IDfMethod and extend DfSingleDocbaseModule use the following:


com.documentum.fc.client.DfSingleDocbaseModule.getSession()

B. For workflow methods that extend WorkflowMethod and implement IDfModule use the following:


com.documentum.fc.client.IDfTypedObject.getSession()

from the IDfWorkitem argument.

C. For components that extend Component use the following:


com.documentum.web.formext.component.Component.getDfSession()

D. For SBO that extend DfService use the following:


com.documentum.fc.client.DfService.getSession(String)

you only need the global docbase that can be read easily from dfc.properties.

E. For standalone Java programs use the following:

Regards,

Panos

All comments

Imran_Yusubov

Jobs call methods which are run on content server. On content server,you can create a session without providing a password which is called trusted login. If you want to run the method as a super user, in composer set "run as server" option to true.Unfortunately i cantprovide you some code but, if i am not wrong the idfmethod interface has a method called getSession which will return a session for the user who called it or a superuser session if you have set the run as server option. See th dfc java docs for more info. Hope it helps

Do not create sessions on Jobs, methods, Components and SBO that the session is already available from parent classes.

A. For Jobs that implement IDfMethod and extend DfSingleDocbaseModule use the following:


com.documentum.fc.client.DfSingleDocbaseModule.getSession()

B. For workflow methods that extend WorkflowMethod and implement IDfModule use the following:


com.documentum.fc.client.IDfTypedObject.getSession()

from the IDfWorkitem argument.

C. For components that extend Component use the following:


com.documentum.web.formext.component.Component.getDfSession()

D. For SBO that extend DfService use the following:


com.documentum.fc.client.DfService.getSession(String)

you only need the global docbase that can be read easily from dfc.properties.

E. For standalone Java programs use the following:

Regards,

Panos

https://community.emc.com/people/Julien.Fontaine/blog/2013/01/29/dfc-development--back-to-basic

I write an article a How-to article to connect to a docbase :

Thanks Julien! I have updated my reply to include standalone java programs with your solution. You can also use session manager as an alternative approach.

Thanks for replying

Imran- Thanks for clarifying the concept of trusted login in case of Jobs. I am implementing IDfMethod but unfortunately their is no getsession()

Panos- DfSingleDocbaseModule do provide getSession() and releaseSession(), but it will restrict me if i want anyother(if any) class to extend. Isn't their any interface that provides getsession() ?
Also, I hope no session manager will be required here i.e. I can directly write getsession() and i get a session.

Julien- I am using this method currently.

Hello MK21,

I cannot understand the restriction you are mentioning and why will you ever need to extend a method. Unless you would like to provide a generic method that can be extended only by 1 level, I see no other benefit. Usually, in a method you are extending the IDfMethod to provide your business logic solution.

Be very careful when you are creating new sessions in a job, as a possible session leak there is going to flood your Content Server with "no more sessions" errors. Obtaining the session from DfSingleDocbaseModule is handy and there is no need to release it.

Panos

Panosk,

In this case, I have an extra question, do you know a tools or a tips to detect session leak ?

Panos,

Yes, I was talking about that one level of extension only.

For now, I am releasing session using

sessionManager.release(session);

when the job ends.

White Paper: EMC Documentum Foundation Classes Session Manangement

Hello Julien,

You may use the following DFC property:


# Enables or disables diagnostics which detect failures by the application to 
# properly release resources such as sessions and collections. When enabled a 
# log message will be generated when certain resources are garbage collected 
# without first being closed or released by the application. 
# 
# Note that there is some performance overhead for this diagnostic so you may 
# not want to use it on a production system unless you are diagnosing a 
# particular problem.                                                           
# 
dfc.diagnostics.resources.enable = true

It prints such kind of errors in the application servers output. You may also want to check the following white paper for more information:

@MK21

Then, I see no problem. Go for the DfSingleDocbaseModule. We are extending that in all our jobs to obtain the session easily.

Panos

Thanks PanosK, I have marked your answer as correct. ☺

One more thing you mentioned that ”you only need the global docbase that can be read easily from dfc.properties.”

If I am not wrong you mean to say, Global repository should be running. As dfc.properties will be already available with JMS. Right ?

That is only for acquiring a session in an SBO module. The getSession(String repo) there expects a string parameter with the repository name. You don't need to know the repository name in a method. It is not for your case, but it was included for completeness for someone that would like to obtain a session in an SBO without having to pass it as an argument.

Panos

Ok, thanks ☺ ☺

Hi Team,

I've read through the posts. Thank you very much for this detail.

I'm using Option 1 to get a session in a JOB

A. For Jobs that implement IDfMethod and extend DfSingleDocbaseModule use the following:

com.documentum.fc.client.DfSingleDocbaseModule.getSession()

However I'm NOT getting a session. I get:

java.lang.NullPointerException

at com.documentum.fc.client.DfSingleDocbaseModule.getSession(DfSingleDocbaseModule.java:58)

I'm passing a custom argument through, which I need. very NB.

Do I need to select "Pass Standard Arguments" for the getSession() to work?

If I select it I'm unable to find my custom argument in the Map Argument in code.

Your help is highly appreciated.

Chris

Please post your snippet of code in order to try to understand.

public void execute(Map params, OutputStream ostream) throws Exception {

try{

if (params.containsKey(CREATIONDATE))

{

crDate = params.get(CREATIONDATE).toString();

System.out.println(CREATIONDATE + " value found: " + crDate);

}else

{

throw new ServerException("NO "+ CREATIONDATE + " PARAM FOUND");

}

System.out.println("GET SESSION");

IDfSession session = getSession(); // THIS IS WHERE IS BREAKS

System.out.println("SESSION OBTAINED");

I'd attached my code.

Do I need to include the IDFSingleDocBaseModule in my JAR file?

What is the standard way of exporting a JAR file for a JOB?

Thanks for the help.

Chris

In order to get the Session like wise from the IDfModule your module need

to be deployed using composer, Extending the interface will not return the

session.

Thats exactly what I'm doing:

public class FRB_CCM_Diarize extends DfSingleDocbaseModule implements IDmMethod{

do you have an example?

Do I have to have to use Composer. Documentation I have read says I can use Eclipse (my preferred).

Many Thanks

Christopher Malevris

was ur artifact deployed as module in the repository?

then only @ runtime you can get the session from getSession() else it

throws the error

you can fire an dql query to check that

I just copied my jar file to "C:\Documentum\dba\java_methods"

and then created a new Method and then added a JOB.

How do I search to see if what modules are deployed?

AND

if I use Composer do I still declare my class following way

"public class FRB_CCM_Diarize extends DfSingleDocbaseModule implements IDmMethod{"

select * from dm_module where object_name=''

usually the name is configured as such

Either you use/ composer never makes any difference all that matters is

your class neeed to be packaged properly as a module

Note: But i never declared my class name as such and not sure if the value

in the module accepts special characters.

Nope, I dont see my Module in the list.

How Do I install a Module?

you can do it using composer/dab

from da i'm not sure

https://community.emc.com/people/Julien.Fontaine/blog/2013/04/29/session-another-deep-dive

I just release a new blog post on how to use and create Session. Hope it can help.

Thanks Julien! I've added that too, as you are using session manager and I like it more, since it is the recommended way

Panos

crossfire

Panos, you said:


Panos Kavalagios написал(а):

... Obtaining the session from DfSingleDocbaseModule is handy and there is no need to release it

But there is protected void releaseSession(IDfSession session) method in DfSingleDocbaseModule class. When we should use it?

I can't believe that it is a right way to forget about DfSession objects, obtained in DFC code

Yes, you are right. We do not release the session in component level only. In jobs we have to inform session manager to release the obtained session.

Panos

antey

Hi, Panos!

We have several classes extending DfSingleDocbaseModule, which are used for java activities within xCP2 workflows. Could you, please, tell me, if I obtain the session with getSession() method in my class, should I call releaseSession() explicitly? Or will the session be released automatically?

EMC documentation does not say anything about this issue.

Thanks in advance.

Anton