Using MessageForge

Congratulations! Now that you have installed MessageForge and/or integrated with your project, you are now ready to start reaping the benefits of MessageForge . The rest of this document will be a guided tour through the basic operation of MessageForge's build system.

First, make sure that you have set the environment variable RC_LIBREPO_HOME to point to the location of the MessageForge JARs. For example, if MessageForge is is installed in d:\rmsg then set RC_LIBREPO_HOME to d:\rmsg\lib\java .

Next, modify the code generator configuration as per your installation. Edit the codegenconfig.xml file. Replace all paths so they point to your own installation.

Now, make sure that installation is correct by building the sample messages. In the samples directory type the following:

buildtest

You'll notice that all the sample messages are generated. Compile all the generated JAVA classes using your JAVA compiler. After the messages have been successfully compiled, still in the samples directory, type the following:

runtest

You'll notice that the sample messages are tested. The test class is Test.java in the samples\com\rmsg\samples directory.

Finally, define your own application messages. You can use the samples as a guide or use the schema file included with the distribution. In either case, once you have created some application messages you should follow the steps mentioned above to generate JAVA classes for your messages.

That concludes the tour of MessageForge.