microsoft / microsoft/BCQuality

Clarify 20-character limit for assignable permission set names in object-name guidance

Open Beginner friendly
#166 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
AL
Stars
212
Forks
121
Avg merge
3d 2h
Merged PRs (30d)
33

Description

Affected guidance

microsoft/knowledge/style/object-name-30-char-limit.md

Problem

The article includes permission sets in its general 30-character object-name limit. Its Best Practice section also recommends a descriptive name in the 20-26-character range, with additional space reserved for an app prefix.

There is an exception for assignable permission sets. The AL0305 diagnostic remarks on Microsoft Learn state:

For permission sets specifically, the diagnostic will also be triggered, if a permission set with the Assignable property set to true exceeds 20 characters.

The documented limits for permission set names are therefore:

Permission set configuration Maximum name length
Assignable = true 20 characters
Assignable = false 30 characters

Following the current guidance can produce an assignable permission set name of 21-30 characters that appears compliant with the article but triggers compiler diagnostic AL0305.

Suggested correction

  • Qualify the general 30-character rule with the 20-character exception for permission sets where Assignable = true.
  • Adjust the Best Practice section so the complete assignable permission set name, including any prefix or suffix, fits within 20 characters. The 20-26-character descriptive-name recommendation should not apply to these objects.
  • Link to the AL0305 remarks and clarify that exceeding this limit is a compiler error, not only a publish-time validation concern.

The general 30-character guidance can remain, provided this exception is explicit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with microsoft/knowledge/style/object-name-30-char-limit.md and compare its permission-set guidance with the AL0305 remarks linked in the issue. Update the article to state the 20-character limit for Assignable = true, retain the 30-character rule for other permission sets, revise the best-practice range, and explain that exceeding the assignable limit is a compiler error.】【。

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
91/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.