12API Examples for Oracle Secure Enterprise Search

API Examples for Oracle Secure Enterprise Search

This chapter lists Oracle Secure Enterprise Search Open API sample formats for the Search and Index methods, and the feed file. This chapter includes the following topics:

• Search inputArgs Example

• Search outputArgs Example

• Feed File Example

• Index inputArgs Example

Search inputArgs Example

This XML listing displays sample format and values for inputArgs when the Search method is invoked from the InvokeMethod method.

<?xml version="1.0" encoding="UTF-8"?>
<?Siebel-Property-Set EscapeNames="true"?>

<PropertySet
 XParam2="Val2"
 Search_spcType="BASIC"
 EngineName="XSearch"
 BCType="1#15#Service Request"
 Criteria=""
 Navigation="2#7#Account4#Area"
 Browser="FALSE"
 Filename="\\<server>\filesystem\SSC\Config\<application>_Field-Mappings.xml"
 Shared_spcSearch_spcUNC_spcLocation="\\<server>\filesystem\SSC"
 _XML_spcIndexable_spcData_spcLocation="\\<server>\filesystem\SSC\xmlidata\"
 Sort=""
 DefaultFrom="0"
 XParam1="Value1"
 Context="SENSITIVE"
 DefaultCriteria=""
 DefaultContext="SENSITIVE"
 AdptClassName="\\<server>\fs\XSearchAdapter.dll"
 Batch_spcSplit_spcSize="1500"
 DefaultRecordsPerPage="10"
 SSC_spcFTP_spcLocation="ftp://<server>/"
 AvailableFields="22#17#Service Request@@8#Abstract7#Account4#Area15#Attachment List7#BC Name3#CSN7#Created10#Created By11#Description2#Id12#Organization5#Owner23#Primary Organization Id20#Requestor First Name19#Requestor Last Name15#Resolution Code9#SR Number6#Status8#Sub-Area7#Updated10#Updated By"
 RecordsPerPage="10"
 Query=""
 DefaultSort=""
 SubOperation="Search"
 New_spcSearch="0"
 EngineId="42-CC0HV"
 KeyOperator="OR"
 DefaultTo="10"
 SelectedSearch="Service Requests"
 Freetext=""
 Collection="1#7#buscomp"
 DefaultBrowser="FALSE"
 To="9"
 LogOperator="AND"
 Batch_spcSubmit_spcSize="1000"
 Keyword=""
 From="0">

</PropertySet>

Search outputArgs Example

This XML listing displays sample format and values for outputArgs when the Search method is invoked from the InvokeMethod method.

<?xml version ="1.0" encoding ="UTF-16"?>
<?XsearchAdapter-XML EscapeNames="true"?>  
<OutputBlock To ="9" TotalRecords ="13" From ="0">

<OutputBlock
 Rowid ="1-260HR"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="NUOVITESTBENCHMARKSULLASCALABILITA&apos;DISIEBELSALES:sonooradisponibilisuwww.siebel.com|[Author:ITA_CCHE][Name:ITA_SiebelSalesProductNews7.40.01"
 Date ="2002-02-26"
 Title ="ITA_SiebelSalesProductNews7.40.01"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="99-27Y6K"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="eMRSolution6|[Author:SADMIN][Name:eMRSolution6][Type:Solution][Status:Approved]"
 Date ="1979-12-31"
 Title ="eMRSolution6"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="99-27Y6B"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="eMRSolution|[Author:SADMIN][Name:eMRSolution4][Type:Solution][Status:Approved]"
 Date ="1979-12-31"
 Title ="eMRSolution4"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="1-2G2AY"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="HowtoSubmitanSRforRSATokenIssuesWhenlogginganSRforRSAtokensonHelpDeskOnline,youwillwanttoensure/indicatethefollowing:NewRequests1.SR"
 Date ="2002-06-01"
 Title ="RSA-HowtosubmitanSRforanRSAToken"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="1-26GY2"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="SmartScriptandeSmartScriptusethesamescriptstructureandworkexactlythesame.ThismeansthatyoucancreateaSmartScriptonceanddeployiteverywhere"
 Date ="2002-03-05"
 Title ="FRA-SmartScripteteSmartScript"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="1-2G2AW"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="HowtoOrderanRSAToken1)ContactITCustomerCare"
 Date ="2002-06-01"
 Title ="RSA-OrderinganRSAToken"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="1-2C38Z"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="OrderDocumentation(forInternalEmployees)MostSiebelDocumentationandLiteratureitemscanbedownloadedinPDFformatfromtheLiteratureViewoneBiz.As"
 Date ="2002-05-30"
 Title ="MfgOps-Q3"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

<OutputBlock
 Rowid ="1-EZTJ"
 BCType ="Solution"
 DocumentType ="BusCompRecord"
 Summary ="Name:1-EZTJ][Type:ResolutionItem]"
 Date ="2001-07-17"
 Title ="1-EZTJ"
 DataSource ="Solution"
 Location ="">
</OutputBlock>

</OutputBlock>

Feed File Example

This is a sample index feed file for two records. Oracle's Siebel application creates the XML feed files which are input into the index operation.

<?xml version="1.0" encoding="UTF-8" ?> 

- <rss version="2.0" xsi:schemaLocation="http://xmlns.oracle.com/orarss.xsd" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://
www.w3.org/2001/XMLSchema">

- <channel>
  <title>Siebel Search Center</title> 
  <link>http://www.oracle.com/apps/rss</link> 
  <description>This channel contains feed for Siebel BusComp data.</description> 
  <lastBuildDate>2008-05-13T08:03:39.00Z</lastBuildDate> 
- <channelDesc xmlns="http://xmlns.oracle.com/orarss">
  <sourceName>buscomp</sourceName> 
  <batchId>2008-05-13_08-03-39</batchId> 
  <itemCount>2</itemCount> 
  </channelDesc>
- <item>

  <link>http://<server>:<port>/siebel/app/callcenter/
enu?SWECmd=GotoView&SWEView=User+Catalog+Explorer+View&SWERF=1&SWEHo=sdchs21n381&S
WEBU=1&SWEApplet0=InfoCenter+Explorer+List+Applet&SWERowId0=1-12931</link>

- <itemDesc xmlns="http://xmlns.oracle.com/orarss" operation="insert">
- <documentMetadata>

  <accessURL>http://<server>:<port>/siebel/app/callcenter/
enu?SWECmd=GotoView&SWEView=#VIEWNAME#&SWERF=1&SWEHo=sdchs21n381&SWEBU=1&SWEApplet
0=#APPLETNAME#&SWERowId0=#ROWID#</accessURL> 

  <docAttr name="Title">Siebel Distance Learning - ESN</docAttr> 
  <docAttr name="status">Approved</docAttr> 
  </documentMetadata>
- <documentContent>
  <content>[Name:Siebel Distance Learning - ESN] [Status:Approved]</content> 
  </documentContent>
- <documentAcl>
  <securityAttr name="sblvisibilityid">PUB</securityAttr> 
  </documentAcl>
- <documentInfo>
  <status>STATUS_OK_FOR_INDEX</status> 
  </documentInfo>
  </itemDesc>
  </item>
- <item>

  <link>http://<server>:<port>/siebel/app/callcenter/
enu?SWECmd=GotoView&SWEView=User+Catalog+Explorer+View&SWERF=1&SWEHo=sdchs21n381&S
WEBU=1&SWEApplet0=InfoCenter+Explorer+List+Applet&SWERowId0=99-27Y6K</link> 

- <itemDesc xmlns="http://xmlns.oracle.com/orarss" operation="insert">
- <documentMetadata>

  <accessURL>http://<server>:<port>/siebel/app/callcenter/
enu?SWECmd=GotoView&SWEView=#VIEWNAME#&SWERF=1&SWEHo=sdchs21n381&SWEBU=1&SWEApplet
0=#APPLETNAME#&SWERowId0=#ROWID#</accessURL> 

  <docAttr name="Title">eMR Solution 6</docAttr> 
  <docAttr name="status">Approved</docAttr> 
  </documentMetadata>
- <documentContent>

Index inputArgs Example

This XML listing displays sample format and values for inputArgs when the Index method is invoked from the InvokeMethod method.

<?xml version="1.0" encoding="UTF-8"?><?Siebel-Property-Set EscapeNames="true"?>

<PropertySet
 Category_spcId="04-KFT4L"
 EngineName="XSearch" 
 Search_spcSpecification="Id &gt;= &quot;1-1009T&quot; AND Id &lt;= &quot;99-4C12M&quot;"
 _XML_spcIndexable_spcData_spcLocation="\\<server>\fs\SSC\xmlidata\"
 Shared_spcSearch_spcUNC_spcLocation=\\<server>\fs\SSCFilename="\\<server>\fs\ssc\config\SSC_OSES_Field-Mappings.xml"
 Filter_spcSpec=""CategoryName="Solution (Call Center)"
 XParam="Xval"
 Batch_spcSplit_spcSize="1500"
 AdptClassName="\\<server>\fs\XSearchAdapter.dll"
 Search_spcBC_spcName="Solution"
 Connector_spcId="04-KFT4D"
 Adapter_spcInstance_spcCount="0"
 SSC_spcFTP_spcLocation="ftp://<server>/"
 Type="buscomp"
 EngineId="42-CLX4P"
 SearchCategoryName="Solution (Call Center)"
 Batch_spcSubmit_spcSize="1000"
 Operation="Index">

<PropertySet
 Seq_spcNum="" Field_spcType="" Weight_spcFactor="" Searchable_spcFlg="Y" Field_spcName="Author By Name" Navigable_spcFlg="N">
</PropertySet>

<PropertySet
 Seq_spcNum="" Field_spcType="" Weight_spcFactor="" Searchable_spcFlg="N" Field_spcName="BC Name" Navigable_spcFlg="N">
</PropertySet>

<PropertySet
 Seq_spcNum="" Field_spcType="" Weight_spcFactor="" Searchable_spcFlg="N" Field_spcName="Catalog Category Name" Navigable_spcFlg="N">
</PropertySet>

</PropertySet>