Install and Configure SOI Sample Connector

Document ID : KB000093192
Last Modified Date : 03/05/2018
Show Technical Document Details
Introduction:
The Sample connector uses test data and a mock domain manager to simulate data retrieval. The connector interacts with the IFW and the CA Catalyst Synchronizer components. You can install the connector to integrate sample data into CA SOI, test CA SOI functionality, and illustrate how a connector operates.
Background:

The Sample connector is a fully functional connector that creates sample CIs, alerts, and relationships in CA SOI to demonstrate and test connector functionality. The Sample connector uses a mock domain manager based on sample data files, which you can easily manipulate to change the connector's behavior. It also provides the materials to build a custom Level 4, 5, or 6 connector, including Java code, connector policy, configuration, installer kit, and test data.

Running the Sample connector or using the Sample connector to create a connector helps you understand how a custom connector works and how the methods and policy are defined.

Environment:
SOI 3.x, 4.x
Instructions:
Install the Sample connector on any supported operating system using the installer provided with CA SOI. The connector must be able to connect to an SA Manager system, but does not have to be on the same system as the SA Manager.

Follow these steps:
  1. Run the Connector_Sample.exe file at the root of the CA SOI installation image and click Next.
  2. Accept the license agreement, then accept the third-party license agreements, and click Next.
    The Choose Install Folder screen opens.
    Note: This page does not open if CA SOI components already reside on the system.
  3. Accept, enter, or choose the installation folder.
    Note: The maximum installation path length is 150 characters. The installer blocks paths with more than 150 characters.
    If you are not installing on the SA Manager server, the Integration Services Configuration page opens; otherwise, skip to Step 5.
  4. Specify the required information to connect to the appropriate SA Manager and configure connector preferences.
    Note: Refer to your Installation Worksheet in the SA Manager section for these values.
  5. Select whether to start the CA SOI services after installation and click Next.
  6. Click Install.
    The connector installs on the system and integrates with the appropriate CA SOI instance. An installation summary page opens when the installation finishes.
  7. (Optional) Review the installation log file (Sample_Install_releasenumber) that is in the <SOI_HOME>\log folder to check for installation errors.

Enable the Sample Connector

When you install the Sample connector, it is disabled by default. Enable the connector in its connector configuration file to run the connector in CA SOI.

Follow these steps:

  1. Open the sampleConnector_connectorserver.xml file located at <SOI_HOME>\resources\Configurations on the connector system.
  2. Set the State attribute in the element '<Silo>' to "Enabled".
  3. Save and close the file.
  4. Restart the CA SAM Integration Services service.
Check the below Documentation reference on detailed steps on how to configure the Connector

https://docops.ca.com/ca-service-operations-insight/4-2/en/connectors/connector-development/sample-connector#SampleConnector-InstalltheSampleConnector

 
Additional Information:
Click the link below to view a video on how to install and configure a sample connector

https://www.youtube.com/watch?v=FHudJZ_81yc&index=12&list=PLynEdQRJawmyMiyiQOvtT1pBQuc_3oCZz