How to Set Up and Configure Your FileNet Connector

All BA Insight connectors can be downloaded from the Upland Right Answers Portal under Knowledge > BA Insight > Product Downloads > Connectors. This connector is installed with the same generic steps as any BA Insight connector. You must satisfy the Prerequisites for your connector before installing. The configuration specifics are detailed below.

Procedure:

  1. After you establish a web service connection Connection defines the how Connectivity Hub connects to your Source System (which contains your documents, graphics, etc.,). Your Connection includes identifying elements such as: URL of the BA Insight web service connector you are using, (File Share connector, SharePoint Online connector, etc.), Authentication mode, User Accounts and Credentials, Database information (for database connectors), connect to the web service.
  2. In Connectivity Hub, click Connections.
  3. On the Connections page, enter the following information:
    1. Logins
      1. MSSQL mode:
        1. Enter the account in domain\login form.
        2. This account must have full read access to the FileNet database using integrated security and must be on the database you specify below.
      2. Oracle database mode:
        1. Your Connector requires both a valid Active Directory A directory service for Windows domain networks. A hierarchical structure that stores information about objects on the network. Used to manage permissions and control access to critical network resources. account with read access to the FileNet file shares and separate Oracle database login and password with READ access to all of the content to be used to replace the [USERID] and [PASSWORD] attributes in your database connection string.
        2.  Enter both logins and both passwords here and separate them a comma (,).
          1. For example:
            • domain\login,oraclelogin
            • domainpass,oraclepass

    2. WorkplaceXT URL: Enter the client FileNet web application URL.

      1. Object Store Database Connection:

        1. Enter a connection string for the current database.

        2. Enter one object store database Connector for each object store.

          MS-SQL Example

          OS:Server=servername;Database=dbName;Integrated Security=true;DBSchemaName=mySchemaName;ObjectStoreName=myObjectStoreName

          Where the values are as follows:

        ParameterDescription
        serverNameHost name, or IP address, of the SQL server.
        dbNameName of the database
        mySchemaNameName of the schema that is used for the specified database
        myObjectStoreName

        • Name of the FileNet object store.

        • This parameter is required to correctly generate an item URL.

        Integrated Security = true

        Target A Target is a "pointer" to a specific instance of a search application, such as Elasticsearch. - (A Search application instance has one or more indexes) used by the SQL server in Windows Authentication mode.

        Note: If the target SQL server uses SQL Server Authentication mode, specify UID=userName;PWD=userPassword instead of Integrated Security = true
        Note: If you enable Advanced Marking Set security, specify the connection string to the GCD database. Use the pipe symbol (|) to separate connection strings.
        Example:

        Copy
        OS:Server=servername;Database=dbName;Integrated
         
        Security=true;DBSchemaName=mySchemaName;ObjectStoreName=myObjectStoreName|GCD:
        Server=GCDservername;Database=GCDdbName;Integrated 
        Security=true;DBSchemaName=GCDmySchemaName;ObjectStoreName=myObjectStoreName


        Oracle Example

        Copy
        OS:Server=SERVERORIP;PORT=1521;SID=samples;User Id=[USERID];Password=[PASSWORD];DBSchemaName=mySchemaName;ObjectStoreName=myObjectStoreName

        Where the values are as follows:

        ParameterDescription
        SERVERORIPHost name, or IP address, of the Oracle server.
        (PORT=)1521

        • Default port of the Oracle server.

        • If you used a different port, specify the port value.

        SIDName of the Oracle database
        [USERID]

        • Placeholder for the name of the user who is connecting.

        • This reserved word will be replaced in the connector internally to the value that is specified in the Logins field.

        [PASSWORD]

        • Placeholder for the password of the user who is connecting.

        • This reserved word will be replaced in the connector internally to the value that is specified in the Logins field.

        MySchemaNameName of the schema used for the specified database.
        MyObjectStoreName

        • Name of the FileNet object store.

        • This parameter is required for proper generation of the item URL.

        For more Connection String information, see ConnectionStrings.com

    3. Disable Security: Select to mark all items as public.
    4. Include Unfiled Items: Select to process items that have no parent containers.

    5. FilePlan Object Store Database Connection (Records Manager):

      • This field acts the same as the Object Store Database Connection, but applies only if you are using Records Manager.

      • If you do not use Records Manager, leave the field blank.

      • For more information, see the descriptions of Object Store Database Connection, and Items Handling.

      Note: Prefix FPOS should be used in connection string in place of prefix OS: (used in the Object Store Database Connection field.)

    6. Crawler/FileNet Share: Enter the shared path to the content folder and the local path using the following format:FileNetPath1=NetworkShareFilePath1;FileNetPath2=NetworkShareFilePath2...
      where FileNetPathN is a storage area real path and NetworkShareFilePathN is a network Shared path to the storage area root folder.

      For example:
         \\nedmsdb-shtq71\x$\FS\MP_PSBG1\FS_PS1=\\nedmsdb-shtq90\MP_PSBG1\FS_PS1;

      • The left side of the equals (=) sign (in bold) is the location specified in the FileNet properties.
      • The right side of equals (=) sign (in italics) is the Windows Share available to the user.
      • To add multiple stores, separate entries with a semicolon (;).
    7. Advanced Example Mapping from POC:
         \\nedmsdb-shtq90\MP_PSBG1\FS_PS1=\\nedmsdb-shtq90\MP_PSBG1\FS_PS1;

         \\nedmsdb-shtq90\MP_PSBG2\FS_PS2=\\nedmsdb-shtq90\MP_PSBG2\FS_PS2;

         \\nedmsdb-shtq90\MP_PSBG3\FS_PS3=\\nedmsdb-shtq90\MP_PSBG3\FS_PS3;

         \\nedmsdb-shtq90\MP_PSBG4\FS_PS4=\\nedmsdb-shtq90\MP_PSBG4\FS_PS4;

         \\nedmsdb-shtq90\MP_PSBG5\FS_PS5=\\nedmsdb-shtq90\MP_PSBG5\FS_PS5;

         \\nedmsdb-shtq95\MP_PSBG6\FS_PS6=\\nedmsdb-shtq95\MP_PSBG6\FS_PS6;

         \\nedmsdb-shtq95\MP_PSBG7\FS_PS7=\\nedmsdb-shtq95\MP_PSBG7\FS_PS7;

         \\nedmsdb-shtq95\MP_PSBG8\FS_PS8=\\nedmsdb-shtq95\MP_PSBG8\FS_PS8;

         \\nedmsdb-shtq95\MP_PSBG9\FS_PS9=\\nedmsdb-shtq95\MP_PSBG9\FS_PS9;

    8. Index Every Version of a Document:
      1. Every time you modify a document, the existing document is saved and a new document is created.
      2. Click this check box to crawl all current and previous versions of files.
      3. If you do not click this check box, only the current version is retrieved.
      4. If you change the status of this check box, you must run a full crawl.
    9. Include Hidden Document Classes:
      1. Hidden documents are documents that users are unable to create on their own.
      2. Only an administrator can create items with hidden classes.
      3. If you click this check box, items with hidden classes are retrieved.
      4. If you leave this check box blank, items with hidden classes are omitted from the crawl.
      5. If you change the status of this check box, you must run a full crawl.

    10. Security Level Processing: Select the way you want to process the security information for items:

      • Basic Single Level security: Process all of the FileNet security models excluding the Marking Set security.
        This option includes:

        • Direct item security: Security assigned directly to an item.
        • Inherited parent security: Security coming from the parent folder.
        • Security Policy: Security assigned by the Security Policy object.
        • Template Proxy security: Security assigned by some property templates assigned to the item class.

      • Advanced Multilevel Security: This is the same functionality as the Basic Single Level Security, with the addition of Marking Set security processing.

        • Note: See the Prerequisites for the Advanced feature.
        Make sure that the enablesidsecurity parameter is set to true and that the additionalsecuritylevels parameter is high enough to match the maximum level of security applied using Marking Sets.

    12. Items Handling: Choose which items to index (only one selection is allowed).

      • All Items: Index all of the available information.
      • Documents with Records: Index only documents that have an assigned record.
      • Documents without Records: Index only the documents that have no assigned records.
      • Records with Documents: Index only the records with parent document(s). A File Plan Object Store connection is required, see the Note below.

      • Records without Documents: Index only the records that do not have a parent document. A File Plan Object Store connection is required: see the Note below.

        Note: Record information can be retrieved only if the File Plan Object Store connection is specified.

  4. Click Save.

Specify Content Filters

Go to the bottom of the Content Info tab and use these steps:

  1. Object Classes: Use the item picker to select the object classes you want to include in this content index:
    1. Include All
    2. Exclude the Following
    3. Include Only the Following
  2. Custom Filters: Use the supported custom filter types as described below
    • ITEMID: Index only the items with the specified ID.
    • Format: ITEMID=id1,id2,id3…id(n ). Separate item IDs using a comma (,).

      Example:
      Copy
      ITEMID=2ed7899a-9d92-416b-85c4-8c2ad0011c3,fd9e4663-4ea5-4086-a4a1-8d545f1031a3,468e5d1f-dbb2-485a-a96b-8e4781d5eab5

    • SQL: Lets you add an additional SQL condition to the base query for increased granularity when filtering the results.

      Format: SQL={some proper sql condition}

      Example:

      Copy
      SQL= AND DOCVERSION.CREATOR LIKE ‘JOHN %’
      SQL= AND DOCVERSION.MODIFY_USER LIKE ‘% SMITH%’
      SQL= AND DOCVERSION.MIME_TYPE=’plain/text’

      Use the DOCVERSION alias to work with items with class Document (and all of its sub classes) and the GENERIC alias to work with items with the class Custom Object (and all of its sub classes)

      For more information about the tables and fields that you can use, go to Database Table Schemas

    • FOLDER: Index items from the specified path.

      Format: FOLDER=/folder1/folder2/, /folder1/folder3/folder4,…/folder(n)/folder(nn)

      Separate paths in the filter using a comma (,).

      There are two modes for the folder filter.

      • Literal path: /Folder1/Folder2/

      Data is retrieved only from the specified path.

      • Path template: Folder1/*

      Data is retrieved from the specified path and all of its sub paths.

      Example:
      FOLDER=/Documents/Technical Notes/,/Reports/Year2013/*

    • ROWLIMIT: Limit returned results.

      Format: ROWLIMIT=N: Because the Connector separately retrieves Document and Custom objects, the result will be N*2. So, ROWLIMIT=10 returns 20 objects where 10 are documents and 10 are custom objects.

      Example: ROWLIMIT=50

    • INCLUDECONTENTBYEXTENSION: The content of items only with the specified file extensions.

      Format: INCLUDECONTENTBYEXTENSION=ext1,ext2,ext3 …

      Example: INCLUDECONTENTBYEXTENSION= txt,doc,docx,jpg

    • SKIPCONTENTBYEXTENSION: Exclude items with specified file extensions. Works the same as previous item.

  3. Save: Click Save.

More Information

For more information about connection strings, see ConnectionStrings.com.