Templates

New routes, filters and communication points in Rhapsody are created with a set of default Rhapsody configuration settings. Templates are global Rhapsody objects that enable you to create routes, filters and communication points with user-defined configuration settings.

Templates cannot reference locker-based Rhapsody objects, but can reference global Rhapsody objects which are validated upon check-in. 

The following table lists which configuration options are supported for a template of a certain component type:

The Template Manager enables you to add, edit and remove templates:

Viewing Templates

To launch the Templates Manager:

• From the View menu, select Templates.
• Alternatively, press Ctrl+SHIFT+D.

Managing Templates

The manager provides the following functionality from either the toolbar or right-click menu, or both.

Adding a New Template

Adding a New Route Template

To add a new route template:

1. From the Add button, select the Add Route Template. The New Route Template dialog is displayed:

   

2. Enter the appropriate route properties for your template. Refer to Configuring Routes for details on route properties.
3. Select the OK button to create your template, or the Cancel button to abort.

Adding a New Communication Point Template

To add a new communication point template:

1. From the Add button, select the Add Communication Point Template. The Select Communication Point Type dialog is displayed:

   

2. Select the communication point type which you want to create a template for.

3. Select the OK button to display the New Communication Point Template dialog:

   

4. Enter the appropriate communication point properties for your template. Refer to Configuring Communication Points for details on communication point properties.
5. Select the Create button to create your template, or the Cancel button to abort and return to the Templates Manager.

Adding a New Filter Template

To add a new filter template:

1. From the Add button, select the Add Filter Template. The Select Filter Type dialog is displayed:

   

2. Select the filter type which you want to create a template for.

3. Select the OK button to display the New Filter Template dialog:

   

4. Enter the appropriate filter properties for your template. Refer to Configuring Filters for details on filter properties.
5. Select the Create button to create your template, or the Cancel button to abort and return to the Templates Manager.

Create a Template from an Existing Component

To create a template directly from an existing configured route, communication point or filter:

1. Select the relevant component and select the Save as Template from the right-click menu in the:
   • Route Editor.
   • Workspace.
   • Object Browser.
2. The New Component Template dialog is displayed. Edit any properties as required and save your changes. Refer to Adding a New Template for details.

Viewing a Template

To view an existing template in read-only mode:

1. Navigate to the Templates Manager.
2. Select the template whose details you want to view.

3. Select the View button to display the View Component Template dialog:

   

4. For details on component properties, refer to:

   • Configuring Routes.

   • Configuring Communication Points.

   • Configuring Filters.

5. Select the OK button to return to the Templates Manager.

Editing a Template

To edit an existing template:

1. Navigate to the Templates Manager.
2. Select the template whose details you want to edit.

3. Select the Edit button to display the Edit Component Template dialog:

   

4. Edit the appropriate template properties. For details on component properties, refer to:

   • Configuring Routes.

   • Configuring Communication Points.

   • Configuring Filters.

5. Select the OK button to save your template, or the Cancel button to abort and return to the Templates Manager.

Deleting a Template

To delete a template:

1. Navigate to the Templates Manager. 
2. Select the template you want to delete.
3. Select the Delete button.

Creating a Component from a Template

To create a new component from a template, refer to:

• Creating a New Route.
• Creating a New Communication Point.
• Creating a New Filter.

Default Templates

The configuration settings for default templates are used for creating all new components that are created directly (in other words, that are not created using a specific template). 

One template of each component type can be set as a default. If no template for a component type is set to default, the component is created using the default Rhapsody configuration settings for that component type.

To set a template as default:

1. Navigate to the Templates Manager.
2. Select a template for a component type that you want to set as a default template.
3. From the right-click menu select Set as Default.
4. The default template is displayed with the word default next to its name.

To remove a template as default:

1. Navigate to the Templates Manager.
2. Select the default template for a component type whose default setting you want to remove.
3. From the right-click menu select Remove as Default.
4. There is no longer a default template for the component type and the default Rhapsody configuration settings will be used for any newly created components of that type.

You can also set filter templates as default (or remove the default setting) from the right-click menu in the Filter Toolbox's Templates tab.