Install a docbase on Windows

This procedure describes how to install a docbase on Windows.

Prerequisites:
  • The TEXTML Server must be installed and started on the server.
  • If you are using this procedure to install a docbase from a previous version of TEXTML Server, you must first migrate the docbase. See the TEXTML Server Administration Guide for more information.
Installing a docbase creates a docbase entity in the TEXTML Server Administration Console so that you can use it to manage your documents. Use this procedure in the following circumstances:
  • To install a new empty docbase entity (you can import files afterwards).
  • To install a populated docbase from another TEXTML Server version.
Docbase locations

Docbases must be installed on a local drive or a storage area network (SAN) on the server where you installed the TEXTML Server. They cannot be installed on a Windows share or network file system (NFS) volume.

IXIASOFT recommends that you store all the docbases in a top-level folder, called docbases. You can then create a sub-folder for the TEXTML Server version and then a sub-folder for each docbase.

For example, if you plan to create two docbases (DocbaseA and DocbaseB), your directory structure would be as follows:

C:\docbases\4.3\DocbaseA
               \DocbaseB
Note: The user that is running the TEXTML Server service *must* have write privileges to the top-level docbases directory. This is described in the procedure below.

To install a new docbase:

  1. In your file system, create a directory for your docbase. (For example, C:\docbases\4.3\SportsStories.)
  2. Give the TEXTML Server permissions for the high-level folder (i.e., C:\docbases) and its subdirectories:
    1. Right-click the C:\docbases directory and select Properties.
    2. Select the Security tab.
    3. Select the user under which the TEXTML Server is running.
      Important: By default, LOCAL SERVICE is the identity given to the TEXTML Server component when TEXTML Server is installed. But if the TEXTML Server is running in a cluster or forest, the TEXTML Server may be running as another user.
      If the user under which the TEXTML Server runs is not listed in the Group or user names box:
      1. Click Add.
      2. In the Enter the object names to select box, type the username and click Check Names.
        The username is underlined. For example, if the TEXTML Server is running as LOCAL SERVICE, the LOCAL SERVICE username is underlined, as shown below:
        Add Local Service user
      3. Click OK.
      4. Select the username.
    4. Click Edit and set up full permissions for the username:
      Figure 1. Giving permissions to the TEXTML Server

    5. Click OK.
  3. Open the TEXTML Server Administration Console.
  4. Connect to the server where you want to install the docbase.
  5. Right-click the server and select Install Document Base.
    The Install Document Base dialog appears.
    Figure 2. Installing a docbase

  6. In the Data box, click Browse and select the docbase folder.
    Note: The Browse button is only available when the docbase folder is local to the machine from which you started the TEXTML Server Administration Console. If the docbase is on another machine, enter the path to the docbase directory directly in the Data box (for example, C:\docbases\4.3\SportsStories).
  7. In the Name box, enter the name of the docbase.
    Note: While the name of the docbase can be different from the name of the docbase folder, IXIASOFT highly recommends that you use the same name.
  8. Optional: Do one of the following:
    • To have logger records saved in the docbase directory, select Use same directory for logs.
    • To have logger records written to a different directory, specify a folder in the Logs box.
    Note: Logger records (not to be confused with transaction logs) are duplicates of the master record for docbase transactions. TEXTML Server creates logger records when performing write operations on the docbase. Users who expect frequent intense write activity on a docbase may choose to locate the logger records in a separate directory residing on a different physical disk to improve performance.
  9. Under Installation Type, select one of the following:
    • New document base, to install a new and empty docbase entity.
    • Existing document base, to install a populated docbase (for example, a docbase that you previously migrated).
  10. Click OK.
    The new docbase and its associated subfolders appear as child nodes of the server.
    Figure 3. New docbase and subfolders

Troubleshooting
  • If you get an Error installing document base message, repeat the procedure, ensuring that the Name is a docbase folder also selected in the Data box.
  • If you get a The storage version is incompatible with this server message, the selected docbase is not the same version as the server you are using. Check the DocumentBaseCfg.xml file (in the C:\docbases\4.3\instance-name\ folder) and ensure that the version (for TEXTML Server 4.3) is 4300 or higher. If not, migrate the docbase and try again. See the TEXTML Server Administration Guide for more information.
  • If you get a TEXTML Server can't create the Document Base message, repeat the procedure, being sure to clear the Create if missing option in the dialog box.
  • An error can occur if you have not set the permissions correctly for the docbase. Make sure full permissions are given to the LOCAL SERVICE (Step 2 in the procedure above).
  • If none of the above resolves your problem, open the textml_log.txt file in %ProgramData%\IxiaSoft\TextmlServer43\Log\ and check the error message details.