Introduction
Entities basics
Entity queries
Linking entities
Filters
Entities in Result Table attributes
Postprocessing
Complex linkages and postprocessing
Hello there! In this video, you will learn about entities in ACDI reports, what they mean, how to create reports with entities, as well as how to manage entity filters and display attributes of secondary entities in final reports.
If you need a report that will display values for different objects linked with each other by an attribute like groups and its members, roles and users, role requests, approvers, requester, request, target user, etc., you must add a secondary entity or entities to a report.
Let's create a report that will show you data about all roles assigned to a user. This report will be created based on data from the snapshot. In ACDI there is a default Users Report which has only one entity, namely, a user from snapshot.
There are also some filters for this user, and the report displays a list of attributes in the Result Table.
Here is what you need to do: first, create a secondary entity—Role—and link it with the existing one. For this, go to Report Editor, choose a report that you want to use as a template,
click “Save as” and give it a new name. Now save.
Your custom report will appear on the reports list.
You may want to update some tags to use them later for placing the report in an appropriate submenu.
Let’s go back to an entity. Here you see that the base entity snapshot has a query “objectClass:inetOrgPerson.” This means that this entity will display information only about users from a snapshot.
Indices with the prefix report contain data from snapshots.
Okay, let's copy this entity and update the copy with customized properties.
Let’s change the query. You know that roles have the class “nrfRole.”
The entry in the “DateTime” field remains the same as for the copied entity, as do the entries in the “Entity Index” and “Entity primary key” fields.
The next step is to create a link between the two entities.
Roles are linked to users via different attributes. “nrfassignedroles” is an attribute that shows direct role assignments.
And the “nrfmemberof” attribute contains DN of roles assigned via different ways even using a nested child role assignment. Let's use the “nrfmemberof” attribute.
As you can see here, it contains a strict DN.
This means that for the entity “Role” you need to use DN for the “Source Attribute.”
Here “term” must be selected because it's a strict DN.
OK, you don't need any post-processing and want to link the “Role” to an entity “Snapshot.”
Snapshot’s attribute is “nrfMemberOf.”
One user may have many memberships as you can see in this example.
So, you linked entities from one side and now let's do it from the side of the primary entity.
The ”Source Attribute” here is “nrfMemberOf.” “Destination Entity name” – Role, “Destination Attribute” - DN.
Select here “many” to “one.” Let's save the settings.
It’s time to add a few filters for a role. Let’s assume you will want to filter by “CN.”
Then the filter’s name here will be “Role CN” and “role” will be selected for “Entity.”
Save everything. Okay, let's check this report.
Go to Reports and then to Custom Reports, which shows all reports with the tag “custom.” You can see your report here. Let's click “Load.”
OK, the report shows that in the last snapshot, there are 216 roles and 647 users.
Let’s use a filter and check users who are members of the “reportAdmin” role.
According to the data displayed, this role is assigned to twelve users. Let’s run the report.
Now you see all users and their information. You will probably want to display information about the roles themselves. Let's then add additional data to the “Role” entity.
Go to the “Result Table attributes” where you can remove user attributes you don't want to be displayed and add a new field for entity “Role.”
First of all, we need to create a field for the entity itself. You need to enable “Use attribute for entity object”, assign the entity, and give it a custom name. Let’s use “Role info” for the “Alias name for the attribute.” For now, there will be no changes here.
To get additional attributes for secondary entities, you need to create more attribute fields with this switcher turned off.
And now here you set the attributes you want to be displayed in the final report.
Add “nrfLocalizedNames”
And also “nrfLocalizedDescrs.” Entry here “Role Description” and change this entry to “Role Name.” Let's save the changes and check the report again. Refresh the page.
After a role is selected, you see that there are five users and the additional column with role info.
The roles have long descriptions and names with all localizations available. This info can be handled with the help of postprocessing. Let’s create a postprocessing function to enable the postprocessing.
Should you have any questions or require any assistance, please do not hesitate to contact us at any time swsupport.skypro@skypro.ch