Skip to content

Commit 259d5ef

Browse files
committed
Add descriptions
1 parent ed296d3 commit 259d5ef

File tree

5 files changed

+23
-8
lines changed

5 files changed

+23
-8
lines changed

src/Dataverse/TALXIS.DevKit.Templates.Dataverse.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!-- The package metadata. Fill in the properties marked as TODO below -->
55
<!-- Follow the instructions on https://learn.microsoft.com/en-us/nuget/create-packages/package-authoring-best-practices -->
66
<PackageId>TALXIS.DevKit.Templates.Dataverse</PackageId>
7-
<PackageVersion>1.10</PackageVersion>
7+
<PackageVersion>1.11</PackageVersion>
88
<Title>TALXIS.DevKit.Templates.Dataverse</Title>
99
<Authors>NETWORG</Authors>
1010
<Description>A collection of .NET templates for creating Power Platform components using a code-first approach. These templates will allow you to quickly scaffold projects with pre-configured settings and structure.</Description>

src/Dataverse/templates/pp-entity-attribute/.template.config/template.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@
1616
"datatype": "text",
1717
"defaultValue": ".",
1818
"replaces": "SolutionDeclarationsRoot",
19-
"fileRename": "SolutionDeclarationsRoot"
19+
"fileRename": "SolutionDeclarationsRoot",
20+
"description": "Folder under the project folder where solution components will be placed. Use the folder name only, not the full path. Use '.' if you want to place components directly in the project folder."
2021
},
2122
"EntitySchemaName": {
2223
"displayName": "Schema name of the entity including publisher prefix (might be different from logical name)",
24+
"description": "Typically, a Pascal cased version of the logical name. For example, Account",
2325
"type": "parameter",
2426
"datatype": "text",
2527
"replaces": "exampleexistingentity",
@@ -71,13 +73,15 @@
7173
},
7274
"PublisherPrefix": {
7375
"type": "parameter",
76+
"description": "Use the same publisher prefix as defined in Other/Solution.xml of the solution where this attribute is introduced to the system.",
7477
"datatype": "text",
7578
"replaces": "examplepublisherprefix",
7679
"fileRename": "examplepublisherprefix",
7780
"isRequired": true
7881
},
7982
"LogicalName": {
8083
"displayName": "Logical name (without publisher prefix)",
84+
"description": "All lower-case version of the schema name. For example, account",
8185
"type": "parameter",
8286
"datatype": "text",
8387
"replaces": "examplecustomentityattribute",

src/Dataverse/templates/pp-entity/.template.config/template.json

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,18 @@
7171
"datatype": "text",
7272
"defaultValue": ".",
7373
"replaces": "SolutionDeclarationsRoot",
74-
"fileRename": "SolutionDeclarationsRoot"
74+
"fileRename": "SolutionDeclarationsRoot",
75+
"description": "Folder under the project folder where solution components will be placed. Use the folder name only, not the full path. Use '.' if you want to place components directly in the project folder."
7576
},
7677
"IsSystemEntity": {
7778
"type": "parameter",
79+
"description": "Enter true if the entity is a system entity. System entities are predefined entities that are deployed on all environments out of box. You can only modify system entities and you can't introduce new one.",
7880
"datatype": "bool",
7981
"defaultValue": false
8082
},
8183
"EntityType": {
8284
"type": "parameter",
83-
"description": "Select entity type",
85+
"description": "There are two types of entities: Standard and Activity. Standard entities are used to store data, while Activity entities are used to track events such as emails, appointments and tasks.",
8486
"datatype": "choice",
8587
"choices": [
8688
{
@@ -94,13 +96,13 @@
9496
},
9597
"Behavior": {
9698
"type": "parameter",
97-
"description": "Select how the entity will be added to the solution",
99+
"description": "Select how the entity will be added to the solution. New entities will have all their metadata included, while existing entities will be just referenced.",
98100
"datatype": "choice",
99101
"choices": [
100102
{
101103
"choice": "New",
102104
"displayName": "Include metadata",
103-
"description": "When creating a new entity the default attributes, forms and views must be generated"
105+
"description": "When creating a new entity the default attributes, forms and views must be generated. You can't create a new system entity"
104106
},
105107
{
106108
"choice": "Existing",
@@ -152,6 +154,7 @@
152154
},
153155
"PublisherPrefix": {
154156
"type": "parameter",
157+
"description": "Use the same publisher prefix as defined in Other/Solution.xml of the solution where this entity is first introduced to the system.",
155158
"datatype": "text",
156159
"replaces": "examplepublisherprefix",
157160
"fileRename": "examplepublisherprefix",
@@ -160,35 +163,40 @@
160163
},
161164
"LogicalName": {
162165
"displayName": "Logical name (without publisher prefix)",
166+
"description": "All lower-case version of the schema name. For example, salesorder",
163167
"type": "parameter",
164168
"datatype": "text",
165169
"replaces": "examplecustomentity",
166170
"fileRename": "examplecustomentity",
167171
"isRequired": true
168172
},
169173
"LogicalNamePlural": {
170-
"displayName": "Logical name in the plural form (entity set name)",
174+
"displayName": "Logical name in the plural form (entity set name) (without publisher prefix)",
175+
"description": "All lower-case version of the collection schema name. For example, salesorders",
171176
"type": "parameter",
172177
"datatype": "text",
173178
"replaces": "examplecustomentities",
174179
"isRequired": "Behavior == \"New\""
175180
},
176181
"DisplayName": {
177182
"type": "parameter",
183+
"description": "Human-readable name. For example, Sales Order",
178184
"datatype": "text",
179185
"defaultValue": "ExampleEntityDisplayName",
180186
"replaces": "ExampleEntityDisplayName",
181187
"isRequired": true
182188
},
183189
"DisplayNamePlural": {
184190
"type": "parameter",
191+
"description": "Human-readable name in the plural form. For example, Sales Orders",
185192
"datatype": "text",
186193
"replaces": "ExampleEntityPluralDisplayName",
187194
"isRequired": "(Behavior == \"New\")"
188195
},
189196
"IsOrganizationTypeEntity": {
190197
"type": "parameter",
191198
"displayName": "Is Organization Value Entity?",
199+
"description": "If true, the entity is considered an organization value entity which means row level access control will not be configurable.",
192200
"datatype": "bool",
193201
"description": "Enter true if records are owned by organisation. (False = Owned by User/Team/User(Default) & True = Owned by Organisation)",
194202
"defaultValue": "false"

src/Dataverse/templates/pp-script-library/.template.config/template.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@
3232
"datatype": "text",
3333
"defaultValue": ".",
3434
"replaces": "SolutionDeclarationsRoot",
35-
"fileRename": "SolutionDeclarationsRoot"
35+
"fileRename": "SolutionDeclarationsRoot",
36+
"description": "Folder under the project folder where solution components will be placed. Use the folder name only, not the full path. Use '.' if you want to place components directly in the project folder."
3637
},
3738
"PublisherPrefix": {
3839
"type": "parameter",
40+
"description": "Use the same publisher prefix as defined in Other/Solution.xml of the solution where this library is introduced to the system.",
3941
"datatype": "text",
4042
"replaces": "examplepublisherprefix",
4143
"fileRename": "examplepublisherprefix",

src/Dataverse/templates/pp-solution/.template.config/template.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
},
3434
"PublisherPrefix": {
3535
"type": "parameter",
36+
"description": "Keep it under 5 characters. Only characters within the ranges [a - z] and [0 - 9] are allowed. It is used by majority components in their unique system name.",
3637
"datatype": "text",
3738
"replaces": "examplepublisherprefix",
3839
"isRequired": true

0 commit comments

Comments
 (0)