TIBCO

Managing Projects and Artifacts

Overview

Projects are folders in the TIBCO Streaming Model Management Server (MMS) sandbox where you manage your artifacts. Multiple business users may be creating a new artifact either serially or concurrently. At least one project must be available for artifact management.

See Workflow in Detail to learn more about the artifact management workflow.

After signing in to the client, the Sandbox selection screen is displayed. A sandbox provides an isolated environment for working on projects. You can select an existing sandbox or create a new one. Then, create a project or work on existing projects. You can add artifacts to a project by:

  • Creating an artifact and assigning it to the project.

  • Importing n number of artifacts into the project. You can import artifacts by:

    • Browsing for artifacts from your local or other file system.

    • Importing an existing project from Backing Space which is where the checkpointed projects are stored.

Adding Projects and Artifacts

The following sections describe how to create projects and add artifacts to them.

MMS attempts to resolve file naming conflicts if duplicate artifacts or invalid artifact naming syntax are detected within the project.

Adding a New Artifact into a Project

To add an artifact to a project, proceed as follows.

1. If no projects exist, create one by:

  • Clicking the New Project toolbar button in the Project Explorer view.
  • Right-clicking anywhere in the Project Explorer view and selecting New>Project.
  • Selecting File>New>Project from the top-level menubar.

If a project exists, create a new artifact by:

  • Clicking the New Artifact toolbar button in the Project Explorer view.
  • Right-clicking the desired project, selecting New, and then selecting the type of Artifact to create.
  • Selecting File>New from the top-level menubar and then selecting the type of Artifact to create.

Note: The artifact type can be Managed File, Model, Deploy Descriptor, or a Decision Table.

2. Enter/set values in the following fields.

Note: Some fields may not be available depending on the artifact type. For example, Category is only available for Model, and Initial content is not available for Deploy Descriptor.

Field Description
Select a project The project name for the artifact.
Name The name of the artifact.
Type The type of the artifact. For more information, see Artifact Types.
Category The category of the artifact.
Path Optional. The project relative path of the artifact.
Initial content Optional. File to set the initial contents of the artifact.

Note: In most scenarios, it is more efficient to import model files that have already been edited natively into MMS than to create a new one in MMS.

3. Optionally, click Next to add attributes to the artifact. Attributes are arbitrary key-value pairs that can be assigned to artifacts and projects.

Note: You can also modify an artifact's properties after it is created by right-clicking on the Artifact in the Project Explorer view and selecting Properties.

4. Click Finish. The updated project and its containing artifacts appear in the Project Explorer view.

Note: The new projects and artifacts are local to your sandbox until they are checkpointed and published to the backing space.

Importing Projects from the Backing Space

To import projects from a backing space, proceed as follows.

  1. Select File>Import in the top-level menubar, or right-click anywhere in the Project Explorer view and select Import.
  2. In Select an import source, select Project from backing space and then click Next.
  3. On the Import Project dialog, select the project you want to import from Available projects, and then click Add. If you want to add all the available projects, click Add All.
  4. Click Finish.

The changes made to this project are not reflected in the backing space until a checkpoint of the sandbox is created and published. A checkpoint can only be published if the project's version is different from the project's version in the backing space.

Updating the Project Version and Properties

To update the version of a project, proceed as follows:

  1. Right-click the project in the Project Explorer view and select Properties to open the Properties dialog.
  2. Select Project and enter the project version in the Version field. By default, it is populated with the project's current version.
  3. Click OK.

Approving a Project for Deployment

A project must be approved before being deployed to a Streaming cluster. The user must have approval permissions to approve a project. To approve a project for deployment, proceed as follows:

  1. Right-click the project in the Project Explorer view and select Properties to open the Properties dialog.
  2. Select Approvals. The available Streaming clusters are displayed.
  3. Check a cluster and click Apply. You can also click Reset to discard your current changes.
  4. Click OK.

Adding Dependencies to a Project

You can add dependency of other projects from the sandbox or backing space to a project.

Note: A private dependency is only visible in the current sandbox until it is published.

To add dependency to a project, proceed as follows.

  1. Right-click the project in the Project Explorer view and select Properties to open the Properties dialog.
  2. Select Dependencies. The available dependencies are displayed.
  3. Check a dependency and click Apply. You can also click Reset to discard your current changes.
  4. Click OK.