Configure a pull connector

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 2 minutes to read
  • Configure pull connectors that require a script, connector definition, and connector instance to pull events from external devices. These connectors automate the data retrieval process, ensuring the seamless integration of external events into your system for efficient monitoring and management.

    Before you begin

    Role required: evt_mgmt_admin

    Procedure

    1. Navigate to Workspaces > Service Operations Workspace.
    2. From the left pane, select the Integrations Launchpad icon (Integration Launchpad icon)
    3. In the Browse Integrations tab, select the All integrations drop-down list and select Pull.
      Only pull connector tiles are displayed.
      Figure 1. Pull connectors
      Filtering with Pull connectors
    4. Select a pull connector tile.
      If a pop-up menu opens, select the data to track from that connector and select Continue.
      Figure 2. Pull connectors details page
      Pull connectors details page
    5. In the Details tab, in the Connector name field, enter a unique name for the connector type.
    6. Optional: In the Tags field, enter tags to help locate and identify connectors of this type on the Express List.
      To add additional tags, select the plus icon (Plus sign to add more tags.) next to the Tags field. The Add tags window opens.
      1. In the Key field, enter a tag key.
      2. In the Value field, enter a tag value.
      3. Select Add.
    7. Optional: In the Description field, enter brief information about this connector.
    8. Optional: From the Assignment group drop-down list, select the group or team that is responsible for managing and maintaining the connector.
    9. In the Host IP field, enter the IP address that is used to select the appropriate MID Server for communicating with the event source host.
      You can use the host name instead of the host IP.
    10. From the Credentials drop-down list, select the valid credentials to access the event source host.
      To create a new credential, select Create new credentials and continue with the process.
    11. Optional: If you want to customize configurations to meet specific requirements, select Advanced settings and fill in the form.
      Field Description
      Connected MID Server Determine whether you want to have the system choose the optimal MID Server or choose a specific MID Server yourself.

      Perform only if you must make modifications to the MID Server otherwise leave it empty and let the system choose the optimal MID Server.

      Event collection schedule (seconds) Enter the frequency in seconds that indicates how often the system should check for new events from the external event source. The value can’t be lower than the minimum schedule property, which by default is 120 seconds.
      Protocol Defines the communication protocol used for retrieving events from external devices.
      severity_by_state_type Determines the severity level assigned to events based on their state type.
      time_zone Specifies the time zone used for recording and displaying event timestamps.
      offset_min Sets the time offset for event retrieval to ensure accurate synchronization.
      Port Verify the default values for your connector type such as port details or time formats and modify them as necessary. Default values from your connector are filled-in. Specifies the port number used for communication with external devices.
      max_fetch_interval_min Limits the maximum interval between event fetch operations.
      initial_sync_in_days Sets the duration for the initial synchronization process when retrieving historical data.
    12. Optional: Test the connector before activating it by selecting Test and Save.
    13. To save the connector, select Save.
    14. To activate the pull connector, select Activate.
      The pull connector is activated and its tile is displayed in the Installed Integrations tab.

    What to do next

    To confirm the successful configuration of the pull connector and the flow of events into the system, select the Related events tab. If the setup is successful, proceed to Add automation to establish an alert automation. For details on Related events tab, see Review integration and configuration health and for information on alert automation, see Alert automation in Service Operations Workspace for ITOM.