Generating Reports

Several standard reports are defined in Sterling File Gateway.

Procedure

  1. From the main menu, select Tools > Reports.
  2. Select the information you would like the report to contain. Leave any field blank to select all possible values. Options are:
    Field Description
    Producer Select a producer for the arrived files to report on. Do not use if Producer Group is specified.
    Producer Group Select a producer group for the arrived files to report on. Do not use if Producer is specified.
    Consumer Select a consumer for the arrived files to report on. Do not use if Consumer Group is specified.
    Consumer Group Select a consumer group for the arrived files to report on. Do not use if Consumer is specified.
    Status Select one or more from:
    • Started - includes Started, Determining Delivery, and Delivering
    • Succeeded - includes Complete
    • Failed - includes Failed
    • Ignored - includes Ignored
    Date (From) Click on the calendar icon to select a starting date.
    Date (To) Click on the calendar icon to select an ending date.
    Time (From) Specify a time in the format hh:mm:ss.
    Note: Query in server time. Report results will be in server time, regardless of the header label.
    Time (To) Specify a time in the format hh:mm:ss.
    Note: Query in server time. Report results will be in server time, regardless of the header label.
    Group By Select from:
    • Producer
    • Consumer
    Format Select from:
    • HTML
    • PDF
    • XLS
    Report Type Select from:
    • Detailed - includes a Producer ID (assigned by the system), Consumer, Discovery Time, Completion Time, Status, Original File Name, and File Size
    • Summary - includes Total File Size and Total Count by Success, Error, In Progress, and Failure Reviewed
    Note: Error count is the number in Failed status that have not been reviewed.
    Sort By Click and drag the following fields into the desired order for sorting:
    • Status
    • File Name
    • File Size
  3. Select Generate Report.
    Note: For reports with Asian characters, download and install the special Acrobat Reader Asian font packs from www.adobe.com. Text for reports is generated with iText using CJK fonts. If the Asian font packs are not installed, Acrobat Reader may ask you to install when you open a PDF file containing CJK fonts.
    Important: The Operator Users are unable to generate reports.

    Workaround: If the Operator User needs to generate the reports, then the report permission myFileGateway Reports needs to be added manually.

    Depending on your selections, the report has the following contents:

    Field Definition
    Created On Date and time report was requested
    Created By User ID that requested the report
    Group By How the data is grouped
    Report Config Selections made for report
    Filters How the data is ordered
    Producer ID ID assigned by the system for the producer that created and sent the file
    Consumer Partner that received the file. The Consumer Name is listed, if available. If Consumer Name is not available, the Consumer Code is listed, delineated by <>.
    Discovery Time Time file first entered system, in the server time zone, regardless of the header label
    Completion Time Time file transfer was completed, in the server time zone, regardless of the header label
    Status Status when report was generated
    Original File Name Name given to the file by the producer
    File Size Size of the transferred file
    Summary
    • Producer
    • Total File Size
    • Total Count
    • Success
    • Error
    • In Progress
    • Failure Reviewed
    		 For each producer, the total file size transferred in the report period, total count of files transferred in the report period, and a count for each status category. The Producer Name is listed, if available. If Producer Name is not available, the Producer Code is listed, delineated by <>.
    Note: Error count is the number in Failed status that have not been reviewed.
    Note: By default, reports only include the first 1000 activity records that match the specified criteria. Your System Administrator may set another value for the number of records to be included in reports. (See System Administrator > Install and Set Up > filegateway_ui.properties.)
    Note: Sterling File Gateway users with Microsoft Internet Explorer 7 may not be able to open more than one PDF type report at a time due to Internet Explorer 7 content blocking security. Close the original report window or adjust Internet Explorer 7 browser setting or configure Adobe Reader to not open in a browser (and instead open in an Adobe window).

    In Internet Explorer 7, select Internet Options > Security (tab) > Custom level > Downloads > Automatic prompting for file downloads > Enabled.

    In Adobe Reader, select Preferences > Display PDF in browser > disabled.