Searching

You can configure the search by defining categories, filters and/or columns in the results table.

Note: It is recommended to configure a small number of high-level classes such as document, equipment, and so on in the drop-down list.

Search Categories

Search categories are the classes in the Type list.

Example Search Categories:

The following rules apply when configuring search categories:

• Top-level categories are defined in the BootstrapSampleSearchCategories.xml file.

• Top-level category display names are always taken from the bootstrap file.

• Top-level categories can refer to a class at any level of the Class Library, including system classes..

• Top-level categories always show in the list, even if they would NOT return results.

• Sub-categories are "child" classes as defined in Class Library by the BootstrapSampleClasses.xml file, see Creating Your Own Bootstrap Files.

• Sub-category display names are based on the values in the Settings, Labels, Types panel, see Updating AVEVA Asset Information Management Dashboard Settings.

• Sub-categories only show if they would return results.

To define your own categories:

1. Create your own version of the BootstrapSampleSearchCategories.xml file that can be found in [installation folder]\Import\Server\Bootstrap. See Altering the Bootstrap Files.

2. Change your file, using the following syntax/rules:

   1. For each class you want to appear in the Type list, link a <ClassID> to a <SearchCategory> as shown in the following example:

      <Class>

      <ClassID>LOGICAL (&amp; OTHER PHYSICAL) OBJECT</ClassID>

      <SearchCategory>{1}All</SearchCategory>

      </Class>

      <Class>

      <ClassID>DOCUMENT CONTENT</ClassID>

      <SearchCategory>{2}Documents</SearchCategory>

      </Class>

      <Class>

      <ClassID>FUNCTIONAL ARTIFACT</ClassID>

      <SearchCategory>{3}Tags</SearchCategory>

      </Class>

      <Class>

      <ClassID>EQUIPMENT</ClassID>

      <SearchCategory>{4}Equipment</SearchCategory>

      </Class>

      Note:

      • The ClassID can be found by using the Admin Tool, expand the folders in the Class Library pane to see details of the class IDs, names and structure.

      • The number in the {} brackets is the sort order.

      • Un-ordered categories are shown randomly after the ordered ones.

      • The text in the list is exactly as written after the brackets.

   2. If you want to include objects with a class of UNKNOWN in the "ALL" results and in their own category:

      1. Add the following section (use a |(pipe) character to separate multiple categories):

         <Class>

         <ClassID>UNKNOWN</ClassID>

         <SearchCategory>{99}Unknown|All</SearchCategory>

         </Class>

      2. In the AIM Dashboard, select Settings, General, Data visibility, select Show items of Unknown type, and then select Save.

   3. To remove a category from the list:

      • Remove the entire <Class> section, and

      • Empty the <SearchCategory> tag. For example, <SearchCategory></SearchCategory>.

3. Open Import Controller and update the bootstrap file, see Altering the Bootstrap Files.

4. You may need to restart IIS to see the changes in the AIM Dashboard, depending on your refresh intervals.

Search Filters

Search filters are additional criteria that can be used for searching within a category. They appear when a category is selected in the Type list.

Example Search Filters:

To define your own filters:

5. Create a saved search, (you must have the CreateAdvancedFind Right):

   4. Log on to the AIM Dashboard and select Search.

   5. In the Type list, select the category you want to create filters for.

   6. Select Advanced…

   7. Select the type of filter you want to add.

   8. Select an item from the list.

   9. Select Prompt?

   10. Repeat steps d-f for each filter you want to add.

   11. Select Save Search.

   12. Enter an ID (name) for the search, and then select Save.

6. Copy the body attribute of the saved search:

   13. Open the AIM Admin Tool.

   14. In the Class Library pane, search for general find.

   15. In the Object of Class pane, select the search created in step 1.

   16. In the Manager pane, expand Attributes.

   17. Select Edit Object Attributes.

   18. Copy the Value field of the Body attribute.

7. Create your own version of the SearchConfigurationExamples_null.xml file that can be found in [installation folder]\SampleData\IPE Staging Area\SampleConfiguration. See Copying Sample Configurations.

   Note: Make sure you include "_null" at the end of the filename to avoid the application searching for a non-existent XSLT file.

8. Change your file, using the syntax below (as found in the original file):

   19. For <ID> and <ClassID> type the Class ID [classid]of the search category. For example PUMP.

   20. For <Value>, inside the CDATA brackets, paste the [bodyattributevalue] that you copied in step 2.

       <?xml version="1.0" encoding="utf-8"?>

       <vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List" xmlns="http://www.aveva.com/VNET/eiwm">

       <Template>

       <ID>SearchConfigurationExamples_null.xml</ID>

       <Object>

       <ID>[classid]</ID>

       <ClassID>SEARCH CONFIGURATION</ClassID>

       <Characteristic>

       <Name>Body</Name>

       <Value>

       <![CDATA[ [bodyattributevalue] ]]>

       </Value>

       </Characteristic>

       <Association type="is a search configuration for">

       <ClassID>[classid]</ClassID>

       </Association>

       </Object>

       </Template>

       </vl:VNETList>

9. Open Import Controller and update the configuration file, see Copying Sample Configurations.

10. Repeat steps 1, 2 and 4 for each set of filters you want to create.

11. After you have configured the filters, you can delete the saved searches you created in step 2, to avoid cluttering the search list.

12. You may need to restart IIS to see the changes in the AIM Dashboard, depending on your refresh intervals.

Search Columns

Search columns are represented in the search results grid, while you perform a search in the AIM Dashboard.

Example search columns:

Defining Your Own Search Columns

To define your own search columns:

13. Create a new XML file.

    For example: SearchConfigurationExamples_null.xml

    Note: Make sure you include "_null" at the end of the filename to avoid the application searching for a non-existent XSLT file.

14. Save it to the Staging Area location:

    For example:

    [installation folder]\SampleData\IPE Staging Area\SampleConfiguration. See also Copy Sample Configurations.

15. Create a saved search, (you must have the CreateAdvancedFind Right):

    21. Log on to the AIM Dashboard and select Search.

    22. In the Type list, select the category you want to create filters for.

    23. Select Advanced…

    24. Select the type of filter you want to add.

    25. Select an item from the list.

    26. Select Prompt?

    27. Repeat steps d-f for each filter you want to add.

    28. Select Save Search.

    29. Enter an ID (name) for the search, and then select Save.

16. Copy the body attribute of the saved search:

    30. Open the AIM Admin Tool.

    31. In the Class Library pane, search for general find.

    32. In the Object of Class pane, select the search created in step 3.

    33. In the Manager pane, expand Attributes.

    34. Select Edit Object Attributes.

    35. Copy the Value field of the Body attribute.

17. Go to the XML file you created in step 1, and modify it using the syntax below (as found in the original file):

    36. For <ID> and <ClassID> type the Class ID [classid]of the search category. For example PUMP.

    37. For <Value>, inside the CDATA brackets, paste the [bodyattributevalue] that you copied in step 4.

        <?xml version="1.0" encoding="utf-8"?>

        <vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List"

        xmlns="http://www.aveva.com/VNET/eiwm">

        <Template>

        <ID>SearchConfigurationExamples_null.xml</ID>

        <Object>

        <ID>[classid]</ID>

        <ClassID>SEARCH CONFIGURATION</ClassID>

        <Characteristic>

        <Name>Body</Name>

        <Value>

        <![CDATA[ [bodyattributevalue] ]]>

        </Value>

        </Characteristic>

        <Association type="is a search configuration for">

        <ClassID>[classid]</ClassID>

        </Association>

        </Object>

        </Template>

        </vl:VNETList>

18. Create an Export Definition (You must have the CreateExport Right):

    38. Log on to the AIM Dashboard.

    39. In the Global Navigation Panel, select Export.

        The Export Panel opens, docked in the Dashboard.

    40. In the drop-down box, select the arrow to select an Export Definitions.

    41. Go to the left-bottom corner, and select Create.

        The Export Definition window opens.

    42. Select the Add icon for Export Columns, and then select the new Export Columns.

        The newly added Export Columns appear as a list.

    43. To edit the name of the Export Columns, select Modify Label.

    44. Enter an ID (name) for the Export Definition.

    45. To save the Export Definition, select Save.

19. Copy the body attribute of the Export Definition:

    46. Open the AIM Admin Tool.

    47. In the Class Library pane, search for GENERAL EXPORT DEFINITION.

    48. In the Object of Class pane, select the Export Definition created in step 6.

    49. In the Manager pane, expand Attributes.

    50. Select Edit Object Attributes.

    51. Copy the Value field of the Body attribute.

20. Go to the XML file you created in step 1.

21. Paste all the Projection tags from copied Body attribute, after Criteria tag inside <Projection></Projection> tag.

22. Save the file, and then process through Import Controller.

    Note: The examples are available by default at the following path:

    [installation folder]\SampleData\IPE Staging Area\SampleConfiguration\SearchConfigurationExamples_null.xml

The following is one of the examples for search column configuration:

<?xml version="1.0" encoding="utf-8"?>

<vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List" xmlns="http://www.aveva.com/VNET/eiwm">

<Template>

<ID>SearchConfigurationExamples_null.xml</ID>

<Object>

<ID>PUMP</ID>

<ClassID>SEARCH CONFIGURATION</ClassID>

<Characteristic>

<Name>Body</Name>

<Value>

<![CDATA[<?xml version="1.0" encoding="utf-16"?>

<Search xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<VersionNumber>5.0</Version>

<Criteria>

<PropertyProjection xsi:type="ItemIdentifierCriteria">

<ItemIdentifierType>Id</ItemIdentifierType>

<BooleanOperator>AND</BooleanOperator>

<Handle>0</Handle>

<Value>%</Value>

<ValueOperator>Like</ValueOperator>

</PropertyProjection>

<PropertyProjection xsi:type="ItemIdentifierCriteria">

<ItemIdentifierType>ClassId</ItemIdentifierType>

<BooleanOperator>AND</BooleanOperator>

<Handle>0</Handle>

<Value>PUMP</Value>

<ValueOperator>Equals</ValueOperator>

</PropertyProjection>

</Criteria>

<Projection>

<PropertyProjection xsi:type="ItemIdentifierProjection">

<Label>ID</Label>

<ItemIdentifierType>Id</ItemIdentifierType>

</PropertyProjection>

<PropertyProjection xsi:type="ItemIdentifierProjection">

<Label>Type</Label>

<ItemIdentifierType>ClassName</ItemIdentifierType>

</PropertyProjection>

<PropertyProjection xsi:type="AttributeProjection">

<Label>Installed Power</Label>

<AttributeId>Installed Power</AttributeId>

<AllValues>true</AllValues>

<Units>kW</Units>

</PropertyProjection>

</Projection>

</Search>]]>

</Value>

</Characteristic>

<Association type="is a search configuration for">

<ClassID>PUMP</ClassID>

</Association>

</Object>

</Template>

</vl:VNETList>