Install a new docbase on Linux

This procedure describes how to install a new, unpopulated docbase into TEXTML Server.

When you install a docbase, it creates a docbase entity in the TEXTML Server Administration Console so that you can use it to manage your documents.

Note: To install an existing docbase, see Install an existing docbase as a new instance.

Docbases must be installed on a local drive or a storage area network (SAN) on the machine where you installed 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, and then create a sub-folder for the TEXTML Server version and then a sub-folder for each docbase so you can quickly identify and differentiate your docbases.

For example, if you had a production and a testing environment, you could have the following paths:

  • /docbases/TEXTML43/Prod_v44
  • /docbases/TEXTML43/Test_v44

To install a new docbase:

  1. Create a directory for your docbase on a local drive or a storage area network (SAN) on the machine where you installed TEXTML Server.
    For example: /docbases/TEXTML4.3/Prod_v 44
  2. Give TEXTML Server permissions for the high-level directory (for example, the docbases directory) and its subdirectories:
    Enter:
    chmod -R u+wr,g+wr,o+r-w docbases
  3. Open the DITA CMS Eclipse client.
  4. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click OK.
  5. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  6. When the Connect as dialog opens, type your username and password and click OK.
  7. In the TEXTML Administration view, right-click the server and click Install Document Base.
    The Install Document Base dialog opens.
    Figure 1. Installing a docbase

  8. In the Name box, type 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.
  9. In the Data box, type the path to the docbase folder.
    Important: If you opened the TEXTML Server Administration Console from a different machine than where TEXTML Server and the docbase are installed, you must enter the full path to the docbase on the machine where it is installed (and the Browse button is disabled).
  10. 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.
  11. Under Installation Type, click New document base to install a new and empty docbase entity.
  12. Click OK.
    The new docbase and its associated subfolders appear as child nodes of the server.
Troubleshooting
  • Look in the logs. Open the textml_instance-namelog file in /opt/ixiasoft/textmlserver/instance-name/log and check the error message details.
  • 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.