Wiki

Clone wiki

OYSTER / Linkoutput_Tag

The LinkOutput tag specifies where the link index created during the OYSTER run will be stored. A link output is required for every OYSTER run.
The LinkOutput tag must have the Type attribute that defines the two possible formats.

  • Type attribute

    • Acceptable Values
      • "TextFile"
      • "Database"
  • Type="TextFile"

#!xml

<LinkOutput Type="TextFile">Absolute Path</LinkOutput>

When Type is assigned the value of "TextFile" the LinkOutput tag has only the Type attribute. The start and end tag enclose character data that represents the absolute path to the text file that will be created to contain the link index created for the OYSTER run.

  • Type="Database"
#!xml

<LinkOutput Type="Database" Server="123.123.123.123" Port="1433" SID="PROD" UserID="UserName" Passwd="Password">Table Name</LinkOutput>

NOTE: As of OYSTER v3.3 the output to a DBMS is not implemented but will be supported in the future with the following implementation.

When Type is assigned the value of "Database" the LinkOutput tag may have up to five additional attributes.

  • Type - Must be assigned the value of "Database"
  • Server - Must be assigned the address of the database server to be used.

    • DNS Name
    • IP address
  • Port - Must be assigned the port number on which the database server will respond to requests.

  • SID - Must be assigned the name of the database in which the link index will be stored on the server.
  • UserID - Must be assigned the name of the user with access to write to the desired table.
  • Passwd - Must be assigned the password associated to the user given as the values of the UserID attribute.

The start and end tag enclose character data that represents the table name in which the link index will be written. Please note that when connecting to SQLServer 2005 or MySQL, the table name must be fully qualified or OYSTER will produce a connection error. An example of a fully qualified table name is "DatabaseName.dbo.TableName" in SQL Server or "DatabaseName.TableName" in MySQL.

Updated