Table of contents

This document describes the database schema and classes available in build 212 of the WAR database API.

All tables [ show/hide ]

Tables in WAR Database [ show/hide ]

Miscellaneous routines

The DatabaseRoutines class provides several miscellaneous routines relating to the API as a whole:

• retrieve API build number:
  C#: WAR.DatabaseRoutines.Build;
  Perl: WAR::DatabaseRoutines::Build();
  
• change ODBC DSN from default (Sysgem Web Access Request DB):
  C#: WAR.DatabaseRoutines.ConnectionString = "DSN=My DSN";
  Perl: WAR::DatabaseRoutines::SetDSN("My DSN");
  

SAcM_WAR_Command

WAR command entries

Columns

Column	Type	Description
RequestID	string(64) (read-only)	Request ID
Command	string(32)	Command
Source	string(32)	Source
RequestDate	string(23)	Request date, as a string
RequestStatus	string(32)	Request status

Constraints

• Primary key: RequestID.

Command class methods

New objects of this class are constructed with:

• .NET: new WAR.Command(string RequestID)
• Perl: new WAR::Command($RequestID)

The following methods return a single object, or a null reference if the requested object was not found:

• Lookup(string RequestID)

The following methods return a list of objects:

• GetAll()
• GetCompletedCommands()

Other methods:

• Save() -- save the object to the database.
• Delete() -- delete the object from the database.
• Error() (Perl only) -- get error message from last operation, if any.

SAcM_WAR_Param

WAR command parameters

Columns

Column	Type	Description
RequestID	string(64) (read-only)	Request ID
ParamName	string(32) (read-only)	Parameter name
ParamValue	string(255) (read-only)	Parameter value

Constraints

• Primary key: RequestID, ParamName, ParamValue.

Param class methods

New objects of this class are constructed with:

• .NET: new WAR.Param(string RequestID, string ParamName, string ParamValue)
• Perl: new WAR::Param($RequestID, $ParamName, $ParamValue)

The following methods return a single object, or a null reference if the requested object was not found:

• Lookup(string RequestID, string ParamName, string ParamValue)

The following methods return a list of objects:

• GetAll()
• GetParametersForRequest(string RequestID)
• GetParameter(string RequestID, string ParamName)

Other methods:

• Save() -- save the object to the database.
• Delete() -- delete the object from the database.
• Error() (Perl only) -- get error message from last operation, if any.

Associated Objects

Object	Type	Description
Request	Command (read-only)	The WAR request entry

SAcM_WAR_Results

WAR results

Columns

Column	Type	Description
RequestID	string(64) (read-only)	Request ID
ResultAgent	string(255) (read-only)	Agent generating the result
ResultContext	string(255) (optional, read-only)	Context of the result
ResultFieldName	string(32) (read-only)	Field name of the result
ResultValue	string(255) (read-only)	The result text

Constraints

• Primary key: RequestID, ResultAgent, ResultContext, ResultFieldName, ResultValue.

Result class methods

New objects of this class are constructed with:

• .NET: new WAR.Result(string RequestID, string ResultAgent, string ResultContext, string ResultFieldName, string ResultValue)
• Perl: new WAR::Result($RequestID, $ResultAgent, $ResultContext, $ResultFieldName, $ResultValue)

The following methods return a single object, or a null reference if the requested object was not found:

• Lookup(string RequestID, string ResultAgent, string ResultContext, string ResultFieldName, string ResultValue)

The following methods return a list of objects:

• GetAll()
• GetRequestResults(string RequestID)

Other methods:

• Save() -- save the object to the database.
• Delete() -- delete the object from the database.
• Error() (Perl only) -- get error message from last operation, if any.

Associated Objects

Object	Type	Description
Request	Command (read-only)	The WAR request entry