A System Functions in Form Design Aid

This appendix contains the following topic:

This appendix discusses most of the system functions that you can access through Form Design Aid (FDA).

A.1 System Functions

You access and apply most system functions through Form Design Aid (FDA). System functions are visually grouped into folders based on function or control type. This appendix mirrors that system function folder organization; however, it does not describe the system functions that are detailed in a chapter devoted to a particular control type. Furthermore, some system functions are described in other locations entirely.

Note:

  • Do not use the system functions in the Deprecated or Obsolete folders.
  • The following System Functions in Mail Merge & Doc Gen has been deprecated from 9.2.4.0 tools release onwards.

    • Delete Document

    • Display Document

    • Download Template

    • Download Template for Doc Gen

    • Get XML Data Model

    • Run Doc Gen and Display

    • Run Mail Merge and Display

    • Run Multiple Mail Merge

    • Upload Template

    • Upload Template for Doc Gen

Control

These system functions are applied on the control level and work for most control types. System functions that apply to a specific control type do not appear here; they are described in the chapter dedicated to that control type.Edit Control System FunctionsTab Control System Functions

Clear Control Error

Use this system function to clear the errors that have been set on a control.

Parameter

Control

Input, required. The form control (FC) to affect.Set Control Error

Disable Control

Use this system function to render a control unavailable for entry both by the user and programmatically. A disabled control is still visible.

Parameter

Control

Input, required. The FC to affect.Enable Control

Enable Control

Use this system function to render a control available for entry both to the end user and programmatically.

Parameter

Control

Input, required. The FC to affect.Disable Control

Go to Url

Use this system function to insert a functional URL into the application.

Parameter

URL

Input, required. The fully-qualified URL to which to link. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Hide and Reclaim Space

Use this system function to hide a subform or groupbox and reclaim the space.

Parameters

Control

Input, required. The FC (subform or groupbox) to affect.

Additional Notes

The function will reclaim space by adjusting controls below the Input FC. The space for the Input FC will not be reclaimed if there are adjacent controls.

Hide Control

Use this system function to prevent the user from seeing (and therefore interacting with) a control. Hidden controls can be manipulated programmatically.

Parameter

Control

Input, required. The FC to affect.Disable ControlShow Control

Set Control Error

Use this system function to set an error on a control.

Parameters

Control

Input, required. The FC to affect.

Error Code

Input, required. The error to set on the control. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.Clear Control Error

Set Control Text

Use this system function to change the label of a control in a given instance.

Parameters

Control

Input, required. The FC to affect.

Text

Input, required. The text to show as the label for the control. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.Clear Control Error

Set Data Dictionary Item

Use this system function to select the data dictionary (DD) item to use for a control.

Parameters

Control

Input, required. The FC to affect.

DD Alias

Input, required. The DD item to which to apply to the control. Set the parameter to select a DD item from the Data Dictionary dialog (<Pick DD Item>) or an applicable object from the object list.

System Code

Input, required. The system code to use when determining whether to apply system code-based jargon to the DD item text fields. Set the parameter to match the current system code (<Default>) or an applicable object from the object list.

Additional Notes

The control must be a DD item, not database item. When changing them, the DD items to be switched must be of the same type except for one case: You can change a string to a character but not vice versa. If you make a change between string types, the maximum size of the new string item will be the smaller size of the two switched items.

Set Data Dictionary Overrides

Use this system function to apply DD overrides of any type to a control based on any kind of data item (included BV items).

Parameters

Control

Input, required. The FC to affect.

Overrides

Input, required. The override to apply. Set the value to <Data Dictionary Overrides>, or double-click <Data Dictionary Overrides> to select specific overrides to set.Set Control Text

Set Statusbar Text

Use this system function to set the text in the status bar for a given control, identified by its associated DD item.

Parameter

DD Alias

Input, required. The DD item to affect. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, or <Zero>.

Additional Notes

To clear the status bar text, use this system function with a DD Alias parameter of <Blank> or <Zero>.

Show Control

Use this system function to enable the user to see (and therefore interact with) a hidden control.

Parameter

Control

Input, required. The FC to affect.Set Control Text

Was Value Entered

Use this system function to determine if a form control has been changed. A return value of zero indicates no change, and a return value of one indicates a change.

Parameters

Control

Input, required. The FC to affect.

Return To

Input, required. The object to which to return the Boolean. Set the parameter to an applicable object from the object list.

Additional Notes

Two flags track the changes: the form flag and the control flag. When a control is changed, both flags are set to one. When Was Value Entered is called and a specific control is selected for the control parameter, the current value of the control flag is returned. The control value is then set to zero. The form flag remains the same. When <All Controls> is selected for the control parameter, the current value of the form flag is returned. The form flag value is then set to zero, but the control flag remains the same.

Returns

This system function can return one of these values:

  • 0

    The control did not change.

  • 1

    The control changed.

Expand Group Box

Use this system function to expand a group box.

Parameter

GroupBox

Input, required. The FC to affect.

Note:

The collapsible functionality needs to be activated in the group box properties to use this system function. To expand all expandable group boxes at once select <All Collapsable GroupBoxes> from Available Objects.

Collapse Group Box

Use this system function to collapse a group box.

Parameter

GroupBox

Input, required. The FC to affect.

Note:

The collapsible functionality needs to be activated in the group box properties to use this system function. To collapse all expandable group boxes at once select <All Collapsable GroupBoxes> from Available Objects.

General

These system functions affect applications in a variety of ways. They reside in the General folder in FDA.

Cancel User Transaction

Use this system function to cancel any transaction committed by the user. The current transaction is assumed to be the one to cancel, so no input parameters are necessary.

Continue Custom Data Fetch

Use this system function to set up a custom fetch routine for page-at-a-time processing. Called on the Get Custom Grid Row event, it causes runtime to add lines to the grid (one at a time) until the page is full. No input parameters are necessary.

Copy Currency Information

Use this system function to copy currency information (type and number of decimal places) between controls.

Parameters

To Control

Input (math numeric), required. The control to which to copy the currency data. Set the parameter to an applicable object from the object list.

From Control

Input (math numeric), required. The control from which to copy the currency data. Set the parameter to an applicable object from the object list.

Dynamic Form Interconnect (Web Only)

Use this system function to call another form when the application ID, form ID, and data structure values are not known until runtime.

Parameters

Application ID

Input (string), required. The ID of the calling application.

Form ID

Input (string), required. The identifier of the called form data structure.

Version

Input (string), optional. The version of the called form.

DS Value

Input (string), optional. Contains all the data structure values needed to be passed to the form in the format id|value|id|value... and so on.

Get VCard (Release 9.2.1)

Use this system function within a hover form to get the VCard information, including the VCard string and VCard name, that was set on the static text control using the Set VCard system function.

Parameters

Static Text

Input (string), required. The name of the static text control.

VCard String

Output (string). The content of the VCard that is returned.

VCard Name

Output (string). The name of the VCard that is returned.

Launch Batch Application

Use this system function to establish a report interconnection and launch a batch application (report).

Parameters

Report Name

Input (string), required. The report to launch. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Version Name

Input (string), required. The version of the report to launch. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Print Preview?

Input (character: Y/N), required. An indicator of whether to display a print preview of the report. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Data Selection?

Input (character: Y/N), required. An indicator of whether to provide the user the opportunity to override the default data selection for the report. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Data Sequencing?

Input (character: Y/N), required. An indicator of whether to provide the user the opportunity to override the default data sequencing for the report. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Push Specs Only?

Input (character: Y/N), required. An indicator of whether to submit the specifications from the version only. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

PO Template Name

Input (string), required. The processing option data structure to use. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Prompt for Values?

Input (character: Y/N), required. An indicator of whether to prompt the user for processing option values. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Date Last Executed

Input (JDEDATE), required. The source for the date indicating when the report was run. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Data Source Override

Input (string), required. The source for the data upon which to base the report. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

JDE Log?

Input (character: Y/N), required. An indicator of whether to generate a JDE.log file. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

JDEDebug Log?

Input (character: Y/N), required. An indicator of whether to generate a Jdedebug.log file. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

UBE Logging Level?

Input (integer), required. The level of detail to apply when compiling Jdedebug.log. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Jargon Code

Input (string), required. The system code corresponding to the jargon values you want to apply. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Cover Page?

Input (character: Y/N), required. An indicator of whether to print a cover page for the report. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Job Queue Name

Input (string), required. The name to use to identify the job after it has been submitted to the job queue. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

TC Prompting?

Input (character: Y/N), required. An indicator of whether to prompt the user for table conversion option values. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Process Type

Input (character), required. The type of process to run. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Launch Processing Options Dialog

When launching a batch application (report), use this system function to launch the processing options dialog for it.

Parameters

Object Name

Input, required. The report being launched. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Version Name

Input, required. The version of the report being launched. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.

Press Button

Use this system function to "click" a button in the current application programmatically.

Parameter

Control

Input, required. The button to "click." Set the parameter to an applicable object from the object list.

Additional Notes

This is applicable for enabled (but not necessarily visible) form controls and HCs. The event, Button Clicked, fires for the control that is pushed. Note that this system function moves the focus to the control that was activated.

Run Executable

Use this system function to launch an executable program outside of JD Edwards EnterpriseOne.

Parameters

EXE Directory

Input (string), required. The location of the executable. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

EXE Name

Input (string), required. The name of the executable. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Parameters #1

Input (string), required. The first input parameter to pass to the executable. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Parameters #2

Input (string), required. The second input parameter to pass to the executable. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Parameters #3

Input (string), required. The third input parameter to pass to the executable. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Working Directory

Input (string), required. The location where the executable should place its temporary files. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Send Email (Release 9.2.1)

Use this system function within a hover form to send an email to the list of recipients.

Parameters

Recipients

Input (string), required. A list of recipients to send the email to.

Show Parameterized URL

Input, required. Value is <YES> or <NO>. If <YES>, the parameterized URL is attached to the email.

Send Meeting Request (Release 9.2.1)

Use this system function within a hover form to send a meeting request to the list of recipients.

Parameters

Recipients

Input (string), required. A list of recipients to send the meeting request to.

Show Parameterized URL

Input, required. Value is <YES> or <NO>. If <YES>, the parameterized URL is attached to the meeting request.

Set Control Focus

Use this system function to place focus on a specific control.

Parameter

Control

Input, required. The control to receive the focus. Set the parameter to an applicable object from the object list.

Additional Notes

This is applicable for form controls and HCs. The event, Control Is Entered, fires on the control that receives focus.

Set Form Title

Use this system function to change the title of the current form.

Parameter

New Title

Input, required. The title to display on the form. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Dynamic Form Interconnect (Web Only)

Use this system function to call another form when the application ID, form ID, and data structure values are not known until runtime.

Parameters

Application ID

Input (string), required. The ID of the calling application.

Form ID

Input (string), required. The identifier of the called form data structure.

Version

Input (string), optional. The version of the called form.

DS Value

Input (string), optional. Contains all the data structure values needed to be passed to the form in the format id|value|id|value... and so on.

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.

Set Time Zone On Form

Use this system function to set the time zone for the current form.

Parameter

Time Zone

Input, required. The time zone to use for the current form. Set the parameter to an applicable object from the object list.

Set VCard (Release 9.2.1)

Use this system function within a hover form to set the VCard information for a static text control.

Parameters

Static Text

Input (string), required. The name of the static text control.

VCard String

Input (string), required. The content of the VCard.

VCard Name

Input (string), required. The name of the VCard.

Stop Processing

Use this system function to stop runtime from processing the ER on the current event. No parameters are necessary.

Suppress Add

Use this system function to prevent the runtime engine from executing a database add. No parameters are required. Call this system function on the Add Rec to DB - Before or Add Grid Rec to DB - Before event rule, as appropriate.

Suppress Default Visual Assist Form

Use this system function to prevent the default form from appearing when the user clicks a visual assist. No parameters are required. Call this system function on the Visual Assist Button Clicked event, followed by a call to the form that you want to open instead.

Suppress Delete

Use this system function to prevent the runtime engine from executing a database delete. No parameters are required. Call this system function on the Delete Rec to DB - Before or Delete Grid Rec to DB - Before event rule, as appropriate.

Suppress Find

Use this system function to prevent the runtime engine from executing a database fetch. No parameters are required.

Suppress Update

Use this system function to prevent the runtime engine from executing a database update. No parameters are required. Call this system function on the Update Rec to DB - Before or Update Grid Rec to DB - Before event rule, as appropriate.

Time Between

Use this system function to calculate the amount of time that passed between two dates.

Parameters

Start UTC

Input (JDEUTime), required. The first date in Universal Time Code (UTC). Set the parameter to an alphanumeric constant (<Literal>) or an applicable object from the object list.

End UTC

Input (JDEUTime), required. The second date in Universal Time Code (UTC). Set the parameter to an alphanumeric constant (<Literal>) or an applicable object from the object list.

Days

Input, required. The object to which to assign the number of days that have passed. Set the parameter to an applicable object from the object list.

Hours

Input, required. The object to which to assign the number of hours that have passed. Set the parameter to an applicable object from the object list.

Minutes

Input, required. The object to which to assign the number of minutes that have passed. Set the parameter to an applicable object from the object list.

Seconds

Input, required. The object to which to assign the number of seconds that have passed. Set the parameter to an applicable object from the object list.

Returns

This system function returns the difference in days, hours, minutes, and seconds between two dates to the objects identified by Days, Hours, Minutes, and Seconds, respectively.

Was Form Record Fetched

Use this system function to determine whether the interactive engine for the current form fetched a form record.

Parameter

Return To

Input, required. The object to which to return the value. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • 0

    Either no fetch attempt was made, or a fetch attempt failed.

  • 1

    A record was fetched successfully.

Messaging

You should use only one of the system functions in this group: Send Message Extended. The other system functions in the Messaging folder are intended for internal JD Edwards development use only.

Send Message Extended

This system function enables your application to send email messages to users, groups, and so forth.

Parameters

To recipient

Input, optional. The account or accounts to which to send the email.

Cc recipient

Input, optional. The account or accounts to which to send a courtesy copy of the email.

Bcc recipient

Input, optional. The account or accounts to which to send a blind courtesy copy of the email.

Mailbox

Input, required. The mailbox name to which to deliver the email. The mailbox is used only if the mail is delivered to Work Center. For mail delivered externally (such as SMTP mail), this parameter is ignored. Set the parameter to a specific mailbox or to an applicable object from the object list.

Subject

Input, required. The text to display in the subject line of the email. If the value is <Blank> or<Zero>, and you are basing the email on a DD item using the Message parameter, then the system sets the subject line to the DD item description, if one exists.

Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Text

Input, required. The text to display in the body of the email. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, <Zero>, or an applicable object from the object list.

Shortcut

Input, required. A link to a JD Edwards EnterpriseOne application. Set the parameter to the application to which to link or to <None>.

Message

Input, optional. The text to display in the body of the email, based on a DD item glossary. The recipient formatting preferences (for dates, times, and numeric values) as well as language preference (should a translation for this DD item be available) are used when composing the text that represents the message. Set the parameter to the DD item you want to use, or to <None>.

Media Object Name

Input, optional. The name of the media object to include in the email. Set the parameter to an applicable object from the object list, or to <None>.

Media Object Key

Input, optional. The key of the media object to include in the email. Set the parameter to an applicable object from the object list, or to <None>.

Additional Notes

The Send Message Extended system function supports multiple ways to define the recipient of a mail. You can dictate that the message is for a limited group (such as individuals, distribution lists, and so forth), or you can make the recipients dynamic. The delivery method is based on each user's email preferences. You must send the message using at least one of the recipient parameters, although which one you use is immaterial to the system.

When mapping a recipient parameter, these options are available:

  • AB Number

    To send a message to a single user, enter the address book number of a user as the recipient. The mail will be sent to the default contact (contact number 0) for this address book number. Set the parameter to an applicable object from the object list.

    Note:

    JD Edwards EnterpriseOne version 8.10 applications do not employ contacts; therefore, email is sent directly to a user based on the address book number.
  • Contact

    To send a message to an individual in a user's contact list, enter the address book number of a user and then the number of the contact. Set the parameters to an applicable object from the object list.

    Note:

    JD Edwards EnterpriseOne version 8.10 applications do not employ contacts; therefore, this parameter has no effect.
  • Grouped Distribution List

    To send a message to the members of a distribution list, enter the address book number of the list and its structure type. Set the parameters to an applicable object from the object list.

  • Hierarchical Distribution List

    To send a message to the members of a hierarchical distribution list, enter the distribution list structure type, and the address book number of the node to start from in the list. Set the parameters to an applicable object from the object list.

    Note:

    This option is available only from within the JD Edwards EnterpriseOne workflow modeler.
  • SMTP Address

    To send a message to a single user, enter the SMTP address of the user as the recipient. Set the parameter to an applicable object from the object list.

  • Define Dynamic Recipient

    This option enables the selection of any kind of recipient at runtime, as opposed to choosing the kind of recipient at design time (AB Number, Contact, Grouped Distribution List, Hierarchy Distribution List, or SMTP Address).

    All the parameters must be mapped to objects from the available object list. At runtime, the recipient is chosen dynamically based on the value of the Recipient Type:

    • Recipient Type is '00':

      This is the equivalent of selecting <None>.

    • Recipient Type is '01':

      This is the equivalent of selecting <Contact>. The subfields Address book Number and Contact Number are used to determine the recipient.

    • Recipient Type is '02':

      This is the equivalent of selecting <AB Number>. The sub field Address book Number is used to determine the recipient.

    • Recipient Type is '03':

      This is the equivalent of selecting <Grouped Distribution List>. The subfields Address book Number and Structure Type are used to determine the recipients where Address book Number is the AB number for the distribution list and Structure Type is the organizational structure, based on UDC 01/TS.

    • Recipient Type is '04':

      This is the equivalent of selecting <Hierarchical Distribution List>. The subfields Address book Number and Structure Type are used to determine the recipients where Structure Type is the structure and list to use and Address book Number is the point in the hierarchy from which to start.

      Note:

      This hierarchical resolution is available only when you send the email to the JD Edwards EnterpriseOne work center.
    • Recipient Type is '05':

      This is the equivalent of selecting <SMTP Address>. The sub field SMTP Address will be used to determine the recipient.

    • Other values

      Do not use other values, as they are reserved for future use. The list of supported recipient types is defined by the UDC 98/SM.

  • None

    To not specify a recipient (use None when a recipient is optional).

The body of the email can be preset text (Text), or can be based on a DD item (<Message>). In either case, you can include a media object (<Media Object Name> and <Media Object Key>) and or a link directly to a JD Edwards EnterpriseOne application (<Shortcut>) as well.

Attachments can be sent with the mail, by providing the Media Object Name and Media Object Key parameters.

The system function will retrieve the attachments stored within the Media Object specified, and add the data to the mail sent. Only the Media Object 'RTF Text' and 'URL File' attachment types are supported.

Mail Merge & Doc Gen (Web Only)

These system functions enable you to automate mail merge and document generation tasks. They constitute a part of a larger process, as this outline illustrates:

  1. Create an RTF in Microsoft Word to use as the template for a merge.

    Use Word's field feature to indicate where to place text at merge time. You can create multiple RTF files and then use the CompositeGeneration business function (BSFN B980043) to create a single template from them.

  2. Upload the template.

  3. Call the Get XML Data Model system function to process the template.

    Among other files, the system function creates an XML file to populate with data for the merge.

  4. Create a business function to populate the XML file and then run it.

  5. Run the merge.

Note:

The following System Functions in Mail Merge & Doc Gen has been deprecated from 9.2.4.0 tools release onwards.
  • Delete Document

  • Display Document

  • Download Template

  • Download Template for Doc Gen

  • Get XML Data Model

  • Run Doc Gen and Display

  • Run Mail Merge and Display

  • Run Multiple Mail Merge

  • Upload Template

  • Upload Template for Doc Gen

Delete Document

Use this system function to delete a generated document.

Parameters

Document ID

Input, required. The document to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the delete. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Display Document

Use this system function to display a generated document to the user.

Parameters

Document ID

Input, required. The document to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the display. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Download Template

Use this system function to download a mail merge template in RTF format so you can edit it. To enable users to save the RTF template from the browser, the template name must not contain spaces.

Parameters

Template ID

Input, required. The template to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the download. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Download Template for Doc Gen

Use this system function to download a document generation template in RTF format so you can edit it.

Parameters

Template ID

Input, required. The template to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the download. Set the parameter to an applicable object from the object list.

Version

Input, required. The version of the template to download. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Get XML Data Model

Use this system function to process a template after uploading. This system function breaks the template into three parts: an XSL file, an XML file, and one or more image files (if any images were included in the template). Then, use a business function to populate the XML file with the data to merge.

Parameters

Template ID

Input, required. The template to affect. Set the parameter to an applicable object from the object list.

XML Data ID

Input, required. The ID to assign to the XML file. Set the parameter to an applicable object from the object list.

Data Type

Input, required. The template type. Set the parameter to <Mail Merge> or <Doc Gen>.

Status

Output (string), required. The object to which to assign the code that indicates the success of the acquire. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Run Doc Gen and Display

Use this system function to run a document generation operation and display the results to the user. You can choose to save the resulting document.

Parameters

Template ID

Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.

Data File ID

Input, required. The document generation template to use. Set the parameter to an applicable object from the object list.

Save

Input, required. An indicator of whether to save the results of the operation to a separate file. Set the parameter to <TRUE> or <FALSE>.

Document ID

Input, required. The ID to assign to the document, should you choose to save it. Set the parameter to an applicable object from the object list.

Status

Output (string), required. The object to which to assign the code that indicates the success of the operation. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

Run Mail Merge and Display

Use this system function to run a mail merge operation that consists of the first two variable sets in the XML file, and then display the results to the user. The resulting document is saved.

Parameters

Template ID

Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.

Data File ID

Input, required. The mail merge template to use. Set the parameter to an applicable object from the object list.

Save

Input, required. An indicator of whether to save the results of the operation to a separate file. Set the parameter to <TRUE> or <FALSE>.

Document ID

Input, required. The ID to assign to the resulting document. Set the parameter to an applicable object from the object list.

Status

Output (string), required. The object to which to assign the code that indicates the success of the operation. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

Run Multiple Mail Merge

Use this system function to run a full mail merge operation.

Parameters

Template ID

Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.

Data File ID

Input, required. The mail merge template to use. Set the parameter to an applicable object from the object list.

Document ID

Input, required. The ID to assign to the resulting document. Set the parameter to an applicable object from the object list.

Additional Notes

This system function launches an operation that merges all of the data sets in the XML file with the template to create a .pdf. The process runs asynchronously, so it will not overtax the web server. Before running a system function such as Display Document, ensure that the operation has completed. To do so, perform a table I/O on column FNDFUF1 in table F980042. If the return string is PENDING, the operation is still running. If the return string is SUCCESS, then the operation is complete.Download TemplateGet XML Data Model

Upload Template

After designing it, use this system function to upload a mail merge template.

Parameters

Template ID

Input, required. The template to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the upload. Set the parameter to an applicable object from the object list.

File (full path)

Output (string), required. The object to which to assign the full path name of the uploaded file. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.

Upload Template for Doc Gen

After designing it, use this system function to upload a document generation template.

Parameters

Template ID

Input, required. The template to affect. Set the parameter to an applicable object from the object list.

Return Code

Output (string), required. The object to which to assign the code that indicates the success of the upload. Set the parameter to an applicable object from the object list.

File (full path)

Output (string), required. The object to which to assign the full path name of the uploaded file. Set the parameter to an applicable object from the object list.

Version

Input, required. The version of the template to upload. Set the parameter to an applicable object from the object list.

Returns

This system function can return these values:

  • FAILED

    Indicates the process was unsuccessful.

  • SUCCESS

    Indicates the process completed normally.