Connectors Integration

The publications feature gives you the option to publish output to Syndicate (i.e., MadCap's Enterprise Content Delivery Platform) or to a remote server via SFTP. A connector is the most important concept in the publishing process, because without it you cannot connect to an external location. A new connector basically requires credentials to access the outside server you are connecting to, such as login, authentication, and connector URL (host name). See Publications.

Permission Required?

For this activity, you must have the following permission to control and allow access to external servers:

A user with Administrator rights is expected to have the Manage Integrations permission to integrate a connector with a Flare Online license.

For this activity, you must have the following permission:

Users associated with a project only need the Publish Builds permission for publishing output.

For more information about permissions, see Setting User Permissions or Setting Team Permissions.

Connector Set Up

For Flare Online to push data to other systems, there are some considerations in order to establish outside connections. Your organization's administrator can help you with this set up. See Before You Start Publications.

Syndicate

You need to have Syndicate (which includes Elevate) with a Platform Login that gives you access to both applications.

A user (i.e., API user or standard user) needs to be part of the "Syndicate" role. Then in Elevate, the appropriate permissions need to be given for users to access Syndicate groups and folders, and to generate the Client ID and API key that is needed for the publications feature. Note that a standard user with Administrator privileges can generate API keys in the user profile settings in Elevate.

The URLs and credentials generated are all necessary to enter into the Flare Online connector for Syndicate authentication.

Note Syndicate and Elevate are part of the MadCap Software family of products. This documentation assumes you have a Syndicate account and a working knowledge of the portal. For more information refer to Syndicate documentation.

SFTP

Your administrator can provide you with details pertaining to the remote server or the computer where you want to publish output.

How to Create a Connector

When you create a connecter at the license level, you are setting up a connection where all users on your license can use it. See Creating Connectors.

  1. In the upper-right of Flare Online, click your license avatar (or the first letter of your license if you haven't yet chosen an avatar image) and select License Settings.

  2. On the left, select Integrations.

  3. Select the Connectors tab (if it does not have focus).

  4. Click New Connector.

  5. From Type, select Syndicate or SFTP. Depending on the connector type, the fields you see vary.

    Syndicate

    1. In the Settings area, do the following:

      1. Name Enter a name for the connector. It can be anything.

      2. Elevate URL Enter the Elevate URL (e.g., studio-[customer].xyleme.com)

      3. Syndicate URL Enter the Syndicate URL host name (e.g., https://core-[customer].bravais.com)

        Note It is the Delivery (CORe) API that is used to publish content to Syndicate. The base URL for the API call is https://core-[domain].bravais.com, where [domain] is the user's domain name. CORe stands for Core Object Repository, and bravais is the legacy name for Syndicate.

    2. In the Authentication area, enter the following:

      1. Client ID Enter the Elevate-generated Client ID.

      2. API Key Enter the Elevate-generated API Key.

    SFTP

    1. In the Settings area, enter the following:

      1. Name Enter a name for the connector. It can be anything.

      2. URL Enter the host name of the remote server or the computer where you want to publish the output files.

    2. In the Validation area, from Type select:

      • None Select this if there is no validation of the SFTP server.

      • Public Key Select this to validate the server against a public key.

    3. In the Authentication area, from Type select:

      • Password Select this if the server connection is authenticated by the user name and password.

      • Private Key Select this if the server connection is validated against a public or private key pair match. You need to supply the private key and password for the server.

  6. Click Save.