webstudio backup, restore

Backing up and restoring an Endeca project

The backup process allows you to take a snapshot of your projects including users, rule groups, and permissions data. This process does not include the provisioning information for an application.

For backup purposes, an Endeca project is composed of three pieces:

Instance configuration - the Endeca project files for all the applications managed by the same instance of Web Studio.
Web Studio store - a directory that contains a database of users, rule groups, and associated permission information.

Together, the instance configuration and the Web Studio store are the backup. The two are a snapshot of your projects and all their associated user and permission information.

To back up a project:

Stop the Endeca HTTP service.
Copy the webstudiostore directory, including all its subdirectories, from the %ENDECA_CONF%\state\ directory (on Windows) or $ENDECA_CONF/state/ (on UNIX) to another location.

Note: Recall that the default location of %ENDECA_CONF% on Windows is C:\Endeca\MDEXEngine\workspace.

Copy the emanager directory, including all its subdirectories, from the %ENDECA_CONF%\state\ directory (on Windows) or $ENDECA_CONF/state/ (on UNIX) to another location.
In 5.1.3 or later, back up your Web Studio customization files:
Navigate to %ENDECA_CONF%\conf directory (on Windows) or $ENDECA_CONF/conf (on UNIX).
Copy ws-extensions.xml, ws-mainMenu.xml, and ws-roles.xml to another location.

To restore a backup:

Note: You can only restore a back up to an Endeca installation that is exactly the same version as the one on which you made the backup (for example, from 5.1.3 to 5.1.3, but not from a different 5.1.x version to 5.1.3). For information about transferring project and user information when upgrading Endeca, see the Endeca Migration Guide.

Stop the Endeca HTTP service.
Delete the webstudiostore and emanager directories from %ENDECA_CONF%\state\ (on Windows) or $ENDECA_CONF/state/ (on UNIX).
Copy the webstudiostore directory that you backed up earlier to %ENDECA_CONF%\state\ (on Windows) or $ENDECA_CONF/state/ (on UNIX).
Copy the emanager directory that you backed up earlier to %ENDECA_CONF%\state\ (on Windows) or $ENDECA_CONF/state/ (on UNIX).
In 5.1.3 or later, copy the ws-extensions.xml, ws-mainMenu.xml, and ws-roles.xml files that you backed up earlier to %ENDECA_CONF%\conf (on Windows) or $ENDECA_CONF/conf (on UNIX).
Start the Endeca HTTP service.

If you are restoring the backup to a new Endeca installation, users will be unable to log in to Web Studio until the corresponding applications have been provisioned in the EAC.