How to use them?

In OnePart Console, you can create sources and import the files easily.

We highly recommend that you use the OnePart Console to create your sources. OnePart automatically configures the security and Consolidation Server requirements. If necessary, you can configure the advanced options in the Administration Console.

Note: We strongly recommend using the app-admin user for the Administration Console procedures in this guide.

All supported connectors are pre-deployed in NETVIBES OnePart. For the complete list, see What are they?

This page discusses:

Workflow

The workflow for setting up a OnePart connector is:

  1. Install the web service (required for SolidWorks PDM and SmarTeam connectors).
  2. Although all NETVIBES OnePart connector plugins are deployed automatically during the OnePart installation. Certain connectors require additional setup. See the specific documentation for the connector.
  3. Add new source in the OnePart Console.
  4. Import your data.
  5. Schedule your scans.

Basic operations

You can perform basic operations for the OnePart connectors using the following buttons:

  • – to add new sources (if you don’t see your source type in the list you probably haven’t deployed the connector yet.) See To add a new source.

  • – copy sources from existing ones.

  • Filter rules – to create filters to be used when OnePart scans your files. See To exclude files from being indexed.

  • Import – to perform a full (re)scan for a specific connector. This does not clear the existing documents from the index, it merely performs an update. See Importing your data.

  • Schedule scan – to schedule scans on either a daily basis or based on the set frequency. See Scheduling your scans.

  • Clear – to clear all connector’s documents from the system and reset the connector’s state. Once you clear the documents, you can delete the connector.

Deploying connectors

The connector plugins are pre-deployed in Exalead CloudView. However, certain connectors may require some additional setup. See the specific connector documentation for details.

Adding sources

We highly recommend that you use the OnePart Console to create your sources. OnePart automatically configures the security and Consolidation Server requirements. If necessary, you can configure the advanced options in the Administration Console.

However, if OnePart Console does not currently support your connector then you must use the Administration Console to manually create the connector and configure the advanced PAPI filters required. You must also configure the security sources manually. See the specific connector’s documentation for the procedure details.

Note: The OnePartPAPIFilters connector contains PAPI Filters that are required for any connector deployed in OnePart. Any connector deployed without these PAPI Filters will not be supported.

To add a new source

  1. Open NETVIBES OnePart.
    1. Open your web browser at http://<ONEPART_SERVERNAME>:<BASEPORT> For example, http://host:10000
    2. Enter the administrator’s Login / Password: app-admin / exalead (by default)
  2. Select OnePart Console from the user menu.

  3. In the Sources tab, click and select the source from the menu. For example, select Files to add a filesystems source.

  4. Complete the fields as follows:
    1. For Name, enter, for example, Design_team
      Note: Choose this name carefully as it cannot be changed after. You should always use an intuitive name since it appears as a navigation facet in the OnePart UI.
    2. For Paths, enter the file system path to crawl. Click ‘...’ to choose a path from the file browser.
    3. Click ‘+’ to create additional paths.
    4. Click OK.
  5. You must import the files before being able to search within their content.

To exclude files from being indexed

You can set the filter rules for each connector. For more help, see the online tooltips '?'

  1. In the OnePart Console, click the Sources tab.
  2. Click Filter Rules beside the connector you want.
  3. Set the filter rules:
    1. The maximum file size allowed
    2. Exclude file types from being indexed; To exclude all LOG, TMP and PDF files, enter a space separated list in Extensions, for example, log tmp pdf
    3. Ignore rules that allow you to filter based on the source system paths. They are applied according to the file_path meta of documents; for example, */tmp/* filters any document which path contains "/tmp/" in it.
  4. Click OK.

Importing your data

To import your files in NETVIBES OnePart.

  1. Open the OnePart Console.
  2. In the Sources tab, click the Import button beside the connector.


This triggers the import process. You can abort the process if you want.

Verify that your content has been imported correctly. Check the number of documents in the Items column.

Note: All connectors only guarantee that the initial import copies the source to the index in the state of the source at the beginning of the initial import. This means that any data added or modified or deleted during the initial import may or may not be taken into account by the initial import. This is especially true for long initial imports (several days). Therefore, it’s a good practice to perform an incremental scan right after the initial import is over.

How it works

Let's say we see the following (after first import):

Items

Scanned

Imported

Deleted

0 / 150

200

150

0

This means:

The connector saw 200 documents, but given its inside rules, it only imported 150 to the index.

0/150 - there are 150 items in the index but the logged-in user cannot see them due to the security restrictions. The admin user typically does not have rights on the files.

Let's import a second time after some modifications on the source files:

Items

Scanned

Imported

Deleted

0 / 125

180

4

25

This means:

180 documents seen on the source, 20 were removed since the previous scan but some (5) were also modified and now match some exclude rules: hence 25 are deleted leaving 125 Items in the index. 4 were imported because they have been modified since last import.

Scheduling your scans

You can schedule your scans on either a daily basis or based on the set frequency by connector.

  1. Open the OnePart Console.
  2. In the Sources tab, click the Schedule Scan button beside the connector you want to schedule

  3. Set the scan frequency:
    • for a daily basis, select Daily and set the time OR
    • for a more frequent basis, select Every and set the time to either: 5mn, 15mn, 1h, 2h or 4h.
  4. Click OK.