Custom control API to detect saved report output
A new JavaScript API function isSavedOutput()
is added to the scriptable
report APIs. This function is used to detect whether a report is a saved report output.
Some of the scriptable report APIs are invalid in the context of saved report outputs. In previous versions of Cognos® Analytics, these APIs generated errors when they were executed in saved outputs.
Starting with this release, the JavaScript function isSavedOutput() → {Boolean}
can be used when creating custom controls or modifying the report functionality through APIs. This
function returns a Boolean value to identify if the report is a saved output or not. Before calling
a specific function, a client developer can use this new function to check whether the code can be
executed in the saved report output.
The affected APIs include the following functions: back()
,
cancel()
, finish()
, next()
,
reprompt()
. If a saved report output contains the unsupported API, a message is
displayed that the API is not supported in saved report outputs.
The new function is documented in Scriptable Reports (https://ibm.biz/CC_Docs), with the Application interface.