# RoleAnalysisSessionOptionType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Supertype: AbstractAnalysisSessionOptionType
Object clustering options for "role" mode. Specification of parameters utilized for establishing cluster generation conditions, specifically pertaining to the RoleAnalysisClusterType. These parameters play a critical role in defining the criteria and conditions for grouping objects into clusters, enabling effective role analysis. Furthermore, the role analysis session allows for the possibility of updating these values. If there is a need to modify or refine the cluster options during the analysis process, the values associated with the keys can be updated accordingly. This flexibility enables fine-tuning of the role analysis based on changing requirements or new insights gained during the analysis phase.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
query | property SearchFilterType | [0,1] | Specifies the query or filter applied to the objects.
similarityThreshold | property double | [0,1] | Similarity threshold used for clustering (Jaccard).
minMembersCount | property int | [0,1] | Specifies the minimum required cluster size (member objects).
propertiesRange | property RangeType | [0,1] | Specifies the minimum and maximum required number of properties.
minPropertiesOverlap | property int | [0,1] | Minimum property overlap size between cluster members.

- ### Items

  - #### query

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Specifies the query or filter applied to the objects. Only the objects that match the filter are included in the analysis.

  - #### similarityThreshold

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Similarity threshold used for clustering (Jaccard). If the condition is not met, then the objects are excluded from the cluster.

  - #### minMembersCount

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Specifies the minimum required cluster size (member objects). NOTE: The parameter checks the number of these unique objects, not the total number of included objects in the cluster.

  - #### propertiesRange

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Specifies the minimum and maximum required number of properties. If the condition is not met, the object is excluded. USER MODE - min role assign. ROLE MODE - min members count.

  - #### minPropertiesOverlap

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Minimum property overlap size between cluster members. In the case of USER MODE, the user (member) is included in the cluster, if there are other user(s) who have at least "minOverlapCondition" equal roles. In the case of ROLE MODE, the role (member) is included in the cluster, if there are other role(s) who have at least "minOverlapCondition" equal users.