User-defined reports

EC Gateway supports running user-defined reports. These reports are useful for special purposes that are defined by the user. These reports must be ODBC reports.

To display your own report, follow these steps:

  1. Click the Report icon. The list of available reports displays.

  2. Click the New icon on the menu bar. The Report window displays with its General tab active.

  3. Enter the information in the entry boxes.

    Field

    Description

    Report File

    Enter the full path of the report file. Alternatively, you can use the Browse button to locate the report.

    Title

    Enter a title for this report.

    Number of Tables

    Select the number of tables included in your report. It should be the same as the number of tables already used in your report.

    Number of

    Parameters

    (Optional) Select the number of parameters used in your report.

  4. Click the Tables tab. The Tables tab displays.

  5. Click the Add button.

  6. The User Report Table window displays.

  7. Enter the information in the entry boxes and then click OK. Repeat this step for each table that exists in your report. The tables must be defined in the same order as they are used in your report.

    NoteYou cannot add more tables than the number you chose on the General tab of the Report window.

    Field

    Description

    Data Source Name

    Enter the data source name (DSN) for the table that will provide the information for your report. Alternatively, you can use Browse to locate your DSN.

    User ID

    Enter the user ID to access the database.

    Password

    Enter the password (if required) to access the database.

    Table Name

    Enter the name of the table in the database that will be accessed for the information.

  8. When you have finished step 7, the Tables tab display of the Report window is filled with the information that you entered using the User Report Table window.

  9. If you want a table without user-controlled parameters, click the OK button at the bottom of the Report window to end your report definition. Otherwise, go to the next step.

  10. Click the Parameters tab. The Report – Parameters tab window displays.

  11. Click the Add button.

  12. A window displays prompting for a parameter name.

  13. Enter a parameter name and click OK. This parameter must already exist. Each reader of your report will be able to insert specific values into this parameter to set the scope of the report.

  14. Repeat steps 11 through 13 for each parameter that you want to add to your report. The parameter names must be defined in the same order used in the report.

    NoteYou cannot add more parameters than the number of parameters that you chose on the General tab of the Report window.

  15. When you finish adding parameters, click OK at the bottom of the Report window.

  16. Your report is added to the list of reports displayed by EC Gateway.

You can access your report at any time by double-clicking its listing. When you do this, a window displays asking for the value or values for the parameters you established for your report.

To display your report:

  1. Double-click the title of a report on the listing of reports.

    A Parameters window displays.

  2. Enter a value for each parameter. Click OK.

    The selected report displays with its scope set by the specific parameter values entered.

    In this example, a user-defined report prompts for the values of a starting date and an ending date. You enter the desired values in the format YYYY/MM/DD and click the OK button. The report displays covering the range entered for the parameters. The parameters used are not restricted to starting and ending dates.

    NoteIf no parameters are defined here, but your report uses parameters, the report itself will pop up windows to ask the values for the parameters.