Type = How-tos, ; Topic = Reports and Dashboards,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = Supply Chain, IT, Operations, Regulatory Affairs, Quality, Commercial, Pharmacy, Project Management, Finance, Procurement,

Manage query objects

A Query Object is a critical component in OPUS Reports and Dashboards (ORD) that defines how data is retrieved from the underlying database. It serves as a blueprint for generating datasets that can be utilized in reports and dashboards. Query objects can be created from scratch or copied from the marketplace, allowing users to tailor their data retrieval processes to meet specific reporting needs. A query object can include a primary object and one or more related secondary, tertiary, or quaternary objects. Define these relationships once and reuse them across multiple reports.

This topic describes the steps required to create, save, and modify query objects.

Search for and view an existing query object

Search for a query object

Select the Main Menu icon.
Select Reports and Dashboards.
Select Query Objects in the side menu.
Select the desired catalog from the Query Objects drop-down:
- Company – Contains query objects that are tailored for a specific company.
- Marketplace – Contains query objects that are available across all companies and trade partners on the TraceLink network.
- All – Contains all Company and Marketplace query objects.
The screen refreshes and displays the Search Company, Search Marketplace, or Search All Query Objects table in the main content area, depending on the catalog selected.
Select the Filter button to search for a query object.
In the Filters push panel, fill in one or more of the following fields to filter the results:
- Application Name drop-down – The name of the application (e.g. Multienterprise Information Network Tower).
- Query Object Name field – The name of the query object.
- Primary Object field – The name of the main entity selected by Report Designers when creating a query object.
- Query Object Version Number field – The version number of the query object.
- State drop-down – The current state of the query object:
  - Released – (default) Displays query objects in the Released state.
  - Edit – Displays query objects in the Edit state.
- Is Latest drop-down – The version of the query object to be displayed:
  - True – (default) Displays only the latest version of the query object.
  - False – Displays all versions of the query object.
Select Apply.
The Filters panel closes and the main content area displays the results according to filters applied by the user. The applied filters appear above the results table in chips.

Tips

If the desired query object appears in the side menu, but no data displays in the main content area, then the user does not have a role with permission to view the data in the query object. Contact an Administrator for assistance in being assigned the correct role.

To remove a filter, select the Close button in the chip containing the filter.
To remove all filters, select Clear All.

Copy a marketplace query object

A Marketplace query object can be duplicated and modified to meet specific requirements. The existing structure and logic serve as a foundation for creating a customized query object that supports project-specific reporting needs.

Copy a query object

Select the Main Menu icon.
Select Reports and Dashboards.
Select Query Objects in the side menu.
Select the Marketplace catalog from the menu items.
The screen refreshes and displays the query objects in the main content area. By default, the page is sorted to include query objects that are Released and with the latest version.
Select the Filter button to search for a query object.
In the Filters push panel, fill in one or more of the following fields to filter the results:
- Application Name drop-down – The name of the application (e.g. Multienterprise Information Network Tower).
- Query Object Name field – The name of the query object.
- Primary Object field – The main object targeted for eventually building out a report.
- Query Object Version Number field – The version number of the query object.
- Is Latest drop-down – The version of the query object to be displayed:
  - True – (default) Displays only the latest version of the query object.
  - False – Displays all versions of the query object.
- State drop-down – The current state of the query object:
  - Released – (default) Displays query objects in the Released state.
  - Edit – Displays query objects in the Edit state.
Select Apply.
The Filters panel closes and the main content area displays the results according to filters applied by the user. The applied filters appear above the results table in chips.
Select the desired query object row in the search results table.
Select the Copy button on the Operations toolbar.
Select the Company option from the Catalog Type drop-down in the Copy push panel.
Enter a name in the Query Object Name field that clearly identifies the application and purpose.
Select Apply.
The new query object is created in the Company catalog and opens in the Edit state.

Tips

Review the object relationships or update them as needed. When finished, move the query object to the Released state so it can be used to create reports.
To remove a filter, select the Close button in the chip containing the filter.
To remove all filters, select Clear All.

Create and modify query objects

Create a query object

Select the Main Menu icon.
Select Reports and Dashboards.
Select Query Objects in the side menu.
Select the Company catalog from the Query Objects drop-down.
Select the New button.
Fill in the following fields in the General section:
- Query Object Name field – Enter a query object name.
- Application Name drop-down – Select the relevant application.
- Description field – Enter a description (optional).
- Primary Business Object drop-down – Select the business object for which to view data.
- Catalog Type drop-down – By default, Company catalog is selected.
Select the Add icon in the Relationship section.
Select a value from the Secondary Business Object drop-down.
Select the Save button.

The query object is created and saved in the Company catalog.

Tips

Select the Application Name value before selecting the Primary Business Object, as no options are available until an application is selected.
Enter a descriptive value in the Description field to help other users understand the query object’s purpose.
Select the Primary Business Object value before selecting a Secondary Business Object, as no options are available until the primary object is defined.
Add Secondary Business Object values only when additional related data is required for reporting.
Select Secondary Business Object values in sequence, as each level depends on the previous selection.
Limit the number of Secondary Business Object values to only what is necessary to avoid unnecessary complexity in the query.
Review object relationships after configuration to ensure the query object returns accurate and relevant data.

Modify an existing query object (Edit state only)

Select the Main Menu icon.
Select Reports and Dashboards.
Select Query Objects in the side menu.
Select the Company catalog from the Query Objects drop-down.
Select the Query Object name link in the search results table.
The screen refreshes and displays the View and Edit Query Objects screen in the main content area.
Select the Edit button.
Update the desired fields in the General section:
- Query Object Name field – Update the query object name.
- Application Name drop-down – Select the relevant application.
- Description field – Update the description (optional).
- Primary Business Object drop-down – Select the business object for which to view data.
- Catalog Type drop-down – By default, Company catalog is selected.
Select the Add icon in the Relationship section.
Select a value from the Secondary Business Object drop-down.
Select the Save button.

The query object is updated and saved in the Company catalog.

Tips

Select the Application Name value before selecting the Primary Business Object, as no options are available until an application is selected.
Enter a descriptive value in the Description field to help other users understand the query object’s purpose.
Select the Primary Business Object value before selecting a Secondary Business Object, as no options are available until the primary object is defined.
Add Secondary Business Object values only when additional related data is required for reporting.
Select Secondary Business Object values in sequence, as each level depends on the previous selection.
Limit the number of Secondary Business Object values to only what is necessary to avoid unnecessary complexity in the query.
Review object relationships after configuration to ensure the query object returns accurate and relevant data.

Tag end