Skip Headers
Oracle® Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition
11g Release 1 (11.1.1)

Part Number E16364-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Description of Services and Methods in Oracle BI EE Web Services

This chapter describes the services and methods used by the Oracle Business Intelligence Session-Based Web Services.

This document uses JavaScript-like syntax to describes structures. The exact syntax and implementation depends on the SOAP code generation tool and the target language used by your application development environment

This chapter includes the following sections:

3.1 ConditionService Service

Use this service to evaluate Oracle BI EE conditions programatically. This service also allows users to obtain the customizable filters available in a condition.

Table 3-1 shows the supported methods.

Table 3-1 ConditionService Methods

Method Name Description

Section 3.1.1, "evaluateCondition() Method"

Evaluates a condition saved to the catalog.

Section 3.1.2, "evaluateInlineCondition() Method"

Evaluate a condition supplied as a parameter.

Section 3.1.3, "getConditionCustomizableReportElements() Method"

Obtains the customizable filters of a condition saved to the catalog.


3.1.1 evaluateCondition() Method

Use this method to evaluate a Condition that is stored in the catalog. This method returns an XML string containing the result of the condition (true or false).

3.1.1.1 Signature

boolean evaluateCondition(String path, String[] reportCustomizationParameters, String sessionID);

Arguments Description

String path

Specifies the full path and name of the Condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget.

String [] reportCustomizationParameters

Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.1.2 evaluateInlineCondition() Method

Use this method to evaluate a condition defined outside of Oracle BI EE Presentation Services. The Condition XML is supplied in the conditionXML parameter. This method returns an XML string with the result of the condition evaluation, true or false.

3.1.2.1 Signature

boolean evaluateInlineCondition(String conditionXML, String[] reportCustomizationParameters, String sessionID);

Arguments Description

String conditionXML

Specifies the Condition XML. This XML is validated against the condition schema available in orahome/bifoundation/web/schemas/condition.xsd.

String[] ListreportCustomizationParameters

Specifies the customization parameters XML, which is only used if the Condition has customizable filters. This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.1.3 getConditionCustomizableReportElements() Method

Use this method to determine the customizable filters available in a condition that is stored in the catalog. This method returns an XML string containing the definition of the customizable filters available in the condition. The XML is in the format defined in the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.xsd.

3.1.3.1 Signature

String[] getConditionCustomizableReportElements(String path, String sessionID);

Arguments Description

String path

Specifies the full path and name of the condition in the catalog. For example, /users/jchan/Conditions/IsRegionUnderBudget.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2 HtmlViewService Service

Use this service to embed Oracle BI EE HTML results in third-party dynamic web pages, such as Active Server Pages (ASP) or JavaServer Pages (JSP), and portal frameworks. The embed process merges Oracle BI EE web services content with the content of third-party web pages.

Table 3-2 shows the supported methods.

Table 3-2 HtmlViewService Methods

Method Name Description

Section 3.2.2, "addReportToPage() Method"

Adds results to an HTML page.

Section 3.2.3, "endPage() Method"

Destroys a server page object and all data associated with it.

Section 3.2.4, "getCommonBodyHTML() Method"

Retrieves HTML to include in the <BODY> section.

Section 3.2.5, "getHeadersHTML() Method"

Retrieves HTML to include in the <HEAD> section.

Section 3.2.6, "getHtmlforPageWithOneReport() Method"

Retrieves HTML for a page that contains only one analysis.

Section 3.2.7, "getHTMLForReport() Method"

Retrieves HTML to display a particular set of results.

Section 3.2.8, "setBridge() Method"

Specifies a bridge URL to receive communications. Can be useful when the Oracle Business Intelligence web services server and the Presentation Services that the user is accessing reside on different machines or when you want to modify the results in your application development environment.

Section 3.2.9, "startPage() Method"

Creates a new page object and returns its ID.


The methods in the HTMLViewService service extract fragments of HTML code that can be inserted in third-party web pages. Table 3-3 describes the HTML code excerpts and desired page locations.

Table 3-3 HTML Code Fragments and Page Locations for the HtmlViewService Service

HTML Code Fragment Desired Page Location

Header

Should be inserted in the <HEAD> section of an HTML page. The code contains links to common JavaScript files and style sheets.

Report Objects

Can be inserted anywhere in the <BODY> section.

Common Body

Should be inserted in the <BODY> tag after all analysis links. The code contains hidden HTML elements that are used to implement drilldown links.


For each returned analysis object, the HTML code fragment contains a callback link that is followed automatically when the web page is loaded by the browser. The code fragment does not contain the full user interface definition of the analysis. While the analysis is being constructed by Oracle BI EE Presentation Services, the interface displays the Oracle BI EE web services "Searching..." image embedded on the third-party web page.

For smooth analysis transitioning, Oracle BI EE Presentation Services tracks the Oracle Business Intelligence analyses that have been added to third-party web pages by maintaining information in an internal logical page object during the construction of the third-party web page. The HtmlViewService service methods explicitly refer to the internal logical page by its ID.

3.2.1 About HtmlViewService Bridging and Callback URLs

To embed an analysis with active drilldown links, the HtmlViewService service allows the web browser to issue callback requests from embedded analyses to the Oracle BI EE Presentation Services server. Although it is possible to route requests directly to the Oracle BI EE Presentation Services server, in many cases it is preferable to route requests through the Oracle BI EE instance that originally serviced the third-party page. Also, in situations where Oracle BI EE Presentation Services and the third-party web server do not belong to the same Domain Name Service (DNS) domain, users may get JavaScript errors related to browser security constraints for cross-domain scripting.

To avoid these issues, use the setBridge() method to modify callback URLs to point to the third-party web server. Be aware that a web component executed by the third-party web server to re-route requests to Oracle BI EE Presentation Services is not provided. This function would need to be fulfilled by the third-party application. For more information about the setBridge() method, see Section 3.2.8, "setBridge() Method".

3.2.2 addReportToPage() Method

Use this method to add results to an HTML page.

3.2.2.1 Signature

void addReportToPage(String pageID, String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions options, String sessionID);

Arguments Description

String pageID

Specifies a character string page ID returned by the startPage() method. For information about the startPage () method, see Section 3.2.9, "startPage() Method".

String reportID

Specifies a character string that identifies the analysis containing the results to add to the page. It should be used to reference this analysis in subsequent method invocations; for example, corresponding user interface elements generated by the Oracle Business Intelligence Presentation Services server would reference the same ID.

ReportRef report

Specifies the analysis definition, supplied in the ReportRef structure.

String reportViewName

Specifies the view to display. If this parameter is null, the analysis' default view is used. The view name should match the one used to identify the view in the analysis XML definition.

ReportParams reportParams

Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure.

For more information, see Section 3, "Description of Services and Methods in Oracle BI EE Web Services".

ReportHTMLOptions options

Optional. Specifies the display options to apply to the analysis after execution, supplied in the ReportHTMLOptions structure. For more information, see Section 2.27, "QueryResults Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.3 endPage() Method

Use this method to destroy the Oracle BI EE Presentation Services server page object and all data associated with it.

3.2.3.1 Signature

void endpage(String pageID, String sessionID);

Arguments Description

String pageID

Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method").

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.4 getCommonBodyHTML() Method

Use this method to retrieve HTML to include in the <BODY> section.

3.2.4.1 Signature

String getCommonBodyHTML(String pageID, String sessionID);

Arguments Description

String pageID

Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method").

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.4.2 Returns

Returns a string containing the HTML to include in the <BODY> section.

3.2.5 getHeadersHTML() Method

Use this method to retrieve HTML to include in the <HEAD> section.

3.2.5.1 Signature

String getHeadersHTML(String pageID, String sessionID);

Arguments Description

String pageID

Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method").

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.5.2 Returns

Returns a string containing the HTML to include in the <HEAD> section.

3.2.6 getHtmlforPageWithOneReport() Method

Use this method to retrieve the HTML for a page that contains only one analysis. A page that contains only one analysis does not have <BODY> and <HEAD> sections.

3.2.6.1 Signature

String getHtmlForPageWithOneReport(String reportID, ReportRef report, String reportViewName, ReportParams reportParams, ReportHTMLOptions reportOptions, StartPageParams pageParams, String sessionID);

Arguments Description

String pageReportID

Specifies the analysis ID returned by the getHtmlForPageWithOneReport() method.

For information about the addReportToPage method, see Section 3.2.2, "addReportToPage() Method".

ReportRef report

Specifies the analysis definition, supplied in the ReportRef structure.

String reportViewName

Specifies the view to display. If this parameter is null, the analysis' default view is used. The view name should match the one used to identify the view in the analysis XML definition.

ReportParams reportParams

Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure.

For more information, see Section 3, "Description of Services and Methods in Oracle BI EE Web Services".

ReportHTMLOptions reportOptions

Optional. Specifies the display options to apply to the analysis after execution, supplied in the ReportHTMLOptions structure. For more information, see Section 2.27, "QueryResults Structure".

StartPageParams pageParams

Specifies the options to use when starting the page, supplied in the StartPageParams structure. For information about the StartPageParams structure, see Section 2.38, "StartPageParams Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.7 getHTMLForReport() Method

Use this method to retrieve an HTML excerpt to display the results for a particular analysis. Before invoking this method, use the addReportToPage method to add the results to an HTML page.

3.2.7.1 Signature

String getHTMLForReport(String pageID, String pageReportID, String sessionID);

Arguments Description

String pageID

Specifies the ID of the page object, which is returned by the startPage() method (for more information, see Section 3.2.9, "startPage() Method").

String pageReportID

Specifies the analysis ID returned by the addReportToPage() method.

For information about the addReportToPage method, see Section 3.2.2, "addReportToPage() Method".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.7.2 Returns

Returns a string containing the HTML excerpt that displays the specified analysis.

3.2.8 setBridge() Method

Use this method to specify a bridge URL to receive communications. Specifying a bridge URL can be useful when the Oracle BI EE web services server and the user's web server reside on different machines, or when you want to modify the results in your application development environment.

After the setBridge() method is called, all requests from the client browser to the Oracle BI EE Presentation Services server are sent to the bridge URL, which then forwards requests to the Oracle BI EE Presentation Services server.

3.2.8.1 Signature

setBridge(String bridge, String sessionID);

Arguments Description

String bridge

Specifies the bridge URL. For example,

http://myserver/myapplication/sawbridge

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.8.2 Usage

You must make sure that the client browser provides a handler to the bridge URL in the form of a Java servlet, an Active Server Pages (ASP) page, a Common Gateway Interface (CGI), an Internet Server application programming interface (ISAPI), or an equivalent application.

You must also perform the following tasks:

  • Decode the path of the requested Oracle BI EE web services resource in the RedirectURL argument of the request character string. For information about the RedirectURL argument, see Section 3.2.8.3, "How Callback URLs Are Replaced".

  • Forward all other request arguments, together with all headers and the request body, to the bridge URL.

  • Copy the response from the Oracle BI EE Presentation Services server to the response stream.

3.2.8.3 How Callback URLs Are Replaced

The new callback URL is based on the bridge URL, with the addition of a RedirectURL argument. The value of the RedirectURL argument should be the original value of the URL, encoded using standard URL encoding rules.

Internally, Oracle BI EE web services usually uses relative URLs for callback links. For example, if the original callback link is saw.dll?Go and the bridge URL is

http://myserver/myapplication/sawbridge

then the new callback URL is

http://myserver/myapplication/sawbridge?RedirectURL=saw.dll%3fGo

3.2.9 startPage() Method

Use this method to create a page object and returns its ID.

3.2.9.1 Signature

String startPage(StartPageParams options, String sessionID);

Arguments Description

StartPageParams options

Specifies the options to use when starting the page, supplied in the StartPageParams structure. For information about the StartPageParams structure, see Section 2.38, "StartPageParams Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.2.9.2 Returns

Returns a string containing the Oracle Business Intelligence Presentation Services page ID.

3.3 iBotService Service

Use this service to save, edit, delete, subscribe, unsubscribe, customize, and execute Oracle BI EE agents. Note that as of the Oracle Business Intelligence 11g (11.1.1) release, "iBots" have been renamed to "agents."

Table 3-4 shows the supported methods.

Table 3-4 iBotService Methods

Method Names Description

Section 3.3.1, "writeIBot() Method"

Writes a new agent into the catalog and registers it with Oracle BI Scheduler.

Section 3.3.2, "deleteIBot() Method"

Deletes an agent from the catalog and deregisters it from the Oracle BI Scheduler.

Section 3.3.3, "executeIBotNow() Method"

Executes an agent saved in the catalog.

Section 3.3.4, "moveIBot() Method"

Moves an agent from one catalog folder to another.

Section 3.3.5, "sendMessage() Method"

Sends a message to an Oracle BI EE user, group, or user and group.

Section 3.3.6, "subscribe() Method"

Subscribes to a published agent. Also customizes your subscription.

Section 3.3.7, "unsubscribe() Method"

Unsubscribes from an agent.


3.3.1 writeIBot() Method

Use this method to write a new agent to the catalog and to register it with Oracle BI Scheduler. Note that this method is different from the WebCatalogService service's "writeObjects() Method", which only writes to the catalog.

3.3.1.1 Signature

int writeIBot (CatalogObject obj, String path, boolean resolveLinks, boolean allowOverwrite, String sessionID);

Arguments Description

CatalogObject obj

Specifies the object to be written to the catalog. The object's XML is validated against analysis_ibot.xsd, which is located in orahome/bifoundation/web/schemas directory.

String path

Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars.

boolean resolveLinks

If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link.

boolean allowOverwrite

Specifies whether to overwrite an existing object. Set to TRUE to overwrite any object already present in the location specified by "path."

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.2 deleteIBot() Method

Use this method to delete a saved agent. Deleting an agent not only removes it (the object) from the catalog, but it also deregisters the agent from the Oracle BI Scheduler. Note that this method is different from the "WebCatalogService Service" "deleteitem" method because the "deleteitem" method does not deregister the agent from the Oracle BI Scheduler.

3.3.2.1 Signature

void deleteIBot (String path, String sessionID);

Arguments Description

String path

Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.3 executeIBotNow() Method

Use this method to execute an agent that is stored in the catalog. Note that this method does not change the agent's original schedule.

3.3.3.1 Signature

void executeIBotNow(String path, String sessionID);

Arguments Description

String path

Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.4 moveIBot() Method

Use this method to move an agent from one catalog folder to another. Note that this method is different from the "WebCatalogService Service" "moveItem" method because the "moveItem" method moves the catalog object and informs the Oracle BI Scheduler that the object was moved.

3.3.4.1 Signature

void moveIBot(String fromPath, String toPath, boolean resolveLinks, boolean allowOverwrite, String sessionID);

Arguments Description

String fromPath

Specifies the full catalog path of the agent to be moved.

String toPath

Specifies the full catalog path where the agent is moved to.

boolean resolveLinks

Specifies if you want to move the child objects. If this argument is set to TRUE and the path specified in the "fromPath" argument is a link, then the child object pointed to by that link is moved.

boolean allowOverwrite

Specifies if you want to overwrite an existing object. If this argument is set to TRUE and another catalog object existed in the path specified by "toPath", it is overwritten.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.5 sendMessage() Method

Use this method to send a message to a Oracle BI EE user, group, or user and group. The message is delivered according to the corresponding recipient's delivery profile, which was set up in the "My Account dialog" in Oracle BI Presentation Services.

3.3.5.1 Signature

String sendMessage(String[] recipient, String[] group, String subject, String body, String priority, String sessionID);

Arguments Description

String[] recipient

Specifies the GUID of the Oracle BI EE user to whom you want to send the message. You can include more than one user in this argument.

String[] group

Specifies the GUID of the Oracle BI EE group to whom you want to send the message. You can include more than one group in this argument.

String subject

Specifies the subject line of the message.

String body

Specifies the text to be included in the body of the message.

String priority

Specifies the message's priority. You can specify "High," "Normal," or "Low."

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.6 subscribe() Method

Use this method to subscribe to a published agent. If the agent allows customization, then you can also specify the customization XML.

3.3.6.1 Signature

void subscribe(String path, String customizationXml, String sessionID);

Arguments Description

String path

Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars.

String customizationXml

Specifies the customization XML (only if the agent allows customizations). This XML is validated against the customization schema available in orahome/bifoundation/web/schemas/analysis_customization.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.3.7 unsubscribe() Method

Use this method to unsubscribe from an agent. This method also deletes any user customizations.

3.3.7.1 Signature

void unsubscribe(String path, String sessionID);

Arguments Description

String path

Specifies the full path and name of the agent in the catalog. For example, /users/jchan/iBots/BrandDollars.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4 JobManagementService Service

Use this service to execute marketing segmentation and list generation functionality.

Table 3-5 shows the supported methods.

Table 3-5 JobManagementService Methods

Method Name Description

Section 3.4.1, "cancelJob() Method"

Cancels a running marketing job.

Section 3.4.2, "deleteResultSet() Method"

Deletes a saved result set.

Section 3.4.3, "getCounts() Method"

Generates the count numbers for a segment or segment tree.

Section 3.4.4, "getJobInfo() Method"

Gets status and detailed information about a marketing job.

Section 3.4.5, "getPromptedColumns() Method"

Returns prompted columns for a segment or segment tree.

Section 3.4.6, "prepareCache() Method"

Caches a segment or segment tree for list export.

Section 3.4.7, "purgeCache() Method"

Purges the whole cache, entries for a segment, or entries for the segment tree.

Section 3.4.8, "saveResultSet() Method"

Saves a list of members based on the most recent updated counts.

Section 3.4.9, "writeListFiles() Method"

Generates a list for list export, segment campaign load, or segment tree campaign load.


3.4.1 cancelJob() Method

Use this method to cancel a running marketing job.

3.4.1.1 Signature

JobInfo cancelJob(BigInteger jobID, String sessionID);

Arguments Description

BiInteger jobID

Specifies the marketing job ID.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.2 deleteResultSet() Method

Use this method to delete one or more saved results sets of target-level objects identified by a list of GUID values belonging to the specified segment.

3.4.2.1 Signature

JobInfo deleteResultSet(String targetLevel, ArrayOfGUIDs guiDs, String segmentPath, String sessionID);

Arguments Description

String targetLevel

Specifies the target level of the saved results set.

ArrayOfGUIDs guiDs

Specified a list of GUIDs representing the saved result set. For information on the ArrayOfGUIDs structure, see Table 2-6, "ArrayofGUIDS Structure Fields".

String segmentPath

Specifies the path to the segment.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.3 getCounts() Method

Use this method to generate the count numbers for either a segment or a segment tree.

3.4.3.1 Signature

JobInfo getCounts(String segmentPath, String treePath, SegmentationOptions segmentationOptions, String sessionID);

Arguments Description

String segmentPath

Specifies the path to the segment. Used when getCounts is performed on a segment.

String treePath

Specifies the path to the segment tree. Used when getCounts is performed on a segment tree.

Segmentation
Options

Specifies the segment and segment tree override options supplied in the SegmentationOptions structure. These options are used instead of the segment or segment tree defaults as specified in the Oracle Marketing Analytics user interface. For more information about the SegmentationOptions structure, see Section 2.36, "SegmentationOptions Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.4 getJobInfo() Method

Use this method to get the status and detailed job information about a marketing job.

3.4.4.1 Signature

JobInfo getJobInfo(BigInteger jobID, String sessionID);

Arguments Description

BigInteger jobID

Specifies the marketing job ID.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.5 getPromptedColumns() Method

Use this method to return prompted columns for a segment or segment tree.

3.4.5.1 Signature

PromptedColumnInfo getPromptedColumns(String segmentPath, String treePath, String sessionID);

Arguments Description

String segmentPath

Specifies the path to the segment. Used when getPromptedColumns is performed on a segment.

String treePath

Specifies the path to the segment tree. Used when gePromptedColumns is performed on a segment tree.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.6 prepareCache() Method

Use this method to cache a segment or segment tree for list export.

3.4.6.1 Signature

JobInfo prepareCache(String segmentPath, String treePath, Boolean refresh, String sessionID);

Arguments Description

String segmentPath

Specifies the path to the segment. Used when prepareCache is performed on a segment.

String treePath

Specifies the path to the segment tree. Used when prepareCache is performed on a segment tree.

Boolean refresh

If set to TRUE, then the system populates cache entries on cache hits and populates cache entries on cache misses.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.7 purgeCache() Method

Use this method to purge the whole cache, purge entries for a segment from the cache, or purge entries for the segment tree from the cache.

3.4.7.1 Signature

JobInfo purgeCache(String segmentPath, String treePath, Boolean ignoreCacheRef, String sessionID);

Arguments Description

String segmentPath

Specifies the path to the segment.Used when purgeCache is performed on a segment.

String treePath

Specifies the path to the segment tree. Used when purgeCache is performed on a segment tree.

Boolean ignoreCacheRef

If set to TRUE, the system purges the cache entries that are currently used and referenced by segments, segment trees, expired cache entries, and non-existent cache-entries.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.8 saveResultSet() Method

Use this method to save a list of members that qualify for the segment or segment tree based on the most recent updated counts. The system extracts and saves the members to the segment path that you specify.

3.4.8.1 Signature

JobInfo saveResultSet(String segmentPath, TreeNodePath treeNodePath, String savedSegmentPath, SegmentationOptions segmentationOptions, String srCustomLabel, Boolean appendStaticSegment, String sessionID);

Arguments Description

String segmentPath

Specifies the path to the segment.

TreeNodePath treeNodePath

Specifies the segment tree path and branch ID number.

String savedSegmentPath

Specifies the path and name of the new segment where the system extracts and saves the resulting members.

Segmentation
Options segmentation
Options

Specifies the segment and segment tree override options supplied in the SegmentationOptions structure. These options are used instead of the segment or segment tree defaults as specified in the Oracle Marketing Analytics user interface. For more information about the SegmentationOptions structure, see Section 2.36, "SegmentationOptions Structure".

String srCustomLabel

Specifies the custom label for creating a static segment.

Boolean appendStaticSegment

Specifies a flag to create a static segment entry under the same saved segment path.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.4.9 writeListFiles() Method

Use this method to generate lists for list export, segment campaign load, or segment tree campaign load.

3.4.9.1 Signature

JobInfo writeListFiles(ReportRef report, ReportParams reportParams, String segmentPath, TreeNodePath treeNodePath, SegmentationOptions segmentationOptions, String filesystem, BigInteger timeout, String sessionID);

Arguments Description

ReportRef report

Specifies the analysis reference definition supplied in the ReportRef structure. For more information about the ReportRef structure, see Section 2.30, "ReportRef Structure".

ReportParams reportParams

Specifies the filters or variables to apply to the analysis before execution. This information is supplied in the ReportParams common structure. For more information about the ReportParams structure, see Section 2.29, "ReportParams Structure".

String segmentPath

Specifies the path to the segment.

TreeNodePath treeNodePath

Specifies the segment tree path and branch ID.

SegmentationOptions segmentationOptions

Specifies the segment and segment tree override options supplied in the SegmentationOptions structure. These options are used instead of the segment or segment tree defaults as specified in the Oracle Marketing Analytics user interface. For more information about the SegmentationOptions structure, see Section 2.36, "SegmentationOptions Structure".

String filesystem

Specifies the path to the shared directory that contains list files.

BigInteger timeout

Specifies the time out value. This is always set to 0.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.5 KPIAssessmentService Service

Note:

This service applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10".

Use this service to provide methods for assessing KPIs. Table 3-6 shows the supported methods.

Table 3-6 KPIAssessmentService Methods

Method Names Description

Section 3.5.1, "executeKPI() Method"

Requests assessments for the specified KPIs.

Section 3.5.2, "executeKPIDimensionLOVQuery() Method"

Retrieves a list of values for the specified KPI's dimension.

Section 3.5.3, "generateDrillTo() Method"

Generates an Oracle Business Intelligence report containing a detail report for the specified KPI.

Section 3.5.4, "getKPIWatchlistDimensions() Method"

Returns the list of dimensions used by the KPIs in the Watchlist.


3.5.1 executeKPI() Method

Use this method to request assessments for the specified KPIs.

3.5.1.1 Signature

KPIResultSet executeKPI(Array KPIRequests, Array KPIColumnNames, Array Variables, Boolean UseAsyncService, Boolean Fresh, String sessionID);

Arguments Description

KPIRequest[] KPIRequests

Specifies KPIRequest structure objects defining the KPIs you want assessments for. For more information, see Section 2.19, "KPIRequest Structure".

String[] KPIColumnNames

Specifies an array of strings from the KPIColumnName enumeration. For more information, see Section 2.17, "KPIColumnName Enumeration"

Variable[] Variables

(Optional) Specifies an array of Variable objects that you want to apply in the query. For more information, see Section 2.44, "Variable Structure".

Boolean UseAsyncService

Specifies whether to use the asynchronous version of the KPI Assessment Service (true) or not (false).

Boolean Fresh

(Optional) Specifies whether the assessments should be freshly retrieved (true) or whether cached values suffice (false).

String SessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.5.2 executeKPIDimensionLOVQuery() Method

Use this method to retrieve the list of values for the specified KPI's dimension.

3.5.2.1 Signature

KPIDimensionLOVQueryResult KPIDimensionLOVQuery(Integer RowsPerFetch, String KPIPath, String DimensionID, String SessionID);

Arguments Description

Integer RowsPerFetch

Specifies the maximum number of values you want to retrieve.

String KPIPath

Specifies the catalog path to the KPI you are interested in.

String DimensionID

Specifies the ID of the dimension you are interested in.

String SessionID

Specifies the SessionID that you want to use in the SOAP request.

If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.5.3 generateDrillTo() Method

Use this method to call the KPI Engine's generateDrillTo web service method which is responsible for generating a Oracle Business Intelligence report containing a detail report for the specified KPI.

3.5.3.1 Signature

DrillToReportURLResult generateDrillTo(Object KpiRequest, String ReportPath, Array Variables, String sessionID);

Arguments Description

Object KPIRequest

Specifies the KPIRequest structure objects containing the pinnings. For more information, see Section 2.19, "KPIRequest Structure".

String ReportPath

Specifies the Presentation Services catalog path where the generated report should be saved.

Variable[] Variables

Specifies an array of Variable objects that you want to apply in the query. For more information, see Section 2.44, "Variable Structure".

String sessionID

Specifies the SAW Session ID. This parameter can usually be omitted as the session ID is stored in a cookie.


3.5.4 getKPIWatchlistDimensions() Method

Use this method to retrieve the superset of dimensions used by the KPIs in the specified KPI Watchlist.

3.5.4.1 Signature

KPIWatchlistDimensions KPIWatchlistDimensions(String WatchlistPath, String WatchListXML, Boolean GetFresh, Session sessionID);

Arguments Description

String WatchlistPath

Specifies the catalog path to the KPI Watchlist you are interested in.

String WatchListXML

Specifies the KPI Watchlist catalog XML containing unsaved metadata.

Session sessionID

(Optional) Specifies the SAW Session ID. This parameter can usually be omitted as the session ID is stored in a cookie.


3.6 MetadataService Service

Use this service to retrieve descriptions of Oracle Business Intelligence Presentation Services schema objects, such as columns, tables, and subject areas.

Table 3-7 shows the supported methods.

Table 3-7 MetadataService Methods

Method Names Description

Section 3.6.1, "clearQueryCache() Method"

Clears the query cache.

Section 3.6.2, "describeColumn() Method"

Retrieves column information for a specified column in a specified subject area and table.

Section 3.6.3, "describeSubjectArea() Method"

Retrieves subject area information for a specified subject area.

Section 3.6.4, "describeSubjectAreaWithSort() Method"

Retrieves subject area information for a specified subject area in the specified sort order.

Section 3.6.5, "describeTable() Method"

Retrieves table information for a specified table in a specified subject area.

Section 3.6.6, "describeTableWithSort() Method"

Retrieves table information for a specified table in a specified subject area in the specified sort order (of their names).

Section 3.6.7, "getSubjectAreas() Method"

Retrieves the list of subject areas available.

Section 3.6.8, "getSubjectAreasWithSort() Method"

Retrieves the list of subject areas available in the specific sort order.

Section 3.6.9, "reloadLogConfiguration() Method"

Forces changes to logging configuration to take effect without manually restarting Oracle BI Presentation Services.


3.6.1 clearQueryCache() Method

Use this method to clear the query cache.

3.6.1.1 Signature

boolean clearQueryCache(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.2 describeColumn() Method

Use this method to retrieve column information for a specified column in a specified subject area and table.

3.6.2.1 Signature

SAColumn describeColumn(String subjectAreaName, String tableName, String columnName, String sessionID);

Arguments Description

String subjectAreaName

Specifies the subject area to be queried.

String tableName

Specifies the table to be queried.

String columnName

Specifies the name of the column to be queried.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.2.2 Returns

Returns an SAColumn Object. For information on the SAColumn structure, see Section 2.31, "SAColumn Structure".

3.6.3 describeSubjectArea() Method

Use this method to retrieve subject area information about the specified subject area.

3.6.3.1 Signature

SASubjectArea describeSubjectArea (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);

Arguments Description

String subjectAreaName

Specifies the subject area to be queried.

SASubjectAreaDetails detailsLevel

Specifies the information to be retrieved about the subject area. For information on the SASubjectAreaDetails structure, see Section 3.6.3.2, "SASubjectAreaDetails Values".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.3.2 SASubjectAreaDetails Values

Use this method to specify what information should be retrieved about the subject area. Table 3-8 lists the available values.

Table 3-8 SASubjectAreaDetails Values

Values Description

IncludeTables

Include table list with minimum information about each table.

IncludeTablesAndColumns

Include full table and column information.

Minimum

Do not include table and column information.


3.6.3.3 Returns

Returns an SASubjectArea Object (for more information, see Section 2.32, "SASubjectArea Structure").

3.6.3.4 Usage

Depending on the value of the detailsLevel parameter, the returned object contains the information specified in Table 3-9.

Table 3-9 detailsLevel Values

Value of detailsLevel Description

IncludeTables

Specifies that the tables field is not null and contains the collection of tables for this subject area. Each table object has the columns field set to null.

InludeTablesAndColumns

Specifies that the tables field is not null and contains the collection of tables for this subject area. For each table object the columns field contains the corresponding collection of columns.

Minimum

Specifies that the table list is not available. The tables field in the resulting subject area object is null.


3.6.4 describeSubjectAreaWithSort() Method

Note:

This method applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10".

Use this method to retrieve subject area information about the specified subject area in the specified sort order.

3.6.4.1 Signature

SASubjectArea describeSubjectAreaWithSort (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);

Arguments Description

String subjectAreaName

Specifies the subject area to be queried.

SASubjectAreaDetails detailsLevel

Specifies the information to be retrieved about the subject area. For information on the SASubjectAreaDetails structure, see Section 3.6.3.2, "SASubjectAreaDetails Values".

String sortOrder

Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z) , and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).

String sortOrderCaseSensitive

Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.4.2 Returns

Returns an SASubjectArea Object (for more information, see Section 2.32, "SASubjectArea Structure") with tables returned in the specified sort order.

3.6.5 describeTable() Method

Use this method to retrieve table information for a specified table in a specified subject area.

3.6.5.1 Signature

SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sessionID);

Arguments Description

String subjectAreaName

Specifies the subject area to be queried.

String tableName

Specifies the table to be queried.

SATableDetails detailsLevel

Specifies the information to retrieve about the table. For information on the SATableDetails structure, see Section 3.6.5.2, "SATablesDetails Values".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.5.2 SATablesDetails Values

Used to specify the information to retrieve about the table. Table 3-10 lists the available values.

Table 3-10 SATableDetails Values

Values Description

IncludeColumns

Populate the columns field in the SATable Object.

Minimum

Do not include column information. The columns field in the SATable Object is set to null.


3.6.5.3 Returns

Returns an SATable Object. For information on the SATable structure, see Section 2.33, "SATable Structure".

3.6.6 describeTableWithSort() Method

Note:

This method applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10".

Use this method to retrieve table information for a specified table in the specified sort order (of their names).

3.6.6.1 Signature

SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sortOrder, String sortOrderCaseSensitive, String sessionID);

Arguments Description

String subjectAreaName

Specifies the subject area to be queried.

String tableName

Specifies the table to be queried.

SATableDetails detailsLevel

Specifies the information to retrieve about the table. For information on the SATableDetails structure, see Section 3.6.5.2, "SATablesDetails Values".

String sortOrder

Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z) , and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).

String sortOrderCaseSensitive

Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.6.2 Returns

Returns an SATable Object with columns in the specified sort order. For information on the SATable structure, see Section 2.33, "SATable Structure".

There is a fixed order for column types. This fixed sort order is:

  • Nested folders

  • Measures

  • Attributes

  • Hierarchies

3.6.7 getSubjectAreas() Method

Use this method to retrieve the list of subject areas that are available.

3.6.7.1 Signature

List[] getSubjectAreas(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.7.2 Returns

Returns an array of SASubjectArea objects. For information on the SASubjectArea structure, see Section 2.32, "SASubjectArea Structure".

3.6.7.3 Usage

SASubjectArea objects returned by this method do not have table information available. The tables field is null. The approach to querying at all levels is to use getSubjectAreas() to retrieve the list of subject areas and then use describeSubjectArea() to retrieve the list of tables. Next, use describeTable() to retrieve the list of columns in a specified table, and finally, use describeColumn() to retrieve information on a specified column.

3.6.8 getSubjectAreasWithSort() Method

Note:

This method applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10".

Use this method to retrieve the list of subject areas that are available in the specific sort order.

3.6.8.1 Signature

List[] getSubjectAreasWithSort(String sortOrder, String sortOrderCaseSensitive, String sessionID);

Arguments Description

String sortOrder

Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z) , and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).

String sortOrderCaseSensitive

Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.6.8.2 Returns

Returns an array of SASubjectArea objects returned in the specified sort order. For information on the SASubjectArea structure, see Section 2.32, "SASubjectArea Structure".

3.6.8.3 Usage

SASubjectArea objects returned by this method do not have table information available. The tables field is null. The approach to querying at all levels is to use getSubjectAreasWithSort() to retrieve the list of subject areas and then use describeSubjectAreaWithSort() to retrieve the list of tables. Next, use describeTableWithSort() to retrieve the list of columns in a specified table, and finally, use describeColumn() to retrieve information on a specified column.

3.6.9 reloadLogConfiguration() Method

Use this method to force changes to logging configuration to take effect without manually restarting Oracle BI Presentation Services.

3.6.9.1 Signature

boolean reloadLogConfiguration(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.7 ReplicationService Service

Use this service to provide catalog replication methods.

Table 3-11 shows the supported methods.

Table 3-11 ReplicationService Methods

Method Names Description

Section 3.7.3, "Import() Method"

Import changes from the log file.

Section 3.7.4, "export() Method"

Exports catalog changes to a specified log file.

Section 3.7.5, "markForReplication() Method"

Change the "replicable" flag on a specified folder and its descendants.

Section 3.7.6, "purgeLog() Method"

Cleans the specified logs.


3.7.1 ExportFlags Enumeration

This enumeration specifies the changes to export during export methods. Table 3-12 lists the values in this enumeration.

Note:

Only one of the fields in ExportFlags should be populated.

Table 3-12 ExportFlags Enumeration Values

Method Names Description

String processAllChanges

Specifies that you want to export flags that were changed in a given directory on the LOCAL computer and on REMOTE computers, after first referring to the replication logs to find out what changes were made (combines processLocalChanges and processRemoteChanges).

String processAll_ForMerge

Specifies how you want to manage conflicts in items that already exist.

If the item exists and the export item's last modified time stamp for the export item is greater than the existing item's time stamp, then the existing item is replaced.

If the item exists and the export item's last modified time stamp for the export item is less than the existing item's time stamp, then the existing item is not replaced.

String processAll_ForReplace

Specifies that you want to use the export items regardless of both the export and existing items' timestamps.

String processAll_ForWriteIfNotExists

Specifies that if any items included in the export exist, they will not be replaced.

String processLocalChanges

Specifies that you want to export flags that were changed in a given directory on the LOCAL computer, after first referring to the replication logs to find out what changes were made.

String processRemoteChanges

Specifies that you want to export flags that were changed in a given directory on REMOTE computers, after first referring to the replication logs to find out what changes were made.


3.7.2 ImportFlags Enumeration

This enumeration specifies the changes to import during import methods. Table 3-13 lists the values in this enumeration.

Table 3-13 ImportFlags Enumeration Values

Method Names Description

String processAllChanges

Specifies that you want to import flags that were changed in a given directory on the LOCAL computer and on REMOTE computers, after first referring to the replication logs to find out what changes were made (combines processLocalChanges and processRemoteChanges).

String processLocalChanges

Specifies that you want to import flags that were changed in a given directory on the LOCAL computer, after first referring to the replication logs to find out what changes were made.

String processRemoteChanges

Specifies that you want to import flags that were changed in a given directory on REMOTE computers, after first referring to the replication logs to find out what changes were made.


3.7.3 Import() Method

Use this method to import changes from the log file.

Note:

In a Java environment, you must specify the import method as _import(), which avoids conflict with the reserved word 'import'.

3.7.3.1 Signature

List[] (String filename, ImportFlags flag, Calendar lastPurgedLog, boolean updateReplicationLog, boolean returnErrors, CatalogItemsFilter filter, PathMap pathMap, String sessionID);

Argument Description

String filename

Specifies the name of the log file.

ImportFlags flag

Specifies the subset of changes (for example, local or remote) to import. For more information, see "ImportFlags Enumeration".

Calendar lastPurgedLog

Specifies the date and time that the log was last cleaned up. If the change in the export file was made after that time, then import uses local logs to determine if it should be replayed, otherwise it uses the last access time.

boolean updateReplicationLog

If set to TRUE, then the replication log is updated. If set to FALSE, then the replication log is not updated.

boolean returnErrors

If set to TRUE, then the function returns an array of "ImportError Structure" objects which describes cases when changes recorded in the import file that satisfy filter conditions were not replayed.

CatalogItemsFilter filter

Specifies that you should filter changes made within a particular time period, and to catalog items in specified folders. Can be null.

PathMap pathMap

Specifies to which directory the imported changes are copied. Use this argument to copy items in one directory to another directory.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.7.3.2 Returns

Returns an ImportError structure containing the list of errors encountered. For more information, see Section 2.15, "ImportError Structure".

3.7.4 export() Method

Use this method to export catalog changes to a specified log file.

3.7.4.1 Signature

void export (String filename, CatalogItemsFilter filter, ExportFlags flag, boolean exportSecurity, String sessionID);

Argument Description

String filename

Specifies the name of the log file.

CatalogItemsFilter filter

Specifies the subset of changes to be exported. The filter.items field cannot be null.

ExportImportFlags flag

Specifies the changes (for example, local or remote) to export. For more information, see "ExportFlags Enumeration".

exportSecurity

Specifies the security information for the corresponding object.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.7.5 markForReplication() Method

Use this method to change the "replicable" flag on a specified folder and its descendants.

3.7.5.1 Signature

void markForReplication (String item, boolean replicate, String sessionID);

Argument Description

String item

Specifies the path of the folder.

boolean replicate

If set to TRUE, then mark the folder as replicable. If set to FALSE, then remove the replicable flag.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.7.6 purgeLog() Method

Cleans the specified logs.

3.7.6.1 Signature

void purgeLog(List[] items, Calendar timestamp, String sessionID);

Argument Description

List[] items

List of folder paths to clean.

Calendar timestamp

Cleans only those log items where the last modified time is earlier than the timestamp.

String sessionID

A string value that contains the session ID to log off from the SOAP session. The session ID is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.8 ReportEditingService Service

Use this service to merge arguments and Oracle Business Intelligence Presentation Services data to create and return the results.

Table 3-14 shows the supported methods.

Table 3-14 ReportEditingService Methods

Method Names Description

Section 3.8.1, "applyReportDefaults() Method"

Applies analysis default arguments to the analysis and returns the results.

Section 3.8.2, "applyReportParams() Method"

Applies report arguments to the analysis object and returns the results.

Section 3.8.3, "generateReportSQL() Method"

Retrieves the SQL query for a given analysis.


3.8.1 applyReportDefaults() Method

Use this method to apply analysis default arguments to the analysis and returns the results.

3.8.1.1 Signature

String applyReportDefaults(ReportRef reportRefs, String sessionID);

Arguments Description

ReportRef object

Specifies the path to the analysis definition, supplied in the ReportRef common structure.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.8.1.2 Returns

Returns the result of applying the default analysis arguments to the specified analysis object.

3.8.2 applyReportParams() Method

Use this method to apply analysis arguments to the analysis and return the results.

3.8.2.1 Signature

Object applyReportParams(ReportRef reportRef, ReportParams reportParams, boolean encodeInString, String sessionID);

Arguments Description

ReportRef reportRef

Specifies the path to the analysis definition, supplied in the ReportRef common structure.

ReportParams reportParams

Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure. For more information, see Section 3, "Description of Services and Methods in Oracle BI EE Web Services".

boolean encodeInString

If set to TRUE, then the returned analysis object is encoded as a character string.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.8.2.2 Returns

Returns the result of applying analysis arguments to the specified analysis object. If you set encodeInString to true, then the result is encoded as a character string.

3.8.3 generateReportSQL() Method

Use this method to retrieve the logical SQL query for a given analysis.

3.8.3.1 Signature

String generateReportSQL(ReportRef reportRef, ReportParams reportParams, String sessionID);

Arguments Description

ReportRef reportRef

Specifies the path to the analysis definition supplied in the ReportRef common structure.

ReportParams reportParams

Optional. Specifies the path to the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure. For more information, see Section 3, "Description of Services and Methods in Oracle BI EE Web Services".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.8.3.2 Returns

A string containing the SQL query for the specified analysis.

3.9 SAWSessionService Service

Use this service to provide authentication methods such as logon and logoff, and other session-related methods.

Table 3-15 shows the supported methods.

Table 3-15 SAWSessionService Methods

Method Name Description

Section 3.9.1, "getCurUser() Method"

Retrieves the current user ID for the session.

Section 3.9.2, "GetSessionEnvironment() Method"

Retrieves the environment object for the current session.

Section 3.9.3, "getSessionVariable() Method"

Retrieves a list of session variables.

Section 3.9.4, "impersonate() Method"

Logs on and then impersonates the user.

Section 3.9.5, "impersonateex() Method"

Logs on and then impersonates the user. Similar to the impersonate method, but impersonateex can specify optional session parameters.

Section 3.9.6, "keepAlive() Method"

Instructs Oracle Business Intelligence Presentation Services not to end particular sessions due to inactivity.

Section 3.9.7, "logoff() Method"

Logs the user off Oracle Business Intelligence Presentation Services.

Section 3.9.8, "logon() Method"

Authenticates the user.

Section 3.9.9, "logonex() Method"

Authenticates the user. Similar to the logon method, but logonex can specify optional session parameters.


3.9.1 getCurUser() Method

Use this method to retrieve the current user name for the session.

3.9.1.1 Signature

String getCurUser(String sessionID);

Argument Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.9.1.2 Returns

Returns a string indicating the current user name for the session.

3.9.2 GetSessionEnvironment() Method

Use this method to retrieve the environment object for the current session.

3.9.2.1 Signature

SessionEnvironment getSessionEnvironment (String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.9.2.2 Returns

This method returns a session environment object (for more information, see Section 2.37, "SessionEnvironment Structure").

3.9.3 getSessionVariable() Method

Use this method to retrieve a list of session variables.

3.9.3.1 Signature

List[] getSessionVariables(List[] names, String sessionID);

Arguments Description

List[] names

Specifies the names of the session variables.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.9.3.2 Returns

This method returns values of the Oracle BI EE variables associated with the current session.

3.9.4 impersonate() Method

Use this method to log on and impersonate the user during the SAWSessionService service. This method is useful when you need to create sessions for multiple users and have only the administrator's name and password. You do not need to use the (logon) method if you use the impersonate() method.

If user authentication or impersonation fails, an exception is thrown.

3.9.4.1 Signature

String impersonate(String name, String password, String impersonateID);

Arguments Description

String name

Specifies the user name to log on and authenticate.

String password

Specifies the password for the user. If there is no password for the user, leave this field empty (void).

String impersonateID

Specifies the user name to impersonate the authenticated user.


3.9.4.2 Returns

This method returns the session ID and sets an HTTP session cookie. The session ID is used in other methods to identify the Oracle Business Intelligence web services session.

3.9.5 impersonateex() Method

Use this method to log on and impersonate the user in the SAWSessionService service. Similar to the impersonate method, but impersonateex can specify optional session parameters. This method is useful when you need to create sessions for multiple users and have only the administrator's name and password. You do not need to use the (logon) method if you use the impersonateex() method.

If user authentication or impersonation fails, then an exception is thrown.

3.9.5.1 Signature

AuthResults impersonateex(String name, String password, String impersonateID, SAWSessionParameters sessionparams);

Arguments Description

String name

Specifies the user name to log on and authenticate.

String password

Specifies the password for the user. If there is no password for the user, leave this field empty (void).

String impersonateID

Specifies the user name to impersonate the authenticated user.

SAWSessionParameters sessionparams

Optional. Specifies the session parameters to use, supplied in the SAWSessionParameters structure. For information about the SAWSessionParameters structure, see Section 2.35, "SAWSessionParameters Structure".


3.9.5.2 Returns

This method returns the AuthResult structure containing the session ID, and also sets an HTTP session cookie. The session ID is used in other methods to identify the Oracle Business Intelligence Presentation Services session. For more information, see Section 2.8, "AuthResult Structure".

3.9.6 keepAlive() Method

Use this method to instruct Oracle BI EE Presentation Services not to end particular web user sessions due to inactivity. The effect of this method on session lifetime is the same as if those users performed an activity in the browser such as clicking an analysis, or invoking a method.

3.9.6.1 Signature

void keepAlive(String[] sessionID);

Argument Description

String[] sessionID

Specifies the session IDs to remain logged on.


3.9.7 logoff() Method

Use this method to log off the user from Oracle BI EE Presentation Services.

3.9.7.1 Signature

void logoff(String sessionID);

Argument Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.9.8 logon() Method

Use this method to authenticate the user. If authentication fails, an exception is thrown.

3.9.8.1 Signature

String logon(String name, String password);

Arguments Description

String name

Specifies the user name to authenticate.

String password

Specifies the password for the user. If there is no password, leave this field empty (void).


3.9.8.2 Returns

This method returns the session ID and sets an HTTP session cookie. The session ID is used in other methods to identify the Oracle BI EE Presentation Services session.

3.9.9 logonex() Method

Use this method to authenticate the user. Logonex() to the logon method, but logonex can specify optional session parameters. If authentication fails, an exception is thrown.

3.9.9.1 Signature

AuthResult logonex(String name, String password, SAWSessionParameters sessionparams);

Arguments Description

String name

Specifies the user name to authenticate.

String password

Specifies the password for the user. If there is no password, leave this field empty (void).

SAWSessionParameters sessionparams

Optional. Specifies the sessionparams to use, supplied in the SAWSessionParameters structure. For information about the SAWSessionParameters structure, see Section 2.35, "SAWSessionParameters Structure".


3.9.9.2 Returns

This method returns the AuthResult structure containing the session ID, and also sets an HTTP session cookie. The session ID is used in other methods to identify the Oracle Business Intelligence Presentation Services session.

3.10 ScorecardAssessmentService Service

Note:

This service applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10".

Use this service to provide methods for the scorecard assessment engine web service. Table 3-16 shows the supported methods.

Table 3-16 ScorecardAssessmentService Methods

Method Names Description

Section 3.10.1, "executeScorecard() Method"

Exposes the scorecard assessment engine web service's executeScorecard method.

Section 3.10.2, "executeScorecardTree() Method"

Retrieves assessments for one or more of the scorecard's trees in their entirety.

Section 3.10.3, "generateKPIDrillTo() Method"

Generates an Oracle Business Intelligence report containing a detail report for the specified KPI.

Section 3.10.4, "getScorecardKPIDimensions() Method"

Returns the set of dimensions that are related to the KPIs currently in use by the strategy and initiative trees.


3.10.1 executeScorecard() Method

Use this method to expose the scorecard assessment engine web service's executeScorecard method.

3.10.1.1 Signature

AssessmentResult[] executeScorecard(String ScorecardPath, Array NodeInfos, Array Variables, Boolean GetFresh, Session sessionID);

For more information about AssessmentResult[], see Section 2.7, "AssessmentResult Structure".

Arguments Description

String ScorecardPath

Specifies the Presentation Services catalog path identifying the folder containing the scorecard you want to assess.

Array NodeInfos

Specifies an array of nodes for which you need assessments. For more information, see Section 2.22.1, "NodeTypes Enumeration".

Variable[] Variables

Specifies an array of Variable objects that you want to apply in the query. For more information, see Section 2.44, "Variable Structure".

Boolean GetFresh

(Optional) Specifies whether server side Presentation Services cache should be hit (true), or not (false)? Defaults to false.

Session sessionID

(Optional) Specifies the SAW Session ID. This parameter can usually be omitted as the session ID is stored as a cookie.


3.10.2 executeScorecardTree() Method

Use this method to retrieve assessments for one or more of the scorecard's trees in their entirety.

3.10.2.1 Signature

AssessmentResult[] executeScorecardTree(String ScorecardPath, Integer TreesFlag, Array Variables, Boolean GetFresh, Session sessionID);

Arguments Description

String ScorecardPath

Specifies the Presentation Services catalog path identifying the folder containing the scorecard you want to assess.

Integer TreesFlag

Specifies an integer indicating which trees you are interested in. Use the "bitwise or" operator (|) with the values of TreeFlags corresponding to the trees you are interested in to arrive at the integer value you need. For more information, see Section 2.39, "TreeFlags Enumeration".

Variable[] Variables

Specifies an array of Variable objects that you want to apply in the query. For more information, see Section 2.44, "Variable Structure".

String sessionID

(Optional) Specifies the SAW session ID. This parameter can usually be omitted as the session ID is stored as a cookie.


3.10.3 generateKPIDrillTo() Method

Use this method to generate an Oracle Business Intelligence report containing a detail report for the specified KPI.

3.10.3.1 Signature

DrillToReportURLResult generateKPIDrillTo(String ScorecardPath, String NodeID, String NodeType, String ReportPath, Array Variables, Boolean IsDrillToReport, chartHeight, chartWidth, Session sessionID);

Arguments Description

String ScorecardPath

Specifies the path to the scorecard folder containing the strategy tree or initiative tree the specified KPI is pinned to.

String NodeID

Specifies the GUID for the pinned KPI's node in the strategy or initiative tree.

String NodeType

Specifies the type of tree a node belongs to. For more information about possible values, see Section 2.22.1, "NodeTypes Enumeration".

String ReportPath

Specifies the web catalog path where the generated report should be saved.

Array Variables

Specifies an array of Variable structure objects that should be used when generating the report. For more information, see Section 2.44, "Variable Structure".

Boolean IsDrillToReport

Specifies if it is a drilltoreport (true), or if it is a detail report (false).

chartHeight

Specifies chart height.

chartWidth

Specifies chart width.

String sessionID

(Optional) Specifies the SAW Session ID. This parameter can usually be omitted as the session ID is stored in a cookie.


3.10.4 getScorecardKPIDimensions() Method

Use this method to return the set of dimensions that are related to the KPIs currently in use by the strategy and initiative trees.

3.10.4.1 Signature

ScorecardDimensionReference[] getScorecardKPIDimensions(Boolean GetFresh, Session sessionID);

Arguments Description

Boolean GetFresh

(Optional) Specifies whether the results must be freshly retrieved from the middle-tier (true) or whether the cached list is sufficient (false). Default: false.

Session sessionID

(Optional) Specifies the HTTP Session ID that should be used to make the request. Default: The current HTTP session (as identified by the session cookie).


3.11 ScorecardMetadataService Service

Note:

This service applies to Oracle BI EE 11.1.1.7.10 and later versions, and might not be available in earlier versions. For more information about Oracle BI EE 11.1.1.7.10, see "New Features for 11.1.1.7.10"

Use this service to provide methods for the ScorecardMetadataService SOAP API for creating, updating and deleting Scorecard Metadata in the Oracle BI Presentation Services Catalog. Table 3-17 shows the supported methods.

Table 3-17 ScorecardMetadataService Methods

Method Names Description

Section 3.11.1, "createScorecard() Method"

Creates a scorecard.

Section 3.11.2, "openScorecard() Method"

Opens a scorecard (in read only mode).

Section 3.11.3, "closeScorecard() Method"

Closes a scorecard.

Section 3.11.4, "editScorecard() Method"

Edits a scorecard (opens in read-write mode).

Section 3.11.5, "getScorecardDetails() Method"

Retrieves scorecard details.

Section 3.11.6, "updateScorecardSettings() Method"

Updates scorecard settings.

Section 3.11.7, "addStrategyNode() Method"

Adds a strategy node to a specified scorecard.

Section 3.11.8, "deleteStrategyNode() Method"

Deletes a strategy node from a specified scorecard.

Section 3.11.9, "updateStrategyNode() Method"

Updates a strategy node for a specified scorecard.

Section 3.11.10, "moveStrategyNode() Method"

Moves a strategy node to a new parent node in a specified scorecard.

Section 3.11.11, "addInitiativeNode() Method"

Adds an initiative node to a specified scorecard.

Section 3.11.12, "deleteInitiativeNode() Method"

Deletes an initiative node from a specified scorecard.

Section 3.11.13, "moveInitiativeNode() Method"

Moves an initiative node to a new parent node in a specified scorecard.

Section 3.11.14, "addPerspective() Method"

Adds a perspective to a specified scorecard.

Section 3.11.15, "deletePerspective() Method"

Deletes a perspective from a specified scorecard.

Section 3.11.16, "updatePerspective() Method"

Updates a perspective in a specified scorecard.

Section 3.11.17, "addScorecardView() Method"

Adds a scorecard view to a specified scorecard.

Section 3.11.18, "updateScorecardView() Method"

Updates a scorecard view in a specified scorecard.

Section 3.11.19, "deleteScorecardView() Method"

Deletes a scorecard view from a specified scorecard.

Section 3.11.20, "updateCausalLinkages() Method"

Updates the causal linkages in the specified scorecard.

Section 3.11.21, "updateScorecardItemACL() Method"

Updates the Access Control List (ACL) for an item in the specified scorecard.


3.11.1 createScorecard() Method

Use this method to create a scorecard.

3.11.1.1 Signature

CreateScorecardResult createScorecard(String Name, String Description, String Path, String RootNodeName, Boolean UseDefaultPerspectives, String SessionID);

Arguments Description

String Name

Specifies the name you want to give to the new scorecard.

String Description

Specifies the description you want to give to the new scorecard.

String Path

Specifies the catalog path where you want to save the new scorecard.

String RootNodeName

Specifies the name that you want to give to the root node of the new scorecard's strategy tree.

Boolean UseDefaultPerspectives

Specifies whether the scorecard should be pre populated with the default perspectives (true) or not (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.2 openScorecard() Method

Use this method to open a scorecard.

3.11.2.1 Signature

OpenScorecardResult openScorecard(String Path, Boolean RequestedReadWrite, Object RetryOrigResult, String SessionID);

Arguments Description

String Path

Specifies the catalog path of the scorecard you want to open.

Boolean RequestedReadWrite

Specifies whether you want to open the scorecard in Edit mode (true) or View mode (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.3 closeScorecard() Method

Use this method to close a scorecard.

3.11.3.1 Signature

CloseScorecardResult closeScorecard(String ScorecardID, String ErrorCode, String ErrorMessage);

Arguments Description

String ScorecardID

Specifies the ID of the scorecard you want to close.

Boolean Unlock

Specifies whether you want to unlock the scorecard (true) or not (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.4 editScorecard() Method

Use this method to edit a scorecard.

3.11.4.1 Signature

OpenScorecardResult editScorecard(String Path, String ScorecardID, Boolean Edit, String SessionID);

Arguments Description

String Path

Specifies the catalog path of the scorecard you want to open.

String ScorecardID

Specifies the ID of the scorecard you want to close.

Boolean Edit

Specifies whether you want to open the scorecard in Edit mode (true) or View mode (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.5 getScorecardDetails() Method

Use this method to retrieve scorecard details.

3.11.5.1 Signature

GetScorecardDetailsResult getScorecardDetails(String ScorecardID, Boolean GetSettings, Boolean GetPerspectives, Boolean GetStrategyTree, Boolean GetInitiativeTree, Boolean GetCausalLinkages, Boolean GetViews, Boolean IncludeCatalogObjects, String SessionID);

Arguments Description

String ScorecardID

The ID of the Scorecard you are interested in.

Boolean GetSettings

Specifies whether you want the results to include the Scorecard Settings (true) or not (false).

Boolean GetPerspectives

Specifies whether you want the results to include the Scorecard's Perspectives (true) or not (false).

Boolean GetStrategyTree

Specifies Specifies whether you want the results to include the Scorecard's Strategy Tree (true) or not (false).

Boolean GetInitiativeTree

Specifies whether you want the results to include the Scorecard's Initiative Tree (true) or not (false).

Boolean GetCausalLinkages

Specifies hether you want the results to include the Scorecard's Causal Linkages (true) or not (false).

Boolean GetViews

Specifies whether you want the results to include the Scorecard's Views (true) or not (false).

Boolean IncludeCatalogObjects

Specifies whether you want the results to include the Scorecard's Catalog Objects (true) or not (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.6 updateScorecardSettings() Method

Use this method to update scorecard settings.

3.11.6.1 Signature

void updateScorecardSettings(String ScorecardID, Object ScorecardSettings, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to update.

Object ScorecardSettings

Specifies the new scorecard settings that you want to apply.

String SessionID

(Optional) Specifies he HTTP session ID.


3.11.7 addStrategyNode() Method

Use this method to add a strategy node to the specified scorecard.

3.11.7.1 Signature

ObjectiveNode (or PinnedKPINode) addStrategyNode(String ScorecardID, Object StrategyNode, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to add the strategy node to.

Object StrategyNode

Specifies the strategy node that you want to add.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.8 deleteStrategyNode() Method

Use this method to delete a strategy node from a specified scorecard.

3.11.8.1 Signature

DeleteNodeResult deleteStrategyNode(String ScorecardID, String NodeID, Boolean RemoveLinkedObjective, Boolean Recursive, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to remove the strategy node from.

String NodeID

Specifies the ID of the node you want to delete.

Boolean RemoveLinkedObjective

Specifies whether you want to delete all the nodes linked to the specified node (true) or not (false).

Boolean Recursive

Specifies whether you want to delete all the nodes beneath the specified node (true) or not (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.9 updateStrategyNode() Method

Use this method to update a strategy node in the specified scorecard.

3.11.9.1 Signature

ObjectiveNode (or PinnedKPINode) updateStrategyNode(String ScorecardID, Object StrategyNode, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the strategy node you want to update.

Object StrategyNode

Specifies the strategy node that you want to update.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.10 moveStrategyNode() Method

Use this method to move a strategy node to a new parent node in the specified scorecard.

3.11.10.1 Signature

MoveNodeResult moveStrategyNode(String ScorecardID, String NodeToBeMovedGuid, String OriginalParentGuid, String ReferenceNodeGuid, String NewParentGuid, String Operation, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the strategy node you want to move.

String NodeToBeMovedGuid

Specifies the ID of the node you want to move.

String OriginalParentGuid

Specifies the ID of the old parent node.

String ReferenceNodeGuid

Specifies the ID of the reference node (this is used with respect to the specified operation to determine the final resting place of the moved node).

String NewParentGuid

Specifies he ID of the new parent node.

String Operation

Specifies the move operation to apply. Specifies the operation ADD, UPDATE, or DELETE.

String SessionID

(Optional) Specifies he HTTP session ID.


3.11.11 addInitiativeNode() Method

Use this method to add an initiative node to the specified scorecard.

3.11.11.1 Signature

InitiativeNode (or PinnedKPINode) addInitiativeNode(String ScorecardID, Object InitiativeNode, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to add the initiative node to.

Object InitiativeNode

Specifies the initiative node that you want to add.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.12 deleteInitiativeNode() Method

Use this method to delete an initiative node from the specified scorecard.

3.11.12.1 Signature

DeleteNodeResult deleteInitiativeNode(String ScorecardID, String NodeID, Boolean RemoveLinkedInitiative, Boolean Recursive, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to remove the initiative node from.

String NodeID

Specifies the ID of the node that you want to delete.

Boolean RemoveLinkedInitiative

Specifies whether you want to delete all the nodes linked to the specified node (true) or not (false).

Boolean Recursive

Specifies whether you want to delete all the nodes beneath the specified node (true) or not (false).

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.13 moveInitiativeNode() Method

Use this method to move an initiative node to a new parent node in the specified scorecard.

3.11.13.1 Signature

MoveNodeResult moveInitiativeNode(String ScorecardID, String NodeToBeMovedGuid, String OriginalParentGuid, String ReferenceNodeGuid, String NewParentGuid, String Operation, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the strategy node you want to move.

String NodeToBeMovedGuid

Specifies the ID of the node you want to move.

String OriginalParentGuid

Specifies the ID of the old parent node.

String ReferenceNodeGuid

Specifies the ID of the reference node (this is used with respect to the specified operation to determine the final resting place of the moved node).

String NewParentGuid

Specifies the ID of the new parent node.

String Operation

Specifies the move operation to apply. Specifies the operation ADD, UPDATE, or DELETE.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.14 addPerspective() Method

Use this method to add a perspective to a scorecard.

3.11.14.1 Signature

Perspective addPerspective(String ScorecardID, Object InitiativeNode, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to add the perspective to.

Object Perspective

Specifies the perspective you want to add.

String SessionID

(Optional) Specifies he HTTP session ID.


3.11.15 deletePerspective() Method

Use this method to delete a perspective from the specified scorecard.

3.11.15.1 Signature

DeletePerspectiveResult deleteInitiativeNode(String ScorecardID, String PerspectiveID, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to remove the perspective from.

String PerspectiveID

Specifies the ID of the perspective you want to delete.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.16 updatePerspective() Method

Use this method to update a perspective in the specified scorecard.

3.11.16.1 Signature

Perspective updatePerspective(String ScorecardID, Object Perspective, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the perspective you want to update.

Object Perspective

Specifies the perspective you want to update.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.17 addScorecardView() Method

Use this method to add a scorecard view to the specified scorecard.

3.11.17.1 Signature

ItemInfo addScorecardView(String ScorecardID, Object XMLDocumentInfo, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard you want to add a scorecard view to.

Object XMLDocumentInfo

Specifies the object containing the new view's metadata.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.18 updateScorecardView() Method

Use this method to update a scorecard view in the specified scorecard.

3.11.18.1 Signature

ItemInfo updateScorecardView(String ScorecardID, Object XMLDocumentInfo, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the view you want to update.

Object XMLDocumentInfo

Specifies the object containing the updated view's metadata.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.19 deleteScorecardView() Method

Use this method to delete a scorecard view from the specified scorecard.

3.11.19.1 Signature

DeleteScorecardViewResult deleteScorecardView(String ScorecardID, String Path, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the view you want to delete.

String Path

Specifies the catalog path of the view you want to delete.

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.20 updateCausalLinkages() Method

Use this method to update the causal linkages in the specified scorecard.

3.11.20.1 Signature

UpdateCausalLinkageResult updateCausalLinkages(String Name, Array CausalLinkage, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the causal linkages you want to update.

Array CausalLinkage[]

Specifies an array of CausalLinkage structure objects that you want to update. For more information, see Section 2.11, "CausalLinkage Structure".

String SessionID

(Optional) Specifies the HTTP session ID.


3.11.21 updateScorecardItemACL() Method

Use this method to update the Access Control List (ACL) for an item in the specified scorecard.

3.11.21.1 Signature

UpdateScorecardItemACLResult updateScorecardItemACL(String ScorecardID, Enumeration Type, String Path, String id, ACL acl, UpdateCatalogItemACLParams options, String SessionID);

Arguments Description

String ScorecardID

Specifies the ID of the Scorecard containing the item whose ACL you want to update.

Enumeration Type

Specifies what type of object is having its ACL updated.

The Type field can be the following valid values: SCORECARD, STRATEGY_NODE, and INITIATIVE_NODE types.

String id

Specifies a scorecard tree NODE GUID which is only needed for Strategy Tree or Initiative Tree ACLs (when Type is STRATEGY_NODE or INITIATIVE_NODE). It can be null for other catalog types.

String Path

Specifies the path to the object whose ACL you want to update.

ACL acl

Specifies the new ACL. For more information, see Section 2.3, "ACL Structure".

UpdateCatalogItemACLParams options

The 'options' UpdateCatalogItemACLParams structure contains the UpdateACLMode and Recursive flags and is of type UpdateCatalogItemACLParams. For more information, see Section 2.42, "UpdateCatalogItemACLParams Structure".

String SessionID

(Optional) Specifies the HTTP session ID.


3.12 SecurityService Service

Use this service to provide methods for identifying accounts and privileges. Table 3-18 shows the supported methods.

Table 3-18 SecurityService Methods

Method Names Description

Section 3.12.1, "forgetAccounts() Method"

Removes an Oracle BI EE Presentation Services internal ID to account name mapping.

Section 3.12.2, "getAccounts() Method"

Searches for Oracle BI EE user accounts.

Section 3.12.3, "getAccountTenantID() Method"

Gets the tenant ID of a specific account.

Section 3.12.4, "getGlobalPrivilegeACL() Method"

Gets the Access Control List for global privileges.

Section 3.12.5, "getGlobalPrivileges() Method"

Gets the list of all global privileges.

Section 3.12.6, "getGroups() Method"

Gets a list of catalog groups that are members of the account (for example, user or group

Section 3.12.7, "getMembers() Method"

Gets direct members of the catalog group.

Section 3.12.8, "getPermissions() Method"

Get the list of permissions for the specified user.

Section 3.12.9, "getPermissionsEx() Method"

Get the list of permissions for the specified user.

Section 3.12.10, "getPrivilegesStatus() Method"

Lists all privileges and their statuses.

Section 3.12.11, "isMember() Method"

Confirms if a catalog group is a member of the user or group.

Section 3.12.12, "joinGroups() Method"

Adds a user to a catalog group as a member.

Section 3.12.13, "leaveGroups() Method"

Removes a member from a group.

Section 3.12.14, "renameAccounts() Method"

Change the name of an user account.

Section 3.12.15, "updateGlobalPrivilegeACL() Method"

Update the Access Control List for global privileges.


3.12.1 forgetAccounts() Method

Use this method to remove an Oracle BI EE Presentation Services internal ID to account name mapping. This action is useful when an account mapping was created by mistake, for example, as a side effect of an updateGlobalSAWPrivilegeACL method with a misspelled account name.

3.12.1.1 Signature

void forgetAccounts(List[], int cleanuplevel, String sessionID);

Argument Description

List[]

Specifies the accounts to forget, supplied in the Account structure. For information about the Account structure, see Section 2.3, "ACL Structure".

int cleanuplevel

Specifies the amount of mapping information to remove. Set to 0 to remove the mapping from an internal account ID and a user or group name. Set to 1 to remove the user directory if accounts refer to a user.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.2 getAccounts() Method

Use this method to search for Oracle BI EE user accounts (for example, LDAP users, catalog groups, or application roles).

3.12.2.1 Signature

List[] getAccounts(List[], String sessionID);

Argument Description

List[]

Specifies user names, catalog group names, and application role names. A flag indicates if the name is a user, group, or application role.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.3 getAccountTenantID() Method

Use this method to retrieve the tenant ID of a specific account.

3.12.3.1 Signature

List[] getAccountTenantID(List[], String sessionID);

Argument Description

Account account

Specifies the account for which we want tenant ID.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.3.2 Returns

Returns the tenant ID.

3.12.4 getGlobalPrivilegeACL() Method

Use this method to retrieve the Access Control List for global privileges.

3.12.4.1 Signature

ACL getGlobalPrivilegeACL(String privilegeName, String sessionID);

Argument Description

String privilegeName

Specifies the name of the privilege to retrieve.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.5 getGlobalPrivileges() Method

Use this method to retrieve the list of global privileges.

3.12.5.1 Signature

List[] getGlobalPrivileges(String sessionID);

Argument Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.6 getGroups() Method

Use this method to get a list of catalog groups that are members of the account (for example, user or group).

3.12.6.1 Signature

List[] getGroups(List[], Boolean expandGroups, String sessionID);

Argument Description

List[]

Specifies user or group.

Boolean expandGroups

Specifies to expand the groups to which the members belong.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.7 getMembers() Method

Use this method to get direct members of the catalog group.

3.12.7.1 Signature

List[] getMembers(List[] group, Boolean expandGroups, String sessionID);

Argument Description

List[]

Specifies the catalog group for which you want a list of members.

Boolean expandGroups

Specifies to expand the groups to which the members belong.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.8 getPermissions() Method

Use this method to retrieve a list of permissions for the specified user, based on the specified access control list.

Note:

This method also returns any permissions that are inherited by a user's security group, even if the access control list does not specify the group's permissions.

3.12.8.1 Signature

List[] getPermissions(List[], Account account, String sessionID);

Argument Description

List[]

Specifies the access control list for the user specified by Account account.

Account account

Specifies the name of the user for whom to find permission for the ACLs. Can be the user's name or a GUID.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.8.2 Returns

Returns permissions information in the permissionMask field in the AccessControlToken structure (for more information, see Section 2.1, "AccessControlToken Structure").

3.12.9 getPermissionsEx() Method

Use this method to retrieve a list of permissions for the specified user, owner, or creator, based on the specified access control list.

3.12.9.1 Signature

List[] getPermissionsEx(List[], Account account, Owner owner, Creator creator, String sessionID);

Argument Description

List[]

Specifies the access control list for the user specified by Account account.

Account account

Specifies the name of the user for whom to find permission for the ACLs. Can be the user's name or a GUID.

Owner owner

Specifies the name of the owner for whom to find permission for the ACLs. Can be the owner's user name or a GUID.

Creator creator

Specifies the name of the creator for whom to find permission for the ACLs. Can be the creator's user name or a GUID.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.9.2 Returns

Returns permissions information in the permissionMask field in the AccessControlToken structure (for more information, see Section 2.1, "AccessControlToken Structure").

3.12.10 getPrivilegesStatus() Method

Use this method to list all privileges and their statuses.

3.12.10.1 Signature

List[] getPrivilegesStatus(List[] privileges, String sessionID);

Argument Description

List[] privileges

Specifies a list of privileges.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.11 isMember() Method

Use this method to confirm if a catalog group is a member of the user or group.

3.12.11.1 Signature

boolean isMember(List[] group, List[] member, Boolean expandGroups, String sessionID);

Argument Description

List[] group

Specifies the username, catalog group, or application role name.

List[] member

Specifies the name of the member to verify. Consider the example isMember(BIAdministrator, Administrator, false). This example asks if the user Administrator is a member of the BIAdministrator application role.

Boolean expandGroups

Specifies ....

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.12 joinGroups() Method

Use this method to join a catalog group as a member.

3.12.12.1 Signature

void joinGroups(List[] group, List[] member, String sessionID);

Argument Description

List[] group

Specifies the name of the group to join or become a member. Consider the following example: join(Marketing, UserA). This example illustrates that UserA will join the Marketing catalog group.

List[] member

Specifies the name of the underlying member. For more information, see the example included in the previous argument.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.13 leaveGroups() Method

Use this method to remove a member from a group.

3.12.13.1 Signature

void leaveGroups(List[] group, List[] member, String sessionID);

Argument Description

List[] group

Specifies the group from which to remove a member.

List[] member

Specifies the member that you want to remove from the group.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.14 renameAccounts() Method

Use this method to change the name of a user account in the catalog.

3.12.14.1 Signature

void renameAccounts(List[] from, List[] to, String sessionID);

Argument Description

List[] from

Specifies the old name of the account.

List[] to

Specifies a new name for the account.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.12.14.2 Returns

Returns an array of accounts. If accountsFilter returns a null value, this method returns all accounts cached by the current Presentation Services instance.

3.12.15 updateGlobalPrivilegeACL() Method

Use this method to update the Access Control List for global privileges.

3.12.15.1 Signature

void updateGlobalPrivilegeACL(String privilegeName, ACL acl, UpdateACLParams updateACLParams, String sessionID);

Arguments Description

String privilegeName

Specifies the name of privilege to update.

ACL acl

Specifies the Access Control List to update, supplied in the ACL structure. For information about the ACL structure, see Section 2.3, "ACL Structure".

UpdateACLParams updateACLParams

Specifies the Access Control List parameters to update, supplied in the UpdateACLParams structure. For information about the UpdateACLParams structure, see Section 2.41, "UpdateACLParams Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13 WebCatalogService Service

Use this service to provide methods for navigating and managing the catalog, and to read and write catalog objects in XML format. Table 3-19 shows the supported methods.

Table 3-19 WebCatalogService Methods

Method Names Description

Section 3.13.3, "copyItem() Method"

Copies an object from one location to another in the catalog.

Section 3.13.4, "copyItem2() Method"

Generates an archive file from the catalog.

Section 3.13.5, "createFolder() Method"

Creates a new folder in the catalog.

Section 3.13.6, "createLink() Method"

Creates a link to the catalog.

Section 3.13.7, "deleteItem() Method"

Deletes an object from the catalog.

Section 3.13.8, "getItemInfo() Method"

Retrieves catalog information for an object.

Section 3.13.9, "getMaintenanceMode() Method"

Retrieves the maintenance mode status.

Section 3.13.10, "getObjectCategories() Method"

Retrieves all supported categories.

Section 3.13.11, "getObjectCreateList() Method"

Retrieves all creatable objects.

Section 3.13.12, "getObjectTypes() Method"

Retrieves all supported catalog object types.

Section 3.13.13, "getSubItems() Method"

Retrieves the collection of child subitems for an object in the catalog.

Section 3.13.14, "maintenanceMode() Method"

Locks the catalog during maintenance.

Section 3.13.15, "moveItem() Method"

Moves an object in the catalog to a different location in the catalog.

Section 3.13.16, "pasteItem2() Method"

Pastes the copied items.

Section 3.13.17, "readObjects() Method"

Reads an object from the catalog.

Section 3.13.18, "removeFolder() Method"

Deletes a folder from the catalog.

Section 3.13.19, "setItemAttributes() Method"

Sets attribute flags for the specified catalog item.

Section 3.13.20, "setItemProperty() Method"

Sets a property for an object in the catalog.

Section 3.13.21, "setOwnership() Method"

Take ownership of the specified item.

Section 3.13.22, "updateCatalogItemACL() Method"

Update the Access Control List for an item in the catalog.

Section 3.13.23, "writeObjects() Method"

Writes a list of objects to the catalog.


3.13.1 ErrorDetailsLevel Enumeration

This enumeration specifies a list of valid values for methods in the "WebCatalogService Service". Table 3-20 lists the values in this enumeration.

Note:

Only one of the values in ErrorDetailsLevel should be selected.

Table 3-20 ErrorDetailsLevel Enumeration Values

Values Description

String ErrorCode

Specifies that the ErrorInfo.errorCode field is populated.

String ErrorCodeAndText

Specifies that the ErrorInfo.errorCode and ErrorInfo.message fields are populated.

String FullDetails

Specifies that all ErrorInfo fields are populated.


3.13.2 ReadObjectsReturnOptions Enumeration

This enumeration specifies a list of valid values for methods in the "WebCatalogService Service". Table 3-21 lists the values in this enumeration.

Table 3-21 ReadObjectsReturnOptions Enumeration Values

Values Description

String NoObject

Specifies that the catalogObject and catalogObjectBytes fields are not populated.

String ObjectAsString

Specifies that the catalogObject field is populated and the catalogObjectBytes fields is not populated.

String ObjectAsBinary

Specifies that the catalogObject field is not populated and the catalogObjectBytes fields is populated.

String ObjectAsBinaryUseMtom

Specifies that the catalogObject field is not populated and the catalogObjectBytes fields is populated and using MTOM to encode the content returned by the SOAP message.


3.13.3 copyItem() Method

Use this method to copy an object from one location in the catalog to another location in the catalog.

3.13.3.1 Signature

void copyItem(String pathSrc, String pathDest, int flagACL, String sessionID);

Arguments Description

String pathSrc

Specifies the current path to the object in the catalog.

String pathDest

Specifies the location in the catalog where the object should be copied.

int flagACL

Specified whether the item is copied with security. 0 indicates that the item is copied without security. 1 indicates that the item is copied with security.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.4 copyItem2() Method

Use this method to generate an archive file from the catalog.

3.13.4.1 Signature

DataHandler copyItem2(List[] path, boolean recursive, boolean permissions, boolean timestamps, boolean useMtom, String sessionID);

Arguments Description

List[] path

Specifies the location in the catalog from which the archive was created.

boolean recursive

Specifies whether the child-level folders were included in the archive.

boolean permissions

Specified whether the items are copied with security.

boolean timestamps

Specifies whether to preserve the items' time stamps were preserved.

boolean useMtom

Specifies whether MTOM was used to encode the content returned by the SOAP message.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.5 createFolder() Method

Use this method to create a folder in the catalog.

3.13.5.1 Signature

void createFolder(String path, boolean createIfNotExists, boolean createIntermediateDirs, String sessionID);

Arguments Description

String path

Specifies the location in the catalog where the folder should be created, including the name of the new folder.

boolean createIfNotExists

If set to TRUE, then the folder object is created in the catalog if it does not already exist. If set to FALSE, then the folder object is not recreated if it already exists.

boolean createIntermediateDirs

If set to TRUE, then an intermediate directory is created. If set to FALSE, the an intermediate directory is not created.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.6 createLink() Method

Use this method to create a link to the catalog.

3.13.6.1 Signature

void createLink(String path, String pathTarget, boolean overwriteIfExists, String sessionID);

Arguments Description

String Path

Specifies the path to the parent object in the catalog.

String TargetPath

Specifies the location in the catalog to which the link being created should refer.

boolean overwriteIfExists

If set to TRUE, then the link is overwritten if it already exists in the catalog. If set to FALSE, then the link is not overwritten if it already exists in the catalog.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.7 deleteItem() Method

Use this method to delete an object from the catalog. To delete a folder, read Section 3.13.18, "removeFolder() Method".

3.13.7.1 Signature

void deleteItem(String path, String sessionID);

Arguments Description

String path

Specifies the path to the object in the catalog.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.8 getItemInfo() Method

Use this method to retrieve catalog information for an object.

3.13.8.1 Signature

ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);

Arguments Description

String path

Specifies the path to the object in the catalog.

boolean resolveLinks

If set to TRUE and the path in the catalog refers to a link, then Oracle Business Intelligence retrieves information for the object pointed to by the link.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.8.2 Returns

Returns catalog information for an object in an ItemInfo structure. For more information, see Section 2.16, "ItemInfo Structure".

3.13.9 getMaintenanceMode() Method

Use this method to retrieve the maintenance mode status.

3.13.9.1 Signature

Boolean getMaintenanceMode(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.9.2 Returns

Returns true or false value indicating current maintenance mode status. For more information, see Section 3.13.14, "maintenanceMode() Method".

3.13.10 getObjectCategories() Method

Use this method to retrieve the supported categories.

3.13.10.1 Signature

Boolean getObjectCategories(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.10.2 Returns

Returns a list of supported categories.

3.13.11 getObjectCreateList() Method

Use this method to retrieve a list of all creatable objects.

3.13.11.1 Signature

Boolean getObjectCreateList(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.11.2 Returns

Returns a list of creatable objects.

3.13.12 getObjectTypes() Method

Use this method to retrieve a list of all supported catalog object types.

3.13.12.1 Signature

Boolean getObjectTypes(String sessionID);

Arguments Description

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.12.2 Returns

Returns a list of supported object types.

3.13.13 getSubItems() Method

Use this method to retrieve the collection of child sub-items for an object in the catalog.

3.13.13.1 Signature

List[] getSubItems(String path, String mask, boolean resolveLinks, GetSubItemsParams options, String sessionID);

Arguments Description

String path

Specifies the path to the parent object in the catalog.

String mask

Specifies a mask that indicates the child subitems to retrieve. The mask character is an asterisk (*). To retrieve all child subitems, use a single asterisk.

boolean resolveLinks

If set to TRUE and the path in the catalog refers to a link, then information is retrieved for the child subitems of the object pointed to by the link.

GetSubItemsParams options

Optional. Specifies parameters to supply to the GetSubItemsParams structure. For information about the GetSubItemsParams structure, see Section 2.14, "GetSubItemsParams Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.13.2 Returns

Returns a collection of child subitems in an ItemInfo structure. For more information, see Section 2.16, "ItemInfo Structure".

3.13.14 maintenanceMode() Method

Use this method to lock the catalog during maintenance.

3.13.14.1 Signature

void maintenanceMode(boolean flag, String sessionID);

Arguments Description

boolean flag

Set to TRUE if the catalog is locked.

String sessionID)

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.15 moveItem() Method

Use this method to move an object in the catalog to a different location in the catalog.

3.13.15.1 Signature

void moveItem(String pathSrc, String pathDest, int flagACL, String sessionID);

Arguments Description

String pathSrc

Specifies the current path to the object in the catalog.

String pathDest

Specifies the location in the catalog where the object should be moved.

int flagACL

Specified whether the item is moved with security. 0 indicates that the item is moved without security. 1 indicates that the item is moved with security.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.16 pasteItem2() Method

Use this method to paste the copied items.

3.13.16.1 Signature

void pasteItem2(Binary stream DataHandler archive, String replacePath, int flagACL, int flagOverwrite, String sessionID);

Arguments Description

Binary stream DataHandler archive

Specifies the returned content of the item as string or bytes. What you specify in this field is determined by the readObjects method.

String replacePath

Specifies the location to paste the copied item.

int flagACL

Specified whether the item is pasted with security. 0 indicates that the item is pasted without security. 1 indicates that the item is pasted without security.

int flagOverwrite

Specifies whether the pasted item overwrites existing item. 0 indicates replace all, 1 indicates replace old, 2 indicates replace none, and 3 indicates force replace.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.17 readObjects() Method

Use this method to read an object from the catalog and return a CatalogObject structure.

3.13.17.1 Signature

List[] readObjects(List[] paths, boolean resolveLinks, ErrorDetailsLevel errorMode, ReadObjectsReturnOptions returnOptions, String sessionID);

Arguments Description

List[] paths

Specifies the location of the object in the catalog.

boolean resolveLinks

If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link.

ErrorDetailsLevel errorMode

Specifies the amount of error information in the errorInfo field in the CatalogObjects structure. For more information, see Section 2.10, "CatalogObject Structure".

ReadObjectsReturnOptions returnOptions

Specifies a list of valid values. For more information, see "ReadObjectsReturnOptions Enumeration".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.17.2 Returns

Returns an array of "CatalogObject Structure" Objects.

Note:

If a read operation fails for a catalog object (for example, due to an invalid path or insufficient privileges), the errorInfo field for that object contains a description of the error.

3.13.18 removeFolder() Method

Use this method to delete a folder and its contents from the catalog. To delete an object other than a folder and its contents, see Section 3.13.7, "deleteItem() Method".

3.13.18.1 Signature

void removeFolder(String path, boolean recursive, String sessionID);

Arguments Description

String path

Specifies the path to the folder in the catalog.

boolean recursive

If set to TRUE, then remove the specified folder and its contents. If set to FALSE, then only remove the specified folder if it is empty, otherwise display an exception message.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.19 setItemAttributes() Method

Use this method to set attribute flags for a specified catalog item.

3.13.19.1 Signature

void setItemAttributes (List[] path, int value, int valueOff, boolean recursive, String sessionID);

Arguments Description

List[] path

Specifies the path to the folder in the catalog.

int value

Specifies which attributes is added. Specifies a combination of the following flags:

1 = read only 2 = archive 4 = hidden 8 = system

int valueOff

Specifies which attributes is removed. See the above int value cell for flags.

boolean recursive

Specifies whether to set the properties of items in sub-directories.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.20 setItemProperty() Method

Use this method to set a property for an object in the catalog.

3.13.20.1 Signature

void setItemProperty(List[] path, List[] name, List[] value, boolean recursive, String sessionID);

Arguments Description

List[] path

Specifies the path to the object in the catalog.

List[] name

Specifies the name of the property to set.

List[] value

Specifies the new setting for the property.

boolean recursive

Specifies whether to set the properties of items in sub-directories.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.21 setOwnership() Method

Use this method to take ownership of the specified item.

3.13.21.1 Signature

void setOwnership(List[]path, Account owner, boolean recursive, String sessionID);

Arguments Description

List[] path

Specifies the location in the catalog of the object to take ownership.

Account owner

Specifies the account to assign as owner.

boolean recursive

If set to TRUE, then apply this action to the specified folder and its contents. If set to FALSE, then only apply this action to the specified folder if it is empty, otherwise display an exception message.

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.22 updateCatalogItemACL() Method

Use this method to update the Access Control List for an item in the catalog.

3.13.22.1 Signature

void updateCatalogItemACL(List[] path, ACL acl, UpdateCatalogItemACLParams options, String sessionID);

Fields Description

List[] path

Specifies the path to the object in the catalog.

ACL acl

Specifies the Access Control List. For more information, see Section 2.3, "ACL Structure".

UpdateCatalogItemACLParams options

Specifies additional parameters. For more information, see Section 2.42, "UpdateCatalogItemACLParams Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.23 writeObjects() Method

Use this method to write an array of objects to the catalog.

3.13.23.1 Signature

List[] writeObjects(List[] catalogObjects, boolean allowOverwrite, boolean createIntermediateDirs, ErrorDetailsLevel errorMode, String sessionID);

Argument Description

List [] catalogObjects

Specifies the objects to write to the catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see Section 2.10, "CatalogObject Structure".

All fields of object.itemInfo are ignored, except for the array of item properties, which are applied to the object. The signature of the resulting document is always COXmlDocument1.

boolean allowOverwrite

If set to TRUE, then if the object already exists in the catalog, it is overwritten. If set to FALSE, then if the object already exists in the catalog, it is not overwritten.

boolean createIntermediateDirs

If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link.

ErrorDetailsLevel errorMode

Specifies the amount of error information in the errorInfo field in the "CatalogObject Structure".

String sessionID

Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.


3.13.23.2 Returns

An array of "ErrorInfo Structure" objects.

3.14 XMLViewService Service

Use this service to retrieve results from Oracle BI EE Presentation Services in XML format. Table 3-22 shows the supported methods.

Table 3-22 XMLView Service Methods

Method Name Description

Section 3.14.2, "cancelQuery() Method"

Cancels the current query.

Section 3.14.3, "executeSQLQuery() Method"

Runs a SQL query.

Section 3.14.4, "executeXMLQuery() Method"

Runs an XML query.

Section 3.14.5, "fetchNext() Method"

Returns the next page of data rows.

Section 3.14.6, "getPromptedFilters() Method"

Returns a filter XML structure containing only the analysis' columns with a prompted filter.

Section 3.14.7, "upgradeXML() Method"

Returns an upgraded version of the requested object.


3.14.1 XMLQueryOutputFormat Enumeration

This enumeration specifies a list of valid values for the executeSQLQuery() Method and executeXMLQuery() Method. For example, you might want to return data rows and metadata, or data rows only. Table 3-23 lists the values in this enumeration.

Note:

Only one of the values in XMLQueryOutputFormat can be selected.

Table 3-23 XMLQueryOutputFormat Enumeration Values

Values Description

String SAWRowsetData

Specifies that the query returns only data rows.

String SAWRowsetSchema

Specifies that the query returns only metadata.

String SAWRowsetSchemaAndData

Specifies that the query returns both metadata and data rows.


3.14.2 cancelQuery() Method

Use this method to cancel a query and clean up resources associated with the query. This method should only be used if the query row set is not scrolled to the last row in the data set returned.

Note:

If you use this method when the query row set is scrolled to the last row in the data set returned, query data is cleaned up during the last fetchNext method invocation.

3.14.2.1 Signature

void cancelQuery(String queryID, String sessionID);

Argument Description

String queryID

Specifies the unique ID of the query.

String sessionID

Specifies the unique ID of the session.


3.14.3 executeSQLQuery() Method

Use this method to execute a SQL query and return the results of the query.

Note:

If the results returned exceed one page, you need to use the fetchNext() Method to return the next page of rows.

3.14.3.1 Signature

QueryResults executeSQLQuery(String sql, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, String sessionID);

Argument Description

String sql

Specifies the string of SQL code to execute.

XMLQueryOutputFormat outputFormat

Specifies the output format (for more information, see Section 2.45, "XMLQueryExecutionOptions Structure").

XMLQueryExecutionOptions executionOptions

Specifies the query execution options (for more information, see Section 2.45, "XMLQueryExecutionOptions Structure").

String sessionID

Specifies the unique ID of the session.


3.14.3.2 Returns

Returns the results of the query as one or more rows of data in a QueryResults structure (for more information, see Section 2.27, "QueryResults Structure").

3.14.4 executeXMLQuery() Method

Use this method to execute an XML query and return the results of the query.

Note:

If the results returned exceed one page, you need to use the fetchNext() Method to return the next page of rows.

3.14.4.1 Signature

QueryResults executeXMLQuery(ReportRef report, XMLQueryOutputFormat outputFormat, XMLQueryExecutionOptions executionOptions, ReportParams reportParams, String sessionID);

Argument Description

ReportRef reportRef

Specifies the analysis definition, supplied in the ReportRef common structure.

XMLQueryOutputFormat outputFormat

Specifies the output format (for more information, see Section 2.45, "XMLQueryExecutionOptions Structure").

XMLQueryExecutionOptions executionOptions

Specifies the query execution options (for more information, see Section 2.45, "XMLQueryExecutionOptions Structure").

ReportParams reportParams

Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure. For information about the ReportParams structure, see Section 2.29, "ReportParams Structure".

String sessionID

Specifies the unique ID of the session.


3.14.4.2 Returns

Returns the results of the query as one or more rows of data in a QueryResults structure (for more information, see Section 2.27, "QueryResults Structure").

3.14.5 fetchNext() Method

Use this method to return the next page of rows retrieved by a query.

Note:

The page returned might contain zero rows. If the finished flag is not set, the remaining rows might not be available immediately.

3.14.5.1 Signature

QueryResults fetchNext(String queryID, String sessionID);

Argument Description

String queryID

Specifies the unique ID of the query, which is returned in the QueryResults object.

String sessionID

Specifies the unique ID of the session.


3.14.5.2 Returns

Returns the next page of query results as one or more rows of data in a QueryResults structure (for more information, see Section 2.27, "QueryResults Structure").

3.14.6 getPromptedFilters() Method

Use this method to retrieve a saved analysis' prompted columns or the prompted columns from an analysis' xml definition. Note that to create an analysis with a prompted column, you must assign the isPrompted operator to it.

3.14.6.1 Signature

List[] getPromptedFilters(ReportRef report, String sessionID);

Argument Description

ReportRef report

Specifies the analysis' reportPath or a reportXml (report definition).

String sessionID

Specifies the unique ID of the session.


3.14.7 upgradeXML() Method

Use this method to upgrade Oracle BI EE objects that reside outside of the Presentation Services catalog. This method upgrades object from Oracle BI EE 10g to Oracle BI EE 11g. Use this method primarily for Oracle BI Add-in for Microsoft Office to upgrade the analyses that were saved within Oracle BI Office and not to the catalog. You should only use this method if you want to upgrade the objects in your Oracle BI Office catalog.

Note that if you use methods like executeXmlQuery and use the ReportRef argument to pass an Oracle BI EE 10g report definition, that report is upgraded before the query is run.

3.14.7.1 Signature

String upgradeXML(String xml, String sessionID);

Argument Description

String xml

Specifies the catalog object's xml.

String sessionID

Specifies the unique ID of the session.