Basic User Training Guide
IFS Energy and Resources (Deactivated)
IFS Energy & Resources
IFS Energy & Resources (Deactivated)
- 1 IFS Reporting for End Users Basic Training Guide 2.0
- 2 In this Guide
- 3 Course Overview
- 4 Lesson One: Introduction and Getting Started
- 5 Lesson Two: Creating an Ad Hoc View
- 6 Lesson Three: Creating a Report
- 7 Lesson Four: Navigating the Library
- 8 Lesson Five: Scheduling Reports and Dashboard and Saving Report Options
- 9 Appendix: Additional Resources
IFS Reporting for End Users Basic Training Guide 2.0
In this Guide
Course Overview
Course Description
Audience and Prerequisites
Learning Objectives
Lesson One: Introduction and Getting Started
IFS Reporting Overview
Logging In
Logging Out
Home Page
Menu Bar
Recently Viewed Items
Popular Resources
Products
Lesson Two: Creating an Ad Hoc View
Ad Hoc View Overview
Creating an Ad Hoc View
The Ad Hoc View Editor
Lesson Three: Creating a Report
Report Overview
Creating a Report
Editing Report Properties
Moving or Copying a Report
The Report Viewer
Formatting Columns (Tables only, not Crosstabs)
Conditional Formatting Columns (Tables only, not Crosstabs)
Filtering a Report (Tables only, not Crosstabs)
Sorting a Report
Moving, Resizing, and Hiding Columns (Tables only, not Crosstabs)
Lesson Four: Navigating the Library
Folders
Library Resource List
Searching the Library
Out-of-the-Box Ad Hoc Views, Reports, and Dashboards
Lesson Five: Scheduling Reports and Dashboards and Saving Report Options
Appendix: Additional Resources
Course Overview
This class will provide an overview of IFS Reporting from a user perspective. We look at how to access IFS Reporting content, create and format Ad Hoc Views and Reports, and schedule Reports and Dashboards.
This class is recommended for anyone who wants to gain experience with IFS Reporting. There are no prerequisites for this basic level course.
With successful completion of this course, students will be able to:
Log In and Log Out.
Navigate the Home Page.
Create an Ad Hoc View.
Create and Format a Report.
Navigate the Library.
Schedule a Report.
Lesson One: Introduction and Getting Started
IFS Reporting is a web-based reporting solution that is designed to work with multiple data sources from IFS products and can also display data from non-IFS products to support your reporting needs from a single platform. IFS Reporting uses TIBCO JasperSoft technology, which has an established user community and extensive website resources, including how to videos and articles. It is recommended that you use these resources to supplement the training you get from IFS.
For more information, visit the JasperSoft website: http://community.jaspersoft.com .
Your Home Page contains the following items, as in Figure 3:
Menu Bar
The menu bar options along the top of the Home page are available from every P2 Reporting screen.
Table 1. Menu Bar
Menu Bar | Menu Bar Description |
Opens the Home Page. | |
Library | Displays a list of all Ad Hoc Views, Reports, and Dashboards to which you have access. |
Admin | Organizations - Displays a list of organizations to which the user has access. |
Create | Launches the workflow for designing the selected object - Ad Hoc View, Dashboard, Data Source, Domain, or Report. |
Help | Launches the online help for TIBCO JasperSoft at http://help.jaspersoft.com . |
Log Out | Logs out the user and displays the P2 Reporting log in screen. |
Recently Viewed Items
This list displays links for up to ten recently viewed items, such as Reports, Ad Hoc Views, and Dashboards.
Popular Resources
The links listed here provide educational and support resources for JasperSoft that are supplemental to the training that you receive from P2.
Search Bar
Enter keywords from Descriptions or Titles of Reports, Adhoc Views, Dashboards, Data Sources or Domains.
IFS Reporting Products
To open a navigation window that will guide you through the content for this product, including Ad Hoc Views, Reports and Dashboards, click the product icon.
These icons can be clicked to open a window that helps you navigate the product's reporting content, including Ad Hoc Views, Reports and Dashboards. The window contains the unique categories of data for each product, as in Figure 4.
Figure 4. Data Categories for the Midcap Product
Lesson Two: Creating an Ad Hoc View
An Ad Hoc View can be used to explore data, and provides analysis options (such as slice, pivot, and filter) to help you recognize trends and outliers in your data. You can drill into specific details or analyze your data at a very high level.
Ad Hoc Views can also be used to create content for reports. After you create an Ad Hoc View, you - and other users with the proper permissions - can run the report. Once the report is generated you can view it to further refine the displayed information and personalize the look of the report in the report viewer. For more information on that process, see sections Creating a Report and the Report Viewer .
On the Menu Bar, click Create, and then Ad Hoc View.
On Select Data, expand the folders to view the Domains, and then click the Domain you want to use for your Ad Hoc View. Click Choose Data as in Figure 5.
On Choose Data, to select a data source and move all fields to the Selected Fields column, click the double arrow.
To select a data source and move specific fields to the Selected Fields column, highlight individual fields in the Source column, and then click the single arrow to select and move them to the Selected Fields column. To select a group of fields, hold down the Ctrl key and highlight the fields before clicking the arrow button.
(Optional). To filter data for the Ad Hoc View, click Pre-filters. In the Filters section, click and drag fields.
Select the conditional operator value for the field, and then select the field value(s) for the filter.
To save your changes click OK.
(Optional) To customize the display, click Display.
In the Customize the Display section, to rename a field, select the existing field name and type in your preferred field name.
To save your change click OK.
(Optional) To create a set of fields filters, and input controls that can be reused, click Save as Topic. The predefined set of fields, filters, and input controls are defined for a specific Data Source or Domain.
In the Save Topic section, type a name, description, and the location where you want to save the Topic.
To save your changes click OK.
The Ad Hoc View Editor is the interactive tool for exploring your data and designing views. Figure 6 and Table 2 explain the components of the Editor and their functionality.
Figure 6. The Ad Hoc View Editor Components
Table 2 Ad Hoc View Editor Components.
Component | Description |
Change Data Source or Fields | Change the Topic or Domain for the Ad Hoc View. All data and formatting are lost when you select a different Topic or Domain. |
Data Selection Panel | Shows available fields and measures that can be added to the Layout Band. Measures are summarized values that cannot be added as groups.
|
Filters Panel | To hide or show this panel, click the arrow (> or <) icon in the top left corner. |
Filter Controls | Changes the display of filters, either collectively or individually. Each filter menu allows the user to select the conditional operator value to apply with the filter. |
Format Panel | Changes the display of elements on the Canvas. To hide or show this panel, click the arrow (> or <) icon in the top left corner. To see how the data will appear in any report created from the view, click the “Editing” button and switch to “Viewing” |
Canvas | Shows the data subject to the fields, measures, and filters applied. Also, a sample of how the data will appear in any report created from the view. |
Layout Bands | Allows you to drag and drop fields and measures from the Data Selection Panel to add them to the canvas. Change the order by dragging them to a different location in the layout band. The bands have different labels and functions, depending on the type of view. |
Tool Bar | Provides icons and menus for working with the view, including:
|
View Type | Displays data in the canvas as a Table, Chart, or Crosstab. |
Data Mode | Selects the amount of data displayed in the canvas. |
Title Bar | Allows you to click to edit the title of the view. |
Lesson Three: Creating a Report
In this Lesson you will learn how to create and format tabular reports as well as charts.
The Report Viewer lets you interact with saved reports to visualize your data. Reports can be set up for a user to drilldown to detail, launch hyperlinks, and apply different parameters and filters.
Users can create a report in two ways:
Save an Ad Hoc View and create a report in one step from the Ad Hoc View tool bar.
Select an existing Ad Hoc View from the Library.
This lesson shows you how to create a Report using an existing view from the Library.
From the Home Page select Create, and then Report.
Navigate to the folder that contains the Ad Hoc View that will be the basis of the report, and then select the Ad Hoc View.
Select Custom Report Template, and then to select a custom template from the Library, click Browse.
To save the report, click OK.
The report will now appear in the Library in the same location as the Ad Hoc View.
The default report name is the name of the Ad Hoc View with "Report" appended. You can change this name to reflect your organization's naming structure.
To edit the report name:
To change the name, find the report in the Library, right-click the name, and then select Properties.
Type in a Name and Description, and then click Submit.
Figure 7. The Folder Structure in IFS Reporting
Remove the report from its current location by right-clicking the report, and then click Cut, as in Figure 7.
In the Folders section, navigate to the new location, and then click Paste.
You can also use Copy and Paste to put copies of reports in multiple folders.
The data source and computations in a report can only be changed by editing its Ad Hoc View or Domain, but the Report Viewer has components that allow the user to interact with the data and format the report, as in Figure 9 and Table 3 . The following sections describe the features of a report that can be modified.
Figure 8. The Report Viewer
Table 3. Report Viewer Components
Component | Description |
Report Name | Displays the saved name of the report in the Library. |
Refresh Button | Refreshes the Report data, and displays the date and time of last refresh on the left. |
Tool Bar | Provides icons and menus for working with the report, including:
|
Zoom Level | Changes the view to be smaller or larger using the following options:
|
Search | Allows user to search the entire report for character strings with the following options:
|
Page Navigation | Moves the view based on the following options:
|
Report Title | Displays the title of the Ad Hoc View. |
Table Headers | Displays the fields selected as table columns in the Ad Hoc View. |
Sort Indicator | Identifies the column being used to sort report data by displaying a triangle.
|
Column Formatting Menu | Shades the column gray and displays a formatting menu at the top. The menu includes the following options:
|
Alerts List | Shows list of alerts already assigned to the report. |
Figure 9. Formatting Table Columns in a Report
To Format Table Columns:
Open a report.
To view the Format Column dialog, left-click a column header, and then select Formatting, as in Figure 9 .
To format column headers, in Basic Formatting, select Apply to: Headings and choose any of the following options:
Heading text – To replace the current text by typing in a new heading.
Font – To select a font by scrolling through the menu.
Size – To select a font size by scrolling through the menu.
Style – To apply Bold, Italic, or Underlined to text.
Background Color – To select a new color from the background color picker.
Font Color – To select a new color from the font color picker.
Alignment – To change the text to flush Left, Center, or Right.
To format column fields, in Basic Formatting, select Apply to: Detail Rows and choose any of the following options, as in Figure 10:
Heading text – To replace the current text by typing in a new heading.
Font – To select a font by scrolling through the menu.
Size – To select a font size by scrolling through the menu.
Style – To apply Bold, Italic, or Underlined to text.
Background Color – To select a new color from the background color picker.
Font Color – To select a new color from the font color picker.
Alignment – To change the text to flush Left, Center, or Right.
The Report Viewer allows you to format column headings and fields, and to highlight data that meets specific criteria.
For example, if you want to highlight fields for store sales above $100,000, apply text and background formatting to the stores that meet that condition.
To apply conditional formatting, in Conditional Formatting, type in conditions and formats.
If the report output contains too much information, then filter it to display just what you need.
Open a report.
Select the column to use as a basis for filtering.
Click the filter icon
. The Filter column dialog opens.
To build your filter, click the radio button to select Show only rows where. The comparison operator dropdown and value entry box become active.
Select a comparison operator from the dropdown. For example, select Starts with, as in Figure 11.
Type in a value for comparison with the data ("DAVIS" in the example above), and then click OK.
A small filter icon appears in the heading of the filtered column.
To clear the filter, reopen the Filter column dialog, select Show all rows, and then click OK.
Figure 13. Moving Columns in a Report
Columns are easily moved, resized, and hidden in your report. The icon indicates where the column is placed.
To move a column in a report:
Open a report.
To move a column, click the column you want to move, and then drag the column left or right into the new position.
To resize a column, click the column you want to resize, and then drag the
icon until the column is the size you want, as in Figure 13.
To hide a column, click the column you want to hide, then move your mouse over the
icon, and then select Hide column.
Lesson Four: Navigating the Library
The Library is the IFS Reporting internal storage for Reports, Ad Hoc Views, Dashboards, and related files. The Library is organized as a structure of folders containing resources, much like a network file system. Unlike a file system, the Library is stored as a private database that only IFS Reporting can access directly.
Users can browse the Library contents that they have permission to view by expanding Folders. If users are granted Administrator permission to a folder or resource, they can set permissions for other users to access that specific folder or resource.
Clicking a folder name will display the resources (Ad Hoc Views, Reports, etc.) saved to the folder, as well as resource properties, including the following:
Resource Name.
Resource Description.
Resource Type (e.g. Ad Hoc View, Report, Dashboard).
Date the resource was created.
Last date the resource was modified.
Right-clicking a resource on the list displays a menu of options that varies by resource type.
If a resource is scheduled to run, a clock icon appears to the left of the name column. Selecting the clock icon opens the scheduled job details, where the user can choose from the following options:
Create a new scheduled job for the resource.
Run the job immediately.
Disable the scheduled job.
Delete the scheduled job.
Modify the scheduled job.
If a Report resource has saved parameters to create different versions, a right-pointing triangle appears to the left of the name column. Use this icon to display the names of the different report versions.
You can search the entire Library, subject to permissions, by entering a key word or words in the Search box. The order of the words you type in does not affect the search.
Figure 14. Filtering Library Search Results
You can further filter search results using the categories in the Filters panel, as in Figure 14:
Resources that were viewed or modified by the user.
Type of resource.
Date the resource was viewed or modified.
Whether the resource is scheduled.
P2 delivers out-of-the-box Domains, Ad Hoc Views, Reports, and Dashboards as prioritized by our customers and Product Management. The available out-of-the-box content varies by product and is accessed through the Library folders in the following location: /Public/P2/[Product Name]/[Category]. Table 4 shows a list of IFS Reporting Products and their categories at the time this document was created. The IFS Reporting application integrates with new products on a continuing basis.
Table 4. IFS Reporting Products and Categories
Product | Content Categories |
Enterprise Upstream |
|
Midcap |
|
IFS AFE |
|
IFS Land |
|
IFS Merrick |
|
Lesson Five: Scheduling Reports and Dashboard and Saving Report Options
Scheduling Reports and Dashboards, Setting Alerts and Saving Report Options
To open the Library, click Library on the Menu Bar.
Navigate to the Report or Dashboard you want to schedule, right-click, and then select Schedule.
Click Create Schedule, as in Figure 15.
Schedule Tab
Set a Schedule Start Date.
If you select Immediately, you must select Recurrence Type Simple or Calendar; if you select None the job will execute but not save.
If you want to execute a job on-demand instead of scheduling it, it is recommended that you use the Save Options functionality described in the next section.
For recurrence types "Simple" and "Calendar" you can select values for the additional parameters, or accept the default values.
Figure 16. Parameters in a Scheduled Report
Parameters Tab
Select parameter values for the Report, as in Figure 16 .
Scheduled Dashboards are run with the existing parameters of the Dashboard selected, and the Parameters tab is disabled.
Output Options Tab
Type in the File name (required). It is recommended that you give the file a distinct name, and make sure that the file name is different for each scheduled job.
Description . (Optional)
Time Zone .
Output Local .
Formats .
The default format is PDF. Each selected format is generated and saved as a separate file in the selected output destination in the IFS Reporting Repository.
If HTML format is selected, the report content appears in the body of the email.
File Handling
Select one or more methods.
Overwrite Files replaces an old file with a new file of the same name.
Sequential File Names by Timestamp appends a timestamp to the names of files created by the job. This option is useful to organize output of recurring jobs or for time-sensitive reports where the output must be dated.
Output Destination
Select one or more check boxes and define a location in the IFS Reporting repository to save the output.
Leaving all boxes unchecked means you will receive an email of the output, but no file will be written to the repository.
Notifications Tab
To , CC and BCC fields: Type in the email addresses of the recipients. Use commas to separate multiple email addresses.
Subject : Type in a Subject line for the email. It is recommended that you have a detailed subject, and that the subject is different for each scheduled job.
Message . ( Optional )
Report distribution method
Select a report delivery type: email contains links to the Report in the body of the email, attachments , or ZIP attachment.
If HTML is a selected format on the Output Options tab, you have the choice to include the HTML report in the email body. Including it in the email body allows recipients to view the report without opening or downloading the attachment. This may be useful for recipients using mobile devices or who are in remote locations with poor or slow data connections. Note that a user must type into the message section prior to selecting "Include HTML in the email body." Once the box is checked, the message section is disabled.
Do not send emails for empty reports: This option suppresses the email if the report has no content.
Job Status Notifications
The job status notification email tells you if the scheduled report ran successfully or if it failed.
To : Type in the email addresses of the recipients; separate multiple addresses with commas.
Subject: Type in a Subject line for the notification email. It is recommended that you have a detailed subject, and that the subject is different for each scheduled job.
Send success notification: The status notification email is independent of the report email; you will receive both the success notification email as well as the report email if the job executes successfully.
Send failure notification: If the job does not execute successfully, you will receive this email. It is recommended to check options Include reports job information and Include stack trace . This will give you information to diagnose the issue in the event of a failed scheduled job.
To save your changes, click Save .
Enable: If you want to pause a job, you can uncheck the Enabled box on the Schedules page.
Open the Library, find the report, and click to run the report.
Select values for each filter in the Input Control window.
In the bottom right corner of the window click Save.
Type in a Name for the Save Values.
To run the report using the Saved Options, open the report. At the top of the Options window, the saved options will be available from a dropdown list.
To open the Library, click Library on the Menu Bar.
Navigate to the Report or Dashboard you want to set an alert in, an click the report name to open the report.
Click the “Turn on Alert Mode” icon in the report tool bar, as in Figure 17.
Locate the column in the report for which you’d like to set the alert and click on it.
The Create Alert screen will pop up and display the Condition tab.
Name the alert in a way that will easily separate it from other alerts in this report.
Select the Condition from the dropdown and set the Threshold.
Click the Schedule tab and set how often you’d like the report to run to test for the condition.
In Notifications, fill in the Send alert to fields with the email addresses that will receive the alert. Here you can fill in a Subject for the alert email as well as a message.
Note: Only users with access to Reporting can click on the link and see the report.
10. In the Output tab, select the format you’d like the report emailed out as.
11. Click ‘Create Alert’ to save.
Appendix: Additional Resources
IFS Reporting Resources
Release Notes: On the P2 Store
Jaspersoft Resources
List of All Documentation
Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.