This section covers system management operations on documents and indexes for the documentation search service:
Not all documents on a documentation server can be read and searched within the library service application. Two things must occur before a document can be accessed using the Documentation Library Service:
You can register documents two ways:
This section provides an overview of the steps to register a document and create an index of the document. When you are ready to actually do this work, see the chapter on the documentation library service in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs for the detailed instructions on completing these steps.
If you are the system administrator of a documentation server, the next step is to register the new indexes on the server.
For detailed instructions on creating and registering a document and index, see Creating Indexes of your Documentation in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.
If a document and its index were automatically registered when an application was installed on the documentation server, you must use normal software uninstall tools of the operating system to remove the document. If you simply delete a registered document or its index, it will still be registered with the library service. This generates error messages during searches since the search service still tries to search the missing index.
Note: If you uninstall a package and it does not correctly remove all of its indexes, use the following procedure to clean up your system.
If you want to delete a document that was manually registered by the system administrator, follow the instructions in Removing Indexes in Your Documentation in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.
If the contents of a document change, the index of the document must be updated to reflect the changes to the contents of the document. If you are installing an updated application and it automatically registers its documents, it automatically updates the old indexes with the new ones. If you are updating a document that a user created, you have to manually update the index for the document.
Do not move application documents that were automatically installed with an application. For example, do not move operating system base documentation after it is installed. If you move automatically registered documents, the search service is unable to find the documents and errors occur.
You can move documents that you wrote and manually indexed and registered. However, when you move a document, you must tell the search service how that document path has changed so that the service can find the document.
The first part of a document path is stored in the index registration table, and the last part is stored inside the index for that document. There are two methods for changing a document path depending on which part of the path you are changing.
To determine which method you need to use, as root (or a member of the imnadm group:
/usr/IMNSearch/bin/itedomap -p /var/docsearch/indexes -l -x index_name
where index_name is replaced with the name of the index that contains the documents you want to move.
The output of the command looks similar to:
Index index_name - index_title, documents in: path function completed
The path in the output shows you the part of your document path that is stored in the registration table. If you are only changing the names of directories that are listed within the path, you can use the first move method in the following. Write down the current index_name, index_title, and path. Then skip to the next numbered step to change this part of the document path.
However, if you need to change any part of the path that is lower (to the right) of the part of the path shown in the output, you must update the index instead. This is because the lower part of the path is stored inside the index. To update the index, go back to the Updating Documents section and complete all the instructions in that section. Also, go to that section if you need to make changes in both the upper and lower parts of the document path. In either case, you do not need to do any other steps in this section.
/usr/IMNSearch/bin/itedomap -p /var/docsearch/indexes -u -x index_name -sp \ path -ti "index_title"
Note: There must be a trailing slash (/) in the path.
In the above commands replace the path part of the command with the new path where you moved your document. Replace index_name and index_title with the values you wrote down from the output of the command in the first step.
For example, if your documents are in the acctn3en English index and the index title is "Accounting Documents", you can move the document tree from the /doclink/en_US/engineering directory into the /doc_link/en_US/accounting directory by typing the following:
/usr/IMNSearch/bin/itedomap -p /var/docsearch/indexes -u -x acctn3en -sp \ /doc_link/en_US/accounting/ -ti "Accounting Documents"
Note: If you need to, you can change the index title by typing a new title in the previous command. You cannot change the index_name.
Changing the document's library service location is now complete. If you have not already done so, you can now move your documents. Next, test your changes by searching for a word that is inside the moved documents. The document's link in the search results page correctly displays the document.
Follow your normal security procedures for the documents on the documentation server. In addition, a documentation server also has the added security elements of the document indexes and the web server software.
Indexes are treated as files that include a list of all the words in the original documents. If the documents contain confidential information, then the indexes themselves are treated with the same care as the documents.
There are three levels of security you can set up for indexes:
By default, the permissions on the indexes directory are set so that all web server users can both search and read all index files.
All web server users can search inside indexes for key words, but cannot open an index file to directly read its contents. This makes it more difficult for users to obtain confidential data, but a person can sometimes still gain a lot of information just by knowing if certain key words are inside a document. Assuming you store all your indexes in the standard location, you can set this level of security by setting the permissions of the /usr/docsearch/indexes directory. It is set to the user:group imnadm:imnadm with all permissions for others disabled so that only members of the imnadm search administration group can read the index files. To set these permissions type the following two commands:
chown -R imnadm:imnadm /usr/docsearch/indexes
chmod -R o-rwx /usr/docsearch/indexes
Note: The user imnadm must always be able to read and execute the directory where you store indexes. This is because the search engine runs as user imnadm when it searches inside indexes.
This is done by setting the permissions as in "Search, but not read" to prevent reading of index files. In addition, a user's permission to use the search service web server is disabled (this prevents searches). The user is unable to search indexes because the web server does not let the user open the search form. This security level is set up using the administration functions in your web server software to turn off a user's permission to use the web server. See the documentation that came with your web server to determine how to configure your web server software to prevent access by specific users.