Backup procedure

XperiDo server

Last updated : 15-04-2015

 Your documents. Automated.
Master your data flows. Boost your output streams.

Table of contents
Table of contents.............................................................................................................................................................................................. 2

1 Installers & configuration files .......................................................................................................................................................... 4

1.1 Installers........................................................................................................................................................................................... 4

1.2 XBintegrator configuration files ............................................................................................................................................. 4

1.3 Website ............................................................................................................................................................................................ 4

2 Databases .................................................................................................................................................................................................. 5

2.1 Database types ............................................................................................................................................................................. 5

2.2 Setting up the batch file ........................................................................................................................................................... 6

2.2.1 Creating the scripts ................................................................................................................................................................ 6

2.2.2 Creating the batch file .......................................................................................................................................................... 6

Backup procedure XperiDo server 2

 Your documents. Automated.
Master your data flows. Boost your output streams.

This article explains the steps to take when you want to back up the XperiDo installation, configuration and
database on the XperiDo server.

In this article, we use the following terms:

 XBintegrator = an enterprise service bus on which XperiDo is built. The XperiDo server is commonly
referred to as XBintegrator.

 <installdir> = the directory where XBintegrator is currently installed.

 XperiDo website = the XperiDo website in IIS, which is loaded into CRM as an iframe. (applies only to
XperiDo for Microsoft Dynamics CRM)

Backup procedure XperiDo server 3

 Your documents. Automated.
Master your data flows. Boost your output streams.

1 Installers & configuration files

1.1 Installers
Start by backing up the installers that were used for the installation. This will allow you to re-install XBintegrator
and its client programs.

1.2 XBintegrator configuration files

Next, back up the XBintegrator configuration files. There are at least two:

 The main configuration file: <installdir>/conf/xbconfig.xml

 The roles' configuration files (one per role): <installdir>/roles/<rolename>/conf/xbconfig.xml

1.3 Website
If you have XperiDo for Microsoft Dynamics CRM, you'll have an XperiDo website in IIS. It's a good idea to back
up its configuration as well.

You can find this file (web.config) in the website directory. You can find this directory by opening the website in
IIS and clicking Explore.

Backup procedure XperiDo server 4

 Your documents. Automated.
Master your data flows. Boost your output streams.

2 Databases
The most important part of the procedure is backing up the databases. There are multiple databases (depends
on which products you have):

 XBintegrator database

 XperiDo for Microsoft Dynamics CRM database

 XperiDo Nucleus database

2.1 Database types

We always recommend using an H2 type database. This is also the default type that is used during the install.
However, it is possible that you opted to use your own database (such as MSSQL), in which case the backup of
the database cannot be automated with the following steps. In this case, please arrange your own database
backups.

You can find out which type of XBintegrator database you're dealing with, by checking the Custom driver tag in
the Database tag of the <installdir>/conf/xbconfig.xml file.

If it says h2, it's an H2 type.

Here's how to check the other databases:

 XperiDo for Microsoft Dynamics CRM database: in the XBintegrator Administrator Console, go to
<server> > Roles > <role> > Variables > XDCrm. In here, find a URL line:

If the URL line features h2, it's an H2 type.

 XperiDo Nucleus: in the XBintegrator Administrator Console, go to <server> > Roles > <role> >
Variables > XDNucleus > DataBase. In here, find a URL line:

Backup procedure XperiDo server 5

 Your documents. Automated.
Master your data flows. Boost your output streams.

If the URL line features h2, it's an H2 type.

Now you should know which databases (the H2 ones) you can back up with the following steps.

2.2 Setting up the batch file

We'll set up a batch file that you can execute manually or automatically (periodical) which back ups your
databases to zipfiles. There is an SQL instruction we can use for this.

2.2.1 Creating the scripts

We'll create one script for each database. Set up your script like this:

 Filename: doesn't matter really - but we advise to make it logical, such as xbibackup.sql. The extension
should be .sql.

 Content: one line of code: BACKUP TO ‘<filename>.zip’ where you choose a name for the file and type
that instead of <filename>. You must include the path, for instance: BACKUP TO 'D:/Backup/xbi.zip'.

Do this for each database you wish to back up.

2.2.2 Creating the batch file

Next, we'll create the batch file like this:

 Filename: doesn't matter really - but we advise to make it logical, such as runbackup.bat. The extension
should be .bat.

 Content: one line of code per SQL script: java -cp h2-<version>.jar org.h2.tools.RunScript -url
"<dburl>" -script <sqlfile> -user ""

The following tags in the lines of code above should be replaced:

 <version>: the version of the H2 jar file, as found in the lib directory in the installdir. Here's an example:
h2-1.3.166.jar.

Backup procedure XperiDo server 6

 Your documents. Automated.
Master your data flows. Boost your output streams.

 <dburl>: the URL of the database. Finding this for the XperiDo databases is explained above (in
Database types). For the XBi database, you can find this in the url tag in the Database tag of the
<installdir>/conf/xbconfig.xml file.

 <sqlfile>: the SQL file that features the instruction you want to execute. These are the scripts you
created earlier.

For instance: java -cp lib\h2-1.3.166.jar org.h2.tools.RunScript -url "jdbc:h2:C:/Program Files

(x86)/Invenso/XBintegrator/xdnucleus;AUTO_SERVER=true" -script sql/xdnbackup.sql -user ""

Running the batch file will now create backups of your databases. You can schedule the execution of this batch
file with the Task Scheduler.

Backup procedure XperiDo server 7