Configure the Viewer Interaction Behaviour
- Last UpdatedJan 31, 2024
- 2 minute read
You can configure Dashboard to not only highlight/isolate the aliases for the object selected, but also to follow an association and highlight/isolate.
For example, You can isolate all objects of a 2D document within a 3D model, with each of its parts or tags highlighted.
You must configure the SiteSettings element in the DashboardProfile to set the objects' class and the association for isolating/highlighting. For each object of a class highlighted in the configuration, the objects' aliases fulfilling the association is highlighted instead. This configuration applies to all the viewer actions.
Configuring SiteSettings Element in DashboardProfile
You can configure the viewer interaction behaviour by adding the ViewerActionsAssociations configuration to your DashboardProfile XML. If you are in an active system, you can export the profile update with ViewerActionsAssociations, and then reimport it into the system.
To configure SiteSettings Element in DashboardProfile:
-
Update the DashboardProfile in the XML file:
-
Go to the SiteSettings Element.
-
Modify the following XML:
<ViewerActionAssociations>
<ViewerActionAssociation>
<ClassId>DOCUMENT CONTENT</ClassId>
<Association>refers to</Association>
</ViewerActionAssociation>
<ViewerActionAssociation>
<ClassId>SET</ClassId>
<Association>is an assembly including</Association>
</ViewerActionAssociation>
<ViewerActionAssociation>
<ClassId>AREA</ClassId>
<Association>is an assembly including</Association>
<IncludeSelf>true</IncludeSelf>
</ViewerActionAssociation>
<ViewerActionAssociation>
<ClassId>SYSTEM</ClassId>
<Association>is an assembly including</Association>
<IncludeSelf>true</IncludeSelf>
</ViewerActionAssociation>
</ViewerActionAssociations>
</SiteSettings>
-
The following table describes the elements in the XML, what they indicate, and whether they are required or optional:
|
This Element |
Indicates |
Required/Optional |
|---|---|---|
|
ViewerActionAssociations |
A grouping of Viewer Action Associations |
Required |
|
ClassId |
A unique identifier for the objects' class: All associations are inherited to the child classes |
Required |
|
Association |
A relationship established to fetch all the parts or tags of an object. For example, a container and its parts. |
Required |
|
IncludeSelf |
Determines if a particular object itself should be included in the objects send to the viewer |
Optional |
The following table describes the default configuration:
|
Class |
Association |
IncludeSelf |
|---|---|---|
|
DOCUMENT CONTENT |
refers to |
false |
|
SET |
is an assembly including |
false |
|
AREA |
is an assembly including |
true |
|
SYSTEM |
is an assembly including |
true |