search

IBM / paxapi

This repository hosts the API documentation for IBM Planning Analytics for Microsoft Excel. For full product documentation, please visit the Knowledge Center:
https://www.ibm.com/support/knowledgecenter/SSD29G_2.0.0/kc_gen/com.ibm.swg.ba.cognos.ipa.doc_using_planning_analytics_toc-gen2.html
Apache License 2.0
6 stars 5 forks source link

missing doc for report type collection methods #12

Closed tedphillips closed 4 years ago

tedphillips commented 4 years ago

the accessors on the report collections are not always straightforward, i've seen a few cases where consumers [understandably] did not get the right call pattern.

tedphillips commented 4 years ago

will put the gaps as a series of comments on this item.

will start with some for explorations.

Reporting.Explorations
   Count - count of explorations in active book
   GetAt(sheet) - gets the exploration object on specified sheet name from the active book if it exists.
   GetReports() - gets the collection of exploration objects from the active book
tedphillips commented 4 years ago 
Reporting.QuickReports
     Count - count of Quick Reports in active book
     GetReports() - gets the collection of quick report objects from active book
tedphillips commented 4 years ago 
Reporting.DynamicReports
      GetReports() - gets the collection of dynamic report objects from active book
      GetAt(sheet) - gets the collection of dynamic report objects from the specified sheet name in the active book
      Get(ignored, sheet, id) - gets the dynamic report object from the specified sheet name with the given ID in the active book
tedphillips commented 4 years ago

also, I think we need to clean up mentions of 'Reporting.GetCurrentReport' in the samples with equivalents from these lists, I don't believe that works across the 3 relevant reporting types.

charliele commented 4 years ago

Explorations: https://ibm.github.io/paxapi/#exploration-api-functions

QR: https://ibm.github.io/paxapi/#quick-report-api-functions

DR: https://ibm.github.io/paxapi/#dynamic-report-api-function

tedphillips commented 4 years ago

great start! let's stop there for now and see how feedback goes.