iConsole User Guide › iConsole Administration › Managing Searches, Reports, and Dashboards › Search definition (XML) files

Search definition (XML) files

The screen layouts for an individual iConsole search are defined by parameters in a search definition file. Search definition files are written in XML and must contain the following parameters:

• The name of the search stored procedure (SP) that will perform the actual search query. For example:

  spname="PUB_WGN_7DAY_EMAIL_RESEARCH"
  

• The name and description of the search definition
  label="Research Department Weekly E-mails"

  description="E-mails sent by research department in last 7 days"
  

• The format of the Search Properties screen, for example, the available check boxes and list boxes and how they are grouped.

  <parameter name="chkWE" type="checkbox" 
  argpos="1" label="Email Events:" 
  value="false" align="right" 
  tooltip="Select to get captured Email Events"/>
  

• The layout of the Search Results screen, for example, the number of columns and their label names.

  <results>
  <column name="EmailCount" label="The number of emails stored is:" type="numeric" width="50%" style="color:red"/>
  </results>
  

  Note: In the extracts above, the command syntax has been spread over multiple lines for readability purposes. However, the actual command must be on a single line in the batch file.

  Note: An individual search definition file can contain default parameters to define the layout of multiple search definitions.

For more details, see the iConsole Search Definition Guide.

More information:

Stored procedure (SP) files