How to use IBM App Connect with IBM Engineering Workflow Management

IBM Engineering Workflow Management (EWM) is a team collaboration tool that integrates development tasks, which include iteration planning, process definition, change management, defect tracking, source control, build automation, and reporting.

Availability:
  • App Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.1.0-r4 or later
  • A local connector in a Designer instance of IBM App Connect in containers (Long Term Support)Local connector in containers (Long Term Support release)
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release)
Attention: We have now enabled support for the following instances of IBM Engineering Workflow Management:
  • Jazz.net instance that uses HTTP authentication
  • Jazz IBM instance that uses HTTP authentication
  • GoBlue instance that uses form-based authentication
The following information describes how to use App Connect to connect to IBM Engineering Workflow Management.

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

What to consider first

EWM is installed as part of an IBM Engineering Lifecycle Management installation. For this reason, you might need your administrator to complete some of the steps in this document if you do not have admin permissions.

Connecting to IBM Engineering Workflow Management

To connect App Connect to an IBM Engineering Workflow Management account, you need to provide the following connection details.
Table 1. IBM Engineering Workflow Management credentials
Field Description
Tenant URL The public URL of the IBM EWM instance. For example, http://<hostname>:<port>. For instructions about how to create this URL, see the steps below.
User ID The user ID to log in to your IBM EWM account.
Note: User ID's without Jazz Admin or Jazz Project Admin permissions cannot access all operations, for instance Create attachment and Create work item. Non-permitted access will result in a 403 error message.
Figure 1. IBM EWM admin permissions
Screenshot to locate your IBM EWM permissions
Password The password to log in to your IBM EWM account.
Context The context root that is part of the URL that accesses the application in the IBM EWM instance. For example, in the URL https://<hostname>:<port>/ccm, the context root is ccm.
Private network connection To connect IBM EWM to App Connect, you need to create a private network connection to your IBM Engineering Lifecycle Management instance. Select the name of a private network agent that App Connect uses to connect to your private network. This list is populated with the names of private network agents that are created on the Private networks page. For more information, see Connecting to a private network.

To connect to a IBM Engineering Workflow Management endpoint from the App Connect Designer Connect > Applications and APIs page (previously the Catalog page) for the first time, expand IBM Engineering Workflow Management, then click Connect. For more information, see Managing accounts.

General considerations

  • If you want to fetch/retrieve/map the value of a specific property, you can use JSONata expressions. For more information, see Applying JSONata functions to transform your data.
  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

IBM Engineering Workflow Management events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: In containers, only local accounts can be used for these events.

Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.

IBM Engineering Workflow Management actions

Your flow completes these actions on this application.

Attachments
Retrieve attachment content
Create attachment
Project areas
Retrieve project areas
URI resolvers
Resolve resource URI
Work items
Create work item
Retrieve work items
Update work item

Examples

Dashboard tile for a template that uses IBM EWM

Use templates to quickly create flows for IBM Engineering Workflow Management

Learn how to use App Connect templates to quickly create flows that complete actions on IBM Engineering Workflow Management. For example, open the Templates gallery, and then search for IBM Engineering Workflow Management.

Dashboard tile for a template that uses IBM EWM