TMVGate is a RESTful Web Services application that acts as a gateway to IBM Cognos TM1/Planning Analytics (PA) Servers. It is invoked via HTTP or HTTPS URL calls with parameters that determine the security context and how data is extracted from the TM1/PA Server. It uses the TM1 REST API to extract Dimension Subsets, TM1/PA Cube Views or MDX Queries, and transforms them into tabular data before returning them to the requesting application.
The tabular data output format can be in TXT, JSON, XML, HTML, PSV or XML16. These formats are supported by Tableau®, Qlik®, Microsoft Power BI, Microsoft Power Query, Power View and other visualization tools via REST API or Web Data Source.
For reporting with hierarchy, TMVGate supports the extraction of Dimension Subset with Aliases. As TM1/PA Dimensions can be ragged or unbalanced, different fill gap options are provided to fulfill the required hierarchy output data structure.
TMVGate comes with a standalone URL Generator and a User Key Generator. The URL generator (TMVGateURLGenerator.exe) is used to assist you in specifying the required parameters for the creation of Get View URL, View MDX Query, Get Hierarchy URL or POST MDX URLs and the User Key Generator (TMVGateUserKey.exe) is used to generate the secret key when TMVGate Server is configured with UserKey security.
The following sections will walk you through the usage of URL and User Key Generator to extract the desired TM1 data output via TMVGate: