Back Up or Migrate ArcESB

Version 20.0.7488


Back Up or Migrate ArcESB



Overview

ArcESB interfaces with the local system in two ways:

  • Data Directory (a folder on disk holding configuration data)
  • Application Database (a database storing metadata for transactions processed by the application)

If Workspaces other than the default Workspace are configured, an additional interface is applicable:

  • Workspaces Directory (a folder holding configuration data for additional Workspaces)

Backing up Arc is a simple process of copying the Data Directory, Application Database, and potentially Workspaces Directory. Migrating Arc to a new server is accomplished by placing a copy of these resources in the appropriate place on the new machine.

Data Directory and Workspaces Directory

Arc stores all profile, certificate, and connector configuration data (for the default Workspace) in files located in the Data Directory. Connector configuration data for non-default Workspaces are held in the Workspaces Directory.

Backing up or recreating an Arc configuration, therefore, is simply a matter of copying the Data Directory (and potentially the Workspaces Directory). This copy can be placed on a new server to recreate an Arc configuration in a new instance.

The Export Workspace approach described below is the simplest approach to copying an Arc configuration; however, it is important to note that this method does not also copy over archived logfiles and data files processed by the application. In order to copy all application data, the relevant folders must be copied directly on disk as described in the Copy the Data Directory and Copy the Workspaces Directory sections.

Export Workspace

Arc supports exporting and importing configuration data through the application interface. In the top-right corner of the Flows page, click the cogwheel to see the ‘Export Workspace’ feature. When migrating data to a new server, ensure that ‘Include profile settings’, ‘Export all workspaces’, and ‘Export private info’ are all checked.

This export tool will generate a ‘.arcflow’ file containing the application configuration. If Arc is launched on a new server, the same cogwheel can be used to ‘Import Workspace’ and import the same ‘.arcflow’ file from before.

Copy the Data Directory

As an alternative to Export Workspace approach in the previous section, the Data Directory can simply be copied on disk. By default, the Data Directory is located here:

Windows: C:\Program Files\ArcESB\data
Java: ~/arcesb/data (where ~ resolves to the home directory for the user running the server hosting Arc)

Note that if Arc was installed ‘on top of’ an existing installation of the previous application version, RSSBus Connect, then the application may have re-used the old folder structure. In this case, the Data Directory is instead located here:

Windows: C:\Program Files\RSSBus\RSSBusConnect\data
Java: ~/arcesb/data (where ~ resolves to the home directory for the user running the server hosting Arc)

To back up the application, maintain a copy of this Data Directory somewhere convenient. To migrate Arc to a new server, place a copy of this Data Directory at the same respective path on the new server.

Copy the Workspaces Directory

Some Arc configurations will not have a Workspaces Directory, since this folder is only created if non-default Workspaces are configured in the application.

The Workspaces Directory is a sibling of the Data Directory, meaning both folders can be found in the same parent directory. If you do not see a ‘workspaces’ folder next to the ‘data’ folder, then copying the Workspaces Directory is not relevant for your configuration. Otherwise, use the same process from the previous section to copy the ‘workspaces’ folder.

Configure the Data/Workspaces Directory

This section is only relevant when migrating Arc to a new server, and when the default location for the Data Directory has been overridden with a custom path.

Some Arc setups may use a non-default location for the Data Directory, such as hosting the Data Directory on a shared network file system. In this case, the new instance of Arc can simply be configured to use the same network folder for the Data Directory that the previous instance did. The Workspaces Directory is always considered a sibling of the Data Directory, so it does not need to be configured separately.

To configure the Data Directory, first find the server configuration file for the web server hosting the application. When using the embedded web server included with the application, this file can be found here:

Windows: C:\Program Files\ArcESB\www\Web.Config
Java: /opt/arcesb/arcesb.xml

In the Windows edition (Web.Config), find the commented-out section for AppDirectory, where the appSettings element can be used to set a folder path to the folder where the Data Directory should be held.

In the Java edition (arcesb.xml), find the Call element where the APP_DIRECTORY variable is set, and specify a folder path in place of “arcesb.home”.

When hosting the application in an external server, modify the server configuration file for that server to set the AppDirectory (Windows) or APP_DIRECTORY (Java) variable to the appropriate folder path where the Data Directory should reside.

Application Database

By default, Arc uses a SQLite (Windows) or Derby (Java) database to store data about the transactions processed by the application. An external database like MySQL or SQL Server can also be configured as discussed in the Server Administration section.

Default Database

If Arc was configured to use an external database, please skip to the next section. If Arc is using the default (SQLite or Derby) database, follow the steps below to copy the appropriate data.

Windows

First, find the database files on disk. In the Windows edition, the data is held in two SQLite database files, app_logs.db and app_transactions.db. By default these files are located here:

C:\Program Files\ArcESB\www\app_data

Note that if Arc was installed ‘on top of’ an existing installation of the previous application version, RSSBus Connect, then the application may have re-used the old folder structure. In this case, the database files are located here:

C:\Program Files\RSSBus\RSSBus Connect\www\app_data

Simply copy these database files and, if migrating, move them to the same respective path on the new server.

Java

In the Java edition, all of the Derby database files are held in a db directory at the following location:

~/arcesb/db (where ~ resolves to the home directory for the user running the server hosting Arc)

Note that if Arc was installed ‘on top of’ an existing installation of the previous application version, RSSBus Connect, then the application may have re-used the old folder structure. In this case, the database files are located here:

~/rssbus/connect/db

Simply copy this database folder and, if migrating, move it to the same respective path on the new server.

External Database

If Arc is using an external database like MySQL or SQL Server, the connection string for this database must be configured in the configuration file for the server hosting the application (e.g. Web.Config in Windows and server.xml in Java). Backing up an external database is outside of the scope of Arc, and should be accomplished directly through the database. Migrating Arc to a new machine simply requires configuring the new instance to read from and write to the same external database.

To configure the Application Database, install Arc on the new machine and then find the server configuration file for the web server hosting the application.

In the Windows edition (Web.Config), find the commented-out section for AppDb, where the connectionStrings element can be used to set a connection string for the target database.

In the Java edition (server.xml), the details depend on the specific server used to host the application. In general, a configuration variable called APP_DB must be set to the connection string for the target database, using whatever syntax is appropriate for the specific web server used.

Licensing

Arc licenses are tied to a specific machine name (with the exception of the ‘Cloud License’ special license tier). The license is held is a license file called ‘ArcESB.lic’. Backing up the license is a simply matter of copying this license file, as explained below.

Migrating the license file to a new machine without updating the license for that new machine will result in license errors. However, a license can be re-applied on a new server through the application interface as long as the license transfer form has been used to alert our licensing team to the move, as explained below.

Backing Up the License

Windows Edition

In the Windows edition of Arc, the license file is located here (by default):

C:\Program Files\ArcESB\www\app_data

If Arc was installed over top of an RSSBus Connect installation and the RSSBus folder paths were re-used, then the corresponding location is the following:

C:\Program Files\RSSBus\RSSBus Connect\www\app_data

Create a copy of the ‘arcesb.lic’ file at this location to back up the license.

Java Edition

In the Java edition of Arc, the license file is located here (by default):

~/arcesb

If Arc was installed over top of an RSSBus Connect installation and the RSSBus folder paths were re-used, then the corresponding location is the following:

~/rssbus/connect

Create a copy of the ‘arcesb.lic’ file at this location to back up the license.

Migrating the License

The license transfer form can be used to alert our licensing system that a license is moving from one machine to another. This prevents the license from being marked for over-use (installing the same license on multiple machines). Once the form has been filled out, the same product-key can be re-used on the new machine without waiting for confirmation from our licensing team. In the case of any blocks or restrictions on the license, please reach out to our licensing team at sales@arcesb.com.

Server migration can be a time-intensive process, so we allow for a 30-day overlap period where the license is active on two machines. Within these 30 days, the application must be removed from the old machine; if this is not enough time, a more specific timeline can be communicated with our licensing team at sales@arcesb.com.

Summary

The two technical requirements for backing up Arc are copying the Data (and potentially Workspaces) Directory and Application Database. Migrating Arc to a new server requires placing a copy of this data at the respective paths on the new server, or ensuring that the new server is configured to use the same folders/database as the old instance. If the Data/Workspaces Directory and Application Database mirrors the settings from the previous instance, Arc will continue processing the same data with the same configuration on the new machine.

Migrating servers also requires updating the license for the new machine. The license transfer form allows for moving licenses without needing a new product key. Alternatively you can always reach out to sales@arcesb.com for licensing help and to ensure that we are aware of your appropriate license usage.