XML File Writer Output Adapter Sample

About This Sample

This sample demonstrates the usage of the Spotfire Streaming XML File Writer adapter, which is an embedded adapter suitable for streaming tuples to a text file formatted with XML tags.

The XML file created by this adapter does not contain a root node. Each tuple streamed by the adapter should be treated as an individual document. Input fields of type list or tuple are not supported.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top-level menu, click File>Import Samples and Community Content.

  • Enter xmlf to narrow the list of options.

  • Select XML file output adapter from the StreamBase Standard Adapters category.

  • Click Import Now.

StreamBase Studio creates a project for the sample.

Running This Sample in StreamBase Studio

  1. In the Project Explorer view, open the sample you just loaded.

    If you see red marks on a project folder, wait a moment for the project to load its features.

    If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven>Update Project from the context menu.

  2. Open the src/main/eventflow/packageName folder.

  3. Open the XMLFileWriterTest.sbapp file.

  4. In the EventFlow editor, double-click the XMLFileWriter adapter icon to open its Properties view.

  5. In the Adapter Properties tab, change File Name to point to a location on your machine where you want the log to be written when the application is run.

  6. Make sure the application is the currently active tab in the EventFlow Editor and click the Run button. This opens the SB Test/Debug perspective and starts the module.

  7. In the SB Test/Debug perspective, select the Manual Input tab.

  8. Enter a valid integer for a and click Send Data.

  9. When done, press F9 or click the Terminate EventFlow Fragment button.

  10. The file specified in File Name is located in the node's root path and should now contain tuples formatted as follows:

    <tuple>
    <a>2</a>
    </tuple>

Sample Location

When you load the sample into StreamBase® Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase® Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

studio-workspace/sample_adapter_embedded_xmlfilewriter

See Default Installation Directories for the default location of studio-workspace on your system.