To help optimize and debug your output, you can have the generated records sent to files rather than to the Guided Search record stores. Doing this enables you to examine the output without triggering indexing, so you can determine if you need to make changes to the configuration of the record-generating components.
To direct output to files, create a component of class atg.repository.search.indexing.submitter.FileDocumentSubmitter
, and set the documentSubmitter
property of the record-generating components to point to the FileDocumentSubmitter
component. A separate file is created for each record generated.
Note that the output records reflect the naming conventions and data formats used with Forge-based deployment templates, because the renaming and conversions done by the other document submitters do not occur. Therefore, if you are using a CAS-based deployment template, the output from FileDocumentSubmitter
may not match the records actually submitted to Guided Search by DimensionDocumentSubmitter
and ConfigImportDocumentSubmitter
.
The location and names of the files are automatically determined based on the following properties of FileDocumentSubmitter
:
baseDirectory
The pathname of the directory to write the files to.
filePrefix
The string to prepend to the name of each generated file. Default is the empty string.
fileSuffix
The string to append to the name of each generated file. Set this as follows:
fileSuffix=.xml
nameByRepositoryId
If true
, each filename will be based on the repository ID of the item the file represents. If false
(the default), files are named 0.xml
, 1.xml
, etc.
overwriteExistingFiles
If true
, if the generated filename matches an existing file, the existing file will be overwritten by the new file. If false
(the default), the new file will be given a different name to avoid overwriting the existing file.