Index

A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

Symbols

_import() method, 3.6.3

A

Access (Microsoft), example of integrating with Oracle Business Intelligence, 6.4
AccessControlToken structure, 2.1
account element, 4.3.4
Account structure, 2.2
ACL structure, 2.3
Action Framework
about, 4.1
adding and maintaining credentials, 4.5
and credentials, 4.4.1
and functionality provided, 4.1.1
and security, 4.4
and the account element, 4.3.4
and the content type element, 4.3.3
and the ebusinesssuiteconfig element, 4.3.7
and the location alias element, 4.3.1
and the policy element, 4.3.5
and the proxy element, 4.3.6
and the registry element, 4.3.2
configuration checklist, 4.2.1
configuration overview, 4.2
configuring, 4.3
ActionFrameworkConfig.xml, 4.3
actions
about, 4.1.1
and permissions, 4.4.3
and privileges, 4.4.2
and security, 4.4
and targets, 4.2.2, 4.6
configuring OWSM for, 4.5.3
execution of, 4.1.2
Invoke a Browser Script, 4.6.6
Invoke a Java Method (EJB), 4.6.5
Invoke a Server Script, 4.6.7
Invoke a Web Service, 4.6.3
Invoke Agent, 4.6.8
Java Job, 4.6.9
Navigate to E-Business Suite, 4.6.2
Navigate to EPM Content, 4.6.1
types of, 4.1.2
addReportToPage() method, 3.2.2
aggregation rule element, in XML schema, 11.12
AggregationRule Values, 2.19.2
APIs
Dashboard URL, using, 6.2
GO URL
Oracle BI Server XML API, 10.1
Oracle Business Intelligence Systems Management, 7
SQL, issuing using the Go command, 6.3
third-party SQL tool, integrating example, 6.4
appending objects, using Oracle BI Server XML API, 10.1.1
application programming interfaces
See APIs
applyReportParams() method, 3.7.1, 3.7.2
ArrayofGUIDS structure, 2.4
authentication, setting up for Oracle E-Business Suite, 5.2
authenticationschemas.xml file, updating for Oracle E-Business Suite integration, 5.2.2
AuthResult structure, 2.5

B

biserverxmlcli command-line tool, using, 10.2.3
biserverxmlexec command-line tool, using, 10.2.2
biserverxmlgen command-line tool, using, 10.2.1
business model element, in XML schema, 11.2

C

callback URLs
modifying, 3.2.1
replaced, 3.2.8.3
cancelJob() method, 3.4.1
cancelQuery() method, 3.11.2
catalog link element, in XML schema, 14.1.1
CatalogItemsFilter structure, 2.6
CatalogObject structure, 2.7
certification information, Preface
checklist for Action Framework configuration, 4.2.1
clearQueryCache() method, 3.5.1
column mapping element, in XML schema, 11.9.1
command-line tools
biserverxmlcli, 10.2.3
biserverxmlexec, 10.2.2
biserverxmlgen, 10.2.1
ConditionService
service, 3.1
configuring
Web services for SOA, 1.4
connection pool element, in XML schema, 12.7
connection pool settings, updating using Oracle BI Server XML API, 10.3.5
connectivity
ODBC data source names, configuring, 8.3, 8.4
query and reporting tools, about using, 8
content type element, 4.3.3
copyItem() method, 3.10.3
copyItem2() method, 3.10.4
createFolder() method, 3.10.5
createLink() method, 3.10.6
credential key, 4.5.1
credential map, 4.5.1
credentials
about, 4.4.1
adding and maintaining, 4.5
cube column element, in XML schema, 12.15
cube table element, in XML schema, 12.11
custom authenticator element, in XML schema, 14.2.4

D

Dashboard URL
about and format, 6.2
basic Dashboard URL, about and format, 6.2.2
PortalPath parameter, using, 6.2.3
User ID and Password parameter, using, 6.2.3
Data Source Name, about, 8.1
database element, in XML schema, 12.1
databases,supported, Preface
DB sign-on element, in XML schema, 14.2.10
default keystore, 4.5.2
deleteIBot() method, 3.3.2
deleteItem() method, 3.10.7
deleteResultSet() method, 3.4.2
describeColumn() method, 3.5.2, 3.5.2
describeSubjectArea() method, 3.5.3
describeTable() method, 3.5.4
dimension element, in XML schema, 11.5
Discoverer metadata, 9.2
Discoverer worksheets, 9.1
drilldown links, 3.2.1
driver, for Oracle BI DSN, 8.3

E

EBS ICX authentication cookie, 5.2.2
ebusinesssuiteconfig element, 4.3.7
enabling
SSL for Web services communication, 1.5
Web services for SOA, 1.4
endPage() method, 3.2.3
error message language, setting in ODBC DSN, 8.3
ErrorDetailsLevel structure, 3.10.1
ErrorInfo structure, 2.8
evaluateCondition() method, 3.1.1
evaluateInlineCondition() method, 3.1.2
ExecuteAgent, 1.3
ExecuteAnalysis, 1.3
ExecuteCondition, 1.3
executeIBotNow() method, 3.3.3
executeSQLQuery() method, 3.11.3
executeXMLQuery() method, 3.11.4
execution of actions, 4.1.2
export() method, 3.6.4
ExportFlags structure, 3.6.1

F

fetchNext() method, 3.11.5
files, ActionFrameworkConfig.xml, 4.3
filters
Go URL, passing to through URL,, 6.3.2
forgetAccount() method, 3.9.1
form functions, creating in Oracle E-Business Suite, 5.3.1

G

generateReportSQL() method, 3.7.3
generic elements and attributes, for Oracle BI Server XML API, 10.4
getAccounts() method, 3.9.2
getCommonBodyHTML() method, 3.2.4
getConditionCustomizableReportElements() method, 3.1.3
getCounts() method, 3.4.3
getCurUser() method, 3.8.1
getGlobalPrivilegeACL() method, 3.9.3
getGlobalSAWPrivileges() method, 3.9.4
getGroups() method, 3.9.5
getHeadersHTML() method, 3.2.5
getHtmlforPageWithOneReport() method, 3.2.6
getHTMLForReport() method, 3.2.7
getItemInfo() method, 3.10.8
getJobInfo() method, 3.4.4
getMembers() method, 3.9.6
getPermissions() method, 3.9.7
getPrivilegesStatus() method, 3.9.8
getPromptedColumns() method, 3.4.5
getPromptedFilters() method, 3.11.6
getSessionVariable() method, 3.8.3
getSubItems() method, 3.10.9
GetSubItemsParams structure, 2.9
getSubjectAreas() method, 3.5.5
Go URL
about, 6.1
application-friendly format, displaying results in, 6.1.3
basic Go URL, about and example, 6.1.2
filters, about passing to through URL, 6.3.2
HTML results, navigation from, 6.3.2.4
JavaScript, navigation using, 6.3.2.3
link options, format and example, 6.1.3
navigation example, 6.3.2.2
navigation parameters syntax, 6.3.2.1
printer friendly format and example, 6.1.3
result format, controlling, 6.1.3
specific style, showing results in, 6.1.3
specify view, showing, 6.1.3
SQL, using to issue and passing filters, 6.3
tables, displaying all records in, 6.1.3.1
user ID and password, prompting for, 6.1.3
GoNav JavaScript function, about, 6.3.2.3
group element, in XML schema, 14.2.9

H

HtmlViewService
bridging, 3.2.1
service, 3.2
HTTPS
invoking Web services, 1.6

I

iBotService
service, 3.3
id, about, 10.4.1
impersonate() method, 3.8.4
impersonateex() method, 3.8.5
import() method, 3.6.3
ImportError structure, 2.10
ImportFlags structure, 3.6.2
init block element, in XML schema, 14.2.3
instanceconfig.xml file, updating for Oracle E-Business Suite integration, 5.2.3
integrating Oracle Business Intelligence
Dashboard URL, using, 6.2
filters, passing to the Go command through a URL, 6.3.2
Go URL, using, 6.1
SQL, issuing using the Go command, 6.3
third-party SQL tool, integrating example, 6.4
with Oracle E-Business Suite security, 5
with other clients, 8
Invoke a Browser Script action, 4.6.6
Invoke a Java Method (EJB) action, 4.6.5
Invoke a Server Script action, 4.6.7
Invoke a Web Service action, 4.6.3
Invoke Agent action, 4.6.8
invoking
Web services with HTTPS, 1.6
isMember() method, 3.9.9
ItemInfo structure, 2.11

J

Java Job action, 4.6.9
JDBC, using to integrate with the Oracle BI Server, 8.1.2
JobManagementService
service, 3.4
joinGroups() method, 3.9.10

K

keepAlive() method, 3.8.6
keystore, 4.5.2

L

LDAP server element, in XML schema, 14.2.2
leaveGroups() method, 3.9.11
list catalog element, in XML schema, 14.1.3
location alias element, 4.3.1
logical column element, in XML schema, 11.1
logical complex join element, in XML schema, 11.3
logical display folder element, in XML schema, 11.14
logical elements, for Oracle BI Server XML API, 11
logical foreign key element, in XML schema, 11.7
logical key element, in XML schema, 11.8
logical level element, in XML schema, 11.4
logical source folder element, in XML schema, 11.10
logical table element, in XML schema, 11.6
logical table source element, in XML schema, 11.9
logoff() method, 3.8.7
logon() method, 3.8.8
logonex() method, 3.8.9

M

maintenanceMode() method, 3.10.10
marketing elements elements, for Oracle BI Server XML API, 14.1
markForReplication() method, 3.6.5
measure definition element, in XML schema, 11.11
memory requirements, Preface
menus
assigning to responsibilities in Oracle E-Business Suite, 5.3.3
creating in Oracle E-Business Suite, 5.3.2
metadata conversion assistant tool, 9.2
metadata, Discoverer, 9.2
MetadataService
service, 3.5
method
getConditionCustomizableReportElements(), 3.1.3
methods
_import(), 3.6.3
addReportToPage(), 3.2.2
applyReportParams(), 3.7.1, 3.7.2
cancelJob(), 3.4.1
cancelQuery(), 3.11.2
clearQueryCache(), 3.5.1
copyItem(), 3.10.3
copyItem2(), 3.10.4
createFolder(), 3.10.5
createLink(), 3.10.6
deleteIBot(), 3.3.2
deleteItem(), 3.10.7
deleteResultSet(), 3.4.2
describeColumn(), 3.5.2, 3.5.2
describeSubjectArea(), 3.5.3
describeTable(), 3.5.4
endPage(), 3.2.3
evaluateCondition(), 3.1.1
evaluateInlineCondition(), 3.1.2
executeIBotNow(), 3.3.3
executeSQLQuery(), 3.11.3
executeXMLQuery(), 3.11.4
export(), 3.6.4
fetchNext(), 3.11.5
forgetAccount(), 3.9.1
generateReportSQL(), 3.7.3
getAccounts(), 3.9.2
getCommonBodyHTML(), 3.2.4
getCounts(), 3.4.3
getCurUser(), 3.8.1
getGlobalPrivilegeACL(), 3.9.3
getGlobalSAWPrivileges(), 3.9.4
getGroups(), 3.9.5
getHeadersHTML(), 3.2.5
getHtmlforPageWithOneReport(), 3.2.6
getHTMLForReport(), 3.2.7
getItemInfo(), 3.10.8
getJobInfo(), 3.4.4
getMembers(), 3.9.6
getPermissions(), 3.9.7
getPrivilegesStatus(), 3.9.8
getPromptedColumns(), 3.4.5
getPromptedFilters(), 3.11.6
getSessionVariable(), 3.8.3
getSubItems(), 3.10.9
getSubjectAreas(), 3.5.5
impersonate(), 3.8.4
impersonateex(), 3.8.5
import, 3.6.3
isMember(), 3.9.9
joinGroups(), 3.9.10
keepAlive(), 3.8.6
leaveGroups(), 3.9.11
logoff(), 3.8.7
logon(), 3.8.8
logonex(), 3.8.9
maintenanceMode(), 3.10.10
markForReplication(), 3.6.5
moveIBot(), 3.3.4
moveItem(), 3.10.11
pasteItem2(), 3.10.12
prepareCache(), 3.4.6
purgeCache(), 3.4.7
purgeLog(), 3.6.6
readObject(), 3.10.13
removeFolder(), 3.10.14
renameAccounts(), 3.9.12
SASubjectAreaDetails(), 3.5.3.2
SATablesDetails(), 3.5.4.2
saveResultSet(), 3.4.8
sendMessage(), 3.3.5
sessionEnvironment(), 3.8.2
setBridge(), 3.2.8
setBridge(), using for callback URLs, 3.2.1
setItemAttributes(), 3.10.15
setItemProperty(), 3.10.16
setOwnership(), 3.10.17
startPage(), 3.2.9
subscribe(), 3.3.6
unsubscribe(), 3.3.7
updateGlobalPrivilegeACL(), 3.9.13
upgradeXML(), 3.11.7
writeIBot(), 3.3.1
writeListFiles(), 3.4.9
writeObjects(), 3.10.19
Microsoft
Access, example of integrating with Oracle Business Intelligence, 6.4
migrating from test to production environments, 10.3.5
migrating metadata, with Oracle BI Server XML API, 10.3.2
minimum disk space, Preface
moveIBot() method, 3.3.4
moveItem() method, 3.10.11

N

NameValuePair structure, 2.12
Navigate to E-Business Suite action, 4.6.2
Navigate to EPM Content action, 4.6.1

O

object identifiers, for Oracle BI Server XML API, 10.4.1
object privilege element, in XML schema, 14.2.6
ODBC
about, 8.1
configuring advanced SSL settings, 8.3.1
creating dedicated connection to Physical layer, 8.1.1
data source names, configuring, 8.3, 8.4
localization considerations over, 8.1
query and reporting tools, about connecting with, 8
supported calls from client applications, 8.2
operating systems, supported, Preface
Oracle BI repository
configuring Physical layer for Oracle E-Business Suite integration, 5.1
maintaining versions with Oracle BI Server XML API, 10.3.1
programmatically updating connection pool settings, 10.3.5
programmatically updating using Oracle BI Server XML API, 10.3.4
setting session variables for Oracle E-Business Suite integration, 5.2.1
Oracle BI Server
about integrating with over JDBC, 8.1.2
about integrating with over ODBC, 8.1
Oracle BI Server XML API
about, 10.1
about object identifiers, 10.4.1
applying patches to online repositories, 10.3.3
command-line tools, 10.2
maintaining RPD versions with, 10.3.1
programmatically updating repositories, 10.3.4
using to append objects, 10.1.1
using to migrate metadata, 10.3.2
using to migrate to production environments, 10.3.5
using XSL with, 10.3.6
Oracle BI Server XML API elements
generic elements and attributes, 10.4
logical elements, 11
marketing elements, 14.1
other elements, 14.3
physical elements, 12
presentation elements, 13
security elements, 14.2
Oracle Business Intelligence Systems Management API, 7
Oracle E-Business Suite
assigning menus to responsibilities, 5.3.3
assigning responsibilities to users, 5.3.4
configuring Oracle BI repository for, 5.1
creating form functions, 5.3.1
creating menus, 5.3.2
embedding links to Oracle Business Intelligence, 5.3
setting up profiles, 5.3.5
setting up shared authentication with, 5.2
other elements, for Oracle BI Server XML API, 14.3
override aggregation rule element, in XML schema, 11.13
OWSM, 4.5.3

P

pasteitem2() method, 3.10.12
patches, applying to online repositories using Oracle BI Server XML API, 10.3.3
PathMap structure, 2.13
permissions, 4.4.3
physical catalog element, in XML schema, 12.2
physical column element, in XML schema, 12.6
physical dimension element, in XML schema, 12.12
physical display folder element, in XML schema, 12.4
physical elements, for Oracle BI Server XML API, 12
physical foreign key element, in XML schema, 12.9
physical key element, in XML schema, 12.8
physical level element, in XML schema, 12.14
physical schema element, in XML schema, 12.3
physical table element, in XML schema, 12.5
platforms, supported, Preface
policy element, 4.3.5
PortalNav JavaScript function, about, 6.3.2.3
prepareCache() method, 3.4.6
presentation catalog element, in XML schema, 13.1
presentation column element, in XML schema, 13.4
presentation elements, for Oracle BI Server XML API, 13
presentation hierarchy element, in XML schema, 13.5
presentation level element, in XML schema, 13.6
presentation table element, in XML schema, 13.3
privilege package element, in XML schema, 14.2.5
Privilege structure, 2.14
privileges, 4.4.2
profiles, setting up in Oracle E-Business Suite, 5.3.5
project element, in XML schema, 14.3.1
proxy element, 4.3.6
purgeCache() method, 3.4.7
purgeLog() method, 3.6.6

Q

qualified list item element, in XML schema, 14.1.4
qualifiedName, about, 10.4.1
qualifying key element, in XML schema, 14.1.5
query object element, in XML schema, 14.3.2
query privilege element, in XML schema, 14.2.7
query tool, about connecting with, 8
QueryResults structure, 2.15

R

readObject() method, 3.10.13
ReadObjectReturnOptions
structure, 3.10.2
registry element, 4.3.2
removeFolder() method, 3.10.14
renameAccounts() method, 3.9.12
ReplicationService
service, 3.6
ReportEditingService
service, 3.7
ReportHTMLLinksMode structure, 2.16.1
ReportHTMLOptions structure, 2.16
reporting tool, about connecting with, 8
ReportParams structure, 2.17
ReportRef structure, 2.18
requirements, system, Preface
responsibilities, assigning to users in Oracle E-Business Suite, 5.3.4

S

SAColumn structure, 2.19
SADataType Values, 2.19.1
sampling table element, in XML schema, 14.1.6
SASubjectArea structure, 2.20
SASubjectAreaDetails() method, 3.5.3.2
SATable structure, 2.21
SATablesDetails() method, 3.5.4.2
saveResultSet() method, 3.4.8
SAWLocale structure, 2.22
SAWSessionParameters structure, 2.23
SAWSessionService
service, 3.8
schema document, for Oracle BI Server XML API, 10.1
securing
Web services for SOA, 1.4
security elements, for Oracle BI Server XML API, 14.2
SecurityService
service, 3.9
seg catalog element, in XML schema, 14.1.7
SegmentationOptions structure, 2.24
SELECT_PHYSICAL, setting up ODBC connection for, 8.1.1
sendMessage() method, 3.3.5
services
ConditionService, 3.1
HtmlViewService, 3.2
iBotService, 3.3
JobManagementService, 3.4
MetadataService, 3.5
ReplicationService, 3.6
ReportEditingService, 3.7
SAWSessionService, 3.8
SecurityService, 3.9
WebCatalogService, 3.10
XMLViewService, 3.11
session variables, setting for Oracle E-Business Suite integration, 5.2.1
session-based Web services
overview, 1.1, 1.2
SessionEnvironment structure, 2.25
sessionEnvironment() method, 3.8.2
setBridge() method, 3.2.1, 3.2.8
setItemAttributes() method, 3.10.15
setItemProperty() method, 3.10.16
setOwnership() method, 3.10.17
shared authentication, with Oracle E-Business Suite, 5.2
single sign-on, limitations when using EBS-ICX authentication cookie, 5.2
SOA
Web services for SOA, 1.3
SQL
example of integrating third-party tool, 6.4
using Go command to issue SQL and passing filters, 6.3
SSL
enabling for Web services communication, 1.5
SSL, configuring in ODBC DSN, 8.3.1
startPage() method, 3.2.9
StartPageParams structure, 2.26
structures, 2
AccessControlToken, 2.1
Account, 2.2
ACL, 2.3
ArrayofGUIDS, 2.4
AuthResult, 2.5
CatalogItemsFilter, 2.6
CatalogObject, 2.7
ErrorDetailsLevel, 3.10.1
ErrorInfo, 2.8
ExportFlags, 3.6.1
GetSubItemsParams, 2.9
ImportError, 2.10
ImportFlags, 3.6.2
ItemInfo, 2.11
NameValuePair, 2.12
PathMap, 2.13
Privilege, 2.14
QueryResults, 2.15
ReadObjectReturnOptions, 3.10.2
ReportHTMLLinksMode, 2.16.1
ReportHTMLOptions, 2.16
ReportParams, 2.17
ReportRef, 2.18
SAColumn, 2.19
SASubjectArea, 2.20
SATable, 2.21
SAWLocale, 2.22
SAWSessionParameters, 2.23
SegmentationOptions, 2.24
SessionEnvironment, 2.25
StartPageParams, 2.26
TreeNodePath, 2.27
UpdateACLMode, 2.28.1
UpdateACLParams, 2.28
UpdateCatalogItemACL, 3.10.18
UpdateCatalogItemACLParams, 2.29
Variable, 2.30
XMLQueryExecutionOptions, 2.31
XMLQueryOutputFormat, 3.11.1
subscribe() method, 3.3.6
supported installation types, Preface
system requirements, Preface

T

target level element, in XML schema, 14.1.2
targets for actions, 4.2.2, 4.6
third-party SQL tool, integrating example, 6.4
tool, metadata conversion assistant, 9.2
TreeNodePath structure, 2.27

U

uid, about, 10.4.1
UNIX, configuring ODBC data source names on, 8.4
unsubscribe() method, 3.3.7
UpdateACLMode structure, 2.28.1
UpdateACLParams structure, 2.28
UpdateCatalogItemACL structure, 3.10.18
UpdateCatalogItemACLParams structure, 2.29
updateGlobalPrivilegeACL() method, 3.9.13
upgradeXML() method, 3.11.7
URLS, callback, 3.2.1
user element, in XML schema, 14.2.8

V

variable element, in XML schema, 14.2.1
Variable structure, 2.30

W

Web services
session-based overview, 1.1, 1.2
SOA overview, 1.3
WebCatalogService service, 3.10
Windows, configuring ODBC data source names on, 8.3
worksheets, Discoverer, 9.1
writeIBot() method, 3.3.1
writeListFiles() method, 3.4.9
writeObjects() method, 3.10.19
WSDL
session-based Web services, 1.1, 1.2
Webservices for SOA, 1.3
WSIL
Web services for SOA, 1.3

X

XML API
See Oracle BI Server XML API
XML schema
aggregation rule element, 11.12
business model element, 11.2
catalog link element, 14.1.1
column mapping element, 11.9.1
common elements and attributes, 10.4
complex join element, 12.10
connection pool element, 12.7
cube column element, 12.15
cube table element, 12.11
custom authenticator element, 14.2.4
database element, 12.1
DB sign-on element, 14.2.10
dimension element, 11.5
group element, 14.2.9
init block element, 14.2.3
LDAP server element, 14.2.2
list catalog element, 14.1.3
logical column element, 11.1
logical complex join element, 11.3
logical display folder element, 11.14
logical foreign key element, 11.7
logical key element, 11.8
logical level element, 11.4
logical source folder element, 11.10
logical table element, 11.6
logical table source element, 11.9
measure definition element, 11.11
object privilege element, 14.2.6
override aggregation rule element, 11.13
physical catalog element, 12.2
physical column element, 12.6
physical dimension element, 12.12
physical display folder element, 12.4
physical foreign key element, 12.9
physical hierarchy element, 12.13
physical key element, 12.8
physical level element, 12.14
physical schema element, 12.3
physical table element, 12.5
presentation catalog element, 13.1
presentation column element, 13.4
presentation hierarchy element, 13.5
presentation level element, 13.6
presentation table element, 13.3
privilege package element, 14.2.5
project element, 14.3.1
qualified list item element, 14.1.4
qualifying key element, 14.1.5
query object element, 14.3.2
query privilege element, 14.2.7
sampling table element, 14.1.6
seg catalog element, 14.1.7
target level element, 14.1.2
user element, 14.2.8
variable element, 14.2.1
XML, generating and executing with Oracle BI Server XML API, 10.2
XMLQueryExecutionOptions structure, 2.31
XMLQueryOutputFormat structure, 3.11.1
XMLViewService service, 3.11
XSL, using with Oracle BI Server XML API, 10.3.6
xudml1.xsd file, 10.1