Implementing a Custom Parser Extension

Configure a Java project and Java builder settings.

Write custom logic to parse a field type and implement the com.sybase.jtf.parser.api.IParseExtension interface.

The result is a custom class that is an extension point of a field. The parsed field data is passed in represented as a byte array. The return value is the newly modified field data, which is inserted into the runtime field data container.

Export the custom code as a JAR file and put the file into the CustomClasses directory under the MessageDesigns directory.

If the custom code JAR file requires supporting JAR files, put the supporting JAR files in CustomClasses directory as well.

Modify the Class-Path variable for the custom code JAR file and supporting JAR files.

For example:

$ cat manifestChange.txt 
 Class-Path: MyUtils.jar
$ jar ufm customField.jar manifestChange.txt

Note: For more information about adding classes to the JAR file's classpath, see Adding Classes to the JAR File's Classpath on the Sun Java Tutorials documentation Web site.

The Message Designer can now instantiate the class when the custom field JAR is loaded in the following steps when you insert the custom field code into a message definition and at runtime.

To start Sybase WorkSpace, select Start > Programs > Sybase > Sybase WorkSpace > Sybase WorkSpace <version>.

To start the Service Container server, select Start > Programs > Sybase > Sybase WorkSpace > SC <version> > Start SC.

In the WorkSpace Navigator of the Service Development perspective, expand the project folder that contains the message definition with which you want to work, then expand the MessageDesigns and MessageDefinitions folders.

Double-click the message definition file, which has a .wfim file name extension.

The message definition file opens in the Message Definition editor.

Select the Message Details tab.

In the Message Definition pane, expand the message definition containers and select the field in which to use the custom field code.

In the Field Properties pane, select the Custom Parse Extension, then click the ellipsis button to the right of that option.

The Custom Parse Extension dialog box opens.

Select the custom field JAR and the class desired for the field, then click OK.

Repeat this step to add the custom field code to other fields in the message definition.

Select File > Save from the main menu bar.

The custom code is added to a message definition.