Search
Clear search
Close search
Google apps
Main menu
true

How to install and deploy the Database connector

All Connectors 4 have a Windows installer download option.

The Installer provides an easy and intuitive way to configure your Connectors 4. Your results will be a configuration file and start up script created in the connector installation directory.

Note: If you want to run the connector as a Windows Service, please review How to use prunsrv to create a service.

To install the connector:

  1. Double-click on database-install-4.1.0.exe.

    Depending on your security settings you may need to start the installation with Administrator privileges.

  2. At the following screen, click Next:
     
  3. On the following screen, you can specify most of the configuration parameters: 


     
  4. Configuration settings
  • GSA Hostname or IP address

    Parameter Details: Hostname or IP address of the GSA

    Configuration file equivalent: gsa.hostname
    Mandatory: Yes
    Default value: N/A
    Example: gsahost.example.com

  • Adaptor port

    Parameter Details: TCP Port to communicate with content server and GSA

    Configuration file equivalent: server.port
    Mandatory: No
    Default value: 6078

  • Dashboard Port

    Parameter Details: TCP Port to connect to the connector's dashboard for administrative purposes 

    Configuration file equivalent: server.dashboardPort
    Mandatory: No
    Default value: 6079

  • Specify JDBC jar file (Database driver)

    Parameter Details: Database driver file to be used by the connector 

    Configuration file equivalent: added to -classpath parameter in run.bat
    Mandatory: Yes
    Default value: N/A
    Example: C:\DB_DRIVERS\mysql-connector-java-5.1.28.jar

  • Full classname of JDBC driver

    Parameter Details: 

    Configuration file equivalent: db.driverClass
    Mandatory: Yes
    Default value: N/A
    Example: com.mysql.jdbc.Driver

  • Database URL (URL to talk to Database)

    Parameter Details: URL to connect to and communicate with the Database

    Configuration file equivalent: db.url
    Mandatory: No
    Default value: N/A
    Example: jdbc:mysql://dbhostname[:port]/testdb

  • Database username

    Parameter Details: username to use to log in to database

    Configuration file equivalent: db.user
    Mandatory: Yes
    Default value: N/A
    Example: dba

  • Database password 

    Parameter Details: password of user being logged to database

    Configuration file equivalent: db.password
    Mandatory: Yes
    Default value: N/A
    Example: password

  • Database Unique Key 

    Parameter Details: Columns sufficient to identify a unique document, along with their types. Valid types are: int, string, timestamp, date, time, long

    Configuration file equivalent: db.uniqueKey
    Mandatory: Yes
    Default value: N/A
    Example: customer_id:int

  • SQL statement that provides all IDs of all documents to be indexed

    Parameter Details: 

    Configuration file equivalent: db.everyDocIdSql
    Mandatory: Yes
    Default value: N/A
    Example: select * from customer

  • SQL statement that provides one document's content

    Parameter Details: Connector will substitute "?" with the ID of Unique Key to get document's content for indexing

    Configuration file equivalent: gsa.singleDocContentSql
    Mandatory: Yes
    Default value: N/A
    Example: select * from customers where customer_id = ?

  • Database mode of operation

    Parameter Details: The mode connector operates

    Configuration file equivalent: db.modeOfOperation
    Mandatory: Yes
    Default value: N/A
    Example: rowToText

  • Database metadata columns

    Parameter Details: identifies columns to treat as metadata, and provides string to use as a key

    Configuration file equivalent: db.metadataColumns
    Mandatory: No
    Default value: N/A
    Example: name:name

  • SQL statement to retrieve recently changed documents, by their timestamp

    Parameter Details: query to retrieve recently changed documents, by their timestamp

    Configuration file equivalent: db.updateSql
    Mandatory: No
    Default value: N/A
    Example: select customer_id, order_placed_time as GSA_TIMESTAMP where order_placed_time > ?

  • Timezone used for timestamps

    Parameter Details: Specific values to be used differ between databases.

    Configuration file equivalent: namedb.updateTimeStampTimezone
    Mandatory: No
    Default value: N/A

  • SQL statement to retrieve users/groups that are permitted or denied access to document

    Parameter Details: 

    Configuration file equivalent: db.aclSql
    Mandatory: No
    Default value: N/A
    Example: select permitted_users as GSA_PERMIT_USERS, denied_users as GSA_DENY_USERS from my_acl_table where customer_id = ?

  • Delimiter on retrieved results of above access control SQL statement

    Parameter Details:  delimiter to separate principals in returned results of access control SQL statement

    Configuration file equivalent: db.aclPrincipalDelimiter
    Mandatory: No
    Default value: ,
    Example: ;

  • Maximum Java Heap size (in megabytes)

    Parameter Details: identifies columns to treat as metadata, and provides string to use as a key

    Configuration file equivalent: added to -Xmx parameter in run.bat
    Mandatory: No
    Default value: 1024
    Example: 1024

  • Start adaptor after installation finishes?

  • Parameter Details: Checkbox

    Configuration file equivalent: N/A
    Default value: Not checked

  1. After finishing the configuration page, specify the directory where the connector will be installed.
  2. Next, you are asked if the connector should create Start Menu shortcuts.
  3. At the end you see the summary page.
  4. Now you can start the connector by double-clicking the run.bat file.

  5. The following files are created in the installation directory after installation is completed:

  6. Filename Description
    adaptor-config.properties Main configuration file
    adaptor-database-4.1.0-withlib.jar Connector's binary file
    docs Directory which contains documentation
    logging.properties Logging configuration file
    logs Directory which contains connector's logs
    run.bat Command file to start the connector
    runwrap.bat Wrapper command file to start run.bat nicely
    _GSA Database Adaptor_installation Installation temporary folder














     

Was this article helpful?
How can we improve it?