This chapter describes the services and methods in Oracle BI EE Web Services.
Note:
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 describes the following services.
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 |
|---|---|
|
Evaluates a condition saved to the catalog. |
|
|
Evaluate a condition supplied as a parameter. |
|
|
Section 3.1.3, "getConditionCustomizableReportElements() Method" |
Obtains the customizable filters of a condition saved to the catalog. |
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).
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. |
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.
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. |
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.
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. |
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 |
|---|---|
|
Adds results to an HTML page. |
|
|
Destroys a server page object and all data associated with it. |
|
|
Retrieves HTML to include in the <BODY> section. |
|
|
Retrieves HTML to include in the <HEAD> section. |
|
|
Retrieves HTML for a page that contains only one analysis. |
|
|
Retrieves HTML to display a particular set of results. |
|
|
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. |
|
|
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.
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".
Use this method to add results to an HTML page.
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.15, "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. |
Use this method to destroy the Oracle BI EE Presentation Services server page object and all data associated with it.
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. |
Use this method to retrieve HTML to include in the <BODY> section.
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. |
Use this method to retrieve HTML to include in the <HEAD> section.
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. |
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.
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.15, "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.26, "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. |
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.
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. |
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.
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. |
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.
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, the new callback URL is http://myserver/myapplication/sawbridge?RedirectURL=saw.dll%3fGo.
Use this method to create a new page object and returns its ID.
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.26, "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. |
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.
| Method Names | Description |
|---|---|
|
Writes a new agent into the catalog and registers it with Oracle BI Scheduler. |
|
|
Deletes an agent from the catalog and deregisters it from the Oracle BI Scheduler. |
|
|
Executes an agent saved in the catalog. |
|
|
Moves an agent from one catalog folder to another. |
|
|
Sends a message to an Oracle BI EE user, group, or user and group. |
|
|
Subscribes to a published agent. Also customizes your subscription. |
|
|
Unsubscribes from an agent. |
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.
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. |
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.
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. |
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.
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. |
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.
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 will be 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 will be 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 will be 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. |
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.
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 arguement. |
| 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. |
Use this method to subscribe to a published agent. If the agent allows customization, then you can also specify the customization XML.
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. |
Use this method to unsubscribe from an agent. This method also deletes any user customizations.
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. |
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 |
|---|---|
|
Cancels a running marketing job. |
|
|
Deletes a saved result set. |
|
|
Generates the count numbers for a segment or segment tree. |
|
|
Gets status and detailed information about a marketing job. |
|
|
Returns prompted columns for a segment or segment tree. |
|
|
Caches a segment or segment tree for list export. |
|
|
Purges the whole cache, entries for a segment, or entries for the segment tree. |
|
|
Saves a list of members based on the most recent updated counts. |
|
|
Generates a list for list export, segment campaign load, or segment tree campaign load. |
Use this method to cancel a running marketing job.
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. |
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.
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 Section 2.4, "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. |
Use this method to generate the count numbers for either a segment or a segment tree.
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.24, "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. |
Use this method to get the status and detailed job information about a marketing job.
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. |
Use this method to return prompted columns for a segment or segment tree.
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. |
Use this method to cache a segment or segment tree for list export.
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. |
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.
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. |
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.
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.24, "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. |
Use this method to generate lists for list export, segment campaign load, or segment tree campaign load.
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.18, "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.17, "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.24, "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. |
Use this service to retrieve descriptions of Oracle Business Intelligence Presentation Services schema objects, such as columns, tables, and subject areas.
Table 3-6 shows the supported methods.
Table 3-6 MetadataService Methods
| Method Names | Description |
|---|---|
|
Clears the query cache. |
|
|
Retrieves column information for a specified column in a specified subject area and table. |
|
|
Retrieves subject area information for a specified subject area. |
|
|
Retrieves table information for a specified table in a specified subject area. |
|
|
Retrieves the list of subject areas available. |
Use this method to retrieve column information for a specified column in a specified subject area and table.
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. |
Returns an SAColumn Object. For information on the SAColumn structure, see Section 2.19, "SAColumn Structure".
Use this method to retrieve subject area information about the specified subject area.
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.5.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. |
Use this method to specify what information should be retrieved about the subject area. Table 3-7 lists the available values.
Returns an SASubjectArea Object (for more information, see Section 2.20, "SASubjectArea Structure").
Depending on the value of the detailsLevel parameter, the returned object contains the information specified in Table 3-8.
| 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. |
Use this method to retrieve table information for a specified table in a specified subject area.
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.5.4.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. |
Used to specify the information to retrieve about the table. Table 3-9 lists the available values.
Returns an SATable Object. For information on the SATable structure, see Section 2.21, "SATable Structure".
Use this method to retrieve the list of subject areas that are available.
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. |
Returns an array of SASubjectArea objects. For information on the SASubjectArea structure, see Section 2.22, "SAWLocale Structure".
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.
Use this service to provide catalog replication methods.
Table 3-10 shows the supported methods.
Table 3-10 ReplicationService Methods
| Method Names | Description |
|---|---|
|
Import changes from the log file. |
|
|
Exports catalog changes to a specified log file. |
|
|
Change the "replicable" flag on a specified folder and its descendants. |
|
|
Cleans the specified logs. |
This enumeration specifies the changes to export during export methods. Table 3-11 lists the values in this enumeration.
Note:
Only one of the fields in ExportFlags should be populated.Table 3-11 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. |
This enumeration specifies the changes to import during import methods. Table 3-12 lists the values in this enumeration.
Table 3-12 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. |
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'.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 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. |
Returns an ImportError structure containing the list of errors encountered. For more information, see Section 2.10, "ImportError Structure".
Use this method to export catalog changes to a specified log file.
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. |
Use this method to change the "replicable" flag on a specified folder and its descendants.
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. |
Cleans the specified logs.
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. |
Use this service to merge arguments and Oracle Business Intelligence Presentation Services data to create and return the results.
Table 3-13 shows the supported methods.
Table 3-13 ReportEditingService Methods
| Method Names | Description |
|---|---|
|
Applies analysis default arguments to the analysis and returns the results. |
|
|
Applies report arguments to the analysis object and returns the results. |
|
|
Retrieves the SQL query for a given analysis. |
Use this method to apply analysis default arguments to the analysis and returns the results.
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. |
Use this method to apply analysis arguments to the analysis and return the results.
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. |
Use this method to retrieve the logical SQL query for a given analysis.
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. |
Use this service to provide authentication methods such as logon and logoff, and other session-related methods.
Table 3-14 shows the supported methods.
Table 3-14 SAWSessionService Methods
| Method Name | Description |
|---|---|
|
Retrieves the current user ID for the session. |
|
|
Retrieves the environment object for the current session. |
|
|
Retrieves a list of session variables. |
|
|
Logs on and then impersonates the user. |
|
|
Logs on and then impersonates the user. Similar to the impersonate method, but impersonateex can specify optional session parameters. |
|
|
Instructs Oracle Business Intelligence Presentation Services not to end particular sessions due to inactivity. |
|
|
Logs the user off Oracle Business Intelligence Presentation Services. |
|
|
Authenticates the user. |
|
|
Authenticates the user. Similar to the logon method, but logonex can specify optional session parameters. |
Use this method to retrieve the current user name for the session.
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. |
Use this method to retrieve the environment object for the current session.
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. |
This method returns a session environment object (for more information, see Section 2.25, "SessionEnvironment Structure").
Use this method to retrieve a list of session variables.
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. |
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.
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. |
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.
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.23, "SAWSessionParameters Structure". |
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, seeSection 2.5, "AuthResult Structure".
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.
Use this method to authenticate the user. If authentication fails, an exception is thrown.
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). |
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.
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.23, "SAWSessionParameters Structure". |
Use this service to provide methods for identifying accounts and privileges. Table 3-15 shows the supported methods.
Table 3-15 SecurityService Methods
| Method Names | Description |
|---|---|
|
Removes an Oracle BI EE Presentation Services internal ID to account name mapping. |
|
|
Searches for Oracle BI EE user accounts |
|
|
Gets the Access Control List for global privileges. |
|
|
Gets the list of all global privileges. |
|
|
Gets a list of catalog groups that are members of the account (for example, user or group |
|
|
Gets direct members of the catalog group. |
|
|
Get the list of permissions for the specified user. |
|
|
Lists all privileges and their statuses. |
|
|
Confirms if a catalog group is a member of the user or group. |
|
|
Adds a user to a catalog group as a member. |
|
|
Removes a member from a group. |
|
|
Change the name of an user account. |
|
|
Update the Access Control List for global privileges. |
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.
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. |
Use this method to search for Oracle BI EE user accounts (for example, LDAP users, catalog groups, or application roles).
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. |
Use this method to retrieve the Access Control List for global privileges.
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. |
Use this method to get a list of catalog groups that are members of the account (for example, user or group).
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. |
Use this method to get direct members of the catalog group.
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. |
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.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. |
Returns permissions information in the permissionMask field in the AccessControlToken structure (for more information, see Section 2.1, "AccessControlToken Structure").
Use this method to list all privileges and their statuses.
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. |
Use this method to confirm if a catalog group is a member of the user or group.
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. |
Use this method to join a catalog group as a member.
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. |
Use this method to remove a member from a group.
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. |
Use this method to change the name of a user account in the catalog.
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. |
Use this method to update the Access Control List for global privileges.
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.28, "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. |
Use this service to provide methods for navigating and managing the catalog, and to read and write catalog objects in XML format. Table 3-16 shows the supported methods.
Table 3-16 WebCatalogService Methods
| Method Names | Description |
|---|---|
|
Copies an object from one location to another in the catalog. |
|
|
Generates an archive file from the catalog. |
|
|
Creates a new folder in the catalog. |
|
|
Creates a link to the catalog. |
|
|
Deletes an object from the catalog. |
|
|
Retrieves catalog information for an object. |
|
|
Retrieves the collection of child subitems for an object in the catalog. |
|
|
Locks the catalog during maintenance. |
|
|
Moves an object in the catalog to a different location in the catalog. |
|
|
Pastes the copied items. |
|
|
Reads an object from the catalog. |
|
|
Deletes a folder from the catalog. |
|
|
Sets attribute flags for the specified catalog item. |
|
|
Sets a property for an object in the catalog. |
|
|
Take ownership of the specified item. |
|
|
Update the Access Control List for an item in the Presentation Catalog. |
|
|
Writes a list of objects to the catalog. |
This enumeration specifies a list of valid values for methods in the "WebCatalogService Service". Table 3-17 lists the values in this enumeration.
Note:
Only one of the values in ErrorDetailsLevel should be selected.Table 3-17 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. |
This enumeration specifies a list of valid values for methods in the "WebCatalogService Service". Table 3-18 lists the values in this enumeration.
Table 3-18 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. |
Use this method to copy an object from one location in the catalog to another location in the catalog.
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. |
Use this method to generate an archive file from the catalog.
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. |
Use this method to create a new folder in the catalog.
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. |
Use this method to create a link to the catalog.
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. |
Use this method to delete an object from the catalog. To delete a folder, read Section 3.10.14, "removeFolder() Method".
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. |
Use this method to retrieve catalog information for an object.
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. |
Returns catalog information for an object in an ItemInfo structure. For more information, see Section 2.11, "ItemInfo Structure".
Use this method to retrieve the collection of child sub-items for an object in the catalog.
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.9, "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. |
Returns a collection of child subitems in an ItemInfo structure. For more information, see Section 2.11, "ItemInfo Structure".
Use this method to lock the catalog during maintenance.
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. |
Use this method to move an object in the catalog to a different location in the catalog.
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. |
Use this method to paste the copied items.
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. |
Use this method to read an object from the catalog and return a CatalogObject structure.
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.7, "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. |
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.10.7, "deleteItem() Method".
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. |
Use this method to set attribute flags for a specified catalog item.
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 attributes | Specifies a combination of the following flags:
1 = read only 2 = archive 4 = hidden 8 = system |
| 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. |
Use this method to set a property for an object in the catalog.
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. |
Use this method to take ownership of the specified item.
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. |
Use this method to update the Access Control List for an item in the catalog.
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.29, "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. |
Use this method to write an array of objects to the catalog.
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.7, "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 CatalogObjects 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. |
Use this service to retrieve results from Oracle BI EE Presentation Services in XML format. Table 3-19 shows the supported methods.
Table 3-19 XMLView Service Methods
| Method Name | Description |
|---|---|
|
Cancels the current query. |
|
|
Runs a SQL query. |
|
|
Runs an XML query. |
|
|
Returns the next page of data rows. |
|
|
Returns a filter XML structure containing only the analysis' columns with a prompted filter. |
|
|
Returns an upgraded version of the requested object. |
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-20 lists the values in this enumeration.
Note:
Only one of the values in XMLQueryOutputFormat can be selected.Table 3-20 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. |
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.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.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.31, "XMLQueryExecutionOptions Structure"). |
| XMLQueryExecutionOptions executionOptions | Specifies the query execution options (for more information, see Section 2.31, "XMLQueryExecutionOptions Structure"). |
| String sessionID | Specifies the unique ID of the session. |
Returns the results of the query as one or more rows of data in a QueryResults structure (for more information, see Section 2.15, "QueryResults Structure").
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.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.31, "XMLQueryExecutionOptions Structure"). |
| XMLQueryExecutionOptions executionOptions | Specifies the query execution options (for more information, see Section 2.31, "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.17, "ReportParams Structure". |
| String sessionID | Specifies the unique ID of the session. |
Returns the results of the query as one or more rows of data in a QueryResults structure (for more information, see Section 2.15, "QueryResults Structure").
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.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. |
Returns the next page of query results as one or more rows of data in a QueryResults structure (for more information, seeSection 2.15, "QueryResults Structure").
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.
Use this method to upgrade Oracle BI EE objects that reside outside of the 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 will be upgraded before the query is run.