Integrate External Tools

Use

The External Tool Integration connects external development management tools like Jira or Microsoft Team
Foundation Server. There is a new IMG node needed in order to configure the corresponding API.

In this IMG activity you configure the external tool integration API in order to connect an external development
management tool in context of Focused Build for SAP Solution Manager.

The API consists of two parts:

 The outbound channel, which is calling an OData web service of the external tool in order to create
and update work packages/items in the external tool.

 The inbound channel, which is a web service, called by the external tool in order to update the status
of an existing work package/item.

In Focused Build the outbound channel is triggered automatically via Change Request Management
Framework actions. The action name is S1_CALL_EXT.

Requirements

The Focused Build requirement to deploy process needs to be configured and you need to have a project of
type /SALM/SINGLE, /SALM/BUILD or /SALM/COMPLETE.

Default Settings

Project Mapping
In the project mapping you define for which projects the external tool integration API can be used and you
define the communication details to the external tool.

Destination

The destination is a RFC destination of type G (HTTP connection to external server) which needs to be
maintained in transaction SM59. In this destination you define in the Technical Settings tab the host and port of
the external tool. In the Logon & Security tab you have to activate SSL and provide basic authentication
credentials.

URI for creation

This is the URI of the external tool which is called by the API for creating a new work package/item.

E.g.: /plugins/servlet/IssueService.svc/Issues

Create Request Method

This is the HTTP request method used by the API for creating a new work package/item.

E.g.: POST
URI for update

This is the URI of the external tool which is called by the API for updating an already existing work
package/item.

E.g.: /plugins/servlet/IssueService.svc/Issues('#EXTERNAL_ID#')

The object ID of the work package/item in the external tool is stored on Solution Manager side as
EXTERNAL_ID. By masking the EXTERNAL_ID with # characters you can add the EXTERNAL_ID to the URI
(see example above).

Update Request Method

This is the HTTP request method used by the API for updating an already existing work package/item.

E.g.: PUT

Jump in URL

This is the jump in URI to the mapped project in the external tool.

E.g.: /browse/ABC

Process Types
In the process types you define for which business transaction types the external tool integration will be used.
E.g.:

S1IT (Work Package)

S1CG (General Change = Work Item)

S1MJ (Normal Change = Work Item)

Jump in URL

This is the URI which is used for generating the jump in URL to a work package/item in the external tool. The
host, port and protocol for generating the URL is taken out of the RFC destination configured in the project
mapping section.

E.g.: /browse/#EXTERNAL_ID#

Like in the project mapping section the EXTERNAL_ID can be added to the URI by masking it with #
characters.

Partner Function

Only the business partner with the here defined partner function is used to check if a process type (work
package and work item) will be send to the external tool.

E.g.: /SALM/09 (Dev Team)

For the business partner used in this partner function the Identification Number is checked. Only in case the ID
Type S1EXTI is set with the Identification Number X the outbound channel of the API will be triggered.

Inbound Status Mapping

In the inbound status mapping you define the status mapping used when the external tool calls Solution
Manager to update the status of a work package/item.

External Status

This is a string send by the external tool.

Internal Status

This is the internal status the work package/item should change to.

Outbound Field Mapping

In the outbound field mapping you define which attributes of the work package/item are send to the external
tool. You can either take the attribute value from the work package/item or overwrite it with a fixed value.

Attribute

The here defined attribute will be part of the JSON send to the OData web service of the external tool.

Rule

The Copy Value rule will send the attribute value of the work package/item to the external tool.

The Set Specific Value rule will send the fixed attribute value as it is defined here in the customizing.

Attribute Value

This is the fixed attribute value which is send in case the Set Specific Value rule is set.

Outbound Partner Mapping

In the outbound partner mapping you define which business partner information is send to the external tool
based on the partner function

Function

This is the partner function used to identify the business partner. E.g.:

/SALM/01 (Business Process Expert)

/SALM/03 (Work Package Owner)

/SALM/04 (Project Manager)

Outbound Text Mapping
In the outbound text mapping you define which texts of the work package/item is send to the external tool.

ID

The text of the work package/item with this Text ID is send to the external tool. E.g.:

S115 (requirement description; for work package)

CD99 (overview; for work item)

Outbound Appointment Mapping

In the outbound appointment mapping you define which appointments of the work package/item are send to the
external tool.

Date Type

The appointment with this date type is send to the external tool. E.g.:

S1_BUILD_FIN (Build Complete)

Activities

To simplify configuration the template project customizing JIRA_TEMPLATE is delivered. In case of Focused
Build for MaxAttention projects where Jira@DBS is used this template can be copied and only minor adaptions
are required. For the integration of other external tools the customizing needs to be adapted to the needs of
this external tool.

For the use with Jira@DBS proceed as follows:

 In the top level node Project Mapping select the JIRA_TEMPATE entry and press the Copy As button

 In the Number field select via the F4 help the project name for which you want to enable the external
tool integration.

 In the Destination field select via the F4 help the destination to the Jira@DBS system (the destination
needs to be maintained beforehand in SM59)

 Adapt the Jump in URL to match the corresponding project ID in the Jira@DBS system
(/browse/<project ID in Jira@DBS>).

 Press and in the pop-up the Copy All button.

 Press the Save button to store the new entries.