IBM Streams 4.3.0

Submitting an application bundle file to an instance

To run an application in Streams Studio, submit a job in the Project Explorer view or the Streams Explorer view.

About this task

An application bundle file is generated by the compiler and can be used to submit the application to the IBM® Streams runtime system. If you are working with an SPL application project in your workspace, you can find the application bundle file in the following directory:
<SPL Project>/<Output>/<Main Composite Name>/<Build Output Dir>/*.sab

When you submit applications to an instance, the instance owner must have access to the directory where the application is located. When you use a remote workspace, ensure that the access permissions are set so that the instance owner can access the directory on the remote workspace.

Procedure

In Streams Studio, you can submit an application bundle file to an instance in one of the following ways.
  • Submit an application bundle file from the Project Explorer view:
    1. In the Project Explorer view, locate the application bundle file that you want to submit.
    2. Right-click the application bundle file and select Launch > Launch As Distributed from the menu.

      The Launch command attempts to find all launch configurations that are associated with the selected application bundle file and reuses existing launch configurations to run the application. If no existing launch configuration can be found, then a new launch configuration is created. The generated launch configuration is named with the following naming convention: <Project>-<namespace>__<main composite name>-<name of build configuration>.

      If the Always Prompt option is enabled in the launch configuration, you are presented with the Launch Configuration window, which you can use to change the launch options before launching. If you change options, you must save them when prompted. If you do not save them, the launch proceeds with the previous values. The changes are saved in the launch configuration. If this option is disabled, then you are presented only with the Launch Configuration window if the launch configuration contains errors.

      If more than one launch configuration is found for the selected build configuration, you are prompted to select a launch configuration to run.

    3. If submission values are required by the SPL application that is being submitted, you are prompted to enter the submission values.
  • Submitting jobs in the Streams Explorer view.

Results

When you submit an application bundle file, the IBM Streams instance automatically transfers the file to the host where the job runs. When you compile the application, the necessary artifacts are included in the file. The file includes most toolkit artifacts and libraries that are needed to run the application. You can also specify dependent artifacts with the <sabFiles> tag in the info.xml file. By including these resources, your application can be relocated.

If the application has user-defined parallelism, parallel transformation occurs when you submit the job. Parallel transformation converts the logical application that is specified in the SPL code into a physical application that can be deployed on the hardware.

You can find information about a submitted job in the Streams Studio Console in the Console view. The hover help for a job in the Instance Graph view displays the submission time values for a job.