IBM Planning Analytics policy
An IBM® Planning Analytics policy contains the connection details that are used by an IBM Planning Analytics Request node when you connect to the IBM Planning Analytics application.
Use an IBM Planning Analytics Request node to connect to IBM Planning Analytics and issue requests to create, retrieve, update or delete objects such as cell, chores, cubes, dimensions, elements, files, groups, hierarchies, process, and users. The IBM Planning Analytics policy controls, at run time, access to the IBM Planning Analytics application.
The IBM Planning
Analytics policy is created when you
configure a connection between an IBM Planning
Analytics Request
node and IBM Planning
Analytics by using the Connector
Discovery wizard. During the process of discovery, account credentials are stored in the vault and
connection details are stored in an IBM Planning
Analytics
policy. The policy is created with a type of IBM Planning Analytics, and the name
of the policy is returned to the node and specified in the Connection tab, in the format
{policyProjectName}:policyName.
You can also create, update, or delete an IBM Planning Analytics policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy an IBM Planning Analytics policy, all message flows that are using the policy will be stopped and restarted.
For more information about using IBM Planning Analytics, see Using IBM Planning Analytics with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| IBM Planning Analytics Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| IBM Planning Analytics Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| IBM Planning Analytics Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and IBM Planning
Analytics. This value is reserved for future use
and must be set to BASIC_API_KEY. |
| Server URL | apiUrl | Specify the URL for the API server that makes runtime calls. |
| Credential Name | credentialName | The name of your IBM Planning
Analytics account. For example,
ibmplanninganalyticspolicy_IBMPlanningAnalytics1 |