Document conventions

The TEXTML Server documentation uses a set of conventions.

Table 1. Document conventions
Convention Example
ProgramData file paths
"Program Data" file paths vary depending on your Windows operating system. To simplify the examples in this guide, %ProgramData% is used to represent both:
  • c:\ProgramData (Vista, Windows 2008, Windows 7)
  • c:\Documents and Settings\All Users\Application Data (Windows XP, Windows 2003)
Open Windows Explorer and copy the configuration file for the original TEXTML Server instance:

%ProgramData%\Ixiasoft\ TextmlServernn\TextmlServerCfg.xml

ProgramFiles file paths
"Program Files" file paths also vary depending on your Windows operating system. To simplify the examples in this guide, %ProgramFiles% is used to represent both:
  • c:\Program Files (Windows XP, Windows 2003, Vista, Windows 2008, Windows 7)
  • c:\Program Files (x86) (Vista, Windows 2008, Windows 7)
Open the GetDocument sample:
%ProgramFiles%\IxiaSoft\TextmlServernn\SDK\
java\com\ixiasoft\samples\GetDocument.java
TEXTML Server version numbers

The variable nn is used to represent any TEXTML Server version number, unless the step, procedure, or description is specific to a particular TEXTML Server version.

Locate the configuration file for the TEXTML Server instance whose port number you want to modify:

%ProgramData%\Ixiasoft\ TextmlServernn\TextmlServerCfg.xml
TEXTML Server sub-versions

An x is appended to TEXTML Server 3 and 4 version numbers as a variable to represent all available sub-versions. For example, 3.x represents versions 3.1. 3.2, 3.3 and so on.

The topic Differences between TEXTML Server 3.x and 4.x.

Naming conventions
  • For conciseness, this guide uses the term docbase instead of document base (used in the TEXTML Server windows and messages).
  • The term TEXTML Server is used to designate the TEXTML Server application, which may also be referred to as simply TEXTML in the application's windows, menus, and messages.
  • The term Administration Console is used to designate the application that provides a graphical user interface (GUI) for managing TEXTML Server docbases. Within the application itself and elsewhere, the terms TEXTML Administration Tool , Java Console, or TEXTML Tool are also used for this same GUI.
Note: The %ProgramData% and %ProgramFiles% variables can be entered directly in the command line or in the address bar and MS Windows will resolve to the correct path for the operating system.