28 Setting Up Processing Option Templates

This chapter contains the following topics:

28.1 Understanding Processing Option Templates

Processing options designate parameters that are used by reports. When reports are processed, the processing option template passes values that are entered by the user. These values are used by the event rules that are attached to the report to perform customized processing.

Processing option templates are included in Oracle's JD Edwards EnterpriseOne. You can also create custom processing option templates to meet your business needs.

You can use processing options to:

  • Control how reports process data.

  • Set up default values.

  • Customize batch versions for different companies or even different users.

  • Control the format of reports.

  • Control page breaks for reports.

  • Control totaling for reports.

Processing option templates can contain one or multiple parameters. You can add tabs, with descriptive names, to the processing option template to categorize the parameters. For example, you can name a tab Print to describe parameters that affect how a report prints or which printer is used.

At runtime, processing option templates display the set of tabs which are referred to as pages. When you select a tab, the page changes to display the set of processing options for that category.

You can add comments to processing options. The comment should describe the purpose of the available parameters and any information that is required by the user. For example, Use this processing option to indicate the preferred format of labels for printing.

Each processing option page displays parameters that are accompanied by a description. The description often includes valid values when appropriate. Add data items to the processing option page to create the parameters. You can change the description of the data item to better describe the purpose of the parameter. For example, Enter 1 to print single column labels and 2 to print two-column labels.

Each data item that you include on the processing option template includes a member name. This name is located on the Properties form of each parameter. You want to modify the member name of generic fields to represent their specific purpose. Modify the member name to be a descriptive name that you will recognize in Event Rules Design. The recommended naming convention for member names is:

  • Add the Hungarian Notation at the beginning of the name.

  • Append the data item alias at the end of the name, preceded by an underline.

  • Do not include spaces in the name.

For example, the Add [Y/N] data item is often used in processing options for entering a yes or no value. The alias for the Add [Y/N] data item is A, and the field is defined as a character data type. With that in mind, you might modify the member name to read cDisplayCommentsColumn_A.

28.2 Designing and Using Processing Option Templates in Reports

This section provides an overview of processing option templates in reports, lists the prerequisites, and discusses how to:

  • Create data structure objects.

  • Create processing option templates.

  • Add tabs to processing option templates.

  • Attach processing option templates to reports.

28.2.1 Understanding Processing Option Templates in Reports

To use a processing option with a report, you must attach the processing option template to the report template. Attach the processing option template by selecting Select Processing Options from the File menu. You can then search for and select the appropriate processing option template from the Select Processing Option Template form.

After you attach the processing option template to the report template, you must create event rules to tell the system how to process the processing option values, and under what conditions. You should include all valid values in the event rules. You should also include a default scenario in case the user leaves the processing option blank.

Processing option templates are report features so they are always attached to the report template. Processing option templates are reusable objects so you can attach the same processing option template to multiple reports. Processing option values, however, are stored with the batch version. This enables you to assign a set of processing option values to a particular batch version. For example, you can have two versions of a report that prints labels; one version with the processing option values set to print one-column labels, and one version set to print two-column labels.

When the report is launched, the system prompts the user to enter processing option values. However, even if a report template has a processing option template attached, the system might launch the report with no prompting. This is called a blind execution. The processing option values for a blind execution are predefined and cannot be modified by the user.

This overview outlines the process for creating and using processing option templates in a report:

  1. Create processing options by building a list of parameters called a template.

  2. Attach the processing option template to a report template and create event rules in the appropriate report section to process the processing option values.

  3. Create a batch version of the report template and select one of these options to indicate how the system should handle the processing options at runtime:

    • Prompt for Values

      The processing options appear, enabling the user to enter values.

    • Blind Execution

      The report runs using a set of predefined processing option values.

28.2.2 Prerequisites

Before you design and use processing option templates in reports, ensure that you:

  • Create a batch application object.

  • Complete the design of a report template to which you can attach a processing option template.

28.2.3 Creating Data Structure Objects

Access Oracle's JD Edwards EnterpriseOne Object Management Workbench.

  1. Select the project in which you want to add a new processing option template and click Add.

  2. On the Add EnterpriseOne Object to the Project form, select the Data Structure option and click OK.

  3. On the Add Object form, enter the name of the processing option template in the Object Name field using the recommended naming conventions.

  4. Enter a brief description of the processing option template in the Description field

  5. Enter a client reserved product code (55–59) in the Product Code field.

  6. Enter the system code that relates to the report data that this processing option will affect in the Product System Code field.

  7. Enter 360 in the Object Use field to indicate that the object is a data structure.

    The object use value should reflect the object that you are creating. You can create categories of data structures to select from the Object Use list. Click the visual assist in the Object Use field. On the Select User Defined Code form, select Revisions from the Form menu. On the Work With User Defined Codes form, click Add. On the User Defined Codes form, scroll to the bottom of the list and enter a new code and description in the blank row of the detail area.

  8. Under Type, select Processing Option Template and click OK.

    The tool that the system presents for developing the object is dependent on the data structure type that you select. If you select Regular Data Structure, the system presents a much different form than if you select Processing Option Template.

  9. On the Processing Option Design form, select the Design Tools tab, and click Start the Processing Option Design Aid.

28.2.4 Creating Processing Option Templates

Access Oracle's JD Edwards EnterpriseOne Processing Option Design Aid.

  1. On the Processing Options Design form, right-click <New Tab> and select Current Tab Properties from the pop-up menu.

  2. On the Tab Properties form, complete these fields, and click OK:

    • Short Name

    • Long Name

  3. Click A on the toolbar and then click the page of the processing option template to add a comment box.

  4. Double-click the comment box, highlight Comment Text, and enter a brief description of the processing option parameters.

    Note:

    You can highlight the comment text and type over it or you can backspace to remove the text, but you cannot use Delete to remove the text.
  5. On the Data Dictionary Browser form, enter a value on the QBE line to locate a required data item and then press Enter.

    You can also click the Search button that is located directly beneath the Data Dictionary Browser heading to search through all data items.

  6. Drag the required data items to the page of the processing option template.

    If you double-click the data item, it appears on the selected processing option page.

  7. To reposition a data item on the processing option page, click the data item and drag it to another location.

    The system automatically adjusts the size and position of data items to fit the width of the tab.

  8. Double-click the text portion of the item to modify the description.

    Note:

    You can highlight the text and type over it or you can backspace to remove the text, but you cannot use Delete to remove the text.
  9. Right-click the data item field and select Properties from the pop-up menu.

  10. On the General tab of the JDE.DataItem Properties form, change the Member Name field.

  11. Select the Help Override Data Item tab, modify the Data Item Help Override Name field, and click OK.

  12. Save the processing option template and exit JD Edwards EnterpriseOne Processing Option Design Aid.

28.2.5 Adding Tabs to Processing Option Templates

Open a processing option template in JD Edwards EnterpriseOne Processing Option Design Aid.

  1. Right-click the current tab and select New Tab from the pop-up menu.

  2. On the Tab Properties form, complete these fields, and click OK:

    • Short Name

    • Long Name

  3. Add comments and data fields as appropriate.

  4. When the new tab is complete, select Test from the Edit menu to test the processing option.

    In test mode, you can click the visual assist for a data item to verify that you have selected the correct data item.

  5. Save the processing option template and exit JD Edwards EnterpriseOne Processing Option Design Aid.

28.2.6 Attaching Processing Option Templates to Reports

Open a report template to which you can attach a processing option in Oracle's JD Edwards EnterpriseOne Report Design Aid.

  1. From the File menu, click Select Processing Options.

  2. On the Select Processing Option Template form, use the QBE line to search for and select the processing option template that you want to use and click OK.

    A check mark appears next to Select Processing Options on the File menu, indicating that a processing option template is attached to this report.

  3. Verify that the processing option template is attached to the report by selecting Report Properties from the File menu.

    The Processing Options field on the Report Properties tab indicates the processing option template that is attached to the report.

  4. Add logic in Event Rules Design to indicate to the system how each valid value entered into the processing option template should be processed.

  5. To remove an existing processing option template, click Select Processing Options from the File menu.

  6. On the Select Processing Option Template form, search for and select the processing option template and click Remove.