ReportRef Structure SASubjectArea Structure SATable Structure

2-10 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition Table 2–22 lists the fields in this structure.

2.19.1 SADataType 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 Table 2–22 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.19.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.19.2, AggregationRule Values . Description of Structures in Oracle BI EE Web Services 2-11

2.19.2 AggregationRule Values

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

2.20 SASubjectArea Structure

Use this structure to represent Subject Area attributes. This structure is used in Section 3.5, MetadataService Service . Table 2–23 lists the fields in this structure.

2.21 SATable Structure

Use this structure to represent the logical table in the Subject Area. This structure is used in the Section 3.5, MetadataService Service . Table 2–24 lists the fields in this structure. Table 2–23 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.21, SATable Structure . 2-12 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition

2.22 SAWLocale Structure

Use this structure to define the locale for the current session. This structure is used in Section 3.8, SAWSessionService Service . Table 2–25 lists the fields in this structure.

2.23 SAWSessionParameters Structure

Use this structure to define optional parameters for the current session. This structure is used in Section 3.8, SAWSessionService Service . Table 2–26 lists the fields in this structure. Table 2–24 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 tables columns. For information about the SAColumn structure, see Section 2.19, SAColumn Structure . Table 2–25 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. Table 2–26 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.8, SAWSessionService Service . String userAgent Specifies whether the HTMLView service will be 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.8.9, logonex Method and Section 3.8.5, impersonateex Method . Description of Structures in Oracle BI EE Web Services 2-13

2.24 SegmentationOptions Structure

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 Section 3.5, MetadataService Service . Table 2–27 lists the fields in this structure.

2.25 SessionEnvironment Structure

Use this structure to return environment information for the current session. This structure is used in Section 3.8, SAWSessionService Service . Table 2–28 lists the fields in this structure. Table 2–27 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 govRules Specifies a value to enforce the corresponding contract planning rules for the segment or segment tree. NameValuePair prompts 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.