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.

StepsDisplaying your own reports

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

  2. Click the New icon on the Menu bar.The Report window displays. The General tab is active.

  3. Enter information as shown in Table 7-1.

    Table 7-1: Fields in the General tab

    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 Add.

  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. See Table 7-2.

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

    Table 7-2: Field descriptions for the User Report Table 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 the Browse button to locate your DSN.

    User ID

    Enter the user id that is needed 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 OK 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 Add.

  12. A window displays prompting for a parameter name. 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.

  13. 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.

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

  15. Your report is added to the list of reports that EC Gateway displays.

You can access your report at any time by double-clicking its name. A window displays asking for the value or values for the parameters you established for your report.

StepsDisplaying a report

  1. Double-click the title of a report on the listing of reports.A Parameters window displays.

    A user-defined report prompts for the values of a starting date and an ending date. Enter the desired values in the format YYYY/MM/DD and click OK. 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 asks for parameter values.

  2. Enter a value for each parameter. Click OK.The selected report displays; its scope is set by the values entered.