Problem with getting custom CTS plug-in to work

Hi all,

Does anyone have experiance with creating a custom plug-in for the Content Transformation Services?

Our goal is to transform a image to format to that isnt supported by the CTS and thus we are forced to create our own custom build plug-in for this purpose.

After following the instructions in CTS_Product_53_SPx_development.pdf i created a custom plugin that seems to load ok when the CTS services are started.

Everything looks ok in the logs but when i try to trigger the plug-in from with our new profile i get this error message:

No Media Plug-in of type CUSTOM_PLUGIN available to handle a 'test_plugin' transformation

This is very odd since CUSTOM_PLUGIN is exacly what my custom plugin is named in my configuration file for the plugin (SERVERNAME).

I dont get any logs from my custom plugin, even though i edited the log4j.properties according to the CTS_Product_53_SPx_development.pdf, so in the java code we are writing the debug messages to both the logger (that doesnt work) and System.err. When i look at the Str_err.log in the <CTS_install_dir>/config dir, i can see my debug messages and one of the messages is the output of the getName() method - that is CUSTOM_PLUGIN.

So my question is, what am i missing here?

Thanks,

Vasse

More detailed log of the "error" from the cts_log.txt:

2009-04-16 14:06:23,244 DEBUG [Thread-149] CTSQueueProcessor -       *************** docbaseX CTSQueueProcessor *********************
2009-04-16 14:06:23,260 DEBUG [Thread-155] CTSLegacyQueueProcessor -       Query to get executed: select stamp,priority, date_sent from dm_queue where name='dm_autorender_win31' AND sign_off_user is nullstring ORDER BY priority DESC, date_sent ASC
2009-04-16 14:06:23,260 DEBUG [Thread-149] CTSQueueProcessor -       Query to get executed: select stamp,priority, date_sent from dm_queue where name='dm_mediaserver' AND sign_off_user is nullstring ORDER BY priority DESC, date_sent ASC
2009-04-16 14:06:23,918 DEBUG [Thread-149] CTSPluginHandlerImpl -       The source format is: text, content type is: text
2009-04-16 14:06:23,918 DEBUG [Thread-149] CTSPluginHandlerImpl -       Message from queue item: -profile_id="0800f61380b76c78"
2009-04-16 14:06:23,918 DEBUG [Thread-149] CTSPluginHandlerImpl -       The profile ID is: 0800f61380b76c78
2009-04-16 14:06:23,918 DEBUG [Thread-149] CTSPluginHandlerImpl -       The target format is: text
2009-04-16 14:06:23,981 DEBUG [Thread-149] CTSQueueProcessor -       Sign-off queue item (1b00f61380226239): profile can be executed
2009-04-16 14:06:23,981 DEBUG [Thread-149] CTSQueueProcessor -       1b00f61380226239 Current Time = Thursday, April 16, 2009 2:06:23 PM CEST
2009-04-16 14:06:23,981 DEBUG [Thread-149] CTSQueueProcessor -       1b00f61380226239 qItem Sent Date = Thursday, April 16, 2009 2:06:36 PM CEST
2009-04-16 14:06:23,996 DEBUG [Thread-149] CTSQueueProcessor -       1b00f61380226239 qItem Expriry Date = Friday, April 17, 2009 2:06:36 PM CEST
2009-04-16 14:06:23,996 DEBUG [Thread-149] CTSQueueProcessor -       1b00f61380226239 qItem Expired = false
2009-04-16 14:06:24,545 DEBUG [Thread-149] CTSQueueProcessor -       gbw02280_docbaseX successfully signed off the item: 1b00f61380226239
2009-04-16 14:06:24,607 DEBUG [Thread-149] CTSSessionHandlerImpl -       This is a 5.3 docbase
2009-04-16 14:06:24,827 DEBUG [Thread-149] CTSSessionImpl -       [5] A new ICTSSession was created for system@docbaseX: s4
2009-04-16 14:06:24,874 DEBUG [Thread-149] CTSSessionUtils -       ### checkSessionStatus: activeSessions=7, inactiveSessions=51
2009-04-16 14:06:24,874 DEBUG [Thread-149] CTSSessionUtils -       releaseThreadSession: true-f=false: com.documentum.cts.impl.services.session.CTSSessionImpl@4e5056:s1
2009-04-16 14:06:24,874 DEBUG [Thread-149] CTSSessionUtils -       setThreadSession: false: com.documentum.cts.impl.services.session.CTSSessionImpl@132b67c:s4
2009-04-16 14:06:24,889 INFO [Thread-149] CTSThreadPoolManagerImpl -       Number of ICTSTask Threads Created: 10
2009-04-16 14:06:24,905 INFO [Thread-149] CTSThreadPoolManagerImpl -       Added ICTSTask to the ICTSThreadPoolManager: dm_transcode_content
2009-04-16 14:06:24,905 DEBUG [Thread-149] CTSSessionImpl -       [4] An ICTSSession was released for system@docbaseX
2009-04-16 14:06:24,905 DEBUG [Thread-149] CTSSessionUtils -       releaseThreadSession: false-f=false: com.documentum.cts.impl.services.session.CTSSessionImpl@132b67c
2009-04-16 14:06:24,921 INFO [Thread-170] CTSThreadPoolManagerImpl -       Processing next CTSTask...
2009-04-16 14:06:24,921 INFO [Thread-170] CTSThreadPoolManagerImpl -       About to get notifier from CTSTask...
2009-04-16 14:06:24,921 INFO [Thread-170] CTSThreadPoolManagerImpl -       About to get session from CTSTask...
2009-04-16 14:06:25,296 DEBUG [Thread-170] CTSSessionImpl -       [5] A new ICTSSession was created for system@docbaseX: s5
2009-04-16 14:06:25,296 DEBUG [Thread-170] CTSSessionUtils -       setThreadSession: false: com.documentum.cts.impl.services.session.CTSSessionImpl@183e965:s5
2009-04-16 14:06:25,296 DEBUG [Thread-170] CTSTaskBase -       getUserSession: got a new thread session: com.documentum.cts.impl.services.session.CTSSessionImpl@183e965:s5
2009-04-16 14:06:25,296 INFO [Thread-170] CTSThreadPoolManagerImpl -       About to get RUN CTSTask...
2009-04-16 14:06:25,296 DEBUG [Thread-170] CTSTask -       Task operation, object id: 0900f61380b7ffa1, formats: from text to text
2009-04-16 14:06:25,578 DEBUG [Thread-170] CTSTask -       TASK with profile id: 0800f61380b76c78 and name: test_plugin has been initialized! - -profile_id="0800f61380b76c78"
2009-04-16 14:06:25,688 DEBUG [Thread-170] CTSPluginHandlerImpl -       executeProfile - test_plugin (0800f61380b76c78)
2009-04-16 14:06:25,704 INFO [Thread-170] CTSPluginHandlerImpl -       **** Executing Atomic CTSProfile test_plugin ******
2009-04-16 14:06:25,719 DEBUG [Thread-170] CTSSessionImpl -       [4] An ICTSSession was released for system@docbaseX
2009-04-16 14:06:25,719 DEBUG [Thread-170] CTSPluginHandlerImpl -       No Media Plug-in of type VASSE available to handle a 'test_plugin' transformation
2009-04-16 14:06:25,751 DEBUG [Thread-170] CTSSessionImpl -       [5] login succeeded for system@docbaseX: s5
2009-04-16 14:06:25,766 DEBUG [Thread-170] CTSTaskKeyLock -       locked the CTSTask key: 0900f61380b7ffa1
2009-04-16 14:06:25,782 DEBUG [Thread-170] CTSTaskKeyLock -       unlocked the CTSTask key: 0900f61380b7ffa1
2009-04-16 14:06:25,782 DEBUG [Thread-170] CTSTask -       deleteOutputResults called for profile: test_plugin
2009-04-16 14:06:25,782 DEBUG [Thread-170] CTSThreadPoolManagerImpl -       Successfully processed document format: null, with ID: null
2009-04-16 14:06:25,782 INFO [Thread-170] CTSThreadPoolManagerImpl -       ICTSTask has returned successfully...
2009-04-16 14:06:25,782 INFO [Thread-170] CTSQueueProcessor -       theCTSResponseContent is null
2009-04-16 14:06:25,939 DEBUG [Thread-170] CTSSessionImpl -       [6] A new ICTSSession was created for system@docbaseX: s6
2009-04-16 14:06:25,939 DEBUG [Thread-170] CTSSessionUtils -       setThreadSession: true: com.documentum.cts.impl.services.session.CTSSessionImpl@2f7cfe:s6
2009-04-16 14:06:25,986 DEBUG [Thread-170] CTSQueueProcessor -       getNumberOfSignedOffItems: 1
2009-04-16 14:06:25,986 DEBUG [Thread-149] CTSQueueProcessor -       getNumberOfSignedOffItems: 1
2009-04-16 14:06:27,098 DEBUG [Thread-149] CTSQueueProcessor -       GC: total= 63 MB, free= 41 MB

Find more posts tagged with

Comments

Vasse

I finally found an error in the log4j.properties hopefully getting the log for the custom plugin to work correct.

Im sure i checked the file 20 times or more but somehow this error eluded me.. im either blind or plain stupid

Since im at home i cant test this but i will post the results of the change asap.

Hopefully if i can get the custom plugin log to work i can get some additional information about the main issue - the plugin not being recognized by the "CTS task manager".

Regards,

Vasse

The log is working now but unfortunatly i dont get any new hints of what the error might be.

One thing i noticed is that in the std_err.log is these messages that seem to only come when i enable my custom plugin in the CTSPluginService.xml:

[Error] :2:11: Document is invalid: no grammar found.
[Error] :2:11: Document root element "imageInfo", must match DOCTYPE root "null".

I dont know where this error is comeing from and i dont recognise having any xml-files with the tag imageInfo.

Any ideas?

Francois Dauberlieu

Looking at the error messages, obviously your XML is malformed.

Run it thru whatever tool you can find to validate it or attch it to your post so we can check it out

Vasse

Solution to my problem was the following:

The source_formats and target_formats for my custom dm_media_profile was lacking the text -> text transformation i was trying to do.

Declaring the formats in the filter tag for your profile isnt enough, you also need to make sure the attributes for the dm_media_profile are correct as well.

Thanks for your help,

Vasse

Francois thank you for your input.

It turned out that these error messages was created by another plugin so they were unrelated.

Francois Dauberlieu

Now, ain't that confusing. I hate when it happens. Good job at spotting the real problem in your plug-in

ACCGS

Hi Vasse,

I am trying to create a new media plugin which is a .exe file that convert the media file from one format to another format.

I looked into the product development guide creating a simple Text plugin. But i am not getting how to proceed. I wrote a java class with methods getName() , getVersion() and loadconfig(). I am having doubt in executeprofile() method.

In the executeprofile() i am calling the .exe file, and added the loggers to check whether my plugin is invoked. I specified the plugin name in the config file <SERVER> which is the same i mentioned in the profile.

But my plugin is not invoked and i dont see any logs.I think it is not being called.

I have doubts regarding-

1) Do i have to call the .exe file in the executeprofile() method ?.

2)when is my custom plugin invoked? after clikcing on the Transform (Menu item) -> More formats(Menu item)--> this plugin should invoke right?

3)where do i specify my parameters that the .exe file will take? In Command Profile or in UserProfile. and how will this be taken in the plugin class.?

If you can share your ideas and sample you have created successfull this wil be very helpful.

Thanks in Advance

GACC

Vasse

Hello GACC,

Kinda late reply but maybe I can help someone else having the similar issues as you.

To try to answer your questions:

1) Do i have to call the .exe file in the executeprofile() method ?.

Yes, from what i know there isnt any other way.

2)when is my custom plugin invoked? after clikcing on the Transform (Menu item) -> More formats(Menu item)--> this plugin should invoke right?

Creating a transformation request for your plugin will most definitly invoke your plugin (at the least when the cts server consumes it).

3)where do i specify my parameters that the .exe file will take? In Command Profile or in UserProfile. and how will this be taken in the plugin class.?

In your executeProfile method you get a handle to the profiles command line file. Your parameters in the user profile (if you want the user to specify any parameters) can be passed down to the command line file and ultimately end up in your plugin class.

Some other tips:

* In your plugin use DfLogger for logging: DfLogger.debug(object, message, args, throwable);

Also add the following to your log4j.properties

log4j.category.com.mycompany.cts=DEBUG, customPluginAppender
log4j.appender.customPluginAppender=org.apache.log4j.RollingFileAppender
log4j.appender.customPluginAppender.MaxFileSize=24MB
log4j.appender.customPluginAppender.MaxBackupIndex=10
log4j.appender.customPluginAppender.File=e\:\\PROGRA~1\\DOCUME~1\\CTS\\logs\\custom_plugin.txt
log4j.appender.customPluginAppender.Append=true
log4j.appender.customPluginAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.customPluginAppender.layout.ConversionPattern=%d{ISO8601} %5p [%10t] %-20c - %5x %m%n
log4j.appender.customPluginAppender.DatePattern='.'yyyy-MM-dd

This will hopefully create a log for your plugin.

* Make sure your plugin is included in the CTSPluginService.xml and that you entered the correct class name and package:

* and that in your configurationsfile (my_plugin.xml in this case) has the correct servername and supported_formats:

<MP_CONFIG>

...

<SERVERNAME>my_plugin</SERVERNAME>
....

          <SUPPORTED_FORMATS>
            <SOURCE format="gif">
                <TARGET format="jpeg"></TARGET>
            </SOURCE>
        </SUPPORTED_FORMATS>
    </MP_CONFIG>

* The servername must match with the mptype attribute in your profile.

* Dont forget to include your compiled plugin to the class path for the cts.

* Restarting the cts services will force a reload of the plugin configuration files and you should see something similar in your cts_log.txt log:

2010-07-20 16:45 INFO [ main] CTSPluginHandlerImpl - Loading the config file : d:\PROGRA~1\DOCUME~1\CTS\config\my_plugin\my_plugin.xml

During the startup several methods from plugin class (com.mycompany.cts.CustomPlugin) are executed, getName, getVersion, getSupportedFormats etc..

If you add some logging you can trace that your plugin class is used or not.

* You might also want to check the standard err log created under Documentum\CTS\config folder for error messages.

Regards,

Vasse

Neeraj2010

I was able to implement the Custom Plugin successfully. Also in the CTS logs it says the profile executed sucessfully. But it is not calling executeProfile() and not seeing any entries in the log that I have printed in the code. Any idea?

Appreciate your inputs here.

- Neeraj

Vasse

Hello,

Are you sure that your code doesnt execute?

To verify this you write to the log In your constructor,

Can you verify that your custom dm_media_profile has the same mptype as you specified in your plugin configuration according to:

* The servername must match with the mptype attribute in your profile.

Example:

d:\PROGRA~1\DOCUME~1\CTS\config\my_plugin\my_plugin.xml

<MP_CONFIG>

...

<SERVERNAME>my_plugin</SERVERNAME>

...

</MP_CONFIG>

should match your custom dm_media_profile:

...

</commandfilepath>

</Profile>

Also verify that your plugin is loaded:

2010-07-20 16:45 INFO [ main] CTSPluginHandlerImpl - Loading the config file : d:\PROGRA~1\DOCUME~1\CTS\config\my_plugin\my_plugin.xml

BR,

Vasse

Neeraj2010

Hi Vasse,

Thanks for your reply. Yes the name matches and I have verified again everything is correct as per CTS Deve guide. Even the Plugin loads sucessfully. Please see below lines from log.

03:37:38,019 INFO [ main] CTSPluginHandlerImpl - Loading the config file : E:\DOCUME~1\CTS\config\indesign\indesign.xml

03:40:33,568 INFO [ Thread-34] CTSProfileManagerImpl - Successfully updated the profile cache for : Indesign_to_PDF

Also the method loadConfuguration() is also called and my debug statements appear in custom log that I configured in log4j.properties.

See the lines from my custom log below:

03:37:38,078 DEBUG [ main] IndesignPlugin - Connected To Docbase

03:37:39,057 DEBUG [ main] IndesignPlugin - Disconnected From Docbase

03:37:39,057 INFO [ main] IndesignPlugin - CTS 6.7 - Custom Indesign Plug-in Initialized.

Also when I select Indesign file and do More Formats, I see my custom plugin. In the CTS log it shows the Plugin called and executed sucessfully. See the below lines from CTS log that says it is completed successfully. But executeProfile() is not called and I don't see any debug statements from that method.

03:50:58,224 INFO [ Thread-73] CTSThreadPoolManagerImpl - About to get RUN CTSTask...

03:51:02,121 INFO [ Thread-73] CTSPluginHandlerImpl - **** Executing Atomic CTSProfile Indesign_to_PDF ******

03:51:02,814 INFO [ Thread-73] CTSThreadPoolManagerImpl - ICTSTask has returned successfully...

03:51:02,814 INFO [ Thread-73] CTSQueueProcessor - _successNotificationAdmin : false

03:51:02,814 INFO [ Thread-73] CTSQueueProcessor - _successNotificationRegular : false

03:51:02,873 INFO [ Thread-73] CTSQueueProcessor - Message from queue item: -profile_id="08001b28801f695e" -render="true" -target_page_modifier="dctm_pm_20961619" -delete_on_completion="true" -arg_object_id="08001b28801f6977"

03:51:03,625 INFO [ Thread-73] CTSQueueProcessor - CTSResponse object is updated successfully for transformation : Indesign_to_PDFwith job status : Completed

I am not getting any clue what could be the reason that it called one method loadConfiguration() and not the executeprofile(). :-(

Regards,

Neeraj

Neeraj2010

I have enabled the DEBUG mode for CTS log and folowing is the info from log.

08:26:22,416 DEBUG [ Thread-51] CTSPluginHandlerImpl - executeProfile - Indesign_to_PDF (08063666801860d1)

08:26:22,434 DEBUG [ Thread-51] CTSPluginHandlerImpl - This profile Indesign_to_PDF is going to be processed locally

08:26:22,434 INFO [ Thread-51] CTSPluginHandlerImpl - **** Executing Atomic CTSProfile Indesign_to_PDF ******

08:26:22,456 DEBUG [ Thread-51] CTSPluginHandlerImpl - MP is available but checking whether the format is supported

08:26:22,456 DEBUG [ Thread-51] CTSPluginHandlerImpl - srcFormat : indd

08:26:22,456 DEBUG [ Thread-51] CTSPluginHandlerImpl - tgtFormat : pdf

08:26:22,456 DEBUG [ Thread-51] CTSPluginHandlerImpl - No Media Plug-in of type CUSTOM_INDESIGN available to handle a 'Indesign_to_PDF' transformation

CUSTOM_INDESIGN is the name I have given in Plugin configuration file.

In Plugin configuration XML file :

<CACHE>E:\DOCUME~1\CTS\cache</CACHE>

<VERSION>CTS 6.7 - Custom Indesign Plug-in</VERSION>

<SERVERNAME>CUSTOM_INDESIGN</SERVERNAME>

And in custom Profile XML :

<CommandFilePath mptype="CUSTOM_INDESIGN">/System/Media Server/Custom/Command Line Files/Indesign_to_PDF.xml</CommandFilePath>

</Profile>

The names are matching. Not sure what this error means.

Also what is the soure format name i have to give in Source format : I believe it is name of dm_format and not dos_extension. Please clarify.

Regards,

Neeraj

Vasse

About the format, as i understand it:

Imagine a plugin that transforms a MS word document to pdf, you will need the following setup.

On content server

dm_format

name = msw8

dos_extension = doc

dm_media_profile object

source_formats = doc

target_formats = pdf

dm_media_profile content

</formats>

On CTS server

plugin configuration file

<SUPPORTED_FORMATS>

</SOURCE>

</SUPPORTED_FORMATS>

formatMapperService.xml

Hope this sheds some light about the formats and when to use name vs dos_extension.

Kind regards,

Vasse

Neeraj2010

Hi Vasse,

Thanks for your reply. I will try this and let you know.

But as per the CTS guide

In Sample Profile :

</Formats>

And In Profile Config file :

<SUPPORTED_FORMATS>

</SOURCE>

Here crtext is actually name for dm_format. If you see the format definition the extention is "txt".

Thats why I have used "indesign5" instead of "indd"

Confused :-(

Regards,

Neeraj

Neeraj2010

I got rid of the error "No Media Plug-in of type CUSTOM_INDESIGN available to handle a 'Indesign_to_PDF' transformation".

I have used format_name "indesign5" as source format in CTS custom profile and dos_extension "indd" as source format in CTS Profile Config file.

But I am getting a different issue now, it says canExecute :false . Please the complete log below.

05:48:41,496 DEBUG [ Thread-50] CTSQueueProcessor - Processing the Queue item: 1b001b28805544d4

05:48:41,507 DEBUG [ Thread-50] CTSQueueProcessor - isPreProcessed the Queue item (1b001b28805544d4) by this instance : false

05:48:41,810 DEBUG [ Thread-50] CTSQueueProcessor - checking canExecuteProfile() for Queue item (1b001b28805544d4)

05:48:41,814 DEBUG [ Thread-50] CTSPluginHandlerImpl - The source format is: indesign7, content type is: indesign7

05:48:41,814 DEBUG [ Thread-50] CTSPluginHandlerImpl - Message from queue item: -profile_id="08001b28801f7439" -render="true" -target_page_modifier="dctm_pm_14127555" -delete_on_completion="true" -arg_object_id="08001b28801f730c"

05:48:41,817 DEBUG [ Thread-50] CTSPluginHandlerImpl - The profile ID is: 08001b28801f7439

05:48:41,817 DEBUG [ Thread-50] CTSPluginHandlerImpl - The target format is: pdf

05:48:41,834 DEBUG [ Thread-50] CTSPluginHandlerImpl - The profile Indesign_to_PDF is an atomic profile

05:48:41,834 DEBUG [ Thread-50] CTSPluginHandlerImpl - using the cached capabilties of profileName : Indesign_to_PDF ; source format : indesign7 ; target format : pdf

05:48:41,837 DEBUG [ Thread-50] CTSPluginHandlerImpl - cached info canExecute : false

05:48:41,837 DEBUG [ Thread-50] CTSPluginHandlerImpl - CanExecute Indesign_to_PDF : false

05:48:41,837 DEBUG [ Thread-50] CTSPluginHandlerImpl - ### leaving canExecute :false

05:48:41,861 DEBUG [ Thread-50] CTSQueueProcessor - Queue item (1b001b28805544d4) canExecute : false

05:48:41,861 INFO [ Thread-50] CTSQueueProcessor - Unable to execute the profile of the queue item (1b001b28805544d4)

05:48:42,252 DEBUG [ Thread-50] CTSQueueProcessor - checking isQueueItemExpired() for Queue item (1b001b28805544d4)

Any thoughts?

Or I need to use dos_extension "indd" as source format in CTS profile as well. But I have checked the OOTB profile document_to_pdf and it has "msw4" and "msw14" etc as source format instead of "doc".

Please suggest what could be the reason.

Regards,

Neeraj

Vasse

I am bit confused, you say you are using format_name indesign5 but the log says indesign7. Is this just a typo?

The log says:

05:48:41,837 DEBUG [ Thread-50] CTSPluginHandlerImpl - cached info canExecute : false

So there is something wrong with the configuration of the plugin / CTS profile.

Or I need to use dos_extension "indd" as source format in CTS profile as well. But I have checked the OOTB profile document_to_pdf and it has "msw4" and "msw14" etc as source format instead of "doc".

I would definitly try that, with the following setup - assuming you want to transform indesign7 to pdf:

On content server

dm_format

name = indesign7

dos_extension = indd

dm_media_profile object

source_formats = indd

target_formats = pdf

dm_media_profile content

</formats>

On CTS server

plugin configuration file

<SUPPORTED_FORMATS>

</SOURCE>

</SUPPORTED_FORMATS>

formatMapperService.xml

Neeraj2010

Actually I have configured for Indesing formats - indesign2,indesign3...indesign7. So I have mentioned indesign5 in the above thread.

Regards,

Neeraj

Neeraj2010

Hi Vasse,

Great it worked.

But here is what we need to have.

dm_format

name = indesign5

dos_extension = indd

name = indesign7

dos_extension = indd

etc.

dm_media_profile content (Here we have to use name of dm_format not dos_extension. Then only it enables More Formats option)

</formats>

On CTS server

plugin configuration file

<SUPPORTED_FORMATS>

</SOURCE>

</SUPPORTED_FORMATS>

formatMapperService.xml

Finally it worked.

Thanks for all your help. CTS Dev documentation was not clear on this.