Configuring the PowerConnect App Server

Setting

Definition

Default Value

Valid From Version

Port

Specifies the port the web server is listening. If SSL is used, this port should be changed to 443.

1.0.0

num_workers

Number of threads the web server will be utilizing to fulfill requests.

1.0.0

use_ssl

Specifies if the web server will listen on a secure (https) or unsecure (http) port. SSL certificates need to be supplied in cert.pem and key.pem files, which contain the certificate chain as well as the personal key. The certificates must be signed by certificate authority. Required for IBM Planning Analytics on Cloud

true

1.0.0

client_id

Needed if using OAuth2. The client_id given by Microsoft when the app was registered on Azure AD

2.0.0

client_secret

Needed if using OAuth2. The client_secret given by Microsoft when the app was registered on Azure AD

2.0.0

tenant_id

For single-tenant applications, you will need to set the tenant_id to the application tenant id

common

2.1.0

ensure_secure_connections

specifies if the web server will accept anonymous requests (without OAuth2) or only requests with a valid token (OAuth2). It’s recommended to set this to true. Set it to false only for testing purposes.

true

2.0.0

reset

reset password on the admin platform to default

false

1.2.0

Setting

Definition

Default Value

environments

List of IBM Planning Analytics environments used by PowerConnect

name

Name of the environment, e.g., DEV, UAT, PROD. This names will be showin in the Custom Connector and the Admin Platform.

Setting

Definition

Default Value

Available since

Connections

List of IBM Planning Analytics instances used by PowerConnect

1.0.0

base_url

Fully qualified address or IP address with port number of the IBM Planning Analytics instance. For IBM Planning Analytics on Cloud, please refer to your welcome kit for the URL. This parameter is needed for Basic Auth and PA Cloud

1.0.0

address

Address of the TM1 server without the port and the protocol (you don’t need to specify https://). Used for CAM with SSO and CAM without SSO.

1.0.0

port

Needed when using address. This is the HTTP Port Number of the IBM Planning Analytics instance. Please refer to your tm1s.cfg file for the value

1.0.0

account

Administrator account in IBM Planning Analytics. For IBM Planning Analytics on Cloud, the non-interactive user must be used.

1.0.0

verify

False by default. Required to be True for PA Cloud.

1.0.0

async

Used to avoid HTTP timeouts, required to be set to true for PA Cloud

1.0.0

use_client_attribute_lookup

Used when the client ID in IBM Planning Analytics does not match the users’ email addresses. Should be set to be an alias.

1.0.0

client_lookup_attribute

Must be used with use_client_attribute_lookup. Name of the lookup alias.

1.0.0

use-sso

Set it to true for CAM with SSO. The service account the web server is running under needs to be an admin user in IBM Planning Analytics.

1.0.0

namespace

Used for CAM with and without SSO and PA Cloud connections.

1.0.0

gateway

Used for CAM with SSO

1.0.0

cloud_id_prefix

Used when connecting to PA Cloud. Required to be set to “CAMID(\”pans:u:”

1.0.0

cloud_id_suffix

Used when connecting to IBM Planning Analytics on Cloud. Required to be set to “\”)”.

1.0.0

security_users_subset

Determines if a subset of }Clients should be used instead of the full dimension

false

1.2.0

non_admin_sec_access

Determines wether non admin users can access secured dimension information

false

1.2.0

Include_weigths

Determines whether weights are included when retrieving dimension tables

true

1.0.0

Instance_use_ssl

Determines if the TM1 instance uses SSL

true

2.0.0

dimension_header

It can be set to hierarchy, dimension or both. It will retrieve the header of dimension as the name of the dimension, the virtual hierarchy or a combination of both (e.g. [Hierarchy].[Dimension])

dimension

2.0.0