Create Query Forms

To create a Query Form:

1. Ensure that you have got the QueryFormCreation permission.

2. Select the Query Forms icon in the Global Navigation Bar.

   

3. Select the Create button from the bottom of the Query Form dialog.

   

   The Query Form Designer appears.

   Knowing the Query Form Designer

The Query Form Designer is a web-based tool built into AIM Dashboard that allows those with the appropriate permission to create pre-defined searches based on certain applicable types.

The following table describes the various buttons or elements available on the Query Form Designer:

Selecting Applicable Classes

You must select the type of objects that the Query Form should search.

To select the applicable classes for a Query Form:

4. Select the Applicable Types drop-down list to see all possible class types.

5. Select the appropriate class type (for example, Equipment) from the list of values.

   

   After a class has been selected, you may add others by choosing the next from the list of Applicable Types.

   To remove a class, you may select thesymbol to remove it.

Adding Fields to a Query Form

To add a field to the query form:

6. Select the Add button to display possible field types.

   

   The following table lists the Query Form Fields and their descriptions.

   Query Form Fields	Description
   ID	Object identifier which will be selectable and will open in a new tab.
   Name	The object’s name
   Context	The object’s AIM context
   Revision	The object’s revision label
   Type ID	The object’s type identifier
   Type Name	The object’s type name
   Alias	The object’s aliases
   Incidental Type ID	The type ID for its incidental class.
   Type Scheme	The scheme type
   Lifecycle	The object’s current lifecycle
   Attribute	An attribute to display
   Related Item	Display a related item (if present)
   Blank Field	A blank space

7. After you have added a field type, it places a new field onto the Query Form Designer.

8. To remove a field type, select thesymbol next to it.

   Every field has a label. The default label is always the individual field types identifier. For example, ID is always default to the text ID. However, you can change the label.

9. To do the label, select the Modify Label checkbox.

   After that, the label becomes editable.

   

   Depending on the type of field, there may be different options, as described in the following table:

   Options	Description
   List Values	Populates a drop-down list of values.
   Modify Label	Enables you to change the displayed label.
   Match All	Verifies the values of all the attributes with this name that belong to an object and its datasets, and only produces a match if they all have the same value. For example, use this option to find all objects where the attribute does not yet have a value either on the object or in any of its dataset by specifying an empty value and the Match All option.

   Note: Different Field Types may ask for additional information.

Lifecycle

Lifecycle requires the selection of a lifecycle group.

Attribute

Attribute requires selecting the source of the attribute. Item is the currently selected object’s own attributes, otherwise you must select a dataset that may be attached to the class object in which the attribute exists. Then you must select the individual attribute to display.

In the following example, the item’s own attribute is being returned and the attribute is Action.

Related Item

Related Item requires selection of an association type and a class of object that may be related to the current class. You will then be asked to add fields from the associated object class to display.

The Count Only checkbox enables you to return only the number of results rather than the values.

Saving the Query Form

After the query form has been built to your specifications, you can save the query form.

To do so:

10. Select the button to open the Save Query Form dialog.

    

    Note: The Type cannot be changed.

11. Type a unique ID for this query form. This is required.

12. Type a Name that will represent this query form in the list of Query Forms. This is optional.

13. In the Description text box, type a short description about this query form and its purpose. This is optional.

14. Select the button to complete the save action.