Transport of Configuration Data 

Use

You can use the Export and Import functions to move individual configuration objects or larger parts of the configuration, including all referenced configuration data, between portals. For example, this allows you to transfer the configuration from a test system to a production system.

 

Features

You can perform the transport manually using the commands integrated in the Configuration iView. If you have implemented the Change and Transport System (CTS), you can also have it perform the export and import of the configuration data automatically.

 

You can generate a transport package in the following formats:

●      Config Archive: Format with the file extension .configarchive

The configuration data in XML format are available in this file compressed as a ZIP file.

●      PAR Archive: Format with the file extension .par

This format is used in the portal environment. The generated PAR file contains the configuration data as a compressed ZIP file in the format .configarchive. In addition, the PAR file contains the files MANIFEST.MF and portalapp.xml.

 

Note the following special features after starting the export function:

●      The extended view of configuration objects is switched on.

●      Configuration objects that are otherwise hidden and used internally become visible.

●      You can browse the configuration hierarchy and display entries. You cannot edit configuration objects in this mode. You can only edit objects if you interrupt the export.

●      More functions, which you can normally launch by choosing Actions in the menu bar, are deactivated.

 

Prerequisites

If you want to use the CTS, you must have created a system in the portal landscape beforehand.

 

Procedure

The transport of configuration data comprises the following steps:

...

       1.      Creation of the transport package

       2.      Export of the transport package

       3.      Import of the transport package

 

Create the Transport Package

To create a transport package, proceed as follows:

...

       1.      Start the export function.

                            a.      In the portal, choose System Administration ® System Configuration ® Knowledge Management ® Content Management.

                            b.      In the menu bar, choose Actions ® Export ® Start.

       2.      Put together the transport package.

                            a.      In the configuration, navigate to the object that you want to export.

                            b.      Select the required instances and choose Export.

From the options, you can choose whether referenced configuration objects are to be exported as well. If you have activated this option, you can use another option to specify whether invalid references are also to be exported.

 

Alternatively, you can use the menu bar to put the export package together. Choose Actions ® Export ® Add. This allows you to choose not only individual instances, but also subareas of the configuration, for example, all repository managers.

In the menu, the following options are available:

○       Topic: Adds all instances of a configuration object to the transport package.

○       Topic Area: Adds all configuration objects in the current area and their instances to the transport package.

○       Topic Area and Related Areas: Adds all configuration objects in the current area and their instances to the transport package. In addition, the system includes the configuration objects and their instances that are listed in Related Areas.

○       Complete Configuration: Adds the entire configuration to the transport package.

 

You can leave the creation of the transport package at any time and return to it later.

To interrupt an export and switch to the normal mode to edit the package, choose Actions ® Export ® Suspend.

To resume an interrupted export, choose Actions ® Export ® Resume.

 

       3.      Check what you have put together.

In the menu bar, choose Actions ® Export ® Edit Export Package. You can check here which entries the transport package currently contains. You can remove configuration objects by deselecting the checkbox in front of the object and choosing OK.

       4.      Generate the transport package and complete the export.

You can perform the transport manually or use CTS.

Manual transport: Work through the following steps for the manual transport.

                            a.      In the menu bar, choose Actions ® Export ® Finalize.

The selected configuration objects are listed and, if necessary, the configuration objects that they reference.

                            b.      Specify a name for the configuration archive to be exported and choose whether the system is to generate the transport package in the Config Archive format or the PAR Archive format.

                            c.      Choose OK.

                            d.      Choose Download and make sure that the file with the ending for the chosen format (.configarchive or .par) is saved.

CTS transport: Work through the following steps for the transport with CTS.

...

                            a.      In the menu bar, choose Actions ® Export ® Finalize via CTS.

                            b.      Specify a name for the transport package. Optionally, you can enter a comment for this transport.

The selected configuration objects are listed and, if necessary, the configuration objects that they reference.

                            c.      Choose Start Export to CTS.

On the next screen, you can find information about the transport to CTS.

                            d.      Choose Close to exit the transport mode.

 

Canceling the Export

To cancel an export, choose Actions ® Export ® Cancel.

 

Manual Mode: Import Configuration Data

...

If you have chosen the manual mode, you must manually import the configuration archive to the target system. Depending on the format, this results in the following steps:

Import of a Transport Package in the Format .configarchive

       1.      In the portal, choose System Administration ® System Configuration ® Knowledge Management ® Content Management. In the menu bar, choose Actions ® Import.

       2.      Choose a configuration archive with the ending .configarchive to import and choose Preview.

The system displays the objects that are added to the configuration, replaced in it, or deleted from it.

If the configuration archive is identical to the existing configuration, the system does not import the file.

       3.      Choose OK to import the configuration archive.

If errors occur during the import, you can display them using the link See Technical Details.

       4.      To activate the imported configuration data in the system, you must restart the application server.

Import of a Transport Package in the Format .par

...

       1.      Upload the PAR file to the portal. In the portal, choose System Administration ® Support ® Portal Runtime ® Administration Console.

       2.      Select the file in the input field beneath Upload Archive and then choose Upload.

       3.      To activate the imported configuration data in the system, you must restart the application server.

 

CTS Mode: Automatic Import of the Configuration Data

If you are using the transport via CTS, CTS automatically transports the transport package to the target system. Once it arrives, the configuration data is automatically unpacked and installed. You may have to restart the application server for the target system.