This section covers system management operations on documents and indexes for the documentation search service:
Not all documents on a documentation server can be searched. Two things must occur before a document can be searched using the Documentation Search Service:
Documents are registered in two ways:
To create an index, you will complete the following steps. When you are ready to create the index, see the chapter Documentation Search Service in the AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs book for more information.
If you are the system administrator of a documentation server, the next step is to register the new indexes on the server.
After your indexes are registered, they will appear for searching in the global Documentation Search Service search form that is launched by typing the docsearch command or by opening the Documentation Search Service icon in the CDE Desktop. You can also create your own custom search form that only shows a subset of all registered indexes. For instructions, read the section on creating your own search forms in the Documentation Search Service chapter in the AIX 4.3 General Programming Concepts book.
For detailed instructions on creating and registering an index, see the chapter Documentation Search Service in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs for more information.
If a document and its index were automatically registered when an application was installed on the server, you must use the uninstall process to remove the document. If you simply delete a registered document or its index, it will still be registered with the search service. This will generate error messages during searches since the search service will still try to search the missing index.
Note: If you uninstall a package and it does not correctly remove all its indexes, use the procedure below to clean up your system.
If you want to delete a document that was manually registered by the system administrator, see the instructions in section Removing Indexes in Your Documentation, AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.
If a document's contents 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 should automatically update the old indexes with the new ones.
If you are updating a document that a user created, you will have to manually update the index for the document.
You can move documents that you wrote and manually indexed and registered. But when you move a document, you must tell the search service how that document's path has changed or the service will no longer be able to find the document.
The first part of a document's 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's path depending on which part of the path you are changing.
To determine which method you need to use, type, as root (or a member of the imnadm group>, the following command:
where <index_name> is replaced with the name of the index that contains the documents you want to move.
The command will output something like this:
Index <index_name> - <index_title>, documents in: <path> NetQ function completed.
The <path> in the output shows you the part of your document's 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 described below. 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 instead update the index. 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. You should 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.
Note: There must be a final slash (/) after the <path> as shown below.
/usr/IMNSearch/cli/imndomap
/var/docsearch/indexes -u <index_name> /<path>/ <index_title>
/usr/IMNSearch/cli/imqdomap
/var/docsearch/indexes -u <index_name> /<path>/ <index_title>
For example, your documents are in the acctn3en English(single-byte) index and the index title is "Accounting Documents". You moved these document's tree from the /doclink/en_US/engineering directory into the /doclink /en_US/accounting directory. You would type (all on one line):
/usr/IMNSearch/cli/imndomap
/var/docsearch/indexes -u acctn3en
/doc_link/en_US/accounting/ Accounting Documents
Note: If you need to, you can change the index title by typing a new title in the above command. You cannot change the index_name.
cp /var/docsearch/indexes/imnmap.dat /usr/docsearch/indexes
You should 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 webserver software.
Indexes should be 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 should be 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 webserver users can both search and read all index files.
All webserver 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, this state is set up 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/indexesNote: 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 level two above (this prevents reading of index files). In addition, a user's permission to use the search service webserver is disabled (this prevents searches). The user will be unable to search indexes because the webserver will not let them open the search form. This security level is set up using the administration functions in your webserver software to turn off a user's permission to use the webserver. Consult the documentation that came with your webserver to determine how to configure your webserver software to prevent access by specific users.