Oracle® Marketing Segmentation Guide > Installing and Administering Segmentation and List Generation > SOAP Calls for Marketing >
writeListFiles Method
The writeListFiles method generates lists for list export, segment campaign load, or segment tree campaign load. API Definition
<xsd:element name="writeListFiles"> <xsd:complexType> <xsd:sequence> <xsd:element name="report" type="sawsoap:ReportRef" minOccurs="0" maxOccurs="1" /> <xsd:element name="reportParams" type="sawsoap:ReportParams" minOccurs="0" /> <xsd:element name="segmentPath" type="xsd:string" minOccurs="0" maxOccurs="1" /> <xsd:element name="treeNodePath" type="sawsoap:TreeNodePath" minOccurs="0" maxOccurs="1" /> <xsd:element name="segmentationOptions" type="sawsoap:SegmentationOptions" minOccurs="0" maxOccurs="1" /> <xsd:element name="filesystem" type="xsd:string" /> <xsd:element name="timeout" type="xsd:integer" /> <xsd:element name="sessionID" type="xsd:string" /> </xsd:sequence> </xsd:complexType> </xsd:element>
<xsd:complexType name="ReportRef"> <xsd:sequence> <xsd:element name="reportPath" type="xsd:string" nillable="true" /> <xsd:element name="reportXml" type="xsd:string" nillable="true" /> <xsd:element name="reportDef" type="sawsoap:ReportDef" nillable="true" /> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="ReportDef"> <xsd:complexContent mixed="false"> <xsd:restriction base="xsd:anyType"> <xsd:sequence /> </xsd:restriction> </xsd:complexContent> </xsd:complexType>
<xsd:complexType name="TreeNodePath"> <xsd:sequence> <xsd:element name="treePath" type="xsd:string" /> <xsd:element name="treeNode" type="xsd:string" /> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="SegmentationOptions"> <xsd:sequence> <xsd:element name="removeCacheHits" type="xsd:boolean" default="false" minOccurs="0" maxOccurs="1" /> <xsd:element name="countOverride" type="sawsoap:OverrideType" default="Default" minOccurs="0" maxOccurs="1" /> <xsd:element name="cacheOverride" type="sawsoap:OverrideType" default="Default" minOccurs="0" maxOccurs="1" /> <xsd:element name="samplingFactor" type="xsd:decimal" default="100" minOccurs="0" maxOccurs="1" /> <xsd:element name="prompts" type="xsd:namevaluepair" minOccurs="0" maxOccurs="unbounded" /> <xsd:element name="govRules" type="xsd:namevaluepair" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="ReportParams"> <xsd:sequence> <xsd:element minOccurs="0" maxOccurs="unbounded" name="filterExpressions" /> <!--ref="sawexpr:expr"--> <xsd:element minOccurs="0" maxOccurs="unbounded" name="variables" type="sawsoap:Variable" /> <xsd:element minOccurs="0" maxOccurs="unbounded" name="nameValues" type="sawsoap:NameValuePair" /> <xsd:element minOccurs="0" maxOccurs="unbounded" name="templateInfos" type="sawsoap:TemplateInfo" /> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="Variable"> <xsd:sequence> <xsd:element name="name" type="xsd:string" /> <xsd:element minOccurs="0" maxOccurs="1" name="valueXml" type="xsd:string" /> <xsd:element minOccurs="0" maxOccurs="1" name="value" /> <!--ref="sawexpr:expr"--> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="NameValuePair"> <xsd:sequence> <xsd:element name="name" type="xsd:string" /> <xsd:element name="value" type="xsd:string" /> </xsd:sequence> </xsd:complexType>
<xsd:complexType name="TemplateInfo"> <xsd:sequence> <xsd:element name="templateForEach" type="xsd:string" /> <xsd:element name="templateIterator" type="xsd:string" /> <xsd:element minOccurs="0" maxOccurs="unbounded" name="instance"> <xsd:complexType> <xsd:sequence> <xsd:element name="instanceName" type="xsd:string" /> <xsd:element minOccurs="0" maxOccurs="unbounded" name="nameValues" type="sawsoap:NameValuePair" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType>
Valid Usage Scenarios
Generates lists for list export. One or more instance elements are specified. <writeListFiles> <report> <reportPath>[path to list format]</reportPath> </report>
<reportParams> <nameValues> <name>[0_name]</name> <value>[0_value]<value> </nameValues> <nameValues> <name>[1_name]</name> <value>[1_value]<value> </nameValues> ... <nameValues> <name>[N_name]</name> <value>[N_value]<value> </nameValues>
<templateInfos> <templateForEach>segments</templateForEach> <templateIterator>segment</templateIterator> <instance> <instanceName>[first name=value pair name in the instance xml element]</instanceName> <nameValues> <name>[A0_name]</name> <value>[A0_value]<value> </nameValues> <nameValues> <name>[A1_name]</name> <value>[A1_value]<value> </nameValues> ... <nameValues> <name>[AN_name]</name> <value>[AN_value]<value> </nameValues> </instance> <instance> <instanceName>[first name=value pair name in the instance xml element]</instanceName> <nameValues> <name>[B0_name]</name> <value>[B0_value]<value> </nameValues> <nameValues> <name>[B1_name]</name> <value>[B1_value]<value> </nameValues> ... <nameValues> <name>[BN_name]</name> <value>[BN_value]<value> </nameValues> </instance> ... <instance> <instanceName>[first name=value pair name in the instance xml element]</instanceName> <nameValues> <name>[N0_name]</name> <value>[N0_value]<value> </nameValues> <nameValues> <name>[N1_name]</name> <value>[N1_value]<value> </nameValues> ... <nameValues> <name>[NN_name]</name> <value>[NN_value]<value> </nameValues> </instance> </templateInfos> </reportParams> <filesystem>[path to shared directory containing list files]</filesystem> <timeout>[timeout value]</timeout> </writeListFiles>
Generates list for segment campaign load. Only one instance element is specified. <writeListFiles> <report> <reportPath>[path to list format]</reportPath> </report>
<reportParams> <nameValues> <name>[0_name]</name> <value>[0_value]<value> </nameValues> <nameValues> <name>[1_name]</name> <value>[1_value]<value> </nameValues> ... <nameValues> <name>[N_name]</name> <value>[N_value]<value> </nameValues> <templateInfos> <templateForEach>segments</templateForEach> <templateIterator>segment</templateIterator> <instance> <instanceName>[first name=value pair name in the instance xml element]</instanceName> <nameValues> <name>[A0_name]</name> <value>[A0_value]<value> </nameValues> <nameValues> <name>[A1_name]</name> <value>[A1_value]<value> </nameValues> ... <nameValues> <name>[AN_name]</name> <value>[AN_value]<value> </nameValues> </instance> </templateInfos> </reportParams> <segmentationOptions> <prompts> <name>[P0_name]</name> <value>[P0_value]</value> </prompts> <prompts> <name>[P1_name]</name> <value>[P1_value]</value> </prompts> ... <prompts> <name>[PN_name]</name> <value>[PN_value]</value> </prompts> <govRules> <name>[GR0_name]</name> <value>[GR0_value]</value> </govRules> <govRules> <name>[GR1_name]</name> <value>[GR1_value]</value> </govRules> ... <govRules> <name>[GRN_name]</name> <value>[GRN_value]</value> </govRules> </segmentationOptions> <filesystem>[path to shared directory containing list files]</filesystem> <timeout>[timeout value]</timeout> </writeListFiles>
Generates list for segment tree campaign load. Only one instance element is specified. <writeListFiles> <report> <reportPath>[path to list format]</reportPath> </report>
<reportParams> <nameValues> <name>[0_name]</name> <value>[0_value]<value> </nameValues> <nameValues> <name>[1_name]</name> <value>[1_value]<value> </nameValues> ... <nameValues> <name>[N_name]</name> <value>[N_value]<value> </nameValues> <templateInfos> <templateForEach>segments</templateForEach> <templateIterator>segment</templateIterator> <instance> <instanceName>[first name=value pair name in the instance xml element]</instanceName> <nameValues> <name>[A0_name]</name> <value>[A0_value]<value> </nameValues> <nameValues> <name>[A1_name]</name> <value>[A1_value]<value> </nameValues> ... <nameValues> <name>[AN_name]</name> <value>[AN_value]<value> </nameValues> </instance> </templateInfos> </reportParams> <segmentationOptions> <prompts> <name>[P0_name]</name> <value>[P0_value]</value> </prompts> <prompts> <name>[P1_name]</name> <value>[P1_value]</value> </prompts> ... <prompts> <name>[PN_name]</name> <value>[PN_value]</value> </prompts> <govRules> <name>[GR0_name]</name> <value>[GR0_value]</value> </govRules> <govRules> <name>[GR1_name]</name> <value>[GR1_value]</value> </govRules> ... <govRules> <name>[GRN_name]</name> <value>[GRN_value]</value> </govRules> </segmentationOptions> <filesystem>[path to shared directory containing list files]</filesystem> <timeout>[timeout value]</timeout> </writeListFiles>
|