MetadataService Service

Use the MetadataService() service to retrieve descriptions of Oracle Analytics Presentation Services schema objects, such as columns, tables, and subject areas.

Method Names	Description
clearQueryCache() Method	Clears the query cache.
describeColumn() Method	Retrieves column information for a specified column in a specified subject area and table.
describeSubjectArea() Method	Retrieves subject area information for a specified subject area.
describeSubjectAreaWithSort() Method	Retrieves subject area information for a specified subject area in the specified sort order.
describeTable() Method	Retrieves table information for a specified table in a specified subject area.
describeTableWithSort() Method	Retrieves table information for a specified table in a specified subject area in the specified sort order (of their names).
getSubjectAreas() Method	Retrieves the list of subject areas available.
getSubjectAreasWithSort() Method	Retrieves the list of subject areas available in the specific sort order.
reloadLogConfiguration() Method	Forces changes to logging configuration to take effect without manually restarting Oracle Analytics Presentation Services.
reloadMetadata() Method	Reloads XML message files, refresh server metadata, and clear caches.

clearQueryCache() Method

Use the clearQueryCache() method to clear the query cache.

Signature

boolean clearQueryCache(String sessionID);

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

describeColumn() Method

Use the describeColumn() method to retrieve column information for a specified column in a specified subject area and table.

Signature

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

Arguments	Description
String subjectAreaName	Specifies the subject area to be queried.
String tableName	Specifies the table to be queried.
String columnName	Specifies the name of the column to be queried.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns an SAColumn Object. For information on the SAColumn structure.

See SAColumn Structure.

describeSubjectArea() Method

Use the describeSubjectArea() method to retrieve subject area information about the specified subject area.

Signature

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

Arguments	Description
String subjectAreaName	Specifies the subject area to be queried.
SASubjectAreaDetails detailsLevel	Specifies the information to be retrieved about the subject area. For information on the SASubjectAreaDetails structure, see SASubjectAreaDetails Values.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

SASubjectAreaDetails Values

Use the SASubjectAreaDetails values to specify what information should be retrieved about the subject area.

Values	Description
IncludeTables	Include table list with minimum information about each table.
IncludeTablesAndColumns	Include full table and column information.
Minimum	Don't include table and column information.

Returns

Returns an SASubjectArea Object.

See SASubjectArea Structure).

Usage

The detailsLevel parameter values for the describeSubjectArea() method.

Depending on the value of the detailsLevel parameter, the returned object contains the information specified in this table.

Value of detailsLevel	Description
IncludeTables	Specifies that the tables field is not null and contains the collection of tables for this subject area. Each table object has the columns field set to null.
InludeTablesAndColumns	Specifies that the tables field is not null and contains the collection of tables for this subject area. For each table object the columns field contains the corresponding collection of columns.
Minimum	Specifies that the table list is not available. The tables field in the resulting subject area object is null.

describeSubjectAreaWithSort() Method

Use the describeSubjectAreaWithSort() method to retrieve subject area information about the specified subject area in the specified sort order.

Signature

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

Arguments	Description
String subjectAreaName	Specifies the subject area to be queried.
SASubjectAreaDetails detailsLevel	Specifies the information to be retrieved about the subject area. For information on the SASubjectAreaDetails structure, see SASubjectAreaDetails Values.
String sortOrder	Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z), and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).
String sortOrderCaseSensitive	Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns an SASubjectArea Object .

See SASubjectArea Structure) with tables returned in the specified sort order.

describeTable() Method

Use the describeTable() method to retrieve table information for a specified table in a specified subject area.

Signature

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

Arguments	Description
String subjectAreaName	Specifies the subject area to be queried.
String tableName	Specifies the table to be queried.
SATableDetails detailsLevel	Specifies the information to retrieve about the table. For information on the SATableDetails structure, see SATablesDetails Values.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

SATablesDetails Values

The SATablesDetails values specify the information to retrieve about the subject area table.

Values	Description
IncludeColumns	Populate the columns field in the SATable Object.
Minimum	Do not include column information. The columns field in the SATable Object is set to null.

Returns

Returns an SATable Object. For information on the SATable structure.

See SATable Structure.

describeTableWithSort() Method

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

Signature

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

Arguments	Description
String subjectAreaName	Specifies the subject area to be queried.
String tableName	Specifies the table to be queried.
SATableDetails detailsLevel	Specifies the information to retrieve about the table. For information on the SATableDetails structure, see SATablesDetails Values.
String sortOrder	Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z), and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).
String sortOrderCaseSensitive	Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns an SATable Object with columns in the specified sort order. For information on the SATable structure.

See SATable Structure.

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

Nested folders
Measures
Attributes
Hierarchies

getSubjectAreas() Method

Use the getSubjectAreas() method to retrieve the list of subject areas that are available.

Signature

List[] getSubjectAreas(String sessionID);

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

Returns

Returns an array of SASubjectArea objects. For information on the SASubjectArea structure.

See SASubjectArea Structure.

Usage

SASubjectArea objects returned by this method do not have table information available.

The tables field is null. The approach to querying at all levels is to use getSubjectAreas() to retrieve the list of subject areas and then use describeSubjectArea() to retrieve the list of tables. Next, use describeTable() to retrieve the list of columns in a specified table, and finally, use describeColumn() to retrieve information on a specified column.

getSubjectAreasWithSort() Method

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

Signature

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

Arguments	Description
String sortOrder	Specifies specifies which sort order you want the results returned in. Values can be 'asc' or 'desc'. 'asc' returns values in ascending order of the current language of the user (for example, in English, A to Z), and conversely 'desc' returns in the reverse order (for example, in English - from Z to A).
String sortOrderCaseSensitive	Specifies if the case of the values need to be taken into consideration during sort. Values can be 'caseSensitive' or 'caseInsensitive'.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns an array of SASubjectArea objects returned in the specified sort order.

For information on the SASubjectArea structure, see SASubjectArea Structure.

Usage

SASubjectArea objects returned by this method do not have table information available.

The tables field is null. The approach to querying at all levels is to use getSubjectAreasWithSort() to retrieve the list of subject areas and then use describeSubjectAreaWithSort() to retrieve the list of tables. Next, use describeTableWithSort() to retrieve the list of columns in a specified table, and finally, use describeColumn() to retrieve information on a specified column.

reloadLogConfiguration() Method

Use the reloadLogConfiguration() method to force changes to logging configuration to take effect without manually restarting Oracle Analytics Presentation Services.

Signature

boolean reloadLogConfiguration(String sessionID);

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

reloadMetadata() Method

Use the reloadMetadata() method to reload XML message files, refresh server metadata, and clear caches.

Signature

boolean reloadMetadata(String sessionID);

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

Returns

Returns a boolean to indicate if the operation is successful.