Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WLM Integration Steps

  1. Create the required Azure AD security groups - Example: TC-SmallVesselRegistrar-[DEV/TEST/ACC/PROD]

  2. Add your application users to the security groups

  3. Register your application with the Microsoft Identity Platform [Create an app registration], and add the API permissions your application requires from WLM:

    • WorkItem.CreateUpdate.All - Allow the application to have create/update access to all work item data.

    • WorkItem.Read.All - Allow the application to have read-only access to all work item data.

  4. Grant admin consent for your application’s API permissions (This can only be done by the cloud admin team)

  5. Register your line of business in the List of value service, contact the MOLE team. [NCD/NCA/NCT/PCP]

    • Contacts: Walter Hoban , Xia W , yiliu

    • List of value type: LineOfBusiness

      • You can use the following query to get information on the structure of the JSON Object:

        Code Block
        languagesql
        SELECT * FROM c WHERE c.ListOfValueType like '%LineOfBusiness%'
  6. Submit a request to Team Kraken [TC.F NCR MAACE Team Kraken / Équipe Kraken CEMAA RCN F.TC NCRMAACETeamKraken-EquipeKrakenCEMAARCN@tc.gc.ca] to integrate with WLM

    • Provide the security group names and what type of operation each group requires (App Role):

      • Readers

      • Writers

    • Provide the application name (App Registration Name)

    • Which environment you want to integrate your app with [NCD/NCA/NCT/PCP]

Application Configuration

Workload Management Service uses the Microsoft Identity Platform to secure it’s endpoints. If you followed the previous steps sequentially you should have your application registered with the MIP and the only remaining step is to configure your application to pass the JWT Bearer token as part of any communication with any of the WLM endpoints.

Workload Management Service Endpoints

Environments

Endpoint

OpenAPI Specification

NCD / Development

https://tc-api-management-dev.azure-api.net/wms/api/v1

Swagger UI (ncdsafsecsurapp-work-management-service.azurewebsites.net)

NCT / Test

https://tc-api-management-test.azure-api.net/wms/api/v1

Swagger UI (nctsafsecsurapp-work-management-service.azurewebsites.net)

NCA / Acceptance

https://tc-api-management-acc.azure-api.net/wms/api/v1

Swagger UI (ncasafsecsurapp-work-management-service.azurewebsites.net)

PCP / Production

https://tc-api-management-prod.azure-api.net/wms/api/v1

Swagger UI (pcpsafsecsurapp-work-management-service.azurewebsites.net)

...