OTX-Runtime Converter API

Table of Contents

• Table of Contents
• Overview
• Usage
• Checker rules for DiagCom
• Code Example

The OTX-Runtime Converter API is a programming interface for the easy, fast and reliable validation and compilation of OTX procedures in own applications. It works independently even without the OTX Development Environment and is available for Windows and Linux. The API is available for DotNet. It works on Window via Net Framework and on Linux via Net6.0 or higher.

Table of Contents

• Installation
• Configuration
• Licensing
• Sample Program
• Builder-Checker

Overview

The OTX-Runtime Converter API can be integrated into own applications. The API supports

• Loading a PTX, a PPX or a project.

  Important: Before loading PTX/PPX/Project, please start standalone BaseXServer (download at https://files.basex.org/releases/9.0.1/BaseX901.zip, unzip and start the basex\bin\basexserver.bat on Windows or basex\bin\basexserver on Linux). Default SERVERPORT is 1984. To change the SERVERPORT, open .basex file and set SERVERPORT to another number. OTX-Runtime Converter API connects to a running BaseXServer via XmlDbPort property.

  - Validation against OTX checker rules. See Checker rules for DiagCom.
• Compiling and exporting of PTX and PPX with executables.

Usage

1. Sample Program is a console application. It can be used on both Windows and Linux.
2. Builder-Checker is a GUI application. It can be used on Windows only.

Checker rules for DiagCom

1. DiagManager must be started before validation. The validation gets DiagCom objects from the DiagManager via IPC (Socket or Pipe).
2. OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter.
3. DiagValidationGroups is a part of checker rules for DiagCom. DiagValidationGroups can be set manually or by importing a *.xml file.

Code Example

How the OTX-Runtime Converter API is used can be seen in the source code of the Runtime Converter API Sample program. The basic proceeding how the OTX-Runtime Converter API can be used is described in the following pseudo code example. The example loads, validates and exports a PTX file with build-in CppOutput.

// Generally applicable Pseudo-Code example
// ========================================
 
void main()
{
    // Set license
    // ==========================================
    OpenTestSystem.Otx.RuntimeConverter.Api.License.LicenseManager.SetLicenseKey("XXXXX-XXXXX-XXXXX-XXXXX-XXXXX");
 
    // Set tracelevel to ALL
    // ==========================================
    OpenTestSystem.Otx.RuntimeConverter.Api.Config.TraceLevel = OpenTestSystem.Otx.RuntimeConverter.Api.TraceLevels.ALL;
 
    // Create RuntimeConverter
    // ==========================================
    OpenTestSystem.Otx.RuntimeConverter.Api.IRuntimeConverter runtimeConverter = OpenTestSystem.Otx.RuntimeConverter.Api.RuntimeConverterFactory.CreateSocketRuntimeConverter(8888);
 
    // Load a ptx file with a password
    // ==========================================
    runtimeConverter.LoadPtx("D:\\Sample.ptx", "This is a password");
 
    // Import DiagValidationGroups.
    // ==========================================
    runtimeConverter.DiagValidationGroups.Import("D:\\DiagValidationGroups1.xml");
    
    // Set XmlDb Port.
    // ==========================================
    runtimeConverter.XmlDbPort = 1984
 
    // Validate the ptx
    // ==========================================
    OpenTestSystem.Otx.RuntimeConverter.Api.Validator.IError[] errors = runtimeConverter.Validate();
    if (errors.Length > 0)
    {
        Console.WriteLine("*** Errors and warnings:");
        foreach (OpenTestSystem.Otx.RuntimeConverter.Api.Validator.IError error in errors)
        {
            Console.Write("[SeverityType]");
            Console.Write(error.SeverityType);
            Console.Write(" [Description]");
            Console.Write(error.Description);
            Console.Write(" [ScopeId]");
            Console.Write(error.ScopeId);
            Console.Write(" [ScopeName]");
            Console.Write(error.ScopeName);
            Console.Write(" [ElementType]");
            Console.Write(error.ElementType);
            Console.Write(" [ErrorCode]");
            Console.Write(error.ErrorCode);
            Console.Write(" [Procedure]");
            Console.Write(error.Procedure);
            Console.Write(" [Document]");
            Console.Write(error.Document);
            Console.Write(" [Package]");
            Console.Write(error.Package);
            Console.Write(" [Project]");
            Console.WriteLine(error.Project);
            Console.WriteLine();
        }
 
        if (errors.FirstOrDefault(err => err.SeverityType == OpenTestSystem.Otx.RuntimeConverter.Api.Validator.SeverityTypes.Critical) != null)
        {
            Console.WriteLine("*** The ptx cannot be compiled because it has {0} errors.", errors.Count(err => err.SeverityType == OpenTestSystem.Otx.RuntimeConverter.Api.Validator.SeverityTypes.Critical));
            return;
        }
    }
 
    // Compile the ptx
    // ==========================================
    runtimeConverter.Compile("D:\\CompiledSample.ptx");
}