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

• Connection
• Connector
• Seed
• Credential

Below are the examples of how to create the Connection, the Seed, the Credential. For the General Connector Configuration, 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 metadata will be collected.
   7. 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. Retrieve security information: Check to retrieve owner, group and ACL information.
   2. Resolve security information SIDs: Check to resolve retrieved SIDs from owner, group and ACL.
   3. Add SID value to retrieved ACLs: Check to include ACL SID on ACL output.
   4. Add encoded SID (Base 32) value to retrieved ACLs: Check to include ACL encoded SID (Base 32) on ACL output.
   5. Add ACL flags to retrieved ACLs: Check to include ACL flags on ACL output.
   6. Add ACL type to retrieved ACLs: Check to include ACL type on ACL output.
   7. Add ACL access mask to retrieved ACLs: Check to include ACL access mask on ACL output.
   8. Static ACLs: These ACLs will be added to all the documents.
      1. Name: Name of the ACL.
      2. Domain: Domain to which the ACL belongs to.
      3. Entity: Whether this ACL is for a group or a user.
      4. Access: Whether this ACL will have access to crawled files.
8. Connection
   1. Distributed File System (DFS) resolution: 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 the throttle policy that applies to this connection object.
    2. Routing Policies: Select the routing policies that this connection will use.
       
       

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 SMB from the Type list.
5. Seed: Crawl 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 of the connector to be used with this seed. The connector type must match the seed type.
8. Connection: The ID of the connection to be used with this seed. The connection type must match the seed type.
9. Workflow: 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.

Create Credential

1. On the Aspire Admin UI go to the credentials tab 
2. All existing credentials will be list. Click on the new button 
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