This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Connector framework service

The Connector Framework Service (CFS) allows secure indexing of documents from IDOL to the Vertica Analytic Database.

The Connector Framework Service (CFS) allows secure indexing of documents from IDOL to the Vertica Analytic Database. Access control lists determine which users have permissions to access documents. Documents transferred from IDOL are stored in a flex table (Flex tables).

CFS components

Use the following CFS components to implement the service on the Vertica:

  • IDOL document metadata

  • CFS Configuration file

For detailed information, see Implementing CFS.

IDOL document metadata

Vertica Analytic Database stores IDOL document metadata in a flex table. Set the name of the flex table with the TableName parameter in the CFS configuration file (see Implementing CFS). The metadata includes the following:

  • AUTONOMYMETADATA (Mandatory): An alphanumeric designation for the ACL designated for the document.

  • DREFIELD: Assigns permission levels to users and groups for accessing IDOL documents.

  • DRETITLE: The document title.

CFS configuration file

You must index IDOL metadata in Vertica Analytic Database to be available for queries. See Implementing CFS.

1 - Implementing CFS

After Vertica ingests documents from IDOL into flex tables, you can implement CFS to secure those documents.

After Vertica ingests documents from IDOL into flex tables, you can implement CFS to secure those documents. Implementing the security requires that the Vertica database administrator modify the CFS configuration file.

Modify the CFS configuration file

The database administrator must modify the following in the CFS configuration file to have CFS automatically index the metadata:

  1. In the [Indexing] section, set the IndexerSections parameter to vertica:

    [Indexing]
    IndexerSections=vertica
    IndexBathSize=1
    IndexTimeInterval=30
    
  2. Create a new section with the same name you entered in the IndexerSections parameter and enter the following parameters and keywords:

    [vertica]
    IndexerType=Library
    ConnectionString=Driver=Vertica;Server=123.456.478.900;Databaswe=myDb;UID=dbadmin;PWD=password
    TableName=myFlexTable
    LibraryDirectory= ./shared_library_indexers
    LibraryName=VerticaIndexer
    

The VerticaIndexer (LibraryName above) is part of CFS. To use this tool, you must install and configure the Vertica ODBC drivers on the same machine as CFS. CFS sends JSON-formatted data to the Flex table using ODBC.

For more information, see Installing ODBC drivers on Linux.

Query the IDOL data

To query the IDOL data in a flex table, run a simple SELECT query. In this example, idol_table is the name of the flex table:

=> SELECT * FROM idol_table;