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.

See Defining Report Definition Output Path

Access the Report Definition application (P95620).

  1. Select the report definition you want in the grid, and then click the Select button.

  2. On the Update Report Definition form, from the Form menu, select Burst/Delivery.

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

    Note: 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> See BI Publisher Archived Report Files
  4. Select the option Override Output File Name. The Data Item for Output File Name field is enabled

  5. In the Data Item for Output File Name field, enter the data dictionary item that has template substitution data structure defined. The Define File Name button is enabled.

    See Delivery Email Subject and Body

  6. Click Define File Name. The Output Structure Definition Value Revisions form displays.

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

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

  9. Enter any one of the following values or a combination of the following values in the Structure Member Value field:

    • Static customized file name - Enter any static text you want to be the name of the report definition output file. For example, test.

    • Dynamic customized file name - Enter the name of the field you want to be the name of the report definition output file. Note. 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.

  10. Click OK.

    Note: If there is more than one entry in the Structure Member Value field with the same value, and if you want to archive the files in the same location, the duplicate file name might be generated based on the static and dynamic values of the Structure Member Value field. The dynamic value is taken from the source XML.If there is more than one similar static value in the Structure Member Value filed, and if duplicate files are archived at the same location, an email will be sent to the user informing that the file is archived with duplicate name when the report definition output is generated. The file is saved with the same name appended by (1) or (2) or (<any number>) depending on the number of duplications in the specified path.Consider the following scenarios:
    1. A static file name called Sample.pdf exists, and you want to create another output file with the same name in the same location. If you do so, an email will be sent to you informing that the file is archived with duplicate file name and the file is created with the name Sample (1).pdf in the specified path. You can access the Output Structure Definition Value Revisions form and correct the file name to avoid the duplication if you want.

    2. Consider the value of the Structure Member Value field is a data structure with two parameters. The value of first parameter is a static value called Sample. The value of the second parameter is a dynamic value called /AddressNumber.

      Now, the file generated for each output will be: Sample_[AN8 from xml].pdf