Siebel Innovation Pack 2017: Setting up the Third-Party Systems

Setting up the Third-Party Systems

You can use the Systems page to register and set up the third-party systems that integrate with the SAM application.

Examples of the issue tracking systems that integrate with the SAM application are Bugzilla, Jira, or Review Board.

Examples of the Software Configuration Management (SCM) systems are ClearCase, SVN, and Siebel Workspace.

Table 9. The following table describes the fields in the Systems page.
Field/Column	Description
Add (plus) button	Click this button to add new system.
System Type column	This column lists the type of the third-party system. Two system types are available: Issue Tracking and SCM (Software Configuration Management).
System column	This column lists the name of the integrated system and this is a user-entered display name.
Read/Update column	Use the button in this column to display the Read/Update Method dialog box. Issue Tracking Systems: When users enter an issue tracking system's unique identifier on the Create Approval Request page, the SAM application invokes the REST API whose URL is defined here to pull information from the associated issue tracking system and populate the fields on the page. SCM Systems: When the user enters an SCM location (such as a ClearCase branch or Workspace name) and clicks the Validate button, the SAM application invokes the REST API whose URL is defined here to confirm that the given location is valid. SAM will prompt for the user to enter a value for the source field on the Approval Request page. That source value will be stored along with the approval request and can be used to deliver the changes once the request is fully approved. SAM can prompt for additional fields if they are required for validation but they will not be stored. Examples: Simple single parameter scenario: http://hostname:<portnumber>/workspace/wsname/{source}> The element {source} is available in the Field drop-down list to select and add. The source captures the workspace name when an SCM is added for delivery during the Create Request process. This source is stored for future delivery. Two parameter scenario: http://hostname:<portnumber>/github/repo/{repository}/pbname/{source} This example uses two different parameters that are required for validation and both are prompted for on the Approval Request page. Again, the additional {repository} parameter is not stored for future use and is not available as an item in the Field drop-down list so it must be entered into the URL manually.
Write/Delivery column	Use the button in this column to display the Write/Delivery Method dialog box. Issue Tracking Systems: After an action is taken on a request, the SAM application can invoke the REST API whose URL is defined here to update the issue tracking system. For example, if a request is approved, the SAM application can add a comment and update the status of the record of the issue tracking system record. SCM Systems: After an action is taken on a request, the SAM application can invoke the REST API whose URL is defined here to deliver the changes defined in the SCM location(s). For more information on how to invoke these REST API calls in the Updates table, refer to Setting Up Approval Profile Actions in the SAM Workflow. NOTE: This feature for SCM systems is only supported in 2.17.10 and onwards.
Drilldown URL column	Use the button in this column to display the Drilldown URL dialog box where you can add or modify the URL that the SAM application uses to drill down to the tracking systems. NOTE: This is only for Issue Tracking systems. This is an example of the Drilldown URL for issue tracking system: http://hostname:<port number>/bugzilla/show_bug.cgi?id={ISSUE_ID}. This example points to the URL of Bugzilla. When users click the Drilldown URL button next to the bug ID on the Create Approval Request page, the SAM application opens the bug in Bugzilla.
Fields column	Use the button in this column to display the Config Fields dialog box where you can configure this system's fields that are available to use throughout SAM. To load the list of fields, enter the URL for the system's field JSON file and click the Get Fields JSON button. For more information regarding the field JSON format, refer to the section Importing System Fields. The following properties can be configured for each field: Name - The internal name of the field (this property should not be edited). Label - The label of the field that is displayed within SAM. Active - When selected, this field is available to be selected throughout SAM when selecting fields for the system. Default Status - Selecting this identifies this field as the status field for this system. This is only used for Issue Tracking systems. Key Field - Selecting this identifies this field as the unique identifier field for this system. This is only used for Issue Tracking systems. List Order - The order that that this field is displayed in any field lists in SAM. Issue Tracking systems: These are the issue tracking system fields that are available within SAM to be displayed on the Approval Request page and updated when an approval status changes. SCM systems: These are the fields that SAM can pass to the SCM system's Write/Delivery REST API when an approval status changes (for example, delivering workspace changes when a request is approved). When data is sent to these REST APIs, each field is mapped in the Workflow>Actions>Update section for that profile and is sent with dynamic data bound with the help of Messages. For more information, see Table 18. NOTE: This feature for SCM systems is only supported in 2.17.10 and onwards.
Delete button	Click the Delete button to delete the corresponding system type from the SAM application.

To set up an Issue Tracking third-party system

From the SAM Home page, select the Main Menu button.

Select the Administration option.

Select the Systems option from the Administration drop-down list.

The Systems page appears.

Click the Add button in the Systems page.

Select Issue Tracking from the System Type drop-down list.

Two system types are available: Issue Tracking and SCM.

Enter the name of the third-party system into the System field.

Tab out of the System field.

Add the REST API URL that the SAM application will use to read the data from the tracking system.

Suppose that in the Administration\Fields page, you have set the default label of the ISSUE_ID field to Bug # and plan to store the Bugzilla Bug Number value in that field. For the Read/Update REST API to work properly, you will need to pass the Bug ID into the URL.

Locate the tracking system that you just added and click its corresponding Read/Update button.
The Read/Update Method dialog box appears.
Enter the hardcoded portion of the URL.
For example, http://hostname:<port number>/bugzillarest/bugs/.
Place the cursor where you want to insert the Bug Number field value.
In this case, that is at the very end of the string.
From the Insert Field Value into URL drop-down list, select the name of the field whose value you want to insert into URL, which is Bug # in this example.
The text {ISSUE_ID} is inserted into the URL where you placed your cursor so the resulting URL is http://hostname:<port number>/bugzillarest/bugs/{ISSUE_ID}.
Click the OK button.
When a user accesses the Create Request page, enters the value 1234 into the Bug ID field, and clicks the Enter key, the SAM application invokes http://hostname:<port number>/bugzillarest/ bugs/1234 to pull data from the issue tracking system into the page.

Add the REST API URL that the SAM application will use to write the data back from the SAM application to the tracking systems.

Locate the tracking system that you just added and click its corresponding Write/Delivery button.
The Write/Delivery Method dialog box appears.
Enter the hardcoded URL into the Write/Delivery URL field.
This is an example of the Write/Delivery URL: http://hostname:<port number>/BugzillaRESTService/bug/.
Click the OK button.

Add the URL that the SAM application will use to drilldown to the tracking systems.

Locate the tracking system that you just added and click its corresponding Drilldown URL button.
The Drilldown URL dialog box appears.
Add a URL into the Drilldown URL field.
This is an example of the drilldown URL: http://hostname:<port number>/bugzilla/ show_bug.cgi?id={ISSUE_ID}.

NOTE: You can use the Insert Field Value into URL drop-down list to select the name of the field and insert it into URL. For more information on how to insert field value into URL, see Step 8.
Click the OK button.

Configure the issue tracking fields that are used by the SAM application.

Locate the system that you just added and click its corresponding Fields button.
The Config Fields page appears.
In the URL field, enter the URL of the tracking system's field JSON file. For more information on the expected JSON format, see Importing System Fields.
Click the Get Fields JSON button.
The SAM application lists all available fields that are populated from the tracking system.
In the Label column, modify the labels as needed.
Select the Active option for the fields that you want to be used within SAM.
In the Default Status column, select the radio button in the Default Status column for the issue tracking system's status field.
For example, this would be the status field in Bugzilla.
In the Key Field column, select the radio button in the Key Field column for the issue tracking system's unique identifier field.
For example, this would be the bug number field in Bugzilla.
Modify the listing order of the fields using the values in the List Order column.
Click the OK button.

To set up an SCM third-party system

From the SAM Home page, select the Main Menu button.

Select the Administration option.

Select the Systems option from the Administration drop-down list.

The Systems page appears.

Click the Add button in the Systems page.

Select SCM from the System Type drop-down list.

Two system types are available: Issue Tracking and SCM.

Enter the name of the third-party system into the System field.

Tab out of the System field.

Add the REST API URL that the SAM application will use to validate the approval request's SCM source (private branch or workspace name for example).

Locate the SCM system that you just added and click its corresponding Read/Update button.
The Read/Update Method dialog box appears.
Enter the hardcoded portion of the URL.
For example, http://hostname:<port number>/workspace/wsname/.
Place the cursor where you want to insert the private branch name or workspace name
In this case, that is at the very end of the string.
From the Insert Field Value into URL drop-down list, select the field source.
NOTE: This is an in-built field to store private branch name or workspace name that is also used when delivery is triggered from SAM.

The text {source} is inserted into the URL where you placed your cursor so the resulting

URL is http://hostname:<port number>/workspace/wsname/{source}

NOTE: You can configure a more complex URL with multiple parameters.

For example,

http://hostname:<port number>/github/repo/{repository}/pbname/{source}

In this case, the element {repository} is not available as an item in the Field drop-down list and must be manually entered. When an SCM entry is added to an approval request, these two elements are prompted to get entered.
Click the OK button.
When a user creates a request and adds an SCM entry for delivery, a prompt for {source} will be displayed. On clicking the Validate button, a pop-up screen appears where {source} and the similar elements like {repository}, if configured, will get populated for input.

On clicking the OK button in the pop-up screen, if the user entered dev_mypb as their private branch, for example, the SAM application invokes http://hostname:<port number>/workspace/wsname/dev_mypb to validate the SCM entry.

For the complex scenario, if the user entered staging for the {repository} prompt, the following URL is invoked:

http://hostname:<port number>/github/repo/staging/pbname/dev_mypb

Add the REST API URL that the SAM application will use to deliver the SCM entry changes.

NOTE: The Write/Delivery method of SCM system is only supported in 2.17.10 and onwards.

Locate the SCM system that you just added and click its corresponding Write/Delivery button.
The Write/Delivery Method dialog box appears.
Enter the hardcoded URL into the Write/Delivery URL field. The SAM application will use this REST API URL to deliver the SCM entry changes.
For example, http://<servername>:<port number>/workspacedelivery/workspace/. For more information, refer to Deploying and Configuring Workspaces.
Click the OK button.

Configure the SCM fields that are used by the SAM application for delivery parameters.

Locate the SCM system that you just added and click its corresponding Fields button.
The Config Fields page appears.
In the URL field, enter the URL of the SCM system's field JSON file. For example, http://<server name>:<port number>/workspacedelivery/workspace/fields.
For more information on the expected JSON format, see Importing System Fields.
Click the Get Fields JSON button.
The SAM application lists all available fields that are populated from the SCM system.

For example, for the URL entered in the step b, the two fields that display are requestid and wsname. Select Key Field option button for requestid and Default Status option for wsname.
In the Label column, modify the labels as needed.
Select the Active option for the fields that you want to be used within SAM.
Modify the listing order of the fields using the values in the List Order column.
Click the OK button.

Siebel Approval Manager Guide		Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.