Preface

This preface is an introduction to the SIETS Developer’s Guide. It defines the audience, describes the structure of this guide, and lists typographic conventions and abbreviations used throughout the guide.

This guide is compliant with the SIETS server version 3.3.19.

This section contains the following topics:

Audience

This guide is intended for application developers. In SIETS context these are developers that build customized applications based on SIETS API.

Structureof This Guide

This guide has the following structure:

Section	Description
Introducing SIETS	Describes SIETS, its concepts, and architecture.
Understanding SIETS Document Structure	Describes SIETS document structure and presents scenarios for unstructured source data and XML structured source data.
Internationalization	Describes multi-language support and text encoding concepts, and explains XML formatting concepts.
SIETS API Specification	Contains all SIETS function descriptions and syntax in XML.
SIETS Clustering	Describes SIETS clustering.
SIETS Console	Explains how to run and work with SIETS console.
Message Files	Describes the concept of message files and explains how to run the `siets-load` command.
Use Cases	Lists and describes sample applications that are based on SIETS API commands.
Appendix A: Error Messages	Contains a list of error messages.
Appendix B: API Reference for FoxPro	Contains SIETS API reference for Microsoft Visual FoxPro programming language.
Appendix C: Frequently Asked Questions	Contains a list of frequently asked questions and answers to them.

Related Information

The SIETS package includes the following guides:

Title	Description
SIETS Administration and Configuration Guide	Describes the SIETS administration and configuration concepts and contains step-by-step instructions.
SIETS Installation Guide	Describes how to install SIETS.

Typographic Conventions

The following styles and conventions are used in this guide:

Convention	Description
`Verdana`	Represents command, function, file and directory names, system messages, and command-line commands.
Hyperlink	Represents a hyperlink. Clicking on this field takes you to the identified place.
Example	Represents an example.
Source code	Represents code.
Comment	Represents a comment in the code.

Abbreviations

The following abbreviations are used in this guide.

Abbreviation	Description
API	Application programming interface.
FTS	Full text search.
XML	Extensible markup language.
SQL	Structured query language.
UTF	UCS (universal character set) transformation format.
HTTP	Hypertext transport protocol.