Example of Dashboard report: Number of Members

Last modified 25 Apr 2024 10:39 +02:00

Please see Dashboard configuration for basic information about configuration variables.

Example Use-case

Administrator needs to display all roles with the number of their members.

Configuration

As the first step we need to configure an object collection for all roles.

Example Object Collection

Git

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (c) 2010-2024 Evolveum
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<objectCollection oid="72b1f98e-f587-4b9f-b92b-72e251dbb255">
    <name>All roles</name>
    <type>RoleType</type>
</objectCollection>

We want a report with table of roles for this we configure the report definition.

Example Report Configuration

Git

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Copyright (c) 2024 Evolveum
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->
<report xmlns="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
        xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
        xmlns:icfs="http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/resource-schema-3"
        xmlns:org="http://midpoint.evolveum.com/xml/ns/public/common/org-3"
        xmlns:q="http://prism.evolveum.com/xml/ns/public/query-3"
        xmlns:ri="http://midpoint.evolveum.com/xml/ns/public/resource/instance-3"
        xmlns:t="http://prism.evolveum.com/xml/ns/public/types-3"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        oid="15aeaf18-e78a-4029-8a26-50976a17ffd7">
    <name>Roles and Members</name>
    <assignment>
        <targetRef oid="00000000-0000-0000-0000-000000000171" relation="org:default" type="c:ArchetypeType"/>
        <activation>
            <effectiveStatus>enabled</effectiveStatus>
        </activation>
    </assignment>
    <archetypeRef oid="00000000-0000-0000-0000-000000000171" relation="org:default" type="c:ArchetypeType"/>
    <roleMembershipRef oid="00000000-0000-0000-0000-000000000171" relation="org:default" type="c:ArchetypeType">
    </roleMembershipRef>
    <objectCollection>
        <collection>
            <baseCollectionRef>
                <collectionRef oid="72b1f98e-f587-4b9f-b92b-72e251dbb255" relation="org:default" type="c:ObjectCollectionType"/>
            </baseCollectionRef>
        </collection>
        <view>
            <column>
                <name>name</name>
                <path>c:name</path>
            </column>
            <column>
                <name>members</name>
                <display>
                    <label>Number of members</label>
                </display>
                <export>
                    <expression>
                        <script>
                            <code>
                                import com.evolveum.midpoint.prism.query.*
                                import com.evolveum.midpoint.xml.ns._public.common.common_3.*

                                query = prismContext.queryFor(UserType.class).item(AssignmentHolderType.F_ROLE_MEMBERSHIP_REF).ref(object.getOid()).build();
                                objects = midpoint.searchObjects(UserType.class, query)
                                return objects.size();
                            </code>
                        </script>
                    </expression>
                </export>
            </column>
            <type>c:RoleType</type>
        </view>
    </objectCollection>
</report>

Now we can run the report in the report menu, and download the report.

Was this page helpful?
YES NO
Thanks for your feedback