Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

Deployment API - commerce manager app deployment

Vote:
 
I am having trouble finding out how to deploy the commerce manager app via the DXP deployment API. I've checked the documentation on Code Package Format and have found various discussion eluding to building the separate package for commerce (e.g. Anders' last comment on Azure DevOps and Episerver deployment API | Optimizely Developer) but nothing states what the package name should be (assuming that is significant).
 
I would guess that since the standard app in Code Package Format is cms.app.1.0.0.nupkg, that for the commerce manager it might be commerce.app.1.0.0.nupkg but, if so, it should really be documented somewhere, right? Or maybe I've got the completely wrong idea about this? 🙂
 
I'm working with Commerce v13.
#336493
Feb 06, 2025 22:37
Vote:
 

it should not really matter. you can name it whatever you like as long as you stick with the convention (to avoid wrong deployment later). there is no strict rule of naming for deployment, I've seen different names and all work fine

#336517
Feb 07, 2025 7:56
Vote:
 

Okay got it, but how do I tell it to "deploy this to the commerce manager app service"?

#336530
Feb 07, 2025 21:52
Vote:
 

I'm not a DXP expert and it has been a long time since I touched the PaaS portal, but it seems you should be able to select the app you want to deploy to?

 

Select deployment options

DXP Self-Deployment Guide

#336557
Feb 08, 2025 13:06
Vote:
 

Okay, so I have concluded - from investigating, contacting support, and looking at examples of deployment API scripts online - that it's simply a convention based control - if the deployment package has the app type convention with "cms" then it deploys to the main app, and if it has "commerce" it deploys to the commerce manager app.

Here's the convention documented at https://docs.developers.optimizely.com/digital-experience-platform/docs/code-package-format has:
<app name>.<package type>.app.<version>.nupkg

  • App name  – Optional. Must not contain spaces or special characters.
  • Package types  – Values are cms (primary Web App).
  • Version â€“ You can specify it differently, using a "date format" or a version number.

So for my deployment packages, I have gone with the simplest form like this:

  • cms.app.4133.nupkg
  • commerce.app.4133.nupkg

And it works like a treat - when I use the same deployment API script, with the exact same parameters, it knows to go to the CMS app for the first example and commerce manager for that second package example.

I wish this was documented a little more explicitly - as I really felt there must have been something I was missing, hence this forum post.

I hope this helps someone else - although I realise it's not really such an issue with new projects as commerce manager is a thing of the past (only for commerce v13 and prior).

#336870
Feb 18, 2025 2:02
* You are NOT allowed to include any hyperlinks in the post because your account hasn't associated to your company. User profile should be updated.