Creating Plan work items from Code

The DevOps Code extension allows integration with IBM® DevOps Plan (Plan), enabling you to create and manage work items directly from your development environment in the browser IDE.

You can follow these steps to configure DevOps Code extension in the Code browser IDE, and create work items in IBM DevOps Plan (Plan).

  1. Open the Command Palette.
    Right-click to open the context menu and select Command Palette in the editor.

  2. Access the DevOps Code Command.
    1. Choose the Code command from the list of available commands.


      The Create Plan Item window is displayed.

    2. Click the Configure settings button to integrate DevOps Code with Plan for the first time.

      The Settings window is displayed to add the Personal Access Token, Plan Server URL, and Team Space ID.

      You can add these fields by navigating to the Plan platform, which is detailed in the next step.

  3. Perform the following steps to get configuration details from Plan:
    1. Click the Plan button in the IBM DevOps Loop switcher to navigate to the Plan page.
    2. Go to the Settings section of Plan, and enter the Personal Access Token (or API tokens) in the Create New API Token dialog.

  4. Perform the following steps to enter the configuration details:
    1. Navigate back to the Code application window from the switcher.
    2. Update the configuration details in the Settings window of Code.
      Note: To find the team space ID to use, open a work item in Plan and look in the browser address bar for the text between the words "repos" and "databases". For example, 'f062c5fb-b1d6-458b-9c02-af601d80e060' in https://<DevOpsLoopURL>/plan/#/ccmweb/view/repos/f062c5fb-b1d6-458b-9c02-af601d80e060/databases/MODEL/records/WorkItem/MODEL00000179
  5. Create a work item:
    1. Select the DevOps Code command from Command Palette.
      The Create Plan Item window is displayed again.

    2. Fill in the required fields such as Application Project, Component, Type, Title, and Description.
    3. Click the Create button to create your work item in Plan.

      A prompt is displayed at the end of the IDE to indicate that the work item has been created successfully.

  6. Click Open Work Item Link to view the work item on the Plan page.
    A dialog is displayed to open the Plan web page.
  7. Click Open to navigate to the work item page on the Plan web page.
By following these steps, you can easily configure the Code extension and begin creating and managing work items directly within your development environment. This integration eliminates the need to switch between your Code IDE and Plan.
Note: Currently, the DevOps Code extension has the following limitations:
  • At most one Plan application can be used. If you have multiple applications, the first one will be used.
  • The Plan application must use the Agile business flow. Other flows are currently not supported.
  • Your Plan project(s) must have at least one component.