How to use a custom SetValue adaptor

Hello,

For training purposes, I've been working on a custom SetValue SBO adaptor to retrieve a value from a repository and place it in a field on a form. In order to do this I've created and compiled two classes both in a package: com.company.adaptor

1. public interface ISetValueDataSourceAdaptor extends IDfBusinessObject {}

2. public class SetValueDataSourceAdaptor extends DfService implements ISetValueAdaptor, ISetValueDataSourceAdaptor { /*implementation*/ }

The documentation said I had to implement ISetValueAdaptor for a SetValue adaptor, and extend DfService for an SBO.

From this I've created two JARs, an interface JAR with class 1, and an implementation JAR with class 2.

In a DocApp I've created a module with name: com.company.adaptor.ISetValueDataSourceAdaptor (as recommended by the dev guide) and included the two JARs as well as XFormsEngine.jar (for the ISetValueAdaptor class). This succeeded.

In Forms Builder I've created a new Data Source adaptor with classname com.company.adaptor.ISetValueDataSourceAdaptor, ticked SBO, and set up the rest of the input and outputs. The Form itself gets a textfield and a listbox which both use the new adaptor in Data & Storage -> External Data Source. Installation and validation succeeds.

Now when I test my form in Webtop, I get the following error:

Failed to construct adaptor MySetValueAdaptor at xpath "/MyForm/ListBox1": java.lang.ClassCastException: com.company.adaptor.SetValueDataSourceAdaptor

I am restricted to Forms Builder 6.0SP1.

I have two questions:

- What am I doing wrong?

- Does anybody have example code for SetValue adaptors as SBOs?

Extra: I have tested the SBO in a test script in java. And I can reproduce the error.

ISetValueDataSourceAdaptor value = (ISetValueDataSourceAdaptor)client.newService("com.company.adaptor.ISetValueDataSourceAdaptor", sessionManager); //works, returns server instance: com.company.adaptor.SetValueDataSourceAdaptor@ce0bb

SetValueDataSourceAdaptor value = (SetValueDataSourceAdaptor)client.newService("com.company.adaptor.ISetValueDataSourceAdaptor", sessionManager); //fails

Find more posts tagged with

Note:

If there are Accepted Answers, those will be shown by default. You can switch to 'All Replies' by selecting the tab below.

Accepted answers

attila_n

You should set it on the 'special' tab / 'Execute adaptor when form initializes'.

All comments

attila_n

Make sure your interface "extends ISetValueAdaptor, IServiceAdaptor" and implementation class "extends DfService implements <your interface>".

Also, instead of including XFormsEngine.jar, add a reference to the XFormsAdaptor java library.

timhurkmans

Thank you for your answer. I have moved ISetValueAdaptor to the interface class and replaced IDfBusinessObject with IServiceAdaptor. This worked. I am no longer getting the error.

However, I still have some issues. Most important of all, the textfield control isn't being populated. I have implemented execute method as below:

public Object execute(IAdaptorParameter[] parameters) throws AdaptorException

{

return "Hello world";

}

Then in Forms Builder, I create an adaptor (datasource) with class name: com.company.adaptor.ISetValueDataSourceAdaptor (SBO) and initial parameter: dql / <query> (which shouldn't affect the execute method right now). The output schema looks like: (custom) out_string -> (group) rows -> (item) mystring of type string.

- Is the output schema correct? I would expect a String, not a Custom type, but the textbuild element forces me to give a row.

- Do I use a Datasource Adaptor or an Initializer Adaptor for this?

- How can I verify the execute method is being called (as in, debug)? Throwing an AdaptorException does not show any error messages, neither in the form nor the log.

- Is the source of the out-of-the-box adaptors available (for training purposes)?

Secondly, where can I find XFormsAdaptor.jar with a reference to 'com.documentum.xforms.engine.adaptor.datasource.ISetValueAdaptor'? The version I found in the out-of-the-box IDocbaseDataSourceServiceAdaptor does not have that reference. So far, only XFormsEngine.jar contains the correct reference. If I include this in the list of interfaces, then Docapp Builder does not give an error and I can see the implemented interfaces:

com.company.adaptor.ISetValueDataSourceAdaptor

com.documentum.xforms.engine.adaptor.IServiceAdaptor

com.documentum.fc.client.IDfService

com.documentum.fc.client.IDfModule

com.documentum.xforms.engine.adaptor.IAdaptor

com.documentum.xforms.engine.adaptor.datasource.ISetValueAdaptor

attila_n

for the simple 'hello world' adaptor in your example you don't need any input parameters and the output should be String. I'm not sure what you mean by 'textbuild element forces me to give a row'.
use initializer if you want to set a value during new object creation. if you need to set values on existing objects, use datasource.
debugging: if you enable remote debugging in tomcat's or jboss' JVM settings, you can connect from eclipse's debugger and set breakpoints in your adaptor code. or you can run the application (webtop, taskspace) from within eclipse itself. in any case, if your adaptor throws an exception, you should see that on the screen.
source code is not available
you can find the xform related jars in the taskspace WAR file. for example you can create a Web project in eclipse by importing the war file and all the jars will be on the classpath.

timhurkmans

Thank you for your reply.

Related to the "textbuild element forces me to give a row": I can set the output schema to String (stringtype), but when I go to a control -> Properties -> General tab -> Data & Storage tab -> Use adaptors: external data source, and enter TestDataSource there, I get the option to enter values for Row Selection, Value and Display, which remain empty if I select String as my output schema. When I try to validate my form, I get:

"Data [ListBox1] error: Data Source Adaptor [TestDataSource] has the following problems: Row selection is empty. Display is empty. Value is empty."

The validator wants me to fill in all three fields if I use an external data source. How can I fix this?

Also, TaskSpace (6.5/6.6) also do not have XFormsAdaptor.jar. I am also restricted to Forms Builder 6.0SP1 with WebTop 6.0. What do I do in this case? Use XFormsEngine.jar?

attila_n

You should set it on the 'special' tab / 'Execute adaptor when form initializes'.

timhurkmans

Yes, that is the way to set a value to a textfield.

I have created an adaptor with a useless input and I am now using the 'Execute adaptor when input value changes' option (because 6.0 does not have 'Execute on initialize').

Thank you for your answer.