ModifyConnectorInstanceXml - googlegsa/manager.v3 GitHub Wiki
A Connector's connectorInstance.xml
configuration file contains
advanced implementation-specific configuration, as well
as Spring Framework bean configuration for a Connector
deployment.
Currently, a Connector's connectorInstance.xml
configuration file
is not directly modifiable using the Search Appliance Admin Console.
When a connector's configuration is stored in files within the web
application filesystem, manual modifications to these files could
easily be done using any plain text editor.
However, when a connector's configuration is stored in a JDBC
database, modifying that configuration manually becomes non-trivial.
This page discusses the steps needed to export a connector's configuration from the database, manually edit it, then re-import the modified configuration into the database.
Doing so requires direct access to the computer hosting a Google Connector Manager for the deployed Connector, with sufficient rights to modify files in the Connector Manager Tomcat web application directory.
These example makes the following assumptions:
- The name of the connector deployment is
MyGoogleConnector
, the name of the connector instance ismyconnector
, and that connector is of typeSomeConnectorType
.
- The default
JdbcPersistentStore
is used to store connector configuration data. If you are using a customized external database configuration inapplicationContext.xml
, for instanceMyCompanyOraclePersistentStore
, then use that specific PersistentStore in the following instructions. If you are unsure of the available PersistentStore configurations, run MigrateStore in interactive mode for assistance.
- Disable traversal for the connector:
In the GSA Amin UI, go to Connector Administration > Connectors, click the Edit link for the desired connector, check the Disable Traversal check box, then click the Save Configuration button.
- On the computer that contains the connector deployment, launch a command shell, then change directory to the
Scripts
directory within the connector deployment:$ cd /path/to/MyGoogleConnector/Scripts
- Export the connector's configuration to the local file system using the MigrateStore command:
$ ./Manager MigrateStore --force -connector myconnector JdbcPersistentStore FilePersistentStore
- Change directory to the connector's exported configuration:
$ cd ../Tomcat/webapps/connector-manager/WEB-INF/connectors/SomeConnectorType/myconnector
- Edit
connectorInstance.xml
with a plain text editor. This file must remain a plain text UTF-8 encoded file. Do not use a word processor that will convert the file to some proprietary word processing format. Save the file.
- Import the connector's modified configuration to the database using the MigrateStore command:
$ ./Manager MigrateStore --force -connector myconnector FilePersistentStore JdbcPersistentStore
- Reset the index for that connector on the GSA (Optional). Most changes to advanced connector configuration in
connectorInstance.xml
will require re-indexing all content for that connector. If you know this is not necessary, you may skip this step. If you are unsure, you should reset the index:
In the GSA Amin UI, go to Connector Administration > Connectors and click the Reset link for the target connector.
- Re-enable traversal for the connector:
In the GSA Amin UI, go to Connector Administration > Connectors, click the Edit link for the desired connector, check the Disable Traversal uncheck box, then click the Save Configuration button.
Since Connector Manager v3.0