To create one or more indices in production mode, you can customize the behavior of Index Data by creating a PFF file.
You can create a PFF file in one of two ways: either create it yourself using a text editor such as Notepad, or generate one by selecting
Save As from the
File menu. You can also manipulate PFF files in logic by using the
Pff object.
The following section shows the options available to you in a CSIndex PFF file. A PFF file is not case sensitive, so you can use any combination of upper and lower case text.
[Run Information]
Version=CSPro 8.0
AppType=Index
Description=My Program
ShowInApplicationListing=Always
[Files]
InputData=.\File01.dat
InputData=.\File02.dat
InputData=.\File03.dat
InputData=.\File04.dat
OutputData=.\<filename>-fixed
Listing=.\CSIndex.lst
InputDict=.\DictionaryName.dcf
[Parameters]
ViewListing=Always
DuplicateCase=List
The [Run Information] block is required. While Version and AppType must appear exactly as shown in the example above, there are two optional properties:
- Description=if specified, it will be used instead of the name of the file in the list of applications (mobile only).
- ShowInApplicationListing=determines whether the application associated with this PFF is displayed on the mobile Entry Applications screen. The possible options are: Always (default), Never, and Hidden. Operators must manually elect to show hidden applications, whereas PFFs with the Never option will never be shown.
The
[Files] block is required and names the file(s) to be indexed. At a minimum you must name one input file (
InputData). If you specify an output file (
OutputData), the tool will attempt to remove duplicates from the input data file(s) and create an output file with the duplicates removed. If more than one input data file is selected, the output file can include a wildcard (see
Specify Files for more information).
The [Parameters] block is optional:
- ViewListing determines whether the listing file is viewed. ViewListing=Always means that you will always see the generated listing file, while ViewListing=Never means that you will never see the generated listing file.
- DuplicateCase indicates in which mode the tool should run. You can automatically remove duplicate cases (DuplicateCase=KeepFirst) or you can query the user about duplicates to remove (DuplicateCase=Prompt or DuplicateCase=PromptIfDifferent). Alternatively, if you do not want to output data, you can get a list of duplicates (DuplicateCase=List) or you can view the case contents of duplicates (DuplicateCase=View).
The default values are ViewListing=Always and DuplicateCase=List.
When executing an Index Data production PFF on Android, the DuplicateCase=View, DuplicateCase=Prompt, and DuplicateCase=PromptIfDifferent modes are not supported.