HDPREADME.TXT
     Progress(R) DataDirect(R) Hybrid Data Pipeline
     Hybrid Data Pipeline Server
     Release 4.1
     April 2017

***********************************************************************
Copyright (c) 1990-2017 Progress Software Corporation and/or its 
subsidiaries or affiliates. All Rights Reserved.

***********************************************************************

CONTENTS

Changes for Release 4.1
Product Features
Product Components
Server Requirements
Installation Directory
Notes, Known Problems, and Restrictions
Documentation
Installed Files
Third-Party Acknowledgments


     Changes for Release 4.1

MySQL CE
--------
Support for MySQL Community Edition has been added to Hybrid Data Pipeline.
During installation of the Hybrid Data Pipeline server and the On-Premises
Connector, you provide the location of the MySQL Connector/J driver. After
installation, you may then configure data sources that connect to a MySQL CE
data store and execute queries with ODBC, JDBC, and OData applications.

OpenSSL
-------
The default OpenSSL library has been updated to 1.0.2k, which fixes the
following security vulnerabilities.

* Truncated packet could crash via OOB read (CVE-2017-3731)

* BN_mod_exp may produce incorrect results on x86_64 (CVE-2017-3732)

* Montgomery multiplication may produce incorrect results (CVE-2016-7055)

OpenSSL 1.0.2k addresses vulnerabilities resolved by earlier versions of the
library. For more information on OpenSSL vulnerabilities resolved by this
upgrade, refer to OpenSSL announcements:
https://www.openssl.org/news/openssl-1.0.2-notes.html

SSL Enabled Data Stores
-----------------------
The default value for Crypto Protocol Version has been updated to
"TLSv1, TLSv1.1, TLSv1.2" for data stores that support the parameter. This
change improves the security of the connectivity service by employing only the
most secure cryptographic protocols as the default behavior. At connection, the
connectivity service will attempt to use the most secure protocol first,
TLS 1.2, then fall back to use 1.1 and then 1.0.

Load Balancing
--------------
Support for load balancing has been added to Hybrid Data Pipeline. To enable
multitenancy and scalability, load balancers can be used in the Hybrid Data
Pipeline environment. With load balancing, incoming requests can be evenly
distributed across Hybrid Data Pipeline instances. Hybrid Data Pipeline further
supports load balancing by maintaining session affinity for application queries
and by responding to load balancer health checks.

Throttling (Limits API)
-----------------------
Support for throttling to prevent a single user from adversely impacting the
performance of the connectivity service has been added. The Limits API allows
administrators to set limits on how many rows can be returned for ODBC, JDBC,
and OData requests. An error is returned if an application fetches rows beyond
the specified limit.

Refresh Map Enhancement
-----------------------
The new refresh map button has been added to the Mapping tab. This button allows
you to refresh the map without connecting to the data store. This feature is
useful when you are in the process of developing your application and you have
made changes to the objects in your backend data store. Pressing this button
forces the data store to rebuild the map allowing the new objects to show up in
the relational map the next time your application connects to the data source.
(The map can also be refreshed with a Management API call or when establishing a
connection.)

MySQL CE System Database
------------------------
Support for MySQL Community Edition as an external system database has been
added. During the installation process, you are prompted to select either an
internal database or an external database to store system information necessary
for the operation of Hybrid Data Pipeline. With this enhancement, you can choose
either Oracle or MySQL CE as an external database.

SQL Editor
----------
The SQL editor in the "SQL Testing" view has been upgraded. The functionality of
the new editor is similar to that of the previous editor. However, the history
panel is not currently supported with the new editor.

OpenAccess Server Component
---------------------------
The OpenAccess server component of Hybrid Data Pipeline has been deprecated. The
OpenAccess server is no longer required to connect with Oralce Eloqua.

Apache Hive Data Store
----------------------
* Added SSL support for Apache Hive 0.13.0 and higher

* Certified with Apache Hive 0.13, 0.14, 1.0, 1.1, 1.2

* Certified with Amazon (AMI) 3.2-3.3.1, 3.7

* Certified with Cloudera (CDH) 5.0, 5.1, 5.2, 5.3, 5.4, 5.4, 5.6, 5.7

* Certified with Hortonworks (HDP) 2.1, 2.2

* Certified with IBM BigInsights 4.1

* Certified with Pivotal HD (PHD) 2.1

Greenplum Data Store
--------------------
* Made generally available

* Certified with Greenplum 4.3

* Certified with Pivotal HAWQ 1.2, 2.0

IBM DB2
-------
* Certified with IBM DB2 V11.1 for LUW

* Certified with DB2 for i 7.2

Informix
--------
* Made generally available

* Certified with Informix 12.10

* Certified with Informix 11.7, 11.5, 11.0

* Certified with Informix 10.0

* Certified with Informix 9.4, 9.3, 9.2

Oracle Marketing Cloud (Oracle Eloqua)
--------------------------------------
The Oracle Marketing Cloud data store provides access to Oracle Eloqua. Improved
features and functionality for this data store are available with this Hybrid
Data Pipeline release.

* Write Access
  - Support for INSERT/UPDATE/DELETE operations on CONTACT, ACCOUNT and
    CustomObjects_XXX

* Bulk Calls 
  - Performance improvement for bulk calls
  - Supports fetching more than 5 million
    records
  - Supports fetching up to 250 columns for bulk calls
  - Supports pushing OR operators for bulk calls (This does not apply to
    Activities)

* REST Calls 
  - Some queries with OR and AND operators have been optimized.
 
* Metadata
  - The data store now uses null as the catalog name. Previously, ECATALOG was
    used as the catalog name.
  - The current version of the data store maps columns with integer data to type
    INTEGER. The previous version mapped the integer type to string.

* In contrast to the previous version, the current version of the data store
  cannot split OR queries and push them separately to Oracle Eloqua APIs.
  Therefore, compared to the previous version, the current version may take
  longer to return results involving OR queries.

* The previous version of the data store used the ActivityID field as the
  primary key for Activity_EmailXXX objects, such as Activity_EmailOpen,
  Activity_EmailClickthrough, and Activity_EmailSend. In contrast, the current
  version of the data store uses the ExternalID field as the primary key instead
  of ActivityID.

PostgreSQL
----------
* Certified with PostgreSQL 9.3, 9.4, 9.5, 9.6

Progress OpenEdge
-----------------
* Certified with Progress OpenEdge 11.4, 11.5, 11.6

Salesforce
----------
* Certified with Salesforce API 38

SAP Sybase
----------
* Made generally available

* Certified with SAP Adaptive Server Enterprise 16.0

SQL Server
----------
* Added support for NTLMv2 authentication. NTLMv2 authentication can be
  specified in the Authentication Method field under the Security tab.

* Certified with Microsoft SQL Server 2016


     Product Features

Progress DataDirect Hybrid Data Pipeline is a data access platform that provides
simple, secure access to cloud and on-premises data sources, such as RDBMS, Big
Data, and NoSQL. Hybrid Data Pipeline allows business intelligence tools and
applications to use ODBC, JDBC, or OData to access data from supported
datasources. Hybrid Data Pipeline can be installed in the cloud or behind a
firewall. Hybrid Data Pipeline can then be configured to work with applications
and data sources in nearly any business environment.

* Supports access to over 20 data sources through a single, unified interface.

* Supports secure access to data on-premises or in the cloud.

* Can be hosted in the cloud or on premises.

* Supports SaaS, SQL, NoSQL, and Big Data data sources.

* Supports ODBC, JDBC, and OData APIs.


     Product Components

Progress DataDirect Hybrid Data Pipeline consists of four primary, separately
installed components.

* The Hybrid Data Pipeline server provides access to multiple data sources
  through a single, unified interface. The server can be hosted on premises or
  in the cloud.

* The On-Premises Connector enables the Hybrid Data Pipeline to establish a
  secure connection from the cloud to an on-premises data source.

* The ODBC driver enables ODBC applications to communicate to a data source
  through the Hybrid Data Pipeline server.

* The JDBC driver enables JDBC applications to communicate to a data source
  through the Hybrid Data Pipeline server.


     Server Requirements

Hybrid Data Pipeline must be installed on a 64-bit Linux machine (2 core, 8 GB
RAM minimum) running one of the following operating systems:

* CentOS Linux x64, version 4.0 and higher

* Oracle Linux x64, version 4.0 and higher

* Red Hat Enterprise Linux x64, version 4.0 and higher

* SUSE Linux Enterprise Server, Linux x64, version 10.x, 11, 12, and 13


     Installation Directory

The default installation directory for the Hybrid Data Pipeline server is:

  /opt/Progress/DataDirect/Hybrid_Data_Pipeline/Hybrid_Server

  Note: If you do not have access to "/opt", your user's home directory will
  take the place of this directory.


     Notes, Known Problems, and Restrictions

Web UI
------
* If an administrator creates a user with a password that contains a 
  percentage mark (%), the new user may face issues while trying to login. 
  In addition, Hybrid Data Pipeline functionality may not work as expected.

* When an administrator tries to add new users using the Add Users window, the
  the Password and Confirm Password fields occasionally do not appear properly
  in the popup window.

* 'COPY DETAILS' functionality is not currently working in Internet Explorer 11
  due to a limitation with the third party plugin Clipboard.js on bootstrap
  modals. More details on this can be found at
  https://github.com/zenorocha/clipboard.js/wiki/Known-Issues.

Management API
--------------
* When the Limits API (throttling) is used to set a row limit and
  createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE) is being used, a
  row-limit-exceeded error is returned at the row limit instead of one row
  beyond the limit. For example, if a row limit is set at 45 rows when returning
  a scrollable, insensitive result set beyond the specified limit, the
  connectivity service returns the following error on the 45th row as opposed to
  the expected 46th row: "The limit on the number of rows that can be returned
  from a query -- 45 -- has been exceeded."

* If an administrator creates a user with a password that contains a 
  percentage mark (%), the new user may face issues while trying to login. 
  In addition, Hybrid Data Pipeline functionality may not work as expected.

OData
-----
* $expand only supports one level deep.
  For example, with the entity hierarchy:
  Customers
  |-- Orders
  | |-- OrderItems
  |-- Contacts

  The following queries are supported:
  Customers?$expand=Orders
  Customers?$expand=Contacts
  Customers?$expand=Orders,Contacts

  However, this query is not supported:
  Customers?$expand=Orders,OrderItems

  OrderItems is a second level entity with respect to Customers. To query Orders
  and OrderItems, the query must be rooted at Orders. For example:
  Orders?$expand=OrderItems
  Orders(id)?$expand=OrderItems

* When manually editing the ODataSchemaMap value, the table names and column
  names specified in the value are case-sensitive. The case of the table and
  column names must match the case of the tables and column names reported by
  the data source.
  Note: It is highly recommended that you use the OData Schema Editor to
  generate the value for the ODataSchemaMap data source option. The Schema
  Editor takes care of table and column name casing and other syntactic details.

* When using the substring function on properties that map to a CHAR column in
  the data source, it is data source dependent as to whether the substring
  function treats the trailing spaces as significant. When going against Oracle,
  the trailing spaces are preserved. When going against other data sources, the
  trailing spaces are discarded.

* The $expand clause is not supported with OpenEdge data sources.

* The day scalar function is not working when specified in a $filter clause when
  querying a DB2 data source.

All data stores
---------------
* It is recommended that Login Timeout not be disabled (set to 0) for a Data
  Source.

* Using setByte to set parameter values with the Hybrid Data Pipeline JDBC
  driver fails when the data store does not support the TINYINT SQL type. Use
  setShort or setInt to set the parameter value instead of setByte.

Google Analytics
----------------
* Validation message is not showing when a user enters a Start Date value less
  than the End Date value in Create/Update Google Analytics page.

* Once a Google Analytics OAuth profile is created for a specific Google
  account, changing the Google Account associated with the profile results in
  "the configuration options used to open the database do not match the options
  used to create the database" error being returned for any existing data
  sources.

Microsoft Dynamics CRM
----------------------
* Testing has shown the following two errors from Microsoft Dynamics CRM Online
  when executing queries against the ImportData and TeamTemplate tables:
  - Attribute errortype on Entity ImportData is of type picklist but has Child
    Attributes Count 0
  - Attribute issystem on Entity TeamTemplate is of type bit but has Child
    Attributes Count 0
  Note: We have filed a case with Microsoft and are waiting to hear back about
  the cause of the issue.

* The initial on-premise connection when the relational map is created can take
  some time. It is even possible to receive an error "504: Gateway Timeout".
  When this happens, Hybrid Data Pipeline continues to build the map in the
  background such that subsequent connection attempts are successful and have
  full access to the relational map.

* Executing certain queries against MS Dynamics CRM with the JDBC driver may
  result in a "Communication failure. Protocol error."

OpenEdge 10.2b
--------------
* Setting the MaxPooledStatements data source option in an OpenEdge data store
  to a value other than zero can cause statement not prepared errors to be
  returned in some situations.

Oracle Database
---------------
* Executing queries against column of type xmltype results in the following
  error: "This column type is not currently supported by this driver."

Oracle Marketing Cloud (Oracle Eloqua)
--------------------------------------
* Data store issues
  - There are known issues with Batch Operations
  - The Update/Delete implementation can update only one record at a time.
    Because of this, the number of APIs executed depends on the number of
    records that get updated or deleted by the query plus the number of API
    calls required to fetch the IDs for those records.
  - Lengths of certain text fields are reported as higher than the actual
    lengths supported in Oracle Eloqua.

* Oracle Eloqua REST API issues. We are currently working with Oracle to resolve
  the following issues.
  - AND operators that involve different columns are optimized. In other cases,
    the queries are only partially optimized.
  - OR operators on the same column are optimized. In other cases, the queries
    are completely post-processed.
  - The data store is not able to insert or update the NULL value to any field
    explicitly.
  - The data store is unable to update few fields. They are always reported as
    NULL after update.
  - Oracle Eloqua uses a double colon (::) as an internal delimiter for
    multivalued Select fields. Hence when a value with the semi-colon character
    (;) is inserted or updated into a multivalued Select field, the semicolon
    character gets converted into the double colon character.
  - Query SELECT count (*) from template returns incorrect results.
  - Oracle Eloqua APIs do not populate the correct values in CreatedBy and
    UpdatedBy fields. Instead of user names, they contain a Timestamp value.
  - Only equality filters on id fields are optimized. All other filter
    conditions are not working correctly with Oracle Eloqua APIs and the data
    store is doing post-processing for such filters.
  - Filters on Non-ID Integer fields and Boolean fields are not working
    correctly. Hence the driver needs to post-process all these queries.
  - The data store does not distinguish between NULL and empty string.
    Therefore, null fields are often reported back as empty strings.
  - Values with special characters such as curly braces ({,}), back slash (\),
    colon (:), slash star (/*) and star slash (*/) are not supported in where
    clause filter value.

Oracle Sales Cloud
------------------
* Currently, passing filter conditions to Oracle Sales Cloud works only for
  simple, single column conditions. If there are multiple filters with 'AND'
  and 'OR', only partial or no filters are passed to Oracle Sales Cloud.

* Oracle Sales Cloud reports the data type of String and Date fields as String.
  Therefore, when such fields are filtered or ordered in Hybrid Data Pipeline,
  they are treated as String values. However, when filter conditions are passed
  to Oracle Sales Cloud, Oracle Sales Cloud can distinguish between the actual
  data types and apply Date specific comparisons to Date fields. Therefore,
  query results can differ depending on whether filters have been passed down to
  Oracle Sales Cloud or processed by Hybrid Data Pipeline.

* There appears to be a limitation with the Oracle Sales Cloud REST API
  concerning the >=, <=, and != comparison operators when querying String
  fields. Therefore, Hybrid Data Pipeline has not been optimized to pass these
  comparison operators to Oracle Sales Cloud. We are working with Oracle on this
  issue.

* There appears to be a limitation with the Oracle Sales Cloud REST API
  concerning queries with filter operations on Boolean fields. Therefore, Hybrid
  Data Pipeline has not been optimized to pass filter operations on Boolean
  fields to Oracle Sales Cloud. We are working with Oracle on this issue.

* The drivers currently report ATTACHMENT type fields in the metadata but do not
  support retrieving data for these fields. These fields are set to NULL.

* Join queries between parent and child tables are not supported.

* Queries on child tables whose parent has a composite primary key are not
  supported. For example, the children of ACTIVITIES_ACTIVITYCONTACT and
  LEADS_PRODUCTS are not accessible.

* Queries on the children of relationship objects are not supported. For
  example, the children of ACCOUNTS_RELATIONSHIP, CONTACTS_RELATIONSHIP, and
  HOUSEHOLDS_RELATIONSHIP are not accessible.

* Queries on grandchildren with multiple sets of Parent IDs and Grand Parent IDs
  used in an OR clause are not supported. For example, the following query is
  not supported.
     select * from ACCOUNTS_ADDRESS_ADDRESSPURPOSE
        where (ACCOUNTS_PARTYNUMBER = 'OSC_12343' AND
               ACCOUNTS_ADDRESS_ADDRESSNUMBER = 'AUNA-2XZKGH')
           or (ACCOUNTS_PARTYNUMBER = 'OSC_12344' AND
               ACCOUNTS_ADDRESS_ADDRESSNUMBER = 'AUNA-2YZKGH')

* When querying documented objects like "CATALOGPRODUCTITEMS" and
  "CATEGORYPRODUCTITEMS", no more than 500 records are returned, even when
  more records may be present. This behavior is also seen with some custom
  objects. We are currently working with Oracle support to resolve this issue.

* A query on OPPORTUNITIES_CHILDREVENUE_PRODUCTS or LEADS_PRODUCTGROUPS with
  a filter on the primary key column returns 0 records even when more records
  are present. We are currently working with Oracle support to resolve this
  issue.

* Queries that contain subqueries returning more than 100 records are not
  supported. For example, the following query is not supported.
     select * from ACCOUNTS_ADDRESS
     where ACCOUNTS_PARTYNUMBER
     in (select top 101 PARTYNUMBER from ACCOUNTS)

* When you create custom objects, your Oracle Sales Cloud administrator must
  enable these objects for REST API access through Application Composer.
  Otherwise, you will not be able to query against these custom objects.

Oracle Service Cloud
--------------------
* When you create a custom object, your Oracle Service Cloud administrator must
  enable all four columns of the Object Fields tab of the Object Designer, or
  you cannot query against the custom objects.

* The initial connection when the relational map is created can take some time.
  It is even possible to receive an error "504: Gateway Timeout". When this
  happens, Hybrid Data Pipeline  continues to build the map in the background
  such that subsequent connection attempts are successful and have full access
  to the relational map.

SugarCRM
--------
* Data sources that are using the deprecated enableExportMode option will still
  see a problem until they are migrated to the new data source configuration.

* Data source connections by default now use Export Mode to communicate with the
  Sugar CRM server, providing increased performance when querying large sets of
  data. Bulk export mode causes NULL values for currency columns to be returned
  as the value 0. Because of this, there is no way to differentiate between a
  NULL value and 0, when operating in export mode. This can be a problem when
  using currency columns in the SQL statements, because Hybrid Data Pipeline
  must satisfy some filter conditions on queries, such as with operations like
  =, <>, >, >=, <, <=, IS NULL and IS NOT NULL. For example, suppose a currency
  column in a table in SugarCRM has 3 null values and 5 values that are 0. When
  a query is executed to return all NULL values (SELECT * FROM <table> WHERE
  <>currency column> IS NULL), then 3 rows are returned. However, if a query is
  executed to return all rows where the column performs an arithmetic operation
  (SELECT * FROM <table> WHERE <currency column> + 1 = 1), then all 8 records
  are returned because the 3 NULL values are seen as 0.

On-Premises Connector
---------------------
* See the hdpopcreadme.txt file for the latest notes when using the On-Premises
  Connector. This file is located in the installation directory for the
  On-Premises Connector.

JDBC Driver
-----------
* See the hdpjdbcreadme.txt file for the latest notes when accessing Hybrid Data
  Pipeline through the JDBC driver. This file is located in the installation
  directory for the JDBC driver.

ODBC Driver
-----------
* See the hdpodbcreadme.txt file for the latest notes when accessing Hybrid Data
  Pipeline through the ODBC driver. This file is located in the installation
  directory for the ODBC driver.


     Documentation

Hybrid Data Pipeline documentation consists of the following guides and readmes.

* PROGRESS DATADIRECT HYBRID DATA PIPELINE INSTALLATION GUIDE
  Available online at
  https://documentation.progress.com/output/DataDirect/hybridpipeinstall

* PROGRESS DATADIRECT HYBRID DATA PIPELINE QUICK START
  Available online at
  https://documentation.progress.com/output/DataDirect/hybridpipestart

* PROGRESS DATADIRECT HYBRID DATA PIPELINE USER'S GUIDE
  Available online at
  https://documentation.progress.com/output/DataDirect/hybridpipeline

* The Hybrid Data Pipeline readme file: hdpreadme.txt
  Installed file and available online at
  https://documentation.progress.com/output/DataDirect/hdpreadmes/hdpreadme.htm

* The On-Premise Connector readme file: hdpopcreadme.txt
  Installed file and available online at
  https://documentation.progress.com/output/DataDirect/hdpreadmes/hdpopcreadme.htm

* The JDBC Driver readme file: hdpjdbcreadme.txt
  Installed file and available online at
  https://documentation.progress.com/output/DataDirect/hdpreadmes/hdpjdbcreadme.htm

* The ODBC Driver readme file: hdpodbcreadme.txt
  Installed file and available online at
  https://documentation.progress.com/output/DataDirect/hdpreadmes/hdpodbcreadme.htm

* The OpenAccess Server readme file: hdpoaserverreadme.txt
  Installed file and available online at
  https://documentation.progress.com/output/DataDirect/hdpreadmes/hdpoaserverreadme.htm


     Installed Files

When you install the Hybrid Data Pipeline server, the installer creates logs and
scripts. These files can be used to evaluate and troubleshoot issues. These
files can be found in the following locations where INSTALL_DIR is the
installation directory for the Hybrid Data Pipeline server.

INSTALL_DIR/ddcloud/: 
---------------------
deploy.log                 Log file that provides deployment details

deploy.sh                  Shell script to update existing deployment or echo
                           all output to stdout

error.log                  Log file that provides list of server errors

getlogs.sh                 Shell script that creates a compressed tar file with
                           all server logs

setlogginglevel.sh         Shell script to specify level of detail written to 
                           log files

In addition, the installation process creates four configuration files that are
needed to integrate Hybrid Data Pipeline components.

INSTALL_DIR/redist/: 
--------------------
config.properties          File that contains branding information

ddcloud.pem                File for the self-signed certificate

ddcloudTrustStore.jks      The Java keystore

OnPremise.properties       File with server and port information


     Third-Party Acknowledgments

Refer to the following Web page:
https://www.progress.com/legal/hybridpipe-third-party


April 2017
~~~~~~~~~~
End of README