Using the Planning Analytics REST API

To connect QUBEdocs Cloud to your Planning Analytics model you will need to the following

• URL to your TM1 / Planning Analytics instance 
• Username if applicable (this must be a non interactive user if using Planning Analytics on the Cloud, details here. They should also be available in your Welcome Kit)
• Password if applicable
• CAM Namespace if applicable

Authentication Types

You can find out which authentication type you are using for your instance in your TM1s configuration file.

Prerequisites 

For Planning Analytics Local the URL should be the address to your Planning Analytics server and include the HTTPPortNumber from your TM1s configuration file. For example your URL should be similar to https://myserver.com:8000/api/v1

For Planning Analytics Cloud it will look like https://myserver.planning-analytics.ibmcloud.com/tm1/api/servername/api/v1

If using Basic or CAM authentication you must provide a username and the user will need to have read / write access to your model. This is so we can read metadata, run the QUBEdocs Update process and execute MDX Queries. Optionally you can provide a username when using Mixed authentication and it will treat the connection as if was using Basic.

If using Windows Authentication no username (or password) needs to be provided.

For CAM authentication you must provide a CAM namespace, you can find this in Cognos Configuration Manager under Local Configuration Security Active Directory Namespace ID.  If you are using Planning Analytics Cloud your CAM namespace will be by default LDAP.

Connecting with QUBEdocs Cloud

Log into QUBEdocs Cloud and go to the All Models tab, from there click Connect a new model.

Select the API Connection Type from the drop down and then the Authentication Type you wish to connect with (QUBEdocs Cloud supports Basic and CAM authentication). 

Optionally, you can choose to schedule your documentation:

Finally click create.

Connecting with QUBEdocs Local

Log in as the qubedocsManager, select Manage Connections and finally Add Connections (same as creating any other connection). 

Select the new option Planning Analytics API from the Connect With drop down. 

Next, select the Authentication Type that you use with your Planning Analytics server. 

Once you have selected you've filled in the mandatory details you should be able to validate your connectivity by clicking the Validate Connection button at the bottom of the popup. 

Finally click ok.

Once your connection has been setup you will be able to generate documentation as normal.

Similarly to Cloud, a schedule can be set up for connections within QUBEdocs Local. Once you've saved the connection, click the pencil icon to edit your connection.

Your connection settings will appear and at the bottom, the schedule section will be there. Set it to the frequency you'd like to generate documentation.