cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
Helpful
Responsive Resident
Responsive Resident

Adding licensing information to an existing solution

Hi All, I'm thrilled that Microsoft is adding something to support licensing ISV apps distributed through AppSource. That being said, in its current state it's pretty confusing and the documentation does not provide much clarity on the what or how of this feature.

 

As an ISV, here's my understanding of this feature in its current form:

  • It DOES:
    • Restrict AppSource deployment of model-driven apps to only those tenants that are registered by the ISV in Partner Center
    • Allow customers to assign licenses to individual users from within their own M365 Admin Center
    • Once deployed, restrict access of ISV model-driven apps to users that are assigned a license
  • It DOES NOT:
    • Allow ISVs to add licensing to existing AppSource offers
    • Allow ISVs to add licensing to packages built with current Power Apps Build Tools (v1.0.23)
    • Allow import of unmanaged solutions that include service plans
    • Allow customers to purchase licenses at the time of clicking "Get it Now"

We have an existing offer in AppSource. It has a model-driven app and no code components. We have full ALM automation built out in Azure DevOps and everything runs pretty smoothly. We're small so making changes in an unmanaged environment and then committing to repo works for us. All deployments are automated. The only time we mess with Visual Studio is to package for AppSource. We never open command line tools.

 

Here's a little recap of my experience attempting to implement and evaluate this:

  • Copy an existing AppSource offer - this is mostly cut/paste exercise, however, it will mean the back/forth of approvals with AppSource... content, tech, and co-sell material. Also updating any marketing links to the new offer if published.
    • Add a plan to the new offer. Note the "Plan ID", you'll need it later.
  • Go to the solution in my unmanaged environment and add a "Service Plan" component - just kidding we read the steps before that: Add licensing information to your solution

Here's where things slowed down. The first step says "Clone existing solution". In our world, that means go into the unmanaged Power Apps maker environment, select the solution and click "Clone a patch" or "Clone solution". This is not what they mean and it's confusing.

  • The documentation is referring to command line tools that we don't have (Power Apps CLI) - get those.
  • Using the clone command of the Power Apps CLI does not appear to make much sense for us since we already store our unpacked, unmanaged solution files in ADO. So I download those an unzip them locally.
  • Create licensing files - two CSV files. Do not get confused by file names in the screenshots - they actually need to be ".csv" files.
  • Add the licensing information to the solution using the specified Power Apps CLI command.
    • Take a look at what that command did. Comparing the modified solution files with an old set for reference, we can see that it:
      • added a folder called "ServicePlans" (right between Roles and WebResources).
      • added two Xml files (documented below) to the new folder, populated with the values from your .CSV files.
      • added two empty nodes "<serviceplans /><serviceplanappmodulesset />" to the Customizations.xml file in the "Other" folder.
    • Had I known they needed a folder with a specific name and two files with specific names I could have done that without the extra steps.
  • Build the solution. Here's where we get stuck. The documentation for this is particularly confusing: Create a managed solution for your app
    • We have DevOps automation to build solutions so we branch our unmanaged solution, apply the changes (noted above) in the repo and use our existing automation to build a managed package.
    • Open the resulting ZIP file and the empty nodes are now represented in the Customizations.xml file, however, the two files are nowhere to be found in either the Managed or Unmanaged solution package.
      • Is there some other tool we're supposed to use to ensure those files are picked up?
    • With input from @rajyraman, we discovered that the Package Solution task of the current version of the Power Apps Build Tools is not using the latest version of SolutionPackager and, therefore, does not generate the service plan content in Customzations.xml.
    • Use SolutionPackager on command line as workaround to package both Unmanaged and Managed solutions. Confirmed the service plan XML is incorporated into Customizations.xml.
  • Tested import of unmanaged solution that has service plan information to a clean environment. This fails with the following message: "Solution "ISV Solution" failed to import: ServicePlanAppModules data can only be changed by managed solution import".
  • Package for new AppSource offer and evaluate - Update below. WE'RE PAUSING HERE FOR NOW. Hoping we see updates that make it more manageable with our existing ALM setup.

 

Looking forward to this being more supportable. As of right now, it doesn't seem to be compatible with the ALM tools in Azure DevOps that we rely on.

 

ServicePlans.xml content:

 

 

 

<?xml version="1.0" encoding="utf-8"?>
<serviceplans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <serviceplan name="[SERVICE_PLAN_ID]">
    <accessmode>4</accessmode>
    <iscustomizable>0</iscustomizable>
    <displayname>[SERVICE_PLAN_NAME]</displayname>
    <moreinfourl>[YOUR_ISV_PLAN_INFO_LINK]</moreinfourl>
  </serviceplan>
</serviceplans>

 

 

 

ServicePlanAppModules.xml content:

 

 

 

<?xml version="1.0" encoding="utf-8"?>
<serviceplanappmodulesset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <serviceplanappmodules>
    <iscustomizable>0</iscustomizable>
    <appmoduleid>
      <uniquename>[MODEL_APP_COMPONENT_NAME]</uniquename>
    </appmoduleid>
    <serviceplanid>
      <name>[SERVICE_PLAN_ID]</name>
    </serviceplanid>
  </serviceplanappmodules>
</serviceplanappmodulesset>

 

 

 

 

Documentation references:

 

13 REPLIES 13
rajyraman
Continued Contributor
Continued Contributor

@Helpful- That XML is actually in the customizations.xml after you package the solution folder using the Solution Packager tool.

rajyraman_1-1620277564909.png

 

rajyraman_0-1620277530130.png

 

Helpful
Responsive Resident
Responsive Resident

Thanks, @rajyraman. Our solution is built using Power Platform Build Tools in Azure DevOps and the XML shown above does not appear in the Customizations file.

I thought the build tools used Solution Packager behind the scenes so would assume the same behavior as if we built with SolutionPackager, but maybe that’s a bad assumption.

I’ll test this tomorrow.

rajyraman
Continued Contributor
Continued Contributor

@Helpful- Check the version of Solution Packager being used from the AzDO logs. The one I use on the local machine is 9.1.1.2.

Helpful
Responsive Resident
Responsive Resident

Thanks, @rajyraman. Sure enough, it looks like Power Apps Build Tools is using Version 9.1.0.67.

We packaged with command line and are now seeing the service plan xml nodes populated in Customizations.xml.

I guess we'll wait for the tooling to catch-up. I recall the team that was working on those was getting a fair amount of investment a year ago, but perhaps priorities have shifted.

malkhawaja
Advocate III
Advocate III

Hi @Helpful,
Thanks for the elaborate feedback... my experience was almost exactly the same, as I stuck also to pack the managed solution, then eventually found it in the SolutionPackager Command Line.

now I submitted my package for publish in AppSource, and waiting for certification.

Captjoemcd
Advocate I
Advocate I

@Helpful - As an ISV, we have a very similar dev process to you, using Azure DevOps with automated deployments to customer-specific dev environments and production environments.  Azure DevOps build tools do not currently support including the LMS as you point out, although we've communicated the need to the team responsible for the build tools. 

 

The PAC CLI does nothing other than generate the xml from the csv mapping files, and then adds it to the end of your managed solution.  The folders with the csv files don't need to be in the final solution.  Once you have that xml generated, you can copy it into the managed solution directly.  When we first got started we didn't use the PAC CLI at all and just created the service plans and mapping directly in xml, and then added to our managed solution. 

 

Editing service plan information is currently not supported with an unmanaged solution for the obvious security reasons (though this may change at some point) - this means that you have to add it every time you export a managed solution from your dev environment.  We added a powershell step in our devops pipeline to add the xml to the managed solution when we pull from core dev prior to deploying the managed solutions to customer-specific dev and production environments. 

JeffCarma
Advocate I
Advocate I

Thanks @Captjoemcd ,

 

Here's a snip of powershell to get others started. The two files it uses are the customizations.xml file that is in the "Other" folder when you unpack the solution. (I unpacked it into a folder called "tempforpacking" of course.) The license.xml file is just the license specific section of the xml that the pac cli generates. I haven't added checking to ensure the nodes were added yet, but that should be straight forward.

 

Write-Host "starting script"
Write-Host "getting license.xml and custimizations.xml"
[xml] $orig = Get-Content '.\tempforpacking\Other\Customizations.xml'
[xml] $lic = Get-Content '.\license.xml'

Write-Host "adding license.xml to custimizations.xml"
$orig.ImportExportXml.AppendChild($orig.ImportNode(($lic.ImportExportXml.serviceplans),$true))
$orig.ImportExportXml.AppendChild($orig.ImportNode(($lic.ImportExportXml.serviceplanappmodulesset),$true))

Write-Host "saving modified customizations.xml file"
$orig.Save('.\tempforpacking\Other\Customizations.xml');
kartikka
Employee
Employee

Hi Folks,
             I am the PM that worked adding the licensing capability.  I would really like to understand the paradigm a little bit better on how you want licensing to be part of the CI/CD process. I did have an exchange with Jeff in a seperate thread. But I would like to understand the broader sentiment and the CI/CD workflow in question. 

When you respond, please @ me directly so that I can get notified.

Helpful
Responsive Resident
Responsive Resident

Hi @kartikka, thanks for the opportunity to provide feedback. I will speak on behalf of our setup and am curious to hear the perspective of others.

 

Please see attached image. To make this work:

  1. License Plans can be added as components to an unmanaged solution.
  2. SolutionPackager needs a switch that optionally applies licensing for managed solutions.
  3. Power Platform Build Tools' Package Task needs to be updated to use the new SolutionPackager with "Include Licensing" option for managed solutions (default is false).

ci_cd.png

We have the approach above implemented today, but some of Step 4's tasks could be cleaned-up to use Build Tools instead of PowerShell.

Helpful resources

Announcements

Celebrating the May Super User of the Month: Laurens Martens

  @LaurensM  is an exceptional contributor to the Power Platform Community. Super Users like Laurens inspire others through their example, encouragement, and active participation. We are excited to celebrated Laurens as our Super User of the Month for May 2024.   Consistent Engagement:  He consistently engages with the community by answering forum questions, sharing insights, and providing solutions. Laurens dedication helps other users find answers and overcome challenges.   Community Expertise: As a Super User, Laurens plays a crucial role in maintaining a knowledge sharing environment. Always ensuring a positive experience for everyone.   Leadership: He shares valuable insights on community growth, engagement, and future trends. Their contributions help shape the Power Platform Community.   Congratulations, Laurens Martens, for your outstanding work! Keep inspiring others and making a difference in the community!   Keep up the fantastic work!        

Check out the Copilot Studio Cookbook today!

We are excited to announce our new Copilot Cookbook Gallery in the Copilot Studio Community. We can't wait for you to share your expertise and your experience!    Join us for an amazing opportunity where you'll be one of the first to contribute to the Copilot Cookbook—your ultimate guide to mastering Microsoft Copilot. Whether you're seeking inspiration or grappling with a challenge while crafting apps, you probably already know that Copilot Cookbook is your reliable assistant, offering a wealth of tips and tricks at your fingertips--and we want you to add your expertise. What can you "cook" up?   Click this link to get started: https://aka.ms/CS_Copilot_Cookbook_Gallery   Don't miss out on this exclusive opportunity to be one of the first in the Community to share your app creation journey with Copilot. We'll be announcing a Cookbook Challenge very soon and want to make sure you one of the first "cooks" in the kitchen.   Don't miss your moment--start submitting in the Copilot Cookbook Gallery today!     Thank you,  Engagement Team

Announcing Power Apps Copilot Cookbook Gallery

We are excited to share that the all-new Copilot Cookbook Gallery for Power Apps is now available in the Power Apps Community, full of tips and tricks on how to best use Microsoft Copilot as you develop and create in Power Apps. The new Copilot Cookbook is your go-to resource when you need inspiration--or when you're stuck--and aren't sure how to best partner with Copilot while creating apps.   Whether you're looking for the best prompts or just want to know about responsible AI use, visit Copilot Cookbook for regular updates you can rely on--while also serving up some of your greatest tips and tricks for the Community. Check Out the new Copilot Cookbook for Power Apps today: Copilot Cookbook - Power Platform Community.  We can't wait to see what you "cook" up!      

Tuesday Tip | How to Report Spam in Our Community

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   As our community family expands each week, we revisit our essential tools, tips, and tricks to ensure you’re well-versed in the community’s pulse. Keep an eye on the News & Announcements for your weekly Tuesday Tips—you never know what you may learn!   Today's Tip: How to Report Spam in Our Community We strive to maintain a professional and helpful community, and part of that effort involves keeping our platform free of spam. If you encounter a post that you believe is spam, please follow these steps to report it: Locate the Post: Find the post in question within the community.Kebab Menu: Click on the "Kebab" menu | 3 Dots, on the top right of the post.Report Inappropriate Content: Select "Report Inappropriate Content" from the menu.Submit Report: Fill out any necessary details on the form and submit your report.   Our community team will review the report and take appropriate action to ensure our community remains a valuable resource for everyone.   Thank you for helping us keep the community clean and useful!

Community Roundup: A Look Back at Our Last 10 Tuesday Tips

As we continue to grow and learn together, it's important to reflect on the valuable insights we've shared. For today's #TuesdayTip, we're excited to take a moment to look back at the last 10 tips we've shared in case you missed any or want to revisit them. Thanks for your incredible support for this series--we're so glad it was able to help so many of you navigate your community experience!   Getting Started in the Community An overview of everything you need to know about navigating the community on one page!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Ranks and YOU Have you ever wondered how your fellow community members ascend the ranks within our community? We explain everything about ranks and how to achieve points so you can climb up in the rankings! Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Powering Up Your Community Profile Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile. Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Community Blogs--A Great Place to Start There's so much you'll discover in the Community Blogs, and we hope you'll check them out today!  Community Links: ○ Power Apps ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Unlocking Community Achievements and Earning Badges Across the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. Check out some details on Community badges--and find out more in the detailed link at the end of the article! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio    Blogging in the Community Interested in blogging? Everything you need to know on writing blogs in our four communities! Get started blogging across the Power Platform communities today! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Subscriptions & Notifications We don't want you to miss a thing in the community! Read all about how to subscribe to sections of our forums and how to setup your notifications! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Getting Started with Private Messages & Macros Do you want to enhance your communication in the Community and streamline your interactions? One of the best ways to do this is to ensure you are using Private Messaging--and the ever-handy macros that are available to you as a Community member! Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Community User Groups Learn everything about being part of, starting, or leading a User Group in the Power Platform Community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Update Your Community Profile Today! Keep your community profile up to date which is essential for staying connected and engaged with the community. Community Links: ○ Power Apps  ○ Power Automate  ○ Power Pages  ○ Copilot Studio   Thank you for being an integral part of our journey.   Here's to many more Tuesday Tips as we pave the way for a brighter, more connected future! As always, watch the News & Announcements for the next set of tips, coming soon!

Hear what's next for the Power Up Program

Hear from Principal Program Manager, Dimpi Gandhi, to discover the latest enhancements to the Microsoft #PowerUpProgram, including a new accelerated video-based curriculum crafted with the expertise of Microsoft MVPs, Rory Neary and Charlie Phipps-Bennett. If you’d like to hear what’s coming next, click the link below to sign up today! https://aka.ms/PowerUp  

Users online (4,914)