Skip to main content

Creating an Adapter

This walks you through setting up a new connection in the Portal from start to finish.

Before you start​

Check two things first:

  1. The right plugin is installed. Open Plugins in the Portal and verify the plugin for your protocol is listed. If what you need isn't there, contact your administrator.

  2. Any reference files are uploaded. If your connection needs a custom data dictionary or schema file, upload those to Artifacts first. See Artifacts for how.

Step 1: Open the wizard​

In the Portal, go to Adapters and click New Adapter. This opens the setup wizard.

Step 2: Basic settings​

FieldWhat to fill in
NameA descriptive label, e.g. NYSE Equities - Inbound
Redundancy ModeHow many copies run. Choose Active / Passive for production connections. See Adapters Overview for guidance.

New adapters are created in the off state. You'll turn it on at the end once everything is configured.

Step 3: Connection​

Choose the type of connection you're setting up. The available connection types depend on which plugins are installed on your platform.

The form then asks for the settings specific to that connection type. Your external system's connectivity team or your Connamara representative will have the values you need.

For protocol-specific field guides, see the Official Plugins documentation.

Step 4: Pipeline (optional)​

A pipeline defines what happens to each message as it passes through. If you just want to forward messages as-is, you can skip this step.

If you need to filter certain messages, reformat them, or add information before delivery, see Pipeline Designer for how it works.

Step 5: Review and save​

The wizard shows a summary of everything you've configured. Check it over, then click Save.

The adapter is created but not yet running.

Step 6: Turn it on​

  1. Go to Adapters and find your new adapter
  2. Click the adapter's name to open it
  3. Click Enable

The status will move from Inactive to Claiming to Active within a few seconds. Once it shows Active, your connection is live.

If it doesn't reach Active within 30 seconds, check the Event Log tab for an error message. Common issues are covered in Troubleshooting.

Editing an adapter​

To change any settings after creation:

  1. Open the adapter from the Adapters list
  2. Click Edit
  3. Make your changes and save

The adapter will restart to apply the new configuration. For production connections, the platform closes the existing session cleanly before reopening with the new settings.