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.
App Connect
Enterprise as a Service connector
Local
connector in containers (Continuous Delivery release) 12.0.1.0-r4 or later -
Local connector in containers (Long Term Support Cycle-2 release)
- A Jazz.net instance that uses HTTP authentication
- A Jazz IBM instance that uses HTTP authentication
- A GoBlue instance that uses form-based authentication
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
IBM Engineering Workflow Management 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
| Field | Description |
|---|---|
| Tenant URL | The public URL of the IBM Engineering
Workflow Management instance. For example,
http://<hostname>:<port>. |
| User ID | The user ID to log in to your IBM Engineering
Workflow Management account. Note: User
IDs 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.
 |
| Password | The password to log in to your IBM Engineering Workflow Management account. |
| Context | The context root that is part of the URL that accesses the application in the IBM Engineering
Workflow Management instance. For example, in the URL
https://<hostname>:<port>/ccm, the context root is
ccm. |
| Private network connection | To connect IBM Engineering
Workflow Management 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
connection that App Connect uses to connect to your private
network. This list is populated with the names of private network connections that are created from
the Private network connectionspage in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.) |
To connect to a IBM Engineering Workflow Management endpoint from the App Connect Designer page for the first time, expand IBM Engineering Workflow Management, then click Connect.
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.
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.
| Object | Action | Description |
|---|---|---|
| Attachments | Create attachment | Creates an attachment in the IBM Engineering Workflow Management |
| Retrieve attachment content | Retrieves the attachment content | |
| Project areas | Retrieve project areas | Retrieves the project areas |
| URI resolvers | Resolve resource URI | Resolves the URI |
| Work items | Create work item | Creates the IBM Engineering Workflow Management work item |
| Retrieve work items | Retrieves the IBM Engineering Workflow Management work items | |
| Update work item | Updates the IBM Engineering Workflow Management work item |
Examples
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, go to the Discover page and search for IBM Engineering Workflow Management.
Model Context Protocol (MCP) support
- Work items