1. UALR ERIQ Avatar UALR ERIQ
  2. OYSTER
  3. OYSTER

Wiki

Clone wiki

OYSTER / IdentityOutput_Tag

View History

The IdentityOutput tag specifies where the Identities defined during the OYSTER run will be stored. The IdentityOutput tag must have the Type attribute that defines the three possible formats.

  • Type attribute
    • Acceptable Values:
      • "None"
      • "TextFile"
      • "Database"
  • Type="None"
#!xml

<IdentityOutput Type="None" />

When Type is assigned the value of "None" IdentityOutput has only the Type attribute.

The IdentityOutput statement cannot be left out of the run script or OYSTER will stop running once it reaches this section of the run script. To prevent this OYSTER must be notified that there is no identity output by assigning a Type value of "None".

  • Type="TextFile" 
#!xml

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

When Type is assigned the value of "TextFile" the IdentityOutput 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 XML formatted identities for the OYSTER run.

  • Type="Database"
#!xml

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

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 IdentityOutput 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 XML identities are to 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 identity output 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.

Back to OYSTER Reference Guide page

Click Prev IdentityInput Tag page

Click Next LinkOutput Tag page

Updated