You are viewing content for 4.9 | 4.8 | 4.7 | 4.6 | 4.5 | 4.4 | 4.3 | Previous Releases


Integrations → Excel Add-in

About the Excel Add-in

With the Incorta Excel Add-in, you can extract data from Incorta to Excel into a Table or Pivot Table. You can save a query for later use, and refresh the data when you reopen your spreadsheet. You can also use the Excel built-in charts to create meaningful insights into your data.

NOTE

Your worksheet must be unprotected in order to use Excel charts.

Enable the Excel Add-in External Integration Instructions

To display the Excel Add-in external integration instructions within Incorta, the Cluster Management Console (CMC) Administrator must enable the Excel Add-in in the CMC with the following steps:

Specify the client credentials for the Default Tenant Configuration

Here are the steps to specify the required properties for the Default Tenant Configuration:

  • Sign in to the CMC.
  • In the Navigation bar, select Clusters.
  • In the cluster list, select a Cluster name.
  • In the canvas tabs, select Cluster Configurations.
  • In the panel tabs, select Default Tenant Configurations.
  • In the left pane, select External Visualization Tools.
  • In the right pane, enable Excel Addin
  • Select Save.

Specify the client credentials for a Tenant Configuration

Here are the steps to specify the required properties for a specific tenant:

  • Sign in to the CMC.
  • In the Navigation bar, select Clusters.
  • In the cluster list, select a Cluster name.
  • In the canvas tabs, select Tenants.
  • For the given tenant, select Configure.
  • In the left pane, select External Visualization Tools.
  • In the right pane, enable Excel Addin.
  • Select Save.

Here are the steps to view the Excel Add-in external integration instructions within Incorta:

  • Sign in to the Incorta Direct Data Platform.
  • In the Navigation bar, select Content.
  • In the Action bar, select + NewConnect other Visualization Tools.
  • In the Connect other Visualization Tools page, select Excel to view the procedure.

Install the Excel Add-in

Install the Incorta Excel Add-in on either Windows or Mac. Here are the steps to install the Excel Add-in on each operating system.

Install the Excel Add-in on Windows

There are two installers available for the Excel Add-in for Windows: 32-bit and 64-bit. To know which installer to use, you must first identify the version of Excel that you are using.

Download the Excel Add-in

  • Download the latest Excel Add-in .zip file from the latest version of your Incorta customer release distribution: Excel Addin <VERSION>.zip.
  • Unzip Excel Addin <VERSION>.zip.

Identify the Version of Microsoft Excel

  • Open Microsoft Excel.
  • In the Home menu, in the Sidebar, select Account.
  • In Account, in Product Information, select About Excel.
  • In the About Microsoft Excel dialog, the product name contains the Build version that indicates 32-bit or 64-bit.

For the 32-bit version of Microsoft Excel, use the Incorta_Excel_AddInSetup_16.5.3_32.msi installer.

For the 64-bit version of Microsoft Excel, use the Incorta_Excel_AddInSetup_16.5.3_64.msi installer.

Run the Installer

To run the Installer for the Incorta Excel Add-in for Windows, follow these steps:

  • If Excel is open, close Excel.
  • From the unzipped Excel Addin folder, run Incorta_Excel_AddInSetup_<VERSION>_<BIT_SIZE>.msi
  • In the installer wizard, select Next >.
  • In Select Installation Folder, the default installation path is
    C:\Users<YOURUSERNAME>\AppData\Local\Incorta Inc\IncortaExcelAddin\.

    • To accept the default folder for the Excel Add-in installation, select Next >.
    • To specify a specific directory, select Browse. In Browse for folder, first select a folder, then select OK. Select Next >.
  • In the Confirm Installation, select Next >.
  • In Installation Complete, select Close.

Verify the installation

  • Open Microsoft Excel.
  • In the Home menu, in New, select Blank workbook.
  • In the Ribbon, select the Incorta tab.
  • In the Incorta group, select the Show command.
  • Verify the Login Panel.

Install the Excel Add-in on Mac

To install the Excel Add-in for Incorta on Mac:

  • Download the latest Excel Web Add-in XML file from the latest version of your Incorta customer release distribution: IncortaExcelWebAddin.XML
  • If it does not yet exist, create the wef directory in /Users/<YOUR USERNAME>/Library/Containers/com.microsoft.Excel/Data/Documents/
  • Copy the IncortaExcelWebAddin.XML file to the following directory: /Users/<YOUR USERNAME>/Library/Containers/com.microsoft.Excel/Data/Documents/wef
  • Open Excel.
  • Select the Insert tab.
  • In the Insert ribbon, select My Add-insIncorta.
  • Select the Home tab.
  • In the Home ribbon, select Incorta to open the Incorta Excel Add-in Login panel.

IMPORTANT

It is recommended that you whitelist the URL of the Incorta Excel Add-in server: https://excel-addin.incortalabs.com:8443/incorta-addin/Functions/FunctionFile.html

Excel Add-in Anatomy

The Excel Add-in consists of the following:

  • Header bar
  • Login panel
  • Schemas and Tables panel
  • Pivot/Table panel
  • Search bar

Header bar

The header bar is used to:

  • Navigate from one panel to the next (forward arrow), or navigate back to a previous panel (back arrow).
  • View the following information about the Incorta connection (information icon):

    • Incorta URL
    • Tenant
    • UserName
  • Configure the Excel Add-in settings that appear on two tabs: General Options and Pivot Layout.

Here are the properties on the General Options tab:

Property Control Description
Max Rows text box Select the maximum number of rows that will be populated in Excel with data from Incorta. The default is 1048575.
Max Uniques to show in filter drop down (Mac only) text box Select the maximum number of unique values that will appear in a filter drop down. The default is 100.
Logging Level (Windows only) drop down list Select the logging level. Possible values are:
  • No
  • Yes
Enable Sheet Protection toggle (Mac), checkbox (Windows) Enable this property to make the data in the Excel sheet read-only
Enable Cancel While Loading toggle (Mac), checkbox (Windows) Enable this property to allow the user to cancel the data load from Incorta to Excel while it is in progress
Show Log Folder/Open Log File (Windows only) button Select this property to show the log folder and open the log file
Migrate old saved connections (Windows only) button Select this property to migrate old saved connections
Reset Warnings button Select this property to reset warnings
Close (Mac only) button Select this property to close the settings properties
OK (Windows only) button Select this property to save option changes
Cancel (Windows only) button Select this property to close the Options dialog without saving changes.

Here are the setting properties on the Pivot Layout tab:

Property Control Description
Row Total toggle Enable this property to include a row total in all pivot tables
Row Total At drop down list Select the location of the Row Total. The options are:
  • Top
  • Bottom
Column Total toggle Enable this property to include a column total in all pivot tables
Column Total At drop down list Select the location of the Column Total. The options are:
  • Left
  • Right
Hide Columns toggle Select this option to hide the pivot table columns
Close button Select this property to close the settings panel

Login panel

The login panel is used to connect to Incorta from Excel. Here are the properties for the Login panel:

Property Control Description
Saved Connections drop down list When you access the Excel Add-in for the first time, the default is New Connection. If you have saved a connection from a previous session, you can select it. You can delete a saved connection by selecting the delete (trash icon) to the right of the property.
Connection Name text box Enter a name for the connection
Incorta URL text box Enter the URL of your Incorta instance in the format https://<Incorta Host>:<Incorta HTTPS
Port>/Incorta
Tenant text box Enter the name of the Incorta tenant you would like to connect to
Username text box Enter the username for the Incorta tenant
Password text box Enter the password for the Incorta tenant
Remember me checkbox Select this property to retain your credentials (Connection Name, Incorta URL, Tenant, Username) in the Login panel for future sessions.
Save Password checkbox Select this property to save your password in the Login panel for future sessions.
Single Sign On checkbox Select this property to login with Single Sign On
Clear button Select this property to clear the login credentials
Connect button Select this property to connect to the Incorta tenant with the login credentials

Schemas and Tables panel

The Schemas and Tables panel is used to select the Incorta schemas and tables you would like to analyze within Excel. Here are the properties of the Schemas and Tables panel:

Property Control Description
Schemas and Tables Data panel tree view Select the Incorta schemas and tables you would like to analyze within Excel
Clear button Select this property to clear the schema and table selections
Analyze button Select this property to confirm the schema and table selections, and to open the Pivot/Table panel

Pivot/Table panel

The Pivot/Table panel is used to select the type of table you would like to use to view your data, and to select the Incorta data fields. Here are the properties of the Pivot/Table panel:

Property Control Description
Pivot/Table Data panel tree view Select the Incorta data fields you would like to add to your table
Filters drag and drop Drag and drop a data field to this panel to create a filter for your table
Columns drag and drop Drag and drop a data field or select it in the data panel to add a column to your table
Rows drag and drop Select Pivot as the Table type to configure this property. Drag and drop a data field to this panel to add a pivot table row.
Values drag and drop Select Pivot as the Table type to configure this property. Drag and drop a data field to this panel to add a pivot table value.
Table type radio button Select the type of table you would like to use to view your data. The options are:
  • Table
  • Pivot
Clear button Select this property to clear the field, filter and column selections
Save button Select this property to save the field, filter and column selections
Refresh button Select this property to refresh the Pivot/Table Data panel

Connect to Incorta with the Excel Add-in

Here are the steps to connect to Incorta with the Excel Add-in:

  • Open the Incorta Excel Add-in Login panel.
  • Enter the Login panel properties.
  • Select Connect. When you connect to Incorta successfully, the Schemas and Tables panel will open and a Connection Successful message will be displayed in the panel.

Access Schemas and Tables in Excel

After you successfully connect to Incorta, you can access your tenant schemas and tables in the Schemas and Tables panel with the following steps:

  • Navigate the directory tree as necessary to select the desired schemas and tables. You can enter a string in the Search text box above the directory tree to filter the directory tree to the schemas and tables matching your search string.
  • Select Analyze.

Create a Table or Pivot Table in Excel

After you select the schema(s) and/or table(s), the Pivot/Table panel appears. Here are the steps to create a table or pivot table:

  • Choose the fields to add to your report. You can either drag and drop fields to the appropriate panel, or highlight the panel and select the field to add from the tree above:

    • Use the Columns panel to add a column to your table.
    • Use the Filters panel to add a filter to your table.
    • For pivot tables only, use the Rows panel to add a row to your pivot table.
    • For pivot tables only, use the Values panel to add a value to your pivot table.
  • You can switch between tables and pivot tables by selecting the associated radio button near the bottom of the Pivot/Table panel.
  • Select Save to save the query to the current worksheet.
  • Select Refresh to fill the active Excel worksheet with the query results.

IMPORTANT

To retain the query in Excel, you must save the Excel file before you close it.