webMethods

webMethods

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only

Tech Bytes IWHI: Configure external source control & create version control projects 

12 days ago

Introduction

This article will explain how we can create the external VCS(version control system) project

Pre-requisite

webMethods.io Integration tenant with Develop Anywhere Deploy Anywhere capabilities enabled

Audience

 This article is targeted for Integration architects and developers of webMethods.

Use case

Client is planning to develop the assets on cloud and want to manage the assets using their external version control. In this article we will setup external version control on IBM webMethods.io Integration.

Step up the version control on webMethods.io Integration

  • Navigate to webMethods.io Integration platform
  • Click on the settings and then select the version control tab.

  • Click on Add button.

  • Provide the details like Source control name of your choice.
  • Select the external repository from the drop-down menu. In our case we have selected the Azure Repository.
  • Provide the username of external repo, host name and the PAT token.
  • Click on validate

A screenshot of a computer

AI-generated content may be incorrect.

  • Once PAT gets validated, we can see details of it under the version control page.

Points to remember while setting up version control

  • User should have read access on the external VCS for the PAT to get validated and for upcoming operations like pull of repository.
  • In the case of Azure Repo Token Expiry date will not be auto filled. We can leave it either blank or fill in the date manually when the token is expiring.
  • If we don’t fill the expiry date, then on the version control page it will be shown as undefined.
  • For all other external control systems, we get the expiry date in the response and then the same date is updated on expiry date column.

Setup the version control using API’s

  • Above we have seen how we can setup the version control from UI. We can also achieve using same using the  public API offered from the platform.

Create Version control:

METHOD: POST

URL: https://<hostname>/apis/v1/rest/configurations/version-control/accounts

Request payload:

{

  "displayName": "Any display Name",

  "type": "azurerepo<Repo  Type>",

  "hostname": "dev.azure.com",

  "credentials": {

    "username": "xxxxxxxxxxxxxxxx",

    "accessToken": "********************************************"

  }

}

Response

{

               "output": {

                              "type": "azurerepo",

                              "credentials": {

                                             "username": "VikashSharma5"

                              },

                              "displayName": "vikashazure",

                              "owner": "Tenant userName",

                              "isValidToken": true

               }

}

  • Navigate to webMethods.io Project screen and click on + icon.
  • Provide the name for the project of your choice. In our case we  have given “LogisticAssets”
  • Under source control select the external repo server which we have configured in our previous steps.

  • Configure the repo path as per actual url.
  • To verify if the path click on open. It should open the external repository.

Link :  https://<hostname>/VikashSharma5/IBMcustomServices/_git/LogisticAssetsProject

  • When click on create it creates empty VCS project.

 

A screenshot of a computer

AI-generated content may be incorrect.

Points to remember while managing external repository

  • The external repository should be empty else the project will not be created.
  • All the assets checked in to this repo should be done from the webMethods project. If we commit any assets externally from some other client then it will corrupt the webMethods project.
  • Currently Develop any where flow service assets will get checked in to the external repository. All workflow, flow services and assets related to them will still get checked in IBM internal repository.

Create VCS project using API

METHOD: POST

URL: https://<Tenant Name>/apis/v1/rest/projects

Request Payload:

{

  "name": "LogisticAssets",

  "externalGitDetails": {

   

      "gitAccountName": "vikashazure",

      "pathToRepository": "VikashSharma5/IBMcustomServices/_git/LogisticAssetsProject",

      "branch": "main"

   

  }

}

Response Payload

{

               "output": {

                              "name": "LogisticAssets",

                              "uid": "fla221ab7f8cdb8b22cf3ffa",

                              "tenant_uid": "fljhcue",

                              "workflow_count": 0,

                              "flowservice_count": 0,

                              "created_at": "2025-07-03T06:44:10.588Z",

                              "updated_at": "2025-07-03T06:44:10.588Z"

               }

}

 

 

Statistics
0 Favorited
12 Views
0 Files
0 Shares
0 Downloads