This section describes how to save the engine's configuration to a Rhapsody Local Configuration (RLC) file.

Only lockers that the user has the 'View locker' access right for will be saved. Lockers that the user cannot view will not be included in the RLC file.

RLC Save

The following element is used to save an RLC file:

Element

Description

 
rlc-save

Saves 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 save.
passwordExportMode

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

  • encrypt-passwords - any passwords used by the exported components are included in the exported RLCfile, but are encrypted using the custom passphrase provided. Encryption is performed using AES-256 using a PBKDF2 key derived from the provided passphrase. These encrypted passwords can only be subsequently loaded if the correct passphrase is provided. However, as only the passwords are encrypted, it is possible to load the rest of the configuration from the RLC file without the correct passphrase. The passphrase attribute is required to be set to a non-empty value if this option is selected.
  • remove-passwords - any passwords used by the exported components are omitted from the RLC file.
  • include-passwords - any passwords used by the exported components are included in the exported RLC file, but in an unencrypted form. This means that they can be subsequently loaded without providing a passphrase.

Examples

<!-- Save an RLC -->
<rlc-save file="automated-save.rlc"/>

<!-- Save an RLC with encrypted passwords -->
<rlc-save file="automated-save.rlc" passwordExportMode="encrypt-passwords" passphrase="secret"/>

<!-- Save an RLC with the passwords removed -->
<rlc-save file="automated-save.rlc" passwordExportMode="remove-passwords"/>

<!-- Save an RLC with unencrypted passwords -->
<rlc-save file="automated-save.rlc" passwordExportMode="include-passwords"/>