How to: Back-Up Oracle Content Management

How to: Back-Up Oracle Content Management

Oracle Content Management is now in EOS 2025 - unfortunately there is no 1 click backup option available today OOTB with the OCM Web UI. However with the OCM CLI Toolkit you can execute a suite of commands to easily achieve this and backup your data and meta information in JSON format.

💡
To make migration simpler you should checkout Fishbowl Solutions migration services and their easy one click migration tool built into their new CMS - CM Box to migrate data to another Object Store and replicates 80% of the capabilities of OCM with added support for Oracle WebCenter Content.

In this post I'm going to run through how to easily backup your OCM instance locally with the OCM Toolkit -

1. Download and Install OCM Toolkit

The toolkit is available on github:

GitHub - oracle/content-and-experience-toolkit: The Oracle Content Management Toolkit and SDKs help you develop custom applications that consume content that is managed in the OCM repository. These applications can be developed in the Content Management Cloud or using 3rd party tools.
The Oracle Content Management Toolkit and SDKs help you develop custom applications that consume content that is managed in the OCM repository. These applications can be developed in the Content Ma...
If you are new to the OCM Toolkit you can check out a previous guide of mine on how to setup and configure it here:
How To: Setting up the Oracle Content Management Toolkit
The Oracle Content Management Toolkit is a Command-Line Utility that allows you to execute many function against OCM. Now.. you could script these functions by hand and use the public APIs but pretty much all the features you could need are scripted and available here. 💡It’s updated regularly and…

2.Backup Asset Repository Data

The easiest way I have found in the past is to use the transfer-content CMD line this will create 2 batch scripts - one to download a backup of all the asset data in batches from a repository and the other to upload the downloaded batches to another OCM instance

(You have to manually execute the script once generated - you won't need the second batch script that is only for transferring the content to another OCM instance).

OCM Toolkit Overview on transfer-content CMD
💡
Word of warning from experience - if you have a large repository of data and OCM has had an issue with indexing content you may get errors. The only way to fix this is to connect with Oracle Support and for the development team to investigate and fix the indexer issues.

Here is the CMD line I use below - enter the repository name not ID and specify the OCM Server name you defined when you registered your server with the Toolkit using the cec register-server CMD - and if you want define the batch size.

You should now see within your OCM Toolkit folder 2 batch files [RepositoryName]_downloadcontent.bat and _uploadcontent.bat.

If you edit with notepad++ [RepositoryName]_downloadcontent.bat you will see the cmd line and the batched folders that the toolkit creates.
💡
Note - You will need to run through this process for each of your repositories.

3.Backup your Site Content

If you are only interested in backing up your site content you can run a similar script as above - the only difference I usually set the -p flag so that you only download the assets that have been published alongside the site.

If you want you can also use the toolkit to backup your site components, templates, themes - however these may not be as useful if you a migrating to another CMS that doesn't replicate the OCM Sites capabilities such as Fishbowl Solutions CM Box platform and there may be a lot of additional coding refactoring required.

💡
As a quick tip - checkout the 'cec download-folder' CMD line - it has the ability to download all your site files (not content) in one go instead of manually going through step by step process.

4.Backup your documents

Things start to get a little tricky at this point.. As an admin you will not be able to access other users documents -  the easiest approach would be to ask your users to download and install the OCM desktop app and get them to manually backup important files to their local machine.

Alternatively you can take ownership of other user documents - this is the usual process if a user has left your organisation but has forgotten to share critical documents with you via OCM. ie re-enable their account in OCM with a PW you set and access their documents by logging in yourself or alternatively as an admin.

or.. Goto Settings > Users

and then search for the user and select "Transfer Ownership" this will move all the files/folders into your folder location - giving you the ability to back up the files yourself.

Now if you have thousands of users this may not be an option - but you can automate this process and create a script to enable transfer of documents to your Documents folder - creating a new folder ie userID/name and adding all the contents to be backed up so that you can then transfer the documents to a new document platform such as SharePoint if needed and apply the correct security mapping.


Conclusion

The above steps are pretty easy if you have a technical team - if not.. I would recommend to reach out to the Fishbowl Solutions team who have a number of options to evaluate your content and assist migration to WebCenter Content, Sharepoint or another CMS.

Also if you haven't already... Checkout the awesome work the team have been working on with a new OCM Clone - which can be enabled to enhance WebCenter Content.

(O)Content Management Box Architecture Insights
I’ve been pulling together a series of post on the new Content Management Platform CM Box that the Fishbowl Solutions team have been working on to help provide customers with an alternative option to Oracle Content Management - enabling them to continue leveraging the functional features they need w…