Creating a broker schema

To organize your resources, and to define the scope of resource names to ensure uniqueness, you can create broker schemas. A default schema is created when you create a message flow, but you can create additional schemas.

Before you begin

The order in which you create your resources is flexible. You can add a new schema to an existing application, library, or integration project, or you can create a container when you create the schema. To create a container first, follow the instructions in the following topics: If your broker schema file will be used by multiple solutions, consider creating it in a shared library.

To find out more about broker schemas, see Broker schemas.

About this task

When you create a message flow, a schema is created by default. The default schema is not displayed in the Application Development view. Only additional schemas that you create are displayed in the Application Development view, under the containing project. For more information about creating a message flow, see Creating a message flow.

To create additional broker schemas, complete the following steps.

Procedure

  1. To open the New Broker Schema wizard, use one of the following methods.
    • Right-click the space in the Application Development view and click New > Broker Schema.
    • Click File > New > Other > Integration Bus - Application Development > Broker Schema, then click Next.
    • Right-click an application, static library, or integration project, then click New > Broker Schema.
  2. Select the name of the application, library, or integration project in which to create the schema.
    Alternatively, create a new container by clicking New.
  3. Enter a name for the schema.

    Choose a name that reflects the resources that the schema contains; for example, if you want to use this schema for message flows for retail applications, you might give it the name Retail.

    A broker schema name must be a character string that starts with a Unicode character followed by zero or more Unicode characters or digits, and the underscore symbol (_). You can use the period to provide a structure to the name, for example Stock.Common.

  4. Click Finish.
    The schema is shown in the Application Development view under the relevant container.

    If category view is selected in the Application Development view when you create the schema, you see a message to say that the schema has been created, but it might not be visible in the Application Development view when it is empty. To show the new schema in the Application Development view, click Hide Categories The Hide Categories toolbar icon on the Application Development view toolbar.

Results

The schema directory is created in the project directory. If the schema name is structured by using periods, further subdirectories are defined. For example, the broker schema Stock.Common results in a directory Common, in directory Stock, in the application, library, or integration project directory.