1. Form Design Aid Guide
  2. Set Modified Web Object Behavior

Set Modified Web Object Behavior

Use this system function from a One View Financial Statements application to interact with Queries and One View Reporting, all of their related operations, and to export or import One View Financial Statements data.

Note: With the exception of the import and export functionality, this system function can be used by any One View Reporting application, not just One View Financial Statements applications.

The parameters for this system function vary depending on the Action parameter. The Action parameter defines how the system function is being used.

The various actions for this system function can be organized by web object type:

  • QUERY as Web Object Type

    • LOAD_NAMED_AQ

    • DOES_AQ_EXIST

    • PREVIEW (for Web Object Type QUERY)

    • DELETE_AQ_NAME

  • ONEVIEW as Web Object Type

    • SUPPRESS_ONEVIEW_MENU

    • LAUCH_MODIFIED_OVR_SIDEPANEL

    • DOES_OVR_EXIST

    • PREVIEW (for Web Object Type ONEVIEW)

    • DELETE_OVR_NAME

    • FETCH_LAYOUTS

    • FETCH_FORMATS

    • RUN_MODIFIED_OVR

  • NONE as Web Object Type (Export/Import)

    • EXPORT_FRW_RPT

    • EXPORT_FRW_ROW

    • EXPORT_FRW_COL

    • IMPORT_FRW_RPT

    • IMPORT_FRW_ROW

    • IMPORT_FRW_COL

This is the order in which the various actions and their parameters are discussed in the next sections.

All input and output parameters not used during a specific action require a variable to be passed. The variable should be set to blank or set to the proper input or output value prior to the system function call. Using <BLANK> as an input or output parameter can cause issues with subsequent calls because the residual value of the parameter remains.

Important: Do not use <BLANK> in the input or output parameters. All parameters require a variable. Do not pass <BLANK> in any parameter. If a parameter is not listed for the action in the following sections, you should still pass a variable set to blank for that parameter.

Parameters for LOAD_NAMED_AQ

Use to load the modified Query side panel for storing modified metadata. This stops normal Query functionality in the application. The target event is Dialog Initialized or Post Dialog Initialized.

Action

Input, required. Value is LOAD_NAMED_AQ.

Web Object Type

Input, required. Value is QUERY.

Web Object Name

Input. Pass blank as a variable for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

Web Object Name Short

Input, required. This field should be the name of the query.

Application Name

Input, required. Must match calling application.

Form Name

Input, required. Must match calling form.

Version

Input, required. Must match calling form's version. Value may be Blank if there is no version.

Parameters for DOES_AQ_EXIST

Use to check if the passed in query name exists in F952471. The target event is Form/Row menu options or push buttons.

Note: AQEXAML or AQCRITERIAXML returns a formatted query string in the table name field. This can be used to send the information, along with the extracted data, to the BI Publisher server for processing.
Action

Input, required. Value is DOES_AQ_EXIST.

Web Object Type

Input. Value is QUERY.

Web Object Name

Input, required. Pass value to use primary key. Pass a variable set to blank for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, optional. Pass value to use with either primary or unique key. For example, AQEXAXML, AQWRTXML, or AQCRITERIAXML.

The default behavior of this action is to fetch the modified query's EXAXML record in F952471. Since XML Type is part of the primary key and the unique key, a specific valid value should be passed for it. If XML Type is not passed when using the DOES_AQ_EXIST action, then the system will use a default value of "AQEXAXML" to try and fetch the modified query's EXAXML record. If a valid EXAXML record exists in F952471, then it will be fetched. If a user wants to use the DOES_AQ_EXIST action to check if a modified query's WRTXML or CRITERIAXML records exist in F952471, then the XML Type value will have to be passed and it should have a value like "AQWRTXML" or "AQCRITERIAXML."

Web Object Name Short

Input, required. Pass for unique key.

Web Object Name Long

Input, optional.

Application Name

Input, required. Pass for unique key.

Form Name

Input, required. Pass for unique key. This must match LOAD_NAMED_AQ that inserts or updates the data.

Version

Input, required. Pass for unique key.

Table Name

Output. AQEXAXML or AQCRITERIAXML returns a formatted query string to be used with BI Publisher sample data.

Future Use 1

Output. F952471.XMWOFU1

Future Use 2

Output. F952471.XMWOFU2

Web Object Output

Output. F952471.XMOMRBLOB

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for PREVIEW When Used for Modified Query Preview

Use to load the query in preview/read only mode. The target event is Dialog Initialized or Post Dialog Initialized.

Action

Input, required. Value is PREVIEW.

Web Object Type

Input, required. Value is QUERY.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

Web Object Name Short

Input, required. This field should be the name of the query.

Application Name

Input, required. Must match calling application.

Form Name

Input, required. Must match calling form.

Version

Input, required. Must match calling form's version. Value can be Blank (as a variable) if there is no form version.

Parameters for DELETE_AQ_NAME

Use to delete a query attached to a One View Financial Statements component. The target event is Form/Row menu options or push buttons.

Action

Input, required. Value is DELETE_AQ_NAME.

Web Object Name

Input, optional. Pass value to use primary key. Pass variable set to blank for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, optional. Pass value to delete a specific record. Otherwise, pass variable set to blank to delete all records.

Web Object Name Short

Input, required. Pass for unique key.

Application Name

Input, required. Pass for unique key.

Form Name

Input, required. Pass for unique key.

Version

Input, required. Pass for unique key.

Error Message

Output. Returns blank when successful or an error code when it fails.

Parameters for SUPPRESS_ONEVIEW_MENU

Use to suppress the standard One View menu. SUPPRESS_ONEVIEW_MENU is a prerequisite to calling the LAUNCH_MODIFIED_OVR_SIDEPANEL and RUN_MODIFIED_OVR system functions. The target event is Dialog Initialized or Post Dialog Initialized.

Action

Input, required. Value is SUPPRESS_ONEVIEW_MENU.

Parameters for LAUNCH_MODIFIED_OVR_SIDEPANEL

Use to launch the modified One View Reporting side panel for One View Financial Statements. The target event is Dialog Initialized or Post Dialog Initialized.

Action

Input, required. Value is LAUCH_MODIFIED_OVR_SIDEPANEL.

Web Object Type

Input, required. Value is ONEVIEW.

Web Object Name

Input, required. Pass a value to use the primary key. Pass variable set to blank for a unique key.

Web Object User

Input, required. If not passed, defaults to *PUBLIC.

XML Type

Input, required. Value is OVRDESIGNXML.

XML Type is a mandatory field that has to be passed both when using Primary Key or Unique Key. If it is not passed when invoking the LAUNCH_MODIFIED_OVR_SIDEPANEL, then the system will, by default, use the value of "OVRDESIGNXML" . A literal String "OVRDESIGNXML" can be used as the default because for a particular report definition there is going to be only one "OVRDESIGNXML" record in F952471 at any point of time.

Web Object Name Short

Input, optional. Pass for unique key or pass variable set to blank.

Application Name

Input, optional. Pass for unique key or pass variable set to blank.

Form Name

Input, optional. Pass for unique key or pass variable set to blank.

Version

Input, optional. Pass for unique key or pass variable set to blank.

Future Use 1

Output. Pass blank as a variable or pass 1.

In F952471 table, the Future Use Flag 1 (WOFU1) can either have a blank value or it can have a value of "1". If it has no value/ blank value, then it means that a BIP Layout has not yet been created for that FRW Report. When this field has no value the Modified OVR side panel launches in Create Mode. When a BI Publisher layout is created, the system updates this field to a value of "1". The value of "1" is used to launch the Modified OVR side panel in Edit Mode.

Future Use 2

Output. Pass blank as a variable or pass 1.

In the F952471 table, the Future Use Flag 2 (WOFU2) has no value (blank value) to start with. Once a BI Publisher report has been created for a One View Financial Statements report, if the underlying xml for the report changes, then the system updates this field to a value of "1" . When a user launches the Modified OVR side panel and clicks on the Edit icon in the side panel to launch the BI Publisher Layout Editor, the system checks for the value of this field before launching the BI Publisher Layout Editor. If the value of this field is "1" , then the "sample.xml" is regenerated using the new xml and uploaded to BI Publisher for the already created report so that the layout can be designed using the updated xml. Once the new "sample.xml" is generated and uploaded to BI Publisher, the system resets the value of this field to "0" , so that the "sample.xml" will not be regenerated again when a user clicks on the Edit icon next time unless another change in XML is made. This field is updated to "1" whenever there is a change in XML so that the "sample.xml" can be regenerated using this new XML.

Parameters for DOES_OVR_EXIST

Use to check if the passed in One View report name exists in F952471. The target event is Form/Row menu options or push buttons.

Action

Input, required. Value is DOES_OVR_EXIST.

Web Object Type

Input, optional. Value is ONEVIEW.

Web Object Name

Input, required. Pass value to use primary key. Pass variable set to blank for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, optional. Pass value to use with either primary or unique key. For example, OVRDESIGNXML.

The default behavior of this action is to fetch the modified One View design-time xml record in F952471. Since XML Type is part of the primary key and the unique key, a specific valid value should be passed for it. If XML Type is not passed when using the DOES_OVR_EXIST action, then the system will use a default value of "OVRDESIGNXML" to try and fetch the modified One View design-time xml record. If a valid design-time xml record exists in F95247, then it will be fetched. If a user wants to use the DOES_OVR_EXIST action to check if a modified One View runtime xml record exists in F952471, then the XML Type value will have to be passed and it should have a value like "OVRRUNXML+RUNID" where "OVRRUNXML" is a static String and "RUNID" is dynamically generated. Since "RUNID" is dynamically generated by the Applications Development teams and there can be more than one runtime xml record for the same report definition, the system cannot use a default value for XML Type.

Web Object Name Short

Input, required. Pass for unique key or pass variable set to blank.

Application Name

Input, required. Pass for unique key.

Form Name

Input, required. Pass for unique key.

Version

Input, required. Pass for unique key.

Future Use 1

Output. F952471.XMWOFU1

Future Use 2

Output. F952471.XMWOFU2

Web Object Output

Output. F952471.XMOMRBLOB

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for PREVIEW When Used for Modified One View Reporting Preview

Use to load the modified One View Report in preview/read only mode. The target event is Dialog Initialized, Post Dialog Initialized, or Button Click events.

Action

Input, required. Value is PREVIEW.

Web Object Type

Input, required. Value is ONEVIEW.

Web Object Name

Input, required. Pass a value to use the primary key. Pass variable set to blank for a unique key.

Web Object User

Input, required. If not passed, defaults to *PUBLIC.

XML Type

Input, required. Value is OVRDESIGNXML.

Web Object Name Short

Input, optional. Pass for unique key or pass variable set to blank.

Application Name

Input, optional. Pass for unique key or pass variable set to blank.

Form Name

Input, optional. Pass for unique key or pass variable set to blank.

Version

Input, optional. Pass for unique key or pass variable set to blank.

Parameters for DELETE_OVR_NAME

Use to delete a One View report attached to a One View Financial Statements component. The target event is Form/Row menu options or push buttons.

Note: DELETE_OVR_NAME deletes the report template and data model on the BI Publisher server. The OVRDESIGNXML record is required for deleting BI Publisher artifacts. Do not manually delete the F952471 because this results in orphaned BI Publisher artifacts.
Action

Input, required. Value is DELETE_OVR_NAME.

Web Object Name

Input, optional. Pass value to use primary key. Pass variable set to blank for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, optional. Pass value to delete a specific record. Otherwise, pass blank as a variable to delete all records.

Web Object Name Short

Input, required. Pass for unique key.

Application Name

Input, required. Pass for unique key.

Form Name

Input, required. Pass for unique key.

Version

Input, required. Pass for unique key.

Error Message

Output. Returns blank when successful or an error code when it fails.

Parameters for FETCH_LAYOUTS

Use to fetch the layout names from the BI Publisher server. The target event is Dialog Initialized or Post Dialog Initialized.

Action

Input, required. Value is FETCH_LAYOUTS.

Web Object Name

Input, required. Pass value to use primary key. Pass blank as a variable for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, required. Value is OVRDESIGNXML.

Web Object Name Short

Input, optional. Pass for unique key or pass variable set to blank.

Application Name

Input, optional. Pass for unique key or pass variable set to blank.

Form Name

Input, optional. Pass for unique key or pass variable set to blank.

Version

Input, optional. Pass for unique key or pass variable set to blank.

Future Use 1

Output. Value is default layout.

Future Use 2

Output. Value is default format.

Web Object Output

Output. Value is a list of layouts delimited by pipe "|".

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for FETCH_FORMATS

Use to fetch the formats from the BI Publisher server for a specific layout that was retrieved by FETCH_LAYOUTS. The target event is Tab out of control (for the selected layout).

Action

Input, required. Value is FETCH_FORMATS.

Web Object Name

Input, required. Pass value to use primary key. Pass blank as a variable for unique key.

Web Object User

Input, optional. If not passed, defaults to *PUBLIC.

XML Type

Input, required. Value is OVRDESIGNXML.

Web Object Name Short

Input, optional. Pass for unique key or pass variable set to blank.

Application Name

Input, optional. Pass for unique key or pass variable set to blank.

Form Name

Input, optional. Pass for unique key or pass variable set to blank.

Version

Input, optional. Pass for unique key or pass variable set to blank.

Future Use 1

Output. Must be an existing layout from FETCH_LAYOUTS.

Web Object Output

Output. Value is a list of formats delimited by pipe "|".

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for RUN_MODIFIED_OVR

Use to run the One View Financial Statements, which will in turn kick off the BI Publisher report. The target event is Button Click or Form Exit Click.

Note: SUPPRESS_ONEVIEW_MENU action must be called as a prerequisite for this run action in the Dialog is Initialized or Post Dialog is Initialized event.The application name should be the same as the application that was used to create report in BI Publisher. In order to fetch the report in BI Publisher, the system uses a report URL (for example, /JD Edwards/DV910/P09330/Report1.xdo so the application name should always be the same at both report design and runtime.The layout and format with which the report must be run, have to be passed in the Future Use 1 and 2 fields respectively. If they are not passed, the default layout and default format are used to run the report.
Action

Input, required. Value is RUN_MODIFIED_OVR.

Web Object Type

Input, required. Value is ONEVIEW.

Web Object Name

Input, required. Pass value to use primary key. Pass blank as a variable for unique key.

Web Object User

Input, required. If not passed, defaults to *PUBLIC.

XML Type

Input, required. Value is OVRDESIGNXML.

XML Type is a mandatory field to be passed both when using Primary Key or Unique Key for the RUN_MODIFIED_OVR action. It should be passed and it should have a value like "OVRRUNXML+RUNID" where "OVRRUNXML" is a static String and "RUNID" is dynamically generated. The length of XML Type is 20 characters. Please note that RUNID should not exceed 11 characters. Since "RUNID" is dynamically generated by the Applications Development teams and there can be more than one runtime xml record for the same report definition, the system cannot use a default value for XML Type for the RUN_MODIFIED_OVR action.

Web Object Name Short

Input, optional. Pass for unique key or pass variable set to blank.

Application Name

Input, optional. Pass for unique key or pass variable set to blank.

Form Name

Input, optional. Pass for unique key or pass variable set to blank.

Version

Input, optional. Pass for unique key or pass variable set to blank.

Future Use 1

Input, required. Must be an existing layout in BI Publisher for passed report and it must be present in list of layouts from FETCH_LAYOUTS.

Future Use 2

Input, required. Must be one of the supported One View Financial Statement formats. For example, analyze, pdf, rtf, xlsx, or pptx.

Parameters for EXPORT_FRW_RPT

Use to export the F952471 advanced metadata, BI Publisher report template, and data model; F09330 report definition; F09310 report row definitions; F09320 report column definitions; and F09340 report version data in a zip format. Once the zip file is created, the file is sent to the browser for download. The zip file allows transport or transfer of information to another environment via import in the specified environment. The target event is Row Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is EXPORT_FRW_RPT.

Web Object Name

Input, not necessary if Web Object Short Name is present. Then pass variable set to blank.

Web Object User

Input, not necessary. If not passed, defaults to *PUBLIC.

Web Object Name Short

Input, not necessary if Web Object Name is present. Then pass variable set to blank.

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for EXPORT_FRW_ROW

Use to export the F952471 advanced metadata and F09310 row definition data in a zip format. Once the zip file is created, the file is sent to the browser for download. The zip file allows transport or transfer of information to another environment via import in the specified environment. The target event is Row Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is EXPORT_FRW_ROW.

Web Object Name Short

Input, Row Definition Name.; if exporting multiple, use "|" delimiter with string of multiple Row Definition Names.

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for EXPORT_FRW_COL

Use to export the F952471 advanced metadata and F09320 column definition data in a zip format. Once the zip file is created, the file is sent to the browser for download. The zip file allows transport or transfer of information to another environment via import in the specified environment. The target event is Row Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is EXPORT_FRW_COL.

Web Object Name Short

Input, Column Definition Name.; if exporting multiple, use "|" delimiter with string of multiple Row Definition Names.

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for IMPORT_FRW_RPT

Use to import the F952471 advanced metadata, BI Publisher report template, and data model; F09330 report definition; F09310 report row definitions; F09320 report column definitions; and F09340 report version data from the .zip file into the database tables. The end user will be required to choose the file for import. A message box will appear requesting user interaction if there are record conflicts. The target event is Form Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is IMPORT_FRW_RPT.

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for IMPORT_FRW_ROW

Use to import the F952471 advanced metadata and F09310 row definition data from the .zip file into the database tables. The end user will be required to choose the file for import. A message box will appear requesting user interaction if there are record conflicts. The target event is Form Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is IMPORT_FRW_ROW.

Error Code

Output. Returns blank when successful or an error code when it fails.

Parameters for IMPORT_FRW_COL

Use to import the F952471 advanced metadata and F09320 column definition data from the .zip file into the database tables. The end user will be required to choose the file for import. A message box will appear requesting user interaction if there are record conflicts. The target event is Form Menu, Push Button, or press Grid Icon.

Action

Input, required. Value is IMPORT_FRW_COL.

Error Code

Output. Returns blank when successful or an error code when it fails.