IBM Planning Analytics for Microsoft Excel API
You can use the API to create a scheduled batch program to refresh content on a daily, weekly, or monthly basis so that, as your period data changes, the affected files are kept up-to-date.
You can call the API within Microsoft Excel workbooks using VBA or using VBS and a command line interface. For these types of automation to work, you must register one or more macros within the workbook.
If you have IBM® Cognos® Office installed, you can also use the API in Microsoft Word and Microsoft PowerPoint.
When using sample macros and script files as part of your own processing functions, remember that the API is accessible only as user defined functions (UDFs). UDFs are functions created in Visual Basic for Applications (VBA). In this case, however, the UDFs are created within the IBM Cognos solution and are called from VBA.
To help you understand what is possible using this API, several samples are provided. You can use the samples to help you create your own solutions.
- Creating VBA macros
- Passing parameters, leveraging VBS and the command line interface
In addition to these capabilities, you can schedule scripts, either ones that you create or the samples, to run as a batch process at a set time.
To use automation, you must set your macro security to an appropriate level in your Microsoft application. You can set the macro security level using one of the following options depending on your version of Microsoft Office.
- Change the security level of your Microsoft application to medium or low.
- Change the trusted publishers setting of your Microsoft application so that installed add-ins or templates are trusted.
- Planning Analytics for Microsoft Excel API documentation
- Visit https://ibm.github.io/paxapi/ to see the documentation for the Planning Analytics for Microsoft Excel API.
- Report issues
- Any issues or errors related to the Planning Analytics for Microsoft Excel API documentation can be reported in GitHub (https://github.com/IBM/paxapi/issues).