Create a SharePoint App File

Contents[Hide]

1. Overview

This article shows you how to create a Dundas BI SharePoint App File which will allow you add a Dundas BI Viewer App Part to your web pages.

2. Launch the Deployment application

Start the Dundas BI Deployment application (from the Dundas BI server or the SharePoint server).

The default folder location for it is: C:\Program Files (x86)\Dundas Data Visualization Inc\Dundas BI\Setup\2.5.

Dundas BI Deployment application
Dundas BI Deployment application

You can also launch the Deployment application from your Start menu on the server.

Launching the Deployment application
Launching the Deployment application

3. Create a SharePoint App File

In the Deployment application's main screen, click Extras to see the available SharePoint options.

Extras screen showing SharePoint options
Extras screen showing SharePoint options

Click Create a SharePoint App File.

3.1. Create SharePoint App Options

First, record the Client ID that is displayed (e.g., copy and paste into Notepad). You'll need this to deploy the app file to SharePoint later.

Next, enter the URL of your Dundas BI instance, and then click Browse to choose the file path for saving the app file.

Create SharePoint App Options
Create SharePoint App Options

Click Next to continue.

3.2. Deployment Details

Review the deployment details. Click Create to start creating the app file (ViewerApp.app).

Deployment Details
Deployment Details

Wait while the app file is being created.

App file is being created
App file is being created

When the process is finished, a SharePoint Viewer App File is created (ViewerApp.app).

ViewerApp.app file created successfully
ViewerApp.app file created successfully

4. Install the SharePoint App File Manually

Follow these steps to install the ViewerApp.app file on your SharePoint server.

  1. Visit https://{yoursite}.sharepoint.com/sites/AppCatalog/, the internal app catalog site.
  2. Click Distribute apps for SharePoint.
  3. Click (+)new and upload the ViewerApp.app file. This should make the app available for deployment on other sites.
  4. Visite https://{yoursite}.sharepoint.com/_layouts/15/appregnew.aspx (or the same appregnew on any subsite you're deploying to).
  5. Select An app running on a web server.
  6. Fill in the client ID you generated for the web part above.
  7. Choose the generate a client secret. Note this value, it will be needed again as well.
  8. Choose any title you wish (e.g., Dundas BI Viewer).
  9. Fill in the root of your Dundas BI instance for the app domain.
  10. Leave the redirect url blank and pick Create. It should give you a summary of all the info.

Now you can add the app to that particular site:

  1. Visit the site contents from the menu on the left or the gear context menu at the top right.
  2. Click the Add an App icon.
  3. Select the Dundas BI Viewer and agree to trust its very minimal permissions.

The app might take a couple minutes to install. Once it is installed you should be able to add the App Part to your web pages. If you hit the Page tab, start editing and then hit the insert tab you should be able to add app parts.

Once the app part is on the page you can edit the part itself like web parts were edited before. There will be a
property pane on the right and there will be a Dundas BI Properties section. The Dundas BI account and Windows Client
options should work fine without any further configuration, and when being actively edited there should be a project
explorer which appears in place of the app part on the page. You can select the view you want there and then copy the key that is displayed to the Default View Key property on the property pane. Then the app will be the chosen view by default.

The Azure ACS log on option requires more configuration in the Dundas BI app.

  1. The Create Accounts for SharePoint Users should be set to true, at least initially. Once an account is created this doesn't need to be on for the user to log on through this option.
  2. SharePoint Account Group is optional, an existing group may be listed here and newly created accounts from above will be added to this group.
  3. SharePoint Client ID should be set to the client ID you used in appregnew.aspx earlier.
  4. SharePoint Client Secret should be set to the client secret you generated in appregnew.aspx earlier.
  5. SharePoint URL should be set to the SharePoint URL you're using.

5. See also

Dundas Data Visualization, Inc.
500-250 Ferrand Drive
Toronto, ON, Canada
M3C 3G8

North America: 1.800.463.1492
International: 1.416.467.5100

Dundas Support Hours: 7am-6pm, ET, Mon-Fri