Stream Processor Studio Overview

The Stream Processor Studio is a developer tool that is shipped with WSO2 SP to develop Siddhi applications. It allows provides two interfaces to develop Siddhi applications

• From source view: This allows you to write Siddhi applications in the Siddhi Query Language. This supports auto-completion, tracking syntax errors and debugging.

• From design view:This interface visualizes the event flow of a Siddhi application, and allows you to compose the applications by dragging and dropping Siddhi components to a graph.

Once a Siddhi application is created, you can simulate events via the Stream Processor Studio to test whether it works as expected. You can also run the Siddhi application in the debug mode to detect errors in the Stream Processor logic.

Starting Stream Processor Studio

To start and access the Stream Processor Studio, follow the steps below:

1. Start the Stream Processor Studio by issuing one of the following commands from the <SP_HOME>/bin directory.

   • For Windows: editor.bat

   • For Linux: ./editor.sh

2. Access the Stream Processor Studio via the http://localhost:<Stream_Processor_Studio_PORT>/editor URL. The Stream Processor Studio opens as shown below.

Welcome Page

Open

The  Welcome to the Stream Processor Studio Tour Guide is open by deault. You can take a tour by following the instructions on the dialog box, or close it and proceed to explore the Stream Processor Studio on your own. You can also access this dialog box by clicking Tools => Tour Guide. Once you close the dialog box, you can try the following:

• New
  Click this to open a new untitled Siddhi file.

• Open

  
  Click this to open a Siddhi file that is already saved in the workspace folder of the Stream Processor Studio. If the file is already opened in a new tab, clicking Open does not open it again. The default path to the workspace directory is <SP_Home>/wso2/editor/deployment.

• Try out samples
  The pre-created samples provided out of the box are listed in this section. When you click on a sample, it opens in a new tab without a title.

• More Samples
  Click this to view the complete list of samples in the samples directory. This allows you to access samples other than the ones hat are displayed by default is the Try out samples section. When you click on a sample, it opens in a new tab without a title.

• Quick links
  This section provides links to more resources.

Menu items 

This section explains the options that are available in the File, Edit and Run menus.

File menu Items

The File menu includes the following options.

Open

• New
  Click this to open a new untitled Siddhi file. 
   

• Open File
  Click this to open a Siddhi file that is already saved in the workspace directory of the Stream Processor Studio. If the file is already opened in a new tab, clicking this menu item does not open it again in another tab. The default path to the workspace directory is <SP_Home>/wso2/editor/deployment.
  
  When a Siddhi file is opened, its source view is displayed by default. 

  
  To view a design view where the elements of the Siddhi application are graphically represented, click Design View. 
  
  As a result, a graphical view of the Siddhi application is displayed as shown in the following example.
  
   

• Import Sample
  Click this to import a sample from the samples diretory to a new tab. The sample opens in an untitled Siddhi file. Once you save it, it can be accessed from the workspace directory.
   

• Save
  Click this to save an edited or new file to the workspace directory.
   

• Save As
  Click this if you want to save an existing saved file with a different name. If you click this for an untitled Siddhi file, the normal save operation is executed (i.e., same operation carried out when you click Save).
   

• Import File
  Click this to open a file from a system location. This file is opened in a new tab in the saved state with the same file name with which it is imported.
   

• Export File
  Click this to export a saved file to a system location. This is only applicable to Siddhi application tabs that are in a saved state.
  
  

• Export as Docker

   

  Click this to export one or more selected Siddhi applications in a Docker container. Once you click on this menu item, the Export as Docker dialog box appears.
  

  
  Select the relevant check boxes to indicate which Siddhi files you need to export. If you select the check box for workspace, all the Siddhi applications in the workspace directory are exported.
  
  For detailed information, see Exporting Siddhi Files.
  
  

• Close File
  Click this to close a currently active Siddhi application that is already open in a tab.
   

• Close All Files
  Click this to close all the Siddhi files that are currently open.
   

• Delete File
  Click this to delete the currently active Siddhi file from the workspace directory. Only Siddhi files that are already saved can be deleted.
   

• Settings
  Click this to change the theme and the font size used in the Stream Processor Studio. The default theme is Twilight.