Running The Fast Connector Integration Framework Wizard

The TIBCO Scribe® Integration Framework Wizard configures the basic settings for a Connector project in Visual Studio. You cannot run the Wizard until you have downloaded and installed the Integration Framework extension for Visual Studio. If you have not installed the extension, see Installing Extensions.

  1. Open Microsoft Visual Studio.
  2. Select File > New Project.
  3. In the tree on the left select Templates > Visual C#.
  4. Select the FCF — Integration Framework.
  5. Make sure to leave the .NET Framework field at the default setting that was preconfigured for the project.
  6. Click in the Name field and rename the project.

  7. Click OK. The TIBCO Scribe® Fast Connector Framework Wizard dialog displays.
  8. The General section, contains the information required to register the Connector with the Agent. Do not modify the Connector Type ID field. This is a key that uniquely identifies this Connector and any TIBCO Scribe® connections configured for the Connector. It is also used for encryption.
  9. Click the Connector Description field and enter a description of the Connector.
  10. The remaining fields in the General section are used to generate the namespace for this project and the Connector Name that displays in TIBCO Scribe®. With that in mind, provide the appropriate text for Connector Name, Company Name, and Application Name.

    Maximum display length for the Connector Name is 25 characters.

  11. In the Data section of the Wizard, select the data format or structure you plan to use. Options include: JSON, XML, or Custom. These options control how data is serialized and provide defaults on the calls when the project is built.
  12. Refer to the API documentation for the entities you intend to use. Enter the Entity Name, for each one.
  13. For each entity, enter the Relative Path for that entity. Do not include the Base URL. The user is asked for Base URL on the Connection form and it is prepended to the API calls as needed. To determine the relative path, use following example. If you were connecting to the TIBCO Scribe® API and you wanted to get a list of Solutions, the API Endpoint is:

    /v1/orgs/{orgId}/solutions

    From that you can derive the following: 

    • Entity = solutions
    • Base URL = /v1/orgs/{orgId}
    • relative path = /solutions
  14. Configure the necessary operations for each entity.
    1. To enable the Query operation, mark that field with a check mark.
    2. To enable Create and/or Update, select either PUT or POST from the drop-down. Refer to the API documentation to determine whether Create and Update operations should use PUT or POST. If you do not plan to use Create or Update operations, select None from the drop-down.
  15. In the Authentication section, select the type of Authentication required by the API to which you are connecting. Options include: Basic, OAuth Token, URL, or Custom.

    For all Authentication types, User name and Password fields are assumed to be required and are included in the code generated by the Wizard. Do not add User name and Password to the Additional Connection Properties table.

    Use type URL to place an authentication value onto the BaseUrl.

  16. In the Additional Connection Properties section, enter any additional fields required to configure a connection to the selected API. BaseUrl is already displayed and is required. Field names cannot contain any spaces.
  17. Enable the Mask Input field for any Connection Property where user input should be hidden.
  18. Click Build Project. The Fast Connector Framework Wizard uses the information provided to build the base Connector project. When the project opens the project's .cs file displays with the code created by the Fast Connector Messaging Framework Wizard. See Integration Framework Wizard Results.

See Also

Fast Connector Framework (FCF)

Integration Framework Wizard Results