Wikis - Page

Creating New Connectors for Micro Focus Connect

0 Likes

Ok…  so, you need to sync data and there isn't a pre-existing connector for the tool you need to integrate with.  Good news!  MF Connect is an extensible platform where you can create your own custom connectors.  If your endpoint tooling has an API / SDK / REST layer, you can create a connector for it!

The easiest way to get started with creating a new connector is to model an already functional existing connector...  And since all of our connectors posted to the Micro Focus Marketplace include the source code, you’ve got plenty to choose from.  If you are creating a connector to sync agile data, we suggest you review and model our recently updated Azure DevOps connector.  It’s a perfect reference implementation for how to sync agile items.

Once you are into the details, you can find more support via our MF Connect API Javadoc (see attached).  The Javadoc (in addition to being the API doc) also includes helpful general information like:

Writing a Connector

A connector provides functionality in four ways.

  • To acquire connectivity details (datasource), like the product host machine, user credentials
  • To acquire configuration setting details (methods that return lists of Projects, properties of a Type, lists of users)
  • To acquire information on the set of items (methods that return lists of items, identify general changes, notifications of process)
  • To acquire and modify specific items (methods that get property values, methods that set and update properties)

Considerations before writing code:

  • How does your product authenticate programmatically?
  • What information is needed to connect to the product? Does it need a host, does it need other properties?
  • How does your product collect data like users and projects and fields in a type?
  • What types do you want users to have access to?
  • How does your product detect changes and deletes?
  • How does your product relate types to each other?

Assuming you have a good understanding or can identify how to implement these areas, you should be able to implement a connector.  If you are writing a non-SCM based connector see the non-SCM package for implementation details.

Be sure to let us know about your connector progress via the MF Connect page on our public community.  Happy connecting!

Comment List
Related
Recommended