You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

  • Connection
  • Connector
  • Seed
  • Credential

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


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 SMB from the Type list.
  5. General
    1. Hostname: Hostname where the shared directory is located.
    2. Port: Port where the SMB protocol is used.
    3. Index directories: Enable to index the directories.
    4. Scan recursively: Enable to scan discovered directories recursively.
    5. Stop on scan error: If checked, the crawl will stop if error.
    6. Disable fetcher: Check to disable the connector fetcher, only metada will be collected.
    7. Show SMBJ logs: Enable SMBJ logging, (WARNING) enabling decrese 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 this ACL is for a group or a user.
      4. Access: Whether or not this ACL will have access to crawled files.
  8. Connection
    1. : Check to resolve (DFS) paths.
    2. Connection timeout: Timeout in millis for each smb request.
    3. Maximum retries: Maximum retries permitted per document.
    4. Base backoff: Base time for the backoff sleeps (in ms).
    5. Backoff multiplier: Multiplier factor to be used for the backoff time.
  9. Credentials
    1. Select credential for this connection.
  10. Policies

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 from the Type list.
  5. Seed: The subdirectory to crawl. This value will be appended to the base path of the connection.
  6. Connector: The id of the connector to be used with this seed. The connector type must match the seed type.
  7. Connection: The id of the connection to be used with this seed. The connection type must match the seed type.
  8. Workflow: The ids of the workflows that will be executed for the documents crawled.
  9. Tag: The tags of the seed, these can be used to filter the seed.
  10. 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.


  • No labels