Add and execute IBM Cognos automation API functions
Now that you have set up your environment for the IBM Cognos automation API, it's time to add and execute some API functions.
Double-check the references to the IBM Cognos automation API
You might run into some trouble if you're missing some references to the IBM Cognos
automation API. Let's double check those first.
Procedure
Add your own API functions
You will choose different API functions depending on the tasks that you need to automate.
Fortunately, there are plenty to choose from.
Procedure
- Right-click inside of the Project pane, click . This new module is where you will be adding your own API functions.
- Go to IBM Planning Analytics for Microsoft Excel API. This is where you can find IBM Cognos automation API functions.
- Click Exploration API functions.
- Click Create. This
Create
API function allows you to generate Exploration Views from a combination of host system URL, server name, cube name, and view name. - Copy the example that is in this topic.
- Paste the example into the new module. You may have to adjust the formatting.
- Replace the example host system URL with the one that you are using.
- Replace
Goal Input
withBudget Input Total
. - Save the template.
Results
Execute your API functions
Now that you have your API function added, it's time to execute them.
Procedure
- Click the DEVELOPER tab.
- Click Macros.
- Click Create.
- Click Run.