Uploaded by Renaud

APOS Live Data Gateway

advertisement
Live Data Gateway
APOS Live Data Gateway
Help File
Table of Contents
APOS Live Data Gateway ..........................................................................................................................................................................................................1
Extended Data Connectivity for SAP BI........................................................................................................................................................................1
SAP Analytics Cloud - Live Data Connectivity .....................................................................................................................................................1
Analysis for Office – Live Data Connectivity .........................................................................................................................................................2
Licensing ..................................................................................................................................................................................................................................2
Limitations ..............................................................................................................................................................................................................................3
About APOS ................................................................................................................................................................................................................................9
Installation ..................................................................................................................................................................................................................................... 10
Requirements .......................................................................................................................................................................................................................... 10
SAP Requirements ........................................................................................................................................................................................................... 10
APOS Live Data Gateway Manager ........................................................................................................................................................................ 10
APOS Live Data Gateway ............................................................................................................................................................................................. 11
APOS Admin Tool ............................................................................................................................................................................................................ 12
APOS SSO2 Services ....................................................................................................................................................................................................... 12
APOS Azure Analysis Service Gateway ................................................................................................................................................................. 13
BW Connections ............................................................................................................................................................................................................... 13
Universes............................................................................................................................................................................................................................... 13
Databases ............................................................................................................................................................................................................................. 13
Working with Firewalls .................................................................................................................................................................................................. 17
Included Files........................................................................................................................................................................................................................... 18
Installation Steps ................................................................................................................................................................................................................... 20
Uninstall Steps ........................................................................................................................................................................................................................ 21
Live Data Gateway User Guide ........................................................................................................................................................................................... 22
Overview .................................................................................................................................................................................................................................... 22
Live Data Gateway Deployment............................................................................................................................................................................... 24
Web Admin Tool Deployment .................................................................................................................................................................................. 56
SAML SSO Deployment ................................................................................................................................................................................................ 81
SSO2 Services Deployment ........................................................................................................................................................................................ 90
Azure Analysis Service Gateway Deployment ............................................................................................................................................... 136
Install Tomcat .................................................................................................................................................................................................................. 142
Live Data Gateway Manager ................................................................................................................................................................................... 146
Analysis for Office ......................................................................................................................................................................................................... 241
Geo Maps .......................................................................................................................................................................................................................... 245
Configure Proxy with a Dedicated Port ............................................................................................................................................................ 255
OData Gateway .............................................................................................................................................................................................................. 259
Live Data Gateway Reference ........................................................................................................................................................................................... 274
ii
Table Of Contents
Live Data Gateway Manager ........................................................................................................................................................................................ 274
Database Method ......................................................................................................................................................................................................... 276
Non-Database Method.............................................................................................................................................................................................. 431
Connection String ......................................................................................................................................................................................................... 471
Admin Tool Web Application ...................................................................................................................................................................................... 484
Web Application Deployment: .............................................................................................................................................................................. 484
Independent Service Deployment: ...................................................................................................................................................................... 484
Admin Tool Web UI ..................................................................................................................................................................................................... 485
SQL Database ....................................................................................................................................................................................................................... 577
Tables................................................................................................................................................................................................................................... 577
APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT................................................................................................................................ 586
Technical Support ................................................................................................................................................................................................................... 594
iii
APOS Live Data Gateway
Extended Data Connectivity for SAP BI
The APOS Live Data Gateway simplifies and extends data access for SAP Analytics Cloud.
The Data Gateway is a data connection and data transformation solution that enables live data connectivity and
expanded data source options for SAP BI solutions.
This product includes software developed by the Spring Framework
Project (http://www.springframework.org).
SAP Analytics Cloud - Live Data Connectivity
Many organizations looking to begin adoption of SAP Analytics Cloud need efficient and cost-effective connectivity
with their enterprise data sources.
SAP Analytics Cloud natively provides live data connectivity to on premise SAP HANA data.
The APOS Live Data Gateway provides live data connectivity from SAP Analytics Cloud to an expanded set of on
premise data sources, without ever moving the data outside the firewall. The data is kept safely behind the firewall,
with no replication or upload requirements, and no need to re-create or duplicate data models.
The current release for APOS Live Data Gateway for SAP Analytics Cloud, now available, provides live data
connectivity to:























1
CDATA Drivers
Cloudera Impala
Hive o Cloudera (CDH 5.13.0 Version 1.1)
o Hortonworks (Version 1.2.1)
o Google Cloud (Version 2.3.2)
o Amazon EMR (Version 1.1.1.1001)
DB2
Denodo
Direct connection to Relational data sources (Microsoft SQL Server, Oracle)
Essbase
Google Big Query
HANA
IBM Netezza Data Warehouse Appliances
Microsoft OLAP data (SSAS)
MongoDB
MongoDB Atlas
MySQL
Oracle Exadata
Redshift
SAP BW (version 7.3, 7.4, 7.5, and BW4HANA)
SAP BusinessObjects Universes (UNX and UNV)
SAP SQL Anywhere
Snowflake
Sybase IQ
Teradata
Redshift
Introduction
Analysis for Office – Live Data Connectivity
The APOS Live Data Gateway simplifies data access to numerous data sources, providing live data connectivity that
can be managed easily by end users with no knowledge of SQL or MDX queries.
The following data source connections are supported with AO 2.8:



Relational Databases
Relational Databases using a Pre-Defined User (SSO1)
Universes
Licensing
The necessary licenses are available to be used with APOS Live Data Gateway. Contact Sales@apos.com for more
information on the following licenses.



APOS Live Data Gateway – APOS Live Data Gateway license
APOS OData Gateway – APOS Live Data Gateway OData Gateway license
APOS LDG JDBC Driver – APOS Live Data Gateway JDBC Driver license
APOS Systems Inc. | APOS Live Data Gateway
2
Introduction
Limitations
The following limitations exist for APOS Live Data Gateway when used with SAP Analytics Cloud.
SAP Analytics Cloud (SAC)

Chrome browser

Only one connection type is supported per APOS Live Data Gateway web application. Multiple deployments
of the Live Data Gateway web application are allowed.

The Views for live connections shows measures only and is not configurable.

Advanced filters within SAC are not supported.

Expanding on hierarchies in the Waterfall Chart within SAC is not supported.

Showing unbooked data is not supported.

Grid Totals within SAC on the horizontal and vertical axis for relational databases. Totals are not supported
when the measures are placed between dimensions on the same axis..

Date Time Dimensions are supported for relational databases when using the Live Data Gateway database
backend method. The following are limitations:

Time Dimensions are supported when using the following connections: SQL Server, Oracle,
Denodo, Google Big Query, DB2 and Snowflake.

Support for time variance requires the database to support the SQL function LAG. Not supported
yet in LDG for Google Big Query.

Restricted measures based on time dimension hierarchy are supported only for member and range.

Variance not supported when the chart contains a dimension and one single Time Dimension filter
is applied.

Page/Story filters based on hierarchies does not support Cascade Filters.

The following Calculation Types are not supported:

Aggregation

Difference From

Linked data sources for all database connections are not supported.

The following functions in calculated measures are not supported:

RESTRICT

RESULTLOOKUP

LOOKUP

Geo Maps - The following are limitations:

Supported for all relational databases. All elements must be part of one single table, table joins are
not supported.

Only supported when using the Live Database Gateway Database Backend Method

Stored procedures with parameters are not supported

Virtual points that are SRID 3857 and 4326 are supported
APOS Systems Inc. | APOS Live Data Gateway
3
Introduction

HTTP2 – The following do not support HTTP2 protocol and will automatically fall back to HTTP1.

saml2-sso

Kerberos

SSO using NTLM

OData Gateway

BW – The following are limitations:

Variables of processing type Manual Entry and Default Value Variables are supported.

When the variable supports multiple default values, no values will be displayed in the model area
(XMLA limitation).

When filtering by a dimension the dimension must be part of the fields associated with the table or
chart.

BW –The following are unsupported features:

Range filters

Totals

Hierarchy Networks

Hierarchies are not displayed on the drilling format in the DataView page

Exclude filters defined on hierarchies

Calculated measures:

Log10

Power

GrandTotal

LENGTH

LIKE

SUBSTRING

ISNULL

NOT

Dimensions within the IF function located in the Calculated Measures Editor.

Restricted measures on hierarchies defined within the Calculated Measures Editor.

Creating new measures in the Model using the Exception Aggregation column.

SSAS – The following are limitations:

Support of the following aggregations:

SUM

MIN

MAX

AVG

COUNT

Calculated Measures
APOS Systems Inc. | APOS Live Data Gateway
4
Introduction

SSAS –









The following are unsupported features:
Range filters
Totals
Hierarchy Networks
Hierarchy manipulation is not supported in the DataView page
Exclude filters defined on hierarchies
Calculated measures:

Log10

Power

GrandTotal

LENGTH

LIKE

SUBSTRING

ISNULL

NOT
Dimensions within the IF function located in the Calculated Measures Editor.
Restricted measures based on hierarchies defined within the Calculated Measures Editor.
Creating new measures in the Model using the Exception Aggregation column.

MS SQL – The following are limitations:

SQL databases must be configured with mixed authentication. Windows authentication is not
supported.

Only connections defined with CORS are supported when connection to SAC SSO with ADFS and
Kerberos for SQL Server

The following limitations exist when using views based on stored procedures:

Input parameters of type array are not supported

Data returned by output parameters are not supported

Supported for LDG with backend databases only

Not available for AO

Relational Databases – The following are unsupported features:

Hierarchy Networks

Calculated measures:

Log10

Power

GrandTotal

LENGTH

LIKE

SUBSTRING

ISNULL

NOT

Dimensions within the IF function located in the Calculated Measures Editor.

Creating new measures in the Model using the Exception Aggregation column.
APOS Systems Inc. | APOS Live Data Gateway
5
Introduction

ESSBASE – The following are unsupported features:

Range filters

Totals

Hierarchy filters when filter with values from a different level

Hierarchy Networks

Hierarchies are not displayed on the drilling format in the DataView page

Hierarchies and regular dimensions cannot be placed on the same axis with the Measures

Filtering will return the intersection of the selected dimension and the selected filter values

Measures that are organized in hierarchies

Calculated measures:

Log10

Power

GrandTotal

LENGTH

LIKE

SUBSTRING

ISNULL

NOT

Dimensions within the IF function located in the Calculated Measures Editor.

Restricted measures based on hierarchies defined within the Calculated Measures Editor.

Creating new measures in the Model using the Exception Aggregation column.

Linked Analysis/Filters

BSO Mode – Some restrictions for some filters and will show results without considering the filter.

Universes – The following are limitations and unsupported features:

Support for relational UNV and UNX only – no support for OLAP universes

The Model window does NOT exclude non-relational universes.

Universes names displayed in the Model list will have a numeric identifier representing the ID /
Folder ID to the right.

Hierarchies

Range filters

Totals

Calculated measures in both Model and Stories. Calculated measures can instead be created within
the universe.

Creating new measures in the Model using the Exception Aggregation column.

TOP is implemented as Ranking and is only supported if the database supports it otherwise the full
result set will be returned.

Prompts and Contexts – When fields are selected that require this implementation, DB Gateway will
attempt to resolve it using previously defined values and if that is not available then the first item in
the LOV.

Filtering directly with one or more values on a Chart control.

When a universe has been modified from the metadata perspective (add/remove measure or
dimension) the changes will be made available in the SAC model. These updates will not be
available to the story until the Model has been opened and then saved.

Thresholds are not supported.

Universe Filters

Filters will be displayed as Dimension objects.

Filters will have the suffix (F) appended to the dimension name.

When used in a filter operation the word ‘Apply’ will be displayed for the user to select.

Filters should not be selected as fields in charts. If a filter is selected as a field the word
‘True’ will be displayed.

Universe prompt filters are not supported.
APOS Systems Inc. | APOS Live Data Gateway
6
Introduction
Analysis for Office



Analysis for Office v 2.8 minimum
Unsupported features:

Restricted Measures

When using in a filter operation it must be applied as a Dimension. If applied as a background filter
nothing will occur.

If a filter is selected as a field the word ‘True’ will be displayed.
Unsupported features for all database connections:

Linked data sources
OData Gateway
The following limitations exist when creating an OData connection using APOS OData Gateway.



OLAP Data sources – hierarchies are not supported
UNX Universes – connection not supported
SAP Analytics Cloud (SAC) – OData Acquired Data – When acquiring the data via the APOS OData Gateway
the connection must be to either database views or universes. Creating a connection that includes a mixture
of both database views and universes is not supported.
LDG Driver
The following limitation exists when creating a connection using the JDBC Driver and consuming the OData Gateway
web application.


UNV Universes – connection not supported
UNX Universes – connection not supported
Azure Analysis Service Gateway
The following limitation exists when creating a connection using the SSAS type data source to Azure Analysis Service:


Kerberos is not supported.
Multi-Factor Authentication is not supported
OAuth2 Authentication
The following database connections are supported when using SSO authentication of type OAuth:


Snowflake – External OAuth using Azure supported only
Google Big Query
Snowflake OAuth Prerequisites:
1.
2.
3.
4.
Install the LDG components on a computer in the user domain.
The Snowflake (JDBC Generic) database connection is configured to use OAuth.
Snowflake OAuth Resource and OAuth Client should be configured in Azure AD.
Connect to SAC using the Tenant SAC displayed in the Web Admin UI.
Google Big Query OAuth Prerequisites:
1.
Install the LDG components on a computer in the user domain.
APOS Systems Inc. | APOS Live Data Gateway
7
Introduction
2.
3.
4.
5.
The Google Big Query database connection is configured to use OAuth.
The user must have a Google account and have permissions to connect to Google Big Query to get
metadata and data.
Connect to SAC using the Tenant SAC displayed in the Web Admin UI.
Creation of views using the Desktop Admin requires an ODBC connection.
APOS Systems Inc. | APOS Live Data Gateway
8
Introduction
About APOS
APOS Systems Inc. was founded in 1992 and today is a software company focused on the development and support
of the APOS BI Tools suite of products. As a leading Business Objects Technology Partner, APOS has only one goal to help customers around the world extend the Business Objects Enterprise platform, without custom development.
APOS BI Tools for BusinessObjects Enterprise provide our customers with powerful solutions to extend their business
intelligence system. APOS BI Tools include telephone and web-based technical support plus a maintenance program
that provides new versions going forward to support new releases or upgrades of BusinessObjects XI.
Professional Services - APOS professionals are experts with both APOS BI Tools and the BusinessObjects Enterprise
platform - they can help in a pre-sales or post-sales role. For example, we can review your requirements and help you
assess how APOS BI Tools can help. Perhaps we can help with a proof-of-concept, or provide installation and
deployment assistance.
Development - APOS provides development services utilizing BusinessObjects tools and solutions, often using APOS
BI Tools as the foundation to fast track special development projects.
Head Office: 100 Conestoga College Blvd Suite 1101, Kitchener, Ontario Canada N2P 2N6
Tel: 519.894.2767 Fax: 519-894-1891
Email: apos@apos.com
Technical Support: Email: support@apos.com
Technical Support by Phone
APOS Systems Inc. | APOS Live Data Gateway
9
Installation
Requirements
The following requirements must be met to successfully configure and use APOS Live Data Gateway.
SAP Requirements

SAP Analytics Cloud (SAC) version 2016.19 minimum
Connecting to SAC
The following can be used to connect to SAC using Live Data Gateway when the application is deployed to Tomcat.
Cross-Origin Resource Sharing (CORS) is the preferred method when using Live Data Gateway to connect to SAC.
Cross-Origin Resource Sharing (CORS)




Apache Tomcat
o 9.0.40 (64 bit) or later
o 8.5.60 (64 bit) or later
Configured for SSL (https://tomcat.apache.org/tomcat-8.5-doc/ssl-howto.html)
SSL certificate from a Certified Authority
Update the file …Tomcat\conf\context.xml

Add the below statement inside the <Context> XML tag last entry before </Context>. Once added
save the file and restart Tomcat.
<CookieProcessor className=”org.apache.tomcat.util.http.LegacyCookieProcessor”/>
APOS Live Data Gateway Manager


Microsoft .NET Framework v4.0
OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
Database Backend Method


10
Using the Database Method of Live Data Gateway requires SQL Server 2012 minimum
SQL databases must be configured with mixed authentication. Windows authentication is not supported.
APOS Live Data Gateway
APOS Live Data Gateway
Web Application Deployment
Deploy Live Data Gateway to Tomcat.


Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
Apache Tomcat - Update the file …Tomcat\conf\context.xml

Add the below statement inside the <Context> XML tag last entry before </Context>. Once
added save the file and restart Tomcat.
<CookieProcessor className=”org.apache.tomcat.util.http.LegacyCookieProcessor”/>


OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
HTTP2 Protocol – When Tomcat is configured with OpenJDK 8 or Java 1.8, deploy the tcnative-1.dll file to
the Tomcat\bin folder.
Independent Service Deployment



Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
HTTP2 Protocol – When Tomcat has been configured with OpenJDK 8 or Java 1.8, deploy the tcnative-1.dll
file to the bin folder located in the service folder.
SAML SSO Deployment
The SAML SSO deployment requires the following prerequisites when selecting to create a connection using SAML
SSO:



Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
Deployed saml2-sso web application on Apache Tomcat configured to support SSL using the same
certificate for both LDG and Tomcat.
SAC is configured with SAML SSO
APOS Systems Inc. | Installation
11
APOS Live Data Gateway
APOS Admin Tool
Web Application Deployment




Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
Apache Tomcat configured for SSL (https://tomcat.apache.org/tomcat-8.5-doc/ssl-howto.html)

SSL certificate from a Certified Authority
OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
HTTP2 Protocol – When Tomcat is configured with OpenJDK 8 or Java 1.8, deploy the tcnative-1.dll file to
the Tomcat\bin folder.
Independent Service Deployment



Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
HTTP2 Protocol – When Tomcat has been configured with OpenJDK 8 or Java 1.8, deploy the tcnative-1.dll
file to the bin folder located in the service folder.
APOS SSO2 Services
Independent Service Deployment




Apache Tomcat

9.0.40 (64 bit) or later

8.5.60 (64 bit) or later
OpenJDK 8 or Java™ SE Runtime Environment v. 1.8 minimum
APOS Live Date Gateway deployed on the same machine using one of the following methods:

Independent Service Deployment (Recommended)

Web Application Deployment
The following data sources are supported:

Snowflake

AWS Athena

AWS Redshift
APOS Systems Inc. | Installation
12
APOS Live Data Gateway
APOS Azure Analysis Service Gateway




Web Server IIS 8 minimum with the following installed:
 .NET Extensibility 3.5
 .NET Extensibility 4.6
 ASP.Net 3.5
 ASP.Net 4.6
 ISAPI Extensions
 ISAPI Filters
Visual C++ 2015 (64 bit) installed
ADOMD.Net v15.0.2000.235 installed (included with the setup in the ADOMD folder)
Microsoft .NET Framework v4.6.1
BW Connections

BW 7.3, 7.4, 7.5 and BW4HANA
Universes

SAC – SAP BusinessObjects BI 4.1 SP6 minimum
Databases
AWS Athena


Require the installation of the ODBC 64 bit driver Simba Athena.
APOS SSO2 Service (Tomcat Deployment) – Using the JDBC Generic connection option requires the below
file. Contact APOS Support for a copy of the file.
o AthenaJDBC42.jar
AWS EMR Hive


Require the installation of the ODBC 64 bit driver Amazon Hive 1.1.1.1001
Configure a 64 bit ODBC DSN using the Amazon Hive ODBC Driver.
AWS Redshift


Require the installation of the ODBC driver AmazonRedshiftODBC32-1.3.7.1000.
APOS SSO2 Service (Tomcat Deployment) – Using the JDBC Generic option requires the below files. Contact
APOS Support for a copy of the files.
o aws-java-sdk-core-1.12.23.jar
o aws-java-sdk-redshift-1.12.23.jar
o commons-logging-1.1.3.jar
o ion-java-1.0.2.jar
o jmespath-java-1.12.23.jar
o joda-time-2.8.1.jar
o redshift-jdbc42-no-awssdk-1.2.45.1069.jar
BigQuery


Require the installation of the ODBC 64 bit driver BigQuery 2.1.6.1006.
Configure a 64 bit ODBC DSN using the BigQuery driver.
APOS Systems Inc. | Installation
13
APOS Live Data Gateway
CDATA Drivers



The CDATA Drivers option is an umbrella for multiple databases handled with CDATA drivers.
APOS will supply a file named APOS_CData_Drivers.zip that includes the necessary dll and jar files to be
manually copied to the following locations:
o The dll files need to be copied to the LDG Admin folder where the Admin exe files are installed.
o The jar files need to be copied to

The LDG deployment:

Web Application: WEB-INF\lib folder

Service: \lib folder

The APOSAdminTool deployment:

Web application: WEB-INF\lib folder

Service: /lib

The ConnectionTest_lib folder that is found with the LDG Admin folder
The CDATA driver for SAP Business One DI requires the below jar files to be copied from the SAP Business
One installation folder …\Program Files\SAP\SAP Business One DI API\JCO\LIB
o sboapi.jar
o sbowapper.jar
Cloudera Hive


Require the installation of the ODBC 64 bit driver Hive for Cloudera Platform (CDH 5.13.0) Version 1.1
Configure a 64 bit ODBC DSN using the Cloudera ODBC Driver for Impala.
Cloudera Impala

Configure a 64 bit ODBC DSN using the Cloudera ODBC Driver for Impala.
Denodo


Require the installation of the ODBC 64 bit driver Denodo 9.03.05.00
Configure a 64 bit ODBC DSN using the Denodo driver.
ESSBASE


Limited to cube configured with ASO (Aggregate Storage Option).
Not supported when connecting using SSO.
Google Cloud Hive



Require the installation of the ODBC 64 bit driver Hive for Cloudera Platform (CDH 5.13.0) Version 1.1
Configure a 64 bit ODBC DSN using the Cloudera ODBC Driver for Impala.
Supports Hive Google Cloud Platform 2.3.2
HANA

Require the installation of SAP HANA Client
 Configured a 64 bit ODBC DSN using the HANA Client driver.
APOS Systems Inc. | Installation
14
APOS Live Data Gateway
Hortonworks Hive



Require the installation of the ODBC 64 bit driver Hive for Cloudera Platform (CDH 5.13.0) Version 1.1
Configure a 64 bit ODBC DSN using the Cloudera ODBC Driver for Impala.
Supports Hive for Hortonworks 1.2.1
IBM DB2

Require the installation of the DB2 .Net provider (IBM.data.db2.dll, IBM.data.db2.entity.dll version 9.7.4.4)
MongoDB & MongoDB Atlas


Require the installation of the ODBC 64 bit driver MySQL 5.3.
MongoDB Atlas – When not using SSL the below environmental variable must be set
o LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN=1
MySQL

Require the installation of the ODBC 64 bit driver MySQL 5.3.
Netezza

Require the installation of nzoledb and nzjdbc drivers from nz-winclient version 7.2.1.4 or higher.
Oracle
 Require the installation of ODAC product version 4.121.2.0 (64 bit) Release 4 (Oracle.Data Access.dll).
Oracle Exadata




Require the installation of ODAC product version 4.121.2.0 (64 bit) Release 4 (Oracle.Data Access.dll).
Client credentials files from Oracle Exadata Cloud.
Configured a 64 bit ODBC DSN using the Oracle client.
Java version 1.8.0_171 x64 minimum or OpenJDK 8
Presto

Require the selection of the JDBC Generic database option when configuring the database connection.
Snowflake


Requires the selection of the JDBC Generic database option when configuring the database connection.
APOS SSO2 Service – snowflake-jdbc-3.13.1.jar minimum.
Sybase IQ

Require the installation of SybaseIQ Network Client 16.1 (Sap.Data.SQLAnywhere.v4.5.dll)
 Configured a 64 bit ODBC DSN using the Sybase IQ driver.
APOS Systems Inc. | Installation
15
APOS Live Data Gateway
Sybase Anywhere


Require the installation of SAP SQL Anywhere Database Client (iAnywhere.Data.SQLAnywhere.v4.0.dll).
Configured a 64 bit ODBC DSN using the Sybase Anywhere driver.
Teradata

Require the installation of NET data provider for Teradata 14 and up (Teradata.Client.Provider.dll).
APOS Systems Inc. | Installation
16
APOS Live Data Gateway
Sizing Guidelines
We recommend having 16GB of RAM and 4 cores of CPU for supporting 100 concurrent users.
Both the CORS and the gateway can be deployed in a web farm formation for maximum throughput.
Working with Firewalls
If there is a firewall deployed ensure that the firewall has been configured to allow full communication between all
components.
APOS Systems Inc. | Installation
17
APOS Live Data Gateway
Included Files
APOS Live Data Gateway is comprised of the following features which can usually be found in the product installed
folder ...\Program Files\APOS\Live Data Gateway.

Live Data Gateway Manager – This file is located in the Admin folder of the application installed folder. It
is used for the creation of the connections for live connections. A shortcut to the Manager has been created
on the desktop. The application requires the APOS Live Data Gateway license file.

LiveDataGateway – Web Application Deployment - The ROOT.war file is located in the ...\Program
Files\APOS\Live Data Gateway\LDG\WebApp folder. The web application is deployed to tomcat. This
application will use the connection and licensing information when creating live connections.
The OData web application is part of this deployment and requires the APOS Live Data Gateway OData
Gateway license. This feature allows all applications which are able to consume OData (SAC, HANA SDI,
HANA SDA etc.) as well as for those using the APOS LDG JDBC driver (Crystal Reports etc.) to access data
provided by Live Data Gateway. This web application is intended for data sources of type Database,
Universes and OLAP only and is supported when LDG is configured using the Database Method as a
backend. The Non-Database backend Method is not supported with this feature.



Database Method - Multiple data sources with the same type of security saved to a SQL Database
can share one single web application. A version of SQL Express is included in the setup files.
Non-Database Method - Only one connection type is allowed per web application. When multiple
connection types are required the web application will need to be deployed uniquely for each
connection type.
LiveDataGateway.jar – Independent Service Deployment - The files for the independent service are located
in the ...\Program Files\APOS\Live Data Gateway\LDG\Service folder. This application will use the
connection and licensing information when creating live connections.
The OData service is part of this deployment and requires the APOS Live Data Gateway OData Gateway
license. This feature allows all applications which are able to consume OData (SAC, HANA SDI, HANA SDA
etc.) as well as for those using the APOS LDG JDBC driver (Crystal Reports etc.) to access data provided by
Live Data Gateway. This web application is intended for data sources of type Database, Universes and OLAP
only and is supported when LDG is configured using the Database Method as a backend. The Non-Database
backend Method is not supported with this feature


Database Method - Multiple data sources with the same type of security saved to a SQL Database
can share one single web application. A version of SQL Express is included in the setup files.
Non-Database Method - Only one connection type is allowed per web application. When multiple
connection types are required the web application will need to be deployed uniquely for each
connection type.

saml2-sso.war – Web Application Deployment – The saml2-sso.war file is located in the …\Program
Files\APOS\Live Data Gateway\WebApp folder. This web application is deployed to tomcat and is used
along with the LDG deployed as either a web application or as a service to support SAML SSO connections
to MS SQL Server in SAC SSO.

ldg-key-service.jar – APOS SSO2 Services - Independent Service Deployment – The files for the SSO2
Services feature are located in the …\Program Files\APOS\Live Date Gateway\SSO2 Services\ldg-key-service
folder. This application works with the Live Data Gateway deployment and provides an alternative method
for handling user security when the IDENTITY PROVIDERS SSO – Level 2 option is selected for JDBC
Generic connections. The following data sources are supported with this feature :

AWS Athena

AWS Redshift

Snowflake
APOS Systems Inc. | Installation
18
APOS Live Data Gateway

APOSAdminTool.war – Web Application Deployment – The file is located in the ...\Program
Files\APOS\Live Data Gateway\Web Admin Tool\WebApp folder. The web application is deployed to
tomcat (version 8.5 min) and used to define views via the Web UI. This Web UI is intended for data sources
of type Database only and is supported when LDG is configured using the Database Method as a backend.
The Non-Database backend Method is not supported with this feature.

APOSAdminTool.jar – Independent Service Deployment – The independent service files are located in the
...\Program Files\APOS\Live Data Gateway\Web Admin Tool\Service folder.. This Web UI is intended to
define views via the Web UI for data sources of type Database only and is supported when LDG is configured
using the Database Method as a backend. The Non-Database backend Method is not supported with this
feature.

ldg-driver.jar – JDBC Driver – The driver is located in the ...\Program Files\APOS\Live Data
Gateway\Drivers\JDBC Driver folder. Use the JDBC driver with applications that are not able to consume
OData (Crystal Reports etc.) to access sources such as APOS OData Gateway and data provided by Live
Data Gateway. The following files are available to optionally assist when using the jar file when creating
JDBC connections in universes. This driver is intended for data sources of type Database, Universe and OLAP
only and is supported when LDG is configured using the Database Method as a backend. The Non-Database
backend Method is not supported with this feature


aposldgjdbc.sbo
aposldgjdbc.setup

Azure Analysis Service Gateway – The files are located in the …\Program Files\APOS\Live Data
Gateway\Azure folder. Deploy the files to IIS (8 min) and configure to enable http access to Azure Analysis
Service. This service requires the APOS Live Data Gateway license file. Once deployed using the LDG
Manager to create connections to the service and deploy the configuration file(s) to the LDG web application
to create SAC stories.

Help File – This help file that is located in the root of the installed folder. A shortcut to this file has been
created on the desktop for your convenience.
APOS Systems Inc. | Installation
19
APOS Live Data Gateway
Installation Steps
Please follow these steps to install:
1.
Ensure that the Requirements have been met.
2.
Ensure that the current computer user has administrative rights for the computer where you are installing APOS
Live Data Gateway.
3.
Stop all unneeded applications, virus scan utilities, etc.
4.
Download the APOS Live Data Gateway setup program and save it to your local system environment.
5.
Run the setup program - refer to the e-mail you received to obtain more information on licensing.
6.
If APOS Live Data Gateway was installed previously and this is a different version of the installation, a
notification will appear prompting you to first remove the current version before you can proceed. Please follow
the Uninstall Steps in order to successfully remove the application before running the setup program again and
continuing on with step 7.
7.
Once the installation is complete proceed to the below chapters found within the Live Data Gateway User
Guide.









Live Data Gateway Deployment
SAML SSO Deployment
Live Data Gateway Manager
Web Admin Tool Deployment
SSO2 Services Deployment
Geo Maps
Azure Analysis Service Gateway Deployment
OData Gateway
Live Data Gateway Drivers
APOS Systems Inc. | Installation
20
APOS Live Data Gateway
Uninstall Steps
To remove APOS Live Data Gateway from your system follow the below steps:
1.
In Control Panel window select Programs and Features.
2.
In the Program and Features window there should be an entry for APOS Live Data Gateway listed.
3.
Select Uninstall, answer Yes to the removal confirmation and APOS Live Data Gateway will be removed from
your system.
4.
This step will not remove the files that were manually installed on the Tomcat server.
APOS Systems Inc. | Installation
21
APOS Live Data Gateway
Live Data Gateway User Guide
Overview
The APOS Live Data Gateway components supplied within this setup are to be installed on a centrally located server
that has Tomcat installed and internet access in order to allow remote connectivity to SAC.
Follow the below steps to configure and deploy the Live Data Gateway solution:


Live Data Gateway Deployment – Deploy Live Data Gateway to provide live data connectivity from SAP Analytics
Cloud to on premise data sources. Included in the Live Data Gateway deployment is APOS OData Gateway for
use with all applications which are able to consume OData (SAC, HANA SDI, HANA SDA, etc.) as well as those that
can use the APOS LDG JDBC driver (Crystal Reports) to access data provided by Live Data Gateway.
The following two methods of deployment are supported with Live Data Gateway:

Independent Service Deployment – Steps outlining the deployment of the application as a service. Steps
include configuring HTTP2 protocol.

Web Application Deployment – Steps outlining the installation of Tomcat and deployment of the Live Data
Gateway web application.

Installation of Tomcat – Install Tomcat if required.

Deployment of the web application - Deploy the Live Data Gateway web application using one of
the configurations outlined below. The CORS method is the recommended method.

CORS – Configure the tomcat server.xml file for each service name and deploy a web
application file for each Live Data Gateway data source. Steps include configuring HTTP2
protocol.

CORS – SSO – Configure the connection of SAC SSO via ADFS and Kerberos. Update the
tomcat server.xml file for a service name and deploy the required web applications for the data
source.

SAML SSO Deployment – Deploy the SAML SSO web application to support LDG connections to MS SQL
Server using SAML SSO within SAC SSO.

SSO2 Services Deployment – Deploy the SSO2 Services and provides an alternative method for handling
user security for LDG when the IDENTITY PROVIDERS SSO – Level 2 option in the SSO Configuration tab is
selected for JDBC Generic connections. The following data sources are supported with this feature:

AWS Athena

AWS Redshift

Snowflake
Live Data Gateway Manager – Creation and deployment of the connections to the Live Data Gateway web
application server.

Database Method

Connect using the backend database method - This method supports CORS only web application
deployments. All connections and views are saved in a SQL Server database and is the
recommended method. A version of SQL Express is included in the setup if required.

Create a connection to an installation of SQL Server with a database already configured.

Multiple data sources with the same type of security can share one single web application.

Once configured and deployed to the Tomcat server adding new connections and views
with the same type of security will not require accessing the Tomcat server.
APOS Systems Inc. | Live Data Gateway User Guide
22
APOS Live Data Gateway



Connection and view files created using the non-database method can be imported into
the database.
Non-Database Method

Connect using the non-database method - This method supports CORS web application
deployments. The non-database method is deprecated and the Database Method is the
recommended deployment for the configuration of connections and views. Time dimensions are
not supported when using the non-database backend method.
Web Admin Tool Deployment – The following two methods of deployment are supported:

Independent Service Deployment – Steps outlining the deployment of the application as a service. Steps
include configuring HTTP2 protocol.

Admin Tool UI – Web Application to create Views to be used when creating Models in SAC.

Web Application Deployment – Steps outlining the deployment of the Admin Tool web application. Steps
include configuring HTTP2 protocol.

Admin Tool UI – Web Application to create Views to be used when creating Models in SAC.

Installation of Tomcat – Install Tomcat if required.

Analysis for Office - Steps outlining the creation of an AO document that uses a live connection to a LDG
relational database.

Geo Maps – Steps outlining the creation of a MS SQL Semantic View containing Virtual Points to be utilized in a
SAC Story containing a Geo Map.

Azure Analysis Service Gateway Deployment – Steps outlining the configuration and deployment of the Gateway
to create LDG connections via http(s) to Azure Analysis Service

Live Data Gateway Drivers – Steps outlining the use of the LDG Drivers.

JDBC Driver – Create connections to tools such as Crystal Reports to consume relational database
views or universes deployed to the APOS Live Data Gateway web application.
APOS Systems Inc. | Live Data Gateway User Guide
23
APOS Live Data Gateway
Live Data Gateway Deployment
APOS Live Data Gateway supports the following methods of deployment:


Web Application – Deploy to a Tomcat server.
Independent Service – Deploy as an independent service.
Web Application
Deploy the Live Data Gateway web application to a Tomcat server. The file can be found in the ...\Program
Files\APOS\Live Data Gateway\LDG\WebApp folder.
When deploying the web application to tomcat follow the steps outlined below:

First Time Deployment



CORS – Configure the tomcat server.xml file for each service name and deploy a web application file for
each Live Data Gateway data source.
CORS – SSO – Configure the connection of SAC SSO via ADFS and Kerberos. Update the tomcat
server.xml file for a service name and deploy the required web applications for the data source.
Re-Deployment


CORS - Remove any currently deployed Live Data Gateway web applications and re-deploy the updated
web application for each Live Data Gateway data source.
CORS – SSO – Remove any currently deployed Live Data Gateway web applications and re-deploy the
updated web application for each Live Data Gateway data source.
First Time Deployment
CORS
Ensure that Tomcat has been configured for SSL prior to beginning the configuration. These steps must be
followed for each Live Data Gateway data source.
The following outlines steps involved when a service name MSAS is created and the Live Data Gateway web
application is deployed to the ...\Tomcat 8.5\MSAS folder.
1.
Edit the server.xml file which is usually located in the folder …\Tomcat 8.5\conf.
APOS Systems Inc. | Live Data Gateway User Guide
24
APOS Live Data Gateway
2.
Look for the </Service> tag and add a new Service name node. The following is an example for a MSAS
data source. The yellow highlighted areas must be modified to match the client system. This example also
includes the addition of HTTP2 protocol support.
The following line must be added within the definition of the connector describing the SSL configuration
since HTTP2 is supported only for HTTPS.
<UpgradeProtocol className=”org.apache.coyote.http2.Http2Protocol”/>
3.
Repeat the above step for each Live Data Gateway data source creating unique Service name tags for each.
4.
Close and Save the server.xml file.
5.
When configuring for HTTP2 protocol and Tomcat uses OpenJDK 8 or Java 8, the file tcnative-1.dll is
required and needs to be copied to the …\Tomcat\bin folder. This file can be found in the …\Program
Files\APOS\Live Data Gateway\LDG\WebApp\bin folder.
6.
Locate the Live Data Gateway web application ROOT.war file that was installed with this setup. This file can
be found in the …\Program Files\APOS\Live Data Gateway\LDG\WebApp folder.
7.
Copy the ROOT.war file to the folder created within Tomcat as a result of the update of the server.xml file
outlined in Live Data Gateway Web App. In this example this would be …\Tomcat 8.5\MSAS.
APOS Systems Inc. | Live Data Gateway User Guide
25
APOS Live Data Gateway
8.
Restart Tomcat or wait for Tomcat to create the ROOT folder.
9.
When logging is desired locate the log4j2.xml file in the ….\Tomcat 8.5\MSAS\ROOT\WEB-INF\classes
folder and ensure that the folder path already exists on the server and the web application has sufficient
privileges to write to it.
APOS Systems Inc. | Live Data Gateway User Guide
26
APOS Live Data Gateway
10. When installing one of the database type connections, the required database jar file needs to be copied to
its deployed ...\Tomcat 8.5\MSAS\ROOT\WEB-INF\lib folder.
Database Type
Athena
Database File(s)
*When using the JDBC Generic connection and SSO2
Services use the below file. Contact APOS Support
for a copy of the file.
AthenaJDBC42.jar
Amazon EMR
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
CDATA Drivers
APOS will supply a file named
APOS_CData_Drivers.zip that includes the necessary
dll and jar files to be manually copied to the
following locations:



Cloudera Hive
The dll files need to be copied to the LDG
Admin folder where the Admin exe files are
installed.
The jar files need to be copied to

The LDG web application in the deployed
WEB-INF\lib folder

The APOSAdminTool web application in the
deployed WEB-INF\lib folder

The ConnectionTest_lib folder that is found
with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from
the SAP Business One installation folder
…\Program Files\SAP\SAP Business One DI
API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
APOS Systems Inc. | Live Data Gateway User Guide
27
APOS Live Data Gateway
Database Type
Database File(s)
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
ucp.jar
APOS Systems Inc. | Live Data Gateway User Guide
28
APOS Live Data Gateway
Database Type
Database File(s)
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
*When using the JDBC Generic connection and SSO2
Services use the below files instead. Contact APOS
Support for a copy of the files.
aws-java-sdk-core-1.12.23.jar
aws-java-sdk-redshift-1.12.23.jar
commons-logging-1.1.3.jar
ion-java-1.0.2.jar
jmespath-java-1.12.23.jar
joda-time-2.8.1.jar
redshift-jdbc42-no-awssdk-1.2.45.1069.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
Teradata
terajdbc4.jar
tdgssconfig.jar
11. When installing the Oracle Exadata database connection copy the client credential files keystore.jks,
tnsnames.ora and truststore.jks to the deployed …\tomcat\<Service name>\ROOT\WEB-INF\classes
folder.
8.
The following adjustments may need to be completed in the Java tab of the Tomcat Configuration
Manager when using OData Gateway to consume data provided by the LDG web application. Restart
Tomcat once the adjustments have been made before continuing.
 When accessing very large datasets from the LDG web application the following adjustments can be
made in the Java tab:

Java Options – Add the below line
-XX:-UseGCOverheadLimit

Max memory pool – Adjust to a minimum of 2048 MB
APOS Systems Inc. | Live Data Gateway User Guide
29
APOS Live Data Gateway
9.
Proceed to Live Data Gateway Manager to create connections.
CORS – SSO
Deploy and configure a service in Tomcat to connect to SAC SSO via ADFS and Kerberos for SQL Server, Oracle,
Denodo and/or SSAS. Only connections defined with CORS are accepted when connecting to SAC SSO.
On the machine that has tomcat installed and where the Live Data Gateway web application will be deployed
make sure the following has been completed prior to going to the next step. These steps must be followed for
each Live Data Gateway data source.
1.
Ensure that tomcat has been configured for SSL.
2.
Make sure the machine has a static IP.
3.
Add the IP and domain information to the hosts file. Update the highlighted areas.
172.0.0.123
COMPUTER.THEDOMAIN.COM
4.
Restart the machine.
5.
Add the machine to the domain.
6.
A Kerberos service principal must be configured in Active Directory (AD) and this domain account must be
made a member of the local Administrator’s group on the tomcat computer.
 When using SSAS ensure that the below has been executed on the domain controller machine to setup
the SPN’s. Change the yellow highlighted entries to match your environment.

setspn -s HTTP/tomcatcomputer serviceprincipalaccount

setspn -s HTTP/tomcatcomputer.domain.com serviceprincipalaccount
7.
A keytab file must be created for the principal and saved to the tomcat computer.
8.
Ensure that the Kerberos configuration file exists in a directory on the tomcat computer ie: C:\Windows. If
needed create the file called krb5.ini with the below sample lines. Change the yellow highlighted entries to
the required domain and computer values.
[libdefaults]
default_realm = THEDOMAIN.COM
dns_lookup_kdc = true
dns_lookup_realm = true
default_tgs_enctypes = rc4-hmac
default_tkt_enctypes = rc4-hmac
udp_preference_limit = 1
forwardable=true
[realms]
THEDOMAIN.COM ={
kdc = COMPUTER.THEDOMAIN.COM
default_domain = THEDOMAIN.COM
}
The following outlines steps involved when a service name MSSQL is created and the Live Data Gateway web
application is deployed to the ...\Tomcat 8.5\ MSSQL folder.
1.
Edit the server.xml file which is usually located in the folder …\Tomcat 8.5\conf.
APOS Systems Inc. | Live Data Gateway User Guide
30
APOS Live Data Gateway
2.
Look for the </Service> tag and add a new Service name node. The following is an example for the MSSQL
data source. The highlighted items must be modified to match the client system.
<Service name="MSSQL">
<Connector port="8087" protocol="HTTP/1.1" connectionTimeout="20000"
redirectPort="8447" />
<Connector
protocol="org.apache.coyote.http11.Http11NioProtocol"
port="8447" maxThreads="200"
scheme="https" secure="true" SSLEnabled="true" keyAlias="TomcatKeyALIAS"
keystoreFile="C:\Users\Administrator/.keystore" keystorePass="changeit"
clientAuth="false" sslProtocol="TLS"/>
<Engine name="MSQL" defaultHost="localhost">
<Host name="localhost" appBase="MSSQL">
</Host>
</Engine>
</Service>
3.
Close and Save the server.xml file.
APOS Systems Inc. | Live Data Gateway User Guide
31
APOS Live Data Gateway
4.
Enter the below line in the Tomcat JVM configuration. Launch the Apache Tomcat properties, select the
Java tab and add to the Java Options section.
-Dsun.security.krb5.rcache=none
5.
Locate the Live Data Gateway web application ROOT.war file that was installed with this setup. This file can
be found in the …\Program Files\APOS\Live Data Gateway\LDG\WebApp folder.
6.
Copy the ROOT.war file to the folder created within Tomcat as a result of the update of the server.xml file
outlined above. In this example this would be …\Tomcat 8.5\MSSQL.
7.
Restart Tomcat or wait for Tomcat to create the ROOT folder.
9.
When connecting to one of the below database type connections, the required database jar file needs to be
copied to the deployed ...\Tomcat 8.5\MSAS\ROOT\WEB-INF\lib folder.
Database Type
Database File(s)
Microsoft SQL
Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
APOS Systems Inc. | Live Data Gateway User Guide
32
APOS Live Data Gateway
10. The following adjustments may need to be completed in the Java tab of the Tomcat Configuration
Manager when using OData Gateway to consume data provided by the LDG web application. Restart
Tomcat once the adjustments have been made before continuing.
 When accessing very large datasets from the LDG web application the following adjustments can be
made in the Java tab:

Java Options – Add the below line
-XX:-UseGCOverheadLimit

Max memory pool – Adjust to a minimum of 2048 MB
11. When logging is desired locate the log4j2.xml file in the ….\Tomcat 8.5\MSSQL\ROOT\WEB-INF\classes
folder and ensure that the folder path already exists on the server and the web application has sufficient
privileges to write to it.
12. Proceed to Live Data Gateway Manager to create connections.
APOS Systems Inc. | Live Data Gateway User Guide
33
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying to the tomcat web application folder:
CORS
The following outlines steps involved when a service name MSAS was created and the Live Data Gateway web
application is to be deployed to the ...\Tomcat 8.5\MSAS folder
1.
Go to the folder …\Tomcat 8.5\MSAS and delete the ROOT.war file. Wait for the ROOT folder to be
removed from the …\Tomcat 8.5\MSAS folder. This step will need to be replicated if more than one web
application was deployed for each connection type.
2.
Locate the Live Data Gateway web application ROOT.war file that was installed with this setup. This file can
be found in the …\Program Files\APOS\Live Data Gateway\LDG\WebApp folder.
3.
Copy the ROOT.war file to the folder created within Tomcat as a result of the update of the server.xml file
outlined in the Live Data Gateway Web App. In the below example this would be …\Tomcat 8.5\MSAS\
APOS Systems Inc. | Live Data Gateway User Guide
34
APOS Live Data Gateway
4.
Restart Tomcat or wait for Tomcat to create the ROOT folder and contents.
6.
When logging is required, locate the log4j2.xml file in the ….\Tomcat 8.5\MSAS\ROOT\WEB-INF\classes
folder and ensure that the folder path already exists on the server and the web application has sufficient
privileges to write to it.
APOS Systems Inc. | Live Data Gateway User Guide
35
APOS Live Data Gateway
7.
If installing one of the database connections, the required database jar file needs to be copied to its
deployed ...\Tomcat 8.5\MSAS\ROOT\WEB-INF\lib folder.
Database Type
Amazon EMR Hive
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Athena
*When using the JDBC Generic connection and SSO2
Services use the below file. Contact APOS Support for
a copy of the file.
AthenaJDBC42.jar
CDATA Drivers
APOS will supply a file named APOS_CData_Drivers.zip
that includes the necessary dll and jar files to be
manually copied to the following locations:



Cloudera Hive
The dll files need to be copied to the LDG Admin
folder where the Admin exe files are installed.
The jar files need to be copied to

The LDG web application in the deployed
WEB-INF\lib folder

The APOSAdminTool web application in the
deployed WEB-INF\lib folder

The ConnectionTest_lib folder that is found
with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from the
SAP Business One installation folder …\Program
Files\SAP\SAP Business One DI API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
APOS Systems Inc. | Live Data Gateway User Guide
36
APOS Live Data Gateway
Database Type
Database File(s)
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
Google Cloud
Hive
hive-jdbc-1.2.3.2-standalone.jar*
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Microsoft SQL
Server
sqljdbc4.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
mssql-jdbc-9.4.1.jre8.jar
ucp.jar
APOS Systems Inc. | Live Data Gateway User Guide
37
APOS Live Data Gateway
Database Type
Database File(s)
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
*When using the JDBC Generic connection and SSO2
Services use the below files instead. Contact APOS
Support for a copy of the files.
aws-java-sdk-core-1.12.23.jar
aws-java-sdk-redshift-1.12.23.jar
commons-logging-1.1.3.jar
ion-java-1.0.2.jar
jmespath-java-1.12.23.jar
joda-time-2.8.1.jar
redshift-jdbc42-no-awssdk-1.2.45.1069.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
Teradata
terajdbc4.jar
tdgssconfig.jar
8.
If installing the Oracle Exadata database connection copy the client credential files keystore.jks,
tnsnames.ora and truststore.jks to the deployed …\tomcat\<Service name>\ROOT\WEB-INF\classes
folder.
9.
Copy the following configuration files exported from the Live Data Gateway Manager to the
….\tomcat\<Service name>\ROOT\WEB-INF\classes folder.
 Database Backend Method - LDG_Config.xml
 Non-Database Backend Method - DG_Datasource.xml and if applicable DG_View.xml
APOS Systems Inc. | Live Data Gateway User Guide
38
APOS Live Data Gateway
CORS – SSO
The following outlines steps involved with re-deployments steps with a configured service name MSSQL and
deployed Live Data Gateway web application for SAC SSO via ADFS and Kerberos for SQL Server deployed to the
...\Tomcat 8.5\ MSSQL folder.
1.
Go to the folder …\Tomcat 8.5\MSSQL\WEB-INF\classes and copy the following configuration files elsewhere
prior to removing the web application.
 DG_DataSource.xml
 DG_View.xml
2.
Go to the folder …\Tomcat 8.5\MSSQL\WEB-INF\lib and copy the database jar files elsewhere prior to
removing the web application.
3.
Go to the folder …\Tomcat 8.5\ MSSQL and delete the ROOT.war file. Wait for the ROOT folder to be
removed from the …\Tomcat 8.5\ MSSQL folder.
4.
Locate the Live Data Gateway web application ROOT.war file that was installed with this setup. This file can
be found in the …\Program Files\APOS\Live Data Gateway\LDG\WebApp folder.
5.
Copy the ROOT.war file to the folder created within Tomcat as a result of the update of the server.xml file
outlined in the Live Data Gateway Web App. In the below example this would be …\Tomcat 8.5\MSSQL\.
Wait for the ROOT folder and contents to appear.
6.
Copy the files DG_DataSource.xml and DG_View.xml to the newly deployed …\Tomcat 8\MSSQL\WEBINF\classes folder.
APOS Systems Inc. | Live Data Gateway User Guide
39
APOS Live Data Gateway
6.
Copy any necessary database jar files to the newly deployed …\Tomcat 8\MSSQL\WEB-INF\lib folder.
7.
When logging is desired locate the log4j2.xml file in the ….\Tomcat 8\MSSQL\MSSQL\WEB-INF\classes
folder and ensure that the folder path already exists on the server and the web application has sufficient
privileges to write to it.
8.
Restart Tomcat.
APOS Systems Inc. | Live Data Gateway User Guide
40
APOS Live Data Gateway
Independent Service
Deploy Live Data Gateway as an independent service. The files can be found in the ...\Program Files\APOS\Live
Data Gateway\LDG\Service folder.
When deploying the independent service follow the steps outlined below:

First Time Deployment

Re-Deployment
First Time Deployment
1.
Launch the Live Data Gateway Manager and create the database connections and views.
2.
Create a new folder that will contain the service deployment files. In this example a folder named ‘Service
Deployed’ was created with a subfolder called ‘LDG’.
3.
Locate the LDG service files found in the installed folder ...\Program Files\APOS\Live Data
Gateway\LDG\Service. Select all files found within including the bin and lib folders.
APOS Systems Inc. | Live Data Gateway User Guide
41
APOS Live Data Gateway
4.
Copy the selected files, along with the bin and lib folders, to the newly created service deployed LDG folder.
5.
Locate the required database jar files found in the installed folder ...\Program Files\APOS\Live Data
Gateway\ Admin\ConnectionTest_lib. Copy them to the newly created Service Deployed\LDG\lib folder
from the previous step.
Database Type
Amazon EMR
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
APOS Systems Inc. | Live Data Gateway User Guide
42
APOS Live Data Gateway
Database Type
Database File(s)
CDATA Drivers
APOS will supply a file named
APOS_CData_Drivers.zip that includes the necessary
dll and jar files to be manually copied to the
following locations:



Cloudera Hive
The dll files need to be copied to the LDG
Admin folder where the Admin exe files are
installed.
The jar files need to be copied to

The LDG deployed lib folder

The APOSAdminTool deployed \lib folder

The ConnectionTest_lib folder that is found
with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from
the SAP Business One installation folder
…\Program Files\SAP\SAP Business One DI
API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
APOS Systems Inc. | Live Data Gateway User Guide
43
APOS Live Data Gateway
Database Type
Database File(s)
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
ucp.jar
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
APOS Systems Inc. | Live Data Gateway User Guide
44
APOS Live Data Gateway
Database Type
Database File(s)
Teradata
terajdbc4.jar
tdgssconfig.jar
6.
From the first step copy the connection configuration files exported from the Live Data Gateway Manager to
the ...\Service Deployed\LDG folder.
 Database Backend Method - LDG_Config.xml
 Non-Database Backend Method - DG_Datasource.xml and if applicable DG_View.xml
APOS Systems Inc. | Live Data Gateway User Guide
45
APOS Live Data Gateway
7.
Edit the LiveDataGateway.xml file. Update the <workingdirectory> node to be the path to the current
service folder. The <executable> node must also be updated to contain a valid path to java.exe. Save the
file.
Update to <workingdirectory>C:/Service Deployed/LDG</workingdirectory>
8.
When configuring for HTTP2 protocol and Tomcat uses Open JDK 8 or Java 8, the file tcnative-1.dll is
required and needs to be copied to the service deployed folder ...\Service Deployed\LDG\bin folder. This file
can be found in the …\Program Files\APOS\Live Data Gateway\LDG\WebApp\bin folder.
9.
Follow the steps outlined in SAML SSO Deployment when requiring the use of SAML SSO connections.
10. Edit the application.properties file and update the highlighted values. Be sure to remove the # symbol at
the start of each line inside the deployed service section. When using a SAML SSO Deployment the
samlsso.path must be updated with the correct URL. Save the file.
Field / Control
Description
logging.level.root=
Enter the logging level. By default this
value is set to error
samlsso.path=
Enter the full path to the SAML SSO
Deployment.
APOS Systems Inc. | Live Data Gateway User Guide
46
APOS Live Data Gateway
Field / Control
Description
odata.cache.expiry=
Remove the # to uncomment this
option and enter the expiry time when
using the OData Gateway service.
By default this is commented out (#)
and set to 3600.
oauth.proxy.host=
Enter the proxy host name when using
OAuth2 authentication with a proxy.
oauth.proxy.port=
Enter the proxy port number when
using OAuth2 authentication with a
proxy.
server.port=
Enter the SSL port for Tomcat
server.ssl.key-store-type=
Enter the certificate type
server.ssl.key-store-password=
Enter the certificate password
server.ssl.key-store=
Enter the keystore path and filename
where the certificate is located
server.ssl.key-alias=
Enter the certificate alias
security.require-ssl=
Enter true
server.http2.enabled=
Remove the # to uncomment this
option when HTTP2 protocol support is
desired.
By default this is commented out (#)
and set to true.
APOS Systems Inc. | Live Data Gateway User Guide
47
APOS Live Data Gateway
11. Edit the log4j2.xml file and update the log file name and location if desired. Create the c:\_applogs folder if
using the default settings.
12. Locate the ServiceStartStop.bat file, right-click and select to Run as administrator.
APOS Systems Inc. | Live Data Gateway User Guide
48
APOS Live Data Gateway
13. In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
14. Launch Windows Services and verify that the LDG service has been installed and is Running.
15. To check that the application has been deployed successfully and to verify the version number enter the
below URL in a browser window, updating the port number to reflect the one used in step 10 of this guide.
https://localhost:8486/About
16. The LDG service is now ready and can be accessed when creating a Live connection in SAC.
APOS Systems Inc. | Live Data Gateway User Guide
49
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying the service files. Begin by locating the deployed
service folder. In the following example the LDG service was deployed to the c:/Service Deployed/LDG folder location.
1.
To stop and uninstall the running service right-click on the ServiceStop.bat file and Run as administrator.
2.
Launch Windows Services and verify that the LDG service has been uninstalled and is no longer listed.
3.
Delete the file log4j.properties if it exists and you are updating to Version 2021.12.16 or higher.
4.
Make a backup copy of the below files in the deployed service folder so that if they are overwritten the
settings can easily be updated in the new files from the backed up versions.
 LiveDataGateway.xml
 application.properties
 log4j.properties (Versions prior to 2021.12.16)
 log4j2.xml (Version 2021.12.16 and above)
5.
Locate the LDG service files from the setup installed folder ...\Program Files\APOS\Live Data
Gateway\LDG\Service. Select any updated files to be copied to the deployed folder replacing any preexisting files.
6.
Copy the selected files to the deployed LDG folder.
7.
Update the LiveDataGateway.xml file. Update the <workingdirectory> node to be the path to the current
service folder. Save the file.
Update to <workingdirectory>C:/Service Deployed/LDG</workingdirectory>
APOS Systems Inc. | Live Data Gateway User Guide
50
APOS Live Data Gateway
8.
Edit the application.properties file and update highlighted values. When using a SAML SSO Deployment
the samlsso.path must be updated with the correct URL. Save the file.
Field / Control
Description
logging.level.root=
Enter the logging level. By default this
value is set to error
samlsso.path=
Enter the full path to the SAML SSO
Deployment.
oauth.proxy.host=
Enter the proxy host name when using
OAuth2 authentication with a proxy.
oauth.proxy.port=
Enter the proxy port number when
using OAuth2 authentication with a
proxy.
odata.cache.expiry=
Remove the # and enter the expiry time
when using the OData Gateway service.
By default this is commented out (#)
and set to 3600.
server.port=
Enter the SSL port for Tomcat
server.ssl.key-store-type=
Enter the certificate type
server.ssl.key-store-password=
Enter the certificate password
server.ssl.key-store=
Enter the keystore path and filename
where the certificate is located
server.ssl.key-alias=
Enter the certificate alias
security.require-ssl=
Enter true
APOS Systems Inc. | Live Data Gateway User Guide
51
APOS Live Data Gateway
APOS Systems Inc. | Live Data Gateway User Guide
52
APOS Live Data Gateway
9.
Edit the log4j2.xml file and update the log file name and location if desired.
APOS Systems Inc. | Live Data Gateway User Guide
53
APOS Live Data Gateway
10. Locate the ServiceStartStop.bat file, right-click and select to Run as administrator.
11. In the launched command window verify the installation and starting of the service and Press any key to
continue to exit.
12. Launch Windows Services and verify that the LDG service has been installed and is Running.
APOS Systems Inc. | Live Data Gateway User Guide
54
APOS Live Data Gateway
13. To check that the application has been deployed successfully and to verify the version number enter the
below URL in a browser window, updating the port number to reflect the deployment.
https://localhost:8481/About
14. The LDG service is now ready and can be accessed when creating a Live connection in SAC.
Multiple Deployments
Multiple LDG services can be deployed on different ports with different names. In addition to the configuration steps
for the First Time Deployment, the below must be done prior to starting the service:
1.
Edit the LiveDatGateway.xml file and modify the following tags and save the file.
 <id> - Assign a new service id
 <name> - Assign a new service name
 <description> - Assign a new service description
 <workingdirectory>- Enter the path to the new LDG deployed directory
2.
Edit the application.properties file and assign a new service port, save the file.
3.
Edit the ServiceStartStop.bat file and edit the below:
 “set_ServiceName” – assign its value to the same value given to the <name> in the LiveDataGateway.xml file.
 “| find “ – modify the value that follows the word find with the <name> value entered in the
LiveDateGateway.xml file.
4.
Optionally edit the log4j2.xml file and modify the file name of the error log file.
5.
Start the service.
APOS Systems Inc. | Live Data Gateway User Guide
55
APOS Live Data Gateway
Web Admin Tool Deployment
The Web Admin Tool is a flexible application that allows users to create Views for relational database connections.
The web application is deployed to either tomcat (version 8 min) or as a service and used to define views via the Web
UI. This Web UI is supported when LDG is configured using the Database Method as a backend. The Non-Database
backend Method is not supported with this feature.
The Web Admin Tool supports 8 languages including English, German, Spanish, French, Hebrew, Brazilian Portuguese,
Romanian and Russian.
APOS Web Admin Tool supports the following methods of deployment.


Web Application – Deploy to a Tomcat server.
Independent Service – Deploy as an independent service.
Web Application
When deploying the web application to tomcat follow the steps outlined below:


First Time Deployment
Re-Deployment
First Time Deployment
The following must be completed prior to using the Web UI:
1.
Edit the server.xml file which is located in the folder …\Tomcat 8.5\conf.
2.
In the server.xml file locate the port number that has been assigned for SSL and ensure that the yellow
highlighted areas are modified to match the client system. This example also includes the addition of HTTP2
protocol support.
The following line must be added within the definition of the connector describing the SSL configuration
since HTTP2 is supported only for HTTPS.
<UpgradeProtocol className=”org.apache.coyote.http2.Http2Protocol”/>
3.
Close and Save the server.xml file.
4.
When configuring for Tomcat for HTTP2 protocol and Open JDK 8 or Java 8 has been used, the file tcnative-1.dll
is required and needs to be copied to the …\Tomcat\bin folder. This file can be found in the …\Program
Files\APOS\Live Data Gateway\Web Admin Tool\WebApp\bin folder.
5.
Locate the APOSAdminTool.war file from the installed folder usually located in
…\APOS\Live Data Gateway\Web Admin Tool\WebApp folder.
6.
Copy the APOSAdminTool.war file to the Tomcat installed folder …\Tomcat\webapps.
APOS Systems Inc. | Live Data Gateway User Guide
56
APOS Live Data Gateway
7.
Restart Tomcat or wait until the APOSAdminTool folder is generated in the webapps folder.
8.
To check that the application has been deployed successfully and to verify the version number enter the below
URL, updating the port number as needed.
http://localhost:8443/APOSAdminTool/web/About
9.
When creating views based upon relational database, the database jar files must be deployed to the
…\webapps\APOSAdminTool\WEB-INF\lib folder of the web application.
Database Type
Amazon EMR
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the lib folder.
APOS Systems Inc. | Live Data Gateway User Guide
57
APOS Live Data Gateway
Database Type
Database File(s)
CDATA Drivers
APOS will supply a file named
APOS_CData_Drivers.zip that includes the
necessary dll and jar files to be manually copied to
the following locations:



Cloudera Hive
The dll files need to be copied to the LDG
Admin folder where the Admin exe files are
installed.
The jar files need to be copied to

The LDG web application in the deployed
WEB-INF\lib folder

The APOSAdminTool web application in
the deployed WEB-INF\lib folder

The ConnectionTest_lib folder that is
found with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from
the SAP Business One installation folder
…\Program Files\SAP\SAP Business One DI
API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
APOS Systems Inc. | Live Data Gateway User Guide
58
APOS Live Data Gateway
Database Type
Database File(s)
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying
to the lib folder.
Microsoft SQL
Server
sqljdbc4.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
mssql-jdbc-9.4.1.jre8.jar
ucp.jar
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection
option.
APOS Systems Inc. | Live Data Gateway User Guide
59
APOS Live Data Gateway
Database Type
Database File(s)
Redshift
RedshiftJDBC42-1.2.10.1009.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection
option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
Teradata
terajdbc4.jar
tdgssconfig.jar
10. If installing the Oracle Exadata database connection copy the client credential files keystore.jks, tnsnames.ora
and truststore.jks to the deployed …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes folder.
11. Proceed to the Live Data Gateway Manager and create a relational database connection.
 Select File - Apply Freehand SQL flag to enable the ability to create Freehand SQL views using both the
desktop Admin UI and the Admin Tool Web UI.
 Select the File - Approve Users for Web UI menu option to enable the ability to create views using the Web
UI.
12. When the connections have been configured from the previous setup, export the LDG_Config.xml file and copy
to the …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes folder of the web application.
13. Edit the application.properties file that is located in the deployed folder
…\Tomcat\webapps\APOSAdminTool\WEB-INF\classes. If enabling HTTP2 uncomment the line
#server.http2.enabled=true by removing the pound (#) at the beginning of the line. Additionally set the values
if deploying SAML SSO or the OData. Save the file once complete.
APOS Systems Inc. | Live Data Gateway User Guide
60
APOS Live Data Gateway
Field / Control
Description
logging.level.root=
Enter the logging type. Error is the
default value.
samlsso.path=
Enter the fully qualified URL path of the
SAML SSO deployment.
odata.cache.expiry=
Enter value for the cache expiry when
deploying the Odata Gateway service.
By default this is commented out and
the value is set to 3600.
server.port=
Used when deployed as an Independent
Service.
Enter an available SSL port for Tomcat
server.ssl.key-store-type=
Used when deployed as an Independent
Service.,
Enter the certificate type
server.ssl.key-store-password=
Used when deployed as an Independent
Service.
Enter the certificate password
server.ssl.key-store=
Used when deployed as an Independent
Service.
Enter the keystore path and filename
where the certificate is located
server.ssl.key-alias=
Used when deployed as an Independent
Service.
Enter the certificate alias
security.require-ssl=
Used when deployed as an Independent
Service.
Enter true
server.http2.enabled=
Enter true when tomcat has been
configured for HTTP2 protocol. By
default this line has been commented
out.
14. Restart Tomcat.
APOS Systems Inc. | Live Data Gateway User Guide
61
APOS Live Data Gateway
15. Follow the steps outlined in Admin Tool Web UI to create/edit views.
APOS Systems Inc. | Live Data Gateway User Guide
62
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying to the tomcat web application folder:
1.
Ensure that you backup the following files from their webapps folder location.
 LDG_Config.xml is located in …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes
 application.properties is located in …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes
 Database jar files are located in …\Tomcat\webapps\ APOSAdminTool \WEB-INF\lib
2.
Go to the folder …\Tomcat\webapps and delete the APOSAdminTool.war file. Wait for the APOSAdminTool
folder to be removed from the …\Tomcat\webapps folder.
3.
Locate the APOSAdminTool.war file from the installed folder usually located in
…\APOS\Live Data Gateway\Web Admin Tool\WebApp\
4.
Copy the APOSAdminTool.war file to the Tomcat installed folder …\Tomcat\webapps.
5.
Restart Tomcat or wait until the APOSAdminTool folder is generated in the webapps folder.
6.
To check that the application has been deployed successfully and to verify the version number enter the below
URL updating the port number to reflect the web app deployment.
http://localhost:8443/APOSAdminTool/web/About
7.
Copy backed up files from Step 1 from their backup location to the Admin Tool deployed folders.
 LDG_Config.xml copied to …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes
 Database jar copied to …\Tomcat\webapps\APOSAdminTool\WEB-INF\lib
 application.properties copied to …\Tomcat\webapps\APOSAdminTool\WEB-INF\classes
APOS Systems Inc. | Live Data Gateway User Guide
63
APOS Live Data Gateway
8.
If installing the Oracle Exadata database connection copy the client credential files keystore.jks, tnsnames.ora
and truststore.jks to the deployed …\Tomcat\webapps\ APOSAdminTool\WEB-INF\classes folder.
9.
Restart Tomcat.
APOS Systems Inc. | Live Data Gateway User Guide
64
APOS Live Data Gateway
Independent Service
Deploy the Web Admin as an independent service. The files can be found in the ...\Program Files\APOS\Live Data
Gateway\Web Admin Tool\Service folder.
When deploying the independent service follow the steps outlined below:


First Time Deployment
Re-Deployment
First Time Deployment
1.
Launch the Live Data Gateway Manager and create the database connections and views.
2.
Create a new folder that will contain the service deployment files. In this example a folder named ‘Service
Deployed’ was created with a subfolder called ‘Web Admin’.
3.
Locate the Admin Tool service files found in the installed folder ...\Program Files\APOS\Live Data
Gateway\Web Admin Tool\Service. Select all files found within including the bin and lib folders.
APOS Systems Inc. | Live Data Gateway User Guide
65
APOS Live Data Gateway
4.
Copy the selected files, along with the bin and lib folders, to the newly created service deployed Web Admin
folder.
5.
Copy the required database jar files to the newly created Service Deployed\Web Admin\lib folder from the
previous step.
Database Type
Amazon EMR
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
APOS Systems Inc. | Live Data Gateway User Guide
66
APOS Live Data Gateway
Database Type
Database File(s)
CDATA Drivers
APOS will supply a file named
APOS_CData_Drivers.zip that includes the necessary
dll and jar files to be manually copied to the
following locations:



Cloudera Hive
The dll files need to be copied to the LDG
Admin folder where the Admin exe files are
installed.
The jar files need to be copied to

The LDG deployed \lib folder

The APOSAdminTool deployed \lib folder

The ConnectionTest_lib folder that is found
with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from
the SAP Business One installation folder
…\Program Files\SAP\SAP Business One DI
API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
APOS Systems Inc. | Live Data Gateway User Guide
67
APOS Live Data Gateway
Database Type
Database File(s)
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying to
the lib folder.
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
ucp.jar
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
APOS Systems Inc. | Live Data Gateway User Guide
68
APOS Live Data Gateway
Database Type
Database File(s)
Teradata
terajdbc4.jar
tdgssconfig.jar
6.
From the first step copy the connection configuration files exported from the Live Data Gateway Manager to
the ...\Service Deployed\Web Admin folder.
 Database Backend Method - Uses the LDG_Config.xml file and is the recommended method.
 Non-Database Backend Method - DG_Datasource.xml and if applicable DG_View.xml. This method
has been deprecated.
APOS Systems Inc. | Live Data Gateway User Guide
69
APOS Live Data Gateway
7.
Edit the APOSAdminTool.xml file. Update the <workingdirectory> node to be the path to the current
service folder. The <executable> node must also be updated to contain a valid path to java.exe. Save the
file.
Update to <workingdirectory>C:/Service Deployed/LDG</workingdirectory>
8.
Edit the application.properties file and uncomment and update the port and SSL lines as well as any other
settings that may be required. Save the file.
Field / Control
Description
logging.level.root=
Enter the logging type. Error is the
default value.
samlsso.path=
Enter the fully qualified URL path of the
SAML SSO deployment.
odata.cache.expiry=
Enter value for the cache expiry when
deploying the Odata Gateway service.
By default this is commented out and
the value is set to 3600.
oauth.proxy.host=
Enter the proxy host name when using
OAuth2 authentication with a proxy.
APOS Systems Inc. | Live Data Gateway User Guide
70
APOS Live Data Gateway
Field / Control
Description
oauth.proxy.port=
Enter the proxy port number when
using OAuth2 authentication with a
proxy.
server.port=
Enter an available SSL port for Tomcat.
Used when deployed as an Independent
Service.
server.ssl.key-store-type=
Enter the certificate type.
Used when deployed as an Independent
Service.
server.ssl.key-store-password=
Enter the certificate password.
Used when deployed as an Independent
Service.
server.ssl.key-store=
Enter the keystore path and filename
where the certificate is located.
Used when deployed as an Independent
Service.
server.ssl.key-alias=
Enter the certificate alias.
Used when deployed as an Independent
Service.
security.require-ssl=
Enter true.
Used when deployed as an Independent
Service.
server.http2.enabled=
Enter true when tomcat has been
configured for HTTP2 protocol. By
default this line has been commented
out.
APOS Systems Inc. | Live Data Gateway User Guide
71
APOS Live Data Gateway
9.
Edit the log4j2.xml file and update the log file name and location if desired. Create the c:\_applogs folder if
it does not exist when using the default settings.
10. Locate the ServiceStartStop.bat file, right-click and select to Run as administrator.
APOS Systems Inc. | Live Data Gateway User Guide
72
APOS Live Data Gateway
11. In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
12. Launch Windows Services and verify that the Web Admin service has been installed and is Running.
APOS Systems Inc. | Live Data Gateway User Guide
73
APOS Live Data Gateway
13. To check that the application has been deployed successfully and to verify the version number enter the
below URL in a browser window, updating the port number to reflect the deployment.
https://localhost:8491/web/About
14. The Web Admin service is now ready and can be accessed using the following URL in a browser window.
Update both the server name and port number to reflect the deployment when needed.
https://localhost:8491/web/index.html
15. Follow the steps outlined in the Admin Tool UI for more information on how to continue.
APOS Systems Inc. | Live Data Gateway User Guide
74
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying the service files. Begin by locating the deployed
service folder. In the following example the Web Admin service was deployed to the c:\Service Deployed\Web Admin
folder location.
1.
To stop and uninstall the running service right-click on the ServiceStop.bat file and select Run as
Administrator.
2.
Launch Windows Services and verify that the LDG service has been uninstalled and is no longer listed.
3.
Delete the file log4j.properties if it exists and you are updating to Version 2021.12.20 or higher.
4.
Make a backup copy of the below files in the deployed service folder so that if they are overwritten the
settings can easily be updated in the new files from the backed up versions.
 APOSAdminTool.xml
 application.properties
 log4j.properties (Versions prior to 2021.12.20)
 log4j2.xml (Version 2021.12.20 and above)
5.
Locate the Web Admin service files from the setup installed folder ...\Program Files\APOS\Live Data
Gateway\Web Admin Tool\Service. Select any updated files to be copied to the deployed folder replacing
any pre-existing files.
6.
Copy the selected files to the deployed Web Admin folder.
7.
Edit the APOSAdminTool.xml file. Update the <workingdirectory> node to be the path to the current
service folder. Save the file.
Update to <workingdirectory>C:/Service Deployed/Web Admin</workingdirectory>
APOS Systems Inc. | Live Data Gateway User Guide
75
APOS Live Data Gateway
8.
Edit the application.properties file and update the values from the backup file. Save the file.
Field / Control
Description
logging.level.root=
Enter the logging type. Error is the
default value.
samlsso.path=
Enter the fully qualified URL path of the
SAML SSO deployment.
odata.cache.expiry=
Enter value for the cache expiry when
deploying the Odata Gateway service.
By default this is commented out and
the value is set to 3600.
oauth.proxy.host=
Enter the proxy host name when using
OAuth2 authentication with a proxy.
oauth.proxy.port=
Enter the proxy port number when
using OAuth2 authentication with a
proxy.
server.port=
Enter an available SSL port for Tomcat.
Used when deployed as an Independent
Service.
server.ssl.key-store-type=
Enter the certificate type.
Used when deployed as an Independent
Service.
APOS Systems Inc. | Live Data Gateway User Guide
76
APOS Live Data Gateway
Field / Control
Description
server.ssl.key-store-password=
Enter the certificate password.
Used when deployed as an Independent
Service.
server.ssl.key-store=
Enter the keystore path and filename
where the certificate is located.
Used when deployed as an Independent
Service.
server.ssl.key-alias=
Enter the certificate alias.
Used when deployed as an Independent
Service.
security.require-ssl=
Enter true.
Used when deployed as an Independent
Service.
server.http2.enabled=
9.
Enter true when tomcat has been
configured for HTTP2 protocol. By
default this line has been commented
out.
Edit the log4j2.xml file and update the log file name and location if desired.
APOS Systems Inc. | Live Data Gateway User Guide
77
APOS Live Data Gateway
APOS Systems Inc. | Live Data Gateway User Guide
78
APOS Live Data Gateway
10. Locate the ServiceStartStop.bat file, right-click and select to Run as administrator.
11. In the launched command window verify the installation and starting of the service and Press any key to
continue to exit.
12. Launch Windows Services and verify that the Web Admin service has been installed and is Running.
APOS Systems Inc. | Live Data Gateway User Guide
79
APOS Live Data Gateway
13. To check that the application has been deployed successfully and to verify the version number enter the
below URL in a browser window, updating the port number to reflect the deployment.
https://localhost:8491/web/About
14. The Web Admin service is now ready and can be accessed using the following URL in a browser window.
Update both the server name and port number to reflect the deployment when needed.
https://localhost:8491/web/index.html
15. Follow the steps outlined in the Admin Tool UI for more information on how to use this UI
APOS Systems Inc. | Live Data Gateway User Guide
80
APOS Live Data Gateway
SAML SSO Deployment
The SAML SSO deployment requires the following prerequisites when selecting to create a connection using SAML
SSO:




Tomcat 8.5 min installed - CORS – SSO
Deployed saml2-sso web application configured to support SSL using the same certificate for both LDG and
Tomcat.
SAC is configured with SAML SSO.
SAML SSO does not support HTTP2 protocol so will fall back to HTTP1 instead.
The SAML SSO deployment is required when the following SSO SAML connection types are required:


IDENTITY PROVIDERS SSO – Level 2
IMPERSONATE SSO USER – Level 3
First Time Deployment
The following steps outline the deployment of the SAML SSO web application in an ADFS environment:
1.
Deploy and configure Live Data Gateway web application or service as usual.
2.
Locate the file called saml2-sso.war in the below installed folder. Once deployed this will be used to
manage the SAML communication.
…\Program Files\APOS\Live Data Gateway\LDG\WebApp
3.
Web Application Deployment and Tomcat using HTTP1 – When LDG is deployed as a web application in
Tomcat using HTTP1 protocol, the saml2-sso.war needs to be copied to the same directory as the
ROOT.war file where LDG is configured.
APOS Systems Inc. | Live Data Gateway User Guide
81
APOS Live Data Gateway
4.
Independent Service Deployment / HTTP2 Protocol - When LDG is deployed as a service or HTTP2
protocol is being used, the saml2-sso.war file needs to be to a Tomcat/webapp folder. Tomcat must be
configured to support SSL and the same certificate should be used for both the LDG service and Tomcat.
5.
Download the ADFS Metadata file by entering the following URL into a browser replacing the highlighted
yourdc and yourdomain.com values with those applicable with your environment.
https://yourdc.yourdomain.com/FederationMetadata/2007-06/FederationMetadata.xml
6.
Copy the downloaded FederationMetadata.xml file obtained by the previous step to the saml-sso web
application deployed folder …\saml2-sso\WEB-INF\classes\metadata
7.
Restart Tomcat.
8.
In the browser enter the following address URL replacing the highlighted SERVER and PORT values where
the saml2-sso web application is deployed.
https://SERVER:PORT/saml2-sso/saml/web/metadata
9.
Select (click on link) item with your server name from the Service Providers list (the one ending in
/saml/metadata).
APOS Systems Inc. | Live Data Gateway User Guide
82
APOS Live Data Gateway
10. At the bottom of the page select the Download entity metadata button and save to a document with
extension xml. This file will be used to configure the trust entry in the ADFS server.
APOS Systems Inc. | Live Data Gateway User Guide
83
APOS Live Data Gateway
11. In AD FS 2.0 Management Console, right click on Relying Party Trust and select Add Relying Party Trust
to start the wizard for this task.
12. Select Claim Aware and press Start.
APOS Systems Inc. | Live Data Gateway User Guide
84
APOS Live Data Gateway
13. Select Import data about the relying party from a file and select the metadata xml file created in Step 11.
Press Next.
14. The wizard may prompt that some content of metadata is not supported. You can safely ignore this warning.
Select Specify Display Name and enter a Display name.
APOS Systems Inc. | Live Data Gateway User Guide
85
APOS Live Data Gateway
15. Select Choose Access Control Policy and select Permit everyone.
16. Select Ready to Add Trust and verify that the Endpoints tab contains multiple endpoint values. If not, verify
that your metadata was generated with HTTPS protocol URLs. Press Next.
17.
Leave the Configure claims issuance policy for this application checkbox checked and select Finish to
complete the wizard.
18. On the panel displaying the list of Relying Party Trusts, right-click on the entry just added to select.
APOS Systems Inc. | Live Data Gateway User Guide
86
APOS Live Data Gateway
19. Select Edit Claim Insurance Policy.
20. Select Add Rule and choose Send LDAP Attributes as Claims. Press Next.
APOS Systems Inc. | Live Data Gateway User Guide
87
APOS Live Data Gateway
21. In the Choose Rule Type Step choose the below.
 Claim rule name - Enter NameID
 Attribute store - Select Active Directory.
 Mapping of LDAP Attributes to outgoing claim types:
o LDAP Attribute – Select SAM-Account-Name
o Outgoing Claim Type - Select NameID
*In ADFS 3.0 – The Name ID may need to be configured as a Pass Through claim
22. Press Finish to save the claim rules window.
APOS Systems Inc. | Live Data Gateway User Guide
88
APOS Live Data Gateway
23. Double click on the party trust just configured, select Advanced tab and change Secure hash algorithm to
SHA-1.
24.
The below URL can be used for testing purposes replacing the SERVER and PORT highlights with the
deployed web application values. The page should contain a radio button in the <<SAML Login>> tab or
some metadata description. The step is not required.
https://SERVER:PORT/saml2-sso
25. In Live Database Gateway Manager use the Database Connection Management tool to configure a
connection with either of the following SSO SAML options:
 IDENTITY PROVIDER SSO – Level 2
 IMPERSONATE SSO USER – Level 3
Re-Deployment
Follow the below steps if the SAML SSO web application needs to be re-deployed:
1.
Ensure that the FederationMetadata.xml file is backed up and copied elsewhere prior to removing the saml2sso.war file. The FederationMetadata.xml file can be found in the web application deployed folder
…\saml2-sso\WEB-INF\classes\metadata
2.
Web Application Deployment and Tomcat using HTTP1 - When LDG is deployed as a web application in
Tomcat using HTTP1 protocol go to the LDG deployed folder …\Tomcat\LDG and delete the saml2-sso.war file.
Wait for the saml2-sso folder to be removed.
 Locate the new updated saml2-sso.war file from the installed folder usually located in …\Program
Files\APOS\Live Data Gateway\LDG\WebApp
 Copy the saml2-sso.war file to the LDG deployed folder in Tomcat …\Tomcat\LDG
3.
Independent Service Deployment / HTTP2 Protocol - When LDG is deployed as a service or HTTP2 protocol is
being used, go to the Tomcats web application folder …\Tomcat\webapps and delete the saml2-sso.war file.
Wait for the saml2-sso folder to be removed from the folder.
 Locate the new updated saml2-sso.war file from the installed folder usually located in …\Program
Files\APOS\Live Data Gateway\LDG\WebApp
 Copy the saml2-sso.war file to the Tomcat installed folder …\Tomcat\webapps
4.
Restart Tomcat or wait until the saml2-sso folder is generated.
APOS Systems Inc. | Live Data Gateway User Guide
89
APOS Live Data Gateway
SSO2 Services Deployment
The SSO2 Services Deployment works with the Live Data Gateway Deployment and provides an alternative method
for handling user security when the IDENTITY PROVIDERS SSO – Level 2 option in the SSO Configuration tab is
selected for JDBC Generic connections. The following data sources are supported with this feature:



AWS Athena
AWS Redshift
Snowflake
The SSO2 Services is deployed as an Independent Service. A separate service must be deployed for Snowflake and
another service deployed for data sources that will work with IAM (Identity Access Management) on AWS (Amazon
Web Services) for Athena and Redshift. The same source files are used for each deployment however there are
separate properties to be enabled for each in deployment.

Snowflake SSO2 Service Deployment
o Create Snowflake Connection(s)
o Manage Users for SSO Services
o Assign Identity Provider users in connection
o Build Service Configuration
o Deploy SSO2 Service

AWS SSO2 Service Deployment
o Create Athena/Redshift Connection(s)
o Manage Users for SSO Services
o Assign Identity Provider users in connection
o Build Service Configuration
o Deploy SSO2 Service
APOS Systems Inc. | Live Data Gateway User Guide
90
APOS Live Data Gateway
Snowflake SSO2 Service Deployment
First Time Deployment
1.
Launch the Live Data Gateway Manager and create the Snowflake database connection. Enter the following
information in the Connection tab.
 Data Source – Select Database
 Database – Select JDBC Generic
 Database Name – Enter the Snowflake Database Name
 Connection String – Enter the jdbc Snowflake Connection String
 Driver Class – Enter the Snowflake Driver Class: net.snowflake.client.jdbc.SnowflakeDriver
APOS Systems Inc. | Live Data Gateway User Guide
91
APOS Live Data Gateway
2.
In the SSO Configuration tab select the Use SSO checkbox and IDENTITY PROVIDERS SSO from the
Authentication Method drop down. Press OK on the prompt to save the connection first before finishing
the configuration of this type of Authentication Method.
APOS Systems Inc. | Live Data Gateway User Guide
92
APOS Live Data Gateway
3.
Press Save to save the connection configuration.
4.
Populate the connection Unique Prefix and press the OK button.
APOS Systems Inc. | Live Data Gateway User Guide
93
APOS Live Data Gateway
5.
Once the connection creation is complete press OK on the dialog.
6.
Next select the File menu and Manage SSO Services – Manage Users for SSO Services.
APOS Systems Inc. | Live Data Gateway User Guide
94
APOS Live Data Gateway
7.
In the SSO User Management section select SNOWFLAKE from the Service Type drop down. Next add the
Snowflake User by pressing the +button.
8.
Enter the Snowflake User Name to be used for the SSO Service. Press Save to continue.
9.
Press OK on the Success dialog.
APOS Systems Inc. | Live Data Gateway User Guide
95
APOS Live Data Gateway
10. After adding all the desired Snowflake users, set the Key Pair Folder that will be used by the service. Browse
to the folder location that is accessible to the service. Press OK to select the folder.
APOS Systems Inc. | Live Data Gateway User Guide
96
APOS Live Data Gateway
11. Press Save Folder to complete the Key Pair Folder configuration.
12. Press OK on the Success dialog.
APOS Systems Inc. | Live Data Gateway User Guide
97
APOS Live Data Gateway
13. Select the Snowflake connection configured in the earlier steps and press Edit.
APOS Systems Inc. | Live Data Gateway User Guide
98
APOS Live Data Gateway
14. In the SSO Configuration tab select Key Pair (Snowflake) from the SSO Authentication Type drop down.
Next press Identity Providers SSO to assign the users.
APOS Systems Inc. | Live Data Gateway User Guide
99
APOS Live Data Gateway
15. To Associate the SAML/NTLM Users with the Snowflake database user press the + button.
16. In the Users Management form enter the SAML/NTLM User Name and press the Search button to select
the Snowflake users configured in a previous step.
APOS Systems Inc. | Live Data Gateway User Guide
100
APOS Live Data Gateway
17. Once the Snowflake SSO User Name has been selected press Save.
18. Press Yes to Confirm saving the new user.
19. Press OK on the Success dialog.
APOS Systems Inc. | Live Data Gateway User Guide
101
APOS Live Data Gateway
20. Continue and add any additional users, once complete press Exit.
APOS Systems Inc. | Live Data Gateway User Guide
102
APOS Live Data Gateway
21. To complete the connection confirmation press Save.
22. Press OK on the connection update dialog.
APOS Systems Inc. | Live Data Gateway User Guide
103
APOS Live Data Gateway
23. Next select the File menu and Manage SSO Services – Build Service Configuration.
24. Set the following Service DB Details. Once complete press Save.
 Connection Prefix – Select the Snowflake connection from the drop down that was configured in a
previous step.
 User Name – Enter the Snowflake User Name
 Password – Enter the Snowflake Password.
 Pair Key Folder – Verify that the Pair Key Folder is populated from the previous step.
APOS Systems Inc. | Live Data Gateway User Guide
104
APOS Live Data Gateway
25. Press OK on the Success dialog.
26. To complete press Close.
APOS Systems Inc. | Live Data Gateway User Guide
105
APOS Live Data Gateway
27. Complete the connection configuration process by selecting the Snowflake connection and pressing Build
Web Config.
28. Enter the following information and press Save to continue.
 Server Name – Enter the LDG database Server Name
 Database Name – Enter the LDG Database Name
 User Name – Enter the database User Name
 Password – Enter the database user Password
 Port – Enter the database Port
 User Only Selected Connections – Select the check box so that only the Snowflake connection is
configured.
APOS Systems Inc. | Live Data Gateway User Guide
106
APOS Live Data Gateway
29. Browse to a folder location where the LDG_Config.xml file will be saved and will be used both by the SSO2
Service and the LDG deployment.. Press Save to continue.
30. Press OK once the configuration file has been saved.
31. Press Close to continue.
APOS Systems Inc. | Live Data Gateway User Guide
107
APOS Live Data Gateway
32. Next, deploy the SSO2 Service by creating a new folder that will contain the service deployment files. In this
example a parent folder named ‘Deployed Services’ was created with a subfolder called ‘ldg-keyservice_Snowflake’.
33. Locate the SSO2 Service files found in the installed folder ...\Program Files\APOS\Live Data
Gateway\SSO2 Services\ldg-key-service. Select all files and found within the folder.
APOS Systems Inc. | Live Data Gateway User Guide
108
APOS Live Data Gateway
34. Copy the selected files to the newly created folder ldg-key-service_Snowflake.
35. From an earlier step copy the LDG_Config.xml connection configuration file exported from the Live Data
Gateway Manager to the ...\Deployed Services\ldg-key-service_Snowflake folder.
APOS Systems Inc. | Live Data Gateway User Guide
109
APOS Live Data Gateway
36. Edit the ldg-key-service.xml file and update the following notes. Once complete save the file.
 <id> - Update the service ID to be unique across the Windows system
 <name> - Update to a unique meaningful name
 <description> - Update the service description
 <workingdirectory> - Update to the folder where the service was deployed
<workingdirectory>C:/Program Files/APOS/Live Data Gateway/Deployed Services/ldg-keyservice_Snowflake</workingdirectory>
37. Edit the application.properties file and update the below. Save the file.
 logging.file.name – Update the location and name of the error log file.
 Uncomment the following lines by removing the pound (#) key at the beginning of the lines
o spring.profiles.active=quartz,snowflake
o ldg.keyservice.snowflake.admin-role-sql=use role accountadmin
 server.port - Update to an available port number on the Tomcat server.
APOS Systems Inc. | Live Data Gateway User Guide
110
APOS Live Data Gateway
38. Locate the ServiceStartInstall.bat file, right-click and select to Run as administrator.
39. In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
APOS Systems Inc. | Live Data Gateway User Guide
111
APOS Live Data Gateway
40. Launch Windows Services and verify that the SSO2 Key Service for Snowflake has been installed and is
Running.
41. The SSO2 Service is now ready to be used with the Live Data Gateway deployment.
APOS Systems Inc. | Live Data Gateway User Guide
112
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying the service files. Begin by locating the deployed
service folder. In the following example the SSO2 Services for Snowflake was deployed to the C:\Program
Files\APOS\Live Data Gateway\Deployed Services\ldg-key-service_Snowflake folder location.
1.
To stop and uninstall the running service right-click on the ServiceStopUninstall.bat file and select Run as
Administrator.
2.
Launch Windows Services and verify that the SSO2 service has been uninstalled and is no longer listed.
3.
Make a backup copy of the below files in the deployed service folder so that if they are overwritten the
settings can easily be updated from the backup of the files.
 ldg-key-service.xml
 application.properties
4.
Locate the SSO2 Services files from the setup installed folder ...\Program Files\APOS\Live Data
Gateway\SSO2 Services\ldg-key-service. Select any updated files to be copied to the deployed folder
replacing any pre-existing files.
5.
Copy the selected files to the deployed ldg-key-service_Snowflake folder.
6.
Edit the ldg-key-service.xml file. Update the following from the backup file. Save the file.
 <id> - Update the service ID to be unique across the Windows system
 <name> - Update to a unique meaningful name
 <workingdirectory> - Update to the folder where the service was deployed
<workingdirectory>C:/Program Files/APOS/Live Data Gateway/Deployed Services/ldg-keyservice_Snowflake</workingdirectory>
APOS Systems Inc. | Live Data Gateway User Guide
113
APOS Live Data Gateway
7.
Edit the application.properties file and update the values from the backup file. Save the file.
 logging.file.name – Update the location and name of the error log file.
 Uncomment the following lines by removing the pound (#) key at the beginning of the lines
o spring.profiles.active=quartz,snowflake
o ldg.keyservice.snowflake.admin-role-sql=use role accountadmin
 server.port - Update to an available port number on the Tomcat server.
8.
In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
9.
Launch Windows Services and verify that the SSO2 Service for Snowflake has been installed and is
Running.
10. The SSO2 Service is now ready to be used with the Live Data Gateway deployment.
APOS Systems Inc. | Live Data Gateway User Guide
114
APOS Live Data Gateway
AWS SSO2 Service Deployment
First Time Deployment
1.
Launch the Live Data Gateway Manager and create either the Athena or Redshift database connection.
Enter the following information in the Connection tab.
 Data Source – Select Database
 Database – Select JDBC Generic
 Connection String – Enter the jdbc AWS Connection String
o Redshift – jdbc:redshift:iam://
o Athena – jdbc:awsathena://
 Driver Class – Enter the Driver Class
o Redshift - com.amazon.redshift.jdbc.Driver
o Athena – com.simba.athena.jdbc.Driver
APOS Systems Inc. | Live Data Gateway User Guide
115
APOS Live Data Gateway
2.
In the SSO Configuration tab select the Use SSO checkbox and IDENTITY PROVIDERS SSO from the
Authentication Method drop down. Press OK on the prompt to save the connection first before finishing
the configuration of this type of Authentication Method.
APOS Systems Inc. | Live Data Gateway User Guide
116
APOS Live Data Gateway
3.
Press Save to save the connection configuration.
4.
Populate the connection Unique Prefix and press the OK button.
APOS Systems Inc. | Live Data Gateway User Guide
117
APOS Live Data Gateway
5.
Once the connection creation is complete press OK on the dialog.
6.
Next select the File menu and Manage SSO Services – Manage Users for SSO Services.
APOS Systems Inc. | Live Data Gateway User Guide
118
APOS Live Data Gateway
7.
In the SSO User Management section select AWS (IAM) from the Service Type drop down. Next add the
User by pressing the +button.
8.
Enter the AWS User Name to be used for the SSO Service. Press Save to continue.
9.
Press OK on the Success dialog and then press Exit to close the SSO User Management form.
APOS Systems Inc. | Live Data Gateway User Guide
119
APOS Live Data Gateway
10. Select the AWS connection configured in the earlier steps and press Edit and then Yes to begin.
APOS Systems Inc. | Live Data Gateway User Guide
120
APOS Live Data Gateway
11. In the SSO Configuration tab select Key Pair (Snowflake) from the SSO Authentication Type drop down.
Next press Identity Providers SSO to assign the users.
APOS Systems Inc. | Live Data Gateway User Guide
121
APOS Live Data Gateway
12. To Associate the SAML/NTLM Users with the SSO User and Database User press the + button.
13. In the Users Management form enter the SAML/NTLM User Name and press the Search button to select
the SSO User Name, configured in a previous step, and the Database User Name when configuring
Redshift. The Database User Name is not required when configuring an Athena connection. Press Save to
continue.
APOS Systems Inc. | Live Data Gateway User Guide
122
APOS Live Data Gateway
14. Press Yes to Confirm saving the new user.
15. Press OK on the Success dialog.
16. Continue and add any additional users, once complete press Exit.
APOS Systems Inc. | Live Data Gateway User Guide
123
APOS Live Data Gateway
17. To complete the connection confirmation press Save.
18. Press OK on the connection update dialog.
APOS Systems Inc. | Live Data Gateway User Guide
124
APOS Live Data Gateway
19. Next select the File menu and Manage SSO Services – Build Service Configuration. This step is to be
completed once for all AWS connections.
20. Set the following Service DB Details. Once complete press Save.
 Connection Prefix – Select the AWS connection from the drop down that was configured in a previous
step.
 User Name – Enter the AWS Access Key
 Password – Enter the AWS Secret Access Key
APOS Systems Inc. | Live Data Gateway User Guide
125
APOS Live Data Gateway
21. Press OK on the Success dialog.
22. To complete press Close.
APOS Systems Inc. | Live Data Gateway User Guide
126
APOS Live Data Gateway
23. Complete the connection configuration process by selecting the Snowflake connection and pressing Build
Web Config.
24. Enter the following information and press Save to continue.
 Server Name – Enter the LDG database Server Name
 Database Name – Enter the LDG Database Name
 User Name – Enter the database User Name
 Password – Enter the database user Password
 Port – Enter the database Port
 User Only Selected Connections – Select the check box so that only the AWS connection is configured.
APOS Systems Inc. | Live Data Gateway User Guide
127
APOS Live Data Gateway
25. Browse to a folder location where the LDG_Config.xml file will be saved and will be used both by the SSO2
Service and the LDG deployment.. Press Save to continue.
26. Press OK once the configuration file has been saved.
27. Press Close to continue.
APOS Systems Inc. | Live Data Gateway User Guide
128
APOS Live Data Gateway
28. Next, deploy the SSO2 Service by creating a new folder that will contain the service deployment files. In this
example a parent folder named ‘Deployed Services’ was created with a subfolder called ‘ldg-keyservice_AWS’.
29. Locate the SSO2 Service files found in the installed folder ...\Program Files\APOS\Live Data
Gateway\SSO2 Services\ldg-key-service. Select all files and found within the folder.
APOS Systems Inc. | Live Data Gateway User Guide
129
APOS Live Data Gateway
30. Copy the selected files to the newly created folder ldg-key-service_AWS.
31. From an earlier step copy the LDG_Config.xml connection configuration file exported from the Live Data
Gateway Manager to the ...\Deployed Services\ldg-key-service_AWS folder.
APOS Systems Inc. | Live Data Gateway User Guide
130
APOS Live Data Gateway
32. Edit the ldg-key-service.xml file and update the following notes. Once complete save the file.
 <id> - Update the service ID to be unique across the Windows system
 <name> - Update to a unique meaningful name
 <description> - Update the service description
 <workingdirectory> - Update to the folder where the service was deployed
<workingdirectory>C:/Program Files/APOS/Live Data Gateway/Deployed Services/ldg-keyservice_AWS</workingdirectory>
33. Edit the application.properties file and update the below. Save the file.
 logging.file.name – Update the location and name of the error log file.
 Uncomment the following lines by removing the pound (#) key at the beginning of the lines
o spring.profiles.active=quartz,aws
 server.port - Update to an available port number on the Tomcat server.
APOS Systems Inc. | Live Data Gateway User Guide
131
APOS Live Data Gateway
34. Locate the ServiceStartInstall.bat file, right-click and select to Run as administrator.
35. In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
APOS Systems Inc. | Live Data Gateway User Guide
132
APOS Live Data Gateway
36. Launch Windows Services and verify that the SSO2 Key Service for AWS has been installed and is Running.
37. The SSO2 Service is now ready to be used with the Live Data Gateway deployment.
APOS Systems Inc. | Live Data Gateway User Guide
133
APOS Live Data Gateway
Re-Deployment
If this is a re-deployment, follow the below steps when re-deploying the service files. Begin by locating the deployed
service folder. In the following example the SSO2 Services for Snowflake was deployed to the C:\Program
Files\APOS\Live Data Gateway\Deployed Services\ldg-key-service_AWS folder location.
11. To stop and uninstall the running service right-click on the ServiceStopUninstall.bat file and select Run as
Administrator.
12. Launch Windows Services and verify that the SSO2 service has been uninstalled and is no longer listed.
13. Make a backup copy of the below files in the deployed service folder so that if they are overwritten the
settings can easily be updated from the backup of the files.
 ldg-key-service.xml
 application.properties
14. Locate the SSO2 Services files from the setup installed folder ...\Program Files\APOS\Live Data
Gateway\SSO2 Services\ldg-key-service. Select any updated files to be copied to the deployed folder
replacing any pre-existing files.
15. Copy the selected files to the deployed ldg-key-service_AWS folder.
16. Edit the ldg-key-service.xml file. Update the following from the backup file. Save the file.
 <id> - Update the service ID to be unique across the Windows system
 <name> - Update to a unique meaningful name
 <description> - Update the service description
 <workingdirectory> - Update to the folder where the service was deployed
<workingdirectory>C:/Program Files/APOS/Live Data Gateway/Deployed Services/ldg-keyservice_AWS</workingdirectory>
APOS Systems Inc. | Live Data Gateway User Guide
134
APOS Live Data Gateway
17. Edit the application.properties file and update the values from the backup file. Save the file.
 logging.file.name – Update the location and name of the error log file.
 Uncomment the following lines by removing the pound (#) key at the beginning of the lines
o spring.profiles.active=quartz,aws
 server.port - Update to an available port number on the Tomcat server.
18. In the command window that launches, verify the installation and starting of the service and Press any key
to continue to exit.
19. Launch Windows Services and verify that the SSO2 Service for AWS has been installed and is Running.
20. The SSO2 Service is now ready to be used with the Live Data Gateway deployment.
APOS Systems Inc. | Live Data Gateway User Guide
135
APOS Live Data Gateway
Azure Analysis Service Gateway Deployment
Deploy the files to IIS (8 min) and configure to enable http(s) access to Azure Analysis Service. This service requires
the APOS Live Data Gateway license file. Once deployed use the LDG Manager to create connections to Azure and
deploy the configuration file(s) to the LDG web application.
The following steps must be completed when using APOS Azure Analysis Service Gateway to connect to Azure
Analysis Service:
1.
Install Visual C++ 2015 (64 bit)
2.
Install ADOMD.Net v15.0.2000.235 (included with the setup in the ADOMD folder)
3.
Ensure Microsoft .NET Framework v4.6.1 is installed.
4.
Install Web Server IIS 8 minimum with the following options selected:
 .NET Extensibility 3.5
 .NET Extensibility 4.6
 ASP.Net 3.5
 ASP.Net 4.6
 ISAPI Extensions
 ISAPI Filters
5.
Browse to the IIS installed folder inetpub/wwwroot and create a folder. In this example we will be creating
a folder named APOSASG.
6.
Locate the Azure Analysis Gateway files from the setup in …\Program Files\APOS\Live Database\Azure.
Copy all files and folders from here to the newly created APOSASG folder on the IIS server.
7.
Copy the APOS.lic file to the same APOSASG folder as above.
8.
Edit the Web.config file in the APOSASG folder. Locate the tag <add key=”Server” and update the value
within the double quotes to be the URL to the Azure Analysis Server. Once complete, save and close the file.
APOS Systems Inc. | Live Data Gateway User Guide
136
APOS Live Data Gateway
9.
In the IIS Manager go to Application Pools and choose the action Add Application Pool to create a new
one named APOSASG. Select OK to save.
10. Expand the Default Web Site and select the newly created folder named APOSASG from step 5. Right-click
and select Convert to Application.
11. Press the Select button to change the Application pool.
APOS Systems Inc. | Live Data Gateway User Guide
137
APOS Live Data Gateway
12. Select APOSASG from the Application pool drop down and press OK.
13. Verify that all settings are correct and press OK.
14. Right-click on the APOSASG application directory and double click on the Modules icon.
APOS Systems Inc. | Live Data Gateway User Guide
138
APOS Live Data Gateway
15. Select Add Managed Module from the right pane. Populate the Name and select the Type from the drop
down. Press OK
Name: APOSxmlaModule
Type: APOSxmlapump.APOSxmlaModule
16. Verify that the APOSxmlaModule now exists in the Modules listing.
17. Double click on the Authentication icon.
APOS Systems Inc. | Live Data Gateway User Guide
139
APOS Live Data Gateway
18. Set Anonymous Authentication to Enabled. Set all others to Disabled.
19. To enable https for your IIS server, go to the IIS root and double click on the Server Certificates icon. Select
the Import option from the right panel to import a valid certificate.
20. To map a port with a certificate select the Default Web site. Right-click and select Edit Binding and enter
the values according to your environment. Once complete press OK.
21. Restart the IIS server.
22. Open a browser window and enter the URL to validate that the APOS Azure Analysis Service Gateway is
running without errors.
http(s)://Servername/VirtualDirectory/apospump.aposxmla
APOS Systems Inc. | Live Data Gateway User Guide
140
APOS Live Data Gateway
23. The APOS Azure Analysis Gateway is now ready to be used as a connection and works similarly to using a
MSAS/SSAS data source. Launch the Live Data Gateway Manager and select to create a new connection.
Once the SSAS Data Source is selected and the Server URL is populated in the Connection tab, the
connection configuration file can be deployed to the LDG application. Additionally OLAP views are
supported and can be created using the View Wizard.
 Data Source: SSAS
 Server URL: http(s)://Servername/VirtualDirectory/apospump.aposxmla
APOS Systems Inc. | Live Data Gateway User Guide
141
APOS Live Data Gateway
Install Tomcat
If you require a version of Tomcat installed on the server, follow the below steps:
1.
Download and install a version of OpenJDK 8 or java 8 min.
2.
Once downloaded, select the exe file and click on Run as Administrator and click the Next button.
3.
Click I Agree to continue with the installation.
APOS Systems Inc. | Live Data Gateway User Guide
142
APOS Live Data Gateway
4.
Check the checkboxes as outlined below and click Next
5.
Change the ports, change the Windows service name to a unique name and create an Admin user and a
password and click Next
*** Important: Change the port numbers if there is another version of Tomcat installed using the default
ports.
APOS Systems Inc. | Live Data Gateway User Guide
143
APOS Live Data Gateway
6.
Select the location of OpenJDK 8 or Java 8 (minimum) . Click Next
7.
Click Install
APOS Systems Inc. | Live Data Gateway User Guide
144
APOS Live Data Gateway
8.
Check Run Apache Tomcat and click Finish.
9.
To test the installation, open a browser and type in http://localhost:8082
10. Continue with the installation of the Live Data Gateway web app.
APOS Systems Inc. | Live Data Gateway User Guide
145
APOS Live Data Gateway
Live Data Gateway Manager
When using Live Data Gateway Manager, follow the steps outlined below:
1.
Copy the APOS Live Data Gateway license file supplied by APOS to a folder that is accessible by this
application.
2.
Launch the Live Data Gateway Manager (APOSLiveDGManager.exe) application that can be found in the
folder …\Program Files\APOS\Live Data Gateway\Admin
3.
Once the Login screen is displayed choose one of two Login Options
3.

Connect using the backend database method - Recommended Method

This method supports CORS only web application deployments.

Create a connection to an installation of SQL Server with a database already configured.

Multiple data sources with the same type of security can share one single web application.

Once configured and deployed to the Tomcat server adding new connections and views with the
same type of security will not require accessing the Tomcat server.

Connection and view files created using the non-database method can be imported into the
database.

SQL databases must be configured with mixed authentication. Windows authentication is not
supported.

Connect using the non-database method – Deprecated Method

This method supports CORS web application deployments.

A web application must be deployed for each data source.

Does not support Date and time dimensions or Virtual Points.
Press Connect and proceed to one of the below options to continue with the configuration:
 Database Method - Recommended Method
 Non-Database Method
APOS Systems Inc. | Live Data Gateway User Guide
146
APOS Live Data Gateway
Database Method
The Database Method supports only CORS application deployments and is the recommended method for
deployment when configuring Live Data Gateway connections and views. Multiple data sources with the same
type of security can share one single deployment using a SQL Server backend database. A version of SQL Express
is included in the setup if required.
Once deployment has been configured and started, adding new connections and views with the same type of
security will not require accessing either the Tomcat server or deployment service. Connection and view XML
files created using the Non-Database Method can be imported into the database.
Live Data Gateway Login
The following example contains steps to begin using the Database Method. They include adding both SSAS
and MSQL connections to the same database and deploying the connection file to one web application.
1.
Select Connect using the backend database method option. Press Add to create a new Connection to the
Live Data Gateway SQL Server database.
2.
The Database Connection Management form will launch to configure the Database Login Details.
Populate the below details and press Save.








Connection Name – Fill in a unique connection name to the LDG SQL database.
Server Name – Fill in the SQL Server name
Database Name – Fill in the Database Name to the LDG database. This database must be created prior
to this step.
User Name- Fill in the user name that can access the LDG database.
Password – Fill in the password for the user name.
Port – Fill in the port to the SQL Server database
SQL Authentication/Windows Authentication – Choose the authentication type for the user name
entered.
Test – Validate the Database Login Details by selecting the Test button.
APOS Systems Inc. | Live Data Gateway User Guide
147
APOS Live Data Gateway
3.
Select OK to confirm the successfully saved connection information.
APOS Systems Inc. | Live Data Gateway User Guide
148
APOS Live Data Gateway
4.
With the newly configured connection selected in the Available Connections drop down, fill in both the
database User Name and Password and press Connect.
5.
If the LDG tables do not exist within the selected database select Yes when prompted to add them.
6.
Once the tables and indexes have been created successfully press OK.
APOS Systems Inc. | Live Data Gateway User Guide
149
APOS Live Data Gateway
7.
The Connection Management form will be launched to begin adding connections to databases for the SAC
stories.
8.
Begin by selecting the File – Configuration menu selection to enter some required information to continue.
APOS Systems Inc. | Live Data Gateway User Guide
150
APOS Live Data Gateway
9.
Fill in the configuration information and press Save once complete.




Licence – Browse to the location of the supplied APOS.lic file verifying that the license is valid.
Java Path – Browse to the location of Java OpenJDK 8 supplied with this application.
New SAC Tenants - Fill in the SAC Tenant URL. Multiple URLS must be separated by a comma (,).
Add – Press Add to save the New SAC Tenants to the Existing Tenants drop down.
10. Press Save for the once the tenant(s) have been added successfully to save the rest of the configuration
information.
APOS Systems Inc. | Live Data Gateway User Guide
151
APOS Live Data Gateway
11. Within the Connection Management form press the Add button to begin adding database connections for
the SAC stories.
APOS Systems Inc. | Live Data Gateway User Guide
152
APOS Live Data Gateway
12. The Live Data Gateway Admin form will launch.
13. Select the Connections tab and choose SSAS from the Data Source drop down.
APOS Systems Inc. | Live Data Gateway User Guide
153
APOS Live Data Gateway
14. Fill in the SSAS Server URL information.
15. Click Test URL to validate the Server URL entered.
16. Once the Test URL results in a successful message click OK. Press Save to store the connection in the LDG
database.
APOS Systems Inc. | Live Data Gateway User Guide
154
APOS Live Data Gateway
17. Fill in the Connection Description Details ensuring that a Unique Prefix name is assigned to the
connection. Press OK.
18. Once the connection has been completed successfully press OK and verify that it is now in the Available
Connection list.
APOS Systems Inc. | Live Data Gateway User Guide
155
APOS Live Data Gateway
19. Within the Connection Management form press the Add button to continue adding an additional MSQL
database connection.
20. The Live Data Gateway Admin form will launch.
21. Select the Connections tab and choose Database from the Data Source drop down. Select the Database
drop down and choose Microsoft SQL Server from the list.
APOS Systems Inc. | Live Data Gateway User Guide
156
APOS Live Data Gateway
22. Fill in the Host:Port and Database Name information.
23. Click Test Connection to validate the Database Connection information entered.
24. Enter the Database Login Credentials and click OK.
25. Press OK once the Test Connection has been successfully completed..
APOS Systems Inc. | Live Data Gateway User Guide
157
APOS Live Data Gateway
26. If the database tables contain fields that are Date/Time type and datetime hierarchies or GIS Virtual Points
are desired in SAC, select the Date/Time and DB Functions tab and verify the entry of the Date Time and
DB Functions prior to saving the connection.
27. Press Save to store the connection in the LDG database.
28. Fill in the Connection Description Details ensuring that a Unique Prefix name is assigned to the
connection. This prefix must be unique to all connections saved to the LDG database. Select the option to
Support Freehand SQL if desired. Press OK.
APOS Systems Inc. | Live Data Gateway User Guide
158
APOS Live Data Gateway
29. Once the connection has been completed successfully press OK and verify that it is now in the Available
Connection list.
30. Next measures and dimensions must be selected for the SQL database connection so at least one view
must be created. Select the desired SQL data source row and press Manage Views.



SSAS – Views can be created for SSAS connections to limit the number of dimensions and measures
that can be viewed in SAC. Once a SSAS connection has associated Views assigned the regular SSAS
cubes will not be shown. The SSAS chapter in the View Wizard section of the Live Data Gateway
Reference contains more information on creating views for SSAS connections.
BW –Views can be created for BW connections to limit the number of dimensions and measures that
can be viewed in SAC. Once a BW connection has associated Views assigned the regular BW Cubes or
Bex Queries will not be shown in SAC during the Model creation. The BW chapter in the View Wizard
section of the Live Data Gateway Reference contains more information on creating views for BW
connections.
Universes – Views can be created for Universes connections to limit the number of dimensions and
measures that can be viewed in SAC. Once a Universe connection has associated Views assigned the
universes will not be shown. The Universes chapter in the View Wizard section of the Live Data Gateway
Reference contains more information on creating views for Universe connections.
APOS Systems Inc. | Live Data Gateway User Guide
159
APOS Live Data Gateway
31. The View Management form will launch to create and maintain views. Select the Semantic Layer View
Management tab and press Add to begin configuring the view.
Note: The APOS Semantic Layer views are designed to describe only Star or Snowflake data structures. This
guarantees that the end user can choose any measure and dimension combination and they will all be valid.
If you have to use other structures you will wither need to use a freehand SQL view or you can wrap those
structures in a database view and bring them into the semantic layer view. You should not have multiple fact
tables in a semantic layer view as a dimension might need to be joined to both creating a bad join. Multiple
fact tables need to be joined at the database level in a database view so that the database view can be used
as a single fact table in the semantic layer view.
The idea behind a semantic layer is to obfuscate the complex data structure of the database. We do not want
to create a situation in which the user needs to know not to choose certain fields together because it will
cause the joins not to work. All the measures and dimensions in a semantic layer view must be relatable. If
they are not they need to be separated into separate views.
APOS Systems Inc. | Live Data Gateway User Guide
160
APOS Live Data Gateway
32. The View Wizard form will launch to create the view.



Enter the User and Password to connect to the database.
When creating new views enter a unique View Name. This view name must be unique to all views
created for all database connections in the LDG database. A random unique View Name is assigned by
default but this can be updated to another value.
Enter the 64 bit ODBC connection using the relevant installed client when connecting to one of the
below databases:

SybaseIQ

Sybase SQL Anywhere

Oracle Exadata

Denodo

HANA

Cloudera Impala

Cloudera Hive

Hortonworks Hive

BigQuery
33. Click Next.
APOS Systems Inc. | Live Data Gateway User Guide
161
APOS Live Data Gateway
34. Click on the Load Table Schema(s) button to load all tables and fields available for selection contained
within each schema.
35. Expand the tables and click on the column name to select the fields you want in your view.


To see a summary of your selected columns click on the button refresh located in the middle.
It is required to have at least one numeric column to be used as a measure.
APOS Systems Inc. | Live Data Gateway User Guide
162
APOS Live Data Gateway
36. Click on Define Time Dimensions to begin assigning any date time fields in the database to Time
Definitions if datetime hierarchies are desired.
37. Click on the Add (+) button to begin assigning the database field to a time definition.
APOS Systems Inc. | Live Data Gateway User Guide
163
APOS Live Data Gateway
38. Populate a unique Time Dimension ID, Name and select the Database Field from the drop down. Next
select the Time Definition to be applied. Click on Apply to add the Time Dimension to the list.
39. Repeat the above step for as many Time Dimensions that are required. Click Close to finish.
APOS Systems Inc. | Live Data Gateway User Guide
164
APOS Live Data Gateway
40. Click Next to continue.
41. Check at least one row in the column Is Measure to be used as a measure.


You can assign names to the measure in column Measure Name.
When checkbox Assign Default Names For Measures, the names of the original columns will be assign
as names to all the measures with no name.
APOS Systems Inc. | Live Data Gateway User Guide
165
APOS Live Data Gateway
42. Click Next.
43. All the columns not configured as measure will appear in this screen. Assign names to them in Dimension
Name column. Use Dimension Group column to group them together inside the xml file. Any Time
Dimension configurations will be located at the end of the dimension list. The names and IDs for these have
already been assigned so cannot be changed here.
44. Click Next.
APOS Systems Inc. | Live Data Gateway User Guide
166
APOS Live Data Gateway
45. When working with multiple tables, a relation between tables must be defined.


Click Get Relationships From Database to get the existing relations established in the database. If
relations cannot be established, add them manually.
Click on Add New Row to add a new row to the grid to define a new relationship.
46. Click Validate to confirm that the entered relationships are valid.
47. Click Finish. It will go to the next page if all the tables can be associated.
APOS Systems Inc. | Live Data Gateway User Guide
167
APOS Live Data Gateway
48. Click Create New View definition button to generate the XML for the view. Press Save.
49. The Unique Prefix, View Name and Description will be pre-populated but can be updated. Ensure that the
entered Unique Prefix and View Name are unique across all views contained within the current LDG
database. Press OK to save.
APOS Systems Inc. | Live Data Gateway User Guide
168
APOS Live Data Gateway
50. Press OK once the view has been saved successfully and verify that the new view now exists in the view
listing. Additional views can be configured and saved by following the previous steps if desired.
51. Once all views have been configured and saved return to the Connection Management form by pressing
the Close button.
APOS Systems Inc. | Live Data Gateway User Guide
169
APOS Live Data Gateway
52. Once all connections and views have been configured create the LDG_Config.xml file to be deployed to the
web application by selecting Build Web Config.
53. Enter the database credentials connecting to the LDG backend database selected when logging into the Live
Data Gateway Manager. Validate the information by pressing the Test Connection button.
54. Press OK once a successful connection has been made. Press the Save button to save the LDG_Config.xml
file to a folder location.
APOS Systems Inc. | Live Data Gateway User Guide
170
APOS Live Data Gateway
55. Browse to a desired folder location and save the LDG_Config.xml file by pressing the Save button.
56. Once the LDG_Config.xml file has been saved successfully copy the file to the deployed application folder.
APOS Systems Inc. | Live Data Gateway User Guide
171
APOS Live Data Gateway
Live Data Gateway Deployment
Save the LDG_Config.xml file created by the Live Data Gateway Manager using the Database Method to the
LDG Deployment.

CORS – Using CORS to connect to SAC

CORS – SSO – Using CORS connect SAC SSO with Kerberos/ADFS and SAML SSO
CORS
Use CORS to connect to SAC.
1.
Copy the connection LDG_Config.xml file from the folder where it was saved. In this example it was
saved in the …Program Files\Live Data Gateway\Admin\WebConfig folder and will be deployed the web
application …\Tomcat 8\<Service name>\ROOT\WEB-INF\classes folder.
2.
Ensure that the require database jar files have been copied to the deployed web application …\Tomcat
8\<MSSQL>\ROOT\WEB-INF\lib folder.
3.
Restart Tomcat
4.
Proceed to using SAC with CORS.
APOS Systems Inc. | Live Data Gateway User Guide
172
APOS Live Data Gateway
CORS – SSO
Using CORS connect SAC SSO with Kerberos/ADFS and SAML SSO to the below live data sources after
following the steps outlined in the Database Method.
Kerberos/ADFS using the following database connections:




Microsoft SQL Server
SSAS
Oracle
Denodo
SAML SSO using the following database connection:

Microsoft SQL Server
1.
Copy the connection LDG_Config.xml file from the folder where it was saved. In this example it was
saved in the …Program Files\Live Data Gateway\Admin\WebConfig folder and will be deployed the web
application …\Tomcat 8\<Service name>\ROOT\WEB-INF\classes folder.
2.
Copy the required database jar file for the database connection type to the deployed web application
…\Tomcat 8\<MSSQL>\ROOT\WEB-INF\lib folder.
Database Type
Database File(s)
Oracle
ojdbc8.jar
ucp.jar
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
Denodo
Denodo-vdp-jdbcdriver.jar
3.
When selecting to use SAML SSO ensure that the SAML SSO web application has been deployed.
4.
Restart Tomcat.
5. Proceed to using SAC SSO using CORS – SAML Single Sign On.
APOS Systems Inc. | Live Data Gateway User Guide
173
APOS Live Data Gateway
Admin Tool Deployment
Save the LDG_Config.xml file created by the Live Data Gateway Manager using the Database Method to the
Admin Tool Deployment.
1.
Copy the connection LDG_Config.xml file from the folder where it was saved. In this example it was saved
in the …Program Files\Live Data Gateway\Admin\WebConfig folder and will be deployed the web application
…\Tomcat\webapps\APOSAdminTool\WEB-INF\classes folder.
2.
Ensure that the required database jar files have been copied to the deployed web application …\Tomcat
8\webapps\APOSAdminTool\WEB-INF\lib folder.
3.
Restart Tomcat.
4.
When the Admin Tool is deployment as a web application to Tomcat, enter the below URL to begin using the
Web UI to create views for relational databases.
http://localhost/8443/APOSAdminTool/web/index.html
APOS Systems Inc. | Live Data Gateway User Guide
174
APOS Live Data Gateway
5.
Using the database credentials log into the connection that was created using the Live Data Gateway
Manager. Enter the User Name, Password and select the Connection configured for freehand SQL from
the drop down. Press Login
6.
After a successful login, choose the view option for the type of view to be created or updated. The following
example outlines the creation of a Freehand SQL view based upon a SQL connection. Continue in this screen
by selecting the Freehand SQL button.
7.
The Listing Views page will contain any freehand SQL views created by either the Live Data Gateway
Manager or the Web UI. Press New View to create a view.
APOS Systems Inc. | Live Data Gateway User Guide
175
APOS Live Data Gateway
8.
When creating a new view enter the View Prefix, View Name and Description if desired. Select the Global
Access check box so that all users can access the view when creating the Model in SAC using LDG.
9.
Scroll down on the page and create the SQL statement in the text area. The fields and tables can be
dragged and dropped from the tree view to the text area. Press Run Sample to validate the select
statement.
APOS Systems Inc. | Live Data Gateway User Guide
176
APOS Live Data Gateway
10. Scroll down on the page and verify that the Sample data is displayed validating the select statement.
11. If Time Dimensions were configured in the connection, press <> New Time Dimension and assign a Time
Definitions to any of the Date/Time fields in the drop down. Make sure to assign a unique Time
Dimension ID and Name.
12. Set at least one Measure and its Aggregation from the drop down. Press Save.
13. Once saved successfully press OK.
APOS Systems Inc. | Live Data Gateway User Guide
177
APOS Live Data Gateway
14. Confirm that the newly created view is listed on the page. It is ready to be accessed when creating Models in
SAC using LDG. Views created using the Web UI are also listed in either the Freehand SQL Views or
Semantic Layers Views View Management tab of the Live Data Gateway Manager.
The Access permissions can be further defined using the Share the View icon found within the Action section
on the page.
15. Follow the below links for more information on the creation of each view type using the Web Admin UI:



Freehand SQL Views - Configure Freehand SQL views based on relational databases.
Semantic Layer Views - Configure Semantic Layer views based on relational databases.
Stored Procedure Views – Configure views based upon a MS SQL Server stored procedure.
16. Proceed to using SAC with CORS.
SAP Analytics Cloud (SAC)
Use APOS Live Data Gateway to connect to SAP Analytics Cloud using one of the methods outlined below. Using
CORS is the preferred method for creating the live connections.

CORS - Configure tomcat to use CORS to connect the Live Data Gateway Web App with SAC when creating
Live Connections.

Configure a Connection Inside SAC – Using CORS connect to SAC and create a Direct Live Data
Connection.

CORS - SSO – Create SAC live connections using either of the below Authentication Methods to create Live
Data Gateway SSO Level 1, Level 2 or Level 3 connections.

SAML Single Sign On

None
CORS
Ensure that Tomcat or the Service Deployment have been configured for SSL prior to beginning the configuration
and Live Data Gateway web has been deployed using one of the two methods previously mentioned.
APOS Systems Inc. | Live Data Gateway User Guide
178
APOS Live Data Gateway
Configure a Connection within SAC
Once CORS and the Live Data Gateway Web applications have been configured, log into SAP Analytics Cloud and
using the connection configured in the Live Data Gateway Manager using the Database Method, create a live
connection.
1.
Go to the Chrome browser and enter your SAC URL.
2.
When prompted enter your login credentials to SAC.
3.
Once logged in select Connection from the side panel.
APOS Systems Inc. | Live Data Gateway User Guide
179
APOS Live Data Gateway
4.
Click on the + icon located on the upper right panel and select Connect to Live Data and SAP HANA.
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port.
APOS Systems Inc. | Live Data Gateway User Guide
180
APOS Live Data Gateway
6.
Verify the Prefix assigned to the connections in the Connection Management. Using this prefix enter all the
login credentials configured in the LDG database.
For the User Name: use the syntax <prefix> followed by a double underscore __ and then username.
Multiple connections can be provided and separated by a double pipe ||
For the Password: type each password separated by a double pipe ||
7.
In our example below we will use the connections for both the MSQL and SSAS. Once the User Name and
Pasword have been entered press OK.
 User Name: MSQL__Username||SSAS__Username
 Passsword: password||password
8.
Verify that the Direct Connection has been created successfully.
APOS Systems Inc. | Live Data Gateway User Guide
181
APOS Live Data Gateway
9.
Now create a Model. Select Moduler from the side panel.
10. Select the Live Data Model from the Models tab.
APOS Systems Inc. | Live Data Gateway User Guide
182
APOS Live Data Gateway
11. Select the SAP HANA System Type and select the newly created Connection from the previous step as the
Connection. Launch the Data Source selector to choose one data source from the list.
12. View the listing of data sources available for selection and choose one.
The Prefix assigned previously should precede each database and/or cube. In the case of a database where
a view was configured the view name assigned will be displayed.
In the below example there is one MSQL database with one view and two SSAS cubes available for selection.
13. After selecting the data source continue and press OK.
APOS Systems Inc. | Live Data Gateway User Guide
183
APOS Live Data Gateway
14. Save the Model. Additional models can be created for each of the data sources listed for this one
connection.
15. Next Create a Story. Select Stories from the side panel.
APOS Systems Inc. | Live Data Gateway User Guide
184
APOS Live Data Gateway
16. Select Create New Canvas .
17. Choose Add data to begin.
APOS Systems Inc. | Live Data Gateway User Guide
185
APOS Live Data Gateway
18. Select to add Data from an existing dataset or model.
19. Choose the Name of the newly created Model from the previous step. Click OK.
20. Choose the Story tab and select to add a Table to the canvas.
APOS Systems Inc. | Live Data Gateway User Guide
186
APOS Live Data Gateway
21. Within the Builder on the side panel add/remove Measures and Dimensions creating the desired effect on
the canvas. Once complete Save the Story.
Limitation: When using a table/grid the Drill Limitation warning will be appear if there are more than 500
rows in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
187
APOS Live Data Gateway
CORS - SSO
Use one of the two below outlined SAC Direct Connection Authentication Methods when creating SSO
connections.


SAML Single Sign On - Method when using any of the below Authentication methods in the Live Data
Gateway Admin.

IDENTITY PROVIDERS SSO (Level 2) - Assign multiple login users to database users for SSO requests that
will support row level security support.

IMPERSONATE SSO USER – (Level3) - Connect to SAC with SQL Server, Oracle or PostgreSQL and assign
a user to connect to the database.

KERBEROS SSO (Level 3) – Connect to SAC SSO with Kerberos/ADFS with SQL Server, Oracle SSAS and
Denodo.
None - Method when using the below Authentication Method in the Live Data Gateway Admin.

PRE-DEFINED USER (Level 1) – Connect to SAC and assign one account to be used for all SSO requests
coming from a trusted account. All requests will be fulfilled by using that one account with no row level
security support.
SAC Authentication Method
SAML Single Sign On
Log into SAC SSO and create a live connection to the database configured in the Live Data Gateway Admin.
1.
Using a computer other than the machine where Live Data Gateway was deployed on go to the Chrome
browser and enter your SAC SSO URL.
2.
When prompted enter your domain login credentials.
APOS Systems Inc. | Live Data Gateway User Guide
188
APOS Live Data Gateway
3.
Once logged in select Connections from the side panel.
4.
Click on the + icon located on the upper right panel and select Connect to Live Data and then SAP HANA.
APOS Systems Inc. | Live Data Gateway User Guide
189
APOS Live Data Gateway
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port, and select the value of SAML Single
Sign On from the Authentication Method dropdown. Click OK.
6.
Select SAML Single Sign On from the Authentication Method drop down. Press OK.
7.
Verify that the Direct Connection has been created successfully.
APOS Systems Inc. | Live Data Gateway User Guide
190
APOS Live Data Gateway
8.
Now create a Model. Select Moduler from the side panel.
9.
Select Live Data Model from Models.
APOS Systems Inc. | Live Data Gateway User Guide
191
APOS Live Data Gateway
10. Select SAP HANA as the System Type and the newly created Connection from the previous step and
choose the Data Source name from the drop down and fill in the Name for the new model. Click OK.
Note: When selecting Universe connections types, the data source listing of universes will have a numeric
identifier representing the ID / Folder ID located to the right of the name.
11. View the listing of data sources available for selection and choose one.
The Prefix assigned previously should precede each database and/or cube. In the case of a database where
a view was configured the view name assigned will be displayed.
In the below example there is one MSQL database with one view and two SSAS cubes available for selection.
APOS Systems Inc. | Live Data Gateway User Guide
192
APOS Live Data Gateway
12. After selecting the data source continue and press OK.
13. Save the Model.
APOS Systems Inc. | Live Data Gateway User Guide
193
APOS Live Data Gateway
14. Next Create a Story. Select Stories from the side panel.
15. Choose Add a Canvas Page.
APOS Systems Inc. | Live Data Gateway User Guide
194
APOS Live Data Gateway
16. Select to Add data.
17. Choose Data from an existing dataset or model option.
APOS Systems Inc. | Live Data Gateway User Guide
195
APOS Live Data Gateway
18. Select the Story tab and choose Table as the object to be added to the canvas.
19. Select the Name of the newly created Model from the previous step. Click OK.
20. Within the Builder on the side panel add/remove Measures and Dimensions creating the desired effect on
the canvas. Once complete Save the Story.
Note: When using a table/grid the Drill Limitation warning will be appear if there are more than 500 rows
in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
196
APOS Live Data Gateway
None
Log into SAC and using the connection configured in the Live Data Gateway Admin, create a live connection.
1.
Using a computer other than the machine where Live Data Gateway was deployed on go to the Chrome
browser and enter your SAC SSO URL.
2.
When prompted enter your domain login credentials.
3.
Once logged in select Connections from the side panel.
APOS Systems Inc. | Live Data Gateway User Guide
197
APOS Live Data Gateway
4.
Click on the + icon located on the upper right panel and select SAP HANA under Connect to Live Data.
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port. Click OK.
APOS Systems Inc. | Live Data Gateway User Guide
198
APOS Live Data Gateway
6.
Select None from the Authentication Method drop down. Press OK.
7.
Verify that the Direct Connection has been created successfully.
8.
Now create a Model. Select Molduler from the side panel.
9.
Select Live Data Model from the Models.
APOS Systems Inc. | Live Data Gateway User Guide
199
APOS Live Data Gateway
10. Select SAP HANA as the System Type and the newly created Connection from the previous step and choose
the Data Source name from the drop down and fill in the Name for the new model. Click OK.
Note: When selecting Universe connections types, the data source listing of universes will have a numeric
identifier representing the ID / Folder ID located to the right of the name.
11. View the listing of data sources available for selection and choose one.
The Prefix assigned previously should precede each database and/or cube. In the case of a database where
a view was configured the view name assigned will be displayed.
In the below example there is one MSQL database with one view and two SSAS cubes available for selection.
APOS Systems Inc. | Live Data Gateway User Guide
200
APOS Live Data Gateway
12. After selecting the data source continue press OK.
13. Save the Model.
APOS Systems Inc. | Live Data Gateway User Guide
201
APOS Live Data Gateway
14. Next Create a Story. Select Stories from the side panel.
15. Choose to create new Canvas.
APOS Systems Inc. | Live Data Gateway User Guide
202
APOS Live Data Gateway
16. Choose to Add data to the canvas.
17. Select the Name of the newly created Model from the previous step. Click OK.
18. Choose to Add Data from an existing dataset or model.
APOS Systems Inc. | Live Data Gateway User Guide
203
APOS Live Data Gateway
19. Choose the Story tab and then add a Table to the canvas.
20. Within the Builder on the side panel add/remove Measures and Dimensions creating the desired effect on
the canvas. Once complete Save the Story.
Limitation: When using a table/grid the Drill Limitation warning will be appear if there are more than 500
rows in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
204
APOS Live Data Gateway
Non-Database Method
The Non-Database Method supports CORS deployments and has been deprecated. Time dimensions are not
supported when using the non-database method.
The Database Method is the recommended method to use when configuring Live Data Gateway connections and
views.
A web application must be deployed for each data source along with the generated DG_DataSource.xml and the
DG_View.xml file if applicable.
Live Data Gateway Login
The following example contains steps to begin using the Non-Database Method. They include first creating a
SSAS connection and then a MSQL connection. Each connection created must be deployed to separate web
applications.

Select Connect using the non-database method option. Press Connect
APOS Systems Inc. | Live Data Gateway User Guide
205
APOS Live Data Gateway

The Live Data Gateway Admin application will launch.

Select the License tab and click on the Browse option to add the APOS Live Data Gateway license file.
APOS Systems Inc. | Live Data Gateway User Guide
206
APOS Live Data Gateway

Locate and Open the APOS Live Data Gateway license file that was supplied and copied to the
application folder.

Confirm that the APOS Live Data Gateway license is valid.

Select the Connections tab and choose SSAS from the Data Source drop down.

Fill in the SSAS Server URL information.
APOS Systems Inc. | Live Data Gateway User Guide
207
APOS Live Data Gateway

Click Test URL to validate the Server URL entered. A prompt will occur when the Java has not been
configured. Click Yes to configure the java path.

Browse to the location of java.exe. By default a version of java is installed with this application and can
be found in …\Program Files\APOS\Java\OpenJDK\jre8\bin. Click Open.

Once the Test URL results in a successful message click OK.

Select the SAC tab and fill in the SAC Tenant URL. This value is required when using CORS to connect
Live Data Gateway to SAC.
APOS Systems Inc. | Live Data Gateway User Guide
208
APOS Live Data Gateway

Browse to the folder location where you would like to save the DG_Datasource.xml file and press Save.

Once it has been saved click OK.

Deploy this file to the application deployed.
APOS Systems Inc. | Live Data Gateway User Guide
209
APOS Live Data Gateway

Alternatively if connecting to a relational database instead of SSAS, select the Connections tab and
choose Database from the Data Source drop down. Select the database type from the Database drop
down list. Fill in the Host and the Database Name. Test the configured connection by clicking on the
Test Connection button and filling the credentials.

To work with relational databases it is required to create at least one view. The information about the
views will be saved in a file called DG_View.xml which must be copied together with the file
DG_Datasource.xml.
APOS Systems Inc. | Live Data Gateway User Guide
210
APOS Live Data Gateway

Click on Build View button to open the wizard for creating the view.



Enter the User and Password to connect to the database.
To create a new file check New Configuration File.
To work with an existing DG_View.xml file enter the file name in Load Configuration File text box or
browse to it. Click on one of the buttons Edit, Delete, Add to start working on the desired process.
When creating new views enter a unique View Name. A random unique View Name is assigned by
default but this can be updated to another value.
Enter the 64 bit ODBC connection using the relevant installed client when connecting to a relational
database.



Click Next.
APOS Systems Inc. | Live Data Gateway User Guide
211
APOS Live Data Gateway

Click on the Load Table Schema(s) button to load all tables and fields available for selection.

Expand the tables and click on the column name to select the fields you want in your view.


To see a summary of your selected columns click on the button refresh located in the middle.
It is required to have at least one numeric column to be used as a measure.

Click Next.
APOS Systems Inc. | Live Data Gateway User Guide
212
APOS Live Data Gateway

Check at least one row in the column Is Measure to be used as a measure.


You can assign names to the measure in column Measure Name.
When checkbox Assign Default Aliases is selected, the names of the original columns will be assign as
names to all the measures with no name.

Click Next.
APOS Systems Inc. | Live Data Gateway User Guide
213
APOS Live Data Gateway

All the columns not configured as measure will appear in this screen. Assign names to them in
Dimension Name column. Use Dimension Group column to group them together inside the xml file.
When the check box Assign Default Names for Dimensions is selected, the Dimension Names will be
automatically assigned.

Click Next.



When working with multiple tables, a relation between tables must be defined.
Click Get Relationships From Database to get the existing relations established in the database. If
relations cannot be established, add them manually.
Click on Add New Row to add a new row to the grid to define a new relationship.

Click Validate to confirm that the entered relationships are valid.
APOS Systems Inc. | Live Data Gateway User Guide
214
APOS Live Data Gateway

Click Finish. It will go to the next page if all the tables can be associated.

Click Create New View definition button to create a new view.

Click Save to save the DG_View.xml file.

The saved view file named DG_View.xml can be found in the folder …Program Files\Live Data
Gateway\Admin.

Once both the DG_DataSource.xml and DG_View.xml have been created copy the files to the
deployed applications such as LDG and the Web Admin Tool.
APOS Systems Inc. | Live Data Gateway User Guide
215
APOS Live Data Gateway
Live Data Gateway Deployment
You are now ready to save the DG_DataSource.xml file created by the Live Data Gateway Admin to the web
application or independent service deployment.

CORS – Using CORS to connect to SAC

CORS – SSO – Using CORS connect SAC SSO with Kerberos/ADFS and SAML SSO
CORS
Use CORS to connect to SAC.
1.
Copy the connection DG_DataSource.xml file from the …Program Files\Live Data Gateway\Admin folder
to the deployed application. In the following example the file is copied to a web application
deployment to Tomcat in the …\Tomcat 8\<Service name>\ROOT\WEB-INF\classes folder.
Note: Please ensure that if the DG_View.xml file was created, it too is copied to this location.
2.
Proceed to using SAC with CORS.
APOS Systems Inc. | Live Data Gateway User Guide
216
APOS Live Data Gateway
CORS – SSO
Using CORS connect SAC SSO with Kerberos/ADFS and SAML SSO to the below live data sources after
following the steps outlined in the Live Data Gateway Admin.
Kerberos/ADFS using the following database connections:




Microsoft SQL Server
SSAS
Oracle
Denodo
SAML SSO using the following database connection:

Microsoft SQL Server
1.
Copy the files DG_DataSource.xml and DG_View.xml that were saved in the steps outlined in the Live
Data Gateway Admin to the deployed application. In the following example the file is copied to a web
application deployment to Tomcat in the …\Tomcat 8\<MSSQL>\ROOT\WEB-INF\classes folder.
2.
Copy the required database jar file for the database connection type to the deployed web application
…\Tomcat 8\<MSSQL>\ROOT\WEB-INF\lib folder.
Database Type
Database File(s)
Oracle
ojdbc8.jar
ucp.jar
Microsoft SQL
Server
sqljdbc4.jar
Denodo
denodo-vdp-jdbcdriver.jar
mssql-jdbc-9.4.1.jre8.jar
3.
When selecting to use SAML SSO ensure that the SAML SSO web application has been deployed.
4.
Restart Tomcat.
5.
Proceed to using SAC SSO using CORS – SAML Single Sign On
APOS Systems Inc. | Live Data Gateway User Guide
217
APOS Live Data Gateway
SAP Analytics Cloud (SAC)
Use APOS Live Data Gateway to connect to SAP Analytics Cloud using one of the methods outlined below. Using
CORS is the preferred method for creating live connections.

CORS - Configure tomcat to use CORS to connect the Live Data Gateway Web App with SAC when creating Live
Connections.

Configure a Connection Inside SAC – Using CORS connect to SAC and create a Direct Live Data
Connection.

CORS - SSO – Preferred Method when creating SAC live connections using either of the below Authentication
Methods to create Live Data Gateway SSO Level 1, Level 2 or Level 3 connections.

SAML Single Sign On

None
CORS
Ensure that Tomcat or the service deployment have been configured for SSL prior to beginning the configuration
and the Live Data Gateway web application has been deployed.
Configure a Connection within SAC
Once CORS and the Live Data Gateway Web applications have been configured, log into SAP Analytics Cloud and
using the connection configured in the Live Data Gateway Admin, create a live connection.
1.
Go to the Chrome browser and enter your SAC URL.
2.
When prompted enter your login credentials to SAC.
APOS Systems Inc. | Live Data Gateway User Guide
218
APOS Live Data Gateway
3.
Once logged in select Connection from the side panel.
4.
Click on the + icon located on the upper right panel and select SAP HANA under Live Data Connection.
APOS Systems Inc. | Live Data Gateway User Guide
219
APOS Live Data Gateway
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port, database connection Username and
Password. Click OK.
APOS Systems Inc. | Live Data Gateway User Guide
220
APOS Live Data Gateway
6.
Verify that the Direct Connection has been created successfully.
7.
Now create a Model. Select + Create – Model from the side panel.
8.
Select Use a datasource.
APOS Systems Inc. | Live Data Gateway User Guide
221
APOS Live Data Gateway
9.
Select Live Data connection from the list of available sources that appears in the right side panel.
10. Select the newly created Connection from the previous step as the System name, choose the Data Source
name from the drop down and fill in the Name for the new model. Click OK.
Note: When selecting Universe connections types, the data source listing of universes will have a numeric
identifier representing the ID / Folder ID located to the right of the name.
APOS Systems Inc. | Live Data Gateway User Guide
222
APOS Live Data Gateway
11. Save the Model.
12. Next Create a Story. Select Create – Story from the side panel.
APOS Systems Inc. | Live Data Gateway User Guide
223
APOS Live Data Gateway
13. Choose Add a Canvas Page.
14. Choose Chart as the object to be added to the canvas.
15. Choose the Name of the newly created Model from the previous step. Click OK.
APOS Systems Inc. | Live Data Gateway User Guide
224
APOS Live Data Gateway
16. Within the Builder on the side panel add/remove Measures and Dimensions creating the desired effect on
the canvas. Once complete Save the Story.
Note: When using a table/grid the Drill Limitation warning will be appear if there are more than 500 rows
in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
225
APOS Live Data Gateway
CORS - SSO
Use one of the two below outlined SAC Direct Connection Authentication Methods when creating SSO
connections.


SAML Single Sign On - Method when using either of the below Authentication methods in the Live Data
Gateway Admin.

IDENTITY PROVIDERS SSO (Level 2) - Assign multiple login users to database users for SSO requests
that will support row level security support.

IMPERSONATE SSO USER – (Level3) - Connect to SAC with SQL Server, Oracle or PostgreSQL and
assign a user to connect to the database

KERBEROS SSO (Level 3) – Connect to SAC SSO with Kerberos/ADFS and SQL Server, SSAS, Denodo
and Oracle.
None - Method when using the below Authentication Method in the Live Data Gateway Admin.

PRE-DEFINED USER (Level 1) – Connect to SAC and assign one account to be used for all SSO
requests coming from a trusted account. All requests will be fulfilled by using that one account
with no row level security support.
SAC Authentication Method
SAML Single Sign On
Log into SAC SSO and create a live connection to the database configured in the Live Data Gateway Admin.
1.
Using a computer other than the tomcat machine where the Live Data Gateway web application was
deployed on go to the Chrome browser and enter your SAC SSO URL.
2.
When prompted enter your domain login credentials.
APOS Systems Inc. | Live Data Gateway User Guide
226
APOS Live Data Gateway
3.
Once logged in select Connections from the side panel.
4.
Click on the + icon located on the upper right panel and select SAP HANA from Connect to Live Data.
APOS Systems Inc. | Live Data Gateway User Guide
227
APOS Live Data Gateway
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port, and select the value of SAML Single
Sign On from the Authentication Method dropdown. Click OK.
6.
Verify that the Direct Connection has been created successfully.
APOS Systems Inc. | Live Data Gateway User Guide
228
APOS Live Data Gateway
7.
Now create a Model. Select Moduler from the side panel.
8.
Select to use a Live Data Model.
APOS Systems Inc. | Live Data Gateway User Guide
229
APOS Live Data Gateway
9.
Select SAP HANA as the System Type and the newly created Connection from the previous step and choose
the Data Source name from the drop down and fill in the Name for the new model. Click OK.
Note: When selecting Universe connections types, the data source listing of universes will have a numeric
identifier representing the ID / Folder ID located to the right of the name.
10. Save the Model.
APOS Systems Inc. | Live Data Gateway User Guide
230
APOS Live Data Gateway
11. Next Create a Story. Select Create – Story from the side panel.
12. Choose to create a new Canvas .
APOS Systems Inc. | Live Data Gateway User Guide
231
APOS Live Data Gateway
13. Choose to Add data to the canvas.
14. Add Data from an existing dataset or model.
15. Select Existing Model and choose the Name of the newly created Model from the previous step. Click OK.
APOS Systems Inc. | Live Data Gateway User Guide
232
APOS Live Data Gateway
16. Select the Story tab and choose a Table to add to the canvas.
17. Within the Builder on the side panel add/remove Measures and Dimensions creating the desired effect on
the canvas. Once complete Save the Story.
Note: When using a table/grid the Drill Limitation warning will be appear if there are more than 500 rows
in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
233
APOS Live Data Gateway
None
Log into SAC and using the connection configured in the Live Data Gateway Admin, create a live connection.
1.
Go to the browser and enter your SAC URL.
2.
When prompted enter your login credentials to SAC.
3.
Once logged in select Connections from the side panel.
APOS Systems Inc. | Live Data Gateway User Guide
234
APOS Live Data Gateway
4.
Click on the + icon located on the upper right panel and select SAP HANA from Connect to Live Data.
5.
Fill in the Name, Direct Connection Type, Host name, HTTPS Port, and select the None authentication
method.. Click OK.
APOS Systems Inc. | Live Data Gateway User Guide
235
APOS Live Data Gateway
6.
Verify that the Direct Connection has been created successfully.
7.
Now create a Model. Select Moduler from the side panel.
8.
Select to use a Live Data Model.
APOS Systems Inc. | Live Data Gateway User Guide
236
APOS Live Data Gateway
9.
Select SAP HANA as the System Type and the newly created Connection from the previous step and choose
the Data Source name from the drop down and fill in the Name for the new model. Click OK.
10. Save the Model.
APOS Systems Inc. | Live Data Gateway User Guide
237
APOS Live Data Gateway
11. Next Create a Story. Select Stories from the side panel.
12. Choose to add a Canvas to the story.
APOS Systems Inc. | Live Data Gateway User Guide
238
APOS Live Data Gateway
13. Select to Add data to the canvas.
14. Choose Data from an existing dataset or model.
APOS Systems Inc. | Live Data Gateway User Guide
239
APOS Live Data Gateway
15. Select Name of the newly created Model from the previous step. Click OK.
16. Select the Story tab and choose to add a Table to the story canvas.
17. Within the Designer panel add/remove Measures and Dimensions creating the desired effect on the
canvas. Once complete Save the Story.
Note: When using a table/grid the Drill Limitation warning will be appear if there are more than 500 rows
in the model that was selected. Click the Edit Drill Limitation button to change the default value to a
custom value.
APOS Systems Inc. | Live Data Gateway User Guide
240
APOS Live Data Gateway
Analysis for Office
Launch Analysis for Office and select SAC live data connections to the APOS Live Data Gateway deployment.
The following requirements and limitations exist:



Analysis for Office 2.8 minimum
Relational Database connection types.
Relational Database connection types configured with a pre-defined user (SSO1)
Follow the below steps when using Analysis for Office 2.8 to connect to SAC and a Live Data Gateway
Connection.
1.
Start the Analysis for Excel application and selecting the Analysis tab. Choose Insert Data Source and
Select Data Source for Analysis….
2.
Right-click within the Show Connections tab and select Create New SAC Connection.
3.
Populate the Description and fill in the Logon URL to SAC. Select the Enable Live Data Connections check
box before pressing OK.
APOS Systems Inc. | Live Data Gateway User Guide
241
APOS Live Data Gateway
4.
Double-click on the Live Data Connection to retrieve the SAC connections.
5.
Select the LDG configured live connection from the list and press Next.
APOS Systems Inc. | Live Data Gateway User Guide
242
APOS Live Data Gateway
6.
Fill in the LDG database user credentials for the live connection. In the example below the username
includes the connection prefix assigned when configuring the connection using the database backend
method. Press OK.
7.
Select the Area tab and choose the desired View which was configured with the Live Data Gateway View
Wizard. Press OK.
APOS Systems Inc. | Live Data Gateway User Guide
243
APOS Live Data Gateway
8.
Select the desired Columns (Measures) and Rows (Dimensions) from the view.
9.
Choose to Insert a Chart if desired and save the Analysis for Excel document.
APOS Systems Inc. | Live Data Gateway User Guide
244
APOS Live Data Gateway
Geo Maps
APOS Live Data Gateway supports GIS points in when using the relational database connections. These points can
be used when creating Geo Maps in SAC connecting to LDG when using the Database Backend Method.
The two ways of implementing spatial functionality with Live Data Gateway are as follows.

Virtual Points - The table does not contain real spatial columns. Virtual points will be defined using the latitude,
longitude and location key columns. These fields must exist in one single table. Joins between more two or
more tables are not supported.

Real Spatial Data - The table contains real spatial data. The database column type of ST_POINT must exist in the
fields/tables selected.
Virtual Points
The following outlines the steps taken to create Virtual Points in a view based upon a SQL Server connection using the
Database Backend Method. These steps assume that Live Data Gateway is deployed and already setup with both
the LDG_Config.xml file and any necessary database jar files already in place.
1.
Follow the steps outlined in Live Data Gateway Admin to create and save a database connection where a table
contains two fields containing latitude and longitude of a location on planet Earth as well as a location key and
a field that can be used as a measure.
2.
Once the database connection has been configured press Manage Views to launch the View Management
form.
3.
Select the Semantic Layer View Management tab and press Add to begin configuring the view.
APOS Systems Inc. | Live Data Gateway User Guide
245
APOS Live Data Gateway
4.
Populate the Database Information and View Name. Once complete press Next.
5.
Press Load All Schema(s) then expand and select the desired fields including that of latitude, longitude,
location key as well as a field that can be used as a measure. No joins are allowed so all elements must be part
of one single table. Once selected press the Update Summary List button to add the fields to the selected fields
list.
APOS Systems Inc. | Live Data Gateway User Guide
246
APOS Live Data Gateway
6.
Press the Virtual Point Definition button.
7.
Press the + button to add a Virtual Point.
APOS Systems Inc. | Live Data Gateway User Guide
247
APOS Live Data Gateway
8.
Complete the below to add the Virtual Point settings and then press Apply to save.
 Populate the View Name, Location Dimension ID, Location Dimension Name and Identifier for
Mapping values. Each value needs to be unique over the entire collection of connections contained in
the exported Config XML file.
 Select the Virtual Point – Database Definition fields and set the Source Table, Latitude, Longitude
and Identifier for Mapping columns. The values within the drop downs are based upon the
fields/table selected in the previous step.
 Fill in the Projection SRID codes.
 Select the check boxes Database Supports Spatial and Allow Re-projection if the database supports
spatial data.
9.
Once the virtual point is added press Close to continue.
APOS Systems Inc. | Live Data Gateway User Guide
248
APOS Live Data Gateway
10. Once the form closes select Next to continue.
11. Choose the Measure field and confirm the Aggregation from the drop down. Press Next.
APOS Systems Inc. | Live Data Gateway User Guide
249
APOS Live Data Gateway
12. In the Dimension listing verify the virtual point row with the Data Type of VPOINT. Confirm that the Geo
Mapping Columns are populated correctly. Press Next.
13. Since there is only one table defined, a relationship is not required. Press Finish
APOS Systems Inc. | Live Data Gateway User Guide
250
APOS Live Data Gateway
14. Press Create New View Definition and once the XML has been generated press Save.
15. Make any adjustments to the Unique Prefix, View Name and Description and press OK.
16. When prompted press OK once the view has been created.
APOS Systems Inc. | Live Data Gateway User Guide
251
APOS Live Data Gateway
17. The view should now be listed in the Semantic Layer View Management tab.
18. Launch SAC and create the HANA Live Connection selecting the deployed Live Data Gateway web application
Path and the database credentials. Press OK to save the connection.
19. Create a Model selecting the HANA Live Connection name from the previous step.
20. Select to Create a Location Dimension in the Model.
APOS Systems Inc. | Live Data Gateway User Guide
252
APOS Live Data Gateway
21. Select the Location Identifier, View Name and Identifier for Mapping values from their drop downs. Verify
the Location Dimension Name is displayed as expected. These values should match with what was defined
while configured the Virtual Points in the View. Press OK and then Save the Model.
22. Create a Story selecting the Model just configured and select to add a Geo Map to the story.
APOS Systems Inc. | Live Data Gateway User Guide
253
APOS Live Data Gateway
23. In the Builder select Add Layer.
24. Assign the Model that was configured in the previous steps as the Data Source. Select Bubble Layer as the
Layer Type and select the Location Dimension that was defined in the view and wait for the map to generate.
Save the Story.
APOS Systems Inc. | Live Data Gateway User Guide
254
APOS Live Data Gateway
Configure Proxy with a Dedicated Port
When using the web application deployment method to Tomcat, configure a proxy with a dedicated port to be used
to create an OLAP Connection within the BI system
The following outlines how to create the virtual host when using Apache24 as a proxy with the web application
deployed to Tomcat.
1.
Locate and the file httpd.conf and create a copy prior to editing. In the case of this example this file can be
found in …\Apache24\conf.
2.
Within the file uncomment every line which contains the word “vhost”.
3.
Find the word “Listen” and add a new line for every port you want to use. For instance, if the web application is
to be called over port 4488 the entry will be the below
Listen 4488
4.
Save and close the httpd.conf file.
5.
Navigate to the folder …\Apache24\conf\extra and create a copy of the file httpd-vhosts.conf file prior to
editing.
6.
Go to the end of the httpd-vhosts.conf file and create a new virtual host using the port that was configured in
the earlier step. The configuration of the virtual host will allow a redirection at root level to the wanted
LiveDataGateway web application. The following is an example of the lines to be entered replacing the
<SvrName> tag with the name of the server.
<VirtualHost _default_:4488>
ServerName <SvrName>:4488
ProxyTimeout 1200
ProxyRequests off
ProxyPreserveHost on
RequestHeader append X-Custom-Host <SvrName>
ProxyPass / http://<SvrName>:8080/LiveDataGateway/
ProxyPassReverse / http://<SvrName>:8080/LiveDataGateway/
</virtualhost>
7.
Save and close the httpd-vhosts.conf file.
8.
Restart the Apache24 and Tomcat servers.
APOS Systems Inc. | Live Data Gateway User Guide
255
APOS Live Data Gateway
Universes
1.
In the Central Management Console (CMC) configure HANA authentication for each web application.
Configure HANA Authentication






Select Applications
Select HANA Authentication
Select Create a Connection
Enter the following information

Connection Type – Select SAP HANA HTTP

HANA Hostname – Enter the Apache Proxy domain name of computer name

HANA Port – Enter the Dedicated Port defined for the OLAP configuration that you want to
use SSO.

Unique Identify Provider ID – Enter a ID that will uniquely identify the BI Platform with port.
Press Generate
Press OK
APOS Systems Inc. | Live Data Gateway User Guide
256
APOS Live Data Gateway
2.
In the CMC configure Trusted Authentication for BusinessObjects. This step only needs to be configured once.
Configure Trusted Authentication for BusinessObjects








3.
Select Authentication
Select Enterprise
Locate the Trusted Authentication section
Select the check box Trusted Authentication is enabled
Press New Shared Secret
Press Download Shared Secret
Save the resulting generated TrustedPrincipal.conf file
Press Update
In the CMC configure Trusted Authentication for REST. This step only needs to be configured once.
Configure Trusted Authentication for REST





Select Servers
Select Server List
Select the WebApplicationContainerServer (WACS) properties
Locate the Command Line Parameters section
Look for the parameter –Dbobj.trustedauth.home and ensure that the TrustedPrincipal.conf file from
the previous step is copied to this file location. If you wish to have the file at a different path, update
the path value here
APOS Systems Inc. | Live Data Gateway User Guide
257
APOS Live Data Gateway
4.


Locate the RESTful Web Service section
Make note of the below values assigned within this area. These values must be used when configuring
the Universe Connection that is deployed to the Live Data Gateway web application.

Retrieving Method

User Name Parameter


Press Save and Close
Restart the WACS server
Select OLAP Connections in the Central Management Console (CMC).
APOS Systems Inc. | Live Data Gateway User Guide
258
APOS Live Data Gateway
OData Gateway
Use APOS OData Gateway for all applications which are able to consume OData (SAC, HANA SDI, HANA SDA, etc.) as
well as those that can use the APOS LDG JDBC driver (Crystal Reports) to access data provided by Live Data Gateway.
The OData Gateway is contained within the Live Data Gateway deployment and is intended for data sources of type
Database, Universe and OLAP only and is supported when LDG is configured using the Database Method as a
backend. The Non-Database backend Method is not supported with this feature.

OData – Instructions for those tools that consume OData as a datasource. The OData Gateway service requires
the APOS Live Data Gateway OData Gateway license file.

Live Data Gateway Drivers:

JDBC Driver – Instructions for those tools that can consume JDBC as a datasource. The JDBC driver
requires the APOS Live Data Gateway JDBC Driver license file.
OData
Use one of the below OData Entry point URL in the following various tools that consume OData as a datasource.
The use of APOS OData Gateway requires the APOS Live Data Gateway OData Gateway license file.
Ensure to update the yellow highlighted text to reflect the host/port of the Live Data Gateway Deployment.
http(s)://host:port/odata2ldg.svc/



HANA SDI and SDA
DWC
Acquire Mode for SAC
APOS Systems Inc. | Live Data Gateway User Guide
259
APOS Live Data Gateway
HANA SDI and SDA
Consume OData with HANA SDI and HANA SDA using the APOS OData Gateway by following the below steps:
1.
Create a New Remote Source in HANA.
2.
Populate the Source Name and select the OData Adapter from the Adapter Name drop down.
APOS Systems Inc. | Live Data Gateway User Guide
260
APOS Live Data Gateway
3.
Populate the URL and Password information. Press Save to continue and validate the connection.




URL: Fill in the URL of the OData service that is deployed with LDG:
http(s)://host:port/odata2ldg.svc/
Credentials Mode: Select Technical User
Username: Fill in the user name to the database connection
Password: Populate the password of the database user
4.
Expand the newly created Remote Source to view all APOS Views available for selection from the Live Data
Gateway backend.
5.
Continue and create Virtual Tables and/or Remote Subscriptions based upon the views available in the OData
Remote Source.
APOS Systems Inc. | Live Data Gateway User Guide
261
APOS Live Data Gateway
DWC
Connect DWC to the APOS OData Gateway for Live Data Gateway by following the below steps:
1.
Select to Configure an OData Connection.
2.
Create new OData type connection populating the below values. Press Confirm when complete.
 Source Name: Fill in a unique Source Name
 URL: Fill in the URL of the OData service contained within the Live Data Gateway deployment.
http(s)://host:port/odata2ldg.svc/
 User Name: Fill in the user name to the database connection
 Password: Populate the password of the database user
APOS Systems Inc. | Live Data Gateway User Guide
262
APOS Live Data Gateway
3.
Test the newly created Connection. Ensure that the Status is green.
4.
Add the connection to your space.
5.
The newly created connection can now be used in data work flows.
APOS Systems Inc. | Live Data Gateway User Guide
263
APOS Live Data Gateway
Acquire Mode for SAC
Consume the APOS OData Gateway in SAC using acquired mode via a connection type of OData. A mapping of the
host, port and application name of OData Gateway must be configured in SAP Cloud Connector prior to creating the
connection in SAC.
When acquiring the data via the APOS OData Gateway the connection must be to either database views or universes.
Creating a connection that includes a mixture of both database views and universes is not supported
Use the APOS OData Gateway URL in SAC by following the below steps:
1.
Begin by adding a new mapping of the host and port of the OData access point in the SAP Cloud Connector
and select the back end type. Press Next.
 Back-end Type: Non-SAP System
2.
Select the desired Protocol of either HTTP or HTTPS for the URL to be mapped. Press Next.
APOS Systems Inc. | Live Data Gateway User Guide
264
APOS Live Data Gateway
3.
Populate the Internal Host and Internal Port information of the URL. Press Next.
4.
Optionally change the Virtual Host and Virtual Port values. Press Next.
5.
Select None from the Principal Type drop down. Press Next.
APOS Systems Inc. | Live Data Gateway User Guide
265
APOS Live Data Gateway
6.
Optionally enter a Description for the mapping. Press Next.
7.
Review and confirm the system mapping information. Press Finish.
8.
Confirm that the mapping has been added to the list. The next step is to add a Resource.
APOS Systems Inc. | Live Data Gateway User Guide
266
APOS Live Data Gateway
9.
Select the mapping from the list and within the Resources section found below the list press the + button to add
the resource settings. Press Save.



URL Path: Fill in the path of the web application deployed.
Enabled: Ensure enabled has been selected.
Access Policy: Select Path and all sub-paths
10. Confirm that the mapping has a Status of green. Once this is complete a connection can be configured in SAC to
the OData service.
APOS Systems Inc. | Live Data Gateway User Guide
267
APOS Live Data Gateway
11. Launch SAC to create a new Connection. Within Select a Datasource choose the OData Services option from
the Acquire Data section.
APOS Systems Inc. | Live Data Gateway User Guide
268
APOS Live Data Gateway
12. Fill in the new OData Services Connection information. Press Create to save the connection.
Note: The connection must be to either database views or universes. Creating a connection that includes a
mixture of both database views and universes is not supported






Connection Name: Fill in the new OData connection name.
Connect to an On-Premise OData service: Select to use the mapping created in the previous steps.
Data Service URL: Fill in the URL of APOS OData Gateway that is contained with the Live Data Gateway
deployment.
http(s)://host:port/odata2ldg.svc/
Authentication Type: Select Basic Authentication from the drop down.
User Name: Fill in the database connection prefix and user name.
Password: Fill in the password for the database user name.
13. Verify that the OData Services connection was created successfully and continue within SAC to build a model
and story based upon this connection.
APOS Systems Inc. | Live Data Gateway User Guide
269
APOS Live Data Gateway
Live Data Gateway Drivers
JDBC Driver
The JDBC driver ldg-driver.jar is located in the …\Program Files\Live Data Gateway\Drivers\JDBC Driver folder of the
installed LDG application. The driver requires its own separate LDG JDBC license file.
The following outline the steps taken to create a connection using the JDBC Driver to APOS OData Gateway that is
included within the Live Data Gateway deployment. When deploying these reports to a BusinessObjects server
ensure that the driver and APOS License files used to create the connection are also copied to the same folder
location on the server.

Crystal Reports - Steps when using the JDBC Driver when creating a connection in Crystal Reports
Below are the class and connection string to be used with the JDBC driver when connecting to APOS OData Gateway.

JDBC Driver Class: com.apos.ldg.Driver

JDBC Driver Connection String: Use the following connection string to the OData Gateway service in the Live
Data Gateway deployment. Update the highlighted yellow text to the correct information.
jdbc:ldg:URL=http(s)://host:port/odata2ldg.svc/;AuthScheme=Basic;LdgLicenseFile=c:\JDBC\APOS.lic
APOS Systems Inc. | Live Data Gateway User Guide
270
APOS Live Data Gateway
Crystal Reports
Follow the below steps when using the JDBC Driver with Crystal Reports:
1.
Copy the ldg-driver.jar file and the APOS.lic file to a folder location accessible to Crystal Reports. For the
purposes of this example both files have been saved to c:\JDBC.
2.
Since the CRConfig.xml must be updated, make a backup copy of the CRConfig.xml file prior to editing.
The file is located in the BusinessObjects installed folder:
…:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java
3.
Edit the CRConfig.xml file and add the jar file and location within the<Classpath>tag.
<Classpath>C:\JDBC;C:\JDBC\ldg-driver.jar;C:\SDD;C:\SDD\SLConnector.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/crlovmanifest.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/CRLOVExternal.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/CRDBJDBCServer.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/CRDBXMLServer.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/CRDBJavaBeansServer.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/external/log4j.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/CRDBWicServer.jar;C:\Program Files (x86)\SAP
BusinessObjects\\SAP BusinessObjects Enterprise XI 4.0\java/lib/external/CRDBWicExternal.jar;${CLASSPATH}</Classpath>
4.
If required adjust the <JVMMaxHeap> setting based upon the size of the dataset that will be returned to
Crystal. Once complete Save the file.
5.
Launch Crystal Reports and within Create New Connection select JDBC.
APOS Systems Inc. | Live Data Gateway User Guide
271
APOS Live Data Gateway
6.
Enter the JDBC Connection information and press Next to continue.

Connection URL: Use the below URL to OData Gateway included in the Live Data Gateway deployment.
Update the yellow highlighted text with the correct information.
jdbc:ldg:URL=http(s)://host:port/odata2ldg.svc/;AuthScheme=Basic;LdgLicenseFile=c:\JDBC\APOS.lic

7.
Database Classname: com.apos.ldg.Driver
Enter the information to log on to the data source. Press Finish.


User ID: Fill in the prefix and user name to the database connection
Password: Fill in the password for the database connection
APOS Systems Inc. | Live Data Gateway User Guide
272
APOS Live Data Gateway
8.
In the newly created JDBC connection, expand the CData / OData / Tables tree and select from the APOS
Views available to add and continue designing the report.
APOS Systems Inc. | Live Data Gateway User Guide
273
APOS Live Data Gateway
Live Data Gateway Reference
Live Data Gateway Manager
Launching the Live Data Gateway Manager will load a Login screen where one of two login options can be selected.
1.
Database Method

2.
Connect using the backend database method

The Database Method is the recommended method for recreating connections and views.

This method supports only CORS web application and service deployments.

Create a connection to an installation of SQL Server with a database already configured.

Multiple data sources with the same type of security can share one single LDG deployment.

Once configured and deployed, adding new connections and views with the same type of security
will not require accessing the deployment server.

Connection and view files created using the non-database method can be imported into the
database.
Non-Database Method

Connect using the non-database method

The Non-database Method has been deprecated and the Database Method is the recommended
deployment.

This method supports CORS web application and independent service deployments.

Each data source must be a separate LDG deployment.

Virtual Points and Time Dimensions are not supported
APOS Systems Inc. | Live Data Gateway Reference
274
APOS Live Data Gateway
Field / Control
Description
Connect using the backend
database method
Select to configure a connection to a LDG database that can
contain multiple database connections with only deployment
per security type and is the recommended method to use when
configuring connections and views . CORS is supported with
this method. The following controls are enabled when this
option is selected.



Available Connections – Select a configured LDG database
connection from the drop down.

Add – Launches the Database Connection
Management form to configure the database login
details to the LDG backend SQL database.

Edit – Select a connection from the drop down and
launch the Database Connection Management form to
edit a previously configured connection.

Delete – Select a connection from the drop down and
delete the connection.
User Name – Fill in the User Name to the selected LDG
connection.
Password – Fill in the Password to the selected LDG
connection.
Connect using the nondatabase method
Select to launch the Live Data Gateway Manager and continue
using the non-database method where each database
connection requires the deployment of separate LDG
application. This method has been deprecated and the
Database Backend Method is recommended instead.
Connect
Press Connect to launch the selected method:


Cancel
Database Method – Will validate that the required LDG
tables exist in the connection selected. If the tables do not
exist a prompt will occur asking if they should be added by
the application. Once the tables have been validated the
Live Database Gateway – Connection Management will
launch.
Non-Database Method – Launches the Live Data Gateway
Admin. The Database Method is the recommended method
to use when configuring Live Data Gateway connections
and views connections and views.
Press Cancel to close the application without continuing.
APOS Systems Inc. | Live Data Gateway Reference
275
APOS Live Data Gateway
Database Method
Database Connection Management
Use the Database Connection Management form to configure the Database Login Details to the LDG backend SQL
Database and is the recommended method to use when configuring Live Data Gateway connections and views. The
SQL databases must be configured with mixed authentication mode. Windows authentication is not supported.
Field / Control
Description
Connection Name
Fill in a unique Connection Name to the LDG SQL database.
Server Name
Fill in the SQL Server Name to connection to.
Database Name
Fill in the Database Name to the LDG database. This database must be
created prior to this step.
User Name
Fill in the User Name that can access the LDG database.
Password
Fill in the Password for the User Name.
Port
Fill in the Port to the SQL server.
Connection Timeout
Set the Connection Timeout in seconds. By default this value is set to
30 seconds. For unlimited use 0.
Authentication Type
Select the SQL Authentication Type.
Test
Press Test to validate the connection details entered.
APOS Systems Inc. | Live Data Gateway Reference
276
APOS Live Data Gateway
Field / Control
Description
Save
Press Save to save the connection details.
Cancel
Press Cancel to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
277
APOS Live Data Gateway
Connection Management
Use Connection Management to configure connections and views in the LDG database.


Menu Options
Fields / Controls
APOS Systems Inc. | Live Data Gateway Reference
278
APOS Live Data Gateway
Menu Options
File
Field / Control
Description
Configurations
Select the Configurations menu option to launch the Configuration
Management form to provide the Licence, Java Path and SAC Tenant
information. This information must be configured before any
connections can be created.
Add
Press Add to launch the Live Data Gateway Admin to create a
connection.
Edit
Select a connection from the list and press Edit to launch the Live Data
Gateway Admin to make the desired changes.
Delete
Select a connection from the list and press Delete to remove the
connection.
Refresh
Press Refresh to refresh the connection listing from the LDG database.
Apply Freehand SQL flag
to Connections
Select to invoke Apply Freehand SQL dialog to assign the Freehand SQL
flag to the connection(s) selected.
Approve Users For Web UI
Select to invoke the Approve Users Management form to approve
database users to create views using the APOS Admin Tool Web UI.
APOS Systems Inc. | Live Data Gateway Reference
279
APOS Live Data Gateway
Field / Control
Description
Import From XML
Use the Import From XML button to load a previously configured and
saved connection DG_Datasource.xml file that was created using the
Non-Database Method.
Manage SSO Services
When configuring the APOS SSO2 Services for AWS and Snowflake the
following menu options are available for selection:



Manage Users for SSO Services
Add the SSO users to be handled by the services.
Build Service Configuration
Build the Service Configuration for the connection configured to
use the SSO services. Only one Service Configuration needs to be
created for all Snowflake connections and one for all AWS
connections.
Manage JDBC Driver Options
Manage JDBC Driver Options when specific connection url options
are required and are not currently stored in the database for the
SSO Services
OAuth Profiles (URLs)
When configuring OAuth authenticated connections for either JDBC
Generic – Snowflake or Google Big Query set the profile values using
the OAuth Provider Profiles form.
Close
Press Close to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
280
APOS Live Data Gateway
Approve Users Management
Use the Approve Users Management form to approve database users to create views using the APOS Admin
Tool Web UI. Any updates using this form will be be displayed in the APOS Admin Tool Web UI Rights column of
the Available Connection listing.
Field / Control
Description
No DB user can create views
Select to deny all DB users from creating views in the Web UI
for the selected database connection(s).
Any DB user can create views
Select to allow any DB user to create views in the Web UI for
the selected database connection(s).
APOS Systems Inc. | Live Data Gateway Reference
281
APOS Live Data Gateway
Field / Control
Description
Only provided DB users can create
views
Select to allow just the provided DB users, including the DB
owner if desired, to create views in the Web UI for the selected
database connection(s).




Enter User Name – Populate the text box with the DB
user name to be added to the User Listing.
Add – Select to Add the User Name to the Users listing.
Import – Select to Import a CSV list of DB users to the
Users Listing.
Delete – Select one or more user from the Users Listing
and press Delete to remove them.
Save
Press to Save the approved user management settings.
Exit
Press Exit to close the form.
Apply Freehand SQL
Select one or more database type connections and apply the freehand SQL flag to allow the creation of freehand
SQL views. This flag must be set before approving DB users to creating freehand SQL through either the desktop
or APOS Admin Tool Web UI applications. Any updates using this form will be be displayed in the Freehand SQL
column of the Available Connection listing.
Field / Control
Description
Yes
Press Yes to apply the Freehand SQL flag to the selected connection(s).
No
Press No to exit without applying the Freehand SQL flag.
APOS Systems Inc. | Live Data Gateway Reference
282
APOS Live Data Gateway
Manage Users for SSO Services
Add the SSO users to be handled by the services.
Field / Control
Description
Service Type
Select from the following list from the Service Type drop down.


User Name
AWS (IAM)
SNOWFLAKE
Listing of SSO User Names to be handled by the service
Select to invoke the Add User for SSO Service form.
Select a User Name from the list and press to delete the
user.
Import Users
Select Import Users to import a CSV file of users to the list.
Replace Users
Select Replace Users to replace the users in the list with CSV file.
APOS Systems Inc. | Live Data Gateway Reference
283
APOS Live Data Gateway
Field / Control
Description
Key Pair Folder
Browse to a folder location that will be used by the SSO service. This
setting is enabled for Snowflake connections only.
*Snowflake Only

Exit
Save Folder – Press to save the folder assigned.
Select Exit to close the form.
Add User for SSO Service
Add a User Name to be handled by the SSO service. Press Save to continue.
Import Users

Select Yes to confirm the importing of users to the pre-existing list.

Choose the file containing the users to import into the list and press Open to import.
APOS Systems Inc. | Live Data Gateway Reference
284
APOS Live Data Gateway
Replace Users

Select Yes to confirm delete all the existing users and replace them with the selected list.

Choose the file containing the users to import into the list and press Open to import.
APOS Systems Inc. | Live Data Gateway Reference
285
APOS Live Data Gateway
Build Service Configuration
Build the Service Configuration for the connection configured to use the SSO services. Only one Service
Configuration needs to be created for all Snowflake connections and one for all AWS connections.
Field / Control
Description
Connection Prefix
Select from the Connection Prefix drop down a database connection
configured to use the SSO2 Services.
User Name
Enter the data source User Name.
When defining for AWS connection types the Access Key should be
used.
Password
Enter the data source Password.
When defining for AWS connection types the Secret Access Key should
be used.
Pair Key Folder
The Pair Key Folder will be displayed for Snowflake connections. This
value is not required when configuring AWS services.
Test DB Connection
Press Test DB Connection to test the DB Details.
Edit
Select a Connection Prefix and press Edit to load the DB Details to the
list from the database.
Save
Press Save to save the service configuration to the database.
Close
Select Close to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
286
APOS Live Data Gateway
Manage JDBC Driver Options
Manage JDBC Driver Options when specific connection url options are required and are not currently stored in
the database for the SSO2 Services. Add path and other needed properties as well as driver definitions for IAM
supported JDBC Drivers.
APOS Systems Inc. | Live Data Gateway Reference
287
APOS Live Data Gateway
OAuth Provider Profiles
Configure OAuth Provider Profiles when creating OAuth Authentication connections to either Google Big Query
or Snowflake. Once the profiles have been configured, they can be used when setting the SSO OAuth connection
information.
The following profiles are available for selection from the Profile Name drop down


GOOGLE - Select GOOGLE when configure a connection to Google Big Query. No additional information is
required when using this profile
AZURE - Select AZURE when configuring a connection to Snowflake using External OAuth. Additional
information must be supplied so it is recommended that a copy of the profile be made and any updates be
completed on the profile copy
GOOGLE
Confirm that a GOOGLE Profile exists and contains the below properties for Google Big Query OAuth
connections. No additional information is required. Once complete continue creating the connection with
OAuth authentication.
APOS Systems Inc. | Live Data Gateway Reference
288
APOS Live Data Gateway
AZURE
Confirm that a AZURE Profile exists and contains the below properties for Snowflake External OAuth
connections. Since additional information is required it is recommended that a copy be made of the AZURE
profile and any updates be completed in the copy. Once complete continue creating the connection with
OAuth authentication.
Follow the below steps when configuring the profile for Snowflake OAuth:
1.
2.
3.
4.
5.
6.
7.
Select AZURE from the Profile Name drop down.
Press the Copy button.
Populate the New Name text box with a unique name.
Press Paste to complete the copy process.
Select the newly copied profile from the Profile Name drop down.
Replace the %TENANT-ID% place holder in the property values by entering the tenant ID value in the
Replace Placeholder With text box and then pressing the Replace button.
Press Exit and continue configuring the SSO authentication information of the connection and selecting
the newly copied and update profile.
APOS Systems Inc. | Live Data Gateway Reference
289
APOS Live Data Gateway
Views
Field / Control
Description
Manage Views
Select a relational database, SSAS or BW connection from the available
connection listing and press Manage Views to launch the View
Management form. At least one view must be configured for each
relational database connection. Views are optional for SSAS or BW
connections.
Help
Field / Control
Description
About
The About form contains licensing and APOS contact information.
User Statistics
Invokes the Connections User Statistics to display user statistics.
Connections User Statistics
The Connections Users Statistics form displays user statistics for SSO Users. Press Export to CSV to export the
contents of the gird.
APOS Systems Inc. | Live Data Gateway Reference
290
APOS Live Data Gateway
Fields / Controls
Field / Control
Description
Available Connection
The Available Connection listing contains all configured connections
contained within the logged in LDG database. The following columns
exist within this listing.











Prefix – Unique prefix name assigned when configuring the
connection.
Description – A description assigned to the connection.
Datasource – The Datasource type of the connection.
Database – The relational database type if applicable.
Connection – The connection XML that will be used for the
database.
SSO Type – The security type of the connection if applicable.
Freehand SQL – Flag indicating whether the connection supports
freehand SQL configured views.
Web UI Rights – Flag to indicate whether the Web UI can be used
to create Freehand SQL views using the Web UI.
Number of Views – The number of views created for the
connection.
Is Disabled – Flag indicating whether the connection is enabled or
disabled based on the connections available. If a connection needs
to be enabled and the maximum number of connections has
already been reached, another connection can be disabled before
enabling or creating a new connection.
Is Invalid – Flag that indicates whether the connection is
supported with the APOS license.
Double click on a connection to invoke the Connection Description
Details form to update some connection details.
Build Web Config
Press Build Web Config to save the connections of the same security
type by the name of LDG_Config.xml. Once saved this file will be
deployed to the web application.
All the connections must be of the same security type. This means that
if the connection listing contains multiple security types those of the
same type must be selected prior to pressing Build Web Config.
Add
Press Add to launch the Live Data Gateway Admin to create a
connection.
Edit
Select a connection from the list and press Edit to launch the Live Data
Gateway Admin to make the desired changes.
Delete
Select a connection from the list and press Delete to remove the
connection.
APOS Systems Inc. | Live Data Gateway Reference
291
APOS Live Data Gateway
Field / Control
Description
Manage Views
Select a relational database or SSAS connection from the available
connection listing and press Manage Views to launch the View
Management form. This button is only available when either a
relational database, SSAS or BW connection is selected.




Close
Relational Database - At least one view must be configured for
each relational database.
SSAS – Optionally configure and name the dimensions and
measures that will be exposed to SAC. Views are not required
when connecting to SSAS.
BW – Optionally configure and name the dimensions and
measures that will be exposed to SAC. Views are not required
when connecting to BW.
Universes – Optionally configure and name dimensions and
measures from a universe that will be exposed to SAC. Views are
not required when connecting to universes.
Press Close to exit the form.
APOS Systems Inc. | Live Data Gateway Reference
292
APOS Live Data Gateway
Connection Description Details
Field / Control
Description
Unique Prefix
Update the Unique Prefix with a unique name. The Unique Prefix must
be unique across all views contained within the selected LDG Database.
Updating this value will affect all currently configured SAC stories using
this connection.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Update the Description for the connection if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
Disable Connection
Select the Disable Connection check box to make the selected
connection unavailable when creating a Model is SAC.
The connection may be disabled by default if using a limited
connection license and the maximum number of connections exceeds
it. To enable a connection that has been marked as disabled another
connection can be disabled before enabling or creating a new
connection.
APOS Systems Inc. | Live Data Gateway Reference
293
APOS Live Data Gateway
Field / Control
Description
Supports Freehand SQL
The Supports Freehand SQL check box is only visible when a relational
database is selected.
Select the Supports Freehand SQL check box to apply the freehand
SQL flag to allow the creation of freehand SQL views. This flag must be
set before approving DB users to creating freehand SQL through either
the desktop or Web UI applications. Any update to this setting will be
displayed in the Freehand SQL column of the Available Connection
listing.
View XML
Press View XML to return the XML Definition for the connection.
OK
Press OK to save the details.
Cancel
Press Cancel to exit the form.
APOS Systems Inc. | Live Data Gateway Reference
294
APOS Live Data Gateway
Build Web Config
Use the Build Web Config option to save the connections of the same security type by the name of
LDG_Config.xml. Once the file is saved it can copied to the deployment application.
SQL Authentication is supported during the export process.
Field / Control
Description
Server Name
Fill in the SQL Server Name to connection to.
Database Name
Fill in the Database Name to the LDG database.
User Name
Fill in the User Name that can access the LDG database.
SQL Authentication only is supported.
Password
Fill in the Password for the User Name.
Port
Fill in the Port to the SQL server.
Connection Timeout
Set the Connection Timeout in seconds. By default this value is set to
30 seconds. For unlimited use 0.
Use Only Selected Connections
All the connections must be of the same security type. This means that
if the connection listing contains multiple security types those of the
same type must be selected prior to pressing Build Web Config. As a
result the Use Only Selected Connections will be selected and
disabled in this case prior to continuing.
If no rows were selected and all connections were of the same security
type the Use Only Selected Connections check will be unchecked and
disabled.
APOS Systems Inc. | Live Data Gateway Reference
295
APOS Live Data Gateway
Field / Control
Description
Test Connection
Press Test Connection to validate the connection details entered.
Open
Press Open to load a previously configured Web Config file.
Save
Press Save to save the connection details.
Close
Press Close to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
296
APOS Live Data Gateway
Configuration Management
Provide the Licence, Java Path and SAC Tenant information in the Configuration Management form.
Field / Control
Description
Licence
Browse to the location of the license file (APOS.lic) supplied by APOS.
Once loaded verify that the license displays a valid message.
Java Path
Set the Java Path location of OpenJDK 8 supplied with this application.
The java.exe file is usually located in the directory …\Program
Files\APOS\Java\OpenJDK\jre8\bin.
New SAC Tenants
Fill in the New SAC Tenants. Multiple URLs must be separated by a
comma (,).



Existing Tenants
Add – Enter a new URL and press Add to save the URLS to the
Existing Tenants drop down and to the LDG database.
Change - Select one Tenant from the Existing Tenants drop down
to populate the New SAC Tenants text. Update this value and
press the Change button to update the selected Tenant.
Delete – Select one Tenant from the Existing Tenants drop down
to populate the New Sac Tenants text. Press Delete to remove the
Tenant from the list.
The Existing Tenants drop down contains all saved SAC Tenant URLS.
The Tenant SAC URLS will be displayed in the panel page of the Web
Admin UI.
APOS Systems Inc. | Live Data Gateway Reference
297
APOS Live Data Gateway
Field / Control
Description
Save
Press Save to save all configuration information to the LDG database.
Cancel
Press Cancel to close the form.
Live Data Gateway Admin
The Live Data Gateway Admin form used to create connections for use in SAP Analytics Cloud.
The Live Data Gateway Admin has the following tabs:

Connection – Use the Connection tab to configure connections used for SAP Analytics Cloud.

SSO Configuration – Use the SSO Configuration tab to define the SSO settings for the connection.

Date/Time and DB Functions – Use the Date/Time and DB Functions tab to support Time Dimensions
(hierarchy dates) as well as GIS Virtual Points by entering the database formulas to extract the necessary
information.
APOS Systems Inc. | Live Data Gateway Reference
298
APOS Live Data Gateway
o
o
Date/Time - Supported with the following relational databases: MS SQL Server, Oracle, Denodo,
DB2, Snowflake and Google Big Query.
GIS Virtual Points – Supported for all relational database connections when creating Semantic,
Freehand SQL or Stored Procedure views and when used with the backend database method. Only
SRID 3857 and 4326 (Mercator and Geographic) projections are supported.
Extra Properties - Use the Extra Properties tab to disable the parameterized queries for relational databases
when additional assistance is required when running in debug

The following are the controls available for the loading and saving of the connection xml files.
Field / Control
Test Connection / Test URL
Description
This button is dynamic and will change based upon the Data Source
type selected:

Test URL – Press to validate the Server URL that was entered.

Test Connection- Press to validate the Data Source connection
that has been entered for databases. See Test Connection
Requirements for the list of required database jar files that need to
be copied to the ConnectionTest_lib folder.
Note: In some cases with Generic JDBC connections additional steps
must be taken to create a successful connection by adding the
database jar file to the Manifest.MF file. Contact APOS Support for
these steps.
Save
Press Save to save the DG_Datasource.xml file. By default this file is
saved to the installed folder of this product. For deployment purposes
the xml file must be copied to the LiveDataGateway deployment folder.
Close
Press Close when finished using the Admin application.
Test Connection Requirements
When testing the connection of the database types, the required database jar file needs to be copied to the
folder ConnectionTest_lib folder that is located within the Live Data Gateway installed folder of …\Program
Files\APOS\Live Data Gateway\Admin.
Database Type
Amazon EMR
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the ConnectionTest_lib folder.
APOS Systems Inc. | Live Data Gateway Reference
299
APOS Live Data Gateway
Database Type
Database File(s)
CDATA Drivers
APOS will supply a file named APOS_CData_Drivers.zip
that includes the necessary dll and jar files to be
manually copied to the following locations:



Cloudera Hive
The dll files need to be copied to the LDG Admin
folder where the Admin exe files are installed.
Web Application Deployment: The jar files need
to be copied to

The LDG web application in the deployed
WEB-INF\lib folder

The APOSAdminTool web application in the
deployed WEB-INF\lib folder

The ConnectionTest_lib folder that is found
with the LDG Admin folder
The CDATA driver for SAP Business One DI
requires the below jar files to be copied from the
SAP Business One installation folder …\Program
Files\SAP\SAP Business One DI API\JCO\LIB

sboapi.jar

sbowapper.jar
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the ConnectionTest_lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
*Rename the version named jar file to denodo-vdpjdbcdriver.jar when copying to the ConnectionTest_lib
folder.
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
APOS Systems Inc. | Live Data Gateway Reference
300
APOS Live Data Gateway
Database Type
Database File(s)
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying to
the ConnectionTest_lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying to
the ConnectionTest_lib folder.
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
ucp.jar
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
APOS Systems Inc. | Live Data Gateway Reference
301
APOS Live Data Gateway
Database Type
Database File(s)
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
Teradata
terajdbc4.jar
tdgssconfig.jar
APOS Systems Inc. | Live Data Gateway Reference
302
APOS Live Data Gateway
Menu Options
File
Field / Control
Description
Configure Java Path
Optionally locate and Configure Java. This configuration is used when
selecting the Test Connection button. By default a version of OpenJDK
8 is installed with this application and can be found in …\Program
Files\APOS\Java\OpenJDK\jre8\bin.
New
Press New to clear all fields to create a new connection.
Open
Use the Open button to load a Non-Database Method configuration
connection file
Cancel
Press Cancel to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
303
APOS Live Data Gateway
Configure Path
Locate the version of OpenJDK 8 installed with this application by following the below steps:
1.
Browse to the installed application folder …\Program Files\APOS\Java\OpenJDK\jre8\bin
2.
Select the java.exe file.
3.
Click Open
APOS Systems Inc. | Live Data Gateway Reference
304
APOS Live Data Gateway
Help
Field / Control
Description
Help
View this Help file.
About
View the APOS contact information.
APOS Systems Inc. | Live Data Gateway Reference
305
APOS Live Data Gateway
Connections
Use the Connections tab to select the data source for the connection.




SSAS
BW
Essbase
Universes
Database
APOS Systems Inc. | Live Data Gateway Reference
306
APOS Live Data Gateway
SSAS
Field / Control
Data Source
Server URL
Description
Select the SSAS (SQL Server Analysis Services) value from the Data
Source dropdown type. This data source can be used for both MSAS and
Azure Analysis Service connections types.
Fill in the Server URL. The following are examples of the expected URL
formats:


SQL Server Analysis Services: http://Server/OLAP/msmdpump.dll
Azure Analysis Services: http://Server/VirtualFolder/apospump.aposxmla
APOS Systems Inc. | Live Data Gateway Reference
307
APOS Live Data Gateway
BW
Field / Control
Data Source
Server URL
Description
Select the BW values from the Data Source dropdown type.
Fill in the Server URL. The following are examples of the expected URL
formats:

http://Server:port/sap/bw/xml/soap/xmla
APOS Systems Inc. | Live Data Gateway Reference
308
APOS Live Data Gateway
ESSBASE
Field / Control
Data Source
Web Logic URL
Description
Select the Essbase value from the Data Source dropdown type.
Fill in the Server URL. The following is an example of the expected URL
format:

Data Source Host
http://ESSBASEServer:9000/aps/XMLA
Fill in the Data Source Host name when the Web Logic Server and the
Essbase Server are not on the same machine or are in different clusters.
APOS Systems Inc. | Live Data Gateway Reference
309
APOS Live Data Gateway
Universes
Field / Control
Data Source
Server URL
Description
Select the Universes value from the Data Source dropdown type.
Fill in the BI Server URL. The following are examples of the expected URL
formats:

http://BIServer:6405
APOS Systems Inc. | Live Data Gateway Reference
310
APOS Live Data Gateway
Database
Field / Control
Description
Data Source
Select the Database value from the Data Source dropdown type.
APOS Systems Inc. | Live Data Gateway Reference
311
APOS Live Data Gateway
Field / Control
Description
Connection String
Once the Database value has been selected, generate the connection
string by filling in the Connection String properties.
Once the connection string has been generated select the
(edit
button) to add any additional custom properties that may be desired.



SSL

MongoB Atlas
Database – Select the database type from the drop down.

BigQuery

CData Drivers

Cloudera Impala

Denodo

HANA

Hive - Includes the below databases:

Cloudera

Hortonworks

Google Cloud

Amazon EMR

IBM DB2

JDBC Generic

Microsoft SQL Server

MongoDB

MongoDB Atlas

MySQL

Netezza

Oracle

Oracle Exadata

Redshift

Sybase IQ

Sybase SQL Anywhere

Teradata
Host – Enter the Host of the database server.
Database Name – Enter the Database Name.
The SSL option is available when selecting MongoDB Atlas as the
database type. When not using SSL the below environmental variable
must be set prior to creating the XML files.

LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN=1
APOS Systems Inc. | Live Data Gateway Reference
312
APOS Live Data Gateway
SSO Configuration
Use the SSO Configuration to enable and select from an available list of SSO Authentication/Retrieval
Methods. This feature is enabled for the following connection types:



Database
SSAS
Universe
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from the available listing of Authentication/Retrieval Methods.
APOS Systems Inc. | Live Data Gateway Reference
313
APOS Live Data Gateway
Database
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from one of the following Authentication Methods.
Authentication Method – Select the Authentication Method value from
the drop down. The values listed in this drop down are based upon the
database selected. Not all options are available for all database s.




PRE-DEFINED USER – Level 1 - Assign one account to be used for all
SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
Both NTLM and SAML are supported.
IDENTITY PROVIDERS SSO – Level 2 - Assign multiple Login Users
to Database Credentials for SSO requests that will support row level
security support. Both NTLM and SAML are supported.
IMPERSONATE SSO USER – Level 3 - Connect to SAC with SQL
Server, Oracle or PostgreSQL and assign a pre-defined user to
connect to the database. Both NTLM and SAML are supported.
KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS
for SQL Server, SSAS, Denodo or Oracle. Only connections defined
with CORS are accepted
APOS Systems Inc. | Live Data Gateway Reference
314
APOS Live Data Gateway
SSAS
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from one of the three following Authentication Methods.
Authentication Method – Select the Authentication Method value from
the drop down.



PRE-DEFINED USER – Level 1 - Assign one account to be used for all
SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
Both NTLM and SAML are supported.
IDENTITY PROVIDERS SSO – Level 2 - Assign multiple Login Users
to Database Credentials for SSO requests that will support row level
security support.
KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS
for SQL Server, SQL Server Analysis Services, Denodo or Oracle. Only
connections defined with CORS are accepted.
APOS Systems Inc. | Live Data Gateway Reference
315
APOS Live Data Gateway
Field / Control
Description
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the tomcat
computer.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the tomcat computer.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. When used this
file must be saved on the tomcat computer.
Universes
Field / Control
Description
Use SSO
Select the Use SSO check box to select the Retrieval Method.
APOS Systems Inc. | Live Data Gateway Reference
316
APOS Live Data Gateway
Field / Control
Description
Retrieval Method
Select a Retrieval Method from the drop down. If selecting the retrieval
method defined on the WACS server this value must match the WACS
configuration set in the CMC.




HTTP_HEADER - Check WACS configuration setting
QUERY_STRING - Check WACS configuration setting
COOKIE - Check WACS configuration setting
PRE-DEFINED User – Select a BI user account to create a connection
in SAC to a universe.

Trusted User Name – Enter a BI user name that has
sufficient privileges to select a universe

Password – Enter the password for the BI user

Use for No Credentials – To be selected when creating the
connection within SAC. Select the Use for No Credentials
check box to support the SAC Authentication Method value
of None when creating the connection.
Use SSO
Select the Use SSO check box to enable this option and select from one of the following Authentication
Methods.
Authentication Method – Select the Authentication Method value from the drop down.

PRE-DEFINED USER – Level 1 - Connect to a relational database or SSAS and assign one account to be
used for all SSO requests coming from a trusted account. All requests will be fulfilled by using that one
account with no row level security support.

IDENTITY PROVIDERS SSO – Level 2 - Connect to a relational database or SSAS and assign multiple Login
Users to Database Credentials for SSO requests that will support row level security support. Both NTLM and
SAML are supported.

Selecting SAML requires the deployment of the SSO SAML web application.

Selecting OAuth authentication requires the deployment of the Admin Tool Web UI.

IMPERSONATE SSO USER – Level 3 – Connect to SAC with SQL Server, Oracle or PostgreSQL and assign a
user to connect to the database. Both NTLM and SAML are supported.

Selecting SAML requires the deployment of the SSO SAML web application.

KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS for SQL Server, SSAS, Denodo or
Oracle. Only connections defined with CORS are accepted.
PRE-DEFINED USER – Level 1
Selecting the PRE-DEFINED USER value from the authentication method drop down enables the ability to
assign one account to be used for all SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
Within SAC during the creation of a connection the authentication method None needs to be selected from
the SAC Authentication Method drop down.
APOS Systems Inc. | Live Data Gateway Reference
317
APOS Live Data Gateway
Field / Control
Description
Use SSO
Select the Use SSO checkbox and then select from one the following
SAC Authentication User Source options:

NTLM
Select NTLM for those connections not requiring the SAML
configuration. The user logged into the browser will be used.
SAC does not have to be configured with SSO

SAML
Select SAML to connect using the SAML SSO deployed
configuration. Requirements for this option:


SAC must be configured with SSO
The SSO SAML web application deployed and configured
Authentication Type
Select Pre-Defined User from the Authentication Type drop down.
Trusted User Name
Fill in the Trusted User Name to be used by the SSO request.
Password
Fill in the Password for the Trusted User Name.
Use for No Credentials
Select the Use for No Credentials check box when using the
connection within SAC.
APOS Systems Inc. | Live Data Gateway Reference
318
APOS Live Data Gateway
Field / Control
Description
Disable SSO for Admin
Web UI
Select Disable SSO for Admin Web UI to prompt for a DB User and
Password or the Trusted User/Password is used to log into the Web
Admin UI.
APOS Systems Inc. | Live Data Gateway Reference
319
APOS Live Data Gateway
IDENTITY PROVIDERS SSO – Level 2
Selecting the IDENTITY PROVIDERS SSO value from the authentication method drop down enables the
ability to assign multiple Login Users to Database Credentials for SSO requests that will support row level
security support.
This option requires the following prerequisites when selecting SAML:



Tomcat 8.5 min installed
Deployed saml2-sso web application configured to support SSL using the same certificate for both
LDG and Tomcat.
SAC is configured with SAML SSO.
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
APOS Systems Inc. | Live Data Gateway Reference
320
APOS Live Data Gateway
Field / Control
Description
Use SSO
Select the Use SSO checkbox and then select from one the following
SAC Authentication User Source options:

NTLM
Select NTLM for those connections not requiring the SAML
configuration. The user logged into the browser will be used.
SAC does not have to be configured with SSO

SAML
Select SAML to connect using the SAML SSO deployed
configuration. Requirements for this option:


SAC must be configured with SSO
The SSO SAML web application deployed and configured
Authentication Type
Select IDENTITY PROVIDERS SSO from the Authentication Type
drop down.
Authentication Type
Option
Select from the following list of Authentication Type Options. This
drop down is dynamic and is based upon the Database Type selected
and whether SSO2 Services or OAuth Provider Profiles have been
configured. When the OAuth option is selected additional OAuth
Information is required.
By default the following value is available:

Database User/Password
JDBC Generic – Snowflake - The following options may be
available:



KeyPair (Snowflake)
OAuth
Database User/Password
JDBC Generic – Athena – The following options may be available:


AWS (IAM)
Database User/Password
JDBC Generic – Redshift – The following options may be available:


AWS (IAM)
Database User/Password
Google Big Query – The following options may be available:


Service Account
OAuth
APOS Systems Inc. | Live Data Gateway Reference
321
APOS Live Data Gateway
Field / Control
Description
User Can Self Add to the
List
Select the User Can Self Add to the List checkbox to allow the users
to self-add to the database instead of configuring a predefined list of
users via the Identity Providers SSO button. This option is only
available when OAuth is selected in the Authentication Type
Option drop down.
*Supported with OAuth only
Identity Providers SSO
Press the Identity Providers SSO button to invoke the Identity
Providers for SSO form to associate Login Users to Database
Credentials.
Optionally for OAuth Authentication Types the user can be selfadded to the database by selecting the User Can Self Add to the
List check box.
Override Credentials
*Not supported with:


AWS Redshift and SSO2
Service deployment
OAuth
Select the Override Credentials checkbox to enable the following
options.


Trusted User Name - Fill in the Trusted User Name to be used
by the SSO request. The user is validated and verified to be on
the list (Identity Providers SSO list). This single account will then
be used to log into the database.
Password - Fill in the Password for the Trusted User Name
OAuth – Information
Snowflake
The following OAuth information is required when configuring a JDBC Generic – Snowflake
connection with OAuth Authentication selected.
Field / Control
Description
OAuth Client ID
Enter the OAuth Client ID
OAuth Secret
Enter the OAuth Secret value
Oauth Scope
Populate the Oauth Scope by invoking the OAuth Scope
form.
APOS Systems Inc. | Live Data Gateway Reference
322
APOS Live Data Gateway
Field / Control
Description
Oauth Profile
Select the Oauth Profile already configured using the OAuth
Provider Profiles form accessible through the File – OAuth
Profiles (URLs) menu option.
APOS Systems Inc. | Live Data Gateway Reference
323
APOS Live Data Gateway
Google Big Query
The following OAuth information is required when configuring a Google Big Query connection with
OAuth Authentication selected
Field / Control
Description
OAuth Client ID
Enter the OAuth Client ID
OAuth Secret
Enter the OAuth Secret value
Oauth Scope
Populate the Oauth Scope by invoking the OAuth Scope
form.
Oauth Profile
Select the Oauth Profile already configured using the OAuth
Provider Profiles form accessible through the File – OAuth
Profiles (URLs) menu option.
GBQ Project ID
Enter the Google Big Query Project ID.
OAuth Scope
Use the OAuth Scope form to create the OAuth Scope sample string for either Google or Snowflake
using Azure as the External OAuth.
Field / Control
Description
GOOGLE
Select GOOGLE when connecting to Google Big Query.
APOS Systems Inc. | Live Data Gateway Reference
324
APOS Live Data Gateway
Field / Control
Description
AZURE
Select AZURE when connecting to Snowflake using External
OAuth. Replace the placeholder
%EXTERNAL_OAUTH_AUDIENCE_LIST% with the value used
when the security was configured in snowflake.
None
Select None when no OAuth sample string is needed.
OK
Select OK to save the settings.
Cancel
Select Cancel to close the form.
APOS Systems Inc. | Live Data Gateway Reference
325
APOS Live Data Gateway
Identity Providers for SSO
Use the Identity Providers for SSO form to Associate Login Users with Database Credentials to assign
row level security support. The mapped entries will be encrypted and stored in the
DG_DataSource.xml file.
Database User/Password
Field / Control
Description
Add/Delete
Use the buttons found above the user list to Add or Delete users.
Press to add users to the list by filling in the Login User,
Database User and DB Password.
Select one or more rows and press to remove from the user
list.
User List
List of Login users that have been associated with Database users




Login User – The Login user name
Database User – The Database user name
DB Password – The Database password for the user defined.
Test Connection – Use the Test Connection button to test the
Database User and DB Password values.
Note: The Test Connection button is available when creating
database connections. It is not available for data sources that use the
xmla connections such as SSAS, BW and ESSBASE.
APOS Systems Inc. | Live Data Gateway Reference
326
APOS Live Data Gateway
Field / Control
Description
Import Users
Press Import Users to select a comma delimited (CSV) file containing
Login Users and their associated Database User and Password. This
option will add and/or overwrite users from the grid with the values
extracted from the CSV file. All fields are required, any missing will result
in the user not being added.
Replace Users
Press Replace Users to select a comma delimited (CSV) file containing
Login Users and their associated Database User and Password. This
option will replace the users from the grid with the ones from the CSV file.
All fields are required any missing will result in the user not being added.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
APOS Systems Inc. | Live Data Gateway Reference
327
APOS Live Data Gateway
AWS (IAM)
The Identity Providers for SSO form provides the opportunity to associate SAML/NTLM users with SSO
and Database Users when using JDBC Generic AWS Athena/Redshift connections. The AWS (IAM)
option is available when the AWS SSO2 Service has been configured.
Field / Control
Description
Add/Delete
Use the buttons found above the user list to Add or Delete users.
Press to add users to the list by filling in the SAML/NTLM User,
SSO User and the Database User.
Select one or more rows and press to remove from the user
list.
Delete Notes: When a user is deleted the data is not removed
from the database at this stage. The service will remove it
from the table. If the names are used by some connections
they will be removed from the connection mapping. If the
user name is added back to the database and the service has
not yet deleted it, the user name will be reactivated however
the user must be added to the connection again.
User List
List of Users that have been associated with Database users



SAML/NTLM User – The OS User name
SSO User – The SSO AWS User name
Database User – The AWS Redshift User Name. This user is not
required for Athena.
APOS Systems Inc. | Live Data Gateway Reference
328
APOS Live Data Gateway
Field / Control
Description
Import Users
Press Import Users to select a comma delimited (CSV) file containing
SAML/NTLM Users, SSO Users and Database User. This option will add
and/or overwrite users from the grid with the values extracted from the
CSV file. All fields are required, any missing will result in the user not
being added.
Replace Users
Press Replace Users to select a comma delimited (CSV) file containing
SAML/NTLM Users, SSO Users and Database User. This option will replace
the users from the grid with the ones from the CSV file. All fields are
required any missing will result in the user not being added.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
Key Pair (Snowflake)
The Identity Providers for SSO form provides the opportunity to associate SAML/NTLM users with SSO
Users when using JDBC Generic Snowflake connections. The Key Pair (Snowflake) option is available
when the Snowflake SSO2 Service has been configured.
Field / Control
Description
APOS Systems Inc. | Live Data Gateway Reference
329
APOS Live Data Gateway
Field / Control
Description
Add/Delete
Use the buttons found above the user list to Add or Delete users.
Press to add users to the list by filling in the SAML/NTLM User
and SSO Database User.
Select one or more rows and press to remove from the user
list.
Delete Notes: When a user is deleted the data is not removed
from the database at this stage. The service will remove it
from the table. If the names are used by some connections
they will be removed from the connection mapping. If the
user name is added back to the database and the service has
not yet deleted it, the user name will be reactivated however
the user must be added to the connection again.
User List
List of Users that have been associated with Database users


SAML/NTLM User – The OS User name
SSO User – The SSO AWS User name
Import Users
Press Import Users to select a comma delimited (CSV) file containing
SAML/NTLM Users and SSO Users This option will add and/or overwrite
users from the grid with the values extracted from the CSV file. All fields
are required, any missing will result in the user not being added.
Replace Users
Press Replace Users to select a comma delimited (CSV) file containing
SAML/NTLM Users and SSO. This option will replace the users from the
grid with the ones from the CSV file. All fields are required any missing
will result in the user not being added.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
APOS Systems Inc. | Live Data Gateway Reference
330
APOS Live Data Gateway
OAuth
The Identity Providers for SSO form provides the opportunity to associate SAML/NTLM users with SSO
Users when using an OAuth Authentication Type.
Field / Control
Description
Add/Delete
Use the buttons found above the user list to Add or Delete users.
Press to add users to the list by filling in the SAML/NTLM User.
Select one or more rows and press to remove from the user
list.
Delete Notes: When a user is deleted the data is not removed
from the database at this stage. The service will remove it
from the table. If the names are used by some connections
they will be removed from the connection mapping. If the
user name is added back to the database and the service has
not yet deleted it, the user name will be reactivated however
the user must be added to the connection again.
User List
List of Users that have been associated with Database users

SAML/NTLM User – The OS User name
APOS Systems Inc. | Live Data Gateway Reference
331
APOS Live Data Gateway
Field / Control
Description
Import Users
Press Import Users to select a comma delimited (CSV) file containing
SAML/NTLM Users. This option will add and/or overwrite users from the
grid with the values extracted from the CSV file. All fields are required and
any missing will result in the user not being added.
Replace Users
Press Replace Users to select a comma delimited (CSV) file containing
SAML/NTLM Users and SSO. This option will replace the users from the
grid with the ones from the CSV file. All fields are required any missing
will result in the user not being added.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
APOS Systems Inc. | Live Data Gateway Reference
332
APOS Live Data Gateway
IMPERSONATE SSO USER – Level 3
Select the IMPERSONATE SSO USER option when connecting SAC with MS SQL Server, Oracle or
PostgreSQL.
This option requires the following prerequisites when selecting SAML:



Tomcat 8.5 min installed
Deployed saml2-sso web application configured to support SSL using the same certificate for both
LDG and Tomcat.
SAC is configured with SAML SSO.
For SQL Server the implementation will use the “Execute As” statement. Because of that the Microsoft
requirements for the “Execute As” user (which is the SAML user) must be met.
Check https://docs.microsoft.com/en-us/sql/t-sql/statements/execute-as-transact-sql paragraph “Specifying
a User or Login Name”.
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
APOS Systems Inc. | Live Data Gateway Reference
333
APOS Live Data Gateway
Field / Control
Description
Use SSO
Select the Use SSO checkbox and then select from one the
following SAC Authentication User Source options:

NTLM
Select NTLM for those connections not requiring the
SAML configuration. The user logged into the browser
will be used. SAC does not have to be configured with
SSO

SAML
Select SAML to connect using the SAML SSO deployed
configuration. Requirements for this option:


SAC must be configured with SSO
The SSO SAML web application deployed and
configured
Authentication Type
Select IMPERSONATE SSO USER from the Authentication
Type drop down.
Trusted User Name
Fill in the Trusted User Name that has sufficient rights to the
database.
Password
Fill in the Password for the Trusted User Name.
Domain Name
Enter the Domain Name for the browser authenticated user.
APOS Systems Inc. | Live Data Gateway Reference
334
APOS Live Data Gateway
KERBEROS SSO – Level 3
Select the KERBEROS SSO option when connecting SAC SSO with one of the below Kerberos/ADFS
connection types using login account. This is only available when connecting to SAC SSO with CORS.




SSAS
Microsoft SQL Server
Oracle
Denodo
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
SSAS
Field / Control
Description
Authentication Type
Select KERBEROS SSO from the Authentication Type drop
down.
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must
be saved on the deployment machine.
APOS Systems Inc. | Live Data Gateway Reference
335
APOS Live Data Gateway
Field / Control
Description
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file
must be saved on the deployment machine.
APOS Systems Inc. | Live Data Gateway Reference
336
APOS Live Data Gateway
Microsoft SQL Server
Field / Control
Description
Authentication Type
Select KERBEROS SSO from the Authentication Type drop down.
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the tomcat
computer.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the tomcat computer.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file must
be saved on the tomcat computer.
Oracle
Field / Control
Description
Authentication Type
Select KERBEROS SSO from the Authentication Type drop down.
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the deployment machine.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file must
be saved on the deployment machine.
APOS Systems Inc. | Live Data Gateway Reference
337
APOS Live Data Gateway
Field / Control
Description
Database User Proxy
Fill in the oracle Database User Proxy.
User Proxy Password
Fill in the oracle database User Proxy Password.
Denodo
Field / Control
Description
Connection String
Append the value ?useKerberos=true to the end of the Connection
String when defining for Kerberos SSO.
APOS Systems Inc. | Live Data Gateway Reference
338
APOS Live Data Gateway
Date/Time and DB Functions
The Date/Time and DB Functions tab allows for the support for GIS Virtual Points and Time Dimensions
(hierarchy dates) by entering the formulas to extract from the database field. For each Date Time string value
function a corresponding Date Time numeric value must be entered. Removing any of these functions that are
being used in SAC stories will break the story.

Date/Time - This option is supported with the following relational databases and will be pre-populated
with the functions as the database is selected.

MS SQL Server

Oracle

Denodo

Google Big Query

DB2

Snowflake - Since this falls under the category of JDBC Generic, the functions will not be prepopulated but rather can be loaded from an external XML file.

GIS Virtual Points - Supported for all relational database connections when creating Semantic,
Freehand SQL or Stored Procedure views and when used with the backend database method. Only SRID
3857 and 4326 (Mercator and Geographic) projections are supported.
Field / Control
Description
Date Time Functions for
Time Definition
Enter the formulas to extract the year, quarter, month, week and/or day
from the date field as a string value.
(string values)
APOS Systems Inc. | Live Data Gateway Reference
339
APOS Live Data Gateway
Field / Control
Description
Date Time Functions
Enter the formulas to extract the year, quarter, month, week and/or day
from the date field as a numeric value.
(numeric values)
Syntax Concatenation
Enter the syntax for concatenation.
Length Function
Enter the syntax for length function.
String Conversion Function
Enter the syntax for the function to convert to a string.
Logarithmic Function
Enter the syntax for the function to return the logarithm of a number.
Support LAG Function
Select for when the database supports the LAG function. When
unselected the database must support the below. When unselected and
they below is not supported, variance is not supported for the database.

CTE (Common Table Expression) tables

ROW_NUMBER function
Load Default
Press Load Default to replace all settings with the default database type
settings.
Load From File
Load the functions from an external XML file. This option is to be used for
databases configured with the JDBC Generic connection.

Snowflake – The SnowflakeFormula.xml file has been included in
the setup and can be found in the following directory.
…\Program Files\APOS\Live Data Gateway\Admin
APOS Systems Inc. | Live Data Gateway Reference
340
APOS Live Data Gateway
Extra Properties
Use the Extra Properties tab to disable the parameterized queries for relational databases when additional
assistance is required when running in debug.
Field / Control
Description
Disable Parameterized
Queries
Select Disable Parameterized Queries to enable addition logging when
debug is required. By default this option is not selected and should only
be selected when additional debugging is required in order to trouble
shoot errors in the log file.
This option is applicable for relational database connections.
APOS Systems Inc. | Live Data Gateway Reference
341
APOS Live Data Gateway
Field / Control
Description
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
342
APOS Live Data Gateway
View Management
Use the View Management form to configure Freehand SQL, Relational, Spatial or Stored Procedure view types using
the following tabs.

Semantic Layer View Management – Configure Relational or Spatial views for relational databases, SSAS, BW
and universes.

Relational Database - At least one view must be configured for each relational database.

SSAS – Optionally configure and name the dimensions and measures that will be exposed to SAC. Once a
view has been configured for a SSAS connection all other cubes will not be displayed in SAC during the
Model creation for that connection. Views are not required when connecting to SSAS.

BW – Optionally configure and name the dimensions and measures the will be exported to SAC. Once a
view has been configured for a BW connection all other cubes will not be displayed in SAC during the Model
creation for that connection. Views are not required when connecting to BW.

Universes – Optionally configure and name the dimensions and measures from a universe that will be
exposed in SAC. Once a view has been configured for a universe connection all other universes will not be
displayed in SAC during the Model creation for that connection. Views are not required when connecting to
universes.

Freehand SQL View Management – Configure Freehand SQL views for relational databases.

Relational Database - At least one view must be configured for each relational database.

Stored Procedure View Management – Configure Stored Procedure views when connecting to MS SQL.
Connections using JDBC Generic to SQL Server are not supported.

MS SQL Database - At least one view must be configured for each database.
APOS Systems Inc. | Live Data Gateway Reference
343
APOS Live Data Gateway
Field / Control
Description
Available View Management
The Available View Management listing contains all configured views
within the logged in LDG database. The following columns exist within
this listing.




Add
Based upon the selected tab launch the View Wizard to configure a
view.



Edit
View Name – Unique view name assigned when configuring the
view.
Description – A description assigned to the view.
View – The configured view XML string saved to the database.
Owner – The DB owner of the view.
Semantic Layer View Management – Press Add to launch the
View Wizard - Semantic to configure a view.
Freehand SQL View Management – Press Add to launch the View
Wizard – Freehand SQL to configure a view.
Stored Procedure View Management – Press Add to launch the
View Wizard – Stored Procedure to configure a view.
Based upon the selected tab launch the View Wizard to edit a view.



Semantic Layer View Management – Press Edit to launch the
View Wizard - Semantic to make the desired changes.
Freehand SQL View Management – Press Edit to launch the View
Wizard – Freehand SQL to make the desired changes.
Stored Procedure View Management – Press Edit to launch the
View Wizard – Stored Procedure to make the desired changes.
Delete
Select a view from the list and press Delete to remove it.
Refresh
Press Refresh to re-load the information from the connected LDG
database.
Import
Press Import to browse for a view file created using the Non-Database
Method to retrieve the view information. Once the XML file is selected
the View Description Details dialog will load to save the view to the
LDG database.
Share
Select one or more views from the list and press Share to invoke the
Users Management form to assign the DB Users that can access the
view when creating a SAC model.
Close
Press Close to exit the form.
APOS Systems Inc. | Live Data Gateway Reference
344
APOS Live Data Gateway
Menu Options
Views
Field / Control
Description
Add
Based upon the tab selected launch the View Wizard to configure a
view.



Edit
Semantic Layer View Management – Press Add to launch the
View Wizard - Semantic to configure a view.
Freehand SQL View Management – Press Add to launch the View
Wizard – Freehand SQL to configure a view.
Stored Procedure View Management – Press Add to launch View
Wizard – Stored Procedure to configure a view.
Based upon the tab selected launch the View Wizard to edit a selected
view.



Semantic Layer View Management – Press Edit to launch the
View Wizard - Semantic to make the desired changes.
Freehand SQL View Management – Press Edit to launch the View
Wizard – Freehand SQL to make the desired changes.
Stored Procedure View Management – Press Edit to launch the
View Wizard – Stored Procedure to make the desired changes.
Delete
Select a view from the list and press Delete to remove the View.
Refresh
Press Refresh to refresh the view listing from the LDG database.
Change Owner
Select one or more views from the list and press Change Owner to
invoke the Assign Owner Management form to assign the DB Users that
own the view.
Share View
Select one or more views from the list and press Share View to invoke
the Users Management form to assign the DB Users that can access the
view when creating a SAC model.
APOS Systems Inc. | Live Data Gateway Reference
345
APOS Live Data Gateway
Field / Control
Description
Close
Press Close to exit from the form.
APOS Systems Inc. | Live Data Gateway Reference
346
APOS Live Data Gateway
Users Management
With the Users Management form assign Database Users rights when accessing the views in SAC. When more
than one view has been selected, any updates will apply to all of them.
Field / Control
Description
View(s)
The listing of View(s) that were selected to be shared.
Owner(s)
The listing of Owner(s) of the views that were selected.
APOS Systems Inc. | Live Data Gateway Reference
347
APOS Live Data Gateway
Field / Control
Description
DB Users Sharing View
Select the level of sharing for the DB users when accessing the views in
SAC.



Global View
Select to allow everyone rights to access the view.
Private View
Select to allow only the owner to access the view.
Available to the owner and to the database users from the list
Select to assign the DB users who, along with the owner, will have
rights to access the view.

Users – Listing of DB Users who have been added.

Share with User – Enter the DB User to be added to the
listing.

Add – Press to Add the DB User to the listing.

Import – Press to Import a CSV file of DB Users to the
listing.

Delete – Remove users from the listing by selecting one
or more in the listing and press Delete.
Save
Press to Save all updates.
Close
Press Close to exit the form.
APOS Systems Inc. | Live Data Gateway Reference
348
APOS Live Data Gateway
Assign Owner Management
With the Assign Owner Management form assign the DB Owner for the selected views. When more than one
view has been selected, any updates will apply to all of them.
Field / Control
Description
User Name
Enter the User Name and assign a new owner for the view. By default
the owner is the username used to log into the LDG Manager. For a
connection where the database does not require a username to login
the value Not Assigned will be used as the owner.
Connection
The Connection name of the view(s) selected.
Views
The listing of View(s) that were selected to be updated.
Save
Press to Save all updates.
Close
Press Close to exit the form.
APOS Systems Inc. | Live Data Gateway Reference
349
APOS Live Data Gateway
View Wizard – Semantic
Use the Live Data Gateway View Wizard form to create semantic view model(s) for the selected relational
database, SSAS or BW connection. For more information on the creation of views see the Live Data Gateway
Admin User Guide.
The APOS Semantic Layer views are designed to describe only Star or Snowflake data structures. This guarantees
that the end user can choose any measure and dimension combination and they will all be valid. If you have to
use other structures you will wither need to use a freehand SQL view or you can wrap those structures in a
database view and bring them into the semantic layer view. You should not have multiple fact tables in a
semantic layer view as a dimension might need to be joined to both creating a bad join. Multiple fact tables need
to be joined at the database level in a database view so that the database view can be used as a single fact table
in the semantic layer view.
The idea behind a semantic layer is to obfuscate the complex data structure of the database. We do not want to
create a situation in which the user needs to know not to choose certain fields together because it will cause the
joins not to work. All the measures and dimensions in a semantic layer view must be relatable. If they are not they
need to be separated into separate views.

Relational Database - At least one view must be configured for each relational database connection that
will be exposed to SAC.

SSAS – Views are supported with SSAS connections. Within the view configure and name the
dimensions and measures that will be exposed to SAC. Once a view has been configured for a SSAS
connection all other cubes will not be displayed in SAC during the Model creation. Views are not
required when connecting to SSAS.

BW – Views are supported with BW connections. When creating views configure and name the
dimensions and measures that will be exposed to SAC. Once a view has been configured for a BW
connection all other cubes will not be displayed in SAC during the Model Creation. Views are not
required when creating connections to BW.

Universes – Views are supported with Universe connections. When creating views configure and name
the dimensions and measures that will be exposed to SAC. Once a view has been configured for a
Universe connection all other universes will not be displayed in SAC during the Model Creation. Views
are not required when creating connections to Universes.
APOS Systems Inc. | Live Data Gateway Reference
350
APOS Live Data Gateway
Relational Database
Use the Live Data Gateway View Wizard form to create at least one view model for the selected relational
database that will be exposed in SAC during the Model creation.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Non JDBC Generic
The following first form in the Wizard will appear when creating a view with a Non JDBC Generic connection.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
DSN
The DSN text box is available when configuring the below database
connections types. Configure the 64 bit ODBC DSN and enter the name in
this field.








BigQuery
Cloudera-Impala
Denodo
HANA
Hive
Oracle Exadata
Sybase SQL Anywhere
SybaseIQ








BigQuery
Cloudera-Impala
Denodo
HANA
Hive – Includes the following:

Cloudera

Hortonworks

Google Cloud

Amazon EMR
Sybase SQL Anywhere
SybaseIQ
Oracle Exadata
APOS Systems Inc. | Live Data Gateway Reference
351
APOS Live Data Gateway
Field / Control
Description
Connection String
The Connection String is generated and displayed.
Teradata – The Connection String can be updated to use ADO.Net
instead of java using the below format:
Data Source=172.0.0.1;database=dbname;
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Fields.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
352
APOS Live Data Gateway
JDBC Generic
The following first form in the Wizard will appear when creating a view with a JDBC Generic connection.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
DSN
By default the meta data to create the view is obtained by the
JDBC driver. Alternatively an ODBC DSN 64 bit connection can
be used instead.


Connection String
Use DSN – Select the Use DSN check box to use the
ODBC DSN connection to obtain the meta data to create
the view.
DSN - The DSN text box is available when configuring the
below database connections types. Configure the 64 bit
ODBC DSN and enter the name in this field.
The Connection String is generated and displayed.
When using an ODBC DSN connection to create the view the
Connection String can be customized by adding additional
arguments.
APOS Systems Inc. | Live Data Gateway Reference
353
APOS Live Data Gateway
Field / Control
Description
Properties File
When using an ODBC DSN connection to create the view a
Properties File must be selected. This file will be used to store
the query to extract the relationship between tables used on
the relationship tab in the Wizard. The following files have
been supplied for selection at this time in the installed Admin
folder:



OData Query Limits
Greenplum.APOSProperties
PostgreSQL.APOSProperties
SQLServer.APOSProperties
Set a predefined number of records to be returned when using
the OData Gateway service when queries to be executed are
unlimited or the row limit is 2,147,483,647. These values can
be set at both the connection and view level. Any values set
on the view level take precedence over the connection level
query limits. By default the Use Default Values is selected.

Use Default Values – Select to use the default values of
the application. When unselected the following can be set
for limits:

Query Contains Aggregation – Set the number of
records to be returned when the query contains
aggregation for measures.

Query Without Aggregation – Set the number of
records to be returned when the query contains more
than one dimension and no aggregation measures.
If one dimension is requested then the query will
remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Fields.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
354
APOS Live Data Gateway
Select Fields
Use the form to select fields from the available listing and then proceed to assigning measures to one or
more of the selected numeric fields.
Field / Control
Description
View Name
Display of the View Name being configured.
Load All Schema(s)
Press Load Table Schema to load all schemas and their tables/fields
available for the analytical view.
Load View Schema
Press Load View Schema to load just the schema of the view being
edited. This button is enabled when editing a view.
Define Time Dimensions
For those connections with Time Dimensions defined, press Define
Time Dimensions to invoke the Time Dimension Management form
to configure them.
This option is enabled for the below relational database connections.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
APOS Systems Inc. | Live Data Gateway Reference
355
APOS Live Data Gateway
Field / Control
Description
Virtual Point Definition
Press Virtual Point Definition to invoke the Virtual Point
Management form to configure virtual point settings.
Filters
Search for a specific schema and table using the Filters option. The
filter function is case sensitive.

Enter Schema – Enter the schema to be filtered. The % character
can be used as a wildcard character.

Enter Table – Enter the table to be filtered. The % character can
be used as a wildcard character.

Search – Press the Search button to load all results.
Fields Available for
Selection
Navigate through the available listing of tables and select the desired
fields.
Refresh
Press Refresh to display the selected fields to the Summary of the
selected fields.
Summary of the selected
fields
Displays a summary listing of all the fields that were selected.
Refresh Metadata for
Selected Fields
Press Refresh Metadata for Selected Fields to refresh metadata for
the existing view.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign Measures.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
356
APOS Live Data Gateway
Time Dimension Management
Use the Time Dimension Management form to create Time Dimensions in the view for those connections
with Time Dimensions configured. This option is enabled for the below relational database.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Field / Control
Description
Existing Time Dimensions
Any configured time dimensions will be displayed in the Existing
Time Dimensions pane.
Press to Add new Time Dimensions
Select a Time Dimension from the list and press to Delete
to remove it. Removing time dimensions that are being
used in SAC stories will break the story.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned. This value must
be unique across all dimensions and measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned in the view.
This value must be unique across all dimensions and measure Names
in the view.
APOS Systems Inc. | Live Data Gateway Reference
357
APOS Live Data Gateway
Field / Control
Description
Select Database Field
Select the Database Field from the drop down. The drop down will
contain only those fields that were configured as either date or
timestamp fields.
Time Definition
Select the Time Definition to be assigned to the dimension. The drop
down will contain only those Datetime Functions assigned in the
Time Dimension tab of the Connection. The following time definitions
are available for selection from the drop down when all the functions
are enabled.







Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be updated with all dimensions that are generated as a
result of the definition. These levels cannot be modified in the Admin.
Apply
Press the Apply button to add the Time Dimension to the Existing
Time Dimensions listing.
Close
Select Close to exit from the form.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed and is
automatically generated using the following convention: Time Dimension ID underscore (_) Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
APOS Systems Inc. | Live Data Gateway Reference
358
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week,
Day
APOS Systems Inc. | Live Data Gateway Reference
359
APOS Live Data Gateway
Virtual Point Management
Use the Virtual Point Management form when defining a virtual point when implementing spatial
functionality. Joins between tables are not allowed when defining virtual points so ensure that all fields are
part of one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
Existing Virtual Points (View
Names)
The Existing Virtual Points listing contains any virtual points that have
been defined.
Virtual Point Settings
Assign the View Name, Dimension ID, Name, Mapping Identifier as
well as the Virtual Point Database Definition.
Apply
Press Apply to save the virtual point settings.
Close
Press Close to exit from the management form.
APOS Systems Inc. | Live Data Gateway Reference
360
APOS Live Data Gateway
Existing Virtual Points
The listing contains all virtual point views that have been defined.
Field / Control
Description
View Names
The View Names contains a listing of all Virtual Points views that have
been defined.
Add/Edit
Select the + button to either Add or Edit a virtual point view setting.
Delete

Add – Select the + button to add the virtual point setting
information

Edit - Select a View Name from the listing and click the + button
to edit the virtual point settings to update a view.
Select a View Name from the listing and click X to remove a view.
APOS Systems Inc. | Live Data Gateway Reference
361
APOS Live Data Gateway
Define Virtual Points
Edit/Add a View to assign the virtual point information.
Field / Control
Description
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension Name
Set the Location Dimension Name.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Identifier for Mapping
Set the Identifier for Mapping.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Virtual Point – Database
Definition
Set the virtual point information by setting the columns in each of the
following drop downs. The values contained in the drop downs are
based upon the selected fields prior to clicking the Virtual Point
Management button.




Select Source - Select from the drop down the source table that
contains the latitude, longitude and identifier (location key)
columns.
Column Name – Latitude - Select the latitude column from the
drop down.
Column Name – Longitude - Select the longitude column from
the drop down.
Identifier for Mapping Column - Select the identifier (location
key) column from the drop down.
APOS Systems Inc. | Live Data Gateway Reference
362
APOS Live Data Gateway
Field / Control
Description
Projection Details (SRID)
Set the Project Details SRID codes.


Database – Enter the SRID code for the points stored. For
example if the points are stored in the geographical projection
and the data appears in the format (42.63 , 60.20) the SRID code
would be 4326
SAC – Enter the web projection SRID code for SAC. By default
this value has been set with a SRID code of 3857
Database Supports Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
363
APOS Live Data Gateway
Assign Measures
Use the form to Assign Measures to the selected numerical fields and then proceed to assigning dimension
names.
Field / Control
Description
View Name
Display of the View Name being configured.
Measures Listing
The Measures Listing will contain all numerical fields that can be used
as measures. The below columns are contained within this listing:





Is Measure – Select at least one row as a measure.
Measure Name – Assign a Measure Name if the Assign Default
Names for Measures check box is not selected.
DB Field Name – The field name of the measure.
Aggregation – Select one of the aggregation values available in
the drop down:

SUM

AVG

MIN

MAX

COUNT – supported on dimensions for non-numeric
values
Table Name – The table name of the field.
Assign Default Aliases
Select the Assign Default Names For Measures check box to have
the DB Fields Names used as the measure name.
Check All Measures
Select Check All Measures to select all valid measures in the list.
APOS Systems Inc. | Live Data Gateway Reference
364
APOS Live Data Gateway
Field / Control
Description
Uncheck All Measures
Select to Uncheck All Measures in the list.
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Assign Dimension Names.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to View Management.
Assign Dimension Names
Use the form to Assign Dimension Names before proceeding to assigning the relationships between the
selected tables. Any Time Dimensions configured will be displayed here and can only be edited by using the
Time Dimension Management form.
Field / Control
Description
View Name
Display of the View Name being configured.
APOS Systems Inc. | Live Data Gateway Reference
365
APOS Live Data Gateway
Field / Control
Description
Dimension List
The Dimension List contains both the non-numerical selected fields
as well as those numerical fields that were not selected as a measure
on the previous form. The below columns are found within the listing:






Dimension Name – When not using the default name, populate
this cell with a desired name.
DB Field Name
Dimension Group – When not using the default group name,
populate this cell with a desired name.
Table Name
Data Type – The data type is set to ST_POINT when the database
contains a real spatial column.
CharSize
The following Geo Mapping Columns will be displayed if either a
virtual point (VPOINT) has been defined or a real spatial column
(ST_Point) in the database was selected. These values can be edited in
the Virtual Point Management form.







View Name
Identifier for Mapping
Identifier for Mapping Column
DB Projection (SRID)
SAC Projection (SRID)
Database Supports Spatial
Allow Re-projection
Assign Default Names for
Dimensions
Select the Assign Default Names For Dimensions check box to have
the DB Fields Names used as the dimension name.
Use Table as Dimension
Group
Select the Use Table as Dimension Group check box to have the
table name as the dimension name instead of the default listed group
name.
Clear Dimension Names
Press the Clear Dimension Names button to clear the Dimension
Name values.
Clear Group Names
Press the Clear Group Names button to clear the values entered in
the Dimension Group column so that new values can be entered in
the cells.
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Assign Relationships.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the View Management.
APOS Systems Inc. | Live Data Gateway Reference
366
APOS Live Data Gateway
Assign Relationships
Use the form to Assign Relationships between the two or more tables selected before creating the view
definition.
Field / Control
Description
View Name
Display of the View Name being configured.
Get Relationship From
Database
Press Get Relationship From Database to load the available
relationship from the database to the listing. If relationships have not
been configured within the database they will have to be manually
entered in this form.
Add New Row
Press Add New Row to manually add a relationship row to the listing.
Once the row is added, populate the cells with the relationship info.
Delete All
Press Delete All to delete all rows in the listing.
Validate
Press Validate to confirm the accuracy on all the relationship
information contained in the listing.
APOS Systems Inc. | Live Data Gateway Reference
367
APOS Live Data Gateway
Field / Control
Description
Relationship Listing
When configuring a new view the Relationship Listing is blank and
will need to be selected. The below columns are listed:







Relationship Name – The relationship name.
Table 1 – The first table name.
Table 1 Column Key – The first table linking field name.
Table 1 Owner – The first table owner/schema/database.
Table 2 – The second table name.
Table 2 Column Key – The second table linking field name.
Table 2 Owner – The second table owner/schema/database.
Remove Unused Joins
Select the Remove Unused Joins check box to only include those
rows that are relevant to the fields selected. Pressing the Validate
button will cause any extra rows to be removed.
Back
Press Back to go back to the previous page of the Wizard.
Finish
Press Next to proceed to the next form to Create the View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
368
APOS Live Data Gateway
Create View Definition
Create the view definition based upon the previous field sections. Once complete save the view definition
and either exit the Wizard or create additional views within this configuration file.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
databases. Once this is successfully generated -ensure that it is saved
prior to proceeding.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management
APOS Systems Inc. | Live Data Gateway Reference
369
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the View to the LDG database. Ensure that the entered
View Name is unique across all views contained within the current LDG database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The View Name must be
unique across all views contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
370
APOS Live Data Gateway
SSAS
Use the Live Data Gateway View Wizard form to optionally create SSAS or Azure Analysis Service Views to
configure and name the dimensions and measures that will be exposed to SAC. Once a view has been
configured for a SSAS type connection all other cubes will not be displayed in SAC during the Model creation for
that connection. Views are not required when creating SSAS type connections.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database when using
basic authentication. When using Windows Authentication this value is
not required.
Password
Enter the Password for the User identified. When using Windows
Authentication this value is not required.
Connection String
The Connection String is generated and displayed.
View Name
Enter the View Name to be configured. This value is pre-populated with
a default name but can be changed. The View Name must be unique
across all views contained within the selected LDG Database.
View Definition
The View Definition contains the XML string generated by selecting the
Create View Definition once the measures and dimensions have been
selected and the ID and Alias assigned.
Show Value Zero in Results
Select Show Value Zero in Results to show empty records in charts or
tables in SAC. When this option is not selected the empty records will not
be viewed.
APOS Systems Inc. | Live Data Gateway Reference
371
APOS Live Data Gateway
Field / Control
Description
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Fields.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
372
APOS Live Data Gateway
Select Fields
Use the form to Select Fields from the available listing and then proceed to assigning the Names and IDs for
the measures and dimensions.
The maximum number of measures that can be selected is 200.
Field / Control
Description
View Name
Display of the View Name being configured.
Load Cubes
Press Load Cubes to load all cubes to select the fields.
Search for Cubes
Search for Cubes by entering a value followed by the Search button
to load all cubes that match the criteria. The % character can be used
as a wildcard character.
Select Measures and
Dimensions from a Cube
Displays a listing of cubes and their measures and dimensions
available for selection. When selecting measures and dimensions
ensue that they are from only one cube. An entire cube can be
selected.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign the IDs and Aliases for the Measures
and Dimensions selected.
Save
The Save button is not enabled for selection on this form.
APOS Systems Inc. | Live Data Gateway Reference
373
APOS Live Data Gateway
Field / Control
Description
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
374
APOS Live Data Gateway
Assign ID and Aliases
Use the form to Assign the ID and the Aliases for the selected dimensions and measures.
Field / Control
Description
View Name
Display of the View Name being configured.
Measures and Dimensions
Listing
The Measures and Dimensions Listing contain all the fields selected
from a cube. The below columns need to be populated before
continuing:


Dimension ID – Populate the ID column with unique values. If
desired used the Assign Unique Names as ID button to populate
this column. Spaces are not supported when assigning this value.
Dimension Alias - Populate the Alias column with unique alias
names. If desired used the Assign Dimension Names as Alias
button to populate this column. Spaces are not supported when
assigning this value
Assign Unique Names as ID
Select the Assign Unique Names as ID button to populate all
Dimension ID rows with unique values.
Assign Dimension Names as
Alias
Select the Assign Dimension Names as Alias button to populate all
Dimension Alias rows with unique values.
Clear ID
Press the Clear ID button to clear all Dimension ID values.
Clear Alias
Press the Clear Alias button to clear all Dimension Alias values.
APOS Systems Inc. | Live Data Gateway Reference
375
APOS Live Data Gateway
Field / Control
Description
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Create View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
376
APOS Live Data Gateway
Create View Definition
Create the View Definition based upon the dimension selections. Once complete save the view definition
and either exit the Wizard or create additional views within this configuration file.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
SSAS. Once this is successfully generated -ensure that it is saved prior
to proceeding.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
377
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the View to the LDG database. Ensure that the entered
View Name is unique across all views contained within the current LDG database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The View Name must be
unique across all views contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
378
APOS Live Data Gateway
BW
Use the Live Data Gateway View Wizard form to optionally create BW Views to configure and name the
dimensions and measures that will be exposed to SAC. Once a view has been configured for a BW connection all
other cubes will not be displayed in SAC during the Model creation for that connection. Views are not required
when creating BW connections.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database when using
basic authentication.
Password
Enter the Password for the User identified.
Connection String
The Connection String is generated and displayed.
View Name
Enter the View Name to be configured. This value is pre-populated with
a default name but can be changed. The View Name must be unique
across all views contained within the selected LDG Database.
View Definition
The View Definition contains the XML string generated by selecting the
Create View Definition once the measures and dimensions have been
selected and the ID and Alias assigned.
APOS Systems Inc. | Live Data Gateway Reference
379
APOS Live Data Gateway
Field / Control
Description
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Cubes/Bex Queries.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
380
APOS Live Data Gateway
Select Cube/Bex Queries
Use the form to select dimensions and measures from a Cube/Bex Query in the listing and then proceed to
assigning the Names and IDs for the measures and dimensions.
The maximum number of measures that can be selected is 200.
Field / Control
Description
View Name
Display of the View Name being configured.
Load Cubes and Bex Queries
Press Load Cubes and Bex Queries to load all cubes/queries to select
from.
Search for Cubes
Search for cubes and Bex queries by entering a value followed by the
Search button to load all that match the criteria. The % character can
be used as a wildcard character.
Select a Cube/Bex Query or
Measures and Dimensions
Displays a listing of cubes/queries and their measures and dimensions
available for selection. When selecting measures and dimensions
ensue that they are from only one cube/query. An entire cube/query
can be selected.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign the IDs and Names for the Measures
and Dimensions selected.
Save
The Save button is not enabled for selection on this form.
APOS Systems Inc. | Live Data Gateway Reference
381
APOS Live Data Gateway
Field / Control
Description
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
382
APOS Live Data Gateway
Assign ID and Aliases
Use the form to Assign the ID and the Aliases for the selected dimensions and measures.
Field / Control
Description
View Name
Display of the View Name being configured.
Measures and Dimensions
Listing
The Measures and Dimensions Listing contain all the fields selected
from cube/query. The below columns need to be populated before
continuing:


Dimension ID – Populate the ID column with unique values. If
desired used the Assign Unique Names as ID button to populate
this column. Spaces are not supported when assigning this value.
Dimension Alias - Populate the Alias column with unique alias
names. If desired used the Assign Dimension Names as Alias
button to populate this column. Spaces are not supported when
assigning this value
Assign Unique Names as ID
Select the Assign Unique Names as ID button to populate all
Dimension ID rows with unique values.
Assign Dimension Names as
Alias
Select the Assign Dimension Names as Alias button to populate all
Dimension Alias rows with unique values.
Clear ID
Press the Clear ID button to clear all Dimension ID values.
Clear Alias
Press the Clear Alias button to clear all Dimension Alias values.
APOS Systems Inc. | Live Data Gateway Reference
383
APOS Live Data Gateway
Field / Control
Description
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Create View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
384
APOS Live Data Gateway
Create View Definition
Create the View Definition based upon the dimension selections. Once complete save the view definition
and either exit the Wizard or create additional views within this configuration file.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
BW. Once this is successfully generated ensure that it is saved prior to
proceeding.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
385
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the View to the LDG database. Ensure that the entered
View Name is unique across all views contained within the current LDG database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The View Name must be
unique across all views contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
386
APOS Live Data Gateway
Universes
Use the Live Data Gateway View Wizard form to optionally create Universe Views to configure and name the
dimensions and measures that will be exposed to SAC. Once a view has been configured for a Universe
connection all other universes in that SAP BI System will not be displayed in SAC during the Model creation for
that connection. Views are not required when creating Universe connections.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Field / Control
Description
User
Enter the User that has sufficient privileges to view universes in the SAP BI
system
Password
Enter the Password for the User identified.
Server Url
The Server Url is generated and displayed.
View Name
Enter the View Name to be configured. This value is pre-populated with
a default name but can be changed. The View Name must be unique
across all views contained within the selected LDG Database.
Refresh Universe
Capabilities Only
The Refresh Universe Capabilities button is available for selection when
editing a Universe Semantic View. This benefit of this option is to update
the universe capabilities in the XML file then choosing the Save button
without having to continue editing the view.
**Edit Only
View Definition
The View Definition contains the XML string generated by selecting the
Create View Definition once the measures and dimensions have been
selected and the ID and Alias assigned.
APOS Systems Inc. | Live Data Gateway Reference
387
APOS Live Data Gateway
Field / Control
Description
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Universe.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
388
APOS Live Data Gateway
Select Universe
Use the form to Select Universe or measures and dimensions from the available listing and then proceed to
assigning the Names and IDs for the measures and dimensions. Only measures and dimensions from one
universe can be selected. Multiple universes are not supported.
The maximum number of measures that can be selected is 200.
Field / Control
Description
Selected Cube
Display of the selected universe.
View Name
Display of the View Name being configured.
Load All Universes
Press Load All Universes to load all universes for selection.
Load Universes for APOS
View
Press Load Universe for APOS View to load just the schema of the
view being edited.
Search for Universes
Search for Universes by entering a value followed by the Search
button to load all universes that match the criteria. The % character
can be used as a wildcard character.
Select Measures and
Dimensions from a Universe
Displays a listing of universes and their measures and dimensions
available for selection. When selecting measures and dimensions
ensue that they are from only one universe. An entire universe can be
selected.
Back
Press Back to go back to the first page of the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
389
APOS Live Data Gateway
Field / Control
Description
Next
Press Next to proceed to Assign the IDs and Aliases for the Measures
and Dimensions selected.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
390
APOS Live Data Gateway
Assign ID and Aliases
Use the form to Assign the ID and the Aliases for the selected dimensions and measures.
Field / Control
Description
View Name
Display of the View Name being configured.
Measures and Dimensions
Listing
The Measures and Dimensions Listing contain all the fields selected
from a universe. The below columns need to be populated before
continuing:


Dimension ID – Populate the ID column with unique values. If
desired used the Assign Unique Names as ID button to populate
this column. Spaces are not supported when assigning this value.
Dimension name - Populate the name column with unique
names. If desired used the Assign Dimension Names as Alias
button to populate this column. Spaces are not supported when
assigning this value
Assign Unique Names as ID
Select the Assign Unique Names as ID button to populate all
Dimension ID rows with unique values.
Assign Dimension Names as
Alias
Select the Assign Dimension Names as Alias button to populate all
Dimension name rows with unique values.
Clear ID
Press the Clear ID button to clear all Dimension ID values.
Clear Alias
Press the Clear Alias button to clear all Dimension Alias values.
APOS Systems Inc. | Live Data Gateway Reference
391
APOS Live Data Gateway
Field / Control
Description
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Create View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
392
APOS Live Data Gateway
Create View Definition
Create the View Definition based upon the dimension selections. Once complete save the view definition
and either exit the Wizard or create additional views within this configuration file.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to the
Universe view. Once this is successfully generated ensure that it is
saved prior to proceeding.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
393
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the View to the LDG database. Ensure that the entered
View Name is unique across all views contained within the current LDG database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The View Name must be
unique across all views contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
394
APOS Live Data Gateway
View Wizard – Freehand SQL
Use the Live Data Gateway View Wizard form to create view model(s) for the selected relational database
connection. For more information on the creation of views see the Live Data Gateway Admin User Guide.

Relational Database - At least one view must be configured for each relational database connection that
will be exposed to SAC.
Relational Database
Use the Live Data Gateway View Wizard form to create at least one view model for the selected relational
database that will be exposed in SAC during the Model creation.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Non JDBC Generic
The following first form in the Wizard will appear when creating a view with a Non JDBC Generic connection.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
APOS Systems Inc. | Live Data Gateway Reference
395
APOS Live Data Gateway
Field / Control
Description
DSN
The DSN text box is available when configuring the below database
connections types. Configure the 64 bit ODBC DSN and enter the name in
this field.








BigQuery
Cloudera-Impala
Denodo
HANA
Hive
Oracle Exadata
Sybase SQL Anywhere
SybaseIQ








Connection String
BigQuery
Cloudera-Impala
Denodo
HANA
Hive – Includes the following:

Cloudera

Hortonworks

Google Cloud

Amazon EMR
Sybase SQL Anywhere
SybaseIQ
Oracle Exadata
The Connection String is generated and displayed.
Teradata – The Connection String can be updated to use ADO.Net
instead of java using the below format:
Data Source=172.0.0.1;database=dbname;
View Name
Enter the View Name to be configured. A unique default name is
assigned by default but can be updated.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Definition
When a view is being edit the View Definition displays the generated
XML based upon the field selections from the previous forms. When
configuring a new view the View Definition will be blank.
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
396
APOS Live Data Gateway
Field / Control
Description
Next
Press Next to proceed to create the SQL Select Statement.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
397
APOS Live Data Gateway
JDBC Generic
The following first form in the Wizard will appear when creating a view with a JDBC Generic connection.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
DSN
By default he meta data to create the view is obtained by the
JDBC driver. Alternatively an ODBC DSN 64 bit connection can
be used instead.


Connection String
Use DSN – Select the Use DSN check box to use the
ODBC DSN connection to obtain the meta data to create
the view.
DSN - The DSN text box is available when configuring the
below database connections types. Configure the 64 bit
ODBC DSN and enter the name in this field.
The Connection String is generated and displayed.
When using an ODBC DSN connection to create the view the
Connection String can be customized by adding additional
arguments.
APOS Systems Inc. | Live Data Gateway Reference
398
APOS Live Data Gateway
Field / Control
Description
Properties File
When using an ODBC DSN connection to create the view a
Properties File must be selected. This file will be used to store
the query to extract the relationship between tables used on
the relationship tab in the Wizard. The following files have
been supplied for selection at this time in the installed Admin
folder:



View Name
Greenplum.APOSProperties
PostgreSQL.APOSProperties
SQLServer.APOSProperties
Enter the View Name to be configured. A unique default
name is assigned by default but can be updated.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Definition
When a view is being edit the View Definition displays the
generated XML based upon the field selections from the
previous forms. When configuring a new view the View
Definition will be blank.
OData Query Limits
Set a predefined number of records to be returned when using
the OData Gateway service when queries to be executed are
unlimited or the row limit is 2,147,483,647. These values can
be set at both the connection and view level. Any values set
on the view level take precedence over the connection level
query limits. By default the Use Default Values is selected.

Use Default Values – Select to use the default values of
the application. When unselected the following can be set
for limits:

Query Contains Aggregation – Set the number of
records to be returned when the query contains
aggregation for measures.

Query Without Aggregation – Set the number of
records to be returned when the query contains more
than one dimension and no aggregation measures.
If one dimension is requested then the query will
remain as it was originally sent without any limits.
Next
Press Next to proceed to create the SQL Select Statement.
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
399
APOS Live Data Gateway
SQL Select Statement
Use the form to manually enter the SQL Select Statement and then proceed to assigning measures to one
or more of the selected numeric fields. Alternatively double click on field and table names in the tree view to
assist in generating the SQL Select Statement.
When creating the query the aliases for the fields should not contain spaces.
Field / Control
Description
View Name
Display of the View Name being configured.
Type SQL Select Statement
Type the SQL Select Statement ensuring that at least one measure
and one dimension have been included in the select statement. It is
recommended that no spaces exist in the field names.
Validate Query
Press Validate Query to confirm that no syntax errors exist in the SQL
Select Statement.
Load Tables
Press Load Tables to load the tables to the tree view for the database
selected.
Search Table
Search for a specific table using the Search Table option. The filter
function is case sensitive. The % character can be used as a wildcard
character.
Press the Search button to load all results.
APOS Systems Inc. | Live Data Gateway Reference
400
APOS Live Data Gateway
Field / Control
Description
Tables Available for
Selection
Navigate through the available tree view listing of Tables. The SQL
Select statement columns and table name can either be entered
manually or double click on the desired table and column names from
this list and they will be copied to the statement.
Define Time Dimensions
For those connections with Time Dimensions defined, press Define
Time Dimensions to invoke the Time Dimension Management form
to configure them.
This option is enabled for the below relational database connections.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Virtual Point Definition
Press Virtual Point Definition to invoke the Virtual Point
Management form to configure virtual point settings.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign Measures.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
401
APOS Live Data Gateway
Time Dimension Management
Use the Time Dimension Management form to create Time Dimensions in the view for those connections
with Time Dimensions configured. This option is enabled for the below relational database connections.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Field / Control
Description
Existing Time Dimensions
Any configured time dimensions will be displayed in the Existing
Time Dimensions pane.
Press to Add new Time Dimensions
Select a Time Dimension from the list and press to Delete
to remove it. Removing time dimensions that are being
used in SAC stories will break the story.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned. This value must
be unique across all dimensions and measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned in the view.
This value must be unique across all dimensions and measure Names
in the view.
APOS Systems Inc. | Live Data Gateway Reference
402
APOS Live Data Gateway
Field / Control
Description
Select Database Field
Select the Database Field from the drop down. The drop down will
contain only those fields that were configured as either date or
timestamp fields.
Time Definition
Select the Time Definition to be assigned to the dimension. The drop
down will contain only those Datetime Functions assigned in the
Time Dimension tab of the Connection. The following time definitions
are available for selection from the drop down when all the functions
have been enabled.







Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be updated with all dimensions that are generated as a
result of the definition. These levels cannot be modified in the Admin.
Apply
Press the Apply button to add the Time Dimension to the Existing
Time Dimensions listing.
Close
Select Close to exit from the form.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed and is
automatically generated using the following convention: Time Dimension ID underscore (_) Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
APOS Systems Inc. | Live Data Gateway Reference
403
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week,
Day
APOS Systems Inc. | Live Data Gateway Reference
404
APOS Live Data Gateway
Virtual Point Management
Use the Virtual Point Management form when defining a virtual point when implementing spatial
functionality. Joins between tables are not allowed when defining virtual points so ensure that all fields are
part of one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
Existing Virtual Points (View
Names)
The Existing Virtual Points listing contains any virtual points that have
been defined.
Virtual Point Settings
Assign the View Name, Dimension ID, Name, Mapping Identifier as
well as the Virtual Point Database Definition.
Apply
Press Apply to save the virtual point settings.
Close
Press Close to exit from the management form.
APOS Systems Inc. | Live Data Gateway Reference
405
APOS Live Data Gateway
Existing Virtual Points
The listing contains all virtual point views that have been defined.
Field / Control
Description
View Names
The View Names contains a listing of all Virtual Points views that have
been defined.
Add/Edit
Select the + button to either Add or Edit a virtual point view setting.
Delete

Add – Select the + button to add the virtual point setting
information

Edit - Select a View Name from the listing and click the + button
to edit the virtual point settings to update a view.
Select a View Name from the listing and click X to remove a view.
APOS Systems Inc. | Live Data Gateway Reference
406
APOS Live Data Gateway
Define Virtual Points
Edit/Add a View to assign the virtual point information.
Field / Control
Description
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension Name
Set the Location Dimension Name.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Identifier for Mapping
Set the Identifier for Mapping.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Virtual Point – Database
Definition
Set the virtual point information by setting the columns in each of the
following drop downs. The values contained in the drop downs are
based upon the selected fields prior to clicking the Virtual Point
Management button.




Select Source - Select from the drop down the value FreeSQL.
Column Name – Latitude - Select the latitude column from the
drop down.
Column Name – Longitude - Select the longitude column from
the drop down.
Identifier for Mapping Column - Select the identifier (location
key) column from the drop down.
APOS Systems Inc. | Live Data Gateway Reference
407
APOS Live Data Gateway
Field / Control
Description
Projection Details (SRID)
Set the Project Details SRID codes.


Database – Enter the SRID code for the points stored. For
example if the points are stored in the geographical projection
and the data appears in the format (42.63 , 60.20) the SRID code
would be 4326
SAC – Enter the web projection SRID code for SAC. By default
this value has been set with a SRID code of 3857
Database Supports Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
408
APOS Live Data Gateway
Assign Measures and Dimensions
Use the form to Assign Measures to the selected numerical fields and then proceed to creating the view
definition. By default those not selected as measures will be dimensions. Spaces in the field names are not
supported. Any Time Dimensions configured will be displayed here and can only be edited by using the
Time Dimension Management form
Field / Control
Description
View Name
Display of the View Name being configured.
APOS Systems Inc. | Live Data Gateway Reference
409
APOS Live Data Gateway
Field / Control
Description
Measures and Dimensions
Listing
The Measures and Dimensions Listing will contain all dimension and
measure fields. The below columns are contained within this listing:






Is Measure – Select at least one row as a measure.
Dimension/Measure Name – The Dimension or Measure Name.
Dimension/Measure ID – The Dimension or Measure ID
Aggregation – Select one of the aggregation values available in
the drop down:

SUM

AVG

MIN

MAX

COUNT – supported on dimensions for non-numeric
values
Query Field Name – The DB Field Name Dimension/Measure
Data Type – The data type of the column.
The following Geo Mapping Columns will be displayed if either a
virtual point (VPOINT) has been defined or a real spatial column
(ST_Point) in the database was selected. These values can be edited
using the Virtual Point Management form.







View Name
Identifier for Mapping
Identifier for Mapping Column
DB Projection (SRID)
SAC Projection (SRID)
Database Supports Spatial
Allow Re-projection
Assign Default Names
Select the Assign Default Names check box to have the Measure and
Dimension names assigned a name based upon the database fields in
the query when the Assign Name and ID button is selected.
Assign Name and ID
Press the Assign Name and ID button to have the Query Field Names
used as the dimension/measure names and IDs. Configured Time
Dimension Names and IDs can be updated using the Time Dimension
Management form.
Clear Names and IDs
Press the Clear Names and IDs to clear all Dimension/Measure
Names and IDs. Configured Time Dimension rows will not be cleared.
Check All
Select Check All to select all valid measures in the list.
Uncheck All
Select to Uncheck All to unselect all measures iin the list.
Back
Press Back to go back to the previous page of the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
410
APOS Live Data Gateway
Field / Control
Description
Next
Press Next to proceed to Create the View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard
APOS Systems Inc. | Live Data Gateway Reference
411
APOS Live Data Gateway
Create View Definition
Create the View Definition based upon the dimension and measure selections. Once complete save the
view definition and exit the Wizard.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
databases. Once this is successfully generated save prior to exiting.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
412
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the Freehand SQL View to the LDG database. Ensure that
both the Prefix and View Name are unique across all views contained within the selected LDG database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The value must be
unique across all view names contained within the selected LDG
Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
413
APOS Live Data Gateway
View Wizard – Stored Procedure
Use the Live Data Gateway View Wizard form to create view model(s) for the MS SQL relational database
connection. For more information on the creation of views see the Live Data Gateway Admin User Guide.

MS SQL Relational Database - At least one view must be configured for each database connection that
will be exposed to SAC. Additional information and limitations concerning stored procedure views are
listed below:

The stored procedure must return a result set.

Stored procedures with input parameters will become dimensions that are not to be used as
regular dimensions in SAC stories. These dimension names will be prefixed with ‘PARAM_’.

In SAC the input parameters will appear as variables.

Data returned by output parameters are not supported.
MS SQL Relational Database
Use the Live Data Gateway View Wizard form to create a Stored Procedure view model for the selected MS SQL
database. The views configured here will be exposed in SAC during the Model creation. For more information
on the creation of views see the Live Data Gateway Admin User Guide.
The following first form in the Wizard will appear when creating a view based upon a stored procedure in MS
SQL.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
Connection String
The Connection String is generated and displayed.
APOS Systems Inc. | Live Data Gateway Reference
414
APOS Live Data Gateway
Field / Control
Description
View Name
Enter the View Name to be configured. A unique default name is
assigned by default but can be updated.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Definition
When a view is being edit the View Definition displays the generated
XML based upon the field selections from the previous forms. When
configuring a new view the View Definition will be blank.
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to select the Stored Procedure..
Save
Press Save to save the current view to the LDG database.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
415
APOS Live Data Gateway
Select Stored Procedure
Use the form to select one Stored Procedure and then proceed to assigning time dimensions, dimensions
and measures. Any parameters will be listed in the Stored Procedure Parameters pane. All input parameters
must be assigned a label and default value.
Field / Control
Description
View Name
Display of the View Name being configured.
Load All Schema(s)
Press Load All Schema(s) to load the stored procedures from the MS
SQL database.
Load View Stored
When editing a view press Load View Stored to retrieve the view
information.
Define Time Dimensions
For those connections with Time Dimensions defined, press Define
Time Dimensions to invoke the Time Dimension Management form
to configure them.
Virtual Point Definition
Press Virtual Point Definition to invoke the Virtual Point
Management form to configure virtual point settings.
Virtual Points based upon stored procedures with parameters are not
supported.
APOS Systems Inc. | Live Data Gateway Reference
416
APOS Live Data Gateway
Field / Control
Description
Filters
Search for a specific stored procedure using the Search Stored
Procedure option. The filter function is case sensitive. The %
character can be used as a wildcard character.
Enter Stored Procedure
Press the Search button to load all results.
Stored Procedures Available
for Selection
All available Stored Procedures will be listed.
Stored Procedure
Display of the selected Stored Procedure.
Highlight a Stored Procedure from the list and press to
select. Alternatively double-click on the Stored Procedure
name to add. As the Stored Procedure is selected any
parameters will be loaded.
Stored Procedure
Parameters
Any Stored Procedure Parameters for the selection will be listed. Only
input parameters require additional settings to be applied.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign Measures.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
417
APOS Live Data Gateway
Stored Procedure Parameters
Any Stored Procedure Parameters will be listed. All input parameters require both a Label and a Default
Value for each. Any output parameters will be listed however they are not supported.
Field / Control
Description
Parameter Name
Any input/output Parameter Names are listed.
Label
Assign a unique Label name to any input parameters.
The following characters are not supported in this field:
\ -- “ = > < ; *
Value
Assign a default Value to the input parameter. This value must be
populated.
Data Type
The parameter Data Type is displayed.
Order
The parameter Order is displayed.
Is Output
Is Output indicates whether the parameter is an input or output
parameter.
APOS Systems Inc. | Live Data Gateway Reference
418
APOS Live Data Gateway
Time Dimension Management
Use the Time Dimension Management form to create Time Dimensions in the view for those connections
with Time Dimensions configured.
Field / Control
Description
Existing Time Dimensions
Any configured time dimensions will be displayed in the Existing
Time Dimensions pane.
Press to Add new Time Dimensions
Select a Time Dimension from the list and press to Delete
to remove it. Removing time dimensions that are being
used in SAC stories will break the story.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned. This value must
be unique across all dimensions and measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned in the view.
This value must be unique across all dimensions and measure Names
in the view.
Select Database Field
Select the Database Field from the drop down. The drop down will
contain only those fields that were configured as either date or
timestamp fields.
APOS Systems Inc. | Live Data Gateway Reference
419
APOS Live Data Gateway
Field / Control
Description
Time Definition
Select the Time Definition to be assigned to the dimension. The drop
down will contain only those Datetime Functions assigned in the
Time Dimension tab of the Connection. The following time definitions
are available for selection from the drop down when all the functions
have been enabled.







Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be updated with all dimensions that are generated as a
result of the definition. These levels cannot be modified in the Admin.
Apply
Press the Apply button to add the Time Dimension to the Existing
Time Dimensions listing.
Close
Select Close to exit from the form.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed and is
automatically generated using the following convention: Time Dimension ID underscore (_) Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
Year, Week
APOS Systems Inc. | Live Data Gateway Reference
420
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month, Week,
Day
APOS Systems Inc. | Live Data Gateway Reference
421
APOS Live Data Gateway
Virtual Point Management
Use the Virtual Point Management form when defining a virtual point when implementing spatial
functionality. Joins between tables are not allowed when defining virtual points so ensure that all fields are
part of one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.
Virtual Points based upon stored procedures with input parameters are not supported.
Field / Control
Description
Existing Virtual Points (View
Names)
The Existing Virtual Points listing contains any virtual points that have
been defined.
Virtual Point Settings
Assign the View Name, Dimension ID, Name, Mapping Identifier as
well as the Virtual Point Database Definition.
Apply
Press Apply to save the virtual point settings.
Close
Press Close to exit from the management form.
APOS Systems Inc. | Live Data Gateway Reference
422
APOS Live Data Gateway
Existing Virtual Points
The listing contains all virtual point views that have been defined.
Field / Control
Description
View Names
The View Names contains a listing of all Virtual Points views that have
been defined.
Add/Edit
Select the + button to either Add or Edit a virtual point view setting.
Delete

Add – Select the + button to add the virtual point setting
information

Edit - Select a View Name from the listing and click the + button
to edit the virtual point settings to update a view.
Select a View Name from the listing and click X to remove a view.
APOS Systems Inc. | Live Data Gateway Reference
423
APOS Live Data Gateway
Define Virtual Points
Edit/Add a View to assign the virtual point information.
Field / Control
Description
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension Name
Set the Location Dimension Name.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Identifier for Mapping
Set the Identifier for Mapping.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Virtual Point – Database
Definition
Set the virtual point information by setting the columns in each of the
following drop downs. The values contained in the drop downs are
based upon the selected fields prior to clicking the Virtual Point
Management button.




Select Source - Select from the drop down the source
STOREDPROC.
Column Name – Latitude - Select the latitude column from the
drop down.
Column Name – Longitude - Select the longitude column from
the drop down.
Identifier for Mapping Column - Select the identifier (location
key) column from the drop down.
APOS Systems Inc. | Live Data Gateway Reference
424
APOS Live Data Gateway
Field / Control
Description
Projection Details (SRID)
Set the Project Details SRID codes.


Database – Enter the SRID code for the points stored. For
example if the points are stored in the geographical projection
and the data appears in the format (42.63 , 60.20) the SRID code
would be 4326
SAC – Enter the web projection SRID code for SAC. By default
this value has been set with a SRID code of 3857
Database Supports Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality for
Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
425
APOS Live Data Gateway
Assign Measures and Dimensions
Use the form to Assign Measures to the selected numerical fields and then proceed to creating the view
definition. By default those not selected as measures will be dimensions. Spaces in the field names are not
supported.


Time Dimensions - Any Time Dimensions will be displayed here and can only be edited by using the
Time Dimension Management form.
Parameters – Any Parameters will be displayed here and are prefixed by ‘PARAM_’. These can be
edited in the previous form within the Stored Procedure Parameters section.
Field / Control
Description
View Name
Display of the View Name being configured.
APOS Systems Inc. | Live Data Gateway Reference
426
APOS Live Data Gateway
Field / Control
Description
Measures and Dimensions
Listing
The Measures and Dimensions Listing will contain all dimension and
measure fields. The below columns are contained within this listing:






Is Measure – Select at least one row as a measure.
Dimension/Measure Name – The Dimension or Measure Name.
All Parameters are prefixed by ‘PARAM_’.
Dimension/Measure ID – The Dimension or Measure ID. All
Parameters are prefixed by ‘PARAM_’.
Aggregation – Select one of the aggregation values available in
the drop down:

SUM

AVG

MIN

MAX

COUNT – supported on dimensions for non-numeric
values
Query Field Name – The DB Field Name Dimension/Measure
Data Type – The data type of the column.
The following Geo Mapping Columns will be displayed if either a
virtual point (VPOINT) has been defined or a real spatial column
(ST_Point) in the database was selected. These values can be edited
using the Virtual Point Management form.







View Name
Identifier for Mapping
Identifier for Mapping Column
DB Projection (SRID)
SAC Projection (SRID)
Database Supports Spatial
Allow Re-projection
Assign Default Names
Select the Assign Default Names check box to have the Measure and
Dimension names assigned a name based upon the database fields in
the query when the Assign Name and ID button is selected.
Assign Name and ID
Press the Assign Name and ID button to have the Query Field Names
used as the dimension/measure names and IDs. Configured Time
Dimension Names and IDs can be updated using the Time Dimension
Management form.
Clear Names and IDs
Press the Clear Names and IDs to clear all Dimension/Measure
Names and IDs. Configured Time Dimension rows will not be cleared.
Check All
Select Check All to select all valid measures in the list.
Uncheck All
Select to Uncheck All to unselect all measures iin the list.
Back
Press Back to go back to the previous page of the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
427
APOS Live Data Gateway
Field / Control
Description
Next
Press Next to proceed to Create the View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard
APOS Systems Inc. | Live Data Gateway Reference
428
APOS Live Data Gateway
Create View Definition
Create the View Definition based upon the parameter, time dimension, dimension and measure selections.
Once complete save the view definition and exit the Wizard.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
databases. Once this is successfully generated save prior to exiting.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
Save
Press Save to save the View Definition to the LDG Database. The View
Description Details dialog will launch to name the view prior to saving.
Exit
Press Exit to close the Wizard and go back to View Management.
APOS Systems Inc. | Live Data Gateway Reference
429
APOS Live Data Gateway
View Description Details
Use the View Description Details dialog to save the Stored Procedure View to the LDG database. Ensure
that both the Prefix and View Name are unique across all views contained within the selected LDG
database.
Field / Control
Description
Unique Prefix
Populate the view with a Unique Prefix name. This value is prepopulated with a name but can be updated. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate the View Name with a unique name. This value is prepopulated with a name but can be updated. The value must be
unique across all view names contained within the selected LDG
Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
Description
Fill in a Description for the view if desired.
The following characters are not supported in this field:
\ -- “ = > < ; *
OK
Press OK to save the view and return to the View Management form.
Cancel
Press Cancel to close the dialog without saving.
APOS Systems Inc. | Live Data Gateway Reference
430
APOS Live Data Gateway
Non-Database Method
The Non-Database Method has been deprecated and the Database Method is the recommended method to use
when configuring Live Data Gateway connections and views. Time dimensions are not supported when using the
non-database method.
Live Data Gateway Admin
The Live Data Gateway Admin application is used to generate the necessary files to create connections for use
in SAP Analytics Cloud.
The Live Data Gateway Admin has the following tabs:

Connection – Use the Connection tab to configure connections used for SAP Analytics Cloud.

SSO Configuration – Use the SSO Configuration tab to define the SSO settings for the connection.

Date/Time and DB Functions – The configuration of Time Dimensions and Virtual Points are not
supported when using the non-database backend method. See the Database Method for more
information on the support for these
APOS Systems Inc. | Live Data Gateway Reference
431
APOS Live Data Gateway

Extra Properties - Use the Extra Properties tab to disable the parameterized queries for relational
databases when additional assistance is required when running in debug

License – Use the License tab to add the APOS Live Data Gateway license file supplied by APOS for use
with this product.

SAC – Use the SAC tab to add SAC Tenant URLs that may be necessary when using CORS and if using
SAC SSO via ADFS with Kerberos and SQL Server, Oracle, Denodo or SSAS.
The following are the controls available for the loading and saving of the connection xml files.
Field / Control
Description
Test Connection / Test URL
This button is dynamic and will change based upon the Data
Source type selected:

Test URL – Press to validate the Server URL that was
entered.

Test Connection- Press to validate the Data Source
connection that has been entered for databases. See
Test Connection Requirements for the list of required
database jar files that need to be copied to the
ConnectionTest_lib folder.
Note: In some cases with Generic JDBC connections
additional steps must be taken to create a successful
connection by adding the database jar file to the Manifest.MF
file. Contact APOS Support for these steps.
Save
Press Save to save the DG_Datasource.xml file. By default
this file is saved to the installed folder of this product. For
deployment purposes the xml file must be copied to the
LiveDataGateway deployment folder.
Close
Press Close when finished using the Admin application.
Test Connection Requirements
When testing the connection of the database types, the required database jar file needs to be copied to the
folder ConnectionTest_lib folder that is located within the Live Data Gateway installed folder of …\Program
Files\APOS\Live Data Gateway\Admin.
Database Type
Amazon EMR
Database File(s)
hive-jdbc-2.3.3-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the ConnectionTest_lib folder.
APOS Systems Inc. | Live Data Gateway Reference
432
APOS Live Data Gateway
Database Type
Database File(s)
Cloudera Hive
hive-jdbc-1.1.0-cdh5.13.0.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the ConnectionTest_lib folder.
Cloudera Impala
imapalaJDBC41.jar
DB2
jcc-11.5.4.0.jar
Denodo
denodo-vdp-jdbcdriver.jar
*Rename the version named jar file to denodo-vdpjdbcdriver.jar when copying to the
ConnectionTest_lib folder.
ESSBASE
cpld.jar
ess_es_server.jar
ess_japi.jar
ess_maxl.jar
ojdl.jar
Google Big Query
google-api-client-1.23.0.jar
google-api-services-bigquery-v2-rev377-1.23.0.jar
GoogleBigQueryJDBC42.jar
google-http-client-1.23.0.jar
google-http-client-jackson2-1.23.0.jar
google-oauth-client-1.23.0.jar
Google Cloud Hive
hive-jdbc-1.2.3.2-standalone.jar*
*Rename the jar file to hive-jdbc.jar when copying
to the ConnectionTest_lib folder.
HANA
ngdb.jar
Hortonworks Hive
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar*
jaxb-impl-2.2.3.1.jar
*Rename the jar file to hive-jdbc.jar when copying
to the ConnectionTest_lib folder.
APOS Systems Inc. | Live Data Gateway Reference
433
APOS Live Data Gateway
Database Type
Database File(s)
Microsoft SQL Server
sqljdbc4.jar
mssql-jdbc-9.4.1.jre8.jar
MongoDB
Mysql-connector-java-5.1.46.jar
MongoDB Atlas
Mysql-connector-java-5.1.46.jar
MySQL
Mysql-connector-java-5.1.46.jar
Netezza
nzjdbc.jar
Oracle
ojdbc6.jar
ucp.jar
Oracle Exadata
ojdbc8.jar
ucp.jar
Presto
Presto-jdbc-0.218.jar
*Use the JDBC Generic database connection option.
Redshift
RedshiftJDBC42-1.2.10.1009.jar
Snowflake
snowflake-jdbc-3.6.27.jar
*Use the JDBC Generic database connection option.
Sybase Anywhere
jconn4.jar
Sybase IQ
jconn4.jar
Teradata
terajdbc4.jar
tdgssconfig.jar
APOS Systems Inc. | Live Data Gateway Reference
434
APOS Live Data Gateway
The Live Data Gateway Admin has the following menu options available for selection:
File
Field / Control
Description
Configure Java Path
Locate and Configure Java. This configuration is used when
selecting the Test Connection button. By default a version of
OpenJDK 8 is installed with this application and can be found in
…\Program Files\APOS\Java\OpenJDK\jre8\bin.
New
Use to create a New configuration file.
Open
Use the Open button to load a previously configured and saved
DG_Datasource.xml connection file.
Save
Press Save to save a copy of the configuration files. By default the
file is saved to the installed folder of this product. For deployment
purposes the files must be copied to deployment LDG folder..
 CORS – Below is an example of where the file would be copied to
when using the web application deployment method to the MSAS
Service name.
…\tomcat\<Service name>\ROOT\WEB-INF\classes
Close
Press Close when finished using the Admin application.
APOS Systems Inc. | Live Data Gateway Reference
435
APOS Live Data Gateway
Configure Java Path
Locate the version of java installed with this application by following the below steps:
1.
Browse to the installed application folder …\Program Files\APOS\Java\OpenJDK\jre8\bin.
2.
Select the java.exe file.
3.
Click Open
APOS Systems Inc. | Live Data Gateway Reference
436
APOS Live Data Gateway
Help
Field / Control
Description
Help
View this Help file.
About
View the APOS contact information.
APOS Systems Inc. | Live Data Gateway Reference
437
APOS Live Data Gateway
Connections
Use the Connections tab to select the data source for the connection.





SSAS
BW
Essbase
Universes
Databases
APOS Systems Inc. | Live Data Gateway Reference
438
APOS Live Data Gateway
SSAS
Field / Control
Data Source
Server URL
Description
Select the SSAS (SQL Server Analysis Services) value from the Data
Source dropdown type.
Fill in the Server URL. The following are examples of the expected URL
formats:
http://Server/OLAP/msmdpump.dll

BW
Field / Control
Data Source
Server URL
Description
Select the BW values from the Data Source dropdown type.
Fill in the Server URL. The following are examples of the expected URL
formats:

http://Server:port/sap/bw/xml/soap/xmla
APOS Systems Inc. | Live Data Gateway Reference
439
APOS Live Data Gateway
ESSBASE
Field / Control
Data Source
Web Logic URL
Description
Select the Essbase value from the Data Source dropdown type.
Fill in the Server URL. The following is an example of the expected URL
format:

Data Source Host
http://ESSBASEServer:9000/aps/XMLA
Fill in the Data Source Host name when the Web Logic Server and the
Essbase Server are not on the same machine or are in different clusters.
Universes
Field / Control
Data Source
Server URL
Description
Select the Universes value from the Data Source dropdown type.
Fill in the BI Server URL. The following are examples of the expected URL
formats:

http://BIServer:6405
APOS Systems Inc. | Live Data Gateway Reference
440
APOS Live Data Gateway
Databases
Field / Control
Description
Data Source
Select the Database value from the Data Source dropdown type.
Connection String
Once the Database value has been selected, generate the connection
string by filling in the Connection String properties.
Once the connection string has been generated select the
(edit
button) to add any additional custom properties that may be desired.



Database – Select the database type from the drop down.

BigQuery

Cloudera Impala

Denodo

HANA

Hive - Includes the below databases:

Cloudera

Hortonworks

Google Cloud

Amazon EMR

IBM DB2

JDBC Generic

Microsoft SQL Server

MongoDB

MongoDB Atlas

MySQL

Netezza

Oracle

Oracle Exadata

Redshift

Sybase IQ

Sybase SQL Anywhere

Teradata
Host – Enter the Host of the database server.
Database Name – Enter the Database Name.
APOS Systems Inc. | Live Data Gateway Reference
441
APOS Live Data Gateway
Field / Control
SSL
MongoDB Atlas

Description
The SSL option is available when selecting MongoDB Atlas as the
database type. When not using SSL the below environmental variable
must be set prior to creating the XML files.

LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN=1
SSO Configuration
Use the SSO Configuration to enable and select from an available list of SSO Authentication/Retrieval
Methods. This feature is enabled for the following connection types:



Database
SSAS
Universe
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from the available listing of Authentication/Retrieval Methods.
APOS Systems Inc. | Live Data Gateway Reference
442
APOS Live Data Gateway
Database
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from one of the three following Authentication Methods.
Authentication Method – Select the Authentication Method value from
the drop down.




PRE-DEFINED USER – Level 1 - Assign one account to be used for all
SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
IDENTITY PROVIDERS SSO – Level 2 - Assign multiple Login Users
to Database Credentials for SSO requests that will support row level
security support. Both NTLM and SAML are supported.
IMPERSONATE SSO USER – Level 3 – Connect to SAC with SQL
Server, Oracle or PostgreSQL and assigned a user to connect to the
database. Both NTLM and SAML are supported.
KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS
for SQL Server, SSAS, Denodo or Oracle. Only connections defined
with CORS are accepted.
APOS Systems Inc. | Live Data Gateway Reference
443
APOS Live Data Gateway
SSAS
Field / Control
Description
SSO
Use SSO – Select the Use SSO check box to enable this option and select
from one of the three following Authentication Methods.
Authentication Method – Select the Authentication Method value from
the drop down.



PRE-DEFINED USER – Level 1 - Assign one account to be used for all
SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
Both NTLM and SAML are supported.
IDENTITY PROVIDERS SSO – Level 2 - Assign multiple Login Users
to Database Credentials for SSO requests that will support row level
security support.
KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS
for SQL Server, SQL Server Analysis Services, Denodo or Oracle. Only
connections defined with CORS are accepted.
APOS Systems Inc. | Live Data Gateway Reference
444
APOS Live Data Gateway
Universe
Field / Control
Description
Use SSO
Select the Use SSO check box if desired.
Retrieval Method
Select a Retrieval Method from the drop down. If selecting a retrieval
method defined on the WACS server this value must match the WACS
configuration set in the CMC.




HTTP_HEADER - Check WACS configuration setting
QUERY_STRING - Check WACS configuration setting
COOKIE - Check WACS configuration setting
PRE-DEFINED User – Select a BI user account to create a connection
in SAC to a universe.

Trusted User Name – Enter a BI user name that has
sufficient privileges to select a universe

Password – Enter the password for the BI user

Use for No Credentials – To be selected when creating the
connection within SAC. Select the Use for No Credentials
check box to support the SAC Authentication Method value
of None when creating the connection.
Use SSO
Select the Use SSO check box to enable this option and select from one of the three following Authentication
Methods.
Authentication Method – Select the Authentication Method value from the drop down.

PRE-DEFINED USER – Level 1 - Connect to a relational database or SSAS and assign one account to be used
for all SSO requests coming from a trusted account. All requests will be fulfilled by using that one account
with no row level security support.

IDENTITY PROVIDERS SSO – Level 2 - Connect to a relational database or SSAS and assign multiple Login
Users to Database Credentials for SSO requests that will support row level security support. Both NTLM and
SAML are supported.

IMPERSONATE SSO USER – Level 3 – Connect to SAC with SQL Server, Oracle or PostgreSQL and assign a
user to connect to the database. Both NTLM and SAML are supported.
APOS Systems Inc. | Live Data Gateway Reference
445
APOS Live Data Gateway

KERBEROS SSO – Level 3 – Connect to SAC SSO with Kerberos/ADFS for SQL Server, SSAS, Denodo or Oracle.
Only connections defined with CORS are accepted.
APOS Systems Inc. | Live Data Gateway Reference
446
APOS Live Data Gateway
PRE-DEFINED USER – Level 1
Selecting the PRE-DEFINED USER value from the authentication method drop down enables the ability to
assign one account to be used for all SSO requests coming from a trusted account. All requests will be
fulfilled by using that one account with no row level security support.
Within SAC during the creation of a connection the authentication method None needs to be selected from
the SAC Authentication Method drop down. At this time Google Big Query supports the selection of No
User authentication in SAC.
Field / Control
Description
Trusted User Name
Fill in the Trusted User Name to be used by the SSO request.
Password
Fill in the Password for the Trusted User Name.
Use for No Credentials
Select the Use for No Credentials check box when using the
connection within SAC
Disable SSO for Admin
Web UI
Select Disable SSO for Admin Web UI to prompt for a DB User and
Password or the Trusted User/Password is used to log into the Web
Admin UI.
NTLM
Select NTLM for those connections not requiring the SAML
configuration. The user logged into the browser will be used. SAC
does not have to be configured with SSO.
SAML
Select SAML to connect using the SAML SSO deployed configuration.
Requirements for this option:


SAC must be configured with SSO
The SSO SAML web application deployed and configured
APOS Systems Inc. | Live Data Gateway Reference
447
APOS Live Data Gateway
IDENTITY PROVIDERS SSO – Level 2
Selecting the IDENTITY PROVIDERS SSO value from the authentication method drop down enables the
ability to assign multiple Login Users to Database Credentials for SSO requests that will support row level
security support.
This option requires the following prerequisites when selecting SAML:



Tomcat 8.5 min installed
Deployed saml2-sso web application configured to support SSL using the same certificate for both
LDG and Tomcat.
SAC is configured with SAML SSO.
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
Field / Control
Description
SSO Authentication Type
Select from the following list of SSO Authentication Types.

Override Credentials
Database User/Password
Select the Override Credentials checkbox to enabled the following
options:


Trusted User Name - Fill in the Trusted User Name to be used
by the SSO request. The user is validated and verified to be on
the list (Identity Providers SSO list). This single account will then
be used to log into the database.
Password - Fill in the Password for the Trusted User Name
Identity Providers SSO
Press the Identity Providers SSO button to invoke the Identity
Providers for SSO form to associate Login Users to Database
Credentials.
NTLM
Select NTLM for those connections not requiring the SAML
configuration. The user logged into the browser will be used. SAC
does not have to be configured with SSO.
SAML
Select SAML to connect using the SAML SSO deployed configuration.
Requirements for this option:


SAC must be configured with SSO
The SSO SAML web application deployed and configured
APOS Systems Inc. | Live Data Gateway Reference
448
APOS Live Data Gateway
Identity Providers for SSO
Use the Identity Providers for SSO form to Associate Login Users with Database Credentials to assign
row level security support. The mapped entries will be encrypted and stored in the
DG_DataSource.xml file.
Field / Control
Description
Add/Delete
Use the buttons found above the user list to Add or Delete users.
Press to add users to the list by filling in the Login User,
Database User and DB Password.
Select one or more rows and press to remove from the user
list.
User List
List of Login users that have been associated with Database users




Login User – The Login user name
Database User – The Database user name
DB Password – The Database password for the user defined.
Test Connection – Use the Test Connection button to test the
Database User and DB Password values.
Note: The Test Connection button is available when creating
database connections. It is not available for data sources that use the
xmla connections such as SSAS, BW and ESSBASE.
APOS Systems Inc. | Live Data Gateway Reference
449
APOS Live Data Gateway
Field / Control
Description
Import Users
Press Import Users to select a comma delimited (CSV) file containing
Login Users and their associated Database User and Password. This
option will add and/or overwrite users from the grid with the values
extracted from the CSV file. All fields are required, any missing will result
in the user not being added.
Replace Users
Press Replace Users to select a comma delimited (CSV) file containing
Login Users and their associated Database User and Password. This
option will replace the users from the grid with the ones from the CSV file.
All fields are required, any missing will result in the user not being added.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
APOS Systems Inc. | Live Data Gateway Reference
450
APOS Live Data Gateway
IMPERSONATE SSO USER – Level 3
Select the IMPERSONATE SSO USER option when connecting SAC with MS SQL Server, Oracle or
PostgreSQL.
This option requires the following prerequisites when selecting SAML:



Tomcat 8.5 min installed
Deployed saml2-sso web application configured to support SSL using the same certificate for both
LDG and Tomcat.
SAC is configured with SAML SSO.
For SQL Server the implementation will use the “Execute As” statement. Because of that the Microsoft
requirements for the “Execute As” user (which is the SAML user) must be met.
Check https://docs.microsoft.com/en-us/sql/t-sql/statements/execute-as-transact-sql paragraph “Specifying
a User or Login Name”.
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
Field / Control
Description
Trusted User Name
Fill in the Trusted User Name that has sufficient rights to the
database.
Password
Fill in the Password for the Trusted User Name.
NTLM
Select NTLM for those connections not requiring the SAML
configuration. The user logged into the browser will be used.
SAC does not have to be configured with SSO.
SAML
Select SAML to connect using the SAML SSO deployed
configuration.
Requirements for this option:


Domain Name
SAC must be configured with SSO
The SSO SAML web application deployed and
configured
Enter the Domain Name for the browser authenticated user.
APOS Systems Inc. | Live Data Gateway Reference
451
APOS Live Data Gateway
KERBEROS SSO – Level 3
Select the KERBEROS SSO option when connecting SAC SSO with one of the below Kerberos/ADFS
connection types using login account. This is only available when connecting to SAC SSO with CORS.




SSAS
Microsoft SQL Server
Oracle
Denodo
Within SAC during the creation of a connection the authentication method SAML Single Sign On needs to be
selected from the SAC Authentication Method drop down.
SSAS
Field / Control
Description
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must
be saved on the deployment machine.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file
must be saved on the deployment machine.
APOS Systems Inc. | Live Data Gateway Reference
452
APOS Live Data Gateway
Microsoft SQL Server
Field / Control
Description
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the deployment machine.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file must
be saved on the deployment machine.
Oracle
Field / Control
Description
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the deployment machine.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. This file must
be saved on the deployment machine.
Database User Proxy
Fill in the oracle Database User Proxy.
User Proxy Password
Fill in the oracle database User Proxy Password.
APOS Systems Inc. | Live Data Gateway Reference
453
APOS Live Data Gateway
Denodo
Field / Control
Description
Connection String
Append the value ?useKerberos=true to the end of the Connection
String.
Field / Control
Description
Service Principal Name
Fill in the Service Principal Name. This domain account must be
made a member of the local Administrator’s group on the
deployment machine.
Keytab File (full path)
Fill in the full path and filename for the keytab file. This file must be
saved on the deployment machine.
Krb5 Configuration File
Fill in the full path and filename for the krb5.ini file. When used this
file must be saved on the deployment machine.
APOS Systems Inc. | Live Data Gateway Reference
454
APOS Live Data Gateway
View Wizard
Use the View Wizard form to create at least one semantic view model for the selected relational database. The
information about the views will be saved in a file called DG_View.xml which is then deployed along with the
other configuration files to the LDG application deployment folder based on the type of connection being used
to connect to SAC.
The APOS Semantic Layer views are designed to describe only Star or Snowflake data structures. This guarantees
that the end user can choose any measure and dimension combination and they will all be valid. If you have to
use other structures you will wither need to use a freehand SQL view or you can wrap those structures in a
database view and bring them into the semantic layer view. You should not have multiple fact tables in a
semantic layer view as a dimension might need to be joined to both creating a bad join. Multiple fact tables need
to be joined at the database level in a database view so that the database view can be used as a single fact table
in the semantic layer view.
The idea behind a semantic layer is to obfuscate the complex data structure of the database. We do not want to
create a situation in which the user needs to know not to choose certain fields together because it will cause the
joins not to work. All the measures and dimensions in a semantic layer view must be relatable. If they are not they
need to be separated into separate views.
For more information on the creation of views see the Live Data Gateway Admin User Guide.
Non JDBC Generic
The following first form in the Wizard will appear when creating a view with a Non JDBC Generic connection.
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
APOS Systems Inc. | Live Data Gateway Reference
455
APOS Live Data Gateway
Field / Control
Description
DSN
The DSN text box is available when configuring the below database
connections types. Configure the 64 bit ODBC DSN and enter the name in
this field.








BigQuery
Cloudera-Impala
Denodo
HANA
Hive
Oracle Exadata
Sybase SQL Anywhere
SybaseIQ








BigQuery
Cloudera-Impala
Denodo
HANA
Hive – Includes the following:

Cloudera

Hortonworks

Google Cloud

Amazon EMR
Sybase SQL Anywhere
SybaseIQ
Oracle Exadata
Connection String
The Connection String is generated and displayed.
New Configuration File
Select the New Configuration File check box when creating a new View
XML file. This check box should remain unchecked when loading a
previously created file.
View Name
When creating a new View, enter a uniquely named View Name.
Load Configuration File
Browse for the previously created View XML file to Load the
Configuration File to the form for updating purposes. By default this file
is given the name of DG_View.xml when being saved.
Select View
For already saved View XML files, the view names will be listed in the
Select View listing area.
Edit View
Select a View from the list and press Edit View to update the settings by
pressing the Next button.
Delete View
Select a View from the list and press Delete View to remove the view
from the XML file.
Add View
When adding a new view to the list press the Add Viewbutton and then
fill in a unique name in the View Name text box. This option is not
available when the New Configuration File is selected as well and a View
has not yet been created.
APOS Systems Inc. | Live Data Gateway Reference
456
APOS Live Data Gateway
Field / Control
Description
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
Next
Press Next to proceed to Select Fields.
Save
Press Save to save a copy of the view xml file. By default the file is saved
to the installed folder of this product. For deployment purposes the
DG_View.xml named file must be saved to the Live Data Gateway
deployment folder.
Exit
Press Exit to quit this form without saving.
JDBC Generic
The following first form in the Wizard will appear when creating a view with a JDBC Generic connection.
APOS Systems Inc. | Live Data Gateway Reference
457
APOS Live Data Gateway
Field / Control
Description
User
Enter the User that has sufficient privileges to the database.
Password
Enter the Password for the User identified.
DSN
By default he meta data to create the view is obtained by the JDBC
driver. Alternatively an ODBC DSN 64 bit connection can be used
instead.


Connection String
Use DSN – Select the Use DSN check box to use the ODBC DSN
connection to obtain the meta data to create the view.
DSN - The DSN text box is available when configuring the below
database connections types. Configure the 64 bit ODBC DSN and
enter the name in this field.
The Connection String is generated and displayed.
When using an ODBC DSN connection to create the view the
Connection String can be customized by adding additional arguments.
Properties File
When using an ODBC DSN connection to create the view a Properties
File must be selected. This file will be used to store the query to extract
the relationship between tables used on the relationship tab in the
Wizard. The following files have been supplied for selection at this time
in the installed Admin folder:



Greenplum.APOSProperties
PostgreSQL.APOSProperties
SQLServer.APOSProperties
New Configuration File
Select the New Configuration File check box when creating a new
View XML file. This check box should remain unchecked when loading
a previously created file.
View Name
When creating a new View, enter a uniquely named View Name.
Load Configuration File
Browse for the previously created View XML file to Load the
Configuration File to the form for updating purposes. By default this
file is given the name of DG_View.xml when being saved.
Select View
For already saved View XML files, the view names will be listed in the
Select View listing area.
Edit View
Select a View from the list and press Edit View to update the settings
by pressing the Next button.
Delete View
Select a View from the list and press Delete View to remove the view
from the XML file.
APOS Systems Inc. | Live Data Gateway Reference
458
APOS Live Data Gateway
Field / Control
Description
Add View
When adding a new view to the list press the Add View button and
then fill in a unique name in the View Name text box. This option is not
available when the New Configuration File is selected as well and a
View has not yet been created.
OData Query Limits
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default Values is selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to
be returned when the query contains aggregation for
measures.

Query Without Aggregation – Set the number of records to
be returned when the query contains more than one
dimension and no aggregation measures. If one dimension is
requested then the query will remain as it was originally sent
without any limits.
Next
Press Next to proceed to Select Fields.
Save
Press Save to save a copy of the view xml file. By default the file is
saved to the installed folder of this product. For deployment purposes
the DG_View.xml named file must be saved to the Live Data Gateway
deployment folder.
Exit
Press Exit to quit this form without saving.
APOS Systems Inc. | Live Data Gateway Reference
459
APOS Live Data Gateway
Select Fields
Use the form to select fields from the available listing and then proceed to assigning measures to one or more of
the selected numeric fields.
Field / Control
Description
View Name
Display of the View Name being configured.
Load All Schema(s)
Press Load Table Schema to load all schemas and their tables/fields
available for the analytical view.
Load View Schema
Press Load View Schema to load just the schema of the view being
edited. This button is enabled when editing a view.
Define Time Dimensions
The Define Time Dimensions option is not supported when using the
Non-Database Method.
Supported when using the
Database Backend Method
Virtual Point Definition
Supported when using the
Database Backend Method
The Virtual Point Definition option is not supported when using the
Non-Database Method.
APOS Systems Inc. | Live Data Gateway Reference
460
APOS Live Data Gateway
Field / Control
Description
Filters
Search for a specific schema and table using the Filters option. The
filter function is case sensitive.

Enter Schema – Enter the schema to be filtered. The % character
can be used as a wildcard character.

Enter Table – Enter the table to be filtered. The % character can
be sued as a wildcard character.

Search – Press the Search button to load all results.
Fields Available for
Selection
Navigate through the available listing of tables and select the desired
fields.
Refresh
Press Refresh to display the selected fields to the Summary of the
selected fields.
Summary of the selected
fields
Displays a summary listing of all the fields that were selected.
Refresh Metadata for
Selected Fields
Press Refresh Metadata for Selected Fields to refresh metadata for
the existing view.
Cancel
Press Cancel to remove the changes and go back to the first page of
the Wizard.
Back
Press Back to go back to the first page of the Wizard.
Next
Press Next to proceed to Assign Measures.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
461
APOS Live Data Gateway
Assign Measures
Use the form to Assign Measures to the selected numerical fields and then proceed to assigning dimension
names.
Field / Control
Description
View Name
Display of the View Name being configured.
Measures Listing
The Measures Listing will contain all numerical fields that can be used
as measures. The below columns are contained within this listing:





Is Measure – Select at least one row as a measure.
Measure Name – Assign a Measure Name if the Assign Default
Names for Measures check box is not selected.
DB Field Name – The field name of the measure.
Aggregation – Select one of the aggregation values available in
the drop down:

SUM

COUNT

MIN

MAX

AVG
Table Name – The table name of the field.
Assign Default Names For
Measures
Select the Assign Default Names For Measures check box to have
the DB Fields Names used as the measure name.
Cancel
Press Cancel to remove the changes and go back to the first page of
the Wizard.
APOS Systems Inc. | Live Data Gateway Reference
462
APOS Live Data Gateway
Field / Control
Description
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Assign Dimension Names.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
Assign Dimension Names
Use the form to Assign Dimension names before proceeding to assigning the relationships between the selected
tables.
Field / Control
Description
View Name
Display of the View Name being configured.
APOS Systems Inc. | Live Data Gateway Reference
463
APOS Live Data Gateway
Field / Control
Description
Dimension List
The Dimension List contains both the non-numerical selected fields
as well as those numerical fields that were not selected as a measure
on the previous form. The below columns are found within the listing:






Dimension Name – When not using the default name, populate
this cell with a desired name.
DB Field Name
Dimension Group – When not using the default group name,
populate this cell with a desired name.
Table Name
Data Type – The data type is set to ST_POINT when the database
contains a real spatial column.
CharSize
Assign Default Names for
Dimensions
Select the Assign Default Names For Dimensions check box to have
the DB Fields Names used as the dimension name.
Use Table as Dimension
Group
Select the Use Table as Dimension Group check box to have the
table name as the dimension name instead of the default listed group
name.
Clear Group Names
Press the Clear Group Names button to clear the values entered in
the Dimension Group column so that new values can be entered in
the cells.
Cancel
Press Cancel to remove the changes and go back to the first page of
the Wizard.
Back
Press Back to go back to the previous page of the Wizard.
Next
Press Next to proceed to Assign Relationships.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
464
APOS Live Data Gateway
Assign Relationships
Use the form to Assign Relationships between the two or more tables selected before creating the view
definition.
Field / Control
Description
View Name
Display of the View Name being configured.
Get Relationship From
Database
Press Get Relationship From Database to load the available
relationship from the database to the listing. If relationships have not
been configured within the database they will have to be manually
entered in this form.
Add New Row
Press Add New Row to manually add a relationship row to the listing.
Once the row is added, populate the cells with the relationship info.
Delete All
Press Delete All to delete all rows in the listing.
Validate
Press Validate to confirm the accuracy on all the relationship
information contained in the listing.
APOS Systems Inc. | Live Data Gateway Reference
465
APOS Live Data Gateway
Field / Control
Description
Relationship Listing
When configuring a new view the Relationship Listing is blank and
will need to be selected. The below columns are listed:







Relationship Name – The relationship name.
Table 1 – The first table name.
Table 1 Column Key – The first table linking field name.
Table 1 Owner – The first table owner/schema/database.
Table 2 – The second table name.
Table 2 Column Key – The second table linking field name.
Table 2 Owner – The second table owner/schema/database.
Remove Unused Joins
Select the Remove Unused Joins check box to only include those
rows that are relevant to the fields selected. Pressing the Validate
button will cause any extra rows to be removed.
Cancel
Press Cancel to remove the changes and go back to the first page of
the Wizard.
Back
Press Back to go back to the previous page of the Wizard.
Finish
Press Next to proceed to the next form to Create the View Definition.
Save
The Save button is not enabled for selection on this form.
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin.
APOS Systems Inc. | Live Data Gateway Reference
466
APOS Live Data Gateway
Create View Definition
Create the view definition based upon the previous field sections. Once complete save the view definition and
either exit the Wizard or create additional views within this configuration file.
Field / Control
Description
Create New View Definition
Press the Create New View Definition button to generate the XML
required for the Live Data Gateway application when connecting to
databases. Once this is successfully generated -ensure that it is saved
prior to proceeding.
View Name
Display of the View Name being configured.
View Definition Listing
The View Definition Listing displays the generated XML based upon
the field selections from the previous forms.
First Page
Press First Page to go back to the first page of the Wizard to
create/edit/remove views that are contained within this configuration
file.
Save
Press Save to save the View Definition configuration to a file called
DG_View.xml which is then deployed along with the
DG_Datasource.xml to:
 CORS
…\tomcat\<Service name>\ROOT\WEB-INF\classes
Exit
Press Exit to close the Wizard and go back to the Live Data Gateway
Admin
APOS Systems Inc. | Live Data Gateway Reference
467
APOS Live Data Gateway
Extra Properties
Use the Extra Properties tab to disable the parameterized queries for relational databases when additional
assistance is required when running in debug.
Field / Control
Description
Disable Parameterized
Queries
Select Disable Parameterized Queries to enable addition logging when
debug is required. By default this option is not selected and should only
be selected when additional debugging is required in order to trouble
shoot errors in the log file.
This option is applicable for relational database connections.
OData Query Limits
Set a predefined number of records to be returned when using the OData
Gateway service when queries to be executed are unlimited or the row
limit is 2,147,483,647. These values can be set at both the connection and
view level. Any values set on the view level take precedence over the
connection level query limits. By default the Use Default Values is
selected.

Use Default Values – Select to use the default values of the
application. When unselected the following can be set for limits:

Query Contains Aggregation – Set the number of records to be
returned when the query contains aggregation for measures.

Query Without Aggregation – Set the number of records to be
returned when the query contains more than one dimension and
no aggregation measures. If one dimension is requested then
the query will remain as it was originally sent without any limits.
License
Use the License tab to locate and open the APOS Live Data Gateway license file that was supplied. This
information will be saved within the connection XML file that is generated.
APOS Systems Inc. | Live Data Gateway Reference
468
APOS Live Data Gateway
Field / Control
Description
License
Browse to the location of the APOS Live Data Gateway license file that
was supplied with this product.
SAC
Use the SAC tab to enter any required URLs when using CORS to connect the Live Data Gateway application to
SAC.
Field / Control
Description
SAC Tenant URL
Enter the SAC Tenant URL. This value is required when connecting to
SAC when using CORS using the below format.
https://companyName.sapanalytics.cloud
Multiple URLs must be separated by commas.
APOS Systems Inc. | Live Data Gateway Reference
469
APOS Live Data Gateway
APOS Systems Inc. | Live Data Gateway Reference
470
APOS Live Data Gateway
Connection String
The following are examples of connection strings being generated for each of the listed databases:
Google Big Query
Note: Create a 64bit ODBC DSN using Google Big Query that will be used when connecting through the Live
Data Gateway View Wizard.
Configure Service Account
Connect to Google Big Query using a Service Account that is associated with a Security File and a Project ID.
By selecting Configure Service Account, they can be added and saved when creating the
DG_DataSource.xml file.
APOS Systems Inc. | Live Data Gateway Reference
471
APOS Live Data Gateway
Field / Control
Description
Add/Delete
Use the buttons found above the service account list to Add or
Delete service accounts.
Press to add a Service Account to the list by filling in the
Service Account, Big Query Path Key, Big Query Project
ID and Password.
Select one or more rows and press to remove from the
Service Account List.
Service Account List
List of Service Accounts that have been configured to be used to
connect Google Big Query.





Service Account – Fill in the service account name. This value
will be used as the username when logging into the data source
in SAC.
BigQuery Path Key – Browse to a folder location that contains
the respective key for the service account being added.
BigQuery Project ID – Fill in the project ID.
Test Connection – Press Test Connection to validate the service
account information.
Password – Fill in a password that will be used when
connecting to the data source in SAC.
OK
Press OK to save changes and close the form.
Cancel
Press Cancel to close the form without updating.
APOS Systems Inc. | Live Data Gateway Reference
472
APOS Live Data Gateway
CDATA Drivers
The below check box options are available to further customize the CDATA Drivers connection:



Require Catalog In Query – Select when the catalog/database name is required when writing the Select
query.
Requires the Alias in ORDER BY – Select when the Order By syntax in the Select statement is to be
based upon the column alias and not on the real column name.
Use TOP in Select – Select to use TOP in the Select syntax for all database types with the exception of
Access. This feature is not compatible with the Access CDATA driver.
APOS will supply a file named APOS_CData_Drivers.zip that includes the necessary dll and jar files to be manually
copied to the following locations:



The dll files need to be copied to the LDG Admin folder where the Admin exe files are installed.
The jar files need to be copied to
o The LDG web application in the deployed WEB-INF\lib folder
o The APOSAdminTool web application in the deployed WEB-INF\lib folder
o The ConnectionTest_lib folder that is found with the LDG Admin folder
The CDATA driver for SAP Business One DI requires the below jar files to be copied from the SAP
Business One installation folder …\Program Files\SAP\SAP Business One DI API\JCO\LIB
o sboapi.jar
o sbowapper.jar
APOS Systems Inc. | Live Data Gateway Reference
473
APOS Live Data Gateway
The following examples show how to configure the Access CDATA driver connection option:
Access
Connection to Access is supported by selecting the CDATA Drivers database option and following the
below steps:
1.
Select Access from the Database CData Drivers drop down. The drivers found within this drop
down are based upon the dll files supplied in the APOS_CData_Drivers.zip that were copied to the
LDG Admin folder.
2.
Based upon the driver selected from the Database CData Drivers drop down the below settings will
be populated:

Connection String

Driver Class
3.
Add each of the properties to the Driver Properties table.
APOS Systems Inc. | Live Data Gateway Reference
474
APOS Live Data Gateway
Cloudera-Impala
Note: Create a 64bit ODBC DSN using Cloudera ODBC Driver for Impala to be used when connecting through
the Live Data Gateway View Wizard.
Denodo
Notes:


Create a 64bit ODBC DSN using Denodo to be used when connecting through the Desktop Admin Live
Data Gateway View Wizard.
Append the value ?useKerberos=true to the end of the Connection String when configuring a SSO
Kerberos connection.
HANA
Note: Create a 64bit ODBC DSN using HANA Client Driver to be used when connecting through the Live Data
Gateway View Wizard.
APOS Systems Inc. | Live Data Gateway Reference
475
APOS Live Data Gateway
Hive
The HIVE connection string includes the below databases:




Cloudera
Hortonworks
Google Cloud
Amazon EMR
Note: Create 64bit ODBC DSN connections for when connecting through the Live Data Gateway View
Wizard




Cloudera - Use Cloudera ODBC Driver for Impala
Hortonworks – Use Cloudera ODBC Driver for Impala
Google Cloud – Use Cloudera ODBC Driver for Impala
Amazon EMR – Use Amazon Hive ODBC Driver
IBM DB2
APOS Systems Inc. | Live Data Gateway Reference
476
APOS Live Data Gateway
JDBC Generic
The below check box options are available to further customize the JDBC connection:


Require Catalog In Query – Select when the catalog/database name is required when writing the Select
query.
Requires the Alias in ORDER BY – Select when the Order By syntax in the Select statement is to be
based upon the column alias and not on the real column name.
The following examples show how to configure Snowflake and Presto using the JDBC Generic connection option:
Snowflake
Connection to Snowflake is supported by selecting the JDBC Generic database option and following the
below steps:
1.
Populate the below settings:

Database Name

Connection String: enter the connection string and update the highlighted <placeholders>
jdbc:snowflake://<server>:<port>/?warehouse=<warehouse name>&db=<database
name>&schema=<schema>

Driver Class:
net.snowflake.client.jdbc.SnowflakeDriver
2.
Select the Require Catalog In Query check box due to the catalog/database name being required
when writing a query using Snowflake.
3.
Ensure the required JDBC driver jar file is copied to the deployed web application lib folder.
4.
When configuring the Time Dimensions and DB Functions for Snowflake, load the external file
SnowflakeFormula.xml that is included in the setup and can be found in the following directory.
…\Program Files\APOS\Live Data Gateway\Admin
APOS Systems Inc. | Live Data Gateway Reference
477
APOS Live Data Gateway
Presto
Connection to Presto is supported by selecting the JDBC Generic database option and following the below
steps:
1.
Copy the client credential files from Presto to a folder on the server.
 presto.jks
 presto.client.truststore.jks
2.
Populate the below settings:

Database Name

Connection String: enter the connection string and update the highlighted <placeholders>
jdbc:presto://<server>:<port>/database

Driver Class:
com.facebook.presto.jdbc.PrestoDriver
3.
Add each of the Presto properties to the Driver Properties table.
4.
Ensure the required JDBC driver jar file is copied to the deployed web application lib folder.
Microsoft SQL Server
Note: The SQL databases must be configured with mixed authentication mode. Windows authentication is not
supported.
MongoDB
APOS Systems Inc. | Live Data Gateway Reference
478
APOS Live Data Gateway
APOS Systems Inc. | Live Data Gateway Reference
479
APOS Live Data Gateway
MongoDB Atlas
Connection Parameters/Query Context
MySQL
Netezza
APOS Systems Inc. | Live Data Gateway Reference
480
APOS Live Data Gateway
Oracle
Note: Make sure that the below steps have been completed once the Oracle Client has been installed:
1.
2.
3.
Update the tsnames.ora file contained in your oracle client folder …\client\network\admin to
contain the connection to the Oracle database.
When creating the connection in the Admin use the Update Policy button to invoke the Edit Oracle
Policy dialog and update the Oracle Policy Information to match the installed oracle information.
Select the Connection Type from the drop down that matches the configured oracle database
environment.
Edit Oracle Policy
The Oracle Policy Information is populated with values that may not match your system. These values need
to be updated prior to pressing the Build View button in the Admin.
Update the Oracle Policy Information.
1.
In File Explorer locate the Oracle.DataAccess.dll file in the installed Oracle Client directory. In the
sample above this file is located in the c:\app\Administrator\product\12.2.0\client_2\ODP.NET\bin\4
folder.
APOS Systems Inc. | Live Data Gateway Reference
481
APOS Live Data Gateway
2.
Right click on the Oracle.DataAccess.dll file and select the Details tab. Make note of the File version
value.
3.
Within the Edit Oracle Policy dialog locate the below two tags and update the values if necessary with
the File version from the previous step.
 codebase version=
 newVersion=
4.
Additionally update the href= folder location of the Oracle.DataAccess.dll file with the installed oracle
client directory where the file is.
Press the Update button to save the information to the APOSLiveDGViewWizard.exe.config file.
5.
Oracle Exadata
Note: When using Oracle Exadata make sure that the below steps are completed once the Oracle Client has
been installed:
1.
Copy the supplied client credential files from Oracle Exadata Cloud to the oracle client installed
folder…\client\network\admin.
 cwallet.sso
 ewallet.p12
 keystore.jks
 truststore.jks
 sqlnet.ora
 tnsnames.ora
2.
Update the sqlnet.ora file contained in the …\client\network\admin folder. Change the DIRECTORY
path to the installed client folder …\client\network\admin
APOS Systems Inc. | Live Data Gateway Reference
482
APOS Live Data Gateway
3.
Configure the TNS_ADMIN Environmental Variable to the installed client folder
…\client\network\admin.
4.
Create the 64bit ODBC DSN connection.
Redshift
Sybase IQ
Note: Create a 64bit ODBC DSN using the SybaseIQ Network Client 16.1 to be used when connecting through
the Live Data Gateway View Wizard.
Sybase SQL Anywhere
Note: Create a 64bit ODBC DSN using the SAP SQL Anywhere Database Client to be used when connecting
through the Live Data Gateway View Wizard.
Teradata
APOS Systems Inc. | Live Data Gateway Reference
483
APOS Live Data Gateway
Admin Tool Web Application
The Admin Tool Web Application is a flexible web application that allows users to create Views that can be accessed
when creating Models in SAC. The web application is deployed to tomcat (version 8 min) and used to define views via
the Admin Tool Web UI. This Web UI is intended for data sources of type Database only and is supported when LDG
is configured using the Database Method as a backend. The Non-Database backend Method is not supported with
this feature.
The Admin Tool web UI supports 8 languages including English, German, Spanish, French, Hebrew, Brazilian
Portuguese, Romanian and Russian.
The following must be completed prior to using the Admin Tool Web UI:
Web Application Deployment:
1.
The APOSAdminTool.war file must be deployed to tomcat. To check that the application has been deployed
successfully and to verify the version number enter the below URL.
http(s)://localhost:8443/APOSAdminTool/web/About
2.
The database jar files must be deployed to the …\WEB-INF\lib folder of the web application.
3.
The LDG database must be configured using the Live Data Gateway Manager with one database connection and
the below options selected:

Approve Users for Web UI

Apply Freehand SQL flag to Connections
4.
The LDG_Config.xml file exported from the Live Data Gateway Manager must be copied to the …\WEBINF\classes folder of the web application.
5.
Restart Tomcat.
6.
Launch the Admin Tool Web UI.
Independent Service Deployment:
1.
The Admin Tool Service files need to be deployed and the files configured as outlined in the Independent Service
guideline. To check that the service has been deployed successfully and to verify the version number enter the
below URL.
https://localhost:port/web/About
2.
The LDG database must be configured using the Live Data Gateway Manager with one database connection and
the below options selected:

Approve Users for Web UI

Apply Freehand SQL flag to Connections
3.
The LDG_Config.xml file exported from the Live Data Gateway Manager must be copied to the deployed service
folder.
4.
Launch the Admin Tool Web UI.
APOS Systems Inc. | Live Data Gateway Reference
484
APOS Live Data Gateway
Admin Tool Web UI
To begin using the Admin Tool Web UI enter the below URL based upon the method of deployment:
Web Application Deployment: http(s)://localhost:8443/APOSAdminTool/web/index.html
Independent Service Deployment: https://localhost:port/web/index.html
Login
Launch the Login web form and select the Connection from the drop down. Both the User Name and Password
may not be required based upon the configuration of the connection.
When the connection was configured with SSO the connection to the database will be executed using the same SSO
configuration type as defined in the Desktop Live Data Gateway Admin. Denodo connections configured with
Kerberos SSO are not supported at this time and will require a username and password to be entered.
OAuth Authentication – When a database connection with OAuth authentication is selected additional prompts will
occur after pressing Login to create the necessary token to validate the connection using the SAML/NTLM user of the
machine.
Field / Control
Description
Connection
Select one Connection from the drop down. These connections have
been configured using the Live Data Gateway Manager and should
have the below configured options configured. Based upon the
Connection selected the User Name and Password may not be
required.


Approve Users for Web UI
Apply Freehand SQL flag to Connections
APOS Systems Inc. | Live Data Gateway Reference
485
APOS Live Data Gateway
Field / Control
Description
User Name
Fill in the database User Name for the connection. If the database
does not require a username leave this blank.
Password
Fill in the Password for the database user. If the database does not
require a username leave this blank.
Login
Press the Login button to log into the LDG database and load the
Views form to begin editing or configuring new views.
APOS Systems Inc. | Live Data Gateway Reference
486
APOS Live Data Gateway
Views
After successfully logging into the selected connection choose from the following options the type of view to be
configured or updated.

Freehand SQL Views - Configure Freehand SQL views based on relational databases.

Semantic Layer Views - Configure Semantic Layer views based on relational databases.

Stored Procedure Views – Configure Views based upon MS SQL Stored Procedures. JDBC Generic
connections to SQL Server are not supported.
Field / Control
Description
Connection
Display of the database Connection selected.
Freehand SQL
The Freehand SQL button displays the number of Freehand SQL views
that have been configured by either the Web UI or the View Wizard –
Freehand SQL desktop application. Selecting this button invokes the
forms to configure new or edit existing Freehand SQL views.
Semantic Layer
The Semantic Layer button displays the number of Semantic Layer
views that have been configured by either the Web UI or the View
Wizard desktop application. Selecting this button invokes the forms
to configure new or edit existing Semantic Layer views.
APOS Systems Inc. | Live Data Gateway Reference
487
APOS Live Data Gateway
Field / Control
Description
Stored Procedure
The Stored Procedure button displays the number of Views based
upon stored procedures contained within a SQL Server that have been
configured by either the Web UI or the View Wizard – Stored
Procedure desktop application. Selecting this button invokes the
forms to configure new or edit existing Stored Procedure views.
Tenant #1
Display of the SAC Tenant URL(s) setup in the LDG Gateway Admin
Configuration Management form.
For connections using OAuth 2.0 authentication log into SAC using the
link(s) located here to complete the OAuth token validation process.
APOS Systems Inc. | Live Data Gateway Reference
488
APOS Live Data Gateway
Freehand SQL Views
Listing Views
The Listing Views page displays all currently configured freehand SQL views that have been created using either
LDG Manager or the Web UI. The views listed here are limited to those users that have been approved to use the
Web UI.
Field / Control
Description
Connection
Display of the database Connection selected from the Login screen.
View Name
Search for a View Name from the listing of views.
New View
Select the New View button to invoke the Adding View page.
View Listing
The View Listing contains all freehand SQL views created by either the
LDG Manager or the Web UI and the Action items.
Logout
Select the Logout icon located at the upper right of
the window to log out of the connection and return
to the Login form.
APOS Systems Inc. | Live Data Gateway Reference
489
APOS Live Data Gateway
Adding View
Enter the View Description, User Access and SQL Statement using the Adding View page.

Connection – Add the view prefix, name, and description and user access level.

SQL Statement – Create the view SQL select statement

Extra Dimensions – The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with tables that contain datetime fields defined,
create Time Dimensions. This option is supported for the below relational database
connections.






o

MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.
Sample Results/Assign Measure – View sample results and assign measures and their aggregation.
APOS Systems Inc. | Live Data Gateway Reference
490
APOS Live Data Gateway
Connection
Add the view prefix, name, and description and user access level. The View Prefix and View Name must
be uniquely named across all prefixes and names contained within the LDG database.
Field / Control
Description
Connection Name
Display of the Connection Name that the view will belong to.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Prefix
Populate the view with a unique View Prefix name. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate with a unique View Name. The value must be unique across
all view names contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Description
Add the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
Global (All Users)
Access
Set the Global Access level for the view when accessing the view
within SAC when creating a Model. By default this check box is not
selected which will cause the view to be hidden when creating a
Model. Once selected any database user can select the view when
creating Models in SAC. Once the view is saved additional access
levels can be set by selecting the Sharing View icon.
APOS Systems Inc. | Live Data Gateway Reference
491
APOS Live Data Gateway
Field / Control
Description
Include Geospatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
When Query Limits Not
Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
SQL Statement
Create the view SQL Statement within the Text Area. Once complete press Run Sample to validate the
statement.
APOS Systems Inc. | Live Data Gateway Reference
492
APOS Live Data Gateway
Field / Control
Description
Metadata
Within the Metadata tree view navigate to the desired tables and
drag the columns to the SQL Statement text area to assist in creating
the SQL statement. Alternatively double click on the column to add
it to the statement. When using the drag and drop method,
additional syntax may need to be added to the resulting SQL
Statement.
SQL Statement
The SQL Statement to be used within the view.
Run Sample
Select Run Sample to validate the SQL Statement and display a
sampling of the data and to continue adding Extra Dimensions if
applicable.
APOS Systems Inc. | Live Data Gateway Reference
493
APOS Live Data Gateway
Time Dimensions
View the Sample Results and then Create Time Dimensions in the view for those connections with Time
Dimensions configured. This option is supported for the below relational database connections.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
APOS Systems Inc. | Live Data Gateway Reference
494
APOS Live Data Gateway
Field / Control
Description
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
APOS Systems Inc. | Live Data Gateway Reference
495
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
496
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension
Name
Set the Location Dimension Name.
Identifier for Mapping
Set the Identifier for Mapping.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
497
APOS Live Data Gateway
Field / Control
Description
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
498
APOS Live Data Gateway
Assign Measure
View sample results and assign measures and their aggregation before saving the new view. At least
one numerical column must be assigned as a measure. Any Time Dimensions and Geospatial
Dimensions configured will be listed at the bottom.
Field / Control
Description
APOS Systems Inc. | Live Data Gateway Reference
499
APOS Live Data Gateway
Field / Control
Description
Assignment of Measure
Assign the SQL Statement columns with the below settings:
Save

Is It a Measure – Set the column to be a measure. By default
all columns are set to No. At least one column must be
configured as a measure.

Column Name – Display of the Column Name.

Column Description – Update the Column Description.

Aggregation –Select one of the aggregation values available
in the drop down for the measure:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions - Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
Press to Save the new view to the LDG database.
APOS Systems Inc. | Live Data Gateway Reference
500
APOS Live Data Gateway
View Listing
The View Listing contains all freehand SQL views created by both the LDG Manager and the Admin Tool
Web UI along with the Action items that can be performed on them.
Field / Control
Description
Name
Display the Name of the view.
Description
Display the Description of the view.
Action
The following Action items are available in the View Listing.
Select the Edit the View icon to invoke the Editing View
page. Only the view owner can update a view.
Select the Share the View icon to invoke the Sharing View
page to assign database user access to the view in SAC.
Select the Delete the View icon to remove the view from
the LDG database. Only the owner can delete a view.
APOS Systems Inc. | Live Data Gateway Reference
501
APOS Live Data Gateway
Editing View
Update the View Description, Access and SQL Statement using the Editing View page. Only the view
database owner can edit a view.

Connection – Update the View Description and user Access level.

SQL Statement – Update the view SQL statement.

Extra Dimensions – The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with tables that contain datetime fields defined,
create Time Dimensions. This option is supported for the below relational database
connections.






o

MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.
Sample Results/Assign Measure – View sample results and update the assignment of measures and their
aggregation.
APOS Systems Inc. | Live Data Gateway Reference
502
APOS Live Data Gateway
Connection
Update the view description and user access level.
Field / Control
Description
Connection Name
Display of the Connection Name.
View Prefix
Display of the View Prefix name.
View Name
Display of the View Name.
View Description
Update the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
Global (All Users)
Access
Set the Global Access level. Once selected any database user can
select the view when creating Models in SAC.
Include Geospatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
APOS Systems Inc. | Live Data Gateway Reference
503
APOS Live Data Gateway
Field / Control
Description
When Query Limits
Not Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
504
APOS Live Data Gateway
SQL Statement
Update the view SQL statement within the Text Area. Once completed press Run Sample to valid the
statement.
Field / Control
Description
Metadata
Within the Metadata tree view navigate to the desired tables and
drag the columns to the SQL Statement text area to assist in
creating the SQL statement. Alternatively double click on the
column to add it to the statement
SQL Statement
The SQL Statement to be used within the view.
Run Sample
Select Run Sample to validate the SQL Statement and display a
sampling of the data.
APOS Systems Inc. | Live Data Gateway Reference
505
APOS Live Data Gateway
Time Dimensions
View the Sample Results and then Create Time Dimensions in the view for those connections with Time
Dimensions configured. This option is enabled for the below relational database connections.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
APOS Systems Inc. | Live Data Gateway Reference
506
APOS Live Data Gateway
Field / Control
Description
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
APOS Systems Inc. | Live Data Gateway Reference
507
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
508
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension
Name
Set the Location Dimension Name.
Identifier for Mapping
Set the Identifier for Mapping.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
509
APOS Live Data Gateway
Field / Control
Description
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
510
APOS Live Data Gateway
Assign Measure
Update the assignment of measures and their aggregation before saving the updated view. At least one
numerical field must be assigned a measure. Any Time Dimensions and Geospatial Dimensions
configured will be listed at the bottom.
APOS Systems Inc. | Live Data Gateway Reference
511
APOS Live Data Gateway
Field / Control
Description
Assignment of Measure
Assign the SQL Statement columns with the below settings:

Is It a Measure – Set the column as a measure. By default all
columns are set to No. At least one column must be
configured as a measure.

Column Name – Display of the Column Name.

Column Description – Update the Column Description.

Aggregation –Select one of the aggregation values available
in the drop down for the measure:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions - Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
Save
Press to Save the updated view settings.
Reload
Press to Reload all the view settings from the database.
APOS Systems Inc. | Live Data Gateway Reference
512
APOS Live Data Gateway
Sharing View
Use the Sharing View page to assign database user access of the view in SAC
Field / Control
Description
Global (All Users) Access
Select whether there is Global Access to the view within SAC when
creating a Model. When not selected the view will be hidden when
creating a Model. Once selected any database user can select the
view when creating Models in SAC. Alternatively specific database
user names can be assigned access rights.
Enter Database User
Name
Enter the Database User Name that is to have access to the view
within SAC.
New User
Press New User to add the DB User Name to the All Users Sharing
the View listing.
All Users Sharing the
View
User name
The database user name with access to the view.
Select to remove the user from the listing.
APOS Systems Inc. | Live Data Gateway Reference
513
APOS Live Data Gateway
Semantic Layer Views
Listing Views
The Listing Views page displays all configured Semantic Layer views created using either the LDG Manager or
the Admin Tool Web UI. The views listed here are limited to those users that have been approved to use the
Web UI.
The APOS Semantic Layer views are designed to describe only Star or Snowflake data structures. This guarantees
that the end user can choose any measure and dimension combination and they will all be valid. If you have to
use other structures you will wither need to use a freehand SQL view or you can wrap those structures in a
database view and bring them into the semantic layer view. You should not have multiple fact tables in a
semantic layer view as a dimension might need to be joined to both creating a bad join. Multiple fact tables need
to be joined at the database level in a database view so that the database view can be used as a single fact table
in the semantic layer view.
The idea behind a semantic layer is to obfuscate the complex data structure of the database. We do not want to
create a situation in which the user needs to know not to choose certain fields together because it will cause the
joins not to work. All the measures and dimensions in a semantic layer view must be relatable. If they are not they
need to be separated into separate views.
Field / Control
Description
Connection
Display of the Connection selected from the Login screen.
Semantic Layer
Search for a Semantic Layer view name from the listing of views.
New Semantic Layer
Select to create a Semantic Layer view by invoking the Adding View
page.
View Listing
The View Listing contains all Semantic views created by either the Live
Data Gateway Manager or the Web UI and the Action items that can
be performed on them.
APOS Systems Inc. | Live Data Gateway Reference
514
APOS Live Data Gateway
Field / Control
Logout
Description
Select the Logout icon located at the upper right of
the window to return to log out of the connection
and return to the Login form.
APOS Systems Inc. | Live Data Gateway Reference
515
APOS Live Data Gateway
Adding View
Add the View Prefix, View Name, Description and Access Level followed by selecting table columns,
dimensions, measures and any joins using the Adding View page.

Add Semantic Layer View Name – Add the view prefix, name, and description and user access level.

Select Table Columns – Select columns from the table(s).

Extra Dimensions - The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with Time Dimensions defined, create Time
Dimensions. This option is supported for the below relational database connections.






o
MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.

Select Dimension and Measure – View sample results and assign measures and their aggregation. At
least one numerical column must be assigned as a measure.

Define Table Joins – Define the join(s) when selecting more than one table.

Review – Review all values before saving the new view.
APOS Systems Inc. | Live Data Gateway Reference
516
APOS Live Data Gateway
Add Semantic Layer View Name
Enter the View Prefix, View Name, View Description and select Global Access. Once complete press
Step 2 to continue.
Field / Control
Description
Connection Name
Display of the Connection Name that the view is based upon.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Prefix
Populate the view with a unique View Prefix name. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate with a unique View Name. The value must be unique across
all view names contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Description
Add the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
APOS Systems Inc. | Live Data Gateway Reference
517
APOS Live Data Gateway
Field / Control
Description
Global (All Users)
Access
Set the Global Access level for the view when accessing the view
within SAC when creating a Model. By default this check box is not
selected which will cause the view to be hidden when creating a
Model. Once selected any database user can select the view when
creating Models in SAC. Once the view is saved additional access
levels can be set by selecting the Sharing View icon.
Include Geo Spatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
When Query Limits Not
Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
518
APOS Live Data Gateway
Select Table Columns
Select columns from the table(s) and press Step 3 to continue.
Field / Control
Description
Schema
Within the Schema select the box to the left of each field to be
added to the view so that at least two fields are selected, one a
numerical measure and the other a dimension.
APOS Systems Inc. | Live Data Gateway Reference
519
APOS Live Data Gateway
Extra Dimensions
When applicable assign the following Extra Dimensions:


Time Dimensions
Geospatial Dimensions
Time Dimensions
Create Time Dimensions in the view for those connections with Time Dimensions configured. This
option is enabled for the below relational database connections. Press Step 4 to continue.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
APOS Systems Inc. | Live Data Gateway Reference
520
APOS Live Data Gateway
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
APOS Systems Inc. | Live Data Gateway Reference
521
APOS Live Data Gateway
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
APOS Systems Inc. | Live Data Gateway Reference
522
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
523
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension
Name
Set the Location Dimension Name.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
524
APOS Live Data Gateway
Field / Control
Description
Identifier for Mapping
Set the Identifier for Mapping.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Select Table
Select the table from the drop down. The values contained in the
drop down are based upon the selected tables in the previous step.
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
525
APOS Live Data Gateway
Select Dimension and Measure
Select and assign measures and their aggregation before pressing Step 5 to continue. At least one
numerical column must be assigned as a measure. All configured Time Dimensions and Geospatial
Dimensions will be listed in the bottom rows here.
APOS Systems Inc. | Live Data Gateway Reference
526
APOS Live Data Gateway
Field / Control
Description
Select Dimension and
Measure
Assign the columns with the below settings:

Is It a Measure – Set the column to be a measure. By default
all columns are set to No. At least one column must be
configured as a measure.

Table name – Display of the table name of the field.

DB Field Name – Display of the field name.

Dimension/Measure Id – Display of the Dimension/Measure
Id.

Dimension/Measure Name – Update the
Dimension/Measure Name that will be displayed when
creating the Model in SAC. Duplicate names are not allowed
and will be flagged by the Web UI to be updated before
saving the View.

Aggregation –Select one of the aggregation values available
in the drop down for measures:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions – Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
APOS Systems Inc. | Live Data Gateway Reference
527
APOS Live Data Gateway
Define Table Joins
Define the table joins when columns have been selected from more than one table. Press Review to
check all entered view settings before saving.
Field / Control
Description
New Table Join
Press New Table Join to Define a Table Join.
Delete Table Join
Press Delete Table Join to remove the selected rows from the
Table Joins Listing.
Get DB Relationships
Press Get DB Relationships to load the available relationship from
the database to the listing. If relationships have not been
configured within the database they will have to be manually
entered in this form. This option is available for the following
relational databases:






Join Listing
Denodo
MS SQL
HANA
MySQL
DB2
Oracle
Set the following values to complete the Table Join.






Left Table Schema
Left Table Name
Left Table Column Key
Right Table Schema
Right Table Name
Right Table Column Key
APOS Systems Inc. | Live Data Gateway Reference
528
APOS Live Data Gateway
Review
Review all values entered for the Semantic Layer View. If any updates are needed press the Edit button
found at the bottom right of each section to make changes. Press Add New View to add the view to
the View Listing.
APOS Systems Inc. | Live Data Gateway Reference
529
APOS Live Data Gateway
View Listing
The View Listing contains all Freehand SQL views created by either the LDG Manager or the Admin Tool
Web UI. The Action items for each are to the right of the Description.
Field / Control
Description
Name
Display the Name of the view.
Description
Display the Description of the view.
Action
The following Actions are available in the View Listing.
Select the Edit the View icon to invoke the Editing View
page. Only the view owner can update a view.
Select the Share the View icon to invoke the Sharing View
page to assign database user access to the view in SAC.
Select the Delete the View icon to remove the view from
the LDG database. Only the owner can delete a view.
APOS Systems Inc. | Live Data Gateway Reference
530
APOS Live Data Gateway
Editing View
Update the View Description, Access and Columns and their dimension and measure assignments using
the Editing View page. Only the view database owner can edit a view.

Edit Semantic Layer View Information – Edit the description and user access level.

Select Table Columns – Edit columns from the table(s)

Extra Dimensions - The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with Time Dimensions defined, create Time
Dimensions. This option is supported for the below relational database connections.






o
MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.

Select Dimension and Measure – View sample results and update measures and their aggregation. At
least one numerical column must be assigned as a measure.

Define Table Joins – Update the join(s) when selecting more than one table.

Review – Review all values before saving the updated view.
APOS Systems Inc. | Live Data Gateway Reference
531
APOS Live Data Gateway
Edit Semantic Layer View Information
Edit the View Description and Global Access level. Once complete press Step 2 to continue.
Field / Control
Description
Connection Name
Display of the Connection Name that the view is based upon.
View Prefix
Display of the unique View Prefix name.
View Name
Display of the unique View Name.
View Description
Edit the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
Global (All Users)
Access
Update the Global Access level for the view when accessing the view
within SAC when creating a Model. By default this check box is not
selected which will cause the view to be hidden when creating a
Model. Once selected any database user can select the view when
creating Models in SAC. Once the view is saved additional access
levels can be set by selecting the Sharing View icon.
Include Geospatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
APOS Systems Inc. | Live Data Gateway Reference
532
APOS Live Data Gateway
Field / Control
Description
When Query Limits Not
Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
533
APOS Live Data Gateway
Select Table Columns
Update the selected columns from the table(s) and press Step 3 to continue.
Field / Control
Description
Table Treeview
Within the Table Treeview select the box to the left of each field to
be added to the view so that at least two fields are selected, one a
numerical measure and the other a dimension.
APOS Systems Inc. | Live Data Gateway Reference
534
APOS Live Data Gateway
Extra Dimensions
When applicable assign the following Extra Dimensions:


Time Dimensions
Geospatial Dimensions
Time Dimensions
Create Time Dimensions in the view for those connections with Time Dimensions configured. This
option is enabled for the below relational database connections. Press Step 4 to continue.






MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
APOS Systems Inc. | Live Data Gateway Reference
535
APOS Live Data Gateway
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
APOS Systems Inc. | Live Data Gateway Reference
536
APOS Live Data Gateway
Field / Control
Description
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
APOS Systems Inc. | Live Data Gateway Reference
537
APOS Live Data Gateway
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
APOS Systems Inc. | Live Data Gateway Reference
538
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
539
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
Location Dimension
Name
Set the Location Dimension Name.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
540
APOS Live Data Gateway
Field / Control
Description
Identifier for Mapping
Set the Identifier for Mapping.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Select Table
Select the table from the drop down. The values contained in the
drop down are based upon the selected tables in the previous step.
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
541
APOS Live Data Gateway
Select Dimension and Measure
Update the Measures and aggregation before pressing Step 4 to continue.
APOS Systems Inc. | Live Data Gateway Reference
542
APOS Live Data Gateway
Field / Control
Description
Select Dimension and
Measure
Assign the columns with the below settings:

Is It a Measure – Set the column to be a measure. By default
all columns are set to No. At least one column must be
configured as a measure.

Table name – Display of the table name of the field.

DB Field Name – Display of the field name.

Dimension/Measure Id – Display of the Dimension/Measure
Id.

Dimension/Measure Name – Update the
Dimension/Measure Name that will be displayed when
creating the Model in SAC. Duplicate names are not allowed
and will be flagged by the Web UI to be updated before
saving the View.

Aggregation –Select one of the aggregation values available
in the drop down for measures:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions – Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
APOS Systems Inc. | Live Data Gateway Reference
543
APOS Live Data Gateway
Define Table Joins
Update the table joins when columns have been selected from more than one table. Press Review to
check all entered view settings before saving the view.
Field / Control
Description
New Table Join
Press New Table Join to Define a Table Join.
Delete Table Join
Press Delete Table Join to remove the selected rows from the
Table Joins Listing.
Join Listing
Set the following values to complete the Table Join.

Left Table Schema

Left Table Name

Left Table Column Key

Right Table Schema

Right Table Name

Right Table Column Key
APOS Systems Inc. | Live Data Gateway Reference
544
APOS Live Data Gateway
Review
Review all values entered for the Semantic Layer View. If needed press the Edit button found at the
bottom right within each section and make changes. Press Save to update the view settings and return
to the View Listing.
APOS Systems Inc. | Live Data Gateway Reference
545
APOS Live Data Gateway
Sharing View
Use the Sharing View page to assign database user access of the view in SAC
Field / Control
Description
Global (All Users) Access
Select whether there is Global Access to the view within SAC when
creating a Model. When creating a new view this option is not
selected and will cause the view to be hidden when creating a Model.
Once selected any database user can select the view when creating
Models in SAC. Alternatively specific database user names can be
assigned access rights.
Enter Database User
Name
Enter the Database User Name that is to have access to the view
within SAC.
New User
Press New User to add the DB User Name to the All Users Sharing
the View listing.
All Users Sharing the
View
User
The database user name with access to the view.
Select to remove the user from the listing.
APOS Systems Inc. | Live Data Gateway Reference
546
APOS Live Data Gateway
Stored Procedure Views
Listing Stored Procedure Views
The Listing Views page displays all configured Stored Procedure views created using either the LDG Manager
or the Admin Tool Web UI. The views listed here are limited to those users that have been approved to use the
Web UI. Stored Procedure views are supported when connecting to a MS SQL Server database. Connections
using JDBC Generic to SQL Server are not supported.
Field / Control
Description
Connection
Display of the Connection selected from the Login screen.
Stored Procedure View
Search for a Stored Procedure View name from the listing of views.
New Stored Procedure View
Select to create a Stored Procedure View by invoking the Adding
View page.
View Listing
The View Listing contains all Stored Procedure views created by either
the Live Data Gateway Manager or the Web UI and the Action items
that can be performed on them.
Logout
Select the Logout icon located at the upper right of
the window to return to log out of the connection
and return to the Login form.
APOS Systems Inc. | Live Data Gateway Reference
547
APOS Live Data Gateway
Adding View
Add the View Prefix, View Name, Description and Access Level followed by selecting the stored
procedure, input parameters, dimensions and measures using the Adding View page.

Add Stored Procedure View Name – Add the view prefix, name, and description and user access level.

Select Stored Procedure – Select a Stored Procedure from the database.

Stored Procedure Parameters – Set a label and default value of the input parameters of the stored
procedure.

Extra Dimensions - The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with Time Dimensions defined, create Time
Dimensions. This option is supported for the below relational database connections.






o
MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.

Select Dimension and Measure – View sample results and assign measures and their aggregation. At
least one numerical column must be assigned as a measure.

Review – Review all values before saving the new view.
APOS Systems Inc. | Live Data Gateway Reference
548
APOS Live Data Gateway
Add Stored Procedure View Name
Enter the View Prefix, View Name, View Description and select Global Access. Once complete press
Step 2 to continue.
Field / Control
Description
Connection Name
Display of the Connection Name that the view is based upon.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Prefix
Populate the view with a unique View Prefix name. The value must be
unique across all prefixes contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Name
Populate with a unique View Name. The value must be unique across
all view names contained within the selected LDG Database.
The following characters are not supported in this field:
\ -- “ = > < ; *
View Description
Add the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
APOS Systems Inc. | Live Data Gateway Reference
549
APOS Live Data Gateway
Field / Control
Description
Global (All Users)
Access
Set the Global Access level for the view when accessing the view
within SAC when creating a Model. By default this check box is not
selected which will cause the view to be hidden when creating a
Model. Once selected any database user can select the view when
creating Models in SAC. Once the view is saved additional access
levels can be set by selecting the Sharing View icon.
Include Geospatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
Virtual Points based upon stored procedures with parameters are not
supported.
When Query Limits Not
Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
550
APOS Live Data Gateway
Select Stored Procedure
Select a Stored Procedure from the database and press Step 3 to continue.
Field / Control
Description
Schema
Expand the schema and select the box to the left of the desired
stored procedure. A stored procedure must contain at least two
fields, one a numerical measure and the other a dimension and must
return a result set.
APOS Systems Inc. | Live Data Gateway Reference
551
APOS Live Data Gateway
Stored Procedure Parameters
When the Stored Procedure contains input parameters assign a Label and a Default Value for each.
Any output parameters will be listed however they are for display only. Press Step 4 to continue.
Field / Control
Description
Parameter Name
Any input/output parameter names are listed as display only.
Label
Assign a unique Label name to any input parameters.
The following characters are not supported in this field:
\ -- “ = > < ; *
Value
Assign a default value to the input parameter. This value must be
populated.
Data Type
The Data Type of the parameter Data Type is displayed.
Order
The Order of the parameters is displayed.
Is Output
Indicator of whether the parameter is an input or output parameters.
APOS Systems Inc. | Live Data Gateway Reference
552
APOS Live Data Gateway
Extra Dimensions
When applicable assign the following Extra Dimensions:


Time Dimensions
Geospatial Dimensions
Time Dimensions
Create Time Dimensions in the view for those connections with Time Dimensions configured. This
option is enabled for MS SQL relational database connections. If applicable add Geospatial Dimensions
and press Step 5 to continue.
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
APOS Systems Inc. | Live Data Gateway Reference
553
APOS Live Data Gateway
Field / Control
Description
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
Year
APOS Systems Inc. | Live Data Gateway Reference
554
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
555
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Virtual Points based upon stored procedures with parameters are not supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
556
APOS Live Data Gateway
Field / Control
Description
Location Dimension
Name
Set the Location Dimension Name.
Identifier for Mapping
Set the Identifier for Mapping.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Select Table
Select the table from the drop down. The values contained in the
drop down are based upon the selected tables in the previous step.
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
557
APOS Live Data Gateway
Select Dimension and Measure
Select and assign measures and their aggregation before pressing Review to continue. At least one
numerical column must be assigned as a measure. Any Parameters, Time Dimensions and Geospatial
Dimensions will be displayed here.
APOS Systems Inc. | Live Data Gateway Reference
558
APOS Live Data Gateway
Field / Control
Description
Select Dimension and
Measure
Assign the columns with the below settings:

Is It a Measure – Set the columns to be measures. By default
all columns are set to No. At least one column must be
configured as a measure.

Table name – Display of the table name of the field.

DB Field Name – Display of the field name.

Dimension/Measure Id – Display of the Dimension/Measure
Id to be used. Parameters will be prefixed by PARAM_ and
cannot be updated here.

Dimension/Measure Name – Update the
Dimension/Measure Name that will be displayed when
creating the Model in SAC. Duplicate names are not allowed
and will be flagged by the Web UI to be updated before
saving the View. Parameters will be prefixed by PARAM_ and
cannot be updated here.

Aggregation –Select one of the aggregation values available
in the drop down for measures:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions – Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
APOS Systems Inc. | Live Data Gateway Reference
559
APOS Live Data Gateway
Review
Review all values entered for the Stored Procedure. If any updates are needed press the Edit button
found at the bottom right of each section to make changes. Press Save to add the view to the View
Listing.
APOS Systems Inc. | Live Data Gateway Reference
560
APOS Live Data Gateway
View Listing
The View Listing contains all Stored Procedure views created by either the LDG Manager or the Admin
Tool Web UI. The Action items for each are to the right of the Description.
Field / Control
Description
Name
Display the Name of the view.
Description
Display the Description of the view.
Action
The following Actions are available in the View Listing.
Select the Edit the View icon to invoke the Editing View
page. Only the view owner can update a view.
Select the Share the View icon to invoke the Sharing View
page to assign database user access to the view in SAC.
Select the Delete the View icon to remove the view from
the LDG database. Only the owner can delete a view.
APOS Systems Inc. | Live Data Gateway Reference
561
APOS Live Data Gateway
Editing View
Update the View Description, Access and Stored Procedure selection and the input parameter, dimension
and measure assignments using the Editing View page. Only the view database owner can edit a view.

Edit Stored Procedure View Name – Edit the description and user access level.

Select Stored Procedure – Select a stored procedure from the database.

Stored Procedure Parameters – Set a label and default value of the input parameters of the stored
procedure.

Extra Dimensions - The following Extra Dimensions can be configured:
o
Time Dimensions - For those connections with Time Dimensions defined, create Time
Dimensions. This option is supported for the below relational database connections.






o
MS SQL
Oracle
Denodo
Google Big Query
DB2
Snowflake
Geospatial Dimensions - Define virtual points when implementing spatial functionality. Joins
between tables are not allowed when defining virtual points so ensure that all fields are part of
one single table. Only coordinate values with projection of SRID 3857 and 4326 are supported.

Select Dimension and Measure – View sample results and assign measures and their aggregation. At
least one numerical column must be assigned as a measure.

Review – Review all values before saving the updated view.
APOS Systems Inc. | Live Data Gateway Reference
562
APOS Live Data Gateway
Edit Stored Procedure View Information
Edit the View Description and Global Access level. Once complete press Step 2 to continue.
Field / Control
Description
Connection Name
Display of the Connection Name that the view is based upon.
View Prefix
Display of the unique View Prefix name.
View Name
Display of the unique View Name.
View Description
Edit the View Description.
The following characters are not supported in this field:
\ -- “ = > < ; *
Global (All Users)
Access
Update the Global Access level for the view when accessing the view
within SAC when creating a Model. By default this check box is not
selected which will cause the view to be hidden when creating a
Model. Once selected any database user can select the view when
creating Models in SAC. Once the view is saved additional access
levels can be set by selecting the Sharing View icon.
Include Geospatial
Select Include Geospatial to allow for the configuration of virtual
point settings.
APOS Systems Inc. | Live Data Gateway Reference
563
APOS Live Data Gateway
Field / Control
Description
When Query Limits Not
Provided
Set a predefined number of records to be returned when using the
OData Gateway service when queries to be executed are unlimited or
the row limit is 2,147,483,647. These values can be set at both the
connection and view level. Any values set on the view level take
precedence over the connection level query limits. By default the Use
Default is selected.

Use Default – Select to use the default values of the application.
When unselected the following can be set for limits:

Set Row Limit For Queries With Aggregation – Set the
number of records to be returned when the query contains
aggregation for measures.

Queries Without Aggregation – Set the number of records
to be returned when the query contains more than one
dimension and no aggregation measures. If one dimension
is requested then the query will remain as it was originally
sent without any limits.
APOS Systems Inc. | Live Data Gateway Reference
564
APOS Live Data Gateway
Select Stored Procedure
Update the selected stored procedure and press Step 3 to continue.
Field / Control
Description
Schema
The selected stored procedure will be displayed. A stored procedure
must contain at least two fields, one a numerical measure and the
other a dimension and must return a result set.
APOS Systems Inc. | Live Data Gateway Reference
565
APOS Live Data Gateway
Stored Procedure Parameters
When the Stored Procedure contains input parameters they will be displayed here with the assigned
Label and a Default Value for each and can be updated. Any output parameters will be listed however
they are for display only. Press Step 4 to continue.
Field / Control
Description
Parameter name
Any input/output parameter names are listed as display only.
Label
Assign a unique Label name to any input parameters.
The following characters are not supported in this field:
\ -- “ = > < ; *
Value
Assign a default value to the input parameter. This value must be
populated.
Data Type
The Data Type of the parameter Data Type is displayed.
Order
The Order of the parameters is displayed.
Is Output
Indicator of whether the parameter is an input or output parameters.
APOS Systems Inc. | Live Data Gateway Reference
566
APOS Live Data Gateway
Extra Dimensions
When applicable assign the following Extra Dimensions:


Time Dimensions
Geospatial Dimensions
Time Dimensions
Any Time Dimensions will be displayed here for those connections with Time Dimensions configured
and can be updated. This option is enabled for MS SQL relational database connections. Press Step 5
to continue.
APOS Systems Inc. | Live Data Gateway Reference
567
APOS Live Data Gateway
Field / Control
Description
New Time Dimension
Press New Time Dimension to begin adding Time Dimensions. This
option is visible when the database connection was configured with
the Time Dimension functions.
Delete Time Dimension
The Delete Time Dimension option becomes visible once a Time
Dimension has been selected. Once pressed the selected row is
deleted.
Select Time Dimension
Select one or more rows to delete Time Dimensions.
Date/Time Field
Select the Date/Time Field from the drop down. The drop down
will contain only those fields that were configured as either date or
timestamp fields.
Time Definition
Select the Time Definition to be assigned to the dimension. The
drop down will contain only those Datetime Functions assigned in
the Time Dimension tab of the Connection. The following time
definitions are available for selection from the drop down when all
functions are enabled.







Year
Year, Quarter
Year, Quarter, Month, Day
Year, Quarter, Month, Week, Day
Year, Month, Day
Year, Week
Year, Week, Day
Level Definition – As each Time Definition is selected, the Level
Definition will be assigned with all dimensions that are generated as
a result of the definition. These levels cannot be modified.
Time Dimension ID
Enter a unique Time Dimension ID to be assigned to this field in
the view. This value must be unique across all dimensions and
measures IDs in the view.
Time Dimension Name
Enter a unique Time Dimension Name to be assigned to this field
in the view. This value must be unique across all dimensions and
measure Names in the view.
Level Definition
As each Time Definition is selected the following Time Definitions will be added automatically as a
dimension. These dimensions can be selected and used in SAC . The level name cannot be changed
and is automatically generated using the following convention: Time Dimension ID underscore (_)
Level Type.
Time Definition
Dimensions Generated
APOS Systems Inc. | Live Data Gateway Reference
568
APOS Live Data Gateway
Time Definition
Dimensions Generated
Year
Year, Quarter
Year, Week
Year, Week, Day
Year, Month, Day
Year, Quarter, Month, Day
Year, Quarter, Month,
Week, Day
APOS Systems Inc. | Live Data Gateway Reference
569
APOS Live Data Gateway
APOS Systems Inc. | Live Data Gateway Reference
570
APOS Live Data Gateway
Geospatial Dimensions
Define virtual points when implementing spatial functionality. Joins between tables are not allowed
when defining virtual points so ensure that all fields are part of one single table. Only coordinate values
with projection of SRID 3857 and 4326 are supported.
Field / Control
Description
New Geospatial
Dimension
Press New Geospatial Dimension to begin adding virtual points as
Geospatial Dimensions. This option is visible when the Include
Geospatial checkbox is selected.
Delete Geospatial
Dimension
The Delete Geospatial Dimension option becomes visible once a
configured Geospatial Dimension has been selected. Once pressed
the selected row is deleted.
Select Geospatial
Dimension
Select one or more rows to delete Geospatial Dimensions.
View Name
Set the View Name for the virtual point.
This name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
Location Dimension ID
Set the Location Dimension ID.
This ID must be uniquely named over the entire Config XML being
used with the LDG deployment.
APOS Systems Inc. | Live Data Gateway Reference
571
APOS Live Data Gateway
Field / Control
Description
Location Dimension
Name
Set the Location Dimension Name.
Identifier for Mapping
Set the Identifier for Mapping.
This Name must be uniquely assigned over the entire Config XML
being used with the LDG deployment.
This Identifier must be uniquely named over the entire Config XML
being used with the LDG deployment.
Select Table
Select the table from the drop down. The values contained in the
drop down are based upon the selected tables in the previous step.
Column Name – Latitude
Select the latitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Column Name –
Longitude
Select the longitude column from the drop down. The values
contained in the drop down are based upon the selected fields in
the select statement.
Identifier for Mapping
Column
Select the identifier (location key) column from the drop down. The
values contained in the drop down are based upon the selected
fields in the select statement.
Database Projection
Set the Database SRID codes for the points stored. For example if
the points are stored in the geographical projection and the data
appears in the format (42.63 , 60.20) the SRID code would be 4326
SAC Projection
Set the SAC web projection SRID code for SAC. By default this value
has been set with a SRID code of 3857
Database Supports
Spatial
Select Database Supports Spatial when the database has been
configured to support transformation for pure spatial. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
Allow Re-Projection
Select Allow Re-Projection if the start and end projection codes are
different values. The database must be configured to support
transformation for pure spatial when this is selected. This setting is
disabled for all databases except Sybase which has full functionality
for Geo Mapping.
APOS Systems Inc. | Live Data Gateway Reference
572
APOS Live Data Gateway
Select Dimension and Measure
Update the Measures and aggregation before pressing Review to continue. At least one numerical
column must be assigned as a measure. Any Parameters, Time Dimensions and Geospatial Dimensions
will be displayed here
APOS Systems Inc. | Live Data Gateway Reference
573
APOS Live Data Gateway
Field / Control
Description
Select Dimension and
Measure
Assign the columns with the below settings:

Is It a Measure – Set the columns to be measures. By default
all columns are set to No. At least one column must be
configured as a measure.

Table name – Display of the table name of the field.

DB Field Name – Display of the field name.

Dimension/Measure Id – Display of the Dimension/Measure
Id to be used. Parameters will be prefixed by PARAM_ and
cannot be updated here.

Dimension/Measure Name – Update the
Dimension/Measure Name that will be displayed when
creating the Model in SAC. Duplicate names are not allowed
and will be flagged by the Web UI to be updated before
saving the View. Parameters will be prefixed by PARAM_ and
cannot be updated here.

Aggregation –Select one of the aggregation values available
in the drop down for measures:

SUM

AVG

MIN

MAX

COUNT

Date Type – Display of the column Data Type.

Time Dimensions – Displayed as TimeDimension.

Geospatial Dimensions – Display as either a virtual
point (VPOINT) has been defined or a real spatial
column (ST_Point) in the database was selected.

Char Size – Display of the character size of the column.
APOS Systems Inc. | Live Data Gateway Reference
574
APOS Live Data Gateway
Review
Review all values entered for the Stored Procedure. If any updates are needed press the Edit button
found at the bottom right of each section to make changes. Press Save to add the view to the View
Listing.
APOS Systems Inc. | Live Data Gateway Reference
575
APOS Live Data Gateway
Sharing View
Use the Sharing View page to assign database user access of the view in SAC
Field / Control
Description
Global (All Users) Access
Select whether there is Global Access to the view within SAC when
creating a Model. When creating a new view this option is not
selected and will cause the view to be hidden when creating a Model.
Once selected any database user can select the view when creating
Models in SAC. Alternatively specific database user names can be
assigned access rights.
Enter Database User
Name
Enter the Database User Name that is to have access to the view
within SAC.
New User
Press New User to add the DB User Name to the All Users Sharing
the View listing.
All Users Sharing the
View
User
The database user name with access to the view.
Select to remove the user from the listing.
APOS Systems Inc. | Live Data Gateway Reference
576
APOS Live Data Gateway
SQL Database
Using the Database Method of Live Data Gateway requires that SQL Server 2012 minimum be installed and a
database created prior to running the application. The SQL databases must be configured with mixed authentication
mode. Windows authentication is not supported.
A batch file and script have been included with the setup to create the LDG database prior to running the Live Data
Gateway application. These files can be found in the …\Program Files\APOS\Live Data Gateway\Database Scripts
folder:

LDG_DB_Create.sql – The script contains the commands necessary to create the LDG database. Prior to
running this file edit the file and check the location path of the both the database (MDF) and log (LDF) files
associated with the database.

LDG_DB_Create.bat – Execute the batch file that will call the LDG_DB_Create.sql script to create the LDG
database. Prior to executing the batch file check the location path to the LDG_DB_Create.sql file.
The following database tables can be created manually or automatically through the application. If creating the tables
manually the script LDG_Manager.sql can be found in the installed folder …\Program Files\APOS\Live Data
Gateway\Database Scripts.
A version of SQL Express is included in the setup.
Tables
LDG_OAUTH_PROVIDER_PROFILES
The LDG_OAUTH_PROVIDER_PROFILES table contains the OAuth Provider Profiles information.
Field Name
Type
Description
OAUTH_PROFILE_NAME
Text
The OAuth Profile Name
PROFILE_PROP_NAME
Text
The profile property name
PROFILE_PROP_VALUE
Text
The profile property value
UPDATE_TS
Datetime
The update date of value
LAST_MODIFIED_BY
Text
The value last modified by
LDG_Connections
The LDG_Connections table contains all connections configured using the Database Connection Management
application.
Field Name
Type
Description
LDG_Conn_ID
Text
Id of connection.
APOS Systems Inc. | Live Data Gateway Reference
577
APOS Live Data Gateway
Field Name
Type
Description
LDG_BatchDate
Text
The timestamp when the user start working on the form
LDG_TransactionDate
Text
Current timestamp
LDG_Name
Text
The name of the connection
LDG_Prefix
Text
Short name for connection, to be used as a prefix to the
user name in Connection window to identify the
connection more precise
LDG_Connection
Text
Xml file used for connection
LDG_Description
Text
Any description defined by the user
LDG_LastModifiedBy
Text
User that made the most recent change
LDG_LastModifyDate
Text
Data that user made the most recent change
LDG_SupportFreehandSQL
Bit
Flag to indicate whether the connection supports freehand
SQL views
LDG_DataSource
Text
The connection data source selected
LDG_Database
Text
The connection relational database selected
LDG_SSOType
Text
The security type selected
LDG_ApprovedUsersFreeSQL
Bit
Flag to indicate users approved to use the Web UI
LDG_InvalidByLicense
Text
Flag indicator for invalid license for connection.
LDG_Disabled
Text
Flag indicator for disabled connection.
SSO2_DirectoryTables
Text
SSO2 user table name.
OAUTH_SCOPE
Text
OAuth Scope string.
OAUTH_PROFILE_ID
Text
OAuth Profile ID
OAUTH_CLIENT_ID
Text
OAuth Client ID
OAUTH_SECRET
Text
OAuth Secret Value.
APOS Systems Inc. | Live Data Gateway Reference
578
APOS Live Data Gateway
Field Name
Type
Description
IS_OAUTH
Bit
Flag to indicate OAuth authentication type
USER_SELF_SIGNED
Bit
Flag for user self signed for OAuth
USER_SELF_ADD
Bit
Flag for user self added for OAuth
PROJECT_ID
Text
OAuth Project ID
LDG_Views
The LDG_Views table contains all configured views for the relational databases created using the View Wizard.
Field Name
Type
Description
LDG_View_ID
Text
Id of view.
LDG_Conn_ID
Text
Id of connection
LDG_BatchDate
Text
The timestamp when the user start working on the view form
LDG_TransactionDate
Text
Current timestamp
LDG_Name
Text
The name of the connection
LDG_Prefix
Text
Short name for connection, to be used as a prefix to the user
name in Connection window to identify the connection more
precise
LDG_View
Text
Xml file used for view
LDG_Description
Text
Any description defined by the user
LDG_LastModifiedBy
Text
User that made the most recent change
LDG_LastModifyDate
Text
Data that user made the most recent change
LDG_IsGlobal
Bit
Is the View global or private. All the views defined in the
freehand SQL are private and are visible only for this user. The
view can be shared by the owner, and with be visible in SAC
by the user the view is shared with. The administrator can
transform a view from private to global
APOS Systems Inc. | Live Data Gateway Reference
579
APOS Live Data Gateway
Field Name
Type
Description
LDG_IsFreehandSQL
Number
Flag view type
LDG_ViewType
Text
The type of view configured:



LDG_Owner
Text
FREEHANDSQL
RELATIONAL
SPATIAL
The view owner name, the user connected to the database in
the login page
LDG_ConfigurationFields
The LDG_ConfigurationFields table contains configuration values for the connection database.
Field Name
Type
Description
LDG_ID
Text
Configuration id.
LDG_AddTimestamp
Text
The timestamp added/edited
LDG_LastModifiedBy
Text
User last modified
LDG_ConfigrationType
Text
The type of configuration entry
LDG_ConfigurationValue
Text
The configuration value
LDG_User_Views
The LDG_User_Views table contains the users the views have been shared with
Field Name
Type
Description
LDG_View_ID
Text
Id of view.
LDG_UserName
Text
A DB user which is allowed to see the view even is not the
owner. The owner shared the view with this user
LDG_BatchDate
Text
The timestamp when the user start working on the view form
LDG_TransactionDate
Text
Current timestamp
APOS Systems Inc. | Live Data Gateway Reference
580
APOS Live Data Gateway
Field Name
Type
Description
LDG_LastModifiedBy
Text
User that made the most recent change
LDG_Audit
The LDG_Audit table contains audit information for various actions.
Field Name
Type
Description
LDG_Audit_ID
Text
Id of audit.
LDG_TransactionDate
Text
Current timestamp
LDG_CreatedBy
Text
User that created the action
LDG_Activity
Text
The action
LDG_Conn_ID
Text
The connection id
LDG_View_ID
Text
The view id
LDG_Updatevalue
Text
The updated value
LDG_Originalvalue
Text
The original value
LDG_SERVICE_ACCOUNT_GBQ
The LDG_SERVICE_ACCOUNT_GBQ table contains the Google Big Query service account information.
Field Name
Type
Description
LDG_CONN_ID
Text
The connection ID
SERVICE_ACCOUNT_KEY
Text
The service account key
SERVICE_ACCOUNT
Text
The service account
SUFFIX_DOMAIN_EMAIL
Text
The domain email suffix
PATH_KEY
Text
The path key
APOS Systems Inc. | Live Data Gateway Reference
581
APOS Live Data Gateway
Field Name
Type
Description
GBQ_PROJECT_ID
Text
The Google Big Query Project ID
PASSWORD
Text
The password
LDG_LASTMODIFYDATE
Text
The last modified date of record
LAST_MODIFIED_BY
Text
The last modified user
LDG_SSO_CONFIGURATION
The LDG_SSO_CONFIGURATION table contains the configuration settings for the SSO Services.
Field Name
Type
Description
SSO_TYPE
Text
The SSO Service Type
TABLE_NAME
Text
Table names storing the users associated with each service
type
CONFIG_XML
Text
Config XML used by the services
UPDATE_TD
Text
Timestamp when updated
LDG_SSO2_JDBC_MAPPING
The LDG_SSO2_JDBC_MAPPING table contains the mapping of the driver signature with the table storing the user
for the service connection string parameters for user, password.
Field Name
Type
Description
JDBC_SIGNATURE
Text
Driver signature (driver prefix)
TABLE_NAME
Text
Table names storing the users associates with each service
type.
UPDATE_TS
Text
Update timestamp
KP_FOLDER
Text
Folder where to save the files created by Snowflake service
USER_ACCESSKEY
Text
Connection string parameter associated with user
APOS Systems Inc. | Live Data Gateway Reference
582
APOS Live Data Gateway
Field Name
Type
Description
PASS_SECRETKEY
Text
Connection string parameter associates with password
S3_OUTPUT_LOCATION
Text
Connection string parameter associated with S3 output
location in AWS Athena data source
LDG_Users_FreeSQL_Approved
The LDG_Users_FreeSQL_Approved table contains the association between connections and users which are allowed
to create Freehand SQL statements using the Web UI.
Field Name
Type
Description
LDG_Conn_ID
Text
The connection id
LDG_UserName
Text
A DB user which is allowed to see the view even is not the
owner. The owner shared the view with this user.
LDG_BatchDate
Text
The timestamp when the used accessed the View form
LDG_TransactionDate
Text
Current timestamp
LDG_LastModifiedBy
Text
User who modified
LDG_USERS_IAM
The LDG_USERS_IAM table contains the users to be processed by the AWS service.
Field Name
Type
Description
LDG_USERS_IAM_ID
Text
Unique ID for the row
IAM_USER_NAME
Text
Username for mapping
ACCESS_TOKEN_ID
Text
AWS access key created by the service
SECRET_KEY
Text
AWS secret key created by the service
UPDATE_TS
Text
Update datetime
IS_DELETED
Text
Flag for records to be deleted by the service
APOS Systems Inc. | Live Data Gateway Reference
583
APOS Live Data Gateway
LDG_USERS_SNOWFLAKE
The LDG_USERS_SNOWFLAKE table contains the users to be processed by the AWS service.
Field Name
Type
Description
LDG_USERS_SNOWFLAKE_ID
Text
Unique id for the row
SNOWFLAKE_USER_NAME
Text
Username for mapping
PKEY_FILE
Text
File created by the service with its relative path to KP_Folder
PPHRASE
Text
String created by the service
UPDATE_TS
Text
Update datetime
IS_DELETED
Text
Flag for records to be deleted by the service
LDG_USERS_SSO
The LDG_USERS_SSO table contains the SSO users.
Field Name
Type
Description
CONNECTION_KEY
Text
ConnectionID from LDG_Connections
USER_NAME
Text
Username for mapping
DB_USER_NAME
Text
Database user for mapping
PWD
Text
Database password for the db user name encrypted
UPDATE_TS
Text
Update timestamp
LDG_USERS_ID
Text
Unique id for the row
LAST_MODIFIED_BY
Text
Last modified by user
OAUTH_REFRESH_TOKEN
Text
OAuth refresh token
OAUTH_ACCESS_TOKEN
Text
OAuth access token
OAUTH_REFRESH_TOKEN_CREATEDATE
Datetime
OAuth refresh token create date
APOS Systems Inc. | Live Data Gateway Reference
584
APOS Live Data Gateway
Field Name
Type
Description
OAUTH_REFRESH_TOKEN_EXPIREDATE
Datetime
OAuth refresh token expire date
OAUTH_ACCESS_TOKEN_CREATEDATE
Datetime
OAuth access token create date
OAUTH_ACCESS_TOKEN_EXPIREDATE
Datetime
OAuth access token expire date
LDG_VersionInfo
The LDG_VersionInfo table contains the versioning information of the database.
Field Name
Type
Description
LDG_BatchDate
Text
Datetime of update
LDG_VersionNum
Text
LDG Version number
LDG_VersionDate
Text
LDG Version date
LDG_TransactionDate
Text
Datetime of transaction
LDG_UpgradeLog
The LDG_UpgradeLog table contains the upgrade information of the database.
Field Name
Type
Description
LDG_BatchDate
Text
Datetime of batch
LDG_TransactionDate
Text
Datetime of transaction
LDG_ActionType
Text
Type of action
LDG_ObjectType
Text
Object type being updated
LDG_ActionEvent
Text
Event of the action
APOS Systems Inc. | Live Data Gateway Reference
585
APOS Live Data Gateway
APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
THIS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT ("AGREEMENT”) IS A LEGAL AGREEMENT BETWEEN APOS
SYSTEMS INC. (“APOS”) AND THE INDIVIDUAL, ORGANIZATION OR ENTITY INSTALLING (“LICENSEE”) THE SOFTWARE
(AS DEFINED BELOW) AND/OR SUBSCRIBING FOR THE RIGHT TO USE THE SOFTWARE AS SET IN THE ORDERING
AGREEMENT (AS DEFINED BELOW). [IN THE CASE WHERE LICENSEE IS AN ENTITY OR AN ORGANIZATION, THEN THE
INDIVIDUAL INSTALLING THIS SOFTWARE, REPRESENTS AND WARRANTS TO APOS THAT IT IS AN AUTHORIZED
REPRESENTATIVE COMPLETING THIS PROCESS ON BEHALF OF SUCH ENTITY OR ORGANIZATION) AND WILL BE
ACCEPTING THIS AGREEMENT ON BEHALF OF THE ENTITY FOR WHICH IT REPRESENTS (E.G., AN EMPLOYER) AND
ACKNOWLEDGE THAT SUCH ENTITY WILL BE LEGALLY BOUND BY THIS AGREEMENT.
THE FOLLOWING TERMS AND CONDITIONS APPLY TO THE APOS SOFTWARE ACCOMPANYING THIS AGREEMENT,
WHICH MAY INCLUDE COMPUTER SOFTWARE, ASSOCIATED MEDIA, PRINTED MATERIALS AND ONLINE OR
ELECTRONIC DOCUMENTATION (“SOFTWARE”).
BY PURCHASING A LICENSE TO USE THE SOFTWARE FROM APOS OR A RESELLER (AS DEFINED BELOW), LICENSEE
AGREES TO BE BOUND BY THE PROVISIONS OF THIS AGREEMENT. BY CLICKING “I AGREE” AND/OR CLICKING THE
APPLICABLE BUTTON TO COMPLETE THE INSTALLATION PROCESS OR BY EXECUTING THIS AGREEMENT OR THE
ORDERING AGREEMENT THAT RELATES TO THIS AGREEMENT, LICENSEE CONFIRMS ITS AGREEMENT OF THE TERMS
AND CONDITIONS OF THIS AGREEMENT.
IF YOU DO NOT WISH TO BECOME A PARTY TO THIS AGREEMENT AND BE BOUND BY ALL OF ITS TERMS AND
CONDITIONS, LICENSEE MUST CLICK THE APPROPRIATE BUTTON TO CANCEL THIS PROCESS, DO NOT INSTALL,
ACTIVATE OR USE THE SOFTWARE (INCLUDING ANY ACCOMPANYING WRITTEN MATERIALS).
1. DEFINITIONS AND INTERPRETATION:
(a) Definitions. Capitalized terms used in this Agreement, and not otherwise defined elsewhere in this
Agreement, shall have the following meanings:
(i) “Effective Date” means the date the Ordering Agreement is entered into by APOS and the
Licensee.
(ii) “IT Service Provider” means a third party delivering information technology services to Licensee
pursuant to a written contract with Licensee.
(iii) “License Key” means the unique code or serial number that enables activation and use of an
instance of the Software.
(iv) “License Option” means the specific rights, restrictions, and obligations under which Licensee
may install and use the Software pursuant to this Agreement, which is selected and/or indicated in
the Ordering Agreement, which may include, but not be limited to, the number of users, the
number and/or types of instances or deployments of the Software that Licensee may install,
permitted locations for installing the Software, limitations on use of the Software by end users (if
any) and limitations on the number of reports which may be generated from the use of the
Software.
(v) “Maintenance Services” means maintenance services provided by APOS whereby Licensee will be
entitled to receive: (i) any modification, improvement, enhancement, update, upgrade, new release
and/or other change made to the Software as made available by APOS from time to time; and (ii)
standard technical support, all in accordance with APOS’ then current documentation and policies.
(vi) “Ordering Agreement” means any quotation, proposal, transactional document, ordering
agreement or invoice entered into by Licensee with APOS or a Reseller or an invoice issued by
APOS or a Reseller that sets forth the APOS proprietary software solution or add-on modules to
APOS software product procured by Licensee and the applicable License Option(s) for use of such
software.
(vii) “Reseller” means an authorized reseller or distributor of the Software.
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
586
APOS Live Data Gateway
(b) Conflict. To the extent of any conflict or inconsistency between the provisions of this Agreement and an
Ordering Agreement, the terms of the Ordering Agreement shall supersede and control over any conflict
terms of this Agreement to the extent necessary to resolve such conflict or inconsistency. The terms of this
Agreement shall supersede and control over any conflicting or additional terms and conditions of any
acknowledgement or confirmation or other document issued by Licensee. Notwithstanding the foregoing, if
Licensee enters into an Ordering Agreement (including a quotation, proposal or master services agreement,
or any similar form of contract) directly with a Reseller, the terms and conditions thereof will be directly
between Licensee and the applicable Reseller; provided however, notwithstanding anything in this
Agreement, no Ordering Agreement issued by a Reseller may modify or supersede the terms applicable to
the Software in this Agreement. Except as expressly agreed in writing by APOS and Licensee, no purchase
order or other document submitted by Customer or any Reseller, whether in connection with an order,
Ordering Agreement, a request for services or otherwise, shall be effective to vary the terms of this
Agreement.
2. INSTALLATION AND USE
Licensee may install and use the Software either under a Trial License (as defined below) or a Commercial License (as
defined below) and all such installation and use shall comply with the specific rights and restrictions applicable to
such license set forth in this Agreement. Licensee may also install non-production copies of the Software as is
reasonably necessary for testing, disaster recovery, emergency restart and backup, including, but not limited to,
making copies for such purposes for use at one or more disaster recovery sites.
Under the licenses granted to Licensee under this Agreement, Licensee may permit its IT Service Providers to access,
use and/or operate the Software on Licensee’s behalf for the sole purpose of delivering services to Licensee, provided
that Licensee will be fully responsible for its IT Service Providers’ compliance with terms and conditions of this
Agreement and any breach of this Agreement by an IT Service Provider shall be deemed to be a breach by Licensee.
3. TRIAL LICENSE TERMS
If Licensee is licensing a trial version of the Software, APOS grants Licensee a limited, revocable, personal, nontransferable, non-exclusive license to install and use the Software for time-limited evaluation purposes, only in
accordance with the terms and conditions set forth herein (a “Trial License”). Licensee may only use the Software to
test the functionality of the Software and, for greater certainty, Licensee may not use the Software for any commercial
or production use. Trial Licenses shall be further limited to the specific installation and use rights and restrictions that
APOS makes available to Licensee and shall last for the length of time specified by APOS, in its sole discretion. The
duration of Trial Licenses may be extended or cancelled at any time by APOS in its sole discretion. Upon lapse of the
Trial License, all of or part of the functionality of the Software will be disabled automatically. If Licensee wishes to use
the Software after the trial period, Licensee must purchase a Commercial License to use the Software. Licensee
acknowledges that trial versions of the Software contain time lock and/or time expiry functionality and code. APOS
SHALL HAVE NO WARRANTY OR OTHER OBLIGATIONS TO LICENSEE FOR TRIAL LICENSES. The foregoing sentence
shall survive the termination or expiration of this Agreement. If Licensee is using the software under a Trial License,
then the following Sections 4 and 9 of this Agreement shall not apply to Licensee. With respect to Trial Licenses, this
Section 3 shall prevail over any conflicting provisions in this Agreement.
4. COMMERCIAL LICENSE
If APOS or an APOS Reseller has provided Licensee with a purchase invoice (“Invoice”) setting forth, among other
things, the Software ordered, the License Option (as defined below), the Subscription Term (if applicable) and all
contact information for Licensee (including, but not limited to, contact name, address, email address or telephone
number), then Licensee is licensing the Software under a commercial license (a “Commercial License”). Unless Licensee
notifies APOS within 10 days of the date of the Invoice of any inaccuracies in the Invoice, Licensee shall be deemed to
have confirmed the accuracy of the information and to have accepted the terms and conditions set out therein. By
accepting the terms and conditions of this Agreement, Licensee also accepts the applicable License Option.
In consideration of payment of the applicable fees for Licensee’s Commercial License and Licensee’s agreement to
abide by the terms and conditions of this Agreement, APOS hereby grants to Licensee during the Subscription Term
(as defined below), a non-exclusive, non-sublicenseable, non-transferable, limited, revocable and license to install and
use the Software solely: (i) in accordance with the License Option acquired; (ii) on computer systems owned or leased
by Licensee; (iii) for Licensee’s internal use; and (iv) in accordance with the terms and conditions for this Agreement.
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
587
APOS Live Data Gateway
5. LICENSE KEYS
Installation and use of the Software and the continued use thereof require License Keys issued by APOS. Licensee will
provide APOS or, if applicable, the Reseller, with any information required by APOS to generate and issue Licensee’s
License Keys and Licensee represents, warrants and covenants to APOS that any such information provided to APOS
will be accurate and complete.
6. THIRD PARTY SOFTWARE
Licensee may be required to use or access certain third party software products in connection with Licensee’s
installation and/or use of the Software (“Third Party Software”). The Third Party Software which is required for the use
of the Software is set out in the documentation accompanying the Software or made available to the Licensee by
APOS, as may be amended from time to time. All Third Party Software used by Licensee is subject to end user license
agreements and/or other license terms and conditions specific to each Third Party Software supplier, as such
agreements or terms may be amended from time to time (the “Third Party License Terms”). By using any Third Party
Software, Licensee agrees to be bound by the applicable Third Party License Terms, as such terms may be amended
from time to time. Licensee acknowledges and agrees that APOS disclaims all liability related to, and APOS shall not
otherwise be liable in respect of, all Third Party Software.
7. RESTRICTIONS
Licensee acknowledges that the Software and the structure, organization and source code of the Software constitute
valuable trade secrets of APOS. Accordingly, except as expressly permitted by this Agreement, or by applicable law,
Licensee shall not, and shall not permit any party (including, but not limited to, any of Licensee’s employees or its IT
Service Providers) to: (a) sell, lease, loan, resell, rent, transfer, assign, sublicense, or otherwise distribute the Software
or any of the rights granted by this Agreement without the express written permission of APOS; (b) use the Software
to provide or operate Application Service Provider (ASP), service bureau, marketing, third party training, outsourcing
services, or consulting services, or any other commercial service related to the Software; (c) modify (even for purposes
of error correction), adapt, or translate the Software or create derivative works therefrom, except as necessary to
configure the Software using the menus, options and tools provided for such purposes and contained in the Software;
(d) in any way reverse engineer, disassemble or decompile the Software or any portion thereof except to the extent
and for the express purposes authorized by applicable law notwithstanding this limitation; (e) use the Software to
develop a product which is competitive with the Software or any APOS product offerings; (f) use unauthorized
keycode(s) or distribute keycode(s); (g) disclose any Software benchmark results to any third party without APOS’
prior written approval, (h) permit third party access to, or use of the Software except as expressly permitted herein, (i)
distribute or publish keycode(s), (j) alter, remove, or obscure any copyright, trade secret, patent, trademark, logo,
proprietary and/or other legal notices on or in copies of the Software; (k) use APOS’ name, trade names, logos, or
other trademarks of APOS, or any of its affiliates or licensors, whether in written, electronic, or other form, without
APOS’ prior written consent; (l) access or use software that Licensee is not currently licensed to access or to use;
and/or (m) commit any act which would directly or indirectly violate any Canadian or U.S. law, regulation, treaty, or
other agreement, relating to the export or re-export the Software, to which Canada or the U.S. adheres or with which
Canada or the U.S. complies.
8. MAINTENANCE AND SUPPORT
The purchase of a Commercial License for the Software includes the purchase of Maintenance Services (as defined
above) during the Subscription Term as set out in the Ordering Agreement. The purchase of a Commercial License for
the Software does not include the provision of any professional services from APOS. Additional support or
professional services may be obtained and provided by APOS pursuant to the terms of a separate agreement to be
entered into between Licensee and APOS.
9. AUDIT RIGHT
Licensee will keep accurate records relating to Licensee’s use of the Software in accordance with generally accepted
accounting principles and standard business practices in the Licensee’s industry. Such records shall include, without
limitation, records of usage of the Software including records in respect of any usage which is restricted by any
Ordering Agreement (such as number of reports permitted to be generated using the Software). If Licensee exceeds
the license or usage limitations set forth herein or in any Ordering Agreement, Licensee must purchase additional
usage rights/subscriptions at APOS’ then current prices. APOS has the right to, at any time, request information from
the Licensee that confirms whether or not the license or usage limitations set forth herein or in any Ordering
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
588
APOS Live Data Gateway
Agreement have been exceeded. Licensee agrees that within 15 days of written request from APOS, it will fully
document and certify whether or not the license or usage limitations have been exceeded.
In addition, APOS or its agents may inspect Licensee’s records on 5 business days written notice to Licensee. Such
inspections are solely for the purpose of verifying Licensee’s compliance with the provisions of this Agreement. In the
event any such inspection reveals an underpayment by Licensee, (a) Licensee will promptly remit the amount of the
underpayment for the period covered by the inspection, and (b) if such underpayment exceeds ten percent (10%) of
the payment due for the period covered by the inspection, Licensee will reimburse APOS for its reasonable expenses
incurred in connection with the inspection. For certainty, where such inspections reveal excess usage which requires
additional licenses/subscriptions of the Software, such excess usage shall constitute an underpayment hereunder.
APOS’ rights will remain in effect through the period ending one (1) year from the termination or expiration of this
Agreement.
10. CONFIDENTIALITY
(a) As used herein, “Confidential Information” means any business, marketing, technical, or other information
disclosed by a party hereto (a “Disclosing Party”) to the other party hereto (hereinafter a “Receiving Party”)
which, at the time of disclosure, is designated as confidential (or like designation) or is disclosed in the
circumstances of confidence. The terms and conditions of this Agreement shall be considered Confidential
Information. Confidential Information shall not include information which (a) was lawfully known or received
by the Receiving Party prior to disclosure, as evidenced by its business records; (b) was lawfully in the public
domain prior to its disclosure, or becomes publicly available other than through breach of this Agreement;
(c) was disclosed to the Receiving Party by a third party, provided that such third party, or any other Party
from whom such third party receives such information, is not in breach of any confidentiality obligation in
respect of such information; (d) is independently developed by the Receiving Party as evidenced by its
business records.
(b) All Confidential Information shall be retained by the Receiving Party in confidence and shall be used,
disclosed and copied solely for the purposes of, and in accordance with, this Agreement. The Receiving Party
shall use the same degree of care in protecting the Confidential Information received from the Disclosing
Party, as it uses to protect its own Confidential Information of a similar nature, but in no circumstances, less
than reasonable degree of care, to prevent the unauthorized use, disclosure, or publication of the Disclosing
Party’s Confidential Information.
(c) The Receiving Party shall only disclose Confidential Information of the Disclosing Party to its employees
or contractors who have a need to know such information for the purpose of allowing the Receiving Party to
exercise and perform its rights and obligations under this Agreement. Prior to the disclosure of any
Confidential Information to an employee or contractor of the Receiving Party, such employee or contractor
must have entered into a written agreement with the Receiving Party which protects the confidentiality of
the Disclosing Party’s Confidential Information to at least the same degree as it is protected under this
Agreement.
(d) The Receiving Party may disclose Confidential Information of the Disclosing Party (i) to the extent
required by applicable law, (ii) approved for release in writing by the Disclosing Party according to the terms
stipulated in such approval, or (iii) as may be required during the course of, or in connection, with any
litigation, arbitration or other proceeding, based upon or in connection with the subject matter of this
Agreement, provided that, in both (i) and (iii), the Receiving Party shall give the Disclosing Party reasonable
notice prior to such disclosure and shall comply with any applicable protective order granted in respect of
the Confidential Information.
(e) Upon the termination of this Agreement, or at any time upon the Disclosing Party’s request, Receiving
Party shall deliver to Disclosing Party all Confidential Information and destroy all files, documents, computer
programs and other media (and all copies and reproductions of any of the foregoing) in its possession or
control to the extent same contain Confidential Information.
11. LIMITED WARRANTY AND REMEDY
(a) Limited Warranty. APOS warrants that the Software will, if properly installed, perform substantially in
accordance with its accompanying documentation for a period of ninety (90) days from the date of the
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
589
APOS Live Data Gateway
Invoice. APOS does not, however, warrant that the Software will be free of all defects, errors, or inaccuracies.
The above warranties specifically exclude defects resulting from accident, abuse, unauthorized repair,
modifications, or enhancements, or misapplication. APOS does not warrant that the Software will meet
Licensee’s requirements. Delivery of additional copies of, or revisions or upgrades to, the Software, including
releases provided under Maintenance Services, shall not restart or otherwise affect the warranty period.
(b) Remedy. Licensee’s exclusive remedy for breach of the above-stated limited warranty shall be, at APOS’
option, either: (i) correction or replacement of the Software with product(s) which conform to the abovestated limited warranty; or (ii) return of the price paid for the Software and termination of this Agreement
with respect to those copies not in compliance. Such remedy shall be provided to Licensee by APOS only if
Licensee gives APOS written notice of any breach of the above-stated limited warranty within ninety (90)
days from the date of the Invoice. Except as set out in this Agreement, the remedy set forth in this Section
11(b) is Licensee’s sole exclusive remedy for a breach of warranty, and is APOS’ (or any of its affiliated
corporations and their respective directors, officers, employees or shareholders) entire liability and only
warranty made with respect to the Software. Any replacement Software will be warranted for the remainder
of the original warranty period or thirty (30) days, whichever is longer.
12. INDEMNIFICATION
(a) APOS shall defend, indemnify and hold Licensee harmless against any loss, damage or costs (including
reasonable attorneys' fees) incurred in connection with claims, demands, suits, or proceedings ("Claims")
made or brought against Licensee by a third party alleging that the Licensee’s use of the Software in
accordance with this Agreement infringes the intellectual property rights of such third party, provided that
Licensee: (a) promptly give written notice of the Claim to APOS; (b) gives APOS sole control of the defense
and settlement of the Claim (provided that APOS may not settle any Claim unless it unconditionally releases
Licensee of all liability); and (c) provides to APOS, at APOS’ cost, all reasonable assistance in the defense of
the Claim.
(b) APOS will, at its sole option and expense: (a) procure for Licensee the right to continue using the
Software under the terms of the Agreement; (b) replace or modify the Software to be non-infringing without
material decrease in functionality; or (c) if the foregoing options are not reasonably practicable, terminate
the license and/or this Agreement for the infringing Software and refund all pre-paid fees paid by Licensee.
(c) APOS shall have no liability for any Claim to the extent that: (a) the Claim is based upon the use of the
Software in combination with any other product, service or device not recommended or approved by APOS,
if such Claim would have been avoided by the use of the Software without such product, service or device;
(b) Software has been modified by a party other than APOS, its agents or Licensee acting at the direction of
APOS, if a Claim would not have occurred but for such modifications; or (c) Licensee fails to use an updated
or modified version of the Software provided by APOS at no cost to Licensee to avoid a Claim after notice
by APOS to Licensee of the availability of such updated or modified version of the Software and the fact that
use of same will cure such Claim.
13. DISCLAIMER OF OTHER WARRANTIES
EXCEPT AS OTHERWISE SET OUT IN THE AGREEMENT, LICENSEE EXPRESSLY UNDERSTANDS AND AGREES THAT THE
INSTALLATION AND USE OF THE SOFTWARE IS AT LICENSEE’S SOLE RISK AND THAT, EXCEPT AS EXPRESSLY SET OUT
IN THIS AGREEMENT, THE SOFTWARE IS PROVIDED ENTIRELY ON AN “AS-IS”, “AS-AVAILABLE” BASIS. TO THE
MAXIMUM EXTENT PERMITTED BY LAW, APOS AND ITS AFFILIATES, OFFICERS, DIRECTORS, EMPLOYEES, AGENTS,
PARTNERS AND LICENSORS EXPRESSLY DISCLAIM ANY AND ALL REPRESENTATIONS, WARRANTIES, CONDITIONS
AND GUARANTEES OF EVERY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED
REPRESENTATIONS, WARRANTIES, CONDITIONS AND GUARANTEES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, TITLE, NON-INFRINGEMENT AND HIDDEN DEFECTS.
14. LIMITATION OF LIABILITY
TO THE MAXIMUM EXTENT PERMITTED BY LAW, APOS AND ITS AFFILIATES, OFFICERS, DIRECTORS, EMPLOYEES,
AGENTS, PARTNERS AND LICENSORS SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, EXEMPLARY, SPECIAL
OR CONSEQUENTIAL DAMAGES, INCLUDING BUT NOT LIMITED TO DAMAGES FOR LOSS OF USE, PROFITS,
GOODWILL, OR DATA, OR THE COST OF PROCURING SUBSTITUTE GOODS OR SERVICES, OR OTHER INTANGIBLE
LOSSES (EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES) RESULTING FROM: (I) THE USE OR INABILITY TO
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
590
APOS Live Data Gateway
USE THE SOFTWARE; (II) THE DELETION OF, CORRUPTION OF, INADVERTENT DISCLOSURE OF, OR FAILURE TO STORE
AND/OR RECEIVE OR SEND CONTENT OR TRANSMISSIONS USING THE SOFTWARE NOT CAUSED BY THE SOFTWARE
OR A FAILURE OF, OR ERROR IN THE SOFTWARE; (III) THE CONDUCT, STATEMENTS, CONTENT, ACTS OR OMISSIONS
BY LICENSEE OR ANY THIRD PARTY USING THE SOFTWARE OR PROVIDING ANY PRODUCT, SERVICE, FEATURE OR
SUPPORT FOR THE SOFTWARE; (IV) UNAUTHORIZED ACCESS TO OR ALTERATION OF CONTENT OR TRANSMISSIONS
BY LICENSEE OR ANY OTHER THIRD PARTY NOT CAUSED BY THE SOFTWARE OR A FAILURE OF, OR ERROR IN THE
SOFTWARE; (V) APOS’ ACTIONS, ERRORS OR OMISSIONS IN RELIANCE UPON ANY INFORMATION PROVIDED BY OR
FOR LICENSEE OR THROUGH LICENSEE’S ACCOUNT, ANY CHANGES MADE THERETO, OR ANY NOTICES RECEIVED
THEREFROM; (VI) LICENSEE’S FAILURE TO PROTECT THE CONFIDENTIALITY OF ANY PASSWORDS, CONTENT, OR
ACCESS RIGHTS TO ITS ACCOUNT INFORMATION OR CONTENT CONTAINED THEREIN; OR (VII) THE USE OF ANY
SOFTWARE OR FEATURE NOT DEVELOPED BY APOS (INCLUDING, BUT NOT LIMITED TO, ANY THIRD PARTY
SOFTWARE).
EXCEPT AS EXPRESSLY SET OUT IN THIS AGREEMENT, APOS’ AGGREGATE LIABILITY TO LICENSEE FOR ANY CAUSE
WHATSOEVER, AND REGARDLESS OF THE FORM OF THE ACTION, SHALL BE LIMITED TO AN AMOUNT EQUAL TO
THE LICENSE FEES PAID FOR THE SOFTWARE.
EXCEPT IN RESPECT OF LIABILITY RELATED TO (A) LICENSEE’S CONFIDENTIALITY OBLIGATIONS TO APOS; (B) BREACH
BY LICENSEE OF ANY LIMITATIONS OR RESTRICTIONS ON THE INSTALLATION OR USE OF THE SOFTWARE SET
FORTH IN THIS AGREEMENT; AND/OR (C) LICENSEE’S GROSS NEGLIGENCE OR WILLFUL MISCONDUCT, LICENSEE’S
AGGREGATE LIABILITY TO APOS FOR ACTUAL DIRECT DAMAGES FOR ANY CAUSE WHATSOEVER SHALL BE LIMITED
TO AN AMOUNT EQUAL TO THE FEES PAID BY LICENSEE TO APOS FOR THE SOFTWARE.
IN RESPECT OF LIABILITY RELATED TO (A) LICENSEE’S CONFIDENTIALITY OBLIGATIONS TO APOS; (B) BREACH BY
LICENSEE OF ANY LIMITATIONS OR RESTRICTIONS ON THE INSTALLATION OR USE OF THE SOFTWARE SET FORTH IN
THIS AGREEMENT; AND/OR (C) LICENSEE’S GROSS NEGLIGENCE OR WILLFUL MISCONDUCT, LICENSEE’S AGGREGATE
LIABILITY TO APOS FOR ACTUAL DIRECT DAMAGES FOR ANY CAUSE WHATSOEVER SHALL BE LIMITED TO AN
AMOUNT EQUAL TO THREE (3) TIMES THE FEES PAID BY LICENSEE TO APOS FOR THE SOFTWARE.
IN NO EVENT WILL LICENSEE BE LIABLE TO APOS FOR ANY INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL OR
PUNITIVE DAMAGES, INCLUDING WITHOUT LIMITATION, ANY LOST PROFITS OR REVENUES, REGARDLESS OF THE
THEORY OF LIABILITY (INCLUDING NEGLIGENCE) AND EVEN IF LICENSEE HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
15. TRANSFER OR ASSIGNMENT OF LICENSE
Licensee may not transfer, assign, or encumber any of its rights and obligations under this Agreement or in the
Software without obtaining APOS’ prior written consent and meeting the following conditions: (i) Licensee shall
provide, in writing, the name and address of the transferee; and (ii) the transferee must agree in writing to be bound
by this Agreement. Upon transfer, Licensee may not retain any copies of the Software.
16. TERMINATION
Notwithstanding any term of this Agreement, APOS may immediately terminate this Agreement and any licenses and
services provided hereunder if: (i) APOS notifies Licensee in writing of a breach and such breach is not cured within
thirty (30) days; or (ii) Licensee makes an assignment for the benefit of creditors or proceedings are commenced by or
for Licensee under any bankruptcy, insolvency, or debtor's relief law. Termination shall not relieve Licensee from
Licensee’s obligation to pay fees that remain unpaid and shall not limit either party from pursuing other available
remedies. This Agreement shall automatically terminate in the event that the Trial License expires and Licensee does
not purchase a Commercial License.
Notwithstanding any term of this Agreement, Licensee may terminate this Agreement if Licensee notifies APOS in
writing of a material breach of this Agreement by APOS and such breach is not cured within thirty (30) days.
Upon termination of this Agreement or any part thereof, for any reason, APOS shall have no obligation to refund to
Licensee any fees paid by Licensee (including, but not limited to, fees for Maintenance Services), and Licensee agrees
to waive, in perpetuity and unconditionally, any and all claims for refunds.
Upon termination of this Agreement: (i) all licenses granted herein shall immediately cease and Licensee shall
immediately discontinue the use of the Software, (ii) Licensee shall return all copies and related documentation or, if
directed by APOS, destroy the Software and related documentation, and (iii) neither party will be released from any
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
591
APOS Live Data Gateway
liability which, at the time of termination, has already accrued to the other party or which is attributable, prior to such
termination, nor will either party be prohibited from pursuing any rights and remedies it may have hereunder at law
or in equity with respect to any breach of this Agreement prior to termination. If a Software license is revoked or
expired, Licensee must certify in writing to APOS that Licensee has immediately un-installed and destroyed all copies
of the Software within thirty (30) days of such revocation/expiration.
In addition as may be set forth in this Agreement, the following Sections survive termination of this Agreement:
Sections 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20.
17. OWNERSHIP AND RESERVATION OF RIGHTS
The Software is protected by copyright laws and international copyright treaties, as well as other intellectual property
laws and treaties. The Software is licensed, not sold. APOS does not sell any rights in or to the Software, but rather
grants the right to use the Software pursuant to the terms of this Agreement. The Software (including but not limited
to any images, photographs, animations, video, audio, music, text, and "applets," incorporated into the Software) shall
at all times remain the property of APOS and/or APOS’ licensors, as applicable, and Licensee shall have no right, title,
or interest therein, except as expressly set forth in this Agreement. Any and all modifications, enhancements,
improvements, changes and derivative works to APOS Software created by APOS or Licensee shall be the sole
intellectual property of APOS. APOS exclusively reserves all rights not explicitly granted herein.
18. EXPORT
Licensee acknowledges that the Software may include encryption software that may be controlled for import, export
or purposes under the laws and regulations of the country(ies) and/or territory(ies) in which the Software is used
("Applicable Law"). In particular, Licensee acknowledges that the Software is of Canadian origin, is subject to Canadian
laws and regulations, and may be subject to restrictions on export or re-export to countries subject to Canadian
embargoes or to persons or entities prohibited from receiving Canadian exports (including, but not limited to, those
involved with missile technology or nuclear, chemical or biological weapons). Licensee hereby represents that (1) to
the best of Licensee’s knowledge, Licensee is eligible to receive the Software under Applicable Law; (2) Licensee will
import, export, or re-export the Software to, or use the Software in, any country or territory only in accordance with
Applicable Law; and (3) Licensee will ensure that other persons use the Software in accordance with the foregoing
restrictions.
19. U.S. GOVERNMENT RESTRICTED RIGHTS
This Software is a commercial product that has been developed exclusively at private expense or with public funds
from sources other than the United States Government. If the Software is acquired directly or indirectly on behalf of a
unit or agency of the United States Government under the terms of (i) a United States Department of Defense
contract, then pursuant to DOD FAR Supplement 227.7202-3(a), the United States Government shall only have the
rights set forth in this Agreement; or (ii) a civilian agency contract, then use, reproduction, or disclosure is subject to
the restrictions set forth in FAR clause 27.405(b)(2)(i), entitled Acquisition of Existing Computer Software, and any
restrictions in the agency's FAR supplement and any successor regulations thereto, and the restrictions set forth in
this Agreement. If this Agreement and the licenses herein fail to meet the United States Government’s needs or are
inconsistent in any respect with U.S. federal procurement law, the government agrees to return the Software, unused,
to APOS.
20. GENERAL
(a) Term: The Term of this Agreement shall commence on the Effective Date and shall continue in effect for a
period of one year or as otherwise defined in the Ordering Agreement (the “Initial Term”). Following the
Initial Term, this Agreement shall automatically renew under the same terms for subsequent terms of 12
months each (each a “Renewal Term” and collectively with the Initial Term, the “Term”) unless one of the
Parties notifies the other party with at least thirty (30) days prior to the commencement of any Renewal Term
of its intention to amend terms set out in this Agreement or to not to renew the Agreement
(b) Assignment and Transfer. APOS may freely assign this Agreement. Licensee may not assign or otherwise
transfer this Agreement, and its rights and obligations, in whole or in part, by operation of law or otherwise.
This Agreement endures to the benefit of and shall be binding upon each parties’ respective successors or
permitted assigns.
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
592
APOS Live Data Gateway
(c) Revised Terms and Conditions. APOS may revise the terms and conditions of this Agreement from time to
time in its sole discretion. Revisions shall be effective at the end of the Subscription Term during which such
revisions are made and such revisions shall govern any subsequent Renewal Term.
(d) Governing Law. This Agreement is governed by the laws of the Province of Ontario, Canada and the
federal laws of Canada applicable in that Province, without regard to conflicts of laws principles. Each of the
parties hereto irrevocably attorns to the exclusive jurisdiction of the courts of the Province of Ontario and
Licensee agrees that any claim or action brought by Licensee shall be commenced in the courts of located in
Kitchener, Ontario, Canada. The parties agree that the United Nations Convention on Contracts for the
International Sale of Goods (also called the Vienna Convention, and which is cited in the statutes of Canada
as the International Sale of Goods Contracts Convention Act) will not apply to this Agreement.
(e) Miscellaneous. If any provision of this Agreement, or portion thereof, is determined by a court of
competent jurisdiction to be invalid, illegal or unenforceable, such provision or portion thereof shall be
severed from this Agreement without affecting the validity, legality or enforceability of the remaining
provisions. A waiver of any provision of this Agreement shall only be valid if provided in writing and shall
only be applicable to the specific incident and occurrence so waived. The failure by either party to insist
upon the strict performance of this Agreement, or to exercise any term hereof, shall not act as a waiver of
any right, promise or term, which shall continue in full force and effect. Unless otherwise agreed to by APOS
in writing, this Agreement, together with the Invoice and all terms incorporated herein by reference,
constitutes the entire agreement between the parties pertaining to the subject matter hereof and supersedes
all agreements, understandings, negotiations and discussions, whether oral or written, of the parties and
there are no warranties, representations or other agreements between the parties in connection with the
subject matter hereof except as specifically set forth herein.
Should Licensee have any questions concerning this Agreement, or if Licensee desires to contact APOS for any reason,
please contact:
Head Office: 100 Conestoga College Blvd Suite 1118, Kitchener, Ontario Canada N2P 2N6
Tel: 519.894.2767 Fax: 519.894.1891
Email: apos@apos.com
Technical Support: Email: support@apos.com Tel: 519.894.2767 Ext. 1
APOS Systems Inc. | APOS SOFTWARE LICENSE/SUBSCRIPTION AGREEMENT
593
APOS Live Data Gateway
Technical Support
ON-LINE APOS BI TOOLS SOLUTIONS KNOWLEDGEBASE
Before contacting APOS Technical Support, search our solutions knowledgebase on our On-Line Technical Support
self-service portal at http://www.apos.com/selfservice for answers to common questions.
LOG A SUPPORT CALL ON-LINE
To create a support call or monitor outstanding support calls, connect to our On-Line Technical Support self-service
portal at http://www.apos.com/selfservice.
EMAIL TECHNICAL SUPPORT
If you've been unable to find a solution to your problem in our Knowledgebase and prefer not to log a call on-line,
please email the details of your problem to support@apos.com.
TELEPHONE TECHNICAL SUPPORT
Telephone help desk support is available Monday - Friday, 8:30 AM to 5:00 PM EST. Visit here for a list of our current
regional help desk telephone numbers.
APOS BI TOOLS SOLVE CUSTOMER NEEDS!
Click here for a full listing of all our current APOS BI tools; click here to request a free demo download for any of our
solutions.
APOS PROFESSIONAL SERVICES - CAN WE HELP?
Visit here for an overview of APOS professional services.
SUBSCRIBE TO THE APOS BI TOOLS NEWSLETTER
Stay current with information about new APOS BI tools, product enhancements, free downloads, user groups, case
studies, free webinars/briefings and more. Click here to subscribe.
USEFUL LINKS
1.
2.
3.
4.
5.
Business Objects' Support Knowledgebase - technical questions on the Business Objects platform.
http://support.businessobjects.com/search
Business Objects' Tech Support - the entry point of a variety of support service and information.
http://support.businessobjects.com
Business Objects' Diamond Community - sample applications, forums, developer-oriented.
http://diamond.businessobjects.com
User Groups - find a Business Objects User Group near you
http://www.busobjects.com/usergroup/overview.php
TekTips - on-line forum to share with other Business Objects Enterprise users http://www.tektips.com/threadminder.cfm?pid
APOS Systems Inc. | Technical Support
594
Index
Index
#
#server.http2.enabled=true ................................... 77
%
% 412, 434, 444, 454, 468, 489, 545
%EXTERNAL_OAUTH_AUDIENCE_LIST% .............. 375
%TENANT-ID% ....................................................... 334
?
?useKerberos=true................................ 389, 536, 562
+
+ 216, 226, 235, 258, 266, 274
<
</Service>.......................................................... 29, 38
0
0 Management Console ........................................ 104
2
2.8 ...................................................................... 9, 281
3
3857 ...4, 345, 390, 418, 421, 474, 477, 496, 499, 579,
587, 588, 592, 599, 600, 607, 618, 619, 627, 637,
638, 647, 658, 659, 665, 676, 677
4
4326 ...4, 345, 390, 418, 421, 474, 477, 496, 499, 579,
587, 588, 592, 599, 600, 607, 618, 619, 627, 637,
638, 647, 658, 659, 665, 676, 677
5
500 ................................. 224, 233, 241, 264, 272, 279
6
64 bit ...... 12, 13, 14, 15, 16, 17, 18, 19, 161, 191, 249,
406, 408, 462, 464, 539, 541
64 bit ODBC ..................... 15, 16, 17, 18, 19, 191, 249
6405 ............................................................... 358, 519
64bit............................................... 558, 562, 563, 571
9
9000 ............................................................... 357, 518
A
About ............................................... 11, 335, 353, 514
About APOS ............................................................. 11
Access ..... 18, 213, 560, 561, 581, 592, 593, 610, 627,
629, 650, 665, 667
Access Policy ......................................................... 308
Acquire Data.......................................................... 309
Acquire Mode for SAC ................................... 300, 305
Action .................... 213, 578, 591, 606, 626, 646, 664
Active Directory ............................................... 37, 108
Adapter Name ....................................................... 301
Add 174, 179, 180, 324, 327, 338, 344, 376, 379, 380,
382, 397, 399, 402, 419, 420, 475, 497, 530, 559
Add a Canvas Page ......... 222, 231, 239, 263, 270, 277
Add Application Pool ............................................ 163
add key .................................................................. 161
Add Layer............................................................... 295
Add Managed Module .......................................... 165
Add New Row................................ 199, 252, 427, 551
Add New View....................................................... 625
Add Relying Party Trust ........................................ 104
Add Rule ................................................................ 107
Add Semantic Layer View Name ............................ 607
Add Stored Procedure View Name ................ 647, 649
Add View ....................................................... 540, 542
Adding View .................. 578, 579, 605, 607, 646, 647
ADFS... 6, 25, 28, 37, 49, 101, 102, 103, 108, 205, 206,
254, 255, 265, 363, 364, 367, 386, 508, 523, 524,
526, 534
ADFS Metadata ..................................................... 102
Admin Tool Deployment ...................... 23, 26, 71, 208
Admin Tool UI ............................................ 26, 94, 100
Admin Tool Web Application ................................. 572
Admin Tool Web UI... 77, 79, 326, 572, 573, 574, 591,
626, 664
Administrator.... 37, 38, 365, 386, 388, 389, 534, 535,
537, 569
ADOMD.Net ..................................................... 15, 161
Advanced........................................................... 3, 109
aggregation ... 423, 479, 501, 548, 579, 589, 590, 592,
601, 602, 607, 621, 622, 627, 640, 641, 647, 661,
662, 665, 679, 680
Aggregation ...... 3, 211, 290, 423, 479, 501, 548, 590,
602, 622, 641, 662, 680
aggregations .............................................................. 5
aliases .................................................................... 467
All Users Sharing the View............ 603, 604, 644, 682
Allow Re-projection ...................... 288, 425, 479, 501
Allow Re-Projection ..... 421, 477, 499, 588, 600, 620,
639, 660, 678
Amazon EMR........1, 33, 44, 53, 73, 84, 347, 360, 509,
521, 563
Amazon EMR Hive ................................................... 15
APOS Systems Inc. | Index
595
Index
Analysis.................................. 7, 9, 281, 284, 355, 516
Analysis for Excel ........................................... 281, 284
Analysis for Office .............................................. 9, 281
Anonymous Authentication.................................. 166
Any DB user can create views............................... 326
Any output parameters ......................................... 491
AO 2.8 ........................................................................ 2
Apache ................................................................... 171
Apache Proxy ......................................................... 297
Apache Tomcat ...................................... 12, 13, 14, 39
Apache24............................................................... 296
APOS Admin Tool ............................. 14, 325, 326, 327
APOS Azure Analysis Service Gateway..................... 15
APOS BI Tools........................................................... 11
APOS LDG JDBC ...................................... 2, 21, 25, 300
APOS license file ............................................ 300, 312
APOS OData Gateway ........ 2, 9, 22, 25, 300, 305, 312
APOS SSO2 Services ................................................. 22
APOS Support .................. 15, 33, 36, 44, 47, 346, 508
APOS Systems Inc.................................................... 11
APOS Views .................................................... 302, 316
APOS.lic ......................... 161, 179, 312, 313, 315, 343
APOS_CData_Drivers.zip... 16, 33, 44, 54, 74, 85, 347,
560, 561
APOSAdminTool.16, 22, 33, 44, 54, 71, 72, 73, 74, 77,
80, 81, 82, 85, 109, 110, 208, 347, 560, 572, 574
APOSAdminTool.jar ................................................ 22
APOSAdminTool.war .... 22, 71, 72, 80, 109, 110, 572
APOSAdminTool.xml......................................... 89, 95
APOSASG ............................................... 161, 163, 164
aposldgjdbc.............................................................. 22
aposldgjdbc.sbo ....................................................... 22
aposldgjdbc.setup.................................................... 22
apospump.aposxmla............................. 166, 167, 355
APOSxmlaModule .................................................. 165
APOSxmlapump.APOSxmlaModule ....................... 165
Application pool ............................................ 163, 164
Application Pools .................................................. 163
application.properties . 58, 64, 65, 70, 77, 80, 81, 89,
95, 96, 131, 134, 135, 153, 157, 159
Applications........................................................... 297
Apply ...8, 77, 195, 325, 327, 415, 418, 471, 494, 572,
575
Apply Freehand SQL............................... 325, 327, 572
Apply Freehand SQL flag to Connections .... 325, 572,
575
Approve Users for Web UI ....................... 77, 572, 575
Approve Users For Web UI ................................... 325
Approve Users Management ......................... 325, 326
Area ....................................................................... 283
ASO .......................................................................... 17
ASP.Net ............................................................ 15, 161
Assign Default Aliases ................................... 251, 423
Assign Default Names .. 196, 252, 423, 425, 479, 501,
548, 549
Assign Default Names for Dimensions . 252, 425, 549
Assign Default Names for Measures.............. 423, 548
Assign Default Names For Measures .... 196, 423, 548
Assign Dimension Names............... 423, 424, 548, 549
Assign Dimension Names as Alias 436, 437, 446, 447,
455, 456
Assign Measure...................................................... 601
Assign Measures ............ 413, 422, 468, 489, 546, 547
Assign Measures and Dimensions ......................... 478
Assign Name and ID ...................... 479, 480, 501, 502
Assign Owner Management .................................. 400
Assign Relationships .............................. 426, 550, 551
Assign the ID and the Aliases................ 436, 446, 455
Assign Unique Names as ID . 436, 437, 446, 447, 455,
456
Assignment of Measure ................................ 590, 602
Athena . 15, 33, 44, 111, 136, 143, 371, 378, 379, 690
Attribute store ...................................................... 108
authentication ...... 175, 274, 297, 367, 369, 384, 386,
432, 442, 527, 528, 532, 534
Authentication .. 9, 113, 120, 137, 142, 165, 214, 225,
227, 236, 257, 265, 267, 298, 310, 322, 361, 363,
364, 366, 367, 369, 384, 386, 432, 522, 523, 524,
525, 527, 528, 532, 534
Authentication Method113, 137, 225, 227, 236, 265,
267, 363, 364, 366, 367, 369, 384, 386, 523, 524,
525, 527, 528, 532, 534
Authentication Type .... 310, 322, 368, 370, 371, 385,
386, 388
Authentication Type Option ................................. 371
Available Connection ............................ 183, 189, 337
Available Connections................................... 176, 319
Available to the owner and to the database users
from the list ....................................................... 402
Available View Management................................ 397
AVG .... 5, 423, 479, 501, 590, 602, 622, 641, 662, 680
AWS (IAM) ..................................... 140, 328, 371, 378
AWS Athena......................................... 14, 22, 25, 111
AWS Redshift ....................... 14, 22, 25, 111, 372, 379
AWS SSO2 Service.................................................. 378
AWS SSO2 Service Deployment ..................... 111, 136
Azure.... 9, 10, 15, 22, 23, 26, 161, 166, 167, 355, 374,
432
AZURE .................................................... 333, 334, 375
Azure Analysis Service ..... 9, 15, 22, 26, 161, 355, 432
Azure Analysis Service Gateway .................. 9, 22, 161
Azure Analysis Service Gateway Deployment ... 23, 26
Azure Analysis Services ......................................... 355
APOS Systems Inc. |
596
Index
B
Back ...... 413, 423, 426, 427, 435, 437, 445, 447, 454,
456, 468, 480, 489, 502, 545, 548, 550, 552
Back-end Type ....................................................... 305
Basic Authentication ............................................. 310
Bex Queries............................................ 189, 443, 444
BigQuery . 16, 360, 406, 408, 462, 464, 521, 539, 558,
559
BigQuery Path Key ................................................ 559
BigQuery Project ID............................................... 559
Browse................... 243, 246, 352, 513, 539, 542, 556
BSO ............................................................................ 7
Bubble Layer.......................................................... 295
Build Service Configuration .. 111, 125, 147, 325, 331
Build View ..................................................... 249, 569
Build Web Config........... 127, 149, 202, 337, 341, 342
Builder ........................... 224, 233, 241, 264, 272, 279
button ... 168, 175, 180, 184, 192, 200, 201, 202, 204,
224, 233, 241, 248, 249, 250, 253, 264, 272, 279,
287, 308, 325, 338, 344, 346, 351, 360, 372, 377,
411, 412, 413, 421, 423, 425, 426, 427, 428, 429,
434, 435, 436, 437, 438, 444, 445, 446, 447, 448,
454, 455, 456, 457, 468, 477, 480, 481, 489, 499,
502, 503, 508, 512, 521, 528, 531, 539, 542, 544,
545, 546, 548, 550, 552, 553, 569, 570, 575, 576,
577, 578, 625, 643, 663, 681
BW .. 1, 5, 15, 189, 335, 338, 354, 356, 377, 395, 404,
442, 515, 516, 531
C
Calculated measures.......................................... 5, 6, 7
Calculated Measures ................................................. 5
Cancel ... 322, 344, 351, 377, 379, 381, 383, 531, 545,
548, 550, 552, 559
CData ..................................................................... 316
CDATA ............ 1, 16, 33, 44, 54, 74, 85, 347, 560, 561
CData Drivers ................................................ 360, 561
CDATA Drivers 1, 16, 33, 44, 54, 74, 85, 347, 560, 561
certificate .......12, 13, 14, 59, 66, 78, 90, 97, 101, 102,
166, 369, 384, 528, 532
Change ................................................................... 344
Change Owner....................................................... 400
Char Size ........................ 590, 602, 622, 641, 662, 680
CharSize ......................................................... 425, 549
Chart ...................................................................... 263
Check All ................................................ 423, 480, 502
Check All Measures ............................................... 423
Choose Access Control Policy ............................... 106
Choose Rule Type Step.......................................... 108
Chrome ...................................................... 3, 214, 257
Claim Aware .......................................................... 104
Claim rule name .................................................... 108
Classpath ............................................................... 313
Clear Alias.............................................. 437, 447, 456
Clear Group Names ....................................... 426, 550
Clear ID .................................................. 437, 447, 456
Clear Names and IDs ..................................... 480, 502
Click OK .................................. 229, 237, 261, 269, 276
Close ..... 325, 342, 346, 400, 402, 403, 415, 471, 494,
509, 512
Cloudera 1, 16, 17, 18, 33, 34, 44, 45, 54, 74, 85, 191,
347, 360, 406, 462, 509, 521, 539, 562, 563
Cloudera Hive 1, 16, 33, 44, 54, 74, 85, 191, 347, 509
Cloudera Impala.....1, 16, 34, 45, 54, 74, 85, 191, 347,
360, 509, 521
Cloudera ODBC Driver for Impala . 15, 16, 17, 18, 562,
563
Cloudera-Impala ............................ 406, 462, 539, 562
clusters........................................................... 357, 518
CMC ....................................... 297, 298, 299, 366, 525
codebase version= ................................................ 570
Column Description .................................. 590, 602
Column Name....... 421, 477, 499, 588, 590, 600, 602,
619, 638, 659, 677
Column Name – Latitude ..... 421, 477, 499, 588, 600,
619, 638, 659, 677
Column Name – Longitude .. 421, 477, 499, 588, 600,
619, 638, 659, 677
Columns................................................. 284, 627, 665
com.amazon.redshift.jdbc.Driver .......................... 136
com.apos.ldg.Driver....................................... 312, 315
com.simba.athena.jdbc.Driver .............................. 136
Command Line Parameters .................................. 298
command window 63, 68, 93, 99, 132, 135, 155, 159
Configuration 178, 249, 324, 343, 365, 387, 388, 389,
534, 535, 536, 537, 539, 540, 542
Configuration Management .............................. 577
Configurations ....................................................... 324
Configure a Connection Inside SAC................ 213, 257
Configure claims issuance policy for this application
........................................................................... 106
Configure Java Path....................... 351, 352, 512, 513
Configure Proxy with a Dedicated Port ................. 296
Configure Service Account..................................... 558
Connect .. 26, 172, 174, 176, 225, 242, 265, 303, 310,
317, 319, 320, 363, 364, 366, 367, 523, 524, 525,
526, 558
Connect to an On-Premise OData service ............ 310
Connect using the backend database method ...... 26,
172, 174, 317, 319
Connect using the non-database method ..... 26, 172,
242, 317, 319
Connection ..... 26, 109, 111, 112, 125, 136, 147, 167,
172, 174, 178, 180, 183, 184, 185, 187, 201, 209,
APOS Systems Inc. |
597
Index
213, 214, 216, 217, 219, 225, 226, 227, 229, 234,
235, 236, 237, 257, 258, 259, 260, 261, 265, 266,
267, 269, 273, 274, 275, 276, 297, 304, 309, 310,
312, 315, 317, 319, 320, 321, 322, 323, 326, 327,
331, 337, 339, 340, 341, 345, 346, 360, 377, 389,
403, 406, 409, 415, 432, 442, 462, 465, 471, 486,
494, 507, 508, 521, 531, 536, 539, 541, 558, 559,
561, 562, 564, 566, 568, 569, 574, 575, 576, 578,
579, 580, 584, 592, 593, 597, 605, 609, 615, 629,
634, 646, 649, 655, 666, 673, 684, 685, 686, 690
Connection Description Details .................... 183, 187
Connection Management .... 178, 180, 184, 201, 217,
320, 323
Connection Name.................................. 174, 310, 321
Connection Parameters ......................................... 568
Connection Prefix.................................. 125, 147, 331
Connection String. 112, 136, 360, 389, 406, 409, 432,
442, 462, 465, 486, 521, 536, 539, 541, 558, 561,
562, 564, 566
Connection Timeout...................................... 322, 341
Connection Type .. 216, 227, 235, 259, 267, 274, 297,
569
Connections ............. 15, 181, 184, 244, 248, 354, 515
Connections Users Statistics ................................. 335
ConnectionTest_lib ... 16, 33, 44, 54, 74, 85, 346, 347,
348, 508, 509, 510, 560
context.xml ........................................................ 12, 13
Control Panel ........................................................... 24
Convert to Application .......................................... 163
COOKIE .......................................................... 366, 525
CORS 6, 12, 25, 26, 28, 37, 41, 49, 172, 174, 205, 206,
207, 213, 214, 225, 242, 247, 254, 255, 256, 257,
265, 317, 319, 363, 364, 367, 386, 508, 512, 523,
524, 526, 534, 554, 556
CORS – SSO ............ 25, 28, 37, 49, 205, 206, 254, 255
COUNT 5, 423, 479, 501, 548, 590, 602, 622, 662, 680
cpld.jar ............................. 34, 45, 54, 75, 85, 348, 510
CRConfig.xml ......................................................... 313
Create .................................................... 260, 262, 270
Create a Connection.............................................. 297
Create a Location Dimension ................................ 293
Create New Connection ........................................ 313
Create New SAC Connection................................. 281
Create New View definition.......................... 200, 253
Create New View Definition 292, 429, 438, 448, 457,
481, 503, 553
Create the View Definition ............ 427, 480, 502, 552
Create View Definition.. 429, 433, 437, 438, 443, 447,
448, 451, 456, 457, 481, 503, 553
Credentials Mode .................................................. 302
Cross-Origin Resource Sharing................................. 12
Crystal Reports..................... 21, 22, 25, 300, 312, 313
CTE ........................................................................ 391
Cube....................................................................... 444
Cubes ............................................. 189, 434, 443, 444
cwallet.sso ............................................................. 570
D
Data Source .. 112, 136, 167, 181, 184, 219, 229, 237,
244, 248, 261, 269, 276, 281, 295, 346, 355, 356,
357, 358, 359, 406, 462, 508, 516, 518, 520
Data Source Host........................................... 357, 518
Data Type ...... 291, 425, 479, 491, 501, 549, 653, 670
data work flows ..................................................... 304
database .. 7, 18, 19, 26, 33, 35, 36, 39, 44, 46, 47, 49,
53, 56, 73, 76, 77, 80, 82, 84, 87, 172, 174, 176,
180, 182, 184, 185, 187, 189, 191, 199, 200, 202,
205, 206, 208, 209, 217, 219, 225, 229, 237, 248,
249, 252, 255, 259, 265, 285, 293, 317, 319, 321,
323, 324, 325, 326, 327, 335, 337, 338, 341, 344,
346, 349, 360, 377, 389, 397, 398, 400, 402, 403,
404, 405, 406, 407, 408, 410, 421, 425, 427, 430,
432, 433, 440, 442, 443, 449, 451, 459, 461, 462,
463, 464, 466, 467, 477, 479, 483, 485, 487, 499,
501, 505, 508, 509, 511, 521, 531, 536, 538, 539,
541, 549, 551, 552, 560, 561, 564, 566, 569, 572,
575, 581, 588, 590, 591, 592, 593, 600, 602, 603,
604, 610, 620, 622, 623, 626, 627, 629, 639, 641,
644, 650, 660, 662, 664, 665, 667, 678, 680, 682,
684, 687, 692, 693
Database.... 19, 21, 22, 26, 33, 39, 44, 53, 73, 84, 112,
173, 174, 175, 184, 185, 205, 206, 208, 214, 248,
255, 317, 319, 320, 321, 337, 341, 347, 354, 359,
360, 361, 363, 364, 366, 369, 372, 376, 377, 379,
381, 383, 389, 421, 425, 429, 430, 438, 440, 448,
449, 457, 459, 477, 479, 481, 483, 499, 501, 503,
505, 507, 509, 515, 520, 521, 523, 524, 526, 528,
530, 531, 536, 571, 572, 580, 588, 600, 610, 620,
639, 650, 660, 678
Database Backend Method 4, 12, 47, 48, 56, 87, 285,
319, 545
Database Classname ............................................. 315
Database Connection Management ..... 174, 319, 321
Database Information ........................................... 286
database jar ...33, 39, 44, 49, 53, 73, 80, 84, 205, 206,
208, 255, 346, 508, 509, 572
Database jar ...................................................... 80, 81
Database Login Credentials .................................. 185
Database Method ... 12, 21, 22, 26, 71, 173, 174, 205,
206, 208, 285, 317, 320, 321, 572, 684
Database Name .... 112, 127, 149, 174, 185, 248, 321,
341, 360, 521, 564, 566
Database Projection...... 588, 600, 619, 638, 659, 677
APOS Systems Inc. |
598
Index
Database Supports Spatial... 288, 421, 425, 477, 479,
499, 501, 588, 600, 620, 639, 660, 678
Database User ...... 143, 376, 377, 379, 380, 528, 530,
531, 603, 644, 682
Database User Proxy ..................................... 389, 536
Database User/Password....................... 371, 376, 528
Database Users ..................................................... 401
Datasource . 48, 56, 87, 247, 248, 325, 337, 346, 509,
512, 554
Date Time Functions ............................................. 391
Date Time Functions for Time Definition ............. 391
Date Type ...................... 590, 602, 622, 641, 662, 680
Date/Time .... 187, 211, 345, 390, 508, 584, 596, 614,
633, 655, 673
Date/Time and DB Functions........ 187, 345, 390, 508
Date/Time Field............. 584, 596, 614, 633, 655, 673
Day.415, 416, 417, 471, 472, 473, 494, 495, 584, 585,
586, 597, 598, 615, 616, 617, 634, 635, 636, 655,
656, 657, 673, 674, 675
DB Field Name423, 425, 548, 549, 622, 641, 662, 680
DB Owner............................................................... 403
DB Password............................... 376, 377, 530, 531
DB Projection (SRID) ............................. 425, 479, 501
DB Users Sharing View .......................................... 402
DB2 .... 1, 3, 18, 34, 45, 54, 74, 85, 345, 347, 390, 412,
414, 468, 470, 509, 579, 583, 592, 596, 607, 613,
623, 627, 632, 647, 665
–Dbobj.trustedauth.home .................................... 298
Dedicated Port ....................................................... 297
Default Web .................................................. 163, 166
Default Web Site ................................................... 163
Define Table Joins .......................... 607, 623, 627, 642
Define Time Dimensions ....... 194, 412, 468, 488, 544
Define Virtual Points ...................................... 420, 476
Delete ... 249, 319, 324, 327, 338, 344, 376, 379, 380,
382, 397, 400, 402, 419, 427, 475, 497, 530, 540,
542, 551, 559
Delete Geospatial Dimension ...... 587, 599, 618, 637,
658, 676
Delete Table Join ........................................... 623, 642
Delete the View..................................... 591, 626, 664
Delete View ................................................... 540, 542
Denodo .... 1, 2, 3, 16, 34, 37, 45, 54, 74, 85, 191, 206,
207, 255, 256, 345, 348, 360, 386, 389, 390, 406,
412, 414, 462, 468, 470, 509, 521, 534, 536, 539,
562, 574, 579, 583, 592, 596, 607, 613, 623, 627,
632, 647, 665
denodo-vdp-jdbcdriver.jar...... 34, 45, 54, 74, 85, 348,
509
Deployment of the web application ........................ 25
deprecated....................................... 26, 242, 319, 507
Description ..... 58, 65, 78, 89, 96, 183, 187, 200, 210,
281, 292, 307, 319, 321, 324, 326, 327, 328, 331,
335, 337, 339, 341, 343, 346, 351, 353, 355, 356,
357, 358, 359, 361, 362, 364, 365, 366, 367, 370,
372, 374, 375, 376, 378, 380, 382, 385, 386, 388,
389, 390, 393, 397, 398, 399, 401, 403, 405, 408,
411, 414, 418, 419, 420, 422, 424, 426, 429, 430,
432, 434, 436, 438, 440, 442, 444, 446, 448, 449,
450, 453, 455, 457, 459, 461, 464, 467, 470, 474,
475, 476, 478, 481, 483, 485, 488, 491, 493, 496,
497, 498, 500, 503, 505, 508, 512, 514, 516, 518,
520, 522, 523, 524, 525, 527, 528, 530, 532, 534,
535, 536, 538, 541, 544, 547, 549, 551, 553, 555,
556, 559, 574, 576, 578, 580, 581, 582, 583, 587,
589, 591, 592, 593, 595, 596, 599, 602, 603, 605,
609, 610, 612, 614, 618, 622, 623, 626, 627, 628,
629, 631, 633, 637, 641, 642, 644, 646, 649, 650,
652, 653, 654, 658, 662, 664, 665, 666, 667, 669,
670, 673, 676, 680, 682, 684, 685, 686, 687, 688,
689, 690, 691, 692, 693
Details.................................................................... 570
Development ........................................................... 11
DG_Datasource.xml ... 48, 56, 87, 247, 248, 254, 325,
346, 351, 509, 512, 554
DG_DataSource.xml ........ 49, 242, 253, 376, 530, 558
DG_View.xml 48, 49, 56, 87, 201, 242, 248, 249, 253,
254, 255, 538, 539, 540, 542, 543, 554
dimension ......3, 5, 7, 8, 190, 198, 394, 404, 407, 409,
415, 422, 425, 433, 438, 443, 448, 451, 457, 463,
466, 467, 471, 479, 480, 481, 485, 486, 494, 501,
502, 503, 538, 540, 543, 547, 549, 550, 555, 581,
584, 594, 597, 605, 611, 612, 615, 616, 627, 630,
631, 634, 635, 651, 652, 655, 656, 665, 668, 669,
673, 674
Dimension ............................................................. 291
Dimension Alias..................... 436, 437, 446, 447, 456
Dimension Group .......... 198, 252, 425, 426, 549, 550
Dimension ID ................. 436, 437, 446, 447, 455, 456
Dimension List ............................................... 425, 549
Dimension name ........................................... 455, 456
Dimension Name........... 198, 252, 425, 479, 501, 549
Dimension/Measure Name ..... 622, 641, 662, 680
dimensions 7, 189, 338, 395, 404, 432, 433, 434, 436,
442, 443, 444, 446, 450, 451, 453, 454, 455, 478,
500
Dimensions 5, 6, 7, 224, 233, 241, 264, 272, 279, 284,
425, 434, 435, 436, 445, 446, 454, 455, 479, 500,
501, 549
Direct .1, 213, 216, 217, 227, 235, 236, 257, 259, 260,
267, 274, 275
DIRECTORY............................................................. 570
Disable Connection ............................................... 339
APOS Systems Inc. |
599
Index
Disable Parameterized Queries .................... 393, 555
Disable SSO for Admin Web UI ..................... 368, 527
Disabled................................................................. 166
Display name ......................................................... 105
dll ... 16, 18, 19, 33, 44, 54, 74, 85, 347, 355, 516, 560,
561
Domain Name ............................................... 385, 533
double pipe ............................................................ 217
Download entity metadata................................... 103
Drill Limitation .............. 224, 233, 241, 264, 272, 279
driver15, 16, 17, 18, 19, 21, 22, 25, 33, 44, 54, 74, 85,
300, 312, 313, 347, 408, 464, 541, 560, 561, 564,
566
Driver Class............................ 112, 136, 561, 564, 566
Driver Properties ........................................... 561, 566
DSN ................................ 406, 408, 462, 464, 539, 541
Duplicate ...................................... 622, 641, 662, 680
DWC ............................................................... 300, 303
Existing Model....................................................... 271
Existing Tenants ............................................ 179, 344
Existing Time Dimensions .... 414, 415, 470, 471, 493,
494
Existing Virtual Points ............ 418, 419, 474, 475, 496
Existing Virtual Points (View Names) ... 418, 474, 496
Exit .327, 407, 410, 413, 424, 426, 428, 429, 433, 435,
437, 438, 443, 445, 447, 448, 452, 454, 456, 458,
463, 466, 468, 480, 482, 487, 489, 502, 504, 540,
543, 546, 548, 550, 552, 554
Export to CSV......................................................... 335
extension ............................................................... 103
External OAuth.......................... 9, 333, 334, 374, 375
external XML.................................................. 390, 392
Extra Dimensions .. 579, 582, 592, 607, 613, 627, 632,
647, 654, 665, 672
Extra Properties ............................ 346, 393, 508, 555
E
FederationMetadata.xml.............................. 102, 109
Field / Control ...33, 39, 44, 53, 58, 65, 73, 78, 84, 89,
96, 206, 255, 319, 321, 324, 326, 327, 328, 331,
335, 337, 339, 341, 343, 346, 347, 351, 353, 355,
356, 357, 358, 359, 361, 362, 364, 365, 366, 367,
370, 372, 374, 375, 376, 378, 380, 382, 385, 386,
388, 389, 390, 393, 397, 399, 401, 403, 405, 408,
411, 414, 418, 419, 420, 422, 424, 426, 429, 430,
432, 434, 436, 438, 440, 442, 444, 446, 448, 449,
450, 453, 455, 457, 459, 461, 464, 467, 470, 474,
475, 476, 478, 481, 483, 485, 488, 491, 493, 496,
497, 498, 500, 503, 505, 508, 509, 512, 514, 516,
518, 520, 522, 523, 524, 525, 527, 528, 530, 532,
534, 535, 536, 538, 541, 544, 547, 549, 551, 553,
555, 556, 559, 574, 576, 578, 580, 582, 583, 587,
589, 591, 593, 595, 596, 599, 602, 603, 605, 609,
612, 614, 618, 622, 623, 626, 628, 631, 633, 637,
641, 642, 644, 646, 649, 652, 653, 654, 658, 662,
664, 666, 669, 670, 673, 676, 680, 682
Fields Available for Selection........................ 412, 545
File ......................................................................... 178
File version ............................................................ 570
filtering ...................................................................... 5
Filters ..................................................... 7, 8, 412, 545
Finish .... 106, 108, 171, 199, 253, 291, 307, 315, 427,
552
First Page ............................................................... 553
First Time Deployment .......................... 28, 51, 71, 83
formulas................................................. 345, 390, 391
Framework......................................................... 12, 15
Freehand SQL ... 71, 77, 208, 209, 213, 325, 327, 337,
340, 345, 390, 395, 397, 399, 461, 483, 575, 576,
578, 626, 690
Freehand SQL View Management ........................ 395
Edit.....28, 38, 224, 233, 241, 249, 264, 272, 279, 313,
319, 324, 338, 397, 399, 419, 420, 451, 475, 476,
497, 498, 539, 542, 569, 570, 591, 625, 626, 627,
628, 629, 643, 663, 664, 666, 667, 681
Edit Binding ........................................................... 166
Edit Claim Insurance Policy ................................... 107
Edit Drill Limitation ....... 224, 233, 241, 264, 272, 279
Edit Oracle Policy ................................................... 569
Edit Semantic Layer View Name .................... 627, 628
Edit Stored Procedure View Name ........................ 665
Edit the View ......................................... 591, 626, 664
Edit View ....................................................... 539, 542
Editing View .................. 591, 592, 626, 627, 664, 665
Enable Live Data Connections............................... 281
Enabled.......................................................... 166, 308
encrypted....................................................... 376, 530
Endpoints .............................................................. 106
Enter Database User Name................... 603, 644, 682
Enter Schema.............................................. 412, 545
Enter Table .................................................. 412, 545
Enter User Name ................................................... 327
Enterprise ................................................ 11, 298, 702
ess_es_server.jar ............. 34, 45, 54, 75, 85, 348, 510
ess_japi.jar ....................... 34, 45, 54, 75, 85, 348, 510
ess_maxl.jar ..................... 34, 45, 54, 75, 85, 348, 510
Essbase ...................................... 1, 354, 357, 515, 518
ESSBASE ..7, 16, 34, 45, 54, 75, 85, 348, 357, 510, 518
Essbase Server ............................................... 357, 518
ewallet.p12 ............................................................ 570
Exception Aggregation....................................... 5, 6, 7
executable ......................................................... 58, 89
Execute As...................................................... 384, 532
F
APOS Systems Inc. |
600
Index
Freehand SQL Views .......... 26, 71, 213, 572, 576, 578
Freehand SQL Web Application ............................. 208
FreeSQL ......................................................... 477, 690
functions ... 3, 390, 415, 471, 494, 583, 584, 596, 597,
614, 615, 633, 634, 655, 673
G
GBQ Project ID ...................................................... 374
Generate................................................................ 297
Generic JDBC .............................................. 346, 508
Geo Map ................................................................ 294
Geo Mapping Columns .................. 291, 425, 479, 501
Geo Maps............................................... 3, 23, 26, 285
Geospatial Dimensions 579, 587, 589, 590, 592, 599,
601, 602, 607, 613, 618, 621, 622, 627, 632, 637,
641, 647, 654, 658, 661, 662, 665, 672, 676, 679,
680
Get DB Relationships ............................................ 623
Get Relationship From Database.................. 427, 551
Get Relationships From Database ................ 199, 252
GIS Virtual Points .................................. 187, 345, 390
Global (All Users) Access....................... 603, 644, 682
Global Access 210, 581, 593, 603, 609, 610, 628, 629,
644, 649, 650, 666, 667, 682
Global View ........................................................... 402
GOOGLE ......................................................... 333, 375
Google Big Query ... 1, 3, 9, 10, 34, 45, 55, 75, 86, 325,
333, 345, 348, 371, 374, 375, 390, 406, 412, 414,
462, 468, 470, 510, 527, 539, 544, 558, 559, 579,
583, 592, 596, 607, 613, 627, 632, 647, 665, 688,
689
Google Cloud .1, 17, 34, 45, 55, 75, 86, 348, 360, 406,
462, 510, 521, 539, 563
Google Cloud Hive ................................................... 17
google-api-client-1.23.0.jar .... 34, 45, 55, 75, 86, 348,
510
google-api-services-bigquery-v2-rev377-1.23.0.jar 34,
45, 55, 75, 86, 348, 510
GoogleBigQueryJDBC42.jar .... 34, 45, 55, 75, 86, 348,
510
google-http-client-1.23.0.jar... 34, 45, 55, 75, 86, 348,
510
google-http-client-jackson2-1.23.0.jar . 34, 45, 55, 75,
86, 348, 510
google-oauth-client-1.23.0.jar 34, 45, 55, 75, 86, 348,
510
GrandTotal ......................................................... 5, 6, 7
green.............................................................. 304, 308
Greenplum.APOSProperties ................. 409, 465, 542
H
HANA . 1, 17, 21, 25, 34, 45, 55, 75, 86, 191, 237, 269,
276, 293, 297, 300, 301, 348, 360, 406, 462, 510,
521, 539, 562, 623
HANA Authentication ............................................ 297
HANA Client Driver ................................................ 562
HANA Hostname ................................................... 297
HANA Live Connection .......................................... 293
HANA Port ............................................................. 297
HANA SDI and SDA ......................................... 300, 301
Help................................................................ 353, 514
Help File................................................................... 22
hierarchy dates .............................................. 345, 390
highlighted .29, 37, 38, 58, 65, 71, 102, 300, 312, 315,
564, 566
highlighted yellow ................................................. 312
Hive 1, 15, 16, 17, 18, 34, 44, 45, 55, 75, 86, 348, 360,
406, 462, 510, 521, 539, 563
hive-jdbc.jar . 33, 34, 35, 44, 45, 46, 53, 54, 55, 73, 74,
75, 84, 85, 86, 347, 348, 509, 510
hive-jdbc-1.1.0-cdh5.13.0.jar.. 33, 44, 54, 74, 85, 347,
509
hive-jdbc-1.2.1000.2.6.4.99-1-standalone.jar .. 35, 46,
55, 75, 86, 348, 510
hive-jdbc-1.2.3.2-standalone.jar..... 34, 45, 55, 75, 86,
348, 510
hive-jdbc-2.3.3-standalone.jar 33, 44, 53, 73, 84, 347,
509
HiveJDBC41.jar................. 35, 46, 55, 75, 86, 348, 510
Hortonworks ..1, 18, 35, 46, 55, 75, 86, 191, 348, 360,
406, 462, 510, 521, 539, 563
Hortonworks Hive ...... 18, 35, 46, 55, 75, 86, 348, 510
host ................ 296, 300, 302, 303, 305, 310, 312, 315
Host .38, 185, 216, 227, 235, 248, 259, 267, 274, 296,
360, 521
hosts ........................................................................ 37
HTTP .......................................... 37, 38, 305, 366, 525
HTTP_HEADER ............................................... 366, 525
HTTP1......................................................... 5, 101, 109
HTTP2 5, 13, 14, 25, 26, 29, 58, 60, 71, 77, 79, 91, 97,
101, 102, 109
httpd.conf.............................................................. 296
httpd-vhosts.conf.................................................. 296
HTTPS . 29, 71, 106, 216, 227, 235, 259, 267, 274, 305
HTTPS Port............................. 216, 227, 259, 267, 274
I
I Agree ................................................................... 168
IAM ........................................ 111, 140, 328, 378, 691
IBM DB2 ........................................... 18, 360, 521, 563
Identifier Dimension Name .................................. 498
APOS Systems Inc. |
601
Index
Identifier for Mapping . 288, 294, 420, 421, 425, 476,
477, 479, 499, 501, 588, 600, 619, 638, 659, 677
Identifier for Mapping Column ............. 425, 479, 501
Identity Access Management ................................ 111
IDENTITY PROVIDER SSO – Level 2......................... 109
Identity Providers for SSO..... 372, 376, 378, 380, 382,
528, 530
Identity Providers SSO .......... 120, 142, 371, 372, 528
IDENTITY PROVIDERS SSO 22, 25, 111, 113, 137, 225,
265, 363, 364, 366, 369, 370, 523, 524, 526, 528
IDENTITY PROVIDERS SSO – Level 2 ....................... 101
IIS ..................................................... 22, 161, 163, 166
imapalaJDBC41.jar ........... 34, 45, 54, 74, 85, 347, 509
IMPERSONATE SSO USER...... 101, 109, 225, 265, 363,
366, 384, 385, 523, 526, 532
IMPERSONATE SSO USER – (Level3) .............. 225, 265
IMPERSONATE SSO USER – Level 3 ....... 109, 363, 366,
384, 523, 526, 532
Import.................................... 166, 325, 327, 398, 402
Import data about the relying party from a file ... 105
Import From XML .................................................. 325
Import Users.......................... 377, 379, 381, 383, 531
Important .............................................................. 169
Include Geo Spatial ............................................... 610
Include Geospatial 581, 587, 593, 599, 610, 618, 629,
637, 650, 658, 667, 676
Included Files ........................................................... 21
Independent Service 13, 14, 21, 22, 25, 26, 28, 51, 71,
83, 572, 574
Independent Service Deployment .. 13, 14, 21, 22, 25,
26, 572, 574
inetpub .................................................................. 161
input parameters .. 485, 488, 489, 491, 647, 653, 665,
670
Insert a Chart......................................................... 284
Insert Data Source................................................. 281
Install ..................................................................... 170
Installation of Tomcat ........................................ 25, 26
Installation Steps ..................................................... 23
Internal Host ......................................................... 306
Internal Port .......................................................... 306
Is Disabled ............................................................. 337
Is Invalid ................................................................ 337
Is It a Measure ............ 590, 602, 622, 641, 662, 680
Is Measure ..................... 196, 251, 423, 479, 501, 548
Is Output................................................ 492, 653, 670
ISAPI ................................................................. 15, 161
ISNULL................................................................ 5, 6, 7
J
jar ............................... 16, 33, 44, 54, 74, 85, 347, 560
Java .. 12, 13, 14, 18, 39, 170, 179, 246, 324, 343, 351,
352, 512, 513
Java 1.8 .............................................................. 13, 14
Java Options................................................. 37, 39, 40
Java Path ............................................... 179, 324, 343
java.exe ................................................. 246, 352, 513
jaxb-impl-2.2.3.1.jar......... 35, 46, 55, 75, 86, 348, 510
jcc-11.5.4.0.jar ....................... 45, 54, 74, 85, 347, 509
jconn4.jar ................. 36, 47, 56, 76, 87, 349, 350, 511
JDBC ............................................................... 313, 316
JDBC Connection ................................................... 315
JDBC Driver ............................ 2, 22, 27, 300, 312, 313
JDBC Driver Class................................................... 312
JDBC Driver Connection String.............................. 312
JDBC Generic .....10, 15, 18, 19, 22, 25, 33, 35, 36, 44,
46, 47, 56, 76, 87, 111, 112, 136, 325, 349, 360,
371, 372, 378, 380, 390, 392, 395, 408, 464, 511,
521, 541, 564, 566, 576, 646
Join Listing ..................................................... 624, 642
Joins ...... 285, 418, 474, 496, 579, 587, 592, 599, 607,
618, 623, 627, 637, 642, 647, 658, 665, 676
jre8................................................. 170, 246, 352, 513
K
Kerberos .... 5, 6, 9, 25, 28, 37, 49, 205, 206, 225, 254,
255, 265, 363, 364, 367, 386, 508, 523, 524, 526,
534, 562, 574
KERBEROS SSO ...... 225, 265, 363, 364, 367, 386, 388,
523, 524, 526, 534
key ..................................................................... 12, 14
Key Pair (Snowflake) ..................... 120, 142, 379, 380
Key Pair Folder ...................................... 117, 118, 329
KeyPair (Snowflake) ............................................... 371
keystore ......36, 38, 47, 59, 66, 77, 78, 82, 90, 97, 570
keystore.jks .................................... 36, 47, 77, 82, 570
keytab .............. 37, 365, 387, 388, 389, 534, 535, 537
Keytab File (full path)... 365, 387, 388, 389, 534, 535,
537
Krb5 Configuration File 365, 387, 388, 389, 534, 535,
536, 537
krb5.ini..... 37, 365, 387, 388, 389, 534, 535, 536, 537
L
Label ...................................................... 491, 653, 670
LAG .................................................................... 3, 391
languages ......................................................... 71, 572
latitude . 285, 286, 421, 477, 499, 588, 600, 619, 638,
659, 677
Layer Type ............................................................. 295
LDAP Attribute ...................................................... 108
LDG Driver.................................................................. 9
LDG Manager ................. 403, 578, 605, 626, 646, 664
LDG_Audit.............................................................. 688
APOS Systems Inc. |
602
Index
LDG_Config.xml.47, 56, 77, 80, 81, 87, 128, 130, 150,
152, 202, 204, 205, 206, 208, 285, 337, 341, 572,
573
LDG_ConfigurationFields ....................................... 687
LDG_Connections .................................................. 684
LDG_DB_Create.bat .............................................. 684
LDG_DB_Create.sql ............................................... 684
LDG_Manager.sql .................................................. 684
LDG_OAUTH_PROVIDER_PROFILES ....................... 684
LDG_SERVICE_ACCOUNT_GBQ.............................. 688
LDG_SSO_CONFIGURATION .................................. 689
LDG_SSO2_JDBC_MAPPING .................................. 689
LDG_UpgradeLog ................................................... 693
LDG_User_Views ................................................... 687
LDG_Users_FreeSQL_Approved ............................ 690
LDG_USERS_IAM ........................................... 690, 691
LDG_USERS_SNOWFLAKE ...................................... 691
LDG_USERS_SSO .................................................... 691
LDG_VersionInfo.................................................... 692
LDG_Views ............................................................. 686
ldg-driver.jar............................................ 22, 312, 313
ldg-key-service 22, 129, 130, 131, 134, 151, 152, 153,
157
ldg-key-service.jar ................................................... 22
ldg-key-service.xml ....................... 131, 134, 153, 157
Left Table Column Key ............................. 624, 642
Left Table Name ........................................ 624, 642
Left Table Schema ..................................... 624, 642
LENGTH .............................................................. 5, 6, 7
Length Function..................................................... 391
Level 1 ... 214, 225, 257, 265, 363, 364, 366, 367, 523,
524, 525, 527
Level 2....... 22, 25, 111, 214, 225, 257, 265, 363, 364,
366, 369, 523, 524, 526, 528
Level 3 ... 214, 225, 257, 265, 363, 364, 367, 386, 523,
524, 526, 534
Level Definition ..... 415, 471, 494, 584, 597, 615, 616,
634, 635, 655, 656, 673, 674
Level Type..... 415, 471, 494, 584, 597, 616, 635, 656,
674
LIBMYSQL_ENABLE_CLEARTEXT_PLUGIN 18, 360, 521
Licence ................................................... 179, 324, 343
license ....2, 21, 22, 161, 172, 179, 243, 244, 300, 312,
343, 508, 556, 695, 696, 697, 698, 700
License ................................................... 243, 508, 556
LIKE .................................................................... 5, 6, 7
limitations .................................................................. 3
Listen ..................................................................... 296
Listing Views.................................. 209, 578, 605, 646
Live Data connection............................................. 261
Live Data Connection ... 213, 226, 235, 257, 258, 266,
282
Live Data Gateway Admin ... 181, 184, 214, 225, 234,
242, 243, 254, 255, 257, 265, 273, 285, 320, 324,
338, 344, 345, 404, 405, 413, 431, 432, 435, 441,
442, 445, 450, 454, 460, 461, 484, 485, 506, 507,
512, 538, 546, 548, 550, 552, 554
Live Data Gateway Deployment .......... 23, 25, 28, 254
Live Data Gateway Drivers ......................... 23, 26, 312
Live Data Gateway Login........................................ 174
Live Data Gateway Manager ..... 12, 21, 23, 25, 37, 40,
47, 51, 56, 77, 83, 87, 112, 130, 136, 152, 167, 172,
202, 205, 208, 209, 213, 214, 317, 319, 572, 573,
575, 578, 591, 606, 646
Live Data Gateway View Wizard ... 283, 404, 405, 432,
442, 450, 461, 485, 538, 558, 562, 571
Live Data Gateway Web App . 25, 29, 41, 49, 213, 257
LiveDataGateway ....31, 33, 36, 39, 40, 42, 44, 47, 50,
296, 346, 509
LiveDataGateway.jar............................................... 21
LiveDataGateway.xml ....................................... 58, 64
LiveDatGateway.xml ................................................ 70
Load All Schema ............................................ 411, 544
Load All Schema(s) ........................................ 286, 488
Load All Universes ................................................. 453
Load Configuration File ......................... 249, 539, 542
Load Cubes ............................................................ 434
Load Cubes and Bex Queries................................. 444
Load Default .......................................................... 391
Load From File ....................................................... 392
Load Table Schema ....................................... 411, 544
Load Table Schema(s) ................................... 192, 250
Load Tables............................................................ 467
Load Universe for APOS View ........................ 453
Load View Schema ........................................ 411, 544
Load View Stored .................................................. 488
Location Dimension ..... 294, 295, 420, 476, 498, 588,
600, 619, 638, 659, 677
Location Dimension ID . 288, 420, 476, 498, 587, 599,
619, 638, 659, 677
Location Dimension Name... 288, 294, 420, 476, 498,
588, 600, 619, 638, 659, 677
Location Identifier................................................. 294
location key .. 285, 286, 421, 477, 499, 588, 600, 619,
638, 659, 677
Log10 ................................................................. 5, 6, 7
log4j.properties ................................................. 64, 95
log4j.xml .......31, 40, 42, 50, 61, 64, 67, 70, 92, 95, 97
Logarithmic Function ............................................ 391
logging.level.root ............................. 58, 65, 78, 89, 96
Login ..... 172, 174, 175, 185, 209, 317, 321, 363, 364,
366, 369, 372, 376, 377, 523, 524, 526, 528, 530,
531, 574, 575, 578, 605, 606, 646
Login User ...................................... 376, 377, 530, 531
APOS Systems Inc. |
603
Index
Logon URL.............................................................. 281
Logout.................................................... 578, 606, 646
longitude ...... 285, 286, 421, 477, 499, 588, 600, 619,
638, 659, 677
LOOKUP ..................................................................... 3
M
Manage SSO Services ............ 115, 125, 139, 147, 325
Manage Users for SSO Services ... 111, 115, 139, 325,
328
Manage Views ............................... 189, 285, 335, 338
Manifest........................................................ 346, 508
Mapping of LDAP Attributes to outgoing claim types
........................................................................... 108
MAX ...5, 423, 479, 501, 548, 590, 602, 622, 641, 662,
680
Max memory pool ............................................. 37, 40
measure .... 7, 190, 192, 196, 198, 250, 251, 252, 285,
286, 404, 415, 423, 425, 467, 471, 479, 480, 481,
493, 501, 502, 503, 538, 548, 549, 584, 589, 590,
597, 601, 602, 605, 607, 612, 615, 621, 622, 627,
631, 634, 641, 647, 652, 656, 661, 662, 665, 669,
674, 679, 680
Measure ........................ 196, 211, 251, 290, 423, 548
Measure Id .................................. 622, 641, 662, 680
Measure Name .............................. 196, 251, 423, 548
measures .......3, 5, 6, 7, 189, 196, 251, 338, 395, 404,
411, 423, 432, 433, 434, 436, 442, 443, 444, 446,
450, 451, 453, 454, 455, 467, 478, 479, 500, 501,
544, 548, 579, 589, 592, 601, 607, 627, 647, 665
Measures ...5, 6, 7, 224, 233, 241, 264, 272, 279, 284,
413, 423, 468, 489, 546, 548
Measures and Dimensions Listing436, 446, 455, 479,
501
Measures Listing ........................................... 423, 548
Menu Options ........................................ 323, 324, 351
Metadata....................................................... 582, 595
Microsoft SQL Server 35, 39, 46, 55, 75, 86, 184, 206,
255, 349, 360, 386, 388, 510, 521, 534, 535, 566
MIN ....5, 423, 479, 501, 548, 590, 602, 622, 641, 662,
680
Model. 5, 6, 7, 189, 210, 218, 220, 223, 228, 230, 233,
236, 238, 240, 260, 262, 263, 268, 269, 271, 275,
276, 279, 293, 294, 295, 339, 395, 404, 405, 432,
442, 450, 461, 485, 581, 603, 610, 622, 629, 641,
644, 650, 662, 667, 680, 682
Modules......................................................... 164, 165
MongoDB .......1, 18, 35, 46, 55, 76, 86, 349, 360, 511,
521, 566
MongoDB Atlas ......1, 18, 35, 46, 55, 76, 86, 349, 360,
511, 521, 568
Month ... 415, 416, 417, 471, 472, 473, 494, 495, 584,
585, 586, 597, 598, 615, 616, 617, 634, 635, 636,
655, 656, 657, 673, 674, 675
MS SQL ..6, 22, 25, 345, 384, 390, 412, 414, 468, 470,
532, 579, 583, 592, 596, 607, 613, 623, 627, 632,
647, 665
MS SQL Database .................................................. 395
MS SQL Server.................... 22, 25, 345, 384, 390, 532
MSAS.... 1, 28, 29, 37, 41, 42, 167, 205, 206, 255, 335,
338, 355, 377, 395, 404, 512, 531
mssql-jdbc-9.4.1.jre8.jar. 35, 39, 46, 55, 75, 86, 206,
255, 349, 510
Multi-Factor ............................................................... 9
Multiple Deployments ............................................. 70
MySQL.... 1, 18, 35, 46, 55, 76, 86, 349, 360, 511, 521,
568, 623
Mysql-connector-java-5.1.46.jar .... 35, 46, 55, 76, 86,
349, 511
N
Name .... 165, 174, 191, 200, 216, 219, 223, 227, 229,
233, 235, 237, 240, 249, 259, 261, 263, 267, 269,
271, 274, 276, 279, 303, 319, 360, 423, 430, 432,
440, 442, 449, 451, 459, 479, 501, 521, 548, 580,
590, 591, 593, 602, 609, 622, 626, 629, 641, 649,
662, 664, 666, 680, 684, 685, 686, 687, 688, 689,
690, 691, 692, 693
NameID.................................................................. 108
NET Extensibility .............................................. 15, 161
net.snowflake.client.jdbc.SnowflakeDriver . 112, 564
Netezza ......18, 35, 46, 56, 76, 87, 349, 360, 511, 521,
568
Networks ........................................................... 5, 6, 7
New ............................................................... 351, 512
New Configuration File .................. 249, 539, 540, 542
New Geospatial Dimension . 587, 599, 618, 637, 658,
676
New Remote Source ............................................. 301
New SAC Tenants .......................................... 179, 344
New Shared Secret ................................................ 298
New Table Join .............................................. 623, 642
New User ............................................... 603, 644, 682
New View ..... 200, 209, 253, 292, 429, 438, 448, 457,
481, 503, 553, 578
newVersion= ......................................................... 570
Next ...... 105, 106, 107, 168, 169, 170, 191, 196, 198,
249, 250, 251, 252, 282, 290, 291, 305, 306, 307,
315, 407, 410, 413, 423, 426, 427, 433, 435, 437,
443, 445, 447, 451, 454, 456, 463, 466, 468, 480,
486, 489, 502, 539, 540, 542, 543, 546, 548, 550,
552
ngdb.jar............................ 34, 45, 55, 75, 86, 348, 510
APOS Systems Inc. |
604
Index
No DB user can create views ................................ 326
No User .................................................................. 527
Non JDBC Generic .................................. 405, 461, 538
Non-Database ............................................ 22, 71, 572
Non-Database Method .... 21, 26, 173, 174, 242, 317,
325, 351, 398, 507
None ..... 214, 225, 234, 236, 257, 265, 273, 274, 306,
366, 367, 375, 525, 527
NOT ................................................ 5, 7, 694, 698, 699
not supported ...... 3, 6, 7, 8, 9, 12, 21, 22, 26, 71, 105,
172, 242, 285, 300, 305, 310, 321, 339, 395, 430,
436, 440, 446, 449, 453, 455, 459, 462, 465, 478,
483, 485, 486, 491, 500, 505, 507, 508, 566, 572,
576, 580, 581, 593, 609, 610, 629, 646, 649, 650,
653, 667, 670, 684
Note ...... 229, 233, 237, 254, 261, 264, 269, 272, 279,
310, 346, 377, 508, 531, 558, 562, 563, 566, 569,
570, 571
NTLM .5, 225, 363, 364, 366, 367, 368, 370, 385, 523,
524, 526, 527, 529, 532
Number of Views .................................................. 337
numeric values ...................................................... 391
numerical ...... 422, 423, 425, 478, 500, 547, 548, 549,
589, 601, 607, 612, 621, 627, 631, 647, 652, 661,
665, 669, 679
nzjdbc.jar ......................... 35, 46, 56, 76, 87, 349, 511
O
OAuth...9, 10, 325, 333, 334, 366, 371, 372, 373, 374,
375, 382, 574, 577
OAuth – Information.............................................. 372
OAuth 2.0 authentication ................................... 577
OAuth Authentication............ 333, 372, 374, 382, 574
OAuth Client ID ............................................. 372, 374
OAuth Information ................................................ 371
Oauth Profile ................................................. 373, 374
OAuth Profiles (URLs) ............................ 325, 373, 374
OAuth Provider Profiles 325, 333, 371, 373, 374, 684
Oauth Scope .................................................. 372, 374
OAuth Scope.................................................. 372, 374
OAuth Secret ................................................. 372, 374
oauth.proxy.host ................................... 59, 65, 90, 96
oauth.proxy.port.................................... 59, 65, 90, 96
OAuth2 ................................................. 59, 65, 90, 96
OData ... 2, 5, 9, 21, 22, 23, 25, 36, 40, 59, 65, 77, 300,
301, 302, 303, 305, 308, 309, 310, 312, 315, 316
OData Acquired Data ................................................. 9
OData Adapter ...................................................... 301
OData Connection ................................................. 303
OData Entry point URL .......................................... 300
Odata Gateway .......................................... 78, 89, 96
OData Gateway ...... 2, 5, 9, 21, 23, 36, 40, 59, 65, 300,
305, 312, 315, 394, 407, 409, 433, 443, 451, 463,
466, 486, 540, 543, 555, 581, 594, 611, 630, 651,
668
OData Query Limits ...... 394, 407, 409, 433, 443, 451,
463, 466, 486, 540, 543, 555
OData Services .............................................. 309, 310
odata.cache.expiry........................... 59, 65, 78, 89, 96
odata2ldg.svc ................. 300, 302, 303, 310, 312, 315
ODBC DSN 15, 16, 17, 18, 19, 406, 408, 409, 462, 464,
465, 539, 541, 542, 558, 562, 563, 571
ojdbc6.jar ........ 35, 46, 56, 76, 87, 206, 255, 349, 511
ojdbc8.jar ........................ 35, 46, 56, 76, 87, 349, 511
ojdl.jar.............................. 34, 45, 54, 75, 85, 348, 510
OK ..182, 185, 216, 223, 227, 233, 235, 240, 246, 247,
259, 263, 267, 271, 274, 279, 281, 283, 293, 294,
297, 377, 379, 381, 383, 531, 559
OLAP Connection ........................................... 281, 296
OLAP Connections ................................................. 299
Only provided DB users can create views ............ 327
Open ...................... 244, 246, 342, 351, 352, 512, 513
OpenJDK 812, 13, 14, 18, 29, 168, 170, 179, 343, 351,
352, 512
Oracle .... 1, 3, 6, 18, 35, 36, 37, 46, 47, 56, 76, 77, 82,
87, 191, 206, 225, 255, 265, 345, 349, 360, 363,
366, 384, 386, 388, 390, 406, 412, 414, 462, 468,
470, 508, 511, 521, 523, 526, 532, 534, 535, 539,
569, 570, 579, 583, 592, 596, 607, 613, 623, 627,
632, 647, 665
Oracle Exadata .....1, 18, 35, 36, 46, 47, 56, 76, 77, 82,
87, 191, 349, 360, 406, 462, 511, 521, 539, 570
Oracle Policy Information ...................................... 569
Oracle.DataAccess.dll ................................... 569, 570
Order ..................................... 491, 560, 564, 653, 670
Outgoing Claim Type ............................................. 108
Owner .................................... 397, 400, 401, 403, 687
Owner(s)................................................................ 401
P
Pair Key Folder .............................................. 125, 331
PARAM_ ................................. 485, 500, 501, 662, 680
Parameter Name ........................................... 491, 653
parameters ... 4, 6, 485, 488, 489, 496, 650, 653, 658,
670
Parameters .... 491, 500, 501, 661, 662, 670, 679, 680
Pass Through claim ................................................ 108
password..59, 66, 78, 90, 97, 169, 174, 217, 302, 303,
310, 315, 366, 377, 525, 531, 559
Password ...... 125, 127, 147, 149, 174, 176, 191, 209,
216, 217, 227, 235, 249, 259, 267, 274, 302, 303,
310, 315, 319, 321, 331, 341, 366, 368, 372, 377,
APOS Systems Inc. |
605
Index
385, 405, 408, 432, 442, 450, 461, 464, 486, 525,
527, 528, 531, 532, 539, 541, 559, 574, 575
Path ....................................................................... 293
Path and all sub-paths .......................................... 308
Permit everyone.................................................... 106
pid .......................................................................... 702
port .. 38, 59, 63, 65, 70, 71, 73, 78, 80, 89, 90, 94, 96,
100, 131, 135, 153, 159, 166, 169, 174, 296, 297,
300, 302, 303, 305, 310, 312, 315, 356, 516, 564,
566, 572, 574
Port ................................ 127, 149, 174, 185, 321, 341
PORT .............................................................. 102, 109
ports....................................................................... 169
PostgreSQL.... 225, 265, 363, 367, 409, 465, 523, 526,
542
PostgreSQL.APOSProperties ................. 409, 465, 542
Power................................................................. 5, 6, 7
pre-defined user .................................................... 281
Pre-Defined User ............................................... 2, 368
PRE-DEFINED User......................................... 366, 525
PRE-DEFINED USER 225, 265, 363, 364, 366, 367, 523,
524, 526, 527
preferred method .................................... 12, 213, 257
Preferred Method ................................................. 257
prefix...................................... 187, 217, 337, 685, 686
Prefix ..................................... 217, 219, 229, 237, 337
Press any key to continue .... 63, 68, 93, 99, 132, 135,
155, 159
Press Download Shared Secret ............................. 298
Presto................. 18, 35, 46, 56, 76, 87, 349, 511, 566
presto.client.truststore.jks .................................... 566
presto.jks ............................................................... 566
Presto-jdbc-0.218.jar ....... 35, 46, 56, 76, 87, 349, 511
Principal Type ........................................................ 306
Private View .......................................................... 402
Professional Services ............................................... 11
Projection Details (SRID)....................... 421, 477, 499
prompt filters............................................................. 8
Properties File ....................................... 409, 465, 542
protocol ... 5, 25, 26, 29, 38, 58, 60, 71, 101, 102, 106,
109
Protocol ..................................... 13, 14, 102, 109, 305
proxy .............................................. 59, 65, 90, 96, 296
Q
Quarter . 415, 416, 417, 471, 472, 473, 494, 495, 584,
585, 586, 597, 598, 615, 616, 617, 634, 635, 636,
655, 656, 657, 673, 674, 675
Queries Without Aggregation....... 581, 594, 611,
630, 651, 668
Query Contains Aggregation. 394, 407, 409, 433,
443, 451, 463, 466, 486, 540, 543, 555
Query Context........................................................ 568
query limits.. 394, 407, 409, 433, 443, 451, 463, 466,
486, 540, 543, 555, 581, 594, 611, 630, 651, 668
Query Without Aggregation.. 394, 407, 409, 433,
443, 451, 463, 466, 486, 540, 543, 555
QUERY_STRING ............................................. 366, 525
R
Range filters ....................................................... 5, 6, 7
Ready to Add Trust ............................................... 106
Real Spatial Data ................................................... 285
recommended .. 25, 26, 174, 242, 319, 320, 321, 467,
507, 698
Re-Deployment.......................... 28, 41, 51, 71, 80, 83
Redshift...... 1, 2, 15, 36, 47, 56, 76, 87, 111, 136, 143,
349, 360, 371, 378, 511, 521, 571
RedshiftJDBC42-1.2.10.1009.jar ..... 36, 47, 56, 76, 87,
349, 511
Refresh .................................. 324, 398, 400, 412, 545
Refresh Metadata for Selected Fields .......... 413, 545
Refresh Universe Capabilities ............................... 451
relational database . 26, 27, 71, 73, 77, 248, 249, 335,
337, 338, 340, 366, 393, 395, 404, 405, 412, 414,
461, 468, 470, 485, 525, 526, 538, 555, 579, 583,
592, 596, 607, 613, 627, 632, 647, 654, 665, 672,
685
Relational Database ....... 281, 338, 395, 404, 405, 461
relational databases ..... 3, 4, 208, 213, 248, 345, 346,
390, 393, 395, 508, 555, 576, 623, 686
Relational Databases ............................................. 2, 6
Relationship Listing ....................................... 427, 552
Relationship Name........................................ 427, 552
Reload.................................................................... 602
Relying Party Trust ................................................ 104
Relying Party Trusts .............................................. 106
Remote Source ...................................................... 302
Remote Subscriptions ........................................... 302
remove...7, 23, 24, 224, 233, 241, 264, 272, 279, 324,
327, 338, 344, 376, 379, 380, 382, 397, 400, 419,
475, 497, 530, 540, 542, 545, 548, 550, 552, 553,
559, 591, 604, 626, 644, 664, 682, 696
Remove Unused Joins ................................... 427, 552
Replace Users ........................ 377, 379, 381, 383, 531
Require Catalog In Query .............................. 560, 564
Requires the Alias in ORDER BY .................... 560, 564
Resource ................................................................ 307
Resources .............................................................. 308
Restart ..... 31, 37, 39, 42, 50, 73, 79, 80, 82, 110, 205,
207, 208, 256, 296, 299, 572
Restart Tomcat .................................................. 36, 40
RESTful Web Service ............................................. 299
RESTRICT .................................................................... 3
APOS Systems Inc. |
606
Index
Restricted measures ...................................... 3, 5, 6, 7
RESULTLOOKUP ......................................................... 3
Retrieval Method .......................................... 366, 525
Retrieving Method ................................................ 299
Reverse Proxy .......................................................... 24
Review .. 307, 607, 623, 625, 627, 642, 643, 647, 661,
663, 665, 679, 681
Right Table Column Key .......................... 624, 642
Right Table Name ..................................... 624, 642
Right Table Schema .................................. 624, 642
ROOT . 29, 31, 33, 39, 40, 41, 42, 44, 47, 49, 205, 206,
254, 255, 512, 554
ROOT.war .............................................. 29, 39, 41, 49
row level 225, 265, 363, 364, 366, 367, 369, 376, 523,
524, 526, 527, 528, 530
ROW_NUMBER .................................................... 391
Rows ...................................................................... 284
Run Apache Tomcat ............................................... 171
Run as Administrator ...................... 95, 134, 157, 168
Run Sample ................................... 210, 581, 582, 595
Running ................. 63, 68, 93, 99, 133, 135, 156, 159
S
SAC ....... 3, 6, 7, 9, 12, 15, 21, 25, 28, 37, 49, 178, 179,
180, 189, 205, 206, 207, 210, 213, 214, 225, 234,
247, 254, 255, 256, 257, 265, 273, 285, 293, 300,
305, 308, 309, 310, 324, 338, 339, 343, 344, 363,
364, 366, 367, 368, 369, 384, 386, 395, 398, 400,
401, 402, 404, 405, 421, 425, 432, 433, 442, 450,
461, 477, 479, 485, 499, 501, 508, 523, 524, 525,
526, 527, 528, 532, 534, 538, 556, 559, 581, 591,
603, 610, 626, 629, 644, 650, 664, 667, 682, 687
SAC Projection............... 588, 600, 619, 638, 659, 677
SAC Projection (SRID)............................ 425, 479, 501
SAC SSO......6, 25, 28, 37, 49, 205, 206, 207, 225, 234,
254, 255, 256, 265, 363, 364, 367, 386, 508, 523,
524, 526, 534
SAC Tenant ............ 179, 247, 324, 343, 344, 508, 556
SAC Tenant URL..................................... 179, 247, 556
SAM-Account-Name.............................................. 108
SAML ......13, 22, 23, 25, 101, 109, 207, 214, 225, 227,
256, 257, 265, 267, 363, 364, 366, 367, 368, 369,
370, 384, 385, 386, 523, 524, 526, 527, 528, 529,
532, 534
SAML Single Sign On .... 207, 214, 225, 227, 256, 257,
265, 267, 369, 384, 386, 528, 532, 534
SAML SSO.....13, 22, 23, 25, 58, 77, 78, 101, 109, 206,
207, 255, 256, 368, 369, 370, 384, 385, 527, 528,
529, 532
SAML SSO Deployment ............ 13, 23, 25, 58, 65, 101
SAML SSO web application ...................... 25, 207, 256
SAML/NTLM.. 121, 143, 378, 379, 380, 381, 382, 383,
574
SAML/NTLM User .. 121, 143, 379, 380, 381, 382, 383
SAML/NTLM Users ................ 121, 143, 379, 381, 383
saml2-sso ...... 5, 13, 21, 101, 102, 109, 110, 369, 384,
528, 532
saml2-sso.war ......................... 21, 101, 102, 109, 110
samlsso.path .................................... 58, 65, 78, 89, 96
Sample ................................................................... 211
Sample Results ...................................... 579, 589, 592
Sample Results/Assign Measure............ 579, 589, 592
sample string ................................................. 374, 375
SAP Analytics Cloud ...... 1, 3, 9, 12, 25, 213, 214, 257,
344, 345, 507
SAP Business One DI ................................................ 16
SAP HANA .............. 219, 226, 229, 235, 258, 266, 274
SAP HANA HTTP .................................................... 297
Save ...... 179, 187, 211, 224, 233, 241, 253, 264, 272,
279, 292, 294, 308, 322, 327, 342, 344, 346, 402,
403, 407, 410, 413, 423, 426, 428, 429, 433, 435,
437, 438, 443, 445, 447, 448, 451, 454, 456, 457,
463, 466, 468, 480, 481, 487, 489, 502, 503, 509,
512, 540, 543, 546, 548, 550, 552, 554, 590, 602
Save and Close ...................................................... 299
Save Folder .................................................... 118, 329
sboapi.jar ................................................................. 16
sbowapper.jar.......................................................... 16
Schema .......................... 192, 250, 488, 612, 652, 669
Search ... 121, 143, 412, 434, 444, 454, 468, 489, 545,
578, 605, 646
Search for Cubes ........................................... 434, 444
Search for Universes ............................................. 454
Search Table .......................................................... 468
Secure hash algorithm .......................................... 109
security type .......................................... 319, 337, 341
security.require-ssl .......................... 59, 66, 79, 90, 97
Select a Cube/Bex Query or Measures and
Dimensions ........................................................ 444
Select a Datasource............................................... 309
Select Data Source for Analysis ............................ 281
Select Database Field ............................ 415, 471, 494
Select Dimension and Measure .... 607, 621, 622, 627,
640, 641, 647, 661, 662, 665, 679, 680
Select Fields ... 407, 410, 411, 433, 434, 540, 543, 544
Select Geospatial Dimension587, 599, 618, 637, 658,
676
Select Measures and Dimensions from a Cube .... 434
Select Source ......................................... 421, 477, 499
Select Specify Display Name ................................. 105
Select Stored Procedure ........................ 647, 652, 665
Select Table .. 421, 477, 499, 607, 612, 619, 627, 631,
638, 659, 677
Select Table Columns............. 607, 612, 627, 631, 669
APOS Systems Inc. |
607
Index
Select Universe.............................................. 451, 453
Select View .................................................... 539, 542
Selected Cube........................................................ 453
Semantic 190, 213, 293, 345, 390, 395, 397, 399, 451,
576, 577, 605, 606, 607, 609, 625, 627, 628, 643
Semantic Layer ..... 190, 213, 395, 397, 399, 576, 577,
605, 609, 625, 628, 643
Semantic Layer View Management ..... 190, 285, 293,
395, 397, 399
Semantic Layer Views ............................ 213, 576, 605
Semantic Layers ............................................. 209, 213
Semantic View ....................................................... 451
Send LDAP Attributes as Claims ........................... 107
SERVER .......................................................... 102, 109
Server Certificates ................................................. 166
Server List .............................................................. 298
Server Name .......................... 127, 149, 174, 321, 341
Server Url............................................................... 450
Server URL .... 167, 182, 244, 246, 346, 355, 356, 357,
358, 508, 516, 518, 519
server.http2.enabled ....................... 60, 77, 79, 91, 97
server.port ....................................... 59, 65, 78, 90, 96
server.ssl.key-alias ........................... 59, 66, 78, 90, 97
server.ssl.key-store .......................... 59, 66, 78, 90, 97
server.ssl.key-store-password ......... 59, 66, 78, 90, 97
server.ssl.key-store-type ................. 59, 66, 78, 90, 97
server.xml...................... 25, 28, 29, 38, 39, 41, 49, 71
Servers ................................................................... 298
service account ...................................... 559, 688, 689
Service Account ..................................... 371, 558, 559
Service Account List .............................................. 559
Service DB Details ......................................... 125, 147
service principal ....................................................... 37
Service Principal Name 365, 386, 388, 389, 534, 535,
537
Service Providers................................... 102, 695, 696
Service Type .................................. 116, 140, 328, 689
ServiceStartInstall.bat................................... 132, 155
ServiceStartStop.bat ....................... 61, 68, 70, 92, 99
ServiceStop.bat ................................................. 64, 95
ServiceStopUninstall.bat .............................. 134, 157
Set Row Limit For Queries With Aggregation
................................... 581, 594, 611, 630, 651, 668
setspn ...................................................................... 37
SHA-1 ..................................................................... 109
Share...................................................................... 398
Share the View .............................. 213, 591, 626, 664
Share View ............................................................ 400
Share with User ..................................................... 402
Sharing View 581, 591, 603, 610, 626, 629, 644, 650,
664, 667, 682
Show Connections................................................. 281
Show Value Zero in Results .................................. 433
Sizing ........................................................................ 20
Snowflake .... 1, 3, 9, 10, 14, 18, 22, 25, 36, 47, 56, 76,
87, 111, 112, 116, 117, 119, 120, 121, 122, 125,
127, 129, 130, 131, 133, 134, 135, 142, 149, 157,
190, 325, 329, 331, 333, 334, 349, 371, 372, 374,
375, 379, 380, 390, 392, 404, 414, 470, 511, 538,
564, 579, 592, 605, 690
SNOWFLAKE .......................................................... 116
Snowflake SSO2 Service......................................... 380
Snowflake SSO2 Service Deployment ............ 111, 112
SnowflakeFormula.xml ................................. 392, 564
snowflake-jdbc-3.6.27.jar 36, 47, 56, 76, 87, 349, 511
Source Name ................................................. 301, 303
space ...................................................................... 304
spatial data............................................................ 285
spatial functionality ...... 285, 418, 474, 496, 579, 587,
592, 599, 607, 618, 627, 637, 647, 658, 665, 676
SQL Authentication ............................... 175, 322, 341
SQL Database ......................................................... 684
SQL Express........................................ 21, 26, 174, 684
SQL select statement ..................................... 579, 581
SQL Select Statement............................ 463, 466, 467
SQL Server......1, 6, 25, 28, 37, 49, 225, 265, 355, 363,
364, 367, 508, 516, 523, 524, 526
SQL Server Analysis Services................. 355, 364, 524
SQL Statement 71, 572, 579, 581, 582, 590, 592, 595,
602
sqljdbc4.jar 35, 39, 46, 55, 75, 86, 206, 255, 349, 510
sqlnet.ora............................................................... 570
SQLServer.APOSProperties ................... 409, 465, 542
SRID....4, 288, 345, 390, 418, 421, 425, 474, 477, 479,
496, 499, 501, 579, 587, 588, 592, 599, 600, 607,
618, 619, 627, 637, 638, 647, 658, 659, 665, 676,
677
SSAS ... 5, 6, 9, 167, 174, 181, 182, 184, 189, 217, 219,
225, 229, 237, 242, 244, 248, 265, 335, 338, 354,
355, 361, 363, 364, 366, 367, 386, 395, 404, 432,
438, 448, 515, 516, 522, 523, 524, 525, 526, 534
SSL.... 12, 13, 14, 18, 28, 29, 37, 58, 59, 65, 71, 78, 89,
90, 96, 101, 102, 214, 257, 360, 369, 384, 521,
528, 532
SSO....... 5, 13, 17, 22, 25, 37, 58, 65, 89, 96, 101, 109,
207, 214, 225, 256, 257, 265, 297, 337, 361, 363,
364, 366, 367, 368, 369, 370, 372, 384, 385, 386,
522, 523, 524, 525, 526, 527, 528, 529, 532, 534,
562, 574
SSO authentication ............................................ 9, 334
SSO Authentication Type ...................... 120, 142, 528
SSO Configuration ... 25, 111, 113, 120, 137, 142, 345,
361, 507, 521, 522
APOS Systems Inc. |
608
Index
SSO SAML...... 101, 366, 367, 368, 370, 385, 527, 529,
532
SSO Service ............................ 116, 140, 328, 329, 689
SSO Type ................................................................ 337
SSO User ................ 116, 122, 140, 143, 328, 379, 381
SSO1................................................................... 2, 281
SSO2 Service ..... 15, 19, 111, 128, 129, 133, 135, 136,
150, 151, 156, 159, 372
SSO2 Services.14, 22, 23, 25, 33, 36, 44, 47, 111, 129,
134, 151, 157, 325, 331, 371
SSO2 Services Deployment ........................ 23, 25, 111
ST_Point. 425, 479, 501, 590, 602, 622, 641, 662, 680
ST_POINT ............................................... 285, 425, 549
Start ......................................................... 70, 104, 281
static IP .................................................................... 37
Status............................................................. 304, 308
Step 2 ............................................. 609, 628, 649, 666
Step 3 ............................................. 612, 631, 652, 669
Step 4 ..................................................... 640, 653, 670
Stored Procedure.. 213, 345, 390, 395, 397, 399, 485,
486, 488, 489, 491, 500, 505, 576, 577, 646, 647,
649, 652, 653, 663, 664, 665, 666, 669, 670, 681
Stored Procedure Parameters ..... 488, 489, 500, 647,
653, 665
Stored Procedure View Management .. 395, 397, 399
Stored Procedure Views ........................................ 576
Stored procedures ............................................. 4, 485
Stored Procedures Available for Selection........... 489
STOREDPROC......................................................... 499
Story ...... 224, 233, 241, 262, 264, 270, 272, 279, 294
String Conversion Function................................... 391
string values .......................................................... 391
SUBSTRING ........................................................ 5, 6, 7
SUM ...5, 423, 479, 501, 548, 590, 602, 622, 641, 662,
680
Summary of the selected fields ............ 412, 413, 545
Support Freehand SQL ........................................... 187
Support LAG Function ........................................... 391
Supported ...................... 4, 6, 345, 371, 390, 544, 545
Supports Freehand SQL......................................... 340
Sybase Anywhere....... 19, 36, 47, 56, 76, 87, 349, 511
Sybase IQ .......1, 19, 36, 47, 56, 76, 87, 350, 360, 511,
521, 571
Sybase SQL Anywhere .. 191, 360, 406, 462, 521, 539,
571
SybaseIQ .......... 19, 191, 406, 408, 462, 464, 539, 571
Syntax Concatenation ........................................... 391
System ................................................................... 261
T
Table 1 ........................................................... 427, 552
Table 1 Column Key....................................... 427, 552
Table 1 Owner ............................................... 427, 552
Table 2 ........................................................... 427, 552
Table 2 Column Key....................................... 427, 552
Table 2 Owner ............................................... 427, 552
Table name ................................. 622, 641, 662, 680
Table Name ................................... 423, 425, 548, 549
Table Treeview ...................................................... 631
Tables ............................................................ 316, 684
Tables Available for Selection............................... 468
tcnative-1.dll .................................... 13, 14, 29, 58, 71
tdgssconfig.jar.................. 36, 47, 56, 77, 87, 350, 511
Technical Support .................................................. 702
Technical User ....................................................... 302
Tenant ..................................................... 10, 344, 577
Teradata 2, 19, 36, 47, 56, 77, 87, 350, 360, 406, 462,
511, 521, 571
terajdbc4.jar .................... 36, 47, 56, 77, 87, 350, 511
Test 175, 182, 185, 202, 246, 248, 322, 346, 351, 377,
508, 509, 512, 531, 559
Test Connection ... 185, 202, 248, 342, 346, 351, 377,
508, 509, 512, 531, 559
Test Connection Requirements ............. 346, 508, 509
Test URL......................................... 182, 246, 346, 508
Text Area ....................................................... 581, 595
Thresholds ................................................................. 7
Time Definition .... 195, 415, 471, 494, 584, 585, 597,
615, 616, 634, 635, 655, 656, 673, 674
Time Dimension .... 195, 198, 211, 414, 415, 424, 468,
470, 471, 478, 480, 493, 494, 500, 502, 583, 584,
596, 597, 614, 615, 616, 633, 634, 635, 655, 656,
673, 674
Time Dimension filter ................................................ 3
time dimension hierarchy.......................................... 3
Time Dimension ID ........................................ 211, 414
Time Dimension Management . 412, 480, 488, 493,
502
Time Dimension Name.......................................... 415
Time dimensions...................................... 26, 242, 507
Time Dimensions ...... 3, 195, 211, 318, 345, 390, 412,
414, 424, 468, 470, 478, 488, 493, 500, 508, 544,
564, 579, 583, 584, 589, 590, 592, 596, 601, 602,
607, 613, 614, 621, 622, 627, 632, 633, 641, 647,
654, 655, 661, 662, 665, 672, 673, 679, 680
TNS_ADMIN........................................................... 571
tnsnames.ora ................................. 36, 47, 77, 82, 570
to Run as administrator ........ 61, 68, 92, 99, 132, 155
tomcat...... 12, 13, 22, 25, 28, 37, 41, 71, 80, 213, 257,
265, 346, 365, 388, 509, 512, 534, 540, 543, 554,
572
Tomcat ... 12, 13, 24, 25, 26, 28, 29, 31, 33, 36, 37, 38,
39, 40, 41, 42, 44, 47, 49, 50, 59, 65, 71, 72, 73, 77,
78, 79, 80, 81, 82, 90, 96, 101, 102, 109, 110, 168,
APOS Systems Inc. |
609
Index
169, 170, 172, 174, 204, 205, 206, 207, 208, 214,
254, 255, 256, 257, 296, 369, 384, 528, 532, 572
Tomcat Configuration Manager........................ 36, 40
Tomcat JVM............................................................. 39
trusted account..... 225, 265, 363, 364, 366, 367, 523,
524, 526, 527
Trusted Authentication......................................... 298
Trusted Authentication is enabled ....................... 298
Trusted User Name ...... 366, 368, 372, 385, 525, 527,
528, 532
TrustedPrincipal.conf ............................................ 298
truststore.jks.................................. 36, 47, 77, 82, 570
tsnames.ora........................................................... 569
Type ...... 165, 219, 229, 237, 269, 276, 425, 467, 549,
684, 685, 686, 687, 688, 689, 690, 691, 692, 693
U
ucp.jar ............. 35, 46, 56, 76, 87, 206, 255, 349, 511
Uncheck All............................................ 423, 480, 502
Uncheck All Measures........................................... 423
underscore.... 217, 415, 471, 494, 584, 597, 616, 635,
656, 674
Uninstall ................................................................... 24
Uninstall Steps ......................................................... 24
Unique Identify Provider ID .................................. 297
Unique Prefix 183, 187, 200, 292, 339, 430, 440, 449,
459, 483, 505
uniquely .. 21, 297, 420, 476, 498, 539, 542, 580, 587,
599, 618, 637, 659, 677
Universe ..7, 8, 22, 189, 229, 237, 261, 269, 299, 300,
361, 404, 450, 451, 453, 454, 457, 522, 525
Universe Connection ............................................. 299
Universe Filters .......................................................... 7
Universes . 1, 2, 7, 9, 15, 189, 297, 338, 354, 358, 395,
404, 450, 453, 515, 518
Unsupported.......................................................... 3, 9
UNV.................................................................... 1, 7, 9
UNX .................................................................... 1, 7, 9
Update ................................................................... 298
Update Policy ........................................................ 569
Update Summary List............................................ 286
URL..... 58, 63, 70, 73, 80, 94, 100, 102, 109, 161, 166,
208, 214, 225, 234, 257, 265, 273, 302, 303, 305,
306, 308, 310, 312, 315, 344, 355, 356, 357, 358,
516, 518, 519, 572, 574
Use a datasource ................................... 228, 260, 268
Use Default 394, 407, 409, 433, 443, 451, 463, 466,
486, 540, 543, 555, 581, 594, 611, 630, 651, 668
Use Default Values ... 394, 407, 409, 433, 443, 451,
463, 466, 486, 540, 543, 555
Use DSN ................................................. 408, 464, 541
Use for No Credentials .................. 366, 368, 525, 527
Use Only Selected Connections ............................ 342
Use SSO 113, 137, 361, 363, 364, 366, 368, 370, 385,
522, 523, 524, 525
Use TOP in Select .................................................. 560
User ...... 191, 249, 405, 408, 432, 442, 450, 461, 464,
485, 486, 538, 539, 541, 702
user access.... 579, 580, 591, 593, 603, 607, 626, 627,
644, 647, 664, 665, 682
User Can Self Add to the List ........................ 371, 372
User ID ................................................................... 315
User List ................................. 377, 379, 381, 383, 531
User name ............................................................. 604
User Name .... 116, 125, 127, 140, 143, 147, 149, 174,
176, 209, 217, 299, 303, 310, 319, 321, 327, 328,
329, 331, 341, 372, 379, 403, 528, 574, 575, 603,
644, 682
User Name Parameter .......................................... 299
User Only Selected Connections................... 127, 149
User Proxy Password .................................... 389, 536
User Statistics ........................................................ 335
Username ...... 216, 217, 227, 235, 259, 267, 274, 302
Users 38, 325, 326, 327, 363, 364, 366, 369, 372, 376,
398, 400, 401, 402, 523, 524, 526, 528, 530, 581,
593, 603, 610, 629, 644, 650, 667, 682, 690
Users Management ............... 121, 143, 398, 400, 401
V
valid ....................................................................... 244
Validate ................................. 199, 253, 427, 551, 552
Validate Query ...................................................... 467
Value.......................................... 5, 433, 491, 653, 670
Variables .................................................................... 5
version number................ 63, 70, 73, 80, 94, 100, 572
View............................................................... 283, 397
View Definition .... 427, 429, 433, 437, 438, 443, 447,
448, 451, 456, 457, 462, 465, 481, 486, 503, 552,
553, 554
View Definition Listing . 429, 438, 448, 457, 481, 503,
553
View Description .. 457, 481, 503, 579, 592, 609, 628,
649, 666
View Description Details ........................ 398, 481, 503
View Listing .. 578, 591, 606, 625, 626, 643, 646, 663,
664
View Management....... 190, 213, 285, 293, 335, 338,
395, 397, 399, 424, 426, 428, 429, 431, 437, 438,
441, 447, 448, 450, 456, 458, 460, 482, 484, 504,
506
View Name ... 191, 200, 210, 249, 286, 288, 292, 294,
397, 411, 418, 419, 420, 422, 424, 425, 427, 429,
430, 432, 434, 436, 438, 440, 442, 444, 446, 448,
449, 451, 453, 455, 457, 459, 462, 465, 467, 474,
475, 476, 478, 479, 481, 483, 486, 488, 496, 497,
APOS Systems Inc. |
610
Index
498, 500, 501, 503, 505, 539, 540, 542, 544, 547,
549, 551, 553, 578, 580, 587, 593, 599, 607, 609,
610, 618, 628, 629, 637, 647, 649, 650, 659, 666,
667, 677
View Names .......................................... 419, 475, 497
View Prefix ... 210, 580, 593, 607, 609, 629, 647, 649,
667
View Wizard . 167, 189, 191, 283, 397, 399, 404, 461,
538, 562, 563, 576, 577, 686
View Wizard – Freehand SQL......................... 397, 399
View Wizard – Stored Procedure... 397, 399, 485, 577
View XML .............................................................. 340
View(s)........................................................... 401, 403
Views ...3, 71, 189, 213, 335, 338, 395, 399, 403, 404,
432, 442, 450, 572, 575, 576
Virtual Host ........................................................... 306
Virtual Point – Database Definition..... 288, 421, 477,
499
Virtual Point Definition ......... 287, 412, 468, 489, 545
Virtual Point Management 412, 418, 421, 425, 468,
474, 477, 479, 489, 496, 499, 501
Virtual Point Settings ............................ 418, 474, 496
virtual points . 418, 474, 496, 579, 587, 592, 599, 607,
618, 627, 637, 647, 658, 665, 676
Virtual Points 285, 294, 318, 419, 475, 489, 496, 497,
498, 508, 650, 658
Virtual Port ............................................................ 306
Virtual Tables ........................................................ 302
Visual C++ 2015 ............................................... 15, 161
VPOINT . 291, 425, 479, 501, 590, 602, 622, 641, 662,
680
W
WACS ............................................. 298, 299, 366, 525
Waterfall Charts ......................................................... 3
Web ............................................... 214, 257, 540, 543
web application ..... 3, 9, 13, 21, 22, 25, 26, 27, 28, 29,
31, 33, 36, 37, 38, 39, 40, 41, 42, 44, 49, 50, 71, 73,
74, 77, 80, 101, 102, 109, 161, 172, 174, 202, 205,
206, 208, 242, 254, 255, 257, 265, 293, 296, 297,
299, 308, 317, 337, 347, 366, 367, 368, 369, 370,
384, 385,512, 527, 528, 529, 532, 560, 564, 566,
572
Web Application ......13, 14, 16, 21, 22, 25, 26, 28, 71,
347, 572, 574
Web Application Deployment 13, 14, 21, 22, 26, 347,
572, 574
Web Logic URL............................................... 357, 518
Web Server IIS ................................................. 15, 161
Web UI ...... 22, 71, 208, 209, 213, 325, 326, 327, 340,
572, 574, 578, 605, 606, 646, 685, 690
Web UI Rights ................................................ 326, 337
Web.config ............................................................ 161
WebApplicationContainerServer.......................... 298
webapps 21, 31, 33, 36, 39, 40, 41, 42, 44, 47, 49, 50,
72, 73, 77, 80, 81, 82, 101, 109, 110, 171, 208
WEB-INF\lib ............. 16, 33, 44, 73, 74, 347, 560, 572
Week..... 415, 416, 417, 471, 472, 473, 494, 495, 584,
585, 586, 597, 598, 615, 616, 617, 634, 635, 636,
655, 656, 657, 673, 674, 675
When Query Limits Not Provided 581, 594, 611, 630,
651, 668
wildcard ................ 412, 434, 444, 454, 468, 489, 545
Windows Authentication .............................. 175, 322
Windows Services .... 63, 64, 68, 93, 95, 99, 133, 134,
135, 156, 157, 159
Wizard .. 413, 423, 424, 426, 427, 428, 429, 431, 435,
437, 438, 441, 445, 447, 448, 450, 454, 456, 457,
458, 460, 468, 480, 481, 482, 484, 489, 502, 503,
504, 506, 545, 546, 548, 550, 552, 553, 554
workingdirectory... 58, 64, 89, 95, 131, 134, 153, 157
wwwroot ............................................................... 161
X
xml .......25, 28, 49, 198, 252, 254, 255, 346, 356, 508,
509, 516, 540, 543
XML ......12, 13, 25, 174, 200, 254, 292, 337, 360, 397,
398, 429, 433, 438, 443, 448, 451, 457, 462, 465,
481, 486, 503, 521, 539, 540, 542, 553, 556
Y
Year....... 415, 416, 417, 471, 472, 473, 494, 495, 584,
585, 586, 597, 598, 615, 616, 617, 634, 635, 636,
655, 656, 657, 673, 674, 675
Yes ......................................................................... 246
APOS Systems Inc. |
611
Download