-
Type:
Documentation
-
Resolution: Unresolved
-
Priority:
Minor
-
None
-
Affects Version/s: None
-
Component/s: wiki
-
None
Some ideas for what might improve the Rules wiki page
Rules Notes:
- Owner group is the group that the rule looks at. A little confusing since it doesn't own the rule. The "assigned" group is where the rule is defined.
- Needs documentation on which rules "fire immediately" vs. through the changelog consumer. Also document which rules work with the rules full sync, since the rules UI makes a vague reference to it
- Use cases should have more realistic names instead of groupA and groupB
- Get rid of the instructions on how to add attribute assignments, whether it's a screnshot, gsh script, or text descriptions. Ok to have just a list of simple attribute names; e.g.
- - ActAsSubjectSourceId: g:isa
- ActAsSubjectId: GrouperSystem
- CheckType: flattenedMembershipRemove
- CheckOwnerName: basis:hr:activeEmployees
- ThenEnum: assignMembershipDisabledDaysForOwnerGroupId
- ThenEnumArg0: 7
- ThenEnumArg1: F
- Get rid of gsh to set up use cases. If a use case illustration is useful, describe it in text
- Add illustration to show:
- which are the owner and assigned objects as applicable; add a small box indicating where the rule lives
- where the initial change happens (e.g., user is added to a basis group from a loader job)
- the effective change as the result of the rule
- Make sure all aspects of the rule are described; e.g. if a rule sets a disabled date on a membership but it already has a date, will it leave it alone or overwrite the date
- Add some kind of docString annotation to the enums (description, arguments, run in daemon or immediate, jexl params), to help with documentation (auto-generated?)