The following is a proposed connector user guide template for documenting MuleSoft and 3rd party connectors. When completed, a tech writer will work with the development teams to bring existing and new connector documentation to this standard. Please review and add your comments. Thanks!

Note: Horizontal lines show sections, but won’t be in the actual documents.

Connector Name

The chosen name and one sentence for its description.

Release Notes: Link to Release Notes

Contents:

  1. Introduction

    1. Prerequisites

    2. Requirements

    3. Dependencies

      1. Versions

      2. Consumers

  2. Installing & Configuring

    1. Installing

    2. Configuring

    3. Upgrading from a Previous Version

  3. Using the Connector

    1. Use Cases and Demos

    2. Best Practices

    3. Tips

    4. Integration Patterns

    5. Adding to a Flow

    6. Query Types

    7. Increasing Performance

  4. Example Use Case

    1. Anypoint™ Studio Visual Editor | XML Editor

    2. Example Code

  5. Demo

  6. F.A.Q

  7. See Also

Introduction

Description and concepts. Overview of the system. High level description how the connector is providing the connectivity. SOAP/REST/Proprietary protocol. ? Description of the main concepts of the system. Integration with other MS capabilities

Prerequisites

This document assumes that you are familiar with …
To use this connector, …

Requirements

Hardware, software, and technical requirements.

Dependencies

What MuleSoft software is required to get this connector to work?

Versions

What versions of JAR files and MS software is required ?. What is the version sandbox version during the testing ?

Consumers
What software is required to user this connector?

Compatibility Matrix

What system versions is supported ?. Patches/APIs versions

Installing and Configuring

Installing

How do you install this connector?

Configuring

What do you set on configuration?

Updating From an Older Version

What needs to be configured when updating from a previous version of this connector?
Are there configuration items for previous MuleSoft software for this connector?

Using This Connector

Outbound, inbound, streaming outbound

Use Cases and Demos

List use cases for this connector, including a demo for every use case.

Best Practices

To take full advantage of the functionality …

Tips

  • <Information from Support>

Integration Patterns

_ recognizes these integration patterns for connecting with other systems…

Adding to a Flow

Use a __ Connector in your application → flowchart

Query Types

If talking to a database, what queries are allowed by this connector?

Increasing Performance

What can you set in the connector to increase performance?

Example Use Case

Explain what this example is for.

It should contain a fully functional Mule application as a demo, where the use case is considered. The demo needs to be simple and only considering a single use case.

Anypoint Studio Visual Editor | XML Editor

Explain how to create this case with Anypoint Studio visual editor and XML editor

[tab,title="Studio Visual Editor"]
....
[tab content goes here]
....
[tab,title="XML Editor"]
....
[tab content goes here]
....

Code Example

Number code example lines and explain blocks of lines

F.A.Q

  • Add here all the items you consider useful.

See Also

  • Access full reference documentation for the connector.