OysterRunScript

The OysterRunScript is the main file for any OYSTER run. It is the first file requested by OYSTER when the run is initiated. It is used to specify the following:

• The RunScriptName * This attribute value must match the file name without the extension.

• If Explanation and Debug are turned on or off.

  • These options restrict the amount of information written to the log files.

• If extra detail is required in the Change Report

• If Trace is enabled.

• If memory statistics are displayed at various stages in the run.

• The location, size, name, and number of log files that can be created.

• The RunMode for the run

• The resolution engine to be used during the run.

  • OYSTER offers three resolution engines (Described in detail in the Reference guide):

       * RSwooshStandard
               * Uses Attribute-Based Matching
       * RSwooshEnhanced
               * Uses Attribute-Based Matching
       * FSCluster
               *Uses Record-Based Matching
    

• The path to the XML OysterAttributes document defining the entity attributes to be used during the run

• The path to the XML Identity documents, if any, to be loaded at the start of the run

  • This is an identity file generated by a previous OYSTER run.

• The path to a location where the updated XML Identity documents will be stored at the end of the run if any are specified for the run

• A list of paths to the OysterSourceDescriptor XML document(s)

  • One per source file to be included in the run.

• The path to a location where the Link Index will be written at the end of the run

• A path to each source input file and assertion input file

A simple OysterRunScript is illustrated in Figure 9.

The OysterRunScript in Figure 9 makes use of only text files for the Output, OYSTER also has the ability to read and write to a database. This RunScript is for an IdentityCapture run, different tags are used when performing an assertions run. A full reference of the OysterRunScript file can be found in the OYSTER Reference Guide. Both types of matching, Record-Based and Attribute-Based, are also defined in detail in the OYSTER Reference Guide.

Previous to 3 - OYSTER XML Files Page .................................................................. Next to OysterSourceDescriptor Page

Back to OYSTER User Guide Page