Software Documentation

The AVEVA BI Gateway software documentation set includes the following:

• BI Gateway Installation Guide - Provides information about installing and configuring the BI Gateway software features.

• BI Gateway Web Configuration Guide - Provides information about configuring and mapping various data sources; managing BI Gateway objects such as dimensions, measures, data sources, and their deployment; and security.

• BI Gateway Event API Guide - Provides information about using the BI Gateway Event API.

• BI Gateway Analytics Client Data Source Generator Guide - Provides information about using the Analytics Client Data Source Generator to generate Analytics Client Data Source files compatible with BI Gateway Analytics Client. These files are also known as Tableau Data Source (.tds) files.

• ReadMe (This document) - Provides information about software and hardware requirements, known issues, licensing, and documentation.

Requirements and Recommendations

Accessing the documentation

• The BI Gateway software installation instructions are located in the root folder of the BI Gateway software installation media as a PDF file. You can view these instructions by clicking the View Install Guide button as you start the BI Gateway software installation procedure.

• After installing AVEVA BI Gateway, you can access the BI Gateway software documentation as follows:

  • From the UserDocs folder of the BI Gateway installation path. For example, C:\Program Files (x86)\Wonderware\Intelligence\UserDocs.

  • From the Start menu as listed in the following table:

    Document	Menu option
    BI Gateway Installation Guide	Start > AVEVA Documentation
    BI Gateway Web Configuration Guide	Start > AVEVA Documentation
    BI Gateway Event API Guide	Start > AVEVA Documentation
    Analytics Client Data Source Generator Guide	Start > AVEVA BI Gateway
    Readme	Start > AVEVA BI Gateway

Opening the documentation

• You need Adobe Reader installed on your computer to view the BI Gateway software documentation. You can download the latest version of Adobe Reader from the Adobe Corporation web site:

  http://www.adobe.com/products/reader.html

  After installing Adobe Reader, double-click on a PDF file to view the book with Adobe Reader. Alternatively, open a book with the Adobe Reader Open command from the File menu.

• You can also open the PDF files on Google Chrome, Microsoft Edge, and Mozilla Firefox browsers (with default browser settings).