CSV File Writer Output Adapter

Name: Use this required field to specify or change the component's name, which must be unique in the current module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start with application: If this field is set to Yes (default) or to a module parameter that evaluates to true, this instance of this adapter starts as part of the JVM engine that runs this EventFlow fragment. If this field is set to No or to a module parameter that evaluates to false, the adapter instance is loaded with the engine, but does not start until you send an epadmin container resume command (or its sbadmin equivalent), or until you start the component with StreamBase Manager.

Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.

Specify the location of files written by this adapter using the dataAreaPath property in a HOCON configuration file of type com.tibco.ep.streambase.configuration.sbengine, which is described in the Configuration Guide. Specify a full, absolute path to a directory. For example:

name = "sbengine"
version = "1.0.0"
type = "com.tibco.ep.streambase.configuration.sbengine"

configuration = {
  StreamBaseEngine = {
    streamBase = {
      dataAreaPath = "C:/Users/sbuser/Documents/datadir"
    }
  }
}

Make sure you specify a directory for which you have write rights. If you are developing your EventFlow module on Windows or macOS but expect to deploy on Linux, specify a network directory accessible to all systems, or use a substitution variable to specify one location for development and another for deployment.

If your dataAreaPath property specifies an invalid location, the EventFlow module fails at runtime.

If you do not provide a HOCON configuration file of type sbengine with a valid dataAreaPath property, the adapter writes its output file to a default location in the module's node directory. When running your EventFlow module in StreamBase Studio, navigate down the following folder sequence to find the default location:

You can also identify the default write location using the Engine Data Area line of the engine properties for the current node in the Clusters view. This property shows the full path to the parent folder of the engine-data-area folder.

When running your EventFlow module in a node installed and started with the epadmin command, locate the default engine data area directory with the following folder sequence:

If a node containing your EventFlow module is installed and running, whether started from Studio or with epadmin, you can extract the default engine data area location with a command like the following:

epadmin servicename=nodename display engine | grep "Engine Data Area"

Remember that the node directory is normally removed on successful stopping and removal of a node. The node directories for all nodes that Studio starts are removed when Studio exits, if the nodes completed successfully. The node directories for nodes that ended with an error condition are preserved.