Adding a primary volume

A primary volume serves as a primary data source in IBM® StoredIQ®. You must have at least one primary volume within your configuration.

Procedure

  1. Click Data Servers > a data server > Add Volume.
  2. In the Add Volume dialog box, complete all fields as required for the data source.

    Except for Box and OneDrive volumes, volumes can also be added in IBM StoredIQ Data Server. However, the set of available configuration options slightly varies.

    Chatter, Domino®, and Jive volumes can be added in IBM StoredIQ Data Server only.

    Note: When you name a volume, avoid using commas (,). Although a comma is a valid character, it causes queries to fail when specified as part of the search text.
    Table 1. Box primary volumes.
    Prerequisites: For Box volume prerequisites and configuration information, see Box volume configuration notes.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select Box.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server The server name api.box.com is automatically set and cannot be changed.  
    Authenticate with Box Before a Box volume can be added, the user must be authenticated. Click the Authenticate with Box link, sign in to the Box account, and select Grant access.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common, user-defined name of this volume.  
    Include Users Select this option to scope the volume. Regular expressions are supported.
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 2. CIFS/SMB, SMB2, or SMB3 primary volumes
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select CIFS. SMB, SMB2, and SMB3 are supported. Depending on the setup of your SMB server, some additional SMB configuration might be required on the IBM StoredIQ data server. For details, see Configuring SMB properties.

    If you want to preserve ownership of objects in Copy or Move actions between CIFS volumes, you can add an admin knob as described in Enabling ownership preservation for objects on CIFS volumes.
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.
    If you create a volume for use with Distributed File System (DFS) services, provide the following information:
    • For a domain-based namespace, specify the fully qualified domain name (FQDN) of the server.
    • For a standalone namespace, specify the hostname of the namespace server.
    		 For using DFS services, the jcifs.smb.client.dfs.disabled SMB property in the jcifs.properties file must be set to false. For details, see the property description.
    Username Enter the user name that is used to connect to and mount the volume.

    If you create a volume for use with Distributed File System (DFS) services, enter the fully qualified domain name of the server and the user name for connecting and mounting the volume in the format FQDN\user.

    		 The user must be in the backup operator group on the Windows Share server that shows the shares on IBM® StoredIQ® and also needs to have full control share-level permissions.
    Password Enter the password that is used to connect to and mount the volume.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Share Enter the share name of this volume.

    If you create a volume for use with Distributed File System (DFS) services, enter the DFS namespace.

    		 Data from file or directory symbolic links in a share cannot be harvested.
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.

    If you create a volume for use with Distributed File System (DFS) services, enter the folder target.

    If you create a volume for use with Distributed File System (DFS) services and want to include all namespace folders, do not specify an initial directory.
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 3. Connections primary volumes.
    Prerequisites: For Connections volume prerequisites and configuration information, see Configuration of IBM Connections.
    Field Value Notes
    Volume Type Select Primary in the Volume type list.  
    Source Type Select Connections in the Source type list.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    User name Enter the user name of the account that is set up with admin and search-admin privileges on the Connections server.  
    Password Enter the password of the account that is set up with admin and search-admin privileges on the Connections server.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter a name for the volume.  
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Class name Enter 
    deepfile.fs.template.
impl.ibmconnections.
ibmconnectionsconn.
IBMConnections
    		 Required
    Repository Enter 
    deepfile.fs.template.
impl.ibmconnections.
ibmconnectionsconn
    		 Required
    Option string Enter more option parameters.  
    Indexing options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 4. CMIS primary volumes
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select CMIS.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    Port Enter the port number.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Use SSL Select the Use SSL checkbox.  
    Service Enter the service name.  
    Repository Enter the name of the repository.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 5. Documentum primary volumes.
    Prerequisites: Before you can add Documentum volumes, you must add the Documentum server. For more information, see Adding a Documentum server as a data source.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select Documentum.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Doc base Enter the name that was entered on the data server from the doc broker settings.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Assign To Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Harvest all document versions If you need to harvest all document versions, select the checkbox.
    Important: If you do not select this option for the initial harvest, changing the setting later does not have an effect when the volume is reharvested. As a workaround, create a new volume and ensure that the Harvest all document versions option is set before you start harvesting.
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects.
    • Include content tagging and full-text index.
    		 These options are not selected by default.
    Table 6. Exchange primary volumes.
    Prerequisites: For Exchange volume prerequisites and configuration information in general, see Configuration of Exchange servers.

    Exchange Online volumes require some additional prerequisite configuration. For more information, see Registering IBM StoredIQ as a Microsoft service application for access to Exchange Online.

    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select Exchange.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting. If Exchange Online is selected as the source type, the server name is automatically entered.
    Username Enter the user name that is used to connect to and mount the volume. This field is not available if Exchange Online is selected as the source type.
    Password Enter the password that is used to connect to and mount the volume. This field is not available if Exchange Online is selected as the source type.
    Impersonation Account Enter the user account to use for connecting to Exchange Online. This account must be authorized to impersonate the members of the specified impersonation scope. This field is available only if Exchange Online is selected as the source type.

    For more information, see Registering IBM StoredIQ as a Microsoft service application for access to Exchange Online.

    Client ID Enter the application (client) ID under which IBM StoredIQ is registered with Microsoft. This field is available only if Exchange Online is selected as the source type.

    For more information, see Registering IBM StoredIQ as a Microsoft service application for access to Exchange Online.

    Client Secret Enter the client secret that is associated with the client ID. The values make up the credentials for access to a Microsoft Exchange Online data source.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Server Version Select the version of Microsoft Exchange, choosing from 2000/2003, 2007, 2010/2013/2016, and Online.  
    Mailbox Server Enter the names of the mailbox servers, which are separated by commas. If Exchange Online is selected as the Server Version, this option is not available.
    Active Directory Server Enter the name of the Active Directory server. If Exchange Online is selected as the Server Version, this option is not available.
    Use SSL To use secure socket layer, select the Use SSL checkbox. If Exchange Online is selected as the Server Version, this option is automatically selected and cannot be edited.
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Virtual Root The name defaults to the correct endpoint for the selected Exchange version.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 7. FileNet® primary volumes.
    Prerequisites: For FileNet volume prerequisites and configuration information, see Configuring FileNet.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select FileNet.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    Port Enter the port number.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Object Store Enter the object store.  
    Connection Type Select either HTTP or HTTPS.  
    Path Enter the appropriate directory path.  
    Stanza Enter the appropriate stanza.  
    Scope Optionally, enter the appropriate SQL where clause.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 8. HDFS primary volumes
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select HDFS.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified host name of the server or the IP address from which the volume is available for mounting. Either NameNode service or Knox Gateway service is assumed to be running on this server.
    Port Enter the port number. For NameNode service, use port 50070 and port 8443 for Knox Gateway service.
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume. Authentication to HDFS is not supported for NameNode connectivity (port 50070). If your HDFS server requires a password, use Knox Gateway connectivity.
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Use SSL To use SSL, select the checkbox. See Option String for more certificate options.
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Repository Enter the name of the repository.  
    Option String

    VerifiCertificate=True

    • This option is supported.
    • This option is optional.

    knox_prefix=/gateway/default

    • This option is supported.
    • This option must be used for Knox Gateway connectivity.
    		 This VerifiCertificate option is used to indicate that the validity of the HDFS server's SSL certificate is verified when SSL is used. Values are True, False, or default value. If no value is specified, value is False. To validate the certificate on the HDFS server, the user needs to specify this option and set the value to True.
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 9. IBM Content Manager primary volumes.
    Prerequisites: For IBM Content Manager configuration information, see IBM Content Manager attributes.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select IBM Content Manager.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified host name of the library server database.  
    Port Enter the port that is used to access the library server database.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Connection String Optional: Enter connection-string parameters.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Repository Enter the name of the library server database.  
    Server Type Select the type of server that is associated with the volume. Options include DB2 and Oracle. By default, DB2 is selected.  
    Schema Enter the schema for this library server database.  
    Remote Database Enter the name of the remote database.  
    Harvest Itemtype Enter the names of the item types to be harvested, separated by commas. Harvest type is required to harvest the CM8 volume.
    Copy to Itemtype Either enter SiqDocument as the item type or leave the field empty. If you do not specify the item type, the volume cannot be used for copy-to actions. For more information, see IBM Content Manager attributes.
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 10. Livelink primary volumes.
    Prerequisites: A copy of the lapi.jar file from a Livelink API installation must be available in the /usr/local/IBM/ICI/vendor directory on each data server in your deployment. Usually, you can find this file on the Livelink server in the C:\OPENTEXT\application\WEB-INF\lib directory. However, the path might be different in your Livelink installation.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select Livelink.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    Port Enter the port number.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Database Enter the database name.  
    Search Slice Enter the search slice.  
    Initial Directory Optionally, enter the search slice and name of the initial directory from which the harvest must begin.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 11. NFS primary volumes.
    Prerequisites: Root access must be enabled on the NFS server that is connected to IBM StoredIQ.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select NFS.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Export Enter the export name for this volume.  
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 12. NewsGator primary volumes.
    Prerequisites: For NewsGator volume prerequisites and configuration information, see Configuring NewsGator.
    Field Value Notes
    Volume Type Select Primary.  
    Source Type Select NewsGator.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the server from which the volume is available for mounting.  
    Username Enter the user name that is used to connect to and mount the volume.  
    Password Enter the password that is used to connect to and mount the volume.  
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data.  
    Volume Name Enter the common name of this volume.  
    Initial Directory Optionally, enter the name of the initial directory from which the harvest must begin.  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default.
    Table 13. OneDrive primary volumes.
    Prerequisites: For OneDrive volume prerequisites and configuration information, see OneDrive volumes configuration notes.
    Field Value Notes
    Volume Type Select Primary  
    Source Type Select OneDrive.  
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server For OneDrive volumes, enter the server name.  
    Authenticate with OneDrive Before a OneDrive volume can be added, the user must be authenticated. Click the Authenticate with OneDrive link, sign in with your Global Administrator account. Required.

    You will also need to approve the requested permissions. Select the Consent on behalf of your organization checkbox and click Accept.
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data. Required.
    Volume Name Enter the common, user-defined name of this volume.  
    Initial Directory Select one of these options:
    • To harvest the data of all sites including subsites and all private files on these sites, leave the field empty.

      This is the default for new volumes.

    • To harvest the entire data of a specific site including its subsites, specify the site name.
    • To harvest the entire data of a specific subsite, specify the name of the subsite in the format site/subsite.
    • To harvest all private files of a specific user, specify this user's email address.

    To include private folders in harvests of existing volumes, update the volume. Then, reharvest the volume to have the folders indexed.

    		  
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 These options are not selected by default. Facets, personal drives, and notifications are not harvested.
    Table 14. SharePoint primary volumes.
    Prerequisites: For SharePoint volume prerequisites and configuration information, see Configuration of SharePoint.
    Field Value Notes
    Volume Type Select Primary. Required.
    Source Type Select SharePoint. Required.
    Unified Governance If you want to exclude the volume from synchronization with the governance catalog, clear the Publish to catalog checkbox. This option is available only if synchronization with the governance catalog is enabled.
    Server Enter the fully qualified domain name of the SharePoint server. Required.
    Username Enter the name of a user with the required permissions for that site collections. Use the following syntax:
    • SharePoint Online: 
      userid@Microsoft_cloudname.com
    • Other SharePoint versions:
      Active Directory Domain Name\username
    		 Required. Use a site collection administrator account.
    No volume can be added if the validation of the credentials fails, which can happen for the following reasons:
    • The user does not exist or does not have the required permissions.
    • The password is not correct.
    The HTTP status code is usually 401 Unauthorized. However, for SharePoint Online, the HTTP status code 400 Bad Request is returned for insufficient permissions.
    Password Enter the password for the user specified as Username. Required.
    Assign to Data Server Select the IBM StoredIQ data server that you want to obtain and index the data. Required.
    Volume Name Enter a meaningful name for this volume. Required.
    Server Version Select the applicable SharePoint version: 2003, 2007, 2010, 2013, 2016, or Online. Required.
    Site URL Enter the URL of the SharePoint site collection, for example: /portal/site Required. Do not include the SharePoint server name in the URL, otherwise the URL cannot be located on the server and thus no volume is created.
    Recurse into subsites To check all sites and subsites of the site collection for data objects, select this option. Optional.
    Use SSL Select Use SSL only if SSL is enabled for this SharePoint server. For SharePoint Online, this option is automatically selected and cannot be edited. Optional.

    If SSL is enabled on the SharePoint server and you do not select this option, no volume is created and the HTTP status code 301 Moved Permanently is returned. To fix the issue, select the option.

    If SSL is not enabled on the SharePoint server and you select this option, no volume is created and the socket error [Errno 111] Connection Refused is returned. To fix this issue, clear the Use SSL checkbox.
    Include all versions To harvest all versions of a document, select this option. Optional.
    Initial Directory Enter the name of the subsite from which you want the harvest to start. Optional.
    Indexing Options Select the checkbox for the indexing options that you want to include:
    • Include metadata for contained objects
    • Include content tagging and full-text index
    		 Optional.
    Tip: Select Include metadata for contained objects to have metadata for objects in containers added to the metadata index. To avoid creating a full-text index for the entire volume, make sure the Include content tagging and full-text index checkbox is not selected. Create a full-text index for a subset of data later by running a Step-up Analytics action.

    For SharePoint Online, full-text indexing of OneNote notebook objects, that is, Notes®, is not supported currently. FSMD-based searches for these files are supported.
  3. Click Save to save your configurations and add the volume.
  4. Click View Volumes. Notice that the added volume appears therein, listed as a primary volume. To harvest this newly added volume, select that volume and then click Harvest.