SBM Plugin Configuration Details

The default SBM plugin provides functionality for SBM requests and executions, where the requests that are associated and deployment tasks that are submitted or transitioned are items in SBM projects.

The provider types are used as follows:

The SBM Request provider type is used when adding requests and it allows you to link requests to your SBM item.
The SBM Execution Provider type is used when creating deployment tasks or task templates. You can choose whether to create a new SBM item or to transition an existing SBM item.

Before you can use the SBM plugin, administrators must do the following:

Add one or more configurations of the plugin. See Adding or Updating Configurations and the example SBM plugin configuration described in the following table.
Configure custom column fields to display appropriate data for SBM requests. See Fields for SBM.

Example SBM Plugin Configuration

The fields for an example SBM plugin configuration are described in the following table. The values shown here are examples for use with the default Manual Deployment Task and Sample Request process apps.

Note: A example configuration for the SBM sample IDM (Issue Defect Management) application is also included in the default installation.

Field	Description	Example Values
Name	A unique name for the plugin configuration	Release Control Sample Applications
Description	A description of the plugin configuration that distinguishes it from other configurations in the list	Release Control Sample Applications Configuration - Requires Manual Deployment Tasks and Sample Request process Apps
SBM Web Services	URL for the SBM application web services	http://<serverName>:80/gsoap/gsoap_ssl.dll?sbmappservices72
Use Single Sign-On (SSO)	Enable single sign-on to allow the provider service to log in to the SBM system using the authentication token of the user. Note that if you are logging into a separate SBM system that doesn't share the same SSO server, you will receive the following message "An error occurred while getting collection details" when trying to find an item on the other system.	true
User Name	If single sign-on is not enabled for this server, use this user name to log in to this system.
Password	If single sign-on is not enabled for this server, use this password to log in to this system.
Open in workcenter		true
Execution Properties	Used when adding deployment tasks or task templates
Execution - Provider Name	A descriptive name of the execution provider	RLC - Manual Deployment Task
Execution - Provider Description	Description of the provider, which appears as a tooltip in Edit Deployment Tasks when users are adding a deployment task	Release Control Manual Deployment Task Process App
Execution - SBM Table (DBNAME)	The database table name of the SBM table that you want to submit or transition execution items	TRM_RLM_DEPLOY_TASKS
Execution - Extended Fields	A comma-separated list of fields to populate with data when submitting or transitioning items. The values are the database names for the fields. See Using Extended Fields to Select and Format Data.	RLM_TASK_OWNER
Execution - queryWhereClause	A SQL query where clause that is used to search fields to return the list of possible requests to relate. Refer to the SBM documentation about the `GetItemsByQuery` call for more information on the `queryWhereClause`.	TS_PROJECTID=@{PROJECTID} AND (TS_TITLE LIKE '%@{SEARCHTERMS}%' OR TS_DESCRIPTION LIKE '%@{SEARCHTERMS}%')
Execution - orderByClause	A SQL statement to order the results of the query. Use this statement to place newest items first in the list or to divide them up based on projects. Refer to the SBM documentation about the `GetItemsByQuery` call for more information on the `orderByClause`.	TS_SUBMITDATE ASC
Execution - Transitions	A comma-separated list of transitions that will be available if you choose the "Transition Item" action	UPDATE, RETRY, COMPLETE
Execution - Wait for Callback	Whether to wait for the system to respond with results Important: You should not set this to false for the process apps that are using callbacks, such as the default Manual Deployment Task process app. If you do, manual deployment task items cannot be transferred through the workflow. Conversely, you should not set this to true for the process apps that are not using callbacks, such as the default IDM process app. If you are using any external SBM systems for your providers, see Configuring for Callback from External Systems.	true
Execution - Execution ID database field name	If you plan to submit or transition items in an SBM system external to the SBM on which Release Control is running, specify the execution ID database field name for that system. Note: This field is specific to the default Manual Deployment Task process app for Release Control version 6.0.1 or above. If you are using the Manual Deployment Task process app but aren't upgrading it, you should leave this field empty. If you are using a custom process app, you can add logic to populate this field.	RLM_TASK_EXECUTION_ID
Execution - Update transition name	If you plan to update items in an SBM system external to the SBM on which Release Control is running, specify the update transition name for that system. See the note for the previous field, which also applies to this field.	UPDATE
Request Properties	Used when adding requests
Request - Provider Name	A descriptive name of the request provider	RLC - Sample Request
Request - Provider Description	Description of the provider, which appears as a tooltip in Edit Requests when users are adding a request	Release Control Sample Request Process App
Request - SBM Table (DBNAME)	The database table name of the SBM table that you want to search for requests to relate	TRM_RLM_BUSINESS_REQ
Request - Extended Fields	A comma-separated list of fields that will appear when the user chooses to view the items from the report using the eye icon. See Using Extended Fields to Select and Format Data.	RLM_PROJECT, RLM_PROJECT_OWNER
Request - queryWhereClause	A SQL query where clause that is used to search fields to return the list of possible requests to relate. Refer to the SBM documentation about the `GetItemsByQuery` call for more information on the `queryWhereClause`.	TS_PROJECTID=@{PROJECTID} AND (TS_TITLE LIKE '%@{SEARCHTERMS}%' OR TS_DESCRIPTION LIKE '%@{SEARCHTERMS}%')
Request - orderByClause	A SQL statement to order the results of the query. Use to the statement to place newest items first in the list or to divide them up based on projects. Refer to the SBM documentation about the `GetItemsByQuery` call for more information on the `orderByClause`.	TS_SUBMITDATE ASC
Provider Types
Execution	Provides functionality for executing deployment tasks	Enabled
Deployment Unit	Provides functionality for linking deployment units	Not Supported
Request	Provides functionality for associating requests	Enabled
Configuration Information
Configuration ID	Unique identifier of this configuration within the database instance. Read only.
Configuration UUID	Unique global identifier of this configuration. Read only.