Adding connector authentication, configuration, and request parameters

To add access authentication information for your connector

1. To open BMC Helix Connector Designer in your browser, navigate to https://localhost:3000/ and log in by using your BMC Helix Integration Service credentials.

   Important

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

2. On the Connectors tab, click the name of the connector to which you want to add the access authentication information.
3. On the Settings tab, select Authorization.
   The authorization information you provide will be used to authenticate connector usage.
4. Select an Authorization Type.
   The connector's target application must support the selected authorization type. For more information about which authorization types are supported, see the application's reference documentation. The following authorization types are available:
   • NONE
   • BASIC
   • OAUTH1

   • OAUTH2
     Additional fields are displayed based on the authentication type you select. 

     Important

     You can use the BASIC authorization type for any type of credentials that take two values. The prompts for the BASIC authorization credentials can be configured.

5. Enter the values for the selected authentication type.

   • BASIC authentication fields 

     Field	Description
     Connector user ID	A valid username for the application you are integrating with.
     Connector password	The password associated with the connector user ID.

   • OAuth 1.0 authentication fields

     Important

     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).

     Field	Description
     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 Key	The consumer key.
     Consumer Secret	The consumer secret.
     (Optional) Request Token URL	The request token URL.
     (Optional) Access Token URL	The access token URL.
     (Optional) User Authorization URL	The user authorization URL.
     (Optional) Signature Method	The signature method.

   • OAuth 2.0 authentication fields

     Field	Description
     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 Secret	The client secret.
     (Optional) Authorization URL	The authorization URL.
     (Optional) Token URL	The token URL.
     (Optional) Profile URL	The profile URL of the client. Use this option if you want to fetch the user profile information while creating a connector configuration (adding account).

6. (Optional) To specify additional authorization parameters, click. 
7. (Optional) To remove any additional parameter that you added, click for the parameter value.
8. (Optional) To add request parameters as key-value pairs, select .
   Parameters can be passed as header, body, or query key-value pairs. Parameter values might be auto filled based on configuration values; you can update them as required.
   For information about acceptable values, see the target application's documentation. 
9. (Optional) To remove any request parameters that you added, select the parameters from the list, and click .

To add connector configuration fields

1. To open BMC Helix Connector Designer in your browser, navigate to https://localhost:3000/ and log in by using your BMC Helix Integration Service credentials.

   Important

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

2. On the Settings tab, select Configuration.
   By default, the URL configuration field is configured. Commonly used connection data (such as protocol, host, and port) are populated by default. Update values as required.

3. To add configuration fields, click . 
   When configuring the connector in BMC Helix Integration Studio, the additional fields are displayed on the Configuration tab of the connector.

   Important

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

4. Enter the following values for the configuration field:

   Field	Description
   Name	The display name for the configuration field in BMC Helix Integration Studio.
   Field Name	The actual field name. Can be the same as Name.
   (Optional) Description	A brief description of the field.
   Required	Indicates that a value must be explicitly provided by the user. By default, this option is selected.
   Type	The data type for the field. Supported types are: string (default) password textarea email url address phone number int double percent currency date datetime time boolean picklist lookup string_array

5. (Optional) To remove any configuration fields that you added, select the parameters from the list, and click .

Where to go from here

Building-connectors