This section describes how to load a Rhapsody Local Configuration (RLC) file:

If you are using a command line script or XML to overwrite a current configuration and you do not have permissions to overwrite a configuration, you are not presented with an error message indicating you have insufficient privileges to overwrite a configuration. The new configuration, however, does not overwrite the current configuration; it is added to the current configuration. Refer to Loading a Configuration for details.

RLC Load

The following top-level element is used to load an RLC file:

Element

Description

 
rlc-load

Loads the RLC file specified by the file attribute.

Its attributes are:

Attribute Description

file

A string that specifies the filename of the RLC file to load.

defaultLocker

A string that specifies the name for a new or existing locker to load the RLC configuration into (an optional attribute).

 If the RLC file was created before Rhapsody 6.1, the configuration will not be in a locker. On load, a locker will be created if required and the configuration migrated into it. If a locker with the specified name already exists then the configuration is merged into the existing locker.

To create a new locker, the 'Create locker' access right is required. To load the RLC into an existing locker, the 'Edit locker' access right is required for the relevant locker.

<!-- Load a pre-locker RLC -->
<rlc-load file="pre-6.1.rlc" defaultLocker="My Locker"/>
passwordImportMode

Determines how encrypted passwords contained in an RLC file should be handled when the RLC is imported:

  • decrypt-passwords - any passwords found in the Rhapsody objects loaded from the RLC file are loaded along with the configuration. The passwords are decrypted using the passphrase provided. The RLC load is aborted if either no passphrase is provided in the passphrase attribute or the provided passphrase turns out to be incorrect.
  • remove-passwords - any passwords found in the Rhapsody objects loaded from the RLC file are stripped out of the configuration as it is loaded.
  • import-passwords - this option can only be used with RLCs that are not using encrypted passwords. When used, it imports the unencrypted passwords along with the configuration. The RLC load is aborted if the specified RLC is encrypted.

passphrase

 Specifies a passphrase to use to decrypt passwords associated with Rhapsody objects in the RLC file to be loaded.
starting

Configures the state of communication points and routes upon RLC load:

  • stop all - stops all routes and communication points after loading the RLC.
  • start all - starts all routes and communication points after loading the RLC.
  • as in rlc - starts or stop routes and communication points based on the settings in the RLC.
checkInMessage

A non-empty string that specifies the commit comment to use for the configuration changes (an optional attribute). If the attribute is not provided, then an empty commit comment is used.


Lockers

The following elements relating to lockers can be nested inside the rlc-load element:

Element Description
locker Specifies what action to take when importing a specified locker from an RLC.
locker-default The same as locker, except the action applies to all lockers in an RLC.

The attributes are:

Attribute

Description
name Specifies a particular locker in the RLC (only applicable to locker).
action

Specifies the action to take when encountering locker conflicts when loading the RLC:

  • auto - for a specified locker with:
    • A different name from existing lockers on the engine, imports the locker as is.
    • The same name and UUID as an existing locker on the engine, merges the difference of the two lockers into the existing locker.
    • The same name but a different UUID from an existing locker on the engine, imports the locker by adding an increment number to its name.
  • new - for a specified locker with:
    • A different name from existing lockers on the engine, imports the locker as is.
    • The same name as an existing locker on the engine, imports the locker by adding an increment number to its name.
  • merge - for a specified locker with:
    • A different name and UUID from an existing locker on the engine, imports the locker as is.
    • A different name and the same UUID as an existing locker on the engine, merges the difference of the two lockers into the existing locker.
    • The same name and UUID as an existing locker on the engine, merges the difference of the two lockers into the existing locker.
    • The same name and different UUID as an existing locker on the engine, imports the locker by adding an increment number to its name.
  • skip - skips the importing of the specified locker.

If the action attribute is not specified, then auto is used.

Lookup Tables

The following elements relating to lookup tables can be nested inside the rlc-load element:

Element Description
lookup-table Specifies what action to take when importing a specified lookup table from an RLC. 
lookup-table-default The same as lookup-table, except the action applies to all lookup tables in an RLC.

The attributes are:

Attribute

Description

 
name
 Specifies a particular lookup table in the RLC (only applicable to lookup-table).
action

Specifies the action to take when encountering lookup table conflicts when loading the RLC:

  • auto - for a specified lookup table with:
    • A different name from existing lookup tables on the engine, imports the specified lookup table as is.
    • The same name as an existing lookup table on the engine, only imports the specified lookup table if it is the newer of the two lookup table.
  • new - for a specified lookup table with:
    • A different name from existing lookup tables on the engine, imports the specified lookup table as is.
    • The same name as an existing lookup table on the engine, imports the specified lookup table by adding an increment number to its name. 
  • keep existing - does not import the specified lookup table (same as skip for lockers).
  • overwrite - imports the specified lookup table and removes any existing lookup table on the engine with the same name.

If the action attribute is not specified, then auto is used.

Other Rhapsody Objects 

The following elements relating to Rhapsody objects can be nested inside the rlc-load element:

Element Description
rest-client
 Specifies what action to take when importing a specified REST client from an RLC. 
rest-client-default
 The same as rest-client, except the action applies to all REST clients in an RLC.
javascript-library
 Specifies what action to take when importing a specified shared JavaScript library from an RLC. 
javascript-library-default

The same as javascript-library, except the action applies to all shared JavaScript libraries in an RLC. 
intelligent-mapper-project

Specifies what action to take when importing a specified mapping project from an RLC. 
intelligent-mapper-project-default
 The same as intelligent-mapper, except the action applies to all mapping projects, not a specific one,.
x12-project

Specifies what action to take when importing a specified X12 project from an RLC. 
x12-project-default
 The same as x12-project, except the action applies to all X12 projects, not a specific one on the engine.
route-template

Specifies what action to take when importing a specified route template from an RLC. 
route-template-default The same as route-template, except the action applies to all route templates in an RLC. 
filter-template
 Specifies what action to take when importing a specified filter template from an RLC. 
filter-template-default
 The same as filter-template, except the action applies to all filter templates in an RLC. 
communication-point-template
 Specifies what action to take when importing a specified communication point template from an RLC. 
communication-point-template-default
 The same as communication-point-template, except the action applies to all communication point templates in an RLC. 

The attributes are:

Attribute

Description

 
name

Specifies a single instance of a particular Rhapsody object in the RLC.

action

Specifies the action to take when encountering Rhapsody object conflicts when loading the RLC :

  • auto - the same as overwrite.
  • new - for a specified Rhapsody object with:
    • A different name from existing Rhapsody objects on the engine of the same type, imports the specified Rhapsody object as is.
    • The same name as an existing Rhapsody object on the engine of the same type, imports the specified Rhapsody object by adding an increment number to its name.
    skip - does not import the specified Rhapsody object.
  • overwrite - imports the specified Rhapsody object and removes any existing Rhapsody object on the engine with the same name and type.

If the action attribute is not specified, then auto is used.

Example

<!-- Load an RLC -->
<rlc-load file="MyConfig.rlc" passwordImportMode="decrypt-passwords" passphrase="5ecrets" starting="start all" checkInMessage='Loading an RLC'/>

    <!-- Load with locker collision actions -->
	<locker-default action="skip"/>
	<locker name="My Locker" action="merge"/>
	<locker name="Labs" action="skip"/>

    <!-- Load with lookup table collision actions -->
	<lookup-table-default action="auto"/>
	<lookup-table name="Table" action="overwrite"/>
 
    <!-- Load with REST client collision actions -->
	<rest-client-default action="auto"/>
	<rest-client name="String Library" action="overwrite"/>

    <!-- Load with shared JavaScript library collision actions -->
	<javascript-library-default action="auto"/>
	<javascript-library name="JSLib" action="overwrite"/>

    <!-- Load with Intelligent Mapper mapping project collision actions -->
    <intelligent-mapper-project-default action="auto"/>
    <intelligent-mapper-project name="Mapping Proj 1" action="overwrite"/>

    <!-- Load with X12 project collision actions -->
    <x12-project-default action="auto"/>
    <x12-project name="X12 Proj 1" action="overwrite"/>

    <!-- Load with route template collision actions -->
    <route-template-default action="auto"/>
    <route-template name="Route Template 1" action="overwrite"/>

    <!-- Load with filter template collision actions -->
    <filter-template-default action="auto"/>
    <filter-template name="Filter Template 1" action="overwrite"/>

    <!-- Load with communication point template collision actions -->
    <communication-point-template-default action="auto"/>
    <communication-point-template name="Comm Pt Template 1" action="overwrite"/>
 
</rlc-load>