This chapter describes the structures used by the Oracle Business Intelligence Session-Based Web Services.
This document uses JavaScript-like syntax to describe 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 contains the following sections:
Use this structure to describe permissions granted to a specific account in the access control list. This structure is used in the"SecurityService Service".
Table 2-1 lists the fields in this structure.
Table 2-1 AccessControlToken Structure Fields
Fields | Description |
---|---|
Account account |
Specifies a reference to the Account structure. |
int permissionMask |
Specifies a combination of the following flags: 1 = Permission to read item content 2 = Permission to traverse directory 4 = Permission to change item content 8 = Permission to delete an item 16 = Permission to assign permissions to other accounts 32 = Permission to take ownership of the item 2048 = Permission to run an Oracle BI Publisher report live 4096 = Permission to schedule an Oracle BI Publisher report 8192 = Permission to view output from an Oracle BI Publisher report 65535 = Permission to grant full control of the item. |
Use this structure to hold user names or group names. It has a flag to indicate whether the name is a user or a group. This structure is used in the "SecurityService Service".
Table 2-2 lists the fields in this structure.
Table 2-2 Account Structure Fields
Fields | Description |
---|---|
String accountName |
Specifies an account name or group name. |
int accountType |
Specifies whether the account is a user or a group or both. Use accountType when it is:
0 = user 1 = catalog group 2 = initblock user 3 = invalid or deleted account |
int accountFindType |
Specifies whether the account is a user or a group or both. Use accountFindType when it is being used as an input to a "query" SOAP function (for example, as a parameter in calling getAccounts() ): 0 = find a user using name or GUID exact match 1 = find a catalog group using name or GUID exact match 2 = find a application role using name or GUID exact match 3 = find a user OR Catalog group OR application roles using name or GUID exact match Note the following information for advanced use of this field. If accountFindType is greater than or equal to 4, the system treats the Name or GUID as a pattern. 4 = find all users using name or GUID pattern match 5 = find all catalog groups using name or GUID pattern match 6 = find all application roles using name or GUID pattern match 7 = find all users AND webcat groups AND application roles using name or GUID pattern match Using this field in this way can be slow, and result in the system returning many records. When receiving an Account, both Name and GUID are set. |
String GUID |
Specifies the unique ID which identifies the account. |
Use this structure to hold the access control list (ACL). This structure is used in the "SecurityService Service".
Table 2-3 list the fields in this structure.
Table 2-3 ACL Structure Fields
Fields | Description |
---|---|
AccessControlToken[] accessControlTokens |
Specifies the full list of permissions. For more information, see Section 2.1, "AccessControlToken Structure". |
String dummy |
For internal purposes. |
Use this structure to hold information about the action attached to the scorecard. This structure is used in the "ActionLinks Structure".
Table 2-4 lists the fields in this structure.
Table 2-4 Action Structure Fields
Fields | Description |
---|---|
String Path |
Specifies the catalog path to the BI content that is the target of the Action (only appears when ActionLink is not a "BI Content" type). |
String ActionName |
Specifies the catalog object name of the action. |
String ClassName |
Specifies the java class to be called by an EJB Action. |
String ClassPath |
Specifies the Java path containing the jar. |
String AddnClassPath |
Specifies additional class path if the jar is not in the specified path. |
ParameterDocument[] ActionParameters |
Specifies an array of ParameterDocument objects. A ParameterDocument is a JavaScript object defining a single action parameter. For more information, see Section 2.36, "ParameterDocument Structure". |
String ActionType |
Specifies the type of action (not all action types are available, for example, depending on system setup, privileges): WebServiceActionType JavaActionType OldJavaActionType URLActionType InvokeURLActionType ScriptActionType ServerScriptActionType NavToBIActionType NavToEBSActionType NavToEPMActionType WorkflowActionType NavToCRMActionType ADFContextEventActionType |
String WebServerRegistry |
Specifies the individual web service details that the action will invoke. |
String WebService |
Specifies the individual web service details that the action will invoke. |
String WebOperation |
Specifies the individual web service details that the action will invoke. |
Use this structure to reference valid action links. This structure is used in the "ValidActionLinks Structure".
Table 2-5 lists the fields in this structure.
Table 2-5 ActionLinks Structure Fields
Fields | Description |
---|---|
String ActionPath |
Specifies the catalog path to the BI content that is the target of the ActionLink (only appears when the ActionLink is a "BI Content" type of Action Link). |
String Text |
Specifies the text that is shown to the user that they click on to invoke the Action. |
Action[] Action |
Specifies the Action details (only appears when the ActionLink is not a "BI Content" type). For more information, see Section 2.4, "Action Structure". |
Use this structure to specify the execution options when exporting an analysis. This structure is used in the "AnalysisExportViews Service."
Table 2-6 lists the fields in this structure.
Table 2-6 AnalysisExportExecutionOptions Structure Fields
Fields | Description |
---|---|
boolean async |
If set to TRUE, then asynchronous analysis export is enabled. If set to FALSE, asynchronous analysis export is disabled. |
boolean useMtom |
If set to TRUE, then MTOM is used to encode the content returned by the SOAP message. |
boolean refresh |
If set to TRUE, then the server re-submits the query to refresh the data. If set to FALSE, then the Oracle Business Intelligence Server uses data in the cache. |
Use this structure to specify the execution options when exporting the result. This structure is used in the "AnalysisExportViews Service."
Table 2-7 lists the fields in this structure.
Table 2-7 AnalysisExportResult Structure Fields
Fields | Description |
---|---|
viewData |
Specifies the returned content of the view data in the format specified in the AnalysisExportOutputFormat. For more information, see "initiateAnalysisExport () Method." |
String mimeType |
Specifies mime type of view data returned. |
String queryID |
Specifies query ID of the request. You use this as a parameter in completeAnalysisExport method. For more information, see |
completeAnalysisExport |
Specifies the status of the download request. The values are:
|
Use this structure to specify a list of GUIDs representing a saved result set. This structure is used in the "SecurityService Service".
Table 2-8 lists the field in this structure.
Use this structure to contain a single assessment for a particular QDR for a node in a strategy tree. This structure is used in the "ScorecardAssessmentService Service".
Table 2-9 lists the fields in this structure.
Table 2-9 AssessmentResult Structure Fields
Fields | Description |
---|---|
String ScorecardPath |
Specifies the Presentation Services catalog path to the folder containing the scorecard that was assessed. |
Variable[] Variables |
Specifies an array of Variable objects defining the QDR for which the assessment result is applicable. For more information, see Section 2.64, "Variable Structure Fields". |
String GUID |
Specifies the GUID identifying the node of the strategy tree for which this assessment result is for. |
Enumeration Assessment |
Specifies the status ID for the node or QDR. |
Number Assessment |
Specifies the normalized assessment result for the strategy node. A number between 0 and 100. The number is not only an integer and so can include decimal places. |
String ObjectContext |
Specifies the object context representing the instance of the strategy node. |
String ObjectContext |
Specifies the object context representing the instance of the strategy node. |
Boolean IsAnnotated |
Specifies the value of a flag indicating if the node is annotated (true) or not (false). |
KPIResultColumn[] KPIResultColumns |
Specifies an array of KPIResultColumn objects defining the KPI results, if the node is a KPI node. For more information, see Section 2.31, "KPIResultColumn Structure". |
Boolean IsOverridden |
Specifies whether the node is overridden (true) or not (false). |
ValidActionLink[] ValidActionLinks |
Specifies an array of link elements defining the actions links for the current evaluated status. For more information, see Section 2.63, "ValidActionLinks Structure". |
Use this structure to specify authorization details during an authentication. This structure is used in the "SecurityService Service" (in the "impersonateex() Method" and "logonex() Method").
Table 2-10 lists the fields in this structure.
Table 2-10 AuthResult Structure Fields
Fields | 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. |
boolean authCompleted |
If set to TRUE, then the authorization is complete. If set to FALSE, then the authorization process is in progress and the logonex or impersonatex process should be called again. |
Use this structure to filter catalog items and changes based on the path and timestamp.
Table 2-11 lists the fields in this structure.
Table 2-11 CatalogItemsFilter Structure Fields
Fields | Description |
---|---|
String[] items |
Specifies the list of folders and their descendants to include in the filter. If this value is null, then all nodes in the catalog are included. |
Calendar from |
Specifies the time period on which to filter. Only items and changes with timestamps within that period satisfy the filter. Either or both of those fields could be null, in which case corresponding bound is considered not set. |
Calendar to |
Specifies the time period on which to filter. Only items and changes with timestamps within that period satisfy the filter (from <= timestamp <= to). Either or both of those fields could be null, in which case the corresponding bound is considered not set. |
Use this structure to retrieve or specify all information for a particular catalog object in a single method. This structure is used in the "WebCatalogService Service".
Table 2-12 lists the fields in this structure.
Table 2-12 CatalogObject Structure Fields
Fields | Description |
---|---|
String catalogObject |
Specifies an XML representation of the object. |
catalogObjectBytes |
Specifies the returned content of the catalog object as string or bytes. What you specify in this field is determined by the readObjects method. |
ItemInfo itemInfo |
Specifies catalog information about the object, supplied in the ItemInfo common structure. For information about the ItemInfo structure, see Section 2.21, "ItemInfo Structure". |
ErrorInfo errorInfo |
Specifies the level of error information to be supplied as specified by the ErrorDetails argument in the readObjects method. |
Use this structure to describe a single causal linkage. This structure is used in the "ScorecardMetadataService Service".
Table 2-13 lists the fields in this structure.
Table 2-13 CausalLinkage Structure Fields
Fields | Description |
---|---|
String ID |
Specifies the GUID of this causal linkage. |
String causeNodeID |
Specifies the GUID of the strategy or initiative node at the cause end of the link. |
String effectNodeID |
Specifies the GUID of the strategy or initiative node at the "effect" end of the link. |
String Strength |
Specifies the strength of the relationship. Defined using one of the values in the Section 2.13.1, "Strength Enumeration". |
String Interaction |
Specifies the proportionality of the relationship. Defined using one of the statics in the Section 2.13.2, "Interaction Enumeration". |
String Operation |
Specifies what you want to do with the specified CausalLinkage. Can be one of the values ADD, UPDATE or DELETE. |
This enumeration describes values of the various supported link strengths. This enumeration is used in the "CausalLinkage Structure".
Table 2-14 lists the values in this enumeration.
This enumeration describes values of the various supported link strengths. This enumeration is used in the "CausalLinkage Structure".
Table 2-15 lists the values in this enumeration.
This enumeration describes values of the operation. This enumeration is used in the "CausalLinkage Structure".
Table 2-16 lists the values in this enumeration.
Use this structure to retrieve dimensions. This structure is used in the "ValidActionLinks Structure".
Table 2-17 lists the fields in this structure.
Use this structure to retrieve error information during Presentation Catalog Service method invocations. This structure is used in the "WebCatalogService Service".
Table 2-18 lists the fields in this structure.
Table 2-18 ErrorInfo Structure Fields
Fields | Description |
---|---|
String code |
Specifies the error code to display. |
String context |
Specifies the service and method in which the error occurred. |
String details |
Specifies detailed information about the error. |
String message |
Specifies a human-readable description of the error. |
Use this structure to retrieve favorite item information during Presentation Catalog Service method invocations. This structure is used in the "UserPersonalizationService Service".
Table 2-20 lists the fields in this structure.
Table 2-19 FavoriteItem Structure Fields
Fields | Description |
---|---|
String name |
Specifies the favorite or category name. |
String path |
Specifies the path of catalog object in case of favorite item or category path in favorite manager in case category object. |
UnsignedShort type |
Specifies the type stored in FavoriteItem object: FavoriteItem = 0 Category Object = 1 |
ItemInfo itemInfo |
Specifies catalog information about the object, supplied in the ItemInfo common structure. Valid and stores the actual catalog object if type is 0. Not valid if type is 1. For information about the ItemInfo structure, see Section 2.21, "ItemInfo Structure". |
FavoriteItem favoriteItem |
A list of sub items in case type is 1 otherwise not a valid value. |
Use this structure to hold the name and type of an account that will be removed from the catalog. This structure is used in the "SecurityService Service".
Table 2-20 lists the fields in this structure.
Use this structure to hold the status of the delete accounts operation for each account. This structure is used in the "SecurityService Service".
Table 2-21 lists the fields in this structure.
Use this structure to hold the overall status of the delete accounts operation. This structure is used in the "SecurityService Service".
Table 2-22 lists the fields in this structure.
Table 2-22 ForgetAccountsStatus Structure Fields
Fields | Description |
---|---|
int Status |
Specifies the status of the overall delete accounts operation. The status values are:
|
ForgetAccountResult[] accountsResult |
Specifies the account name and account type with Success or Fail message for each account. |
Use this structure to contain optional parameters used in a getSubItems method. This structure is used in the "WebCatalogService Service".
Table 2-23 lists the fields in this structure.
Table 2-23 GetSubItemsParams Structure Fields
Fields | Descriptions |
---|---|
GetSubItemsFilter filter |
For internal use only. |
boolean includeACL |
If set to TRUE, then ACL information is included in the resulting ItemInfo structures. |
int withPermission and int withPermissionMask |
Specifies that you want to filter the resulting items collection by access level. The only items included in the result are those for which the following expression is true: (itemPermission & withPermissionMask) = (withPermission & withPermissionMask) where |
int withAttributes and int withAttributesMask |
Specifies that you want to filter the resulting items collection by attribute flags. The only items included in the result are those for which the following expression is true: (itemAttributes & withAttributesMask) = (withAttributes & withAttributesMask) Where |
Use this structure to contain catalog information about an object. This structure is used in the "WebCatalogService Service" and "ScorecardMetadataService Service".
Table 2-24 lists the fields in this structure.
Table 2-24 ItemInfo Structure Fields
Fields | Description |
---|---|
String path |
Specifies the path to the object in the catalog. For example, /users/jchan/analyses/. |
ItemInfoType type |
Specifies a character string that indicates the type. Valid values are:
|
String caption |
Specifies the localized name of the object in the catalog. For example, in French, 'My Folders' is displayed as 'Mes Dossiers'. |
int attributes |
Specifies a combination of the following flags: 1 = read only 2 = archive 4 = hidden 8 = system |
Calendar lastModified |
Specifies the date and time that the object was last modified, in Calendar format. |
Calendar created |
Specifies the date and time that the object was created (saved) in the catalog, in Calendar format. |
Calendar accessed |
Specifies the data and time that the object was last accessed by a user, in Calendar format. |
String signature |
Specifies the signature of the catalog object. |
NameValuePair[] itemProperties |
Specifies an array of object properties. |
ACL aclXX |
Specifies the Access Control List for this catalog item. |
Account owner |
Specifies the owner of the object. |
String targetPath |
If the ItemInfoType field is set to "Link," this field specifies the target path for the object. |
Use this structure to contain information about jobs. This structure is used in the "SchedulerService Service".
Table 2-25 lists the fields in this structure.
For more information, see "Oracle BI Scheduler Job Manager Menus" in Oracle Fusion Middleware Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition.
Some Job properties are optional, and may not be present if not relevant to the Job (for example, depending on the Job Trigger type).
Table 2-25 Job Structure Fields
Fields | Description |
---|---|
Job Reference |
A unique reference for the job associated with an instance. |
Name |
A short descriptive name for the job. |
Description |
The text description of the job that describes its actions to end users. |
User ID (author ID) |
The user ID that created the job. |
Script Type |
The type of script used to run the job (VBScript, JScript, Java, or NQCmd). |
Script ID (Path of Agent) |
The path to the script that runs the job. Use to call the WebCatalogService API to return the agent definition. For more information, see Section 3.10.8.5, "Example - Finding and Displaying all Agents in the WebCatalogService". |
Max Run Time (in ms) |
The maximum time in milliseconds that the job can run. |
Running Instances Count |
The total number of currently running instances of this job. |
Max Concurrent Instances |
The maximum number of concurrent running instances. For an unlimited number of concurrent instances, set this value to zero. |
Time Zone |
The time zone that is used to execute the job. If missing the timezone is assumed to be the scheduler local timezone. |
Last Run Date Time |
The last date and time the job started to execute. |
Next Run Date Time |
The next date and time the job will execute. |
Begin Date |
The date when the first recurrent interval runs. |
Start Time |
The time the job starts. |
End Date |
The date when the first recurrent interval ends. |
End Time |
The time the job completes. |
Interval Minutes |
The number of minutes between subsequent executions of a job during the recurrent interval. |
Disabled |
Specifies that a job script does not execute when the trigger expires. |
Delete Job When Done |
Specifies whether to delete a job after it completes. |
Execute When Missed |
Specifies whether to execute a job if running it has failed to occur at the scheduled time. |
Job Trigger (with details depending on type) |
Specifies what triggers a job including details that depend on job type. A Job Trigger can be one of the following values: RunNever, RunOnce, RunDaily, RunWeekly, RunMonthlyByDate, RunMonthlyByDayOfWeek. |
Use this structure to filter job lists. This structure is used in the "SchedulerService Service".
Table 2-26 lists the fields in this structure.
Use this structure to contain information about a job instance corresponding to a running, completed, or cancelled job. This structure is used in the "SchedulerService Service".
Table 2-27 lists the fields in this structure.
For more information, see "Oracle BI Scheduler Job Manager Menus" in Oracle Fusion Middleware Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition.
Table 2-27 JobInstance Structure Fields
Fields | Description |
---|---|
Job Reference |
A unique reference for the job associated with the job instance. |
Job Instance Reference |
A unique reference for the job instance. |
Job Instance Status |
The current status of the job instance. Valid values are:
|
Begin Date Time |
The day and time that the scheduler initiated the job instance. |
End Date Time |
The day and time that the job scheduler completed the job instance. |
Successful Deliveries |
The number of successful deliveries for this job instance. |
Error Message |
The error message, warning, or general message about the job instance execution. |
Use this structure to filter job instance lists. This structure is used in the "SchedulerService Service".
Table 2-28 lists the fields in this structure.
Table 2-28 JobInstanceFilter Structure Fields
Fields | Description |
---|---|
List of JobReference (Authors) |
(Mandatory) If no Job References are specified then all JobReferences are returned. |
Job Instance Status |
(Optional) The current status of the Job instance. Valid values are:
|
Use this enumeration to define job instance state. This enumeration is used in the "SchedulerService Service".
Table 2-29 lists the values in this enumeration.
Use this structure to group a job and its associated instances. This is important when a list of job references are specified as the selection criteria for job instance listing. This structure is used in the "SchedulerService Service".
Table 2-30 lists the fields in this structure.
For more information, see "Oracle BI Scheduler Job Manager Menus" in Oracle Fusion Middleware Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition.
This enumeration specifies a list of valid values for the KPIColumnName field. This enumeration is used in the "KPIAssessmentService Service" and is used by the "KPIResultColumn Structure".
Table 2-31 lists the values in this enumeration.
Table 2-31 KPIColumnName Enumeration Values
Values | Description |
---|---|
String NAME |
The column name. |
String STATUS |
The status column name. |
String ACTUAL_VALUE |
The actual values column name. |
String TARGET_VALUE |
The target value column name. |
String VARIANCE |
The variance column name. |
String VARIANCE_PERCENT |
The variance percent column name. |
String CHANGE |
The change column name. |
String CHANGE_PERCENT |
The change percent column name. |
String TREND |
The trend column name. |
String OBJECT_CONTEXT |
The object context column name. |
String STATUS_INFO |
The status info column name. |
String OWNER |
The owner column name. |
String DIMENSION_CONTEXT |
The dimension context column name. |
String CUSTOM_COLUMN1 |
A custom column name. |
String CUSTOM_COLUMN2 |
A custom column name. |
String CUSTOM_COLUMN5 |
A custom column name. |
Use this structure to contain the metadata for an individual dimension pinning used when defining the QDR for a KPI when requesting assessments. This structure is used in the "KPIRequest Structure".
Table 2-32 lists the fields in this structure.
Table 2-32 KPIDimensionPinning Structure Fields
Fields | Description |
---|---|
String DimensionID |
Specifies the ID of the dimension that you want to pin to a specific value (or values). |
String Value |
Specifies the value that you want to pin the specified dimension to. |
String VariableType |
Specifies the type of variable containing the value you want to use to pin the specified dimension. |
String VariableName |
(Optional) Specifies the name of the variable containing the value you want to use to pin the specified dimension (may be left null if VariableType is NONE). |
String LevelID |
(Optional) Specifies the ID of the dimension level the specified value belongs to (may be left null if the dimension is not a Level or Value Hierarchy). |
Use this structure to contain the information required to request assessment values for the specified KPI. This structure is used in the "KPIAssessmentService Service".
Table 2-33 lists the fields in this structure.
Table 2-33 KPIRequest Structure Fields
Fields | Description |
---|---|
String Path |
Specifies the KPI's Presentation Services catalog path. |
KPIDimensionPinning[] KPIDimensionPinnings |
Specifies an array of dimension pinnings that define the filters to be applied to the query. For more information, see Section 2.29, "KPIDimensionPinning Structure Fields". |
Use this structure to contain a single assessment for a particular QDR for a node in a strategy tree. This structure is used in the "ScorecardAssessmentService Service".
Table 2-34 lists the fields in this structure.
Table 2-34 KPIResultColumn Structure Fields
Fields | Description |
---|---|
String Name |
Specifies the column name that the cell belongs to. For more information, see Section 2.28, "KPIColumnName Enumeration Values". |
String Type |
Specifies the cell's data type. |
String Value |
Specifies the cell's value. |
String FormattedValue |
Specifies the formatted value. |
String ObjectContext |
Specifies the QDR that was applied to the query that returned this cell. |
Boolean IsAnnotated |
Specifies whether the cell has been annotated (true) or not (false). |
Use this structure to retrieve most recently used (MRU) item information during Presentation Catalog Service method invocations. This structure is used in the "UserPersonalizationService Service".
Table 2-35 lists the fields in this structure.
Table 2-35 MRUItem Structure Fields
Fields | Description |
---|---|
String catalogPath |
Specifies the catalog path for the recent catalog object. |
Boolean isFavorite |
Specifies if the MRU item is a favorite item as well. |
ItemInfo itemInfo |
Specifies catalog information about the object, supplied in the ItemInfo common structure. For information about the ItemInfo structure, see Section 2.21, "ItemInfo Structure". |
Use this structure to denote named properties, such as COLOR=RED. This structure is used in the "WebCatalogService Service".
Table 2-36 lists the fields in this structure.
Use this structure to contain the information that identifies a single node. This structure is used in the "ScorecardAssessmentService Service".
Table 2-37 lists the fields in this structure.
Table 2-37 NodeInfo Structure Fields
Fields | Description |
---|---|
String NodeType |
Specifies the type of node. For more information, see Section 2.34.1, "NodeTypes Enumeration". |
String NodeID |
Specifies the node's GUID. |
This enumeration defines the values for the different types of nodes. This enumeration is used in the "NodeInfo Structure".
Table 2-38 lists the values in this enumeration.
Use this structure to specify the location to which you want to copy the data included in the export method.
Table 2-39 lists the fields in this structure.
Use this structure to model a parameter, as used by the Action framework. This structure is used in the "Action Structure".
Table 2-40 lists the fields in this structure.
Table 2-40 ParameterDocument Structure Fields
Fields | Description |
---|---|
String Name |
Specifies the name (title) of the parameter. |
String Prompt |
Specifies the prompt displayed to the user for this parameter. |
String Description |
Specifies the description of the parameter document (sometimes displayed as a tooltip). |
String ParameterType |
Specifies the datatype of the parameter which should be one of the following: string integer long float double short decimal boolean byte date dateTime time document |
Array[] ParameterValues |
Specifies an array of parameter value objects. This could be an empty array, or an array with one or more parameter values (see MultiValuesAllowed). For more information, see Section 2.37, "ParameterValue Structure" |
String ValueFixed |
Specifies whether the parameter values are fixed for this parameter (cannot be overridden). Values are 'true' or 'false'. |
String Order |
Specifies the particular order of parameters in which the owning documents want to keep them. |
String MultiValuesAllowed |
Specifies if the parameter supports multiple values. Values are 'true' or 'false'. |
String Mandatory |
Specifies whether user entry of a value is mandatory.Values are 'true' or 'false'. |
Use this structure to model a parameter value, as used by the ParameterDocument structure. A ParameterDocument owns an array of zero or more of these. This structure is used in the "ParameterDocument Structure".
Table 2-41 lists the fields in this structure.
Table 2-41 ParameterValue Structure Fields
Fields | Description |
---|---|
String Value |
Specifies the value. Defaults to an empty string. |
String ValueMapping |
Specifies the type of parameter value, which should be one of the following: value session repository presentation colrequest request column catalog date time dateTime |
String AltDisplayValue |
Specifies an alternative display value, for when the actual value is a code. |
Use these structures to specify the prompts in the "getPromptElements Method" of the"ReportEditingService Service."
This section consists of the following structures:
Section 2.38.6, "IndividualPromptRunTimeInfoLimitedByInfo Structure"
Section 2.38.8, "IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure"
Section 2.38.9, "IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo Structure"
Section 2.38.10, "IndividualPromptRunTimeInfoDataTypeHierarchyLevels Structure"
Section 2.38.11, "IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels Structure"
Section 2.38.12, "IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure"
Section 2.38.13, "IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo Structure"
Section 2.38.14, "IndividualPromptRunTimeInfoDataType Structure"
Section 2.38.15, "IndividualPromptRunTimeInfoSingleValueType Structure"
Section 2.38.16, "IndividualPromptRunTimeInfoValuesType Structure"
Section 2.38.17, "IndividualPromptRunTimeInfoCurrentValues Structure"
Section 2.38.18, "IndividualPromptRunTimeInfoAvailableOptions Structure"
Section 2.38.19, "IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure"
Section 2.38.20, "IndividualPromptRunTimeInfoLimitedByPromptReference Structure"
Section 2.38.21, "IndividualPromptRunTimeInfoLimitedByPromptRefGroups Structure"
Use this structure to specify the object model of the prompt.This prompt structure is used in the "getPromptElements Method."
Table 2-42 lists the fields in this structure.
Table 2-42 PromptsObjectModel Structure Fields
Fields | Description |
---|---|
String name |
Specifies the name of the prompt. |
String description |
Specifies the description of the prompt. |
String scope |
Specifies the scope of the prompt. |
String subjectArea |
Specifies the subject area of the prompt. |
String layout |
Specifies the layout of the prompt. |
PromptCollectionRunTimeInfo runTimeInfo |
Specifies the run time information of the prompt collection. For more information, see "PromptCollectionRunTimeInfo Structure." |
PromptStepObjectModel promptStepObj |
Specifies the object model of the prompt state. For more information, see "PromptStepObjectModel Structure." |
Use this structure to specify the run time information of the prompt collection. This prompt is used in the "getPromptElements Method."
Table 2-43 lists the fields in this structure.
Table 2-43 PromptCollectionRunTimeInfo Structure Fields
Fields | Description |
---|---|
String collectionID |
Specifies the collection ID of the prompt. |
String viewStatePath |
Specifies the view state path of the prompt. |
Int currentStep |
Specifies the current step of the prompt. |
Boolean reloadInline |
Specifies whether to reload the prompt inline (true) or not (false). |
Boolean supportAutoComplete |
Specifies whether the prompt auto completes (true) or not (false). |
Boolean showReturnLink |
Specifies whether the prompt displays a return link (true) or not (false). |
String currentAction |
Specifies the current action of the prompt. |
Use this structure to specify the step object model of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-44 lists the fields in this structure.
Table 2-44 PromptStepObjectModel Structure Fields
Fields | Description |
---|---|
String title |
Specifies the title of the prompt. |
String instruction |
Specifies the instruction of the prompt. |
String buttonsPosition |
Specifies the position of the button in the prompt. |
String labelPosition |
Specifies the position of the label in the prompt. |
String wrapLabelText |
Specifies the wrap label text in the prompt. |
String customWidthUsage |
Specifies custom width usage of the prompt. |
String customWidthWidth |
Specifies custom width of the prompt. |
String setWidthToAllPrompts |
Specifies whether width applies to all prompts. |
Boolean autoApplyPrompt |
Specifies whether the prompt is applied automatically (true) or not (false). |
Boolean showResetButton |
Specifies whether the prompt displays a Reset button (true) or not (false). |
PromptStepRunTimeInfo runTimeInfo (nillable) |
Specifies the run time information for the prompt step. This can be null. |
IndividualPromptObjectModel[] promptObj |
Species an array of prompt object models. For more information, see "IndividualPromptObjectModel Structure." |
Use this structure to specify the step run time information of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-45 lists the fields in this structure.
Table 2-45 PromptStepRunTimeInfo Structure Fields
Fields | Description |
---|---|
Boolean applyToAllSteps |
Specifies whether the prompt applies to all steps (true) or not (false). |
Boolean autoApplyPrompt |
Specifies whether the prompt is applied automatically (true) or not (false). |
Boolean showResetButton |
Specifies whether the prompt displays the Reset button(true) or not (false). |
Int remaininglRequiredPromptsOnSubsequentSteps |
Specifies the required prompts on subsequent steps. |
Int firstPromptStartIndex |
Specifies the index of the first prompt. |
Use this structure to specify the prompt object model of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-46 lists the fields in this structure.
Table 2-46 IndividualPromptObjectModel Structure Fields
Fields | Description |
---|---|
String label |
Specifies the label of the prompt. |
String description |
Specifies the description of the prompt. |
String type |
Specifies the type of prompt. |
String subjectArea |
Specifies the subject area of the prompt. |
Boolean placedOnNewColumn |
Specifies whether the prompt is applied on a new column (true) or not (false). |
Boolean required |
Specifies whether the prompt is required (true) or not (false). |
String formulaExprString |
Specifies the formula expression of the prompt. |
String promptUIControlType |
Specifies the user interface control type of the prompt. |
String promptOperator |
Specifies the prompt operator. |
String customWidthUsage |
Specifies the custom width usage of the prompt. |
String customWidthWidth |
Specifies the custom width of the prompt. |
String setPromptVariableType |
Specifies the prompt variable type of the prompt. |
String setVariableName |
Specifies the variable name of the prompt. |
IndividualPromptRunTimeInfoLimitedByInfo limitedByInfo |
Specifies the limited by information of a prompt. For more information, see "IndividualPromptRunTimeInfoLimitedByInfo Structure." |
IndividualPromptRunTimeInfo runTimeInfo |
Specifies the run time information of a prompt. For more information, see "IndividualPromptRunTimeInfo Structure." |
Use this structure to specify the run time limited information of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-47 lists the fields in this structure.
Table 2-47 IndividualPromptRunTimeInfoLimitedByInfo Structure Fields
Fields | Description |
---|---|
String limitedByType |
Specifies whether the prompt is limited by other prompt types, such as none, allPrompts, and specificPrompts. |
Boolean isLimitedByNotApplied |
Specifies whether constraint is applied to the prompt (true) or not (false). |
IndividualPromptRunTimeInfoLimitedByPromptRefGroups specificPrompts |
Specifies prompts that limit this prompt. |
Use this structure to specify the run time information of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-48 lists the fields in this structure.
Table 2-48 IndividualPromptRunTimeInfo Structure Fields
Fields | Description |
---|---|
Int promptID |
Specifies the prompt ID. |
Boolean allowUserTypeValues |
Specifies whether the user is allowed to type the values of the prompt (true) or not (false). |
Boolean allowAutoComplete |
Specifies whether the prompt auto completes (true) or not (false). |
Boolean multiSelect |
Specifies whether the prompt allows multiple selections (true) or not (false). |
String showSearch |
Specifies to show the search of the prompt. |
IndividualPromptRunTimeInfoDataType dataType |
Specifies the data type information of a prompt. For more information, see "IndividualPromptRunTimeInfoDataType Structure." |
IndividualPromptRunTimeInfoCurrentValues currentValues |
Specifies the current values of a prompt. For more information, see "IndividualPromptRunTimeInfoCurrentValues Structure." |
IndividualPromptRunTimeInfoAvailableOptions availableOptions |
Specifies the available options for a prompt. For more information, see "IndividualPromptRunTimeInfoAvailableOptions Structure." |
IndividualPromptRunTimeInfoAdditionalAttributes attributes |
Specifies the additional attributes of a prompt. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure." |
Use this structure to specify the SQL information of the hierarchy level of the display column of the prompt. This prompt is used in the "getPromptElements Method."
Table 2-49 lists the fields in this structure.
Table 2-49 IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure Fields
Fields | Description |
---|---|
String displayFormula |
Specifies the display formula of the prompt. |
String sqlFormula |
Specifies the SQL formula of the prompt. |
String dataType |
Specifies the data type of the prompt. |
String category |
Specifies the category of the prompt. |
String primaryType |
Specifies the primary type of the prompt. |
Boolean nullable |
Specifies whether the prompt displays a nullable value (true) or not (false). |
Boolean isMeasure |
If set to TRUE, the prompt displays a measure. If set to FALSE, the prompt displays an attribute. |
String aggType |
Specifies the aggregate type of the prompt. |
String aggRule |
Species the aggregate rule of the prompt. |
Use this structure to specify the level information of a prompt based on a hierarchy column. This prompt is used in the "getPromptElements Method."
Table 2-50 lists the fields in this structure.
Table 2-50 IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo Structure Fields
Fields | Description |
---|---|
String levelID |
Specifies the level ID of the prompt. |
String displayName |
Specifies the display name of the prompt. |
String displayFormula |
Specifies the display formula of the prompt. |
String sqlFormula |
Specifies the SQL formula of the prompt. |
Boolean isDoubleColumn |
Specifies whether the prompt displays a double column (true) or not (false). |
IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo keyColumnInfo |
Specifies the SQL information of the hierarchy level of the key column of the prompt if the prompt column is a hierarchy level. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure." |
IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo displayColumnInfo |
Specifies the SQL information of the hierarchy level of the display column of the prompt if the prompt column is a hierarchy level. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure." |
Use this structure to specify the levels of a prompt based on a hierarchy column. This prompt is used in the "getPromptElements Method."
Table 2-51 lists the field in this structure.
Table 2-51 IndividualPromptRunTimeInfoDataTypeHierarchyLevels Structure Fields
Fields | Description |
---|---|
IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo [] levelInfo |
Specifies an array of level information of a prompt based on a hierarchy column. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo Structure." |
Use this structure to specify the metadata/formula information of a prompt based on a hierarchy column. This prompt is used in the "getPromptElements Method."
Table 2-52 lists the fields in this structure.
Table 2-52 IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels Structure Fields
Fields | Description |
---|---|
String subjectArea |
Specifies the subject area of the prompt. |
String dimensionID |
Specifies the dimension of the prompt. |
String tableName |
Specifies the table name of the prompt. |
String hierarchyID |
Specifies the hierarchy ID of the prompt. |
String displayName |
Specifies the display name of the prompt. |
String tableDisplayName |
Specifies the display name of a table in the prompt. |
String hierarchyDisplayName |
Specifies the hierarchy display name of the prompt. |
String sqlFormulaIn2Parts |
Specifies the two part SQL formula of the prompt. |
String sqlFormulaDisplaySubjectAreaPart |
Specifies the subject area part of the SQL formula. |
IndividualPromptRunTimeInfoDataTypeHierarchyLevels levels |
Specifies the levels of a prompt based on a hierarchy column. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyLevels Structure." |
Use this structure to specify the hierarchy information of a prompt based on a hierarchy column. This prompt is used in the "getPromptElements Method."
Table 2-53 lists the fields in this structure.
Table 2-53 IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure Fields
Fields | Description |
---|---|
String hierarchyID |
Specifies the hierarchy ID of the prompt. |
String dimensionID |
Specifies the dimension ID of the prompt. |
String tableName |
Specifies the table name of the prompt. |
IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels formulaLevels |
Specifies the metadata/formula information for a prompt based on a hierarchy column. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels Structure." |
Use this structure to specify the information of a prompt based on a double column. This prompt is used in the "getPromptElements Method."
Table 2-54 lists the fields in this structure.
Table 2-54 IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo Structure Fields
Fields | Description |
---|---|
String codeColumnFormula |
Specifies the code column formula of the prompt. |
String codeColumnCategory |
Specifies the code column category of the prompt. |
String codeColumnPrimaryType |
Specifies the code of the column primary type of the prompt. |
String codeColumnDBPrimaryType |
Specifies the code of the database primary type of the prompt. |
Boolean enableDoubleColumnInput |
Specifies whether the prompt enables input in a double column (true) or not (false). |
String codeColumnLabel (nillable) |
Specifies the label of the code column for the prompt. |
Boolean selectedByCodeValue |
Specifies whether the prompt input is in code value (true) or not (false). |
Use this structure to specify the data type information of a prompt. This prompt is used in the "getPromptElements Method."
Table 2-55 lists the fields in this structure.
Table 2-55 IndividualPromptRunTimeInfoDataType Structure Fields
Fields | Description |
---|---|
String subjectArea |
Specifies the subject area for the prompt. |
String displayColumnFormula |
Specifies the column formula for the prompt. |
String displayColumnCategory |
Specifies the column category for the prompt. |
String displayColumnPrimaryType |
Specifies the column primary type for the prompt. |
String displayColumnDBPrimaryType |
Specifies the column data base primary type for the prompt. |
Boolean isMeasureColumn |
If set to TRUE, the report column is a measure. If set to FALSE, the report column is an attribute. |
String displayTimeZone |
Specifies the time zone for the prompt. |
Int dataTimeZoneOffset |
Specifies the data time zone offset for the prompt. |
Int displayToDataOffset |
Specifies the data offset for the prompt. |
String promptSourceDataType |
Specifies the source data type for the prompt display column. |
Boolean isHierarchy |
Specifies whether the prompt column is a hierarchy column (true) or not (false). |
IndividualPromptRunTimeInfoDataTypeHierarchyInfo hierarchyInfo (nillable) |
Specifies the hierarchy information of a prompt based on a hierarchy column. This argument can be null. For more information, see "IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure." |
Boolean isDoubleColumnInput |
Specifies whether the prompt input is in a double column (true) or not (false). |
IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo codeColumnInfo (nillable) |
Specifies the code column information of a prompt based on a double column. This argument can be null. For more information, see "IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo Structure." |
Use this structure to specify a single value for the prompt. This prompt is used in the "getPromptElements Method."
Table 2-56 lists the fields in this structure.
Table 2-56 IndividualPromptRunTimeInfoSingleValueType Structure Fields
Fields | Description |
---|---|
String eType |
Specifies the type of value in the structure. For example, SQL, customGroup, hierarchyLevels and so on. |
String caption |
Specifies the caption of the prompt. |
String codeValue |
Specifies the code value of the prompt. |
Use this structure to specify all values that are used by the prompt. This prompt is used in the "getPromptElements Method."
Table 2-57 lists the field in this structure.
Table 2-57 individualPromptRunTimeInfoValuesType Structure Fields
Fields | Description |
---|---|
IndividualPromptRunTimeInfoSingleValueType[] value |
Specifies an array of single values for the prompt. For more information, see "IndividualPromptRunTimeInfoSingleValueType Structure." |
Use this structure to specify the current values of a prompt. This prompt is used in the "getPromptElements Method."
Table 2-58 lists the fields in this structure.
Table 2-58 IndividualPromptRunTimeInfoCurrentValues Structure Fields
Fields | Description |
---|---|
String currentOperator |
Specifies the current operator of the prompt. |
Boolean emptyAsAllChoices |
Specifies whether an empty prompt defaults to all choices (true) or not (false). |
IndividualPromptRunTimeInfoValuesType values |
Specifies the values for the prompt. For more information, see "IndividualPromptRunTimeInfoValuesType Structure." |
Use this structure to specify the available options of a prompt. This prompt is used in the "getPromptElements Method."
Table 2-59 lists the fields in this structure.
Table 2-59 IndividualPromptRunTimeInfoAvailableOptions Structure Fields
Fields | Description |
---|---|
Int numOptionsPerPage |
Specifies the number of options per page. |
Int currentPageInOptions |
Specifies current page number. |
Boolean moreOptions |
Specifies whether the prompt consists of more options (true) or not (false). |
Boolean includeAllChoices |
Specifies whether the prompt include all choices (true) or not (false). |
Boolean needToPopulateDropDown |
Specifies whether the prompt requires you to populate the drop down (true) or not (false). |
String valueTablePromptSourceType |
Specifies the source type for the prompt. |
String sql |
Specifies the SQL for the prompt. |
String runTimeCodeAndDisplayValueFormatStr |
Specifies the format string for the values of the prompt. |
String filterXmlString (nillable) |
Specifies the xml filter of the prompt. |
IndividualPromptRunTimeInfoValuesType groupPaths (nillable) |
Specifies the values of the groups that are used by the prompt. This argument can be null. For more information, see "IndividualPromptRunTimeInfoValuesType Structure." |
IndividualPromptRunTimeInfoValuesType populatedOptions (nillable) |
Specifies the populated values that are used by the prompt. This argument can be null. For more information, see "IndividualPromptRunTimeInfoValuesType Structure." |
Use this structure to specify the additional attributes of a prompt. This prompt is used in the "getPromptElements Method."
Table 2-60 lists the fields in this structure.
Use this structure to specify prompts that limit this prompt.This prompt is used in the "getPromptElements Method."
Table 2-61 lists the fields in this structure.
Use this structure to specify prompts that limit the groups of this prompt. This prompt is used in the "getPromptElements Method."
Table 2-62 lists the field in this structure.
Table 2-62 IndividualPromptRunTimeInfoLimitedByPromptRefGroups Structure Fields
Fields | Description |
---|---|
IndividualPromptRunTimeInfoLimitedByPromptReference[] limitByPrompt |
Specifies an array of prompts that limit this prompt. For more information, see "IndividualPromptRunTimeInfoLimitedByPromptReference Structure." |
Use this structure to represent global privileges. In Oracle BI EE, you configure these privileges using the Manage Privileges screen. This structure is used in the "SecurityService Service".
Table 2-63 lists the fields in this structure.
Use this structure when purging job instances.This structure is used in the "SchedulerService Service".
Table 2-64 lists the fields in this structure. You must choose only one of the two properties.
Table 2-64 PurgeJobInstancesFilter Structure Fields
Fields | Description |
---|---|
List of JobReference |
(Optional) If no Job References are specified then all JobReferences are returned. |
JobInstanceStatus |
(Optional) The current status of the Job instance. Valid values are:
|
Use this structure to specify query details during query execution.This structure is used in the "XMLViewService Service" (in the executeXMLQuery method).
Table 2-65 lists the fields in this structure.
Table 2-65 QueryResults Structure Fields
Fields | Description |
---|---|
String rowset |
Specifies the rowset XML encoded in the string. |
String queryID |
Specifies the unique ID of the query, which can be used in fetchNext calls. |
boolean finished |
If set to TRUE, then there are no more rows to return. If set to FALSE, then another fetchNext call is needed to return more rows. |
Use this structure to hold the old name, new name and type of an account which will be renamed. This structure is used in the "SecurityService Service."
Table 2-66 lists the fields in this structure.
Use this structure to hold the status of the rename accounts operation for each account. This structure is used in the "SecurityService Service."
Table 2-68 lists the fields in this structure.
Table 2-67 RenameAccountResults Structure Fields
Fields | Description |
---|---|
String oldAccountName |
Specifies the old name of the account. |
String newAccountName |
Specifies the new name of the account. |
int accountType |
Specifies the type of account. |
int status |
Specifies the status of the overall rename accounts operation. The values are:
|
Use this structure to hold the overall status of the rename accounts operation. This structure is used in the "SecurityService Service."
Table 2-68 lists the fields in this structure.
Table 2-68 RenameAccountsStatus Structure Fields
Fields | Description |
---|---|
int status |
Specifies the status of the overall rename accounts operation. The values are:
|
RenameAccountResult[] accountsResult |
Specifies the old name, new name and account type with Success or Fail message for each account. |
Use this structure to define report parameters (prompt, filter, or variable). This structure is used in the "ReportEditingService Service.".
Table 2-69 lists the field in this structure.
Table 2-69 ReportADFParameters Structure Fields
Field | Description |
---|---|
String name |
Specifies the formula of the prompt, filter, or variable |
String operator |
Specifies the prompt operator |
String type |
Specifies the type of parameter (filter, prompt, or variable). |
String datatype |
Specifies the SQL datatype of the parameter |
String value |
Specifies the field used for an operator needing two operands. Other operators have values specified in the ADFParameterValues field. |
ADFParameterValues values |
Specifies the values for this parameter |
ADFParameterValues String [] |
Specifies an array of string values |
Use this structure to define options for displaying results on an HTML page. This structure is used in the "HtmlViewService Service".
Table 2-70 lists the field in this structure.
Table 2-70 ReportHTMLOptions Structure Field
Field | Description |
---|---|
boolean enableDelayLoading |
Internal use only. This field is always set to 1, which means that Oracle Business Intelligence web services is never required to provide results immediately, and displays a message indicating that it is waiting for results. |
String linkMode |
Specifies whether to display drills or links in the current browser window or a new browser window. For more information about valid values, see Section 2.46.1, "ReportHTMLLinksMode Enumeration". |
This enumeration specifies a list of valid values for the ReportHTMLLinksMode field in the "ReportHTMLOptions Structure".
Table 2-71 lists the values in this enumeration.
Table 2-71 ReportHTMLLinksMode Enumeration Values
Values | Description |
---|---|
String InPlace |
Specifies that drills or links should replace only the content of the current analysis without changing the rest of the page. |
String NewPage |
Specifies that drills or links should be displayed in a new browser window. |
String SamePage |
Specifies that drills or links should replace the current browser window. |
Use this structure to replace existing filters and variables in an analysis. This structure is common to all services in Oracle BI EE web services.
Table 2-72 lists the fields in this structure.
Table 2-72 ReportParams Structure Fields
Fields | Description |
---|---|
String[] filterExpressions |
Specifies an array of Oracle Business Intelligence web services filter expressions in the form Object[] filter_expression, filter_expression ... |
Variable[] variables |
Specifies an array of variable values to be set before method execution. This structure is used in Section 3.16.4, "executeXMLQuery() Method" and Section 3.8.4, "generateReportSQL() Method". For more information, see Section 2.64, "Variable Structure". |
NameValuePair[] nameValues |
Should be set to NULL. This field is for internal use only. |
TemplateInfo[] templateInfos |
Should be set to NULL. This field is for internal use only. |
String viewName |
Specifies which view to use when generating XML data for the analysis. |
Table 2-73 shows how filter expressions are applied to an analysis.
Table 2-73 How Filter Expressions Are Applied to an Analysis in Oracle BI EE Web Services
Step | Internal Processing |
---|---|
1 |
Obtains XML representations of the analysis and each filter expression. |
2 |
For each expression element, locates the child node of the type sqlExpression (the type is determined by the value of the xsi:type attribute), and references its inner text. |
3 |
In the analysis XML, locates all nodes that also have a child node of type sqlExpression where the inner text matches that located in the preceding step. |
4 |
Replaces all nodes found in Step 3 with the expression from Step 2. |
Table 2-74 shows how variables are applied to an analysis.
Table 2-74 How Variables Are Applied to an Analysis in Oracle BI EE Web Services
Step | Internal Processing |
---|---|
1 |
Obtains XML representations of the analysis. |
2 |
For each variable, locates all nodes in the analysis XML that have a type of variable, attribute scope equal to analysis, and inner text that matches the variable name. |
3 |
Replaces each node located in Step 2 with the new variable value. |
Use this structure to return column properties for a hierarchical column used in an analysis. This structure is used in "ReportEditingService Service."
Note:
System wide default column properties that apply to any of the report columns are returned in the report column properties.Table 2-75 lists the fields in this structure.
Table 2-75 ReportHierarchicalColumn Structure Fields
Fields | Description |
---|---|
String ID |
Specifies the column identifier of the report column |
String tableHeading |
Specifies the table heading of the report column |
String columnHeading |
Specifies the column heading of the report column |
Boolean hidden |
If set to TRUE, the column is hidden. If set to FALSE, the column is displayed. |
String subjectArea |
Specifies the subject area of the report column |
String tableName |
Specifies the table name of the report column |
String hierarchyID |
Specifies the hierarchy of the report column |
String dimensionID |
Specifies the dimension of the report column |
Use this structure to return column properties for a regular column used in an analysis. This structure is used in "ReportEditingService Service."
Note:
System wide default column properties that apply to any of the report columns are returned in the report column properties.Table 2-76 lists the fields in this structure.
Table 2-76 ReportRegularColumn Structure Fields
Fields | Description |
---|---|
String ID |
Specifies the column identifier of the report column |
String tableHeading |
Specifies the table heading of the report column |
String columnHeading |
Specifies the column heading of the report column |
Boolean hidden |
If set to TRUE, the column is hidden. If set to FALSE, the column is displayed. |
String sqlFormula |
Specifies the column formula of the report column |
Boolean measure |
If set to TRUE, the report column is a measure. If set to FALSE, the report column is an attribute column. |
aggrRule ReportColumnAggrRule |
If the column contains aggregated data, this value specifies the type of aggregation used in the column. For more information, see Section 2.49.1, "ColumnAggregationRule Values." |
The ReportRegularColumn structure specifies the default aggregation rule for the column. The following list shows the aggregation functions available:
Default
Server
Sum
Average
Count
CountDistinct
Max
Min
None
ServerAggregate
Unknown
Use this structure to reference an analysis in one of the following ways:
The location of the analysis in the catalog.
The ReportDef object that defines the analysis. This field should always be null.
The XML that defines the analysis.
Note:
Only one of the fields in ReportRef should be populated.The ReportRef structure is common to all services in Oracle BI EE web services.
Table 2-77 lists the fields in this structure.
Use this structure to represent the logical column in the Subject Area. This structure is used in the "MetadataService Service".
Table 2-78 lists the fields in this structure.
Table 2-78 SAColumn Structure Fields
Fields | Description |
---|---|
String name |
Specifies a column name used in SQL statements. |
String displayName |
Specifies a localized name, used in Oracle Business Intelligence Answers. |
String description |
Specifies a string to contain the description of the column name. |
boolean nullable |
If set to TRUE, then the column can be null. |
String dataType |
Specifies the type of data that a column contains. For more information, see Section 2.51.1, "SADataType Values". |
boolean aggregateable |
If set to TRUE, then the column can be aggregated. |
String aggrRule |
If the column contains aggregated data, this value specifies the type of aggregation used. For more information, see Section 2.51.2, "AggregationRule Values". |
The SADataType indicates the type of data that a column contains. The following list shows the data types available:
BigInt
Binary
Bit
Char
Coordinate
Date
Decimal
Double
Float
Integer
Invalid
LongVarBinary
LongVarChar
Numeric
Real
SmallInt
Time
TimeStamp
TinyInt
Unknown
VarBinary
VarChar
The SADataType specifies the default aggregation rule for the column. The following list shows the aggregation functions available:
Avg
BottomN
Complex
Count
CountDistinct
CountStar
DimensionAggr
First
Last
Max
Min
None
Percentile
Rank
ServerDefault
SubTotal
Sum
TopN
Use this structure to represent Subject Area attributes. This structure is used in the "MetadataService Service".
Table 2-79 lists the fields in this structure.
Table 2-79 SASubjectArea Structure Fields
Fields | Description |
---|---|
String name |
Specifies the table name that is used in SQL statements. |
String displayName |
Specifies the localized name, used in Oracle Business Intelligence Answers. |
String description |
Specifies the description of the subject area. |
SATable[] tables |
Specifies a collection of tables for this subject area. For information about the SATable structure, see Section 2.53, "SATable Structure". |
Use this structure to represent the logical table in the Subject Area. This structure is used in the "MetadataService Service".
Table 2-80 lists the fields in this structure.
Table 2-80 SATable Structure Fields
Fields | Description |
---|---|
String name |
Specifies the table name that is used in SQL statements. |
String displayName |
Specifies the localized name, used in Oracle Business Intelligence Answers. |
String description |
Specifies the description of the table name. |
SAColumn[] columns |
Specifies an array of the table's columns. For information about the SAColumn structure, see Section 2.51, "SAColumn Structure". |
Use this structure to define the locale for the current session. This structure is used in the "SAWSessionService Service".
Table 2-81 lists the fields in this structure.
Table 2-81 SAWLocale Structure Fields
Fields | Description |
---|---|
String language |
Specifies the language code. Values for language should conform to the ones used in Java, in the java.util.Locale class (ISO-639, ISO-3166). |
String country |
Specifies the country code. Values for country should conform to the ones used in Java, in the java.util.Locale class (ISO-639, ISO-3166). |
Use this structure to define optional parameters for the current session. This structure is used in the "SAWSessionService Service".
Table 2-82 lists the fields in this structure.
Table 2-82 SAWSessionParameters Structure Fields
Fields | Description |
---|---|
SAWLocale locale |
Specifies the locale to be used, supplied in the SAWLocale structure. For information about the SAWLocale structure, see Section 3.9, "SAWSessionService Service". |
String userAgent |
Specifies whether the HTMLView service is used with current session. It specifies the userAgent string of the browser, where Oracle Business Intelligence Presentation Services HTML content is displayed. Oracle Business Intelligence Presentation Services uses this information to produce browser-specific HTML. |
String syndicate |
Internal use only. |
LogonParameter logonParams |
Specifies the parameters used for authentication. |
boolean asyncLogon |
If set to TRUE, then asynchronous login is enabled. If set to FALSE (default), then asynchronous login is not enabled. |
String sessionID |
Specifies the unique ID of the session. This field is used in Section 3.9.9, "logonex() Method" and Section 3.9.5, "impersonateex() Method". |
Use this structure to define the segment or segment tree to override the defaults specified in the Oracle Marketing Analytics user interface. This structure is used in the "MetadataService Service".
Table 2-83 lists the fields in this structure.
Table 2-83 SegmentationOptions Structure Fields
Fields | Description |
---|---|
OverrideType cacheOverride |
Specifies how you want to override the Oracle Marketing Analytics' "Cache the block for future update counts requests" user interface option. If set to Default, then the cache override is not specified in the structure or the structure is not specified. The Default value specifies to use what is defined in the user interface option for each criteria block. If set to None, the system overrides the user interface-defined values and sets all criteria blocks to disable the "Cache the block for future update counts requests" user interface option. If set to All, the system overrides the user interface-defined values and sets all criteria blocks to enable the "Cache the block for future update counts requests" user interface option. |
OverrideType countOverride |
Specifies if the system should use the getCounts method to generate the count numbers. If set to Default, then the count override is not specified in the structure or the structure is not specified. If set to All, the system executes the getCounts method. When set to All, the system calculates count numbers for all criteria blocks. |
NameValuePair |
Specifies a value to enforce the corresponding contract planning rules for the segment or segment tree. |
NameValuePair |
Specifies the prompt values to apply to the columns in the segment or segment tree. This process filters data when generating counts. If you do not provide a value in this field, then the system does not apply filter criteria to columns in segments. |
Boolean removeCacheHits |
Specifies that you want to clear cache entries that contain count information. If set to True, the system queries against the most current data. To do this, the system removes all existing cache entries that contain count information for the target segment or segment tree. The system then repopulates the cache with new count number entries calculated by the getCounts method. |
BigDecimal samplingFactor |
Specifies the size of the data set for calculating counts. The getCounts method calculates the count number of all criteria blocks against a subset of the data determined by this value. The default value is 100. The default value determines that the count number is calculated against the whole data set. |
Use this structure to return environment information for the current session. This structure is used in the "SAWSessionService Service".
Table 2-84 lists the fields in this structure.
Table 2-84 SessionEnvironment Structure Fields
Fields | Description |
---|---|
String userName |
Specifies the name of the current user. |
ItemInfo homeDirectory |
Specifies the full path to the user's home directory in the catalog. For example, /users/<user login ID>. |
ItemInfo[] SharedDirectories |
Specifies the full paths to shared directories to which the current user has at least read access. Note: By default, only administrators are allowed to list direct descendents of the "/shared" directory. Retrieving the SessionEnvironment object is the only way to enable users to navigate its shared area. |
Use this structure to define options in startPage method invocations. This structure is used in the "HtmlViewService Service".
Table 2-85 lists the fields in this structure.
Table 2-85 StartPageParams Structure Fields
Fields | Description |
---|---|
String idsPrefix |
Specifies a prefix to be used with IDs and names of all HTML elements to avoid name conflicts on an HTML page. |
boolean dontUseHttpCookies |
If set to TRUE, thenOracle Business Intelligence Presentation Services cannot rely on cookies for passing the sessionID. Instead, the sessionID is included as a parameter in callback URLs. |
This enumeration specifies the static definitions for the various different TreeFlag values that can be returned as part of a nodes assessment. This enumeration is used in the "KPIAssessmentService Service".
Table 2-86 lists the values in this enumeration.
Table 2-86 TreeFlags Enumeration Values
Values | Description |
---|---|
Integer STRATEGY |
Specifies that the value of the Strategy TreeFlag is 1. |
Integer INITIATIVE |
Specifies that the value of the Initiative TreeFlag is 2. |
Integer ACCOUNTABILITY |
Specifies that the value of the Accountability TreeFlag is 4. |
Note:
You can add the values in Table 2-86 together if required. For example, if the you want the results to include nodes from both the Strategy and Initiative trees, you would pass 3 as the value (1+2).Use this structure to specify a segment tree path and branch Id number for a branch in the segment tree. This structure is used in the "JobManagementService Service".
Table 2-87 lists the fields in this structure.
Use this structure to set options in updateACL method invocations. This structure is used in the "SecurityService Service".
Table 2-88 lists the fields in this structure.
Table 2-88 UpdateACLParams Structure Fields
Fields | Description |
---|---|
UpdateACLMode updateFlag |
Specifies how to update the ACL mode. For more information, see Section 2.61.1, "UpdateACLMode Enumeration". |
This enumeration specifies a list of valid values for the update flag in the "UpdateACLParams Structure".
Table 2-89 lists the values in this enumeration.
Table 2-89 UpdateACLMode Enumeration Values
Values | Description |
---|---|
String ReplaceACL |
Specifies the ACL value to update. |
String ReplaceForSpecifiedAccounts |
Specifies a list of accounts to update in the ACL. |
String DeleteAccountsFromACL |
Specifies a list of accounts to remove from the ACL. |
String AddPermission |
Specifies a list permissions to update for a list of ACL entries |
String DeletePermission |
Specifies a list permissions to be removed from a list of ACL entries |
Use this structure to provide additional parameters in the "updateCatalogItemACL() Method". This structure is used in the "WebCatalogService Service".
Table 2-90 lists the fields in this structure.
Table 2-90 UpdateCatalogItemACLParams Structure Fields
Fields | Description |
---|---|
UpdateACLMode updateFlag |
Specifies how to update the ACL mode. For more information, see Section 2.61.1, "UpdateACLMode Enumeration". |
boolean recursive |
If set to TRUE, then the method is applied to the catalog item and all descendents, which are identified by the path. If set to FALSE, then the method is only applied to the catalog item. |
Use this structure to reference valid action links. This structure is used in the "AssessmentResult Structure".
Table 2-91 lists the fields in this structure.
Table 2-91 ValidActionLinks Structure Fields
Fields | Description |
---|---|
DimensionContext[] ActionLinkContext |
Specifies an array of DimensionContext structures. For more information, see Section 2.14, "DimensionContext Structure". |
ActionLinks[] ActionLink |
Specifies an array of ActionLink structures. For more information, see Section 2.5, "ActionLinks Structure". |
Use this structure to reference a variable in the analysis and replace it with another variable. This structure is common to all services in Oracle BI EE web services.
Table 2-92 lists the fields in this structure.
Use this structure to specify optional parameters during a query. This structure is used in the "XMLViewService Service" (in the executeXMLQuery method).
Table 2-93 lists the fields in this structure.
Table 2-93 XMLQueryExecutionOptions Structure Fields
Fields | Description |
---|---|
boolean async |
If set to TRUE, then asynchronous query execution is enabled. If set to FALSE, then asynchronous query execution is disabled. |
int maxRowsPerPage |
Specifies the maximum number of rows to be returned by a executeXMLQuery or fetchNext method. |
boolean refresh |
If set to TRUE, then the server re-submits the query to refresh the data. If set to FALSE, then the Oracle Business Intelligence Server uses data in the cache. |
boolean presentationInfo |
If set to TRUE, then store localized presentation information in the metadata section of the record set XML. Presentation information consists of the following:
|
String type |
Specifies the query ID, which can be used in logs to diagnose errors. |