Skip to content

Working with the XML configuration interface

You can use the XML configuration interface to export and import HCL Digital Experience configurations. This way you can configure selected features or areas of your portal. You can also transfer a complete configuration from one portal to another.

Using the XML configuration interface

HCL Digital Experience provides a highly configurable framework of services to accommodate the different scenarios that portals of today need to address. The framework allows convenient replacement of service implementations as well as modification of the configuration of each service. When you work with the XML configuration interface, the results, especially of configuration imports or updates, are influenced by the property settings in these configuration services. This includes changes that you have made to these settings. For more detail about the configuration services, refer to the topics about the portal service configuration.

There are two ways to use the XML configuration interface to work with portal configuration data:

  • By using the XML configuration command line client. The XML configuration command line client provides all the XML configuration interface functions.
  • By using administration portlets you can export and import XML configurations.

Both options are described in the following sections.

Terminology

These topics use the following terminology in the context of the XML configuration interface:

  • export

    This term can have either of the following meanings, depending on the context:

    • In the administrative context: a human administrative task, for example exporting a portal configuration or a part of it
    • In the context of the XML configuration interface: an XML request and action, for example to export the data of a portal configuration or a part of it.

  • import

    This term represents only the human task in the administrative context, for example importing a portal configuration or a part of it. It has no corresponding XML request type. In the context of the XML configuration interface, an import is performed by specifying the update request type, together with the create or update action for the resources that are to be imported.

The topics in the documentation describe the portal XML configuration interface. Internally within the portal, this tool is named XML Access.

Sample XML scripts

The following topics mention several sample files suitable for different purposes of portal configuration using XML. Before you use them, read the other topics about the XML configuration interface carefully. These sample files are documented here for reference purposes only. If you want to use the XML samples for work on your portal configuration, use the files provided in your portal installation, as they might be more up to date than this documentation. The XML sample files are located in the following directory of your HCL Digital Experience installation:

  • UNIX™Linux™: PortalServer_root/doc/xml-samples
  • Windows™: PortalServer_root\doc\xml-samples

XMLAccess progress logging

Starting CF221, you can enable progress logging to see the progress of XMLAccess in updating items contained in the xmlaccess input script. To use this new function, turn on tracing for com.ibm.wps.command.xml.Progress=all.

The trace.log file contain entries like the following:

[6/3/24 12:49:18:113 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - started updating skin with name: [skin ZK_00000000000000AQ78VEJK2001 uniquename=ibm.portal.SimpleStandard] overall item: 0
[6/3/24 12:49:18:234 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - finished updating skin with name: [skin ZK_00000000000000AQ78VEJK2001 uniquename=ibm.portal.SimpleStandard] overall item: 1
...
[6/3/24 12:49:18:268 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - started updating theme with name: [theme ZJ_00000000000000AQ78VEJK2003 uniquename=ibm.portal.SimpleTheme] overall item: 12
[6/3/24 12:49:18:329 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - finished updating theme with name: [theme ZJ_00000000000000AQ78VEJK2003 uniquename=ibm.portal.SimpleTheme] overall item: 13
...
[6/3/24 12:49:18:354 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - started updating web application with name: [web-app Z1_00000000000000A0BR2B300EO7 uid=ilwwcm-localrenderingportlet-jsr.war.webmod] overall item: 19
[6/3/24 12:49:18:396 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - finished updating web application with name: [web-app Z1_00000000000000A0BR2B300EO7 uid=ilwwcm-localrenderingportlet-jsr.war.webmod] overall item: 25
...
[6/3/24 12:49:19:448 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - started updating page with name: [content-node Z6_000000000000000000000000A0 uniquename=wps.content.root] overall item: 339
[6/3/24 12:49:24:658 UTC] 000001e2 UpdateEngine  I com.ibm.wps.command.xml.UpdateEngine logProgress XMLAccess progress - finished updating page with name: [content-node Z6_000000000000000000000000A0 uniquename=wps.content.root] overall item: 341
The system logs the start and end times for the following artifacts:

  • Skins
  • Themes
  • Web applications
  • Pages
  • Users
  • Groups
Related information