Registering file system paths


As an administrator, you must register a File System Path so that you can search for files in a specified directory. It is used for sources that are retrieved from an external file system. When you register this source type, you define the path to the folder that contains the files that you want to index for searching. The folder can be stored on the AR System server computer or on a remote computer to which you have access. Knowledge Management stores and manages the metadata of this source.

File system path sequence

The Registration Wizard uses the following panel sequence when you register file system paths as knowledge sources:

Welcome > Source > Organization > Categorization > Accessibility > Completion

Prerequisites for file system path registration

Fulfill the following list of prerequisites before you register file system paths as knowledge sources:

  • Verify that the account, which runs the AR System server process on the computer on which the AR System server resides, has permission to the directory (remote or local) that contains the files that need to be indexed.
  • If the file system folder resides on a Windows computer and AR System resides on a UNIX computer, you should be able access to the folder. To get access, install a product that allows file and print services to SMB/CIFS clients, such as Samba, on the UNIX system.
  • Before you register knowledge sources that reside on a remote computer, verify that the AR System server has been started with a special domain user, to enable access to the files. This user must have read permissions for the file system folder that contains the knowledge sources. If AR System is installed on a UNIX computer, you must start the AR System server process by using the special domain user.

Limitations of file system path registration

Global search results might include external files that have been registered as knowledge-base items. If the search conditions are fulfilled by XML or HTML files that have been registered in this way, the Global Search Results screen appears distorted because of the tags that are used in XML and HTML files. Additionally, the Advanced search link on the search results screen becomes unresponsive.

To register a file system path

  1. Open the Knowledge Management Console.
  2. In Functions, click Manage Knowledge Sources.
  3. Click Add.
  4. In the Welcome panel, select Knowledge Base Item > File System Path and click Next.
  5. Enter the full path of the directory on a remote computer using the Universal Naming Convention (UNC) name syntax, or enter a local path on the AR System server computer.
  6. Provide a name for the knowledge source.
  7. Enter the file extensions that are to be indexed and managed by Knowledge Management, (for example, pdf;doc;txt). You can also enter .ppt and .pptx file extensions, provided the files are not compressed, and .msg file extension. 

    SuccessBest practice
    We recommend you to not use the *.file extension format. For example, you must enter the file extension as pdf and not as *.pdf. This suggestion is applicable for all types of file extensions.
    For a list of more supported file formats, see How FTS indexing works for attachments from the AR System online documentation.

  8. Define whether to include sub-folders.
  9. Enter the Owner and Owner Group.
  10. Enter the Description and Language, as required.
  11. In the Organization panel, enter information in the appropriate fields.
    • To add visibility groups to the source, select a company and a visibility group from the lists and click Add.
      The visibility group is assigned to all the articles from that source.
    • You can add more than one visibility group for each source.
  12. In the Categorization panel, select the appropriate Operational Categorization and Product Categorization values.
  13. In the Accessibility panel>Companies, select the companies to which this source belongs.
  14. Click Finish in the Completion panel.
  15. (optional) View the registration status in the Status column of the Manage Knowledge Sources page.

To start the AR server service with a special domain user

  1. Stop the AR System service.
  2. Right-click on the service and select Properties.
  3. Open the Log On tab.
  4. Select This Account and enter the name of the special domain user with the permissions for the remote directories and sub-directories.
  5. Enter the user password.
  6. Confirm the user password. 
  7. Click OK.
  8. Start the AR System service.


To increase the timeout period of the registration plugin

  1. Stop the AR System server.
  2. Add the following line to the pluginsvr_config.xml file, as displayed in the example below:
    <Api-Timeout>3600</Api-Timeout/>
  3. Start the AR System server.

Example:

<plugin>
<name>RMDY.ITSM.RKM.REGISTRATION</name>
<type>FilterAPI</type>
<code>JAVA</code>
<filename>/data1/Remedy/RemedyRemedyITSMSuite/Shared_Components/plugins/rkm-registration.jar</filename>
<classname>com.Remedy.itsm.rkm.filterapi.registration.RegistrationController</classname>
<pathelement>/data1/Remedy/RemedyRemedyITSMSuite/Shared_Components/plugins/rkm-common.jar</pathelement>
<pathelement type="location">/data1/Remedy/ARSystem/pluginsvr/foundation_shared/ITSMCommonUtils.jar</pathelement>
<pathelement type="path">/data1/Remedy/RemedyRemedyITSMSuite/Shared_Components/plugins</pathelement>
<userDefined>
<Api-Timeout>3600</Api-Timeout/>
</userDefined>
</plugin>


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Helix ITSM: Knowledge Management 25.2