Back Up or Migrate ArcESB

Version 21.0.8222


Back Up or Migrate ArcESB


概要

ArcESB interfaces with the local system in two ways:

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

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

Application Directory

Arc stores all profile, certificate, and connector configuration data in files located in the Application Directory.

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

Copy the Application Directory

By default, the Application Directory is located here:

Windows: C:\ProgramData\ArcESB
Java: /opt/arcesb

Note that if Arc was installed ‘on top of’ an existing installation of a previous version of the application version then the application may have re-used the old folder structure.In this case, the Data Directory may instead be located in one of these locations:

Windows (RSSBus Connect): C:\Program Files\RSSBus\RSSBusConnect Windows (ArcESB): C:\Program Files\ArcESB 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 Application Directory at the same respective path on the new server.

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 Application Directory, such as hosting the Application 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 Application Directory that the previous instance did.

To configure the Application 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/webapp/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 variable to the appropriate folder path where the Application 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 PostgreSQL, SQL Server, or MySQL can also be configured as discussed in the Server Administration section.

If Arc is using an external database, 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 arcesb.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 (arcesb.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 within Application Directory with a ‘.lic’ extension. Backing up the license is a simply matter of copying this license file, as explained below.

Backing Up the License

Windows Edition

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

C:\ProgramData\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:

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

Create a copy of this ‘.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):

/opt/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 ‘.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@cdata.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@cdata.com.

Summary

The two technical requirements for backing up Arc are copying the Application 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 Application 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@cdata.com for licensing help and to ensure that we are aware of your appropriate license usage.