Skip Headers
JD Edwards EnterpriseOne Tools Development Tools: Form Design Aid Guide
Release 8.98 Update 4

Part Number E14706-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

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.

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


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.


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.


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.


Set Save Behavior on OK

Use this system function to set the form behavior after an OK button click.

Parameters

Behavior

Input, required. The behavior to use.

Set to <Save and Clear> to:

  • Save the current record.

  • Clear the form or subform.

  • Switch the form or subform to ADD mode.

  • Leave the form or subform open for further input

Set to <Save and Continue> to:

  • Save the current record.

  • Switch the form or subform to UPDATE mode.

  • Leave the form or subform open for further input

Set to <Save and Close> to:

  • Save the current record.

  • Close the form.

Note:

Remember that <Save and Close> is not valid for subforms.

Note:

The End Form on Add property has no effect when you use this system function. The system function sets the property to No if it is set to Yes.

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.


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:


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:

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.


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:


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:


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:


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:


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:


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:


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: