Frequently Asked Questions

These instructions assume that you already have the IBM Streams extension for Visual Studio Code installed. If not, start here and follow the instructions.

1. Click File > Open... (or Add Folder to Workspace...).
2. Browse to the project folder and click Open (or Add).
3. The imported project files can be viewed in the Explorer view on the left side.

1. Click File > Import.
2. In the dialog that appears, select General > Existing Projects into Workspace. Click Next.
3. If the project is coming from a folder, make sure Select root directory is selected. Otherwise, if a project is coming from a ZIP file, make sure Select archive file is selected.
4. Click Browse... and navigate to the location of the project folder or ZIP project file.
5. Click Finish.
6. The imported project files can be viewed in the Project Explorer view on the left side.

These instructions assume that you already have the IBM Streams extension for Visual Studio Code installed. If not, start here and follow the instructions.

1. Ensure that your toolkit folder contains a toolkit.xml file.
2. Execute the Set IBM Streams Toolkit Paths command from the Command Palette.
3. Enter the absolute path to your toolkit folder and press Enter. You may also specify multiple toolkit folder paths using commas (,) or semicolons (;) as separators.

1. In the Streams Explorer view, expand the IBM Streams Installations folder and find your installation. Expand the installation and right-click on Toolkit Locations. Then, select Add Toolkit Location....
2. In the Add Toolkit Location window, choose one of the following methods:
   • In the Toolkit location field, specify the name of a toolkit location file or a directory where toolkits are located.
   • Click File... to browse for an XML file that defines a set of toolkit locations.
   • Click Directory... to browse for a directory where toolkits are located.
3. Click OK.

You can learn more about working with toolkits in Streams Studio here.

These instructions assume that you already have the IBM Streams extension for Visual Studio Code installed. If not, start here and follow the instructions.

1. Bring up the Explorer view on the left side and locate your SPL application file.
2. Then, either:
   • Right-click on the .spl file.
   • Double-click on the .spl file to open it in the editor and right-click in the editor.
3. Choose from one of the two build options:
   • Build: Builds your Streams application and downloads the application bundle (.sab) to the application’s output folder.
   • Build and Submit Job: Builds your Streams application and submits it directly to a Streams instance of your choice.

After a project is imported and whenever your project changes, a build is performed automatically. This might take a few seconds. In the SPL Build Console view, you should see a message like:

---- SPL Build for project XXX completed in XXX.XXX seconds ----

If you do not see the SPL Build message in the Console view or you would like to manually perform a build, follow these steps:

• To manually start a build for all active build configurations in a project:
  1. Select and right-click on the SPL project.
  2. Select Build Active Configurations from the menu.
  3. All main composites are built with their active build configurations. Any main composite without an active build configuration is not built.
• To manually build a main composite:
  1. If the main composite does not have any build configurations, you must first create one by following the instructions here.
  2. Expand the main composite in the Project Explorer view.
  3. Select the build configuration (or multiple build configurations) that you want to build, right-click, and select Build from the menu.

Learn more about building applications in Streams Studio here.

These instructions assume that you already have an IBM Streams instance. If you need to install an instance, start here and follow the instructions.

To find the Console URL, see the documentation. Choose Finding the internal URLs for IBM Streams services or Finding the external URLs for IBM Streams services depending on whether or not you will be accessing the Streams Console from within the Kubernetes cluster.

These instructions assume that you already have a running IBM Streaming Analytics service. If you need to create a service, start here.

1. Navigate to the Resource list in IBM Cloud.
2. In the Services section, find your Streaming Analytics service in the list and click on it. You will be brought to the service's details page.
3. Click on the Launch button. This will open the Streams Console.

1. From a terminal, run the following commands:

   source $STREAMS_INSTALL/bin/streamsprofile.sh
   streamtool geturl
          

   This will print out a URL, like this: https://streamsqse.localdomain:8443/streams/domain/console
2. Open this URL in the browser and log in with your Streams credentials.

These instructions assume that you already have the IBM Streams extension for Visual Studio Code installed. If not, start here and follow the instructions.

1. Click on the IBM Streams icon on the left side to bring up the Streams Explorer view.
2. Hover over an instance node and then click on the Open IBM Streams Console icon that appears on the right. This will open the Streams Console in your browser.

These instructions assume that you already have the IBM Streams extension for Visual Studio Code installed. If not, start here and follow the instructions.

1. Import the folder containing the .sab file if you haven't already. To import a project, follow the instructions here.
2. Right-click on the .sab file and select Submit Job.
3. You will prompted for the job configuration before the job is submitted. For more information, see the documentation for the Streams VS Code extension.

Follow these steps to submit a .sab file from the Streams Console.