XMLAccess Samples

WebSphere Portal LogoXMLAccess is a command-line utility for exporting and importing various portal configuration settings in an XML format. The utility takes an XML file as input and produces an XML file, which is the results of the input. It’s a very common way of moving configuration settings from one environment to another. On the portal file system, there are number of useful samples, which can be used as-is or a basis for creating your own scripts. Following is a list of the available XMLAccess samples. I wanted to list these on my blog because it’s often more convenient to check them here than on the actual server file system.

XMLAccess samples

Found in <PortalServer-root>/doc/xml-samples.

In the HCL Docker/Kubernetes image from HCL, for example, they can be found at the following path:
/opt/HCL/PortalServer/doc/xml-samples

List created from files in HCL Portal version 9.5

ActivatePortlet.xml
CleanSystemSlots.xml
CleanupUsers.xml
ClonePortlet.xml
CopyPage.xml
CreateAnalyticsTags.xml
CreateApplicationCategoryByLabel.xml
CreateApplicationCategoryByURL.xml
CreateCsaPage.xml
CreateFilter.xml
CreateLanguage.xml
CreateLegacyPage.xml
CreatePageFromTemplate.xml
CreatePageFromZip.xml
CreatePage.xml
CreateTagsAndRatings.xml
CreateUrl.xml
CreateUser.xml
CreateUXFMDialogDefinition.xml
CreateWSRPProducer.xml
DeleteAnalyticsTags.xml
DeleteApplicationCategory.xml
DeleteFilter.xml
DeletePage.xml
DeletePortlet.xml
DeleteTagsAndRatings.xml
DeleteUser.xml
DeleteUXFMDialogDefinition.xml
DeployPortlet.xml
DeployThemeFromWebModule.xml
DeployTheme.xml
ExportAllDAMCollections.xml
ExportAllPolicyNodes.xml
ExportAllPortlets.xml
ExportAllUsers.xml
ExportAnalyticsTags.xml
ExportIncludingOrphanedData.xml
ExportManagedPagesRelease.xml
ExportPageResult.xml
ExportPage.xml
ExportPortletAndPage.xml
ExportPortletAndStaticPage.xml
ExportRelease.xml
ExportStaticPage.xml
ExportSubTree.xml
ExportTagsAndRatings.xml
ExportTasks.xml
ExportThemesAndSkins.xml
ExportUniqueRelease.xml
ExportUserResource.xml
ExportUXFMDialogDefinition.xml
ExportWSRPCustomizedPortletInstances.xml
ExportWSRPProducersAndPortlets.xml
ExportWSRPProducer.xml
Export.xml
FederationDeletion.xml
FederationImport.xml
IntegrateRemotePortlet.xml
ModifyPortlet.xml
MovePage.xml
RegisterPreDeployedEAR.xml
Task.xml
Transaction.xml
UpdateAccesscontrol.xml
UpdateFilter.xml
UpdatePortlet.xml
UpdateVault.xml

Example: export all themes and skins

Following is an example of how one of these scripts might be executed on a UNIX system:

/usr/IBM/WebSphere/PortalServer/bin/xmlaccess.sh -user wpsadmin -password <password> -url http://<host>:<port>/wps/config -in /usr/IBM/WebSphere/PortalServer/doc/xml-samples/ExportThemesAndSkins.xml -out /home/<user-home>/ExportThemesAndSkins_result.xml

In the command above, you should modify the paths if they differ on your server and you must also replace <password>, <host>, <port>, and <user-home> with values appropriate to your own environment.