SAWSessionParameters Structure Oracle Fusion Middleware Online Documentation Library

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. 2-14 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition

2.26 StartPageParams Structure

Use this structure to define options in startPage method invocations. This structure is used in Section 3.2, HtmlViewService Service . Table 2–29 lists the fields in this structure.

2.27 TreeNodePath Structure

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 Section 3.4, JobManagementService Service . Table 2–30 lists the fields in this structure.

2.28 UpdateACLParams Structure

Use this structure to set options in updateACL method invocations. This structure is used in Section 3.9, SecurityService Service . Table 2–31 lists the fields in this structure. Table 2–28 SessionEnvironment Structure Fields Fields Description String userName Specifies the name of the current user. ItemInfo homeDirectory Specifies the full path to the users home directory in the catalog. For example, usersuser 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. Table 2–29 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. Table 2–30 TreeNodePath Structure Fields Fields Description String treeNode Specifies the segment tree’s branch Id number that contains the members to include in the list. String treePath Specifies the path to the segment tree.