Bookshelf Home | Contents | Index | PDF     

Oracle® Marketing Segmentation Guide > Installing and Administering Segmentation and List Generation > Managing Web Service Integration with Marketing Segmentation >

SOAP Calls for Marketing Segmentation

Simple Object Access Protocol (SOAP) calls are available to Marketing for the purpose of customizing segmentation and list generation. Most SOAP calls are documented in the Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

The following SOAP methods are specific to Marketing Segmentation:

  • deleteResultSet
  • getCounts
  • getPromptedColumns
  • prepareCache
  • purgeCache
  • saveResultSet
  • writeListFiles

For SOAP code examples, see SOAP Call Code Examples for Marketing Segmentation.

Table 6. SOAP Methods Specific to Marketing Segmentation
Method
Description
Valid Usage Scenario

deleteResultSet

Deletes one or more saved result sets of target level objects identified by a list of GUID values belonging to a segment.

-

getCounts

Calculates the count numbers for either a segment or a segment tree. Thus, the segmentPath element must be specified in the getCounts element when getCounts is performed on a segment.

Otherwise, the treePath element must be specified in the getCounts element when getCounts is performed on a segment tree. Anything else results in an error.

Segmentation options are used by getCounts to override the default options specified for the segment or segment tree in Marketing BI.

The usage options for the GetCounts operation are:

  • countOverride
  • removeCacheHits
  • samplingFactor
  • prompts
  • govRules

These options are specified within the segmentationOptions element.

getPromptedColumns

Returns prompted columns for a segment or a segment tree.

Either the segmentPath or the treePath element must be specified as an input parameter or else an error is returned.

  • Returns the prompted columns for the segment.
  • Returns the prompted columns for the segment tree.

prepareCache

Caches a segment or a segment tree for list export.

-

purgeCache

Purges the entire cache, purges entries for a segment from the cache, or purges entries for a segment tree from the cache. If the node specified is a non-leaf node then the cache for all its children leaf nodes is purged.

All cache content is purged from cache.

saveResultSet

Saves the list of resulting members that qualify for the segment based on the most recent updated counts.

The list of resulting members are extracted and saved to the specified savedSegmentPath.

-

writeListFiles

Generates lists for list export, segment campaign load, or segment tree campaign load.

-

    
Oracle® Marketing Segmentation Guide Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices.