Reports

The Reports form allows you to run reports based on different parameters. When you run a report, it is generated and displayed on the Reports form. You can also run and save a report with a specific name, so you can select the report again later.

Once generated, a report can be exported to Crystal Reports (RPT), PDF, Excel, Word, RTF, and CSV.

Running a report, especially a report with a large amount of data, may take up a lot of your system resources and cause a decrease in performance of the Shop Floor Time web application. To prevent this problem, you can define a separate instance of the application server to use for processing reports. See Dedicated Reports Server.

See Also:

Types of Reports

Reports Form Field Descriptions

Run Report

Run and Save Report

Delete a Saved Report

View, Print, and Export a Report

Dedicated Reports Server

Report Images

 

Reports Form Field Descriptions

Report Name

The Report Name field displays the available reports. See Types of Reports for a description of these reports and a link to each one.

In order to run a report, you must first select a Report Name.

When you select a Report Name, the report’s parameters display below the Report Name/Saved Reports/Process Status fields.

Saved Report

The Saved Report field displays the name of any saved reports for the selected Report Name. You can use this field to select a specific report to run.

A Saved Report is created when you click Run and Save Report and you enter a report name. A Saved Report is also created when you click Run Report. In this case, the report you are running will be saved as the Report Name, lowercase with underscores (e.g., action_report).

When you select a Saved Report, the report’s parameters update to match those you defined when you saved the report. The report will then display on the screen.

If you change any of the report’s parameters and run the report, the new parameters will be saved with the report.

If you click Run and Save Report, you will be prompted for a report name and you can keep the existing report name (overwriting the previous version) or enter a new name.

You can use the Delete Saved Report button to delete a Saved Report.

Saved Reports are unique for each logged-in user. Other users will not have access to your saved reports.

Process Status

This field shows the status of the selected Report Name and Saved Report.

Complete: The report finished processing and is ready to be displayed.

Error: The report stopped processing because an error occurred.

Long Running: The report has been running for more than an hour but less than 24 hours.

Processing: The report has been processing for less than an hour.

Ready: A request has been created to generate the report, but the generation has not started yet

Stale: The report has been running for more than 24 hours.

Run Report

Use this option to generate a report and view it on screen. You can then print or export the report.

See Run Report for the steps needed to run a report.

Run and Save Report

Using Run and Save Report is the same as using Run Report, except that you will be prompted to name the report. The next time you want to run the report, you can select it from the Saved Reports field (after you select the correct Report Name).

Cancel Report

Click this button to stop a report from processing.

While a report is processing, a message with a spinner will display. The spinner message will display until the report finishes processing, or for up to three minutes if the report is still processing. Once the spinner message stops displaying, if the report is still processing, you can click Cancel Report to stop processing the report.

Delete Saved Report

Click this button to delete a Saved Report.

Refresh View

Click this button to update the Process Status field with the report’s status.

 

Run Report

Use the Run Report option to generate a report and view it on screen. You can then print or export the report.

  1. Click Main Menu > Reporting > Reports.

  2. If necessary, click the Filter button to display the Report Name and Saved Reports fields.

  3. Select a Report Name. See Types of Reports for information on the available reports.

  4. From the Saved Reports field, you can select the name of the report you want to run. The available options depend on the Report Name you selected.

    If you do not select a Saved Report, the report you are running will be saved as the Report Name, lowercase with underscores (e.g., action_report).

  5. The report’s parameters display below the Filter fields. Enter the applicable parameters.

  6. Click Run Report to run the report and display it on screen.

    The report will be saved as the Report Name, lowercase with underscores (e.g., action_report). Note that if you click Run and Save Report, you will be prompted for the report name.

    While the report is processing, a message with a spinner will display. The spinner message will display until the report finishes processing, or for up to three minutes if the report is still processing.

    The Process Status will indicate whether the report is still processing or is complete. Click Refresh View to update this status field.

    While the report is processing, you can go to a different form or log out of the web application. When you return to the Reports form, you can use Refresh View to check the report status.

    Once the spinner message stops displaying, if the report is still processing, you can click Cancel Report to stop processing the report.

  7. When the report is complete, it will display on the form.

  8. To modify the report, change the report’s parameters and click Run Report again. When you change a report’s parameters and run the report, the new parameters will be saved with the report.

  9. To run a different report, repeat these steps beginning with Step 3.

  10. Use the toolbar at the top of the report to page through it, search for terms, print the report, or export the report.

 

Run and Save Report

You can also use the Run and Save Report option to generate a report and view it on screen. When you click Run and Save Report, you will be prompted to name the report before it is processed.

The next time you want to run the report, you can select it from the Saved Reports field (after you select the correct Report Name).

Using Run and Save Report is the same as using Run Report, except that you will be prompted to name the report. See “Run Report” above for more information.

 

Delete a Saved Report

  1. Click Main Menu > Reporting > Reports.

  2. If necessary, click the Filter button to display the Report Name and Saved Reports fields.

  3. Select the Report Name of the report you want to delete.

  4. From the Saved Reports field, select the name of the report you want to delete. The available options depend on the Report Name you selected.

  5. Click Delete Saved Report.

  6. Click OK to confirm the action.

 

View, Print, and Export a Report

When you click Run Report or Run and Save Report, the report will generate and display on screen.

Using the toolbar at the top of the report, you can page through the report, search for specific words in the report, print the report, or export the report. For some reports, you can also display the report’s contents in a hierarchical format using the Group Tree button.

 

Export

To export the report, click the Export button. The Export pop-up form will appear.

Select the following options, then click Export:

File Format: Select the format of the file that will contain the report. Available options are Crystal Reports (RPT), PDF, Excel, Word, RTF, and CSV.

Page Range: Select which pages to include in the report.

 

Print

To print the report, click the Print button. The printing method will depend on which web browser you are using.

Internet Explorer

If you are using Internet Explorer, you must have the Crystal Reports Print Control installed in order to print the report. The browser’s Print window will appear when this control is properly installed.

If the Crystal Reports Print Control is not installed, Internet Explorer will display an alert message when you click the Print button, asking if you want to install the Crystal Reports Print Control. Click Install and you can continue printing the report.

Firefox

If you are using Firefox, the Print to PDF window will appear when you click the Print button. The report must be converted to a PDF file before you can print it.

Select the pages you want to print and click the Export button. Your web browser will ask if you want to open or save the file. Once you display the file on screen you can print it.

Note: You can also Export the file to Excel, Word, RTF, or CSV format, and then open and print the report from another application.

 

Group Tree

For some reports, you can use the Group Tree button to view a hierarchical display of the contents of your report. For example, in the Event Transactions and Totals Report, the data is sorted by the Event Name, Posting Date, and then Person Number. If you click the Group Tree button, a hierarchical display of this data will appear to the left of the report. Click the + button next to an element in the hierarchy to display its contents. When you click an item in the Group Tree, the item will highlight in the report.

 

Page Controls

Use the page controls to view the additional pages in the report or to zoom in and out of the report.

 

Search

To search the report, enter the search terms in the text box and click the search button.

 

Dedicated Reports Server

Running a report, especially a report with a large amount of data, may take up a lot of your system resources and cause a decrease in performance of the Shop Floor Time web application. To prevent this problem, you can define a separate instance of the application server to use for processing reports.

The REPORTING_SERVER Host and Port settings on the Application form are used to identify the host name and port number of the server where you will run reports.

By default these settings are blank, indicating that reports will be processed on the same application server that is running the Shop Floor Time web application.

If you specify a host and port for the REPORTING_SERVER, then that instance of the application server will be used to process reports.

Note that the REPORTING_SERVER settings will not be used to process Ad Hoc Reports. Ad Hoc Reports will always be processed on the same application server that is running the Shop Floor Time web application.

Create a dedicated reports server:

  1. Select the host and port of the application server instance that will be used to process reports. Install the Shop Floor Time application on this server.

  2. On the Servers tab of the Application form, create a record for the application server instance from step 1.

  3. On the Application form, change the host and port for the REPORTING_SERVER settings to match the application server you defined in step 2.

 

Report Images

The images that display on the reports can be replaced with other images, such as your company logo.

The report images are located in the \app\reporting\crystal\design\images folder where the Shop Floor Time application is installed.

The image in the upper left corner is named Company.jpg. The image in the upper right corner is named Customer.jpg.

Important: When you upgrade your Shop Floor Time application, all the images in the \app\reporting\crystal\design\images folder will be overwritten. Make sure you keep a copy of your custom images in another location besides the folder where the Shop Floor Time application is installed.

To replace the report images:

  1. Navigate to the \app\reporting\crystal\design\images folder.

  2. Backup or rename the current images (e.g., original.Customer.jpg and original.Company.jpg).

  3. Place your custom images in the \app\reporting\crystal\design\images folder.

  4. Ensure that the image you want to display in the upper left corner is named Company.jpg.

  5. Ensure that the image you want to display in the upper right corner is named Customer.jpg.

  6. Make sure you have copies of your custom images in another location besides the \images folder. When you upgrade your Shop Floor Time application, all the files in the \images folder will be overwritten.

  7. Restart the application server.

    The changes will take effect the next time a report is generated.