Defining Report Definition Output


Options



Before You Begin

Purpose

In this OBE, you will learn how to customize report definition output file name, how to define report definition output path and how to create hierarchy for the report definition output.

Time to Complete

60 minutes

Background

Customizing the report definition output file name and the file path enables you to maintain and locate the output files easily. For example, you can name the report definition output file as CustomerEmailAddress and specify the output file path if you using the Microsoft Windows operating system as C: /JDE/RDOutputStore. The output file with the name CustomerEmailAddress.pdf suggests that this PDF file contains email addresses of all customers. Different paths and file names can be specified for different report definitions. This enables users to store the output on different locations.

You can also save the output files in the folder that contains the structural hierarchy.

Customizing Report Definition Output File Name

The customized file name is reflected in the Report Definition Output Repository (W95630E) form and Work With Submitted Jobs form of the Use Report Definition Jobs (P95630) application. If the output delivery option is selected as email, the customized output file name is reflected in the email as well. If the archiving option is turned on, the report definition output is saved with the customized file name in the defined location.

  1. Access the Report Definition application. Type P95620 in the Fast Path field and press Enter.

    BI Publisher Repository form
    BI Publisher Report Definitions form
  2. For this OBE, select the Report Definition RD078305CX in the grid.

    BI Publisher Repository form add button
    BI Publisher Report Definitions form
  3. Click Select button.The Update Report Definition form is displayed.

    Templates table
    Update Report Definition form
  4. In the Update Report Definition form, from the Form menu, select Burst/Delivery.

    Templates table
    Burst and Delivery option
  5. In the Update Report Definition - Bursting and Delivery form, select the Override Output File Name tab.

    Templates table
    Override Output File Name

    If you do not use the Override Output File Name option, the output files will be saved with the default file name in the following format:

    <RD_NAME>_<RD_LANG>_<UBE_JOBNUMBER>_<RD_JOBNUMBER>_<SEQ_NO>.<OUTPUT_TYPE>

  6. Select the Override Output File Name check box. The Data Item for Output File Name field is enabled.

    Templates table
    Override Output File Name
  7. In the Data Item for Output File Name field, enter the data dictionary item that has template substitution data structure defined. Enter 003RS. Now, the Define File Name button is enabled.

    Templates table
    Override Output File Name tab
  8. Click Define File Name. The Output Structure Definition Value Revisions form is displayed.

    Templates table
    Output Structure Definition Value Revisions form
  9. If you have several data structures defined for the data item you selected, you can enter several values in the Structure Member Value field and define the sequence in which you want the names to be displayed. Each text/field is divided by an underscore. For example, CustomizedFileName_Test_1.

    The Data Item Alias and Structure Member Name fields are populated automatically.

    You can enter any one of the following values or a combination of the following values in the Structure Member Value field: Static customized file name and Dynamic customized file name.

  10. Enter any static text you want to be the name of the report definition output file. For example, enter the static customized file name as Demo and click OK.

    Templates table
    Output Structure Definition Value Revisions form
  11. To add a dynamic customized file name, enter the name of the field you want to be the name of the report definition output file.

    Prefix the name of the field with '/' character. This prefix indicates that the text is an XML field. If the field is entered, the value of the field will be accessed from the XML source file of the report definition output and displayed as the name of the output file.

    This is helpful since you do not have to change the file name every time you run a report definition. For example, if you are running the address book number report, you can include the AddressNumber field as part of the file name. The report definition gets generated with different address number as the output file name every time you run this report definition.

    If you choose the data item with several data structures, you can define the name of the output file in a sequence.

  12. To enter a dynamic customized file name, access BI Publisher Report Definition application.

  13. Select the Report Definition RD76B561Z in the grid.

  14. From the Form menu, select Burst/Delivery option.

  15. In the Update Report Definition - Bursting and Delivery form, click the Override Output File Name tab.

  16. Select Override Output File name option.

  17. In the Data Item for Output File Name field, enter the data item 399S.

    Templates table
    Update Report Definition - Bursting and Delivery form
  18. The description of the DD item 399S in the DD application(P92002) is Bus Unit &1 Invalid for Empl &2 . Here, &1 and &2 can be replaced with a static or dynamic report definition field.

    Templates table
    Glossary Items
  19. In the Update Report Definition - Bursting and Delivery form, click the Define File Name button. In the Output Structure Definition Value Revisions form and enter the value for the Structure member value field.

  20. To select a dynamic field, access the Report Definition Job Control Search. Enter P95630 in the FastPath and press Enter.

  21. In the Report Definition Job Control Search form, select a Report Definition job to look into the Source. From the Row menu, select View RD Source.

    Templates table
    View RD Source
  22. From the source file, copy AddressBookNumber_ID3.

    Templates table
    Source File
  23. In the Output Structure Value Revisions form, enter the values as shown in the following screenshot and click Save.

    Templates table
    Output Structure Definition Value Revisions form
  24. To See the output, let us access the Report Definition Job Control Search application and select the report definition for which we customized the file name and from the Row menu, select View RD Output.

    Templates table
    Report Definition Job Control Search
  25. In the Report Definition Output Repository, enter the appropriate UBE Execution host name.

    Select the RD for which we just customized a dynamic output file name and select View RD Output.

    Templates table
    Report Definition Output Repository
  26. We can see the name of the output file just like how we customized it. This number 7600 is dynamic and it was taken from the xml source file. Demo is the static file name.

    Templates table
    Dynamic customized file name
  27. Click Close.

Defining the Report Definition Output Path

If you use the enterprise server jde.ini to define the path for archiving, all the report definitions will be saved in same path defined in enterprise server jde.ini file.

You can choose to define a customized output path for a specific report definition output using the Report Definition Server Mapping application (P95641).

If the path is not defined for a report definition in P95641, the output file is stored in the default path defined in the enterprise server jde.ini.

To define output path for the report definition, access the Report Definition Server Mapping application (P95641).

  1. Type P95641 in the fast path and press enter.

    Oracle headquarters buildings
    Work with Report Definition Archive Path
  2. Click Add. On the Report Definition Archive Paths form, in the Report Definition field, enter the report definition for which you want to define the output path. You can use the visual assist to select a report definition.

    In the Report Definition field, enter RD078305CX.

    Enter the values for the Server Name, User/Role and Path as shown in the following screenshot.

    Templates table
    Work with Report Definition Archive Path

    If you enter a folder name in the Path Field that does not exist, the folder structure is created and the output is stored at the specified path. For example, if you enter C: /JDE/RDOutputStore in the Path field and if the folder RDOutputStore does not exists, then the folder with the name RDOutputStore is created and the output file is stored in the path specified. If you enter an invalid path, the report definition job will end in FD status. You can access P95630 application and select View Delivery option and then, select Re-Deliver Output option to correct the path and save the file again.

  3. The Status description populates automatically to Active if the object status is AV and Not Active if the Object status is NA.

    Click OK.

  4. To change the status, select the record and from the Row menu, select Change Status.

    Templates table
    Work with Report Definition Archive Path

Creating Hierarchy for the Report Definition Output

You can choose to create hierarchy of folders with report definition name, report definition language and report definition job number for the report definition output.

To create the report definition output in folder hierarchy:

  1. Access Embedded BI Publisher Configuration application (P95642).

  2. Select the Archive Report Definition in Hierarchical Structure checkbox.

    If Archive Report Definition in Hierarchical Structure is selected, the output file is saved in hierarchical structure in the path defined in Report Definition Server Mapping application (P95641). If the path is not defined in Report Definition Server Mapping application (P95641), the output file is archived in hierarchical structure in the path defined in enterprise server jde.ini.

    Templates table
    Embedded BI Publisher Configuration
  3. Click Save.

Summary

In this exercise you customized the report definition output file name, and defined the report definition output path and created hierarchy for the report definition output.

Want to Learn More?