Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The File System SMB Connector can be configured using the Aspire Admin UI. It requires the following entities to be created:

  • Connection
  • Connector
  • Seed
  • Credential

Below Bellow are the examples of how to create the Connection and , the Seed, the Credential. For the General Connector Configuration, please check this page.

Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default


Create Connection


  1. On the Aspire Admin UI go to the connections tab 
  2. All existing connection will be list. Click on the new button 
  3. Enter the new connection description. 
  4. Select Filesystem SMB from the Type list.
  5. General
    1. Base Path: Path of the base directory to crawl. All the seeds will be prefixed with this value to form the full path. All the seeds will be prefixed with this value to form the full path
    2. Hostname: Hostname where the shared directory is located.
    3. Port: Port where the SMB protocol is usedIgnore Symbolic Links: If enabled symbolic links will not be processed and links in the root items will cause an error.
    4. Index directories: Enable to index the directories.
    5. Scan recursively: Enable to scan discovered directories recursively.
    6. Stop on scan error: If checked, the crawl will stop if error.
    7. Disable fetcher: Check to disable the connector fetcher, only metadata will be collected.
    8. Show SMBJ logs: Enable SMBJ logging, (WARNING) enabling decrease performance.
  6. Scope
    1. Scan excluded items: Enable to force the scan of excluded directories, so child items within the scope can be found.
    2. Include patterns: Patterns to match against document URL, if any of them match, the document will be included in the crawl.
    3. Exclude patterns: Patterns to match against document URL, if any of them match, the document will be excluded from the crawl.
  7. Security
    1. Static ACLs: These ACLs will be added to all of the documents.
      1. Name: Name of the ACL.
      2. Domain: Domain to which the ACL belongs to.
      3. Entity:  Whether or not Whether this ACL is for a group or a user.
      4. Access:  Whether or not Whether this ACL will have access to crawled files.
  8. Connection
    1. : Check to resolve (DFS) paths.
    2. Connection timeout: Timeout in milliseconds for each SMB request.
    3. Maximum retries: Maximum retries permitted per document.
    4. Base back off: Base time for the back off sleeps (in ms).
    5. Back off multiplier: Multiplier factor to be used for the back off time.
  9. Credentials
    1. Select credential for this connection.
  10. Policies
    1. Throttle Policy:  Select Select the throttle policy that applies to this connection object.
    2. Routing Policies: Select the routing policies that this connection will use.

Image Removed

Image Removed

Image Removed

Image Removed

Image RemovedImage AddedImage AddedImage AddedImage AddedImage AddedImage AddedImage Added


Create Connector


For the creation of the Connector object using the Admin UI, check this page.


Create Seed


  1. On the Aspire Admin UI go to the connections tab 
  2. All existing connection will be list. Click on the new button 
  3. Enter the new seed description. 
  4. Select Filesystem SMB from the Type list.
  5. Seed:  The subdirectory to crawlCrawl path. This value will be appended to the base path of the connection.
  6. General: Process start path as a file: If checked, the path will be processed as a file instead of a directory. (WARNING: The crawler will only process the seed and then will stop.
  7. Connector:  The id The ID of the connector to be used with this seed. The connector type must match the seed type.
  8. Connection:  The id The ID of the connection to be used with this seed. The connection type must match the seed type.
  9. Workflow:  The ids The IDs of the workflows that will be executed for the documents crawled.
  10. Tag: The tags of the seed, these can be used to filter the seed.
  11. Policies
    1. Throttle Policy: Select the throttle policy that applies to this connection object.
    2. Routing Policies: Select the routing policies that this connection will use.

Image Removed

Image Removed

Image Removed

Image Removed

Image Removed

Image Removed

Image AddedImage AddedImage AddedImage AddedImage AddedImage AddedImage AddedImage Added








Create Credential

  1. On the Aspire Admin UI go to the credentials tab Image Added
  2. All existing credentials will be list. Click on the new button Image Added
  3. Enter the new credential description.
  4.  General
    1. Domain: Domain of the account that will crawl shared directory. Leave blank for local user.
    2. Username: Account User
    3. Password:  Account Password

Image AddedImage AddedImage Removed