Example of Dashboard report: Shadows on resource

Last modified 16 Apr 2024 10:30 +02:00

Please see Dashboard configuration for basic information about configuration variables.

Example Use-case

Administrator needs to display all shadows on resource with actual state.

Configuration

As first, we need to configure an object collection for shadows of a specific resource and the kind of object of managed in the resource.

Example Object Collection

<?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 xmlns="http://midpoint.evolveum.com/xml/ns/public/common/common-3"

                  xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-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:t="http://prism.evolveum.com/xml/ns/public/types-3"

                  oid="72b1f98e-f587-4b9f-b92b-72e251dbb244">

    <name>Account shadows 'Test CSV: username'</name>

    <type>ShadowType</type>

    <filter>

        <q:text>

            resourceRef matches (oid = 'ef2bc95b-76e0-59e2-86d6-9999cccccccc') and kind = 'account'

        </q:text>

    </filter>

</objectCollection>

The import Dashboard object with widget for our object collection.

Example Dashboard configuration

<!--

  ~ 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.

  -->



<dashboard oid="72b1f98e-f587-4b9f-b92b-72e251da1234">

    <name>shadow-dashboard</name>

    <display>

        <label>Shadow dashboard</label>

    </display>

    <widget>

        <identifier>shadow</identifier>

        <display>

            <label>Resource R1; ACCOUNT</label>

            <color>#00a65a</color>

            <icon>

                <cssClass>fa fa-user</cssClass>

            </icon>

        </display>

        <data>

            <sourceType>objectCollection</sourceType>

            <collection>

                <collectionRef oid="72b1f98e-f587-4b9f-b92b-72e251dbb244" type="ObjectCollectionType"/>

            </collection>

        </data>

        <presentation>

            <dataField>

                <fieldType>value</fieldType>

                <expression>

                    <proportional>

                        <style>value-only</style>

                    </proportional>

                </expression>

            </dataField>

            <dataField>

                <fieldType>unit</fieldType>

                <expression>

                    <value>shadows</value>

                </expression>

            </dataField>

            <view>

                <column>

                    <name>nameColumn</name>

                    <path>name</path>

                    <display>

                        <label>Name</label>

                    </display>

                </column>

                <column>

                    <name>kindColumn</name>

                    <path>intent</path>

                    <display>

                        <label>Kind</label>

                    </display>

                    <previousColumn>nameColumn</previousColumn>

                </column>

                <column>

                    <name>intentColumn</name>

                    <path>kind</path>

                    <display>

                        <label>Intent</label>

                    </display>

                    <previousColumn>kindColumn</previousColumn>

                </column>

                <column>

                    <name>synchronizationColumn</name>

                    <path>synchronizationSituation</path>

                    <display>

                        <label>Synchronization</label>

                    </display>

                    <previousColumn>intentColumn</previousColumn>

                </column>

            </view>

        </presentation>

    </widget>

</dashboard>

We want report with the table of shadow, for this we can import the following dashboard report.

Example Report configuration

<?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="3e32d717-f8ce-45c3-99e3-9d5c1d6bd4a2">



    <name>Shadow dashboard report</name>

    <assignment>

        <targetRef oid="00000000-0000-0000-0000-000000000170" relation="org:default" type="c:ArchetypeType"/>

        <activation>

            <effectiveStatus>enabled</effectiveStatus>

        </activation>

    </assignment>

    <archetypeRef oid="00000000-0000-0000-0000-000000000170" relation="org:default" type="c:ArchetypeType"/>

    <roleMembershipRef oid="00000000-0000-0000-0000-000000000170" relation="org:default" type="c:ArchetypeType">

    </roleMembershipRef>

    <dashboard>

        <dashboardRef oid="72b1f98e-f587-4b9f-b92b-72e251da1234" relation="org:default" type="c:DashboardType"/>

    </dashboard>

</report>

Now we can run the report in the report menu, and download the report. By default, the reports created from dashboards are in the HTML format.

Example of Dashboard report: Shadows on resource

Example Use-case

Configuration

See Also