Updating connector details

After you have added a connector project, you can update it with the general connector details.

To access general connector settings

Skip this section if you have just created a connector.

  1. Go to https://localhost:3000/ to open BMC Helix Connector Designer.

    Note

    Your browser will show a warning that states that the website is not secure. This is the expected behavior; proceed to opening BMC Helix Connector Designer.

  2. Click Connectors, and then click the name of the intended connector.
  3. Under the General tab, proceed to provide or update values as required:

Connector identity fields

Enter Identity values under the General tab as described below. Identify information will appear in BMC Helix Integration Studio.

FieldDescription
NameThe name of the application or service with which the connector communicates.
(Optional) DescriptionA brief description of the connector. BMC recommends that you enter a description.
VersionThe version number of the connector. The version number is automatically assigned and updated if Auto update is selected.
Default CategoryThe generic category of the connector. Select one of the following categories: 
  • File Management
  • Project Management
  • Service Support
  • Social
  • Mobile
  • Email
  • Back Office
  • Utilities
  • CRM
  • Productivity
  • Developer Tools
  • Collaboration
  • Automation
  • Development
  • Monitoring
  • System
  • Management
  • Test

The default category is Productivity.

Image

The image that will be displayed for your connector in  BMC Helix Integration Studio . Click Browse to browse to and attach a JPEG or PNG file.

(Optional) OrganizationThe name of your organization.
(Optional) Organization Identifier

A short identifier for your organization.

(Optional) Team NameThe name of your team.
(Optional) LicenseLicense information for the connector.

Best practice for naming a connector

The name you choose for your custom connector is similar to the name of the integrated application. 

Example connector name

If you create a connector to integrate with LinkedIn, name the connector LinkedIn.

Connector authorization fields

Enter Authorization values under the General tab as described below. Authorization information you provide will be used to authenticate connector usage.

FieldDescription
Authorization Type
Select one of the following authorization types (provided it is supported by the connector's target application): 
  • NONE—For no authentication
  • BASIC—For basic authentication

    Note: The BASIC authorization type may be used for any type of credentials that take two values. The prompts for the BASIC authorization credentials can be configured.

  • OAUTH1—For OAuth 1.0
  • OAUTH2—For OAuth 2.0

Refer to the application's reference documentation to determine which authorization types are supported. Relevant fields appear depending on your selected value.

Click Add Parameter if you need to add extra parameters as key-value pairs. Added parameters can be removed using the trash can icon at the end of each row.

Service URLThe integration endpoint. Your Service URL value may be auto-populated based on configuration values.

Basic authentication fields

FieldDescription
Connector user IDA valid user name for the application you are integrating with.
Connector passwordThe password associated with the connector user ID.

OAuth 1.0 authentication fields

Note

You must register the connector callback URLs in the intended application. The callback URLs must be in the following format:

  • Production instance: https://integrate.bmc.com:443/auth/connector_lowercase_name/callback
  • Development instance: https://developer.integrate.bmc.com:443/auth/connector_lowercase_name/callback

In both cases, connector_lowercase_name represents the full lowercase name of the connector (spaces must be replaced with underscores).

FieldDescription
Passport Strategy

The OAuth 1.0 passport strategy. The value will default to a generic passport strategy.

Describing each available passport strategy is beyond the scope of this document; however, a link will appear for your selection, which you can open in your browser for more information.

Consumer KeyThe consumer key.
  Consumer SecretThe consumer secret.
(Optional) Request Token URLThe request token URL.
(Optional) Access Token URLThe access token URL.
(Optional) User Authorization URLThe user authorization URL.
(Optional) Signature MethodThe signature method.

OAuth 2.0 authentication fields

Note

You must register the connector callback URLs in the intended application. The callback URLs must be in the following format:

  • Production instance: https://integrate.bmc.com:443/auth/connector_lowercase_name/callback
  • Development instance: https://developer.integrate.bmc.com:443/auth/connector_lowercase_name/callback

In both cases connector_lowercase_name represents the full lowercase name of the connector (spaces must be replaced with underscores).

FieldDescription
Passport Strategy

The OAuth 2.0 passport strategy. The value defaults to a generic passport strategy.

Describing each available passport strategy is beyond the scope of this document; however, a link to more information will appear for your selection.

Client ID
The client ID.
Client SecretThe client secret.
(Optional) Authorization URLThe authorization URL.
(OptionalToken URLThe token URL.

Additional authorization parameters

Certain OAuth implementations may require extra parameters. Use the Add Parameter button in the Extra Parameters section under the General tab to specify extra authorization parameters. Parameters can be passed as header, body, or query key-value pairs. Parameter values might be auto-filled based on configuration values; update them as required. For information about acceptable values, refer to the target application's documentation.

You can remove existing parameters using the trash can icon at the end of each row.

Connector configuration fields

Enter Configuration values under the General tab as described below. Commonly used connection data (such as protocol, host, and port) are populated by default. Update values as required.

FieldDescription
Name

The display name for the configuration field in BMC Helix Integration Studio.

Field NameThe actual field name. Can be the same as Name.
(Optional) DescriptionA brief description of the field.
RequiredIndicates that a value must be explicitly provided by the user. Defaults to selected.
Type

The data type for the field. Supported types are:

  • string
  • password
  • textarea
  • email
  • url
  • address
  • phone
  • number
  • int
  • double
  • percent
  • currency
  • date
  • datetime
  • time
  • boolean
  • picklist
  • lookup
  • string_array

The default type is string.

Additional configuration fields

  • Use the Add Configuration Field button to add more configuration fields. 
  • You can remove existing configuration fields using the trash can icon at the end of each row. 
  • You can remove all configuration fields using the Remove Fields button.

Note

If you set a new configuration field as required, you must update the Service URL value (in the Authorization section) to include it.

API definitions

You can specify an API definition file to generate fields while adding triggers or actions in the later stages of connector development. If you choose not to do so, you will have to manually add input and output fields for actions and triggers.

To specify an API definition file for your connector:   

  1. Locate the intended API definition file on the target application's website or a public API repository, such as ProgrammableWeb

    Note

    The currently supported API definition format is Open API (aka Swagger) JSON.

  2. Save the definition file on your local machine or network.
  3. Browse to the API Definitions section under the General tab in BMC Helix Connector Designer.
  4. Click Choose File to browse to and upload the definition file. 

Where to go from here

Adding connector triggers

Was this page helpful? Yes No Submitting... Thank you

Comments