May 3, 2023

PowerConnect Service Configuration

After the installation is completed, navigate to the installation folder, and open the copy the conf\settings.sample.yml file to conf\settings.yml. This will allow you to adjust the sample settings without having to start from scratch.

Note: The PowerConnect service needs to be restarted after making changes to the configuration file.

There are three sections in the configuration file: Web Server, Environment, and Connection settings.

Web Server Settings

The settings in this section are applied to the PowerConnect web server.

The following web server settings are in the conf\settings.yml file.

Environment Settings

The settings in this section allow the environments PowerConnect has access to.

At least one environment needs to be added for PowerConnect to work.

You will find the following web server settings in the settings.yml file.

Connection Settings

The settings in this section allow the configuration of individual connections (IBM Planning Analytics instances).

At least one connection needs to be added in order for PowerConnect to work.

You will find the following web server settings in the settings.yml file.

Authentication

PowerConnect supports all IBM Planning Analytics security modes, including IBM Planning Analytics on Cloud and IBM Planning Analytics Local.

The section below shows which configuration options apply to the individual security modes.

In general, PowerConnect uses an administrator account to access IBM Planning Analytics content. This is true for IBM Planning Analytics Local and IBM Planning Analytics on Cloud. This also applies to both Power BI Desktop and Power BI Online.

However, there are differences between Power BI Desktop and Power BI Online, which are described in the two sections below.

Power BI Desktop

The PowerConnect Custom Connector uses OAuth2 to identify the user. The PowerConnect web service uses an administrator account to establish the initial connection, then uses impersonation to enforce the user’s security within IBM Planning Analytics.

Microsoft Power BI Online

Microsoft Power BI Online does not support users authenticating individually. A data source in Microsoft Power BI online is configured with a single set of credentials when using a custom connector.

Testing

To ensure the PowerConnect service is running, a URL can be accessed with a tool, such as a load balancer, to check that the service can be reached.

The URL has the following format:

In case usessl is set to false in the conf\settings.yml file:
http://<powerconnect-server:port

In case usessl is set to true in the conf\settings.yml file:
https://<powerconnect-server:port

The expected JSON response is:
{“status”:”ok”}

This endpoint can also be used to check the health of the PowerConnect service.

Share

Related content

Loading related content