Summary


This article describes the Connector Suite and the various dashboard connectors it contains. The Connector Suite is an add-on components for the SAP Dashboards client.


 Access


 The Connector Suite file (.XLX) is available for download from the following locations:


 Version

See Build Information for current Connector Suite version.

 Installation

In the SAP Dashboards client:
  • Select File > Manage Add-Ons
  • Select Install Add-On
  • Browse to select and install the .XLX file

 Update

Recommendations
  • Keep Connector Suite version current
  • Qualify updates using a dashboard test copy

Process
  • Select File > Manage Add-Ons 
  • Select Install Add-On
  • Browse to select and install the .XLX file (replace existing if prompted)
  • Open dashboard (XLF)
  • Preview, test, and save

 Connection Manager

Manage one or more connection profiles. Connection information for individual connector components can be configured manually or use a profile from the connection manager. Changing the connection manager profile will change the connection for any connector component using the connection manager.

Requirements
  • The XDC name and path must be consistent between servers used in connection profiles.
  • Offline dashboards must not contain the Connection Manager component

Usage
  • Select Components > Tree > Web Connectivity
  • Drag the IB Connection component to the dashboard canvas

Add a Profile
  • Select the green plus button
  • Profile Name: Enter a profile name
  • Use SSL: Check to enable SSL connection
  • IBE Server:Port: Enter [SERVER]:[PORT]
  • User: Enter username
  • Password: Enter password
  • Prompt for User Credentials: Select this option to prompt the dashboard viewer for credentials

Select a Profile
  • Use Profile: Select a profile
  • User Identity (optional): Use the cell selector to insert the dashboard viewer's Windows user name to a cell
  • Connected Timestamp: Use the cell selector to insert a timestamp to a cell. Time timestamp is updated when the connector successfully authenticates. Cell change can be used to trigger connectors based on successful authentication of the connection manager.

Use in Connectors
  • Select Use credentials from IBConnector to utilize selected connection manager profile

 Cache Connector

Connect to the InfoBurst server and consume a data cache.
  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard. 
  • Offline: Use to embed a cache in a dashboard for offline consumption. Only one connector can be used for an offline dashboard.

Connection
  • Name: Enter a connection name
  • Use credentials from IBConnector: Select to use connection information from IB Connection Manager
  • Supply manually: Select to supply connection details manually
  • Use SSL: Check to enable SSL connection
  • Mobile Authentication: Check to enable Mobile Authentication
  • IBE Server:Port: Enter InfoBurst [SERVER:PORT]
  • User: Enter InfoBurst user name or use the cell selector to link to a cell that contains the user name
  • Password: Enter InfoBurst user password or use the cell selector to link to a cell that contains the password
  • Name: Select the ellipsis button to and select an XDC
  • Key: Select a default key or use the cell selector to link to a cell that contains a key value
    • Key field only appears when cache contains a key
    • For offline dashboard, key values are supplied automatically as part of dashboard delivery
  • Current Key List: Use the cell selector to insert the key list from InfoBurst to a cell or range of cells
    • List value cannot be used to trigger Refresh on Load
  • Logging Meta Data: Use the cell selector to select a cell containing meta information to be recorded with XDC logging
  • User Identity: Use the cell selector to insert the dashboard viewer's Windows user name to a cell
    • Optional and only used when dashboard security is used
    • Field not displayed when IB Connection Manager is used
  • Extra Auth Lookup: Use the cell selector to insert extra column values from an authentication source to a cell
    • Optional and only used when dashboard security is used

Data Mappings
  • Mapped Results: Select the green plus button to select a data source from the XDC
    • Multiple XDC data sources can be utilized with a single connector
  • Data Source Name: Displays name of selected data source
  • Worksheet Range: Use the cell selector to insert data into a cell or cell range

Usage
  • Refresh on Load: Select to refresh data when visualization loads
  • Refresh Every: Select to refresh data on selected interval
  • Trigger Cell: Select a cell that will trigger the visualization to refresh the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Display refresh error as popup: Connector error messages are displayed in the dashboard by default. Un-check option to suppress error message display.
  • Refresh Error Message: Use the cell selector to insert connector error message into a cell
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the visualization is loading
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the visualization is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the data is loading
  • Disable Mouse Input on Load: Select to disable mouse input while data is loading

 Cache Query Connector

Connect to the InfoBurst server and consume the results of a Cache Query.
  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard.
  • Offline: Not available for offline usage.

Connection

  • Name: Enter a connection name
  • Use credentials from IBConnector: Select to use connection information from IB Connection Manager
  • Supply manually: Select to supply connection details manually
  • Use SSL: Check to enable SSL connection
  • Mobile Authentication: Check to enable Mobile Authentication
  • IBE Server:Port: Enter InfoBurst [SERVER:PORT]
  • User: Enter InfoBurst user name or use the cell selector to link to a cell that contains the user name
  • Password: Enter InfoBurst user password or use the cell selector to link to a cell that contains the password
  • Name: Select the ellipsis button to and select an XDC
  • Logging Meta Data: Use the cell selector to select a cell containing meta information to be recorded with XDC logging
  • User Identity: Use the cell selector to insert the dashboard viewer's Windows user name to a cell
    • Optional and only used when dashboard security is used
    • Field not displayed when IB Connection Manager is used
  • Extra Auth Lookup: Use the cell selector to insert extra column values from an authentication source to a cell
    • Optional and only used when dashboard security is used

Query Mappings

  • Query Name: Select a query from the XDC
    • Multiple queries are support in a single Cache Query connector
  • Worksheet Range: Use the cell selector to insert data into a cell or cell range
  • Mapping Orientation: Select the orientation of the cell(s) that contain the parameter name(s) and parameter value(s)
    • Only used when the cache query contains one or more parameters
  • Mapped to Range: Use the cell selector to link to the cells that contain the parameter name(s) and value(s)

Usage
  • Refresh on Load: Select to refresh data when visualization loads
  • Refresh Every: Select to refresh data on selected interval
  • Trigger Cell: Select a cell that will trigger the visualization to refresh the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Display refresh error as popup: Connector error messages are displayed in the dashboard by default. Un-check option to suppress error message display.
  • Refresh Error Message: Use the cell selector to insert connector error message into a cell
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the visualization is loading
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the visualization is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the data is loading
  • Disable Mouse Input on Load: Select to disable mouse input while data is loading

 Database Query Connector

Connect to the InfoBurst server and consume the results of a direct database query.
  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard.
  • Offline: Not available for offline usage.

Connection
  • Name: Enter a connection name
  • Use credentials from IBConnector: Select to use connection information from IB Connection Manager
  • Supply manually: Select to supply connection details manually
  • Use SSL: Check to enable SSL connection
  • IBE Server:Port: Enter InfoBurst [SERVER:PORT]
  • User: Enter InfoBurst user name or use the cell selector to link to a cell that contains the user name
  • Password: Enter InfoBurst user password or use the cell selector to link to a cell that contains the password
  • Name: Select the ellipsis button to select a database connection
  • User Identity: Use the cell selector to insert the dashboard viewer's Windows user name to a cell
    • Optional and only used when dashboard security is used
    • Field not displayed when IB Connection Manager is used

Query Mappings
  • Include Column Headers: Column headers are included by default when returning data with a query. Un-check this option to exclude column headers.
  • Max Rows: Maximum number of rows to return when query is invoked
    • Default: 2048, Max: 9999
  • Decimal Rounding: Select this option to round decimals and control precision
  • DB Connection Query or Custom Query: Select DB Connection Query to use a pre-defined query or Custom Query to use a custom query
  • Name: Select a query
  • Output: Use the cell selector to insert the data into a cell or cell range
  • Parameters: Supply parameter values when the query contains one or more parameters
    • Set Manually: Supply value or values for a parameter
    • Mapped to Spreadsheet: Select the cell(s) that contain parameter information
      • Mapped to Range: Use the cell selector to link to the cells that contain the parameter name(s) and value(s)
  • Custom Query: Enter a SQL query
  • Output: Use the cell selector to insert the data into a cell or cell range

Usage
  • Refresh on Load: Select to refresh data when visualization loads
  • Refresh Every: Select to refresh data on selected interval
  • Trigger Cell: Select a cell that will trigger the visualization to refresh the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Display refresh error as popup: Connector error messages are displayed in the dashboard by default. Un-check option to suppress error message display.
  • Refresh Error Message: Use the cell selector to insert connector error message into a cell
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the visualization is loading
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the visualization is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the data is loading
  • Disable Mouse Input on Load: Select to disable mouse input while data is loading

 Database Writeback Connector

Connect to the InfoBurst server and update a database table with one or more values.
  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard.
  • Offline: Not available for offline usage.
  • The volume of data that can be written back with a single connector is 65526 characters of data (including XML tags).

Connection
  • Name: Enter a connection name
  • Use credentials from IBConnector: Select to use connection information from IB Connection Manager
  • Supply manually: Select to supply connection details manually
  • Use SSL: Check to enable SSL connection
  • IBE Server:Port: Enter InfoBurst [SERVER:PORT]
  • User: Enter InfoBurst user name or use the cell selector to link to a cell that contains the user name
  • Password: Enter InfoBurst user password or use the cell selector to link to a cell that contains the password
  • Name: Select the ellipsis button to select a database connection
  • User Identity: Use the cell selector to insert the dashboard viewer's Windows user name to a cell
    • Optional and only used when dashboard security is used
    • Field not displayed when IB Connection Manager is used

Query Mappings


Query 1

  • Name: Select a query
  • Mapping Orientation: Select the orientation of the cell(s) that contain the parameter name(s) and parameter value(s)
    • Only used when the cache query contains one or more parameters
  • Mapped to Range: Use the cell selector to link to the cells that contain the parameter name(s) and value(s)
  • Result Information: Returns query status. Map six columns and two rows.
  • Example output:

lOBDnJURf5QDsPknkptwJp114DrBf_KVGA.png


Query 2

  • Name: Select a query
  • Mapping Orientation: Select the orientation of the cell(s) that contain the parameter name(s) and parameter value(s)
    • Only used when the cache query contains one or more parameters
  • Mapped to Range: Use the cell selector to link to the cells that contain the parameter name(s) and value(s)
  • Result Information: Returns query status. Map six columns and two rows.
  • Example output:
lOBDnJURf5QDsPknkptwJp114DrBf_KVGA.png

Usage
  • Refresh on Load: Select to refresh data when visualization loads
  • Refresh Every: Select to refresh data on selected interval
  • Trigger Cell: Select a cell that will trigger the visualization to refresh the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Display refresh error as popup: Connector error messages are displayed in the dashboard by default. Un-check option to suppress error message display.
  • Refresh Error Message: Use the cell selector to insert connector error message into a cell
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the visualization is loading
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the visualization is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the data is loading
  • Disable Mouse Input on Load: Select to disable mouse input while data is loading

 SaveAsExcel Connector


Use this connector to save dashboard data to Excel. The connector is mapped to one or more ranges of data. The dashboard viewer then has the option to save the defined range(s) to Excel.

  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard.
  • Offline: Not available for offline usage.

Details
  • Name: Enter a connection name
  • Use credentials from IBConnector: Select to use connection information from IB Connection Manager
  • Supply manually: Select to supply connection details manually
  • Use SSL: Check to enable SSL connection
  • IBE Server:Port: Enter InfoBurst [SERVER:PORT]
  • Excel Ranges: Select the green plus button to a add an Excel range
  • Sheet Name: Provide a name for the Excel sheet that will contain the defined range
  • Range to save: Use the cell selector to select a range of cells that contain the data to be saved

Usage

  • Trigger Cell: Select a cell that will trigger the connector to save the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Display refresh error as popup: Connector error messages are displayed in the dashboard by default. Un-check option to suppress error message display.
  • Refresh Error Message: Use the cell selector to insert connector error message into a cell
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the connector is executing
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the connector is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the connector is executing
  • Disable Mouse Input on Load: Select to disable mouse input while connector is executing

 CrossTab Builder Connector

Connect to the InfoBurst server and build a crosstab from a selected data range with optional column/row totals
  • Connected: Available for a connected dashboard. Multiple connectors can be used in a dashboard. 
  • Offline: Not available for offline usage.

Details
  • Name: Enter a connection name
  • Server: Enter InfoBurst [SERVER:PORT]
  • Input Range: Use the cell selector to select a range of cells that contain the tabular data (including column headers) that will comprise the crosstab
  • Output Range: Use the cell selector to select a cell range to output the resulting crosstab data
  • X Axis Column Name: Name the selected column that will form the X Axis of the crosstab
  • Y Axis Column Name: Name the selected column that will form the Y Axis of the crosstab
  • Summary Column Name: Name the selected column that contains the summary data of the crosstab
  • Row/Column Totals: Select placement of results of row or column level calculations
    • Type: Select calculation type for row/column totals
  • Summary Formatting: Select formatting type of summary data
  • Abbreviated States: Check to abbreviate US states names
  • Suppress Zeros: Check to suppress zeros in resulting crosstab data

Usage
  • Refresh on Load: Select to refresh data when visualization loads
  • Refresh Every: Select to refresh data on selected interval
  • Trigger Cell: Select a cell that will trigger the visualization to refresh the data
    • When Cell Updates: Select to trigger a refresh when the Trigger Cell is updated, even if the value of the cell does not change
    • When Value Changes: Select to trigger a refresh when the value in the Trigger Cell changes
    • When Value Equals: Select to trigger a refresh when the value in the Trigger Cell equals the target value. Type a target value, or use the cell selector to link to a cell that contains the trigger value
  • Loading Message: Enter a message or use the cell selector to link to a cell that contains the message to display while the visualization is loading
  • Idle Message: Enter a message or use the cell selector to link to a cell that contains the message to display when the visualization is idle
  • Insert In: Use the cell selector to insert the message into a cell
  • Enable Load Cursor: Select to display the cursor while the data is loading
  • Disable Mouse Input on Load: Select to disable mouse input while data is loading