Oracle Analytics Publisher

Home› Oracle Analytics› Oracle Analytics Forums› Oracle Analytics Cloud and Server› Oracle Analytics Publisher

Categories

Welcome to the Oracle Analytics Community: Please complete your User Profile and upload your Profile Picture

Analysis / Dashboard Download with API

Received Response
66
Views
11
Comments
Vangel
Vangel Rank 2 - Community Beginner
in Oracle Analytics Publisher

Hello,

Is it possible to download an Analysis or Dashboard from Oracle BI using the SOAP API or REST API? I am specifically asking about downloading the actual catalog file, not the output of the analysis.

Any guidance or examples would be greatly appreciated.

Thanks,
Attila

«1

Answers

  • Gianni Ceresa
    Gianni Ceresa Mod
    edited Sep 11, 2025 2:39PM

    Hi,

    The historical SOAP webservice includes one for the catalog that has methods to download objects from the catalog. Or even just get an object content (the XML of the object). Look at the WebCatalogService methods.

    https://docs.oracle.com/middleware/1221/biee/BIEIT/methods.htm#i1009936

    It comes with a WSDL, any SOAP client should be able to generate the required code for a request based on the WSDL definition automatically. Examples would depends on the tools and languages you want to use.

    What do you mean by "actual catalog file" ? While the catalog, in older versions of the product, was indeed files and folders saved on disk, not everything is what is seems to be. Therefore the answer could change based on your definition of "actual catalog file".

  • Vangel
    Vangel Rank 2 - Community Beginner
    https://community.oracle.com/products/oracleanalytics/discussion/comment/70786#Comment_70786

    Hi,

    Thanks for your reply.

    I've been able to download reports (as .xdoz) and data models (as .xdmz) to my local pc using SOAP calls. However, when it comes to Analyses, I haven't found a way to download them.

    What I'm trying to figure out is wheter there's a way to download Analyses objects (the catalog definition itself, not just results/output) in a similar way as with reports and data models. Based on my finding this is not possible through WebCatalogService, is there another approach I should use?

    Thanks,

    Attila

  • Gianni Ceresa
    Gianni Ceresa Mod
    edited Sep 15, 2025 11:48AM

    With the WebCatalogService you can get the XML of any object, including analyses (I used it a lot to read every single catalog object in the past, analyses, dashboards, filters, agents etc.).

    What product (name and version) are you using? Is the "Analyses" the "classic" analysis (not DV, not Publisher)?

    What methods did you try?

  • Vangel
    Vangel Rank 2 - Community Beginner
    edited Sep 16, 2025 12:25PM
    https://community.oracle.com/products/oracleanalytics/discussion/comment/70873#Comment_70873

    I've been using xmlpserver (Oracle Analytics Publisher) to download reports and data models with a script using SOAP API. However Analysis / Dashboards don't appear there, only reports and data models are visible.

    In OTBI, when migrating an Analysis from a development environment to production, we typically archive the Analysis on the dev server and then unarchive it on production. This process generates a .catalog file, which can later be imported into another environment. This process is manual, using the archive / unarchive options in OTBI.

    This is the process that I want to automate with a script, api calls, so we don't have to go into OTBI and archive the analysis manually.

    Question:Is there a way to download OTBI Analysis directly, ideally via a REST API?

    Alternatively, is this somehow possible through the SOAP API?

    I’m not looking for just the XML definition of the object, but rather the full .catalog file that is produced through the Archive option in OTBI.

  • Gianni Ceresa
    Gianni Ceresa Mod
    edited Sep 16, 2025 12:37PM

    Ok, so this depends on what OTBI provides… (I don't have OTBI, all I know is that it is a kind of "old" OBIEE with a number of pre-built subject area for you to use).

    Can you check the WSDL of OTBI (the OBIEE part, not Publisher) to check if the WebCatalogService service has the copyItem2() and pasteItem2() methods?

    These two have a very poor name, but they perform actions like archiving and unarchiving, working with the .catalog as you are asking.

    But I don't remember in what version of the WSDL they were added (assuming they weren't there from day 1).

    They are there in the v7 of the WSDL, and online I saw somebody doing a SOAP API call to OTBI using the v7, therefore, those 2 methods should be there and working on the catalog (not Publisher, the general OTBI catalog).

  • User_B43AT
    User_B43AT Rank 2 - Community Beginner

    @Gianni Ceresa I tried using the copyItem2() method from analytics-ws/saw.dll/wsdl/v6

    <wsdl:operation name="copyItem2"><wsdl:input message="sawsoap:copyItem2In"/><wsdl:output message="sawsoap:copyItem2Out"/></wsdl:operation>

    But the url analytics-ws/saw.dll?SoapImpl=webCatalogService

    returns an internal 500 error.

    Is there any solution available to archive an entire catalog via SOAP?

  • Kevin M-Oracle
    Kevin M-Oracle Rank 6 - Analytics & AI Lead

    I have used this end point: /analytics-ws/saw.dll/wsdl/v12?wsdl

    Then use these methods:

    v12:logon
    v12:copyItem2 --archive
    12:pasteItem2 --unarchive

    Rgds,

    Kevin

  • User_B43AT
    User_B43AT Rank 2 - Community Beginner

    Logon failed with error 403. How did you do it please?

  • Kevin M-Oracle
    Kevin M-Oracle Rank 6 - Analytics & AI Lead

    I used logon, it provided a sessionID, I used that to execute copy2.

    See: Examples of "webCatalogService" Webservice Methods in Oracle Analytics (Doc ID 3018011.1).

    Rgds,

    Kevin

  • User_B43AT
    User_B43AT Rank 2 - Community Beginner
    edited Nov 6, 2025 3:41PM

    I messaged you for more details about this. Can you help pls?

    I cannot use logon for some reason, do you have that part of your code?