Document conventions

The IXIASOFT 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 c:\ProgramData.

 Open Windows Explorer and copy the configuration file for the original IXIASOFT TEXTML Server instance:

%ProgramData%\Ixiasoft\ TextmlServer[version]\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 c:\Program Files.

 Open the GetDocument sample:
%ProgramFiles%\IxiaSoft\TextmlServer[version]\SDK\
java\com\ixiasoft\samples\GetDocument.java
IXIASOFT TEXTML Server version numbers

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

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

%ProgramData%\Ixiasoft\ TextmlServer[version]\TextmlServerCfg.xml
Naming conventions
  • For conciseness, this guide uses the term docbase instead of Content Store. The former term was used throughout 4.3 documentation, and while it was largely changed to the latter in 4.4 documentation, the term "docbase" is retained in IXIASOFT TEXTML Server-specific documentation as it tends to refer to the physical files/folders that use the same name.
  • The term IXIASOFT TEXTML Server is used to designate the IXIASOFT TEXTML Server application, which may also be referred to as simply TEXTML in the application's windows, menus, and messages.
  • The term TextmlServer Console Java is used to designate the application that provides a graphical user interface (GUI) for managing TEXTML Server docbases.
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.