Installing and Updating Data Sync

To install Data Sync, you must meet the requirements and prerequisites, then unzip and run the application. Once installed, Data Sync notifies you of any available updates.

About Required User Accounts and Security Guidelines

To load data using Data Sync, you need user accounts with appropriate privileges.

What User Accounts Are Required?

For each Data Sync user, provision a user account that has the following:

Use these Data Sync user accounts in your Data Sync connections.

About Sensitive Information Stored By Data Sync

Data Sync stores sensitive information, including connection information for your data sources. We recommend that you run Data Sync in a controlled environment where the operating system and file system privileges are tightly controlled.

About Prerequisites, Supported Databases, and JDBC Requirements

Before installing Data Sync, you must have Java 1.7 or later Java Development Kit (JDK). On an on-going basis, apply any critical Java updates.

Note:

Data Sync doesn't work with Java Runtime Environment (JRE); you must have JDK.

Database Support

Data Sync supports the following databases:

  • Oracle

  • Microsoft SQL Server

  • DB2

  • Teradata

  • MySQL

  • Oracle TimesTen

  • Generic JDBC with prepackaged drivers for MongoDB, Salesforce, Redshift, Hive and PostgreSQL

  • Other sources that support JDBC

  • Oracle Transactional Business Intelligence:

    • Oracle Financials Cloud

    • Oracle HCM Cloud

    • Oracle Procurement Cloud

    • Oracle Project Management Cloud

    • Oracle Sales Cloud

    • Oracle Supply Chain Management Cloud

  • Oracle Service Cloud (RightNow)

JDBC Drivers

Data Sync is a Java application and uses JDBC to extract data from databases. Data Sync is installed with Oracle JDBC Version 12.1.0.2.0. If you’re using a different database or version, then you must replace the installed Oracle JDBC Version with the JDBC version specific to your database. To replace the installed JDBC, you copy the JDBC drivers to the \lib directory after you install Data Sync. For example, if your Oracle version is different, then copy the JDBC driver from your local Oracle installation.

Vendor JDBC Driver Name

Oracle

ojdbc7.jar

MySQL

Mysql-connector-java*.jar

Microsoft SQL Server

sqljdbc.jar

DB2

db2java.zip

TimesTen

ttjdbc6.jar, orai18n.jar, timestenjmsxla.jar, jms.jar, javax.jms.jar

Teradata

terajdbc4.jar, log4j.jar, teradata.jar, tdgssjava.jar, tdgssconfig.jar

Installing Data Sync

Download and install Data Sync in a few simple steps.

Note:

Data Sync stores sensitive information, including connection information to your on-premises databases. We recommend that you only install Data Sync in protected environments where the operating system and file system privileges are tightly controlled.
Before you install Data Sync, do this:
  • Install Java Development Kit (JDK) 1.7 or later and apply any critical Java updates on an on-going basis.

    Data Sync doesn’t work with Java Runtime Environment (JRE). You must install JDK.

  • Request permission to upload data. See Giving Users Permissions to Upload Data with Data Sync.

Install Data Sync in your environment.
  1. Download Data Sync from Oracle Technology Network:
  2. Unzip BICSDataSync_Vx_x.Zip to a directory with no spaces in its name.
  3. Set your JAVA_HOME:
    1. Open config.bat (Windows) or config.sh (Linux or Unix).
    2. Replace @JAVA_HOME with the directory where JDK is installed.

    For example:

    set JAVA_HOME=D:\Java (on Windows)

    set JAVA_HOME=usr/java (on Linux or UNIX)

    If your directory name contains spaces you’ll need to add double quotes around it.

  4. Copy any database-specific JDBC drivers that you need to Data Sync’s \lib directory.
    Data Sync installs Oracle JDBC driver 11.2.x. If you want to connect to a different database (for example, Microsoft SQL Server or DB2) or if you want to use a different Oracle driver from the default version, obtain and manually copy the required files to the \lib directory. See also JDBC Drivers.
Now you’re ready to start Data Sync. See Starting Data Sync the First Time.

Starting Data Sync for the First Time

The first time you start Data Sync, you’ll be asked to give your Data Sync repository a name and provide a password.

  1. Start up Data Sync. Run datasync.bat (on Windows) or datasync.sh (on Linux/UNIX) from the directory where you installed Data Sync.
    The Data Sync icon displays in your system icon tray to show that the server is up and running.
  2. Right-click the Data Sync icon and select Start UI.
  3. Enter a Logical Name for the repository.
    This name is used to distinguish the repository in multi-repository environments. For example, you could name your repository Development Environment or Production Environment. You’ll see this name displayed as a tooltip on the system tray Data Sync icon and on the title bar in Data Sync.
  4. Enter a password.
    Provide a password to access the client and select whether you want Data Sync to remember the password.

    Note:

    We recommend that you only install Data Sync in protected environments because Data Sync stores transactional system passwords.
  5. Enter a name that describes your first project.
    Data Sync opens.
  6. Set some basic system properties. See Setting Default Options for Data Sync.
    If your organization uses a proxy server to route calls to external websites, configure Proxy Host and Proxy Port.
  7. Connect Data Sync to your data target. See Specifying Connection Details for Your Cloud Service.
  8. Connect Data Sync to your data source. See Specifying Connection Details for a Data Source.
  9. Optional. Set up email. See Setting Up Email Notifications.

Starting and Stopping Data Sync

To start Data Sync and its server, run datasync.bat (Windows) or datasync.sh (Linux/UNIX) from the directory where you installed Data Sync. The Data Sync icon displays in your system icon tray to show that the server is up and running.

  • Select Start UI to open the Data Sync client.

  • Select Exit to stop the Data Sync server.

Alternatively, run these files:
  • datasyncClient.bat.sh opens the Data Sync tool (when server is running).

  • stopserver.bat/sh stops the Data Sync server.

Reconfiguring Data Sync from the Beginning

To reset Data Sync to its default state and redo the setup process, run datasync.bat (Windows) or datasync.sh (Linux/UNIX) in a command window with the -clean option.

Uninstalling Data Sync

To uninstall Data Sync, delete the install directory.

Understanding Software Alerts in Data Sync

Data Sync notifies you if there is a new patch or software package.

If there is a new patch available or a new software package with additional functionality, Data Sync notifies you using the New Patch Alerts icon next to the Server Monitor icon. Prior to each load, Data Sync performs a version check, sending its current version to be checked against the one on the cloud. Depending on whether the versions match, the following actions occur:

  • If the versions match, the data load continues.

  • If the minor version is changed on the cloud, indicating an available patch, an optional alert is created and an email sent prior to continuing with the load. The alert is sent only once.

  • When the major version is changed, indicating a new software package, an alert is created and an email sent. The data load halts, while informing you that a new version of the patch is required prior to doing any further data loads.

The number of unread alerts is indicated on the Alerts icon. Click the icon to view a list of alerts. If the icon is black there are no alerts, and it turns green when there are unread optional alerts, and red when there are unread mandatory alerts.

Updating Data Sync

You update Data Sync by performing a full installation and then migrating your environment.

New software updates are downloadable as compressed files that contain all content for a new installation of the software. To update the software, perform a full installation of the software as a new environment in a separate home directory, then migrate the environment from your existing installation.

Setting Up a New Environment with an Existing Environment Configuration

When you start the new environment after installing a patch or new version, you’re prompted for environment configuration. Select Copy existing environment configuration and then specify the existing Data Sync environment's home directory. Data Sync repository and configuration files are copied to the new environment. If the new installation requires metadata upgrade, perform any upgrade after the files are copied.