Import configuration from XML

To copy the properties from one isolated region to another, you can import configuration properties previously exported from another isolated region. You can also use this export and import functionality to back up and restore the isolated region configuration.

About this task

Any pending changes for the target isolated region must be either committed or discarded before beginning the import process.

Procedure

To import isolated region properties:

  1. In Process Configuration Console, select the connection point that identifies the target isolated region.
  2. From the Action menu, select Import from XML, and then browse to locate the previously exported XML file that contains the isolated region properties.
  3. Select one of the following options:
    Option Description
    Overwrite Add the imported properties to the target isolated region, replacing any queues, rosters, and event logs of the same name in the target isolated region. If the target isolated region contains operations that are in use, the commit process will fail. In addition, if there are any transferred workflows that use a queue, that queue will not be overwritten even if the workflows are not running at the time of the import process.

    This option is appropriate for importing from a development environment into an initialized region that will be used for a production environment.

    Important: If you use the Overwrite option to import into a target region that has been in use for some time, items of the same name will be overwritten, which can lead to unexpected results.

    If the exported source contains user information, the import skips the import of the user information if that user is not defined on the target system.

    If the exported source contains a repository, the business name, authorized user, operator, and other business and contact information are imported; the inquiry URL and business key are generated for the target region.
    Merge Add the imported properties to the current properties of the target isolated region. If the target isolated region contains items of the same name as those in the imported (source) isolated region, the longer length string is retained for imported items of type String.

    For an in-use target region, this option preserves any existing properties in the target region, adding only new properties from the source region.

    If the exported source contains user informaiton, the import skips the import of the user information if that user is not defined on the target system.
  4. At the end of the import process, you can click Details to view the progress log.
    If the log contains errors, see the information below for common errors.
    Tip: If you import with System Properties from a non-default region, click Refresh to update display of the properties.

Results

The following rules apply for importing step processor definitions:

  • A step processor definition in the target isolated region cannot be deleted.
  • If an imported step processor definition has an index that conflicts with an existing index in the target, a new index is assigned to the newly imported step processor.
  • The configuration must always have a default step processor and a default launch processor.
    • For importing with the merge option, the target default step processor and default launch processor are preserved.
    • For importing with the overwrite option, default step and launch processors in the source replaces the corresponding step and launch processors in the target to become the defaults.
      Note: If a source step processor set contains an entry that will alter the existing default setting, and there is no other default step processor in the source set, the import will not change the existing default setting.

Example

The following tables illustrate importing an isolated region with the overwrite option set.

Table 1. Source isolated region
ID Type Name
5 8 Approval HTML (Content Cortex)
6 4 Approval Launch HTML (Content Cortex)
50 2 (def. step) MyStep
55 1 (def. launch) MyLaunch
Table 2. Existing target isolated region
ID Type Name
3 8 HTML (Content Cortex)
4 4 Launch HTML (Content Cortex)
5 2 (def. step) Approval HTML (Content Cortex)
6 1 (def. launch) Approval Launch HTML (Content Cortex)
Table 3. Result
ID Type Name
3 8 HTML (Content Cortex)
4 4 Launch HTML (Content Cortex)
5 2 (def. step) Approval HTML (Content Cortex)
6 1 (def. launch) Approval Launch HTML (Content Cortex)
50 2 (def. step) MyStep
55 1 (def. launch) MyLaunch

If the source isolated region contains no default processors and one of the entries will alter the existing default in the target isolated region that could result in no default processor, the existing default processor will not be changed.

Table 4. Source isolated region
ID Type Name
5 8 Approval HTML (Content Cortex)
6 4 Approval Launch HTML (Content Cortex)
Table 5. Existing target isolated region
ID Type Name
3 8 HTML (Content Cortex)
4 4 Launch HTML (Content Cortex)
5 2 (def. step) Approval HTML (Content Cortex)
6 1 (def. launch) Approval Launch HTML (Content Cortex)
Table 6. Result
ID Type Name
3 8 HTML (Content Cortex)
4 4 Launch HTML (Content Cortex)
5 2 (def. step) Approval HTML (Content Cortex)
6 1 (def. launch) Approval Launch HTML (Content Cortex)

If an import fails, you can fix the problem in the source isolated region and re-export the configuration, or in the target isolated region. You can also directly edit the exported XML file and remove items that are causing errors.

The following lists common error messages that might occur during import.

Errors occurred during commit: Can't change field lengths on log, log name="DefaultEventLog, field name=F_Subject

Cause: Length of string field cannot be changed in a log file.

Solution: Either remove the F_Subject field from the export xml file or remove the F_Subject field from the target region.

Exception during import from file, The type of exposed field {xxx} does not match existing exposed field type

Cause: Field type cannot be changed in a log file.

Solution: Remove the field in the export xml file or change to a different log file.

Attribute values don't match for F_WebServer.4

Cause: Location of the Web Applications in the import file does not match the corresponding settings in the target region.

Solution: Either use Process Configuration Console to modify the Web Applications URLs in the import region and re-export the region properties, or modify the target region.

Exception during import from file, Attribute values don't match for F_ComponentDescriptor

Cause: For the Merge option, the Java™ Authentication and Authorization Service (JAAS) user or password or other settings differ on the source and target region for the Component Queue adaptor configuration in a CE Operations queue.

Solution: The Component Queue adaptor configuration should match, or you can use Overwrite to replace the existing settings.

What to do next

If you edit the XML file, you might introduce syntax errors that will cause the import process to fail. The following are some common types of errors and the corresponding error messages:

Example 1: Unmatched open tag and end tag

Exception during import from file. Failed to get a document parser. The element type "ModelAttributes" must be terminated by the matching end-tag "</ModelAttributes>".
... Element type "Value" must be followed by either attribute specifications, ">" or "/>"...

Example 2: Missing open quote in value clause

...Open quote is expected for attribute "Val" associated with an element type "Value"...

Example 3: Missing close quote in value clause

...The value of attribute "Val" associated with an element type "Value" must not contain the '<' character.

Example 4: Missing open quote in attribute

...Open quote is expected for attribute "Length" associated with an element type “ExposedFieldDefinition".

Example 5: Missing close quote in attribute

...Element type "ExposedFieldDefinition" must be followed by either attribute specifications, ">" or "/>"