Loading a Configuration

Rhapsody enables you to load (open) previously saved configurations via the Reload Local Configuration Wizard:

Caveats

• When loading RLCs created on versions prior to Rhapsody 5 (containing notification schemes) onto later versions, the system events are not migrated to the new engine.
• The Scheme Notifier communication point has been renamed and is now called the Watchlist Notifier communication point. RLC files containing the older communication point will automatically be converted to the new one. The XML output from this communication point has some changes that may require changes to the route. Refer to Watchlist Notifier for details.
• The Notification and Waiting and Idle Count Notifier communication points are not available in Rhapsody versions 5 onward. If an RLC file from a previous version of Rhapsody is loaded that contains either of the communication points, they are replaced with the RLC load error icon and will need to be manually removed.
• As of Rhapsody 6.1, Rhapsody does not permit the naming of components using any of the following special characters: {}[]<>:;$\/*?"|. If you attempt to load a pre-Rhapsody 6.1 RLC file that contains components with invalid names, the RLC load will fail. Ensure you rename any invalid component names before importing your configuration. This restriction is not applicable to the special characters (< and >) in the default names of the filters in the IHE Toolkit.

Loading an RLC File

Before loading a saved configuration, Rhapsody checks that the total number of existing and loaded communication points and routes do not exceed the current license restrictions. If it does, an alert is displayed identifying the reason for the load failing.

To load a Rhapsody local configuration (RLC):

1. Navigate to File>Open... to display the Reload Local Configuration Wizard:

   

2. Select the Browse... button to select the RLC file that contains your local configuration, then select the Next button.

3. Decide what you want to do:

   

   If you want to...	Then...
   Delete your existing Rhapsody configuration	1. Select the Clear the current configuration prior to load checkbox. Refer to Clearing the Current Configuration for details. 2. To load: All the components of the new configuration, select Reload entire configuration. Only certain components of the new configuration, select Choose components to reload. Select the checkboxes alongside the components you want to load. If you are manually choosing components to load, ensure you also select any dependencies.
   Merge the new configuration with your existing Rhapsody configuration	1. Ensure the Clear the current configuration prior to load checkbox is not selected. 2. To load: All the components of the new configuration, select Reload entire configuration. Only certain components of the new configuration, select Choose components to reload. Select the checkboxes alongside the components you want to load. If you are manually choosing components to load, ensure you also select any dependencies.
   Optionally load notification thresholds	Custom notification thresholds and resend periods for each component are automatically saved to the RLC file. The Overwrite component notification thresholds option allows these notification thresholds to be optionally loaded.

   • If a message or mapper definition file is associated with a selected route, it is automatically loaded.
   • Definitions, tracking schemes and watchlists are automatically loaded if you load a component that uses them.
   • If you load a component with the same name as an existing one, it will be replaced, unless the component with the same name is in a different folder.

4. If you want to be prompted before a definition file is overwritten, then select the Prompt when overwriting definitions checkbox. Refer to Overwriting Definitions for details.
5. Under Starting Options, select the status of the components being loaded.
   • Start All - Rhapsody starts all the components after loading them.
   • Stop All - Rhapsody stops all the components after loading them.
   • As in RLC file - after loading the components, Rhapsody retains their status as recorded in a previously saved RLC file. In other words, if you save an RLC file with components in various states, loading the RLC file with this option will ensure that the components are loaded in the same state that they were saved in.
6. If you want to disable all communication point schedules upon loading, then check the Disable all communication point schedules checkbox (the scheduling information is still maintained and editable).
7. Select the Finish button to display the RLC Load commit comments dialog.
   

   • If you have not checked the Clear the current configuration prior to load checkbox, the following dialog is displayed:

     

   • If you have checked the Clear the current configuration prior to load checkbox, the following dialog is displayed:

     

8. Enter the appropriate comments or select a recent comment by clicking the Recent Comments link.
9. Select the Load button to load the RLC file or the Cancel button to return to the Reload Local Configuration Wizard.

Clearing the Current Configuration

The Clear the current configuration prior to load checkbox allows you to clear the current configuration with a new one when enabled or loads the new configuration alongside the current one when disabled (some components may be overwritten, however). To enable or disable the Clear the current configuration prior to load checkbox in the load dialog, set the Rlc.overwriteConfiguration.enabled property in the rhapsody.properties file:

Creating and Overwriting Lockers

When loading an old configuration that does not include lockers, Rhapsody prompts you to select an existing locker, or create a new locker, to load the configuration into:

When loading a configuration that includes lockers, Rhapsody prompts you if it detects differences between the lockers in the RLC file and those which already exist in the engine:

The icon, before the Action column, indicates the state of the locker. Place your mouse pointer over the icon to view a tooltip.

To confirm which definitions you want to overwrite, from the Action list:

Overwriting Definitions

When loading a configuration, Rhapsody prompts you if it detects differences between the definitions in the RLC file and those which already exist in the engine.

To confirm which definitions you want to overwrite, from the Action list:

Overwriting Lookup Tables

When loading a configuration that contains lookup tables, Rhapsody prompts you if it detects differences between the tables in the RLC file and those which already exist in the engine.

The icon, before the Action column, indicates the state of the lookup tables. Place your mouse pointer over the icon to view a tooltip.

To confirm which lookup tables you want to overwrite, from the Action list:

Overwriting Watchlists

When loading a configuration that contains watchlists, Rhapsody prompts you if it detects differences between watchlists in the RLC file and those which already exist in the engine.

The icon, before the Action column, indicates the state of the watchlist.

Icon	Description
	The two watchlists appear to be identical.
	The two watchlists have the same name, but may not be the same watchlist.
	This watchlist may have been renamed.
	The watchlist in the RLC file appears to be newer than the existing watchlist.

To confirm which watchlist you want to overwrite, from the Action list:

Overwriting Shared JavaScript Function Libraries

When loading a configuration that contains shared JavaScript function libraries, Rhapsody prompts you if it detects naming conflicts between the libraries in the RLC file and those which already exist in the engine.

The icon, before the Action column, indicates the state of the shared JavaScript function library:

To confirm which library you want to overwrite, from the Action list:

Overwriting REST Clients

When loading a configuration that contains REST Clients, Rhapsody prompts you if it detects naming conflicts between the REST Clients in the RLC file and those which already exist in the engine.

The icon, before the Action column, indicates the state of the REST Client:

To confirm which library you want to overwrite, from the Action list:

Loading Custom Modules and Libraries

An RLC file containing a Rhapsody configuration can also potentially include custom modules and libraries associated with that configuration. Custom libraries are normally components such as database or JMS drivers; custom modules are non-standard communication points and filters written using the Rhapsody Development Kit (RDK). By default custom modules and libraries are loaded from the RLC file with the configuration, but can be selected explicitly from the Reload Local Configuration wizard. However, the custom modules and libraries will fail to load if the user does not have the 'Load custom modules and third party libraries' access right. The Rhapsody IDE does not upload a custom module or library to the Rhapsody engine if exactly the same library already exists on the Rhapsody engine. A custom module or library is considered the same for these purposes if it has the same name and contents.

In addition, an option in the rhapsody.properties file can be used to limit the circumstances under which custom modules and libraries can be uploaded to the Rhapsody engine. This option is shown below:

# Indicates whether the engine is allow uploads of custom modules and libraries from the IDE. This can be set to one
# of: AllowModuleUploads, OnlyAllowNewModuleUploads, or DisallowModuleUploads.
#ModuleService.customModuleUploadMode=AllowModuleUploads

The three available options for this setting are described below:

As this setting is within the rhapsody.properties file, it requires a Rhapsody engine restart in order to take effect.

Loading Configurations Containing Passwords

When the Rhapsody IDE saves a configuration as an RLC file, you can choose how passwords should be treated. The available options are:

• Export Encrypted Passwords Using Custom Passphrase.
• Remove Passwords From Exported Configuration.
• Export Unencrypted Passwords.

Refer to Saving a Configuration for details on each of these options.

Loading Configurations with Unencrypted Passwords

If the RLC file to be imported contains unencrypted passwords, then you can choose how these passwords are imported during the load:

The available options are:

Rhapsody variables are only loaded from an RLC file if they do not already exist in the Rhapsody engine. This applies irrespective of which option is selected here.

The Automatically use this selection in the future option can be selected automatically either to keep or remove the passwords during future configuration loads. Once set, this option can be subsequently changed via Rhapsody Options.

Loading Configurations with Encrypted Passwords

If the RLC file to be imported contains encrypted passwords, then the passwords can either be decrypted or removed during the load:

The available options are:

Rhapsody variables are only loaded from an RLC file if they do not already exist in the Rhapsody engine. This applies irrespective of which option is selected here.