You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: powerapps-docs/developer/data-platform/appendix-add-license-information-to-your-solution.md
+39-26Lines changed: 39 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -18,17 +18,17 @@ search.app:
18
18
19
19
# Appendix: Add licensing information to your solution
20
20
21
-
This article outlines how to add licensing information to Microsoft Dataverse solution, package the solution, and upload it to Microsoft AppSource. To add licensing information to your solution, you need to get the **Service ID** values created in the Partner Center when you create plans in the Partner Center. More information: [Create an AppSource package for your app](/powerapps/developer/data-platform/create-package-app-appsource).
21
+
This article outlines how to add licensing information to a Microsoft Dataverse solution, package it, and upload the solution zip file to Microsoft AppSource. More information: [Create an AppSource package for your app](/powerapps/developer/data-platform/create-package-app-appsource).
22
22
23
23
The following steps are required to add license information to your solution:
24
24
25
25
- Clone existing solution.
26
-
- Use the Power Apps CLI tool to add license information to the solution based on your desired licensing approach.
27
-
- Build the solution and package it and upload the zip file to Partner Center.
26
+
- Use the Power Apps CLI tool to add license information to the solution.
27
+
- Build the solution, package it, and upload the zip file to AppSource.
28
28
29
29
## Download the latest version of the Power Apps CLI
30
30
31
-
You can download the latest version of Power Apps CLI from [here](/powerapps/developer/data-platform/powerapps-cli). The Power Apps CLI tool includes commands that are required for adding license information to the solution. To verify that you have the correct version of the tool:
31
+
You can download the latest version of Power Apps CLI from [here](/powerapps/developer/data-platform/powerapps-cli). The Power Apps CLI tool includes commands that are required for adding licensing information to the solution. To verify that you have the latest version of the tool:
32
32
33
33
- Open a **Developer Command Prompt for VS 2017** or higher window.
34
34
- Enter the command `pac install latest`. This will install the latest version of the tooling.
@@ -38,40 +38,49 @@ You can download the latest version of Power Apps CLI from [here](/powerapps/dev
38
38
39
39
Use Power Apps CLI commands to clone the solution. To clone a solution:
40
40
41
-
1. Create an authentication profile for the environment that your solution is added to by using the command:
42
-
43
-
`pac auth create --name <name of your choice> --kind Dataverse -–url <your dataverse url> --username <your username> --password <your password>`
41
+
1. Create an authentication profile for the environment where you want to add your solution by using the command:
44
42
43
+
```azurecli
44
+
pac auth create --name <name of your choice> --kind Dataverse -–url <your dataverse url> --username <your username> --password <your password>`
45
+
```
45
46
1. Clone the existing solution by using the command:
To add license information to your solution, you need to create two `.CSV` files using the text editor of your choice. The following are the two files that you need to create:
54
+
To add licensing information to your solution, you need to create two `.CSV` files using the text editor of your choice. The following are the two files that you need to create:
52
55
53
56
- **Plan definition file**: Define the details of the plans you created in the Partner Center.
54
57
- **Plan mapping file**: Maps those plans to the components of your solution.
55
58
56
-
In this article, we will create two CSV files. This solution has three model-driven apps (Gold App, Silver App, and Bronze App) each of which has different features. We will follow the **Russian doll** licensing model as shown in the following table:
59
+
In this article, we will create two CSV files. You can choose any licensing approach you like. In this article, we will follow the **Russian doll** licensing model as shown in the following table:
You need to create these plans in the Partner Center. More information: [Create plans on AppSource](/azure/marketplace/dynamics-365-customer-engage-plans). Here is what they look like in Partner Center with the **Service ID** for each plan:
64
+
In this article, the solution contains three model-driven apps (Gold App, Silver App, and Bronze App) each model-driven app different from one another.
62
65
63
-
> [!NOTE]
64
-
> Currently model-driven apps are the only types of solution components that can be mapped to licenses. In future releases, we plan to add support for other component types such as canvas apps and tables.
To add licensing information to your solution, you need to get the **Service ID** values created in the Partner Center. You need to create these plans in the Partner Center to get the **Service ID** values. More information: [Create plans in Partner Center](/azure/marketplace/dynamics-365-customer-engage-plans).
> Currently model-driven apps are the only types of solution components that can be mapped to licenses. In future releases, we plan to add support for other component types such as canvas apps and tables.
67
76
68
77
### Plan definition file
69
78
70
79
The plan definition file should contain the following columns:
71
80
72
-
**Service ID:** This is created automatically when you create a plan in the Partner Center as part of the offer creation. More information: [Create plans on AppSource](/azure/marketplace/dynamics-365-customer-engage-plans).
73
-
**Display Name:** The display name for your plan. The display name is shown to users on the license check error dialogs.
74
-
**More info URL:** The URL where you would like to direct users to get more information about the solution if they get any license check errors.
81
+
- **Service ID:** This is created automatically when you create a plan in the Partner Center as part of the offer creation. More information: [Create plans in Partner Center](/azure/marketplace/dynamics-365-customer-engage-plans).
82
+
- **Display Name:** The display name for your plan. The display name is shown to users on the license check error dialogs.
83
+
- **More info URL:** The URL where you would like to direct users to get more information about the solution if they get any license check errors.
@@ -80,30 +89,34 @@ The plan definition file should contain the following columns:
80
89
81
90
The plan mapping file should contain the following columns:
82
91
83
-
**Service ID:** This is created automatically when you create a plan in the Partner Center as part of the offer creation. More information: [Create plans on AppSource](/azure/marketplace/dynamics-365-customer-engage-plans).
84
-
**Component name:** The solution component that you would like to restrict access to using license management. This name must match the name of the component in the **Name** column in the solution viewer.
92
+
- **Service ID:** This is created automatically when you create a plan in the Partner Center as part of the offer creation. More information: [Create plans in Partner Center](/azure/marketplace/dynamics-365-customer-engage-plans).
93
+
- **Component name:** The solution component that you would like to restrict access to using license management. This name must match the name of the component in the **Name** column in the solution viewer.
Once you have created your own licensing CSV files, the next step is to add the information from these files to your solution.
90
99
91
-
###Add licensing information
100
+
## Add licensing information
92
101
93
102
To add the license information from the CSV files (created above) to the solution:
94
103
95
-
- Open a **Developer Command Prompt for VS 2017** or higher window. Enter the following command:
96
-
97
-
`pac solution add-license`
104
+
- Open a **Developer Command Prompt for VS 2017** or higher window. NAvigate to the ___location where you have cloned solution. Enter the following command:
98
105
106
+
```azurecli
107
+
pac solution add-license -pd <path to plan definition file> -pm <path to plan mapping file>
108
+
```
99
109
- To check whether the licensing information is added, navigate to the ___location where you have cloned your solution zip file, you should see a new folder **ServicePlans** is created with two XML files.
100
-
- Optional- To determine how the license information from the CSV files was captured, open the XML files in your favorite editor.
110
+
- Optional: To determine how the license information from the CSV files was captured, open the XML files in your favorite editor.
101
111
- The **ServicePlans.xml** file contains the plan definition information from the plan definition file.
102
112
- The **ServicePlansAppModules.xml** file contains the plan mapping information from the plan mapping file.
103
113
104
114
## Build the solution and create an AppSource package
105
115
106
-
To build and create AppSource package, see [Create a managed solution for your app](/powerapps/developer/data-platform/create-solution-app-appsource). To create the AppSource package, see [Create an AppSource package for your app](/powerapps/developer/data-platform/create-package-app-appsource).
116
+
To build a solution, see [Create a managed solution for your app](/powerapps/developer/data-platform/create-solution-app-appsource). To create the AppSource package, see [Create an AppSource package for your app](/powerapps/developer/data-platform/create-package-app-appsource).
117
+
118
+
To validate whether the licensing information is included, after the solution is built, look for the licensing information in your solution `customizations.xml` file.
107
119
108
-
To validate if the licensing information is included, after the solution is built, look for the licensing information in your solution `customizations.xml` file.
0 commit comments