| Agile Product Lifecycle Management Getting Started Guide Release 9.3.6 E71144-01 |
|
 Previous |
 Next |
| Agile Product Lifecycle Management Getting Started Guide Release 9.3.6 E71144-01 |
|
Previous |
Next |
This chapter provides basic information about Agile Reports and how to use them. Refer to the appropriate Agile PLM solution user guide for information about specific reports for each solution. For a list of Agile PLM solutions, see "Overview of the Agile PLM Suite."
Reports provide you with the basic information you need to analyze your business processes. By accessing and summarizing this information in a meaningful way, reports provide an insight into your business processes and can help guide better-informed decisions. Agile PLM provides a robust reporting platform that lets you:
Measure and monitor business performances using standard out-of-the-boxes reports. These standard reports capture the best practices in product lifecycle management business processes.
Configure reports with Agile's custom reporting to obtain the specific information you need.
Use a single point of access to all relevant reports—even those developed outside of the Agile PLM application—through Agile's external reporting capability.
Agile PLM provides the following types of reports:
Table 7-1 Agile PLM report types
| Report type | Descriptions |
|---|---|
|
Standard Reports |
Standard reports provide you with the information you commonly need to analyze your business processes. You select predefined criteria and specify the results you want. Each solution has its own set of reports. The user guides describe specific reports. For more information, see "Working with Standard Reports." |
|
Custom Reports |
You can create custom user—specific or company—specific reports directly within Agile. You define your query using the Query Definition feature, which is similar to an Advanced Search. The custom reports provide a high level of flexibility. You can select which objects to report on, define the filtering criteria, and specify report output. For more information, see "Working with Custom Reports." |
|
External Reports |
You can create reports outside of Agile using any third-party solution, such as SDK or other tools. You can then create linked access directly within Agile to launch those external reports. This is accomplished through configuring process extensions in Agile Administrator and adding URLs. For more information, see "Working with External Reports" and see Agile PLM Administrator Guide. |
The reports that you are allowed to manage or run, and the content of those reports, are affected by the privileges assigned to you, for both business objects and report objects.
You can create, view, edit and delete reports depending on the roles and privileges assigned to you. To run a report on a particular type of object, a user must be granted the following privileges:
Business object privileges
If you do not have the Discovery privilege for a given business object, you cannot include that object in a report. Parts for which you do not have the Discovery privilege are displayed in the same way as they are displayed on BOMs.
All the Discovery privileges that are set up for your Agile content will be observed when you run a report with that content, including all Discovery-related SmartRule settings and warnings that the Agile administrator has specified. For more information about Discovery privilege and SmartRules, see Agile PLM Administrator Guide.
Attachment thumbnails are not support for reports.
Report object privileges for standard reports
To run and view standard reports, you must have Run Report, Discover, and Read privileges for the standard report you want to run. Agile supplies some predefined roles that provide the ability to use specific types of business objects and to run standard reports relating to those business objects. For example, depending on your assigned roles, you may be able to run standard reports in the Products Reports folder, but not standard reports in the Quality Reports folder.
Report object privileges for custom reports
In addition to Run Report, Discover, and Read privileges, custom reports require additional privileges: Create, Delete, Modify. The Undelete, SaveAs and Send privileges provide additional custom report capabilities.
Report management privileges
To modify and delete report schedules and layouts, or to create and delete global reports folders, you need the Manage Report privilege.
To manage Static Template framework you need the Manage Report Templates privilege along with the Administrator and Manage Report privileges. In addition to performing the static template management you can also Create, Edit, Remove, Get, and Replace template files.
The Oracle Agile-provided predefined roles Report User and Report Manager contain the privileges you need to work with custom reports.
|
Note: In addition to assigning Oracle Agile-provided predefined roles, the Agile administrator can create customized roles for your company. Your assigned roles (either predefined roles or customized roles) determine which types of standard reports you can run and whether you are able to create and run custom reports. |
For more information about the privileges that affect reports or about roles and predefined roles, see Agile PLM Administrator Guide. If you have questions about your assigned roles and privileges or about your ability to run reports, contact the Agile administrator.
The General Info tab contains the general information about the reports. It has the following fields by default; the Agile administrator may have modified the fields:
Name – the name of the report.
Report Type – indicates the report type (subclass) for each class of reports.
Standard Report Type – indicates the standard report type, either Standard or Administrator.
Custom Report Type – indicates the custom report type (subclass). The default is Custom Report; your Agile administrator may define additional custom report types.
External Report Type – indicates the external report type (subclass). The default is External Report; your Agile administrator may define additional external report types.
Description – text that describes the report.
Folder – when the General Info tab is in edit mode, click the Launch Palette button to specify the report folder location. You can choose to share or not share the report folder location with users.
Query Definition – (Custom Reports only) lets you define criteria on which to base the search.
Process Extension – (External Reports only) a drop-down list of Process Extensions that are set by your administrator.
Lifecycle Phase – the lifecycle phase of the report: Active or Inactive.
Custom Report – the lifecycle phase is Inactive if the report cannot be executed because it does not have a query defined or a layout defined yet.
External Report – the lifecycle phase is Inactive if no Process Extension is defined, and the report cannot be executed.
Create Date – the date the report was created.
Modified Date – the date the report was last saved.
Create User – the name of the user who created the report. This field is blank on standard reports.
This tab has the following buttons standard:
Edit – appears when the General Info tab is not in edit mode. To edit the General Info tab, click Edit.
Custom reports include the following General Info tab edit variations:
Edit Information – appears when the custom report General Info tab is not in edit mode and you place the pointer over the Edit button. To edit the General Info tab, click Edit Information.
Edit Query – appears when the custom report General Info tab is not in edit mode. To edit the query, click Edit Query. Make any changes to the query on the Define Query dialog. To save changes that you made on the Define Query dialog, click Save.
Save – appears when the General Info tab is in edit mode. To save the changes that you made to the tab while it was in edit mode, click Save.
Cancel – appears when the General Info tab is in edit mode. To undo the changes that you made to the tab while it was in edit mode, click Cancel.
You can use the Actions menu on the General Info tab to perform various actions on the standard report. These commands are Bookmark, Save As, Delete, Copy URL to Clipboard, Send, and Sharing.
For more detailed information about bookmarking and other commonly used functions, see Chapter 2, "Navigating in Agile Web Client."
Some standard reports do not include a Layout tab; the layout is predefined for you. For example, the IP Transfer does not include a Layout tab.
Use the Layout tab to add or modify a standard report or a customized report layout with the fields your business requires in the required order.
To create a layout, click Add.
To delete a layout, select the appropriate row, and click Remove.
To modify a layout, click the layout name link to open the layout definition palette.
To edit the information on the Layout tab, double-click an editable table cell and use the Web Client table editing features.
Standard report layouts
Each standard report that includes a Layout tab which has a default layout. If you have the appropriate privileges, you can edit the default layout.
You can create layouts for standard reports that are available only to you (personal layouts), or you can make the layouts available to all users (global layouts).
To edit the layout fields, click the layout name link to open the layout definition palette. On the layout Format tab, you can select fields from the Hidden Fields list. Some standard report layouts allow you to select values for a main heading and an additional subordinate heading. For more information, see "Editing Standard Report Layouts."
Custom report layouts
You can use the custom report default layout to create a new custom report. You can create layouts for custom reports that are available only to you (personal layouts) or you can make layouts available to all users (global layouts).
To edit the layout fields, sorting and grouping, click the layout name link. On the layout definition Format tab, you can select fields from the Hidden Fields list. You can change the filter criteria on the layout definition Sort tab. For more information, see "Creating Custom Report Layouts."
The Layout tab contains the following buttons:
Web Client table editing features – lets you edit the attributes that appear in the Layout table: name, access, paper size, and orientation. Double-click any editable cell to begin editing.
Remove – deletes the layouts you have selected.
Add – lets you create a layout using the Add Layout palette.
The Layout tab has the following fields by default; your Agile administrator may have modified the fields:
Name – the name of the given layout.
Access – indicates whether the layout is available to all users (Global) or only to you (Personal).
Paper Size – the size of the paper the report will be printed on, such as Legal or Letter.
Orientation – the page orientation: Landscape or Portrait.
Owner – the name of the user who created the report.
To edit the Layout tab table:
Display the Layout tab.
Double-click any editable cell. The table is edit mode.
In the Name, Access, Paper Size, and Orientation fields, make the desired modifications. You can use the Fill commands in the More menu.
Click Save.
|
Note: External reports do not have a Layout tab. The third-party solution that generates the report also defines the report layout. If you have questions about external reports on your Agile PLM system, contact your Agile administrator. |
Use the Layout tab Add command to create a new layout for a standard report.
Some standard report layouts include two headings in both the Hidden Fields list and in the Displayed Fields list. The values under the first header are field attributes of the object the report is intended to locate. The values under the second header are field attributes of objects that are subordinate to the report object. For example, in layouts for the Change Activity report, the values under Main Header Attributes are fields of the change objects upon which Agile PLM is reporting. The values under the Affected Items header are fields of the affected items of each change that appears in the report.
When you run the Change Activity report, each change is listed in its own row. Under each change row are rows with a different background color that list each of the affected items of the change; these affected items appear on the Affected Items tab of the change object. In a similar manner, the Item Manufacturers report has a header for item field attributes and a subordinate header for field attributes of the manufacturer parts that are listed on the item's Manufacturers tab.
When you create a standard report layout with multiple headers, keep these tips in mind:
You can sort each header section independently. For example, you can sort the attributes under the main header without affecting the order of the attributes under the subordinate header.
The Hidden Fields list is also organized by headers. You must select values under the appropriate Hidden Fields header to add it under the corresponding Displayed Fields header.
Attributes under one header cannot be moved to be under a different header, although you can select as many attributes as you want under each header.
You are not required to specify any attributes under the subordinate header. For example, in a Change Activity report, if there are no values under the Affected Items header in the Displayed Fields list, then no affected items will be listed on the report; only a list of changes will appear on the report.
The Change Package report, which assembles all the information about a change in an easy-to-read, printable format, includes more than two headers in the Hidden Fields and Displayed Fields lists. Each tab of the change object has a header (for example, Cover Page, Affected Items, or Workflow). In addition, depending on which type of change you select in the Layout Type drop-down list, additional headers may also be available. For example, under Affected Items.BOM you can select field attributes of the items that appear on the BOM tabs of the affected items listed on the change's Affected Items tab. For example, you might select Items.BOM.Qty and Items.BOM.Find Num.
Use the Add command on the Layout tab to create a new layout for a custom report.
To create a custom report layout:
In the navigation pane, select the report you want customize. Click the Layout tab, and then click Add. The Add Layout palette appears.
On the layout palette Properties tab:
Type a name for the layout.
In the Access list, select the location for the layout. Your report layout can be Global—available to all—or Personal—available only to you.
Select the paper size and orientation from the corresponding drop-down lists.
On the layout palette Format tab, select the fields you want in the report.
To add values to the Displayed Fields list, select them in the Hidden Fields list, and double-click (or click the right arrow button).
To remove values from Displayed Fields list, select them and double-click (or click the left arrow button).
To change the order of fields, select a field and use the up arrow or down arrow button to move it.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Displayed Fields list nor in the Hidden Fields list. |
On the layout palette Sort tab, you can specify how you want the report data to be sorted. Select an attribute, and then choose Ascending or Descending to specify the sort order. You can also select the Group check boxes to further organize the report data.
The first level Attribute sort setting is applied to all the report rows.
The second level Attribute sort setting is applied if there are any ties in the first level of sorting.
The third level Attribute sort setting is applied if there are any ties in the second level of sorting.
Group organizes the report by grouping the results according the value selected in the sort-by list.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Sort tab Attributes lists. |
Click Save.
|
Important: Avoid using special characters in reports using BI Publisher, as they tend to fail. |
To create a standard report layout:
In the navigation pane, select the report you want customize. Click the Layout tab, and then click Add. The Add Layout palette appears.
Type a name for the layout.
Select a format for the generated report from the Output Format list. Choose from a list of formats – PDF, WORD, EXCEL, HTML, and STANDARD.
|
Note: The Output Format list appears only on specific reports. If you do not see the Output Format list, ignore this step. |
On the layout palette Properties tab:
Type a name for the layout.
In the Access list, select the location for the layout. Your report layout can be Global—available to all—or Personal—available only to you.
Select the paper size and orientation from the corresponding drop-down lists.
If there is a Layout Type list, choose a layout type from the list. For example, the Change Activity report lets you create layouts for change orders and price change orders.
|
Note: The Layout Type list appears on only a few specific report layouts. If you do not see a Layout Type list, ignore this step. |
On the layout palette Format tab, select the fields you want in the report.
To add values to the Displayed Fields list, select them in the Hidden Fields list, and double-click (or click the right arrow button).
To remove values from Displayed Fields list, select them and double-click (or click the left arrow button).
To change the order of fields, select a field and use the up arrow or down arrow button to move it.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Displayed Fields list nor in the Hidden Fields list. |
On the layout palette Sort tab, you can specify how you want the report data to be sorted. Select an attribute, and then choose Ascending or Descending to specify the sort order. You can also select the Group check boxes to further organize the report data.
The first level Attribute sort setting is applied to all the report rows.
The second level Attribute sort setting is applied if there are any ties in the first level of sorting.
The third level Attribute sort setting is applied if there are any ties in the second level of sorting.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Sort tab Attributes lists. |
Group organizes the report by grouping the results according the value selected in the sort-by list.
If there are multiple headers in the Hidden Fields and Displayed Fields lists, select the appropriate values under each header and arrange them in the order you want. For more information, see "About Standard Report Layouts with Multiple Headers."
|
Note: Multiple headers do not appear on all standard report layouts. If you see only one header (for example, Main Header Attributes) in the Selected Values list, ignore this step. |
When you are finished, click Save.
You edit a report layout in the layout definition palette. For information about how to change the information in the fields on the Layout tab, see "Layout Tab."
To edit a standard report layout:
Display the layout definition palette in one of the following ways:
In the navigation pane, select the report you want customize. Click the Layout tab, and then click the name link for the layout you want to edit. The layout definition palette appears.
Select the report you want to customize. Click the Execute button. On the Select Layout and Configuration page of most Report wizards, click the Edit button to the right of the Layout field. The layout definition palette for the selected layout appears.
Change the fields you want the report to include, as necessary. On the layout palette Format tab:
To add values to the Displayed Fields list, select them in the Hidden Fields list, and double-click (or click the right arrow button).
To remove values from the Displayed Fields list, select them and double-click (or click the left arrow button).
To change the order of fields, select a field and use the up arrow or down arrow button to move it.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Displayed Fields list nor in the Hidden Fields list. |
If there are multiple headers in the Hidden Fields and Displayed Fields lists, select the appropriate values under each header and arrange them in the order you want. For more information, see "About Standard Report Layouts with Multiple Headers."
Click Save to save your changes to the layout.
You edit a report layout in the layout definition palette.
To edit a report layout:
Display the layout definition palette in one of the following ways:
In the navigation pane, select the report you want customize. Click the Layout tab, and then click the name link for the layout you want to edit. The layout definition palette appears.
Select the report you want to customize. Click the Execute button. On the Select Layout and Configuration page of most Report wizards, click the Edit button to the right of the Layout field. The layout definition palette for the selected layout appears.
Change the fields you want the report to include, as necessary. On the layout palette Format tab:
To add values to the Displayed Fields list, select them in the Hidden Fields list, and double-click (or click the right arrow button).
To remove values from the Displayed Fields list, select them and double-click (or click the left arrow button).
To change the order of fields, select a field and use the up arrow or down arrow button to move it.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Displayed Fields list nor in the Hidden Fields list. |
On the layout palette Sort tab, change the sort order and select or clear the Group check box as necessary.
|
Note: Because LargeText fields cannot be included in reports they do not appear in the Sort tab Attributes lists. |
Click Save to save your changes to the layout.
Use the Schedule tab when you want a report to run based on a specific schedule or on a specific date and time. You can add, edit, or delete the schedules.
You must have the appropriate privileges to work with the Schedule tab.
This tab has the following actions and buttons:
Web Client table editing features – lets you edit the schedule attributes that appear in the Schedule tab table.
Remove – deletes the schedules you have selected.
Add – lets you add a new schedule frequency (Run Once, Every Day, Weekdays, Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays, Sundays, First Day of the Month, and Last Day of the Month) to the report schedule using the Report wizard.
View Details – click to view the schedule details of the selected schedule table row.
The Schedule tab has the following fields by default; your Agile administrator may have modified the fields:
Enable – double-click to edit; select Yes to activate the schedule and run reports automatically, or select No to disable the automatic schedule.
Schedule Frequency – a drop-down list with the following options: Run Once, Every Day, Weekdays, Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays, Sundays, First Day of the Month, or Last Day of the Month.
Schedule Time – the date and time when the report should run. You specify the date only if the Schedule Frequency option is set to Run Once. For any other schedule, you specify only the time.
Share W/Users – list of users who will be notified when the report is generated (based on the schedule) and who will have access to the reports generated from the schedule.
Owner – the name of the user who created the schedule.
To create a schedule:
Display the Schedule tab for the report.
Click Add. The Add Schedule wizard appears.
Follow each step in the wizard to define and specify your report. These are the same wizard steps you use when you click the Execute button to run the report. For details about running specific reports, see the appropriate user guide.
The last wizard step in the Add Schedule wizard is the Define Schedule step.
On the Define Schedule page, in the Schedule drop-down list, select Run Once, or select the recurring day you want the report to run.
If you select Run Once, click the calendar button and select a date. Specify the time you want the report to run. The default time is 12:00 a.m. To enter a time to run the report, use the time format hh:mm:ss and select the appropriate option (AM or PM). For example, to run the report at 8 p.m., enter 08:00 and click the PM option.
If you select a recurring day you want the report to run, you can specify a time to run the report. The default time is 12:00 a.m. Use the time format hh:mm:ss and select the appropriate option (AM or PM). For example, to run the report at 8 p.m. enter 08:00 and click the PM option.
Click the Open Palette icon next to the Users field to select the names of users or user groups who will have access to this report.
Click Finish.
|
Note: External reports do not have a Schedule tab. If there is a schedule, the third-party solution that generates the report also defines the report schedule. If you have questions about external reports on your Agile PLM system, contact the Agile administrator. |
After you run a report, you can save the report results. The Historical Report tab displays all previously saved report instances with a date and time stamp and the name of the user who executed the report. To share a report, select the appropriate check box and click Sharing. To delete or view a report, select the appropriate check box, and click Delete or View.
To save the generated report as a historical report, click the Save button in the Report Output window. If you do not save a report, once you close the report results window, you cannot access that instance of the report again.
If a historical report is generated according to a schedule, then the Type field in the report displays Schedule Generated.
This tab contains the following buttons:
Sharing – lets you specify other users who can view the selected report instance.
Remove – deletes the selected report instance.
View – lets you view the generated Report Output window of the selected report.
More – table edit Fill commands.
The Historical Report tab has the following fields:
Create Date – indicates the date and time the report was generated.
Type – indicates if the historical report is saved by the user or generated by a schedule.
Share W/Users – users who can view this report instance. Edit this field to modify (add or remove) users who can view the selected report instance.
Owner – the name of the user who created the report.
External reports do not have an Historical Reports tab. If you have questions about external reports on your Agile PLM system, contact the Agile administrator.
Standard reports provide you with the information you commonly need to analyze your business processes. You select predefined criteria and specify the results you want. These preconfigured reports are applicable in most situations. You can run them as they are, modify the default layouts, or create your own layouts. You can run Agile reports from Agile Web Client or Java Client.
When you run standard reports from Java Client, Agile PLM opens a Web Client window with the selected report displayed.
In the REPORTS drawer in the left navigation pane, click the Expand icon next to the Reports and Analytics folder to view the top-level folders such as Products Reports and Process Reports. You can access reports from these folders. (Click the Expand All icon to expand all the reports folders.)
To execute a standard report, open the report, click the Execute button and follow the wizard steps. If the standard report does not have any wizard steps, the report is generated immediately after you click the Execute button.
For information about standard report layouts, see "Creating a Standard Layout" and "Editing Standard Report Layouts."
For information about scheduling standard reports, see "Schedule Tab."
For information about standard reports Historical Reports tab, see "Historical Report Tab."
For information about running standard reports, refer to the appropriate user guide, listed in the following table.
The Standard Reports folder contains the predefined folders as listed in the following table.
Table 7-2 Standard Reports subfolders
| Report folder | Description and location to find more information about specific reports |
|---|---|
|
Product Reports |
Contains the standard Product Collaboration (PC) reports. For more information about these reports, see Product Collaboration Guide. |
|
Administrator Reports |
Contains all administrator user reports. For more information about these reports, see Agile PLM Administrator Guide. |
|
Sourcing Reports |
Contains the standard Product Cost Management (PCM) reports. For more information about these reports, see Product Cost Management User Guide. |
|
Quality Reports |
Contains the standard Product Quality Management (PQM) reports. For more information about these reports, see Product Quality Management User Guide. |
|
Process Reports |
Contains reports for changes and transfer orders. For more information about these reports, see Product Collaboration Guide. For more information about the IP Transfer Report, see Agile Content Service User Guide. |
|
Program & Portfolio Reports |
Contains standard reports for Product Portfolio Management (PPM) solutions. Sub folders include End User Reports, Portfolio Reports, Program Reports, and Resource Pool Reports. For more information about these reports, see Agile Product Portfolio Management User Guide. If your company has installed Portfolio Analytics, then the Portfolio Analytics reports appear in the Analytics folder under the Program & Portfolio Reports folder. For more information, see Portfolio Analytics User Guide. |
|
Compliance Reports |
Contains the standard Product Governance & Compliance (PG&C) reports. For more information about these reports, see Agile Product Governance and Compliance User Guide. |
You can create user-specific or company-specific reports directly within Agile PLM. When you define your query on the Define Query step of the Create Custom Reports wizard, the search looks for objects with fields that match the search conditions that you set up.
You can customize reports in the following ways:
Change the way each report looks by editing the report layout.
Specify a schedule (date and time) when you want a report to be executed.
Save and view report instances.
See what actions have been taken on the report.
If you have the appropriate roles and privileges, you can create any user-specific or company-specific custom report by using the Create New command on the main toolbar.
To create a custom report:
Choose Create New > Report > Custom Reports.
The Create Custom Reports wizard appears. Select the subclass, and type a name for the report.
Click Next.
The Define Query step appears. In this step, click the appropriate option to create a new query or to select an existing query (saved search), complete the remaining fields, and click Next.
For information about the options for defining a query, see "Creating a New Query."
The Select Output Fields page appears. In this wizard step, specify which fields to include in the report and how to sort the results table. To include a field, move it to the Displayed Fields list. In the Attribute sort lists, select the attributes for sorting and specify how you want the report data to be sorted. Select Ascending or Descending to specify the sort order. You can also select the Group check boxes to further organize the report data.
|
Note: Because LargeText fields cannot be included in reports they do not appear in Displayed Fields list nor in the Attribute sort lists. |
The settings specified in this step are saved as the Default Layout for the report. For more information about custom report layouts, see "Creating Custom Report Layouts."
Click Finish when you have completed the last step.
View general information about the newly created report on the General Info tab.
Click Edit Information to modify the General Info tab.
On the General Info tab, enter a description. Click the Launch Palette icon next to the Folder field to select a folder in which to store the report. The Folder palette appears. All the available report folders are listed; expand the folders to find the one you want. Double-click a folder to select it. Select one or more folder locations. Press Escape to close the palette.
When you have finished editing the General Info tab, click Save.
To create your own query, select the Create New option on the Define Query step of the Create Custom Report wizard. For a new query, complete the Search Type and Search For fields, and specify at least one search condition. Click Next.
The search type options include the following drop-down lists:
Base Class list – the broad definition of the type of object that you want to search for; for example, Items, Changes, or Manufacturer Parts.
Class or Subclass list – the type of object (class or subclass) that you want to search for; for example, ECO, document, or manufacturer part.
Search Type list – the type of search that you are creating. An Object search finds Agile objects that match the search conditions. A Where-used search finds the assemblies that use the items defined by your search criteria. The assemblies in which the defined items are used appear in the search results.
Related Content list – when you choose a Relationships search type, this additional list lets you select the related content for the search.
The search criteria options include:
Match Case – if checked, the search will be case-sensitive; that is, it will find uppercase or lowercase values exactly the way that you enter them.
Clear button – clears the information on this page.
Attribute – the field on which you want to search. The contents of this list depend on the class or subclass you have chosen for the query.
Operator – a search operator, such as Equal To or Contains. The contents of this list depend on the value specified in the Attribute field.
The Prompt field – select this box to prompt the report user to fill in the value when the custom report is executed. If you select the check box, the Value field is disabled and you do not enter a value now as you create the custom report query; however, when you execute the custom report, you will be prompted to enter a value in a wizard step. See also "Executing Custom Reports."
Value – the value for which you want to search. Click the field to specify a value.
Join – used to specify multiple search conditions. If you want both conditions to be met, select And. If only one condition must be met, select Or.
Grouping menu list – Choose Add ( ), Add [ ], Remove [ ]and Remove ( ) options to tell Agile PLM to group or ungroup conditions. In most searches, use parentheses to group conditions. Use brackets to group conditions in workflow searches.
For more information about defining a query, see Chapter 8, "Finding Agile Data with Searches."
|
Note: Delete invalid data for queries as the Use Report subclass tends to hang if the data submitted is large. |
To edit a Query:
Click Edit Query on the General Info.
In the Define Query wizard, edit the necessary fields.
|
Note: Layout settings can be affected when you edit a query. If you edit the values in the Base Class, Subclass, Search Type, or Related Content lists, custom layout settings are reset to default layout settings. If you edit only the fields in the search criteria conditions, custom layout settings are retained. |
Click Save.
The General Info tab is then displayed with the latest details that have been entered in the Define Query wizard.
If you select the Use Saved Search button on the Define Query page:
Click the Launch Palette icon to select an existing search to customize.
In the displayed palette, locate the saved search you want to use.
Double-click the search to select it. Press Escape to close the palette.
On the Define Query wizard step, all the search criteria are copied from the saved search.
You can modify the criteria to suit your needs. Default Layout output fields are copied from the output display of the saved search.
You must have sufficient privileges to execute a report. For more information about roles and privileges, see the Agile PLM Administrator Guide. The report outputs are displayed only in Web Client.
To run a custom report:
Select the report that you want to execute, and click the Execute button.
In the report wizard, select a layout, or:
Click the Edit button to edit the selected layout.
Click the Create button to create a new layout.
For more information, see "Creating Custom Report Layouts."
When you are done with this step, click Finish. If the Finish button is disabled, click Next.
Select an Output Format. Choices include: Standard, PDF, Word, Excel, and HTML.
Click Finish.
If there are any parametric fields in the report, the Enter Parameter values dialog appears. Fill in the required information. Click OK.
If there are no parametric fields in the report, this wizard step is omitted.
If you selected the Standard report output, once the output appears, use buttons at the top of the Report Output window to save, export, or print the report.
Click the Print button to print the generated custom report.
Click the Export button to export the report as delimited text files (.CSV) or as Microsoft Excel Workbook files.
Click the Save button to save the report instance.
For more information, see "Historical Report Tab."
You can also use buttons to move from page to page in the report and to change the magnification.
If you selected the PDF, Word, Excel, or HTML output format, you are prompted to download the output file in the format you selected. You can use the features of the selected application (for example, Save As) to save the output file on your local drive.
|
Note: When a scheduled custom report fails, a custom report failure notification is sent to all the Users with Administrator privileges. |
When you no longer need a report, you can delete it from the report folder.
To delete a custom report:
Select the report you want to delete.
From Actions menu, choose Delete. A warning message appears asking you to confirm that you want to delete this report. Click OK.
To undelete a custom report:
Under Searches in the navigation pane, select Deleted Reports from the Recycle Bin Searches folder.
Open the deleted report you want to undelete.
From Actions menu, choose Undelete.
|
Note: Although the report users can run reports and do analysis on assigned projects, including those to which they do not have direct access, they cannot delete reports that they do not own. Only the report manager can delete reports that belong to other users. |
You can create reports and generate them from an external report engine. Process extension provides a URL address that can be initiated from within Agile PLM reports and that will launch the specified Web address. The Agile administrator sets the Process Extensions based on your requirements. If you have any questions or comments about the Process Extension settings, contact the Agile administrator.
If you have the appropriate roles and privileges, you can create an external report from the Create New command on the main toolbar. In Agile Web Client, you can connect to an external resource or URL to generate an external report. Before you create an external report, you must add the URL associated with the report to the Process Extension Library. For more information about Process Extensions, see the Agile PLM Administrator Guide.
To create reports in Agile Web Client, you must have the Create Reports privilege.
To create an external report:
Log in to Agile Web Client.
|
Note: You cannot create external reports in Agile Java Client. |
Click Create New > Reports > External Reports.
In the Create New dialog, select a subclass, and type a name for the report.
Click Save.
The newly created External Report object appears in the content pane with the General Info tab displayed. The tab is in edit mode.
Enter the following general information:
Description – Enter a brief description of the report.
Process Extension – Select a Process Extension. The Process Extension you select is associated with a URL, such as the location of Web-based report. The only Process Extensions that appear in this list are those that are designated as "Initiate From: External Reports" in the Process Extension Library.
Folder – Select a folder in which to store the report.
Click Save.
You must have sufficient privileges to execute a report; see "How Your Roles and Privileges Affect Reports." For more detailed information about roles and privileges, see the Agile PLM Administrator Guide.
To run the newly created external report, click the Execute button. The Process Extension that references a URL is invoked, and you see the Web page in a new browser window.
When you execute a report in the Standard output format, you see the report displayed in a new browser window. Once the report output appears, you can use buttons at the top of the Report Output window to save, export, or print the report.
Click the Print button to print the generated custom report.
Follow the on-screen instructions to print the report.
Click the Export button to export the report. Follow the on-screen instructions.
The report can be exported in one of two formats:
File type CSV (comma delimited text file)
File type Microsoft Excel Workbook.
Both file types can then be opened in Microsoft Excel. CSV files can also be opened with any application that uses the CSV file type.
To move from page to page, use the Page drop-down list and the Next Page, and Previous Page buttons.
To change magnification, use the Zoom In and Zoom Out buttons.
Click the Save button to save the report instance. The saved report instance appears on the Historical Report tab.
For more information, see "Historical Report Tab."
Click the browser Close button to close the report window.
