Adding/Editing Query Parameters

The following example walks you through the process of defining query parameters. It uses Test Query as an example.

Figure 25.

1. Click the Edit Parameters button . The Query Parameters dialog box appears.

   

   

   Figure 26.

2. Click the New button to add a parameter. Enter the following information:

   Name: doc_state

   Label: Document State

   Default Value: *

   

   

   Figure 27.

3. Close the dialog box to save the parameter information.
4. Select the Document level of the relationship structure and click the associated Filter button to filter using the parameter you just created.
5. Set any other filters and sort orders that you need.
6. Save the Query definition.

The parameters that you add to the Query definition appear in the Map Parameters dialog box in the Tree Grid View.

Figure 28.

Once mapped, the parameters become available in the Tree Grid View under the Modify Parameters button.

Figure 29.

This allows the entry or selection of the configured parameters from the Tree Grid View, setting query parameters in the underlying Query Definition from the Tree Grid User Interface at runtime.

Parameters can also be used for previewing query results when Executing a Query in the Query Builder. See Section Executing Queries for an example of this.

For structures of versionable Items, like Part and Part BOM Structures, it is useful to examine query results in a Tree Grid View by either the latest versions, or by released versions only, or a combination where if no released components exist then the latest (un-released) version is displayed in the overall structure. The default is to display the structure as it is stored in the database without any optional resolution.

These Resolution Modes are provided to Part BOM Query Definitions (and Tree Grid Views) by a special Parameter which is pre-configured OOTB. Structure Resolution can be applied to any Item Relationship structure of versionable Items that follows the same rules as Part BOM structures: the Released Life Cycle State (is_released Boolean), incremental Revisions with interim versioned generations, etc.

The Default Resolution Mode uses the versions of related child Parts as stored on the BOM Relationships. This is the standard resolution in Aras Innovator.

Figure 30. The Default resolution mode

When the Latest resolution mode is selected, the structure is resolved starting from the top using the latest versions of child items. When a child item is resolved to its latest version, then its child items are resolved using this resolution mode. This is done recursively.

The Latest resolution mode does not consider the released state of the child Parts.

Figure 31. Latest resolution mode

The latest revision D of Child B.2 (Preliminary) is shown where this Part version is in the Preliminary state, although the default structure under revision B of Child A (this structure) refers to revision B of Child B.2 (Released) as stored in the database. In other words, the Latest Resolution Mode dynamically provides a view to in-work changes to released parts that are not yet committed to the released structure.

When the Latest Released resolution mode is selected, the structure is resolved starting from the top using the latest versions of child items that are in Released state. When the child item is resolved to its latest Released version, then its child items are resolved using this resolution mode. This is done recursively.

If the related child item has no versions that are in Released state, then a blank row is displayed for that item. There is no further processing on that item.

Figure 32.

Latest Released resolution mode

The latest Released versions of child parts are resolved. A blank row is displayed for Child C because it has no version that is in the Released state.

When the Latest Released or Latest resolution mode is selected, the structure is resolved starting from the top using the latest versions of child items that are in Released state. If there are no versions that are in Released state, then the latest version is used. When the child item is resolved to a version, then its child items are resolved using this resolution mode. This is done recursively.

Figure 33.

Latest Released or Latest resolution mode

The latest Released versions of child parts are resolved. Child C does not have any version that is in the Released state. Therefore, its latest Preliminary version is resolved.

In Aras Innovator, the BOM Structure grid (a TGV under the BOM Structure tab in the Part form) is pre-configured with a Structure Resolution Parameter, thus it supports the Latest, Released, and Released or Latest modes out of the box.

Figure 34.

In the event you need to enable Structure Resolution for your Query Definition, you will need to add a Parameter that has a default value of Aras.Resolution.EntryPoint;Default, and then also follow the additional detailed steps for configuring Structure Resolution Parameters described in Section Structure Resolution Parameters.

Figure 35.

For more details and extensive examples of how Resolution Modes are applied in BOM Structures, Effectivity, and 3D Visualization please refer to the following documents:

• Aras 3D Visualization - Administrator Guide
• Aras Innovator Product Engineering - User’s Guide