This appendix contains the following topic:
This appendix discusses most of the system functions that you can access through Form Design Aid (FDA).
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.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
Use this system function to clear the errors that have been set on a control.
Input, required. The form control (FC) to affect.Set Control Error
Use this system function to render a control unavailable for entry both by the user and programmatically. A disabled control is still visible.
Input, required. The FC to affect.Enable Control
Use this system function to render a control available for entry both to the end user and programmatically.
Input, required. The FC to affect.Disable Control
Use this system function to insert a functional URL into the application.
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.
Use this system function to prevent the user from seeing (and therefore interacting with) a control. Hidden controls can be manipulated programmatically.
Input, required. The FC to affect.Disable ControlShow Control
Use this system function to set an error on a control.
Input, required. The FC to affect.
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
Use this system function to change the label of a control in a given instance.
Input, required. The FC to affect.
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
Use this system function to select the data dictionary (DD) item to use for a control.
Input, required. The FC to affect.
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.
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.
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.
Use this system function to apply DD overrides of any type to a control based on any kind of data item (included BV items).
Input, required. The FC to affect.
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
Use this system function to set the text in the status bar for a given control, identified by its associated DD item.
Input, required. The DD item to affect. Set the parameter to an alphanumeric constant (<Literal>), <Blank>, or <Zero>.
To clear the status bar text, use this system function with a DD Alias parameter of <Blank> or <Zero>.
Use this system function to enable the user to see (and therefore interact with) a hidden control.
Input, required. The FC to affect.Set Control Text
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.
Input, required. The FC to affect.
Input, required. The object to which to return the Boolean. Set the parameter to an applicable object from the object list.
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.
This system function can return one of these values:
0
The control did not change.
1
The control changed.
These system functions affect applications in a variety of ways. They reside in the General folder in FDA.
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.
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.
Use this system function to copy currency information (type and number of decimal places) between controls.
Input (math numeric), required. The control to which to copy the currency data. Set the parameter to an applicable object from the object list.
Input (math numeric), required. The control from which to copy the currency data. Set the parameter to an applicable object from the object list.
Use this system function to call another form when the application ID, form ID, and data structure values are not known until runtime.
Input (string), required. The ID of the calling application.
Input (string), required. The identifier of the called form data structure.
Input (string), optional. The version of the called form.
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.
Use this system function to establish a report interconnection and launch a batch application (report).
Input (string), required. The report to launch. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
When launching a batch application (report), use this system function to launch the processing options dialog for it.
Input, required. The report being launched. Set the parameter to an alphanumeric constant (<Literal>), <Null>, or an applicable object from the object list.
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.
Use this system function to "click" a button in the current application programmatically.
Input, required. The button to "click." Set the parameter to an applicable object from the object list.
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.
Use this system function to launch an executable program outside of JD Edwards EnterpriseOne.
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.
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.
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.
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.
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.
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.
Use this system function to place focus on a specific control.
Input, required. The control to receive the focus. Set the parameter to an applicable object from the object list.
This is applicable for form controls and HCs. The event, Control Is Entered, fires on the control that receives focus.
Use this system function to change the title of the current form.
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.
Use this system function to set the form behavior after an OK button click.
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.Use this system function to set the time zone for the current form.
Input, required. The time zone to use for the current form. Set the parameter to an applicable object from the object list.
Use this system function to stop runtime from processing the ER on the current event. No parameters are necessary.
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.
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.
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.
Use this system function to prevent the runtime engine from executing a database fetch. No parameters are required.
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.
Use this system function to calculate the amount of time that passed between two dates.
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.
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.
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.
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.
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.
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.
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.
Use this system function to determine whether the interactive engine for the current form fetched a form record.
Input, required. The object to which to return the value. Set the parameter to an applicable object from the object list.
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.
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.
This system function enables your application to send email messages to users, groups, and so forth.
Input, optional. The account or accounts to which to send the email.
Input, optional. The account or accounts to which to send a courtesy copy of the email.
Input, optional. The account or accounts to which to send a blind courtesy copy of the email.
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.
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.
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.
Input, required. A link to a JD Edwards EnterpriseOne application. Set the parameter to the application to which to link or to <None>.
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>.
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>.
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>.
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.
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:
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.
Upload the template.
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.
Create a business function to populate the XML file and then run it.
Run the merge.
Use this system function to delete a generated document.
Input, required. The document to affect. Set the parameter to an applicable object from the object list.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
Use this system function to display a generated document to the user.
Input, required. The document to affect. Set the parameter to an applicable object from the object list.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
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.
Input, required. The template to affect. Set the parameter to an applicable object from the object list.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
Use this system function to download a document generation template in RTF format so you can edit it.
Input, required. The template to affect. Set the parameter to an applicable object from the object list.
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.
Input, required. The version of the template to download. Set the parameter to an applicable object from the object list.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
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.
Input, required. The template to affect. Set the parameter to an applicable object from the object list.
Input, required. The ID to assign to the XML file. Set the parameter to an applicable object from the object list.
Input, required. The template type. Set the parameter to <Mail Merge> or <Doc Gen>.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
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.
Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.
Input, required. The document generation template to use. Set the parameter to an applicable object from the object list.
Input, required. An indicator of whether to save the results of the operation to a separate file. Set the parameter to <TRUE> or <FALSE>.
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.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.Download Template for Doc GenGet XML Data Model
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.
Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.
Input, required. The mail merge template to use. Set the parameter to an applicable object from the object list.
Input, required. An indicator of whether to save the results of the operation to a separate file. Set the parameter to <TRUE> or <FALSE>.
Input, required. The ID to assign to the resulting document. Set the parameter to an applicable object from the object list.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.Download TemplateGet XML Data Model
Use this system function to run a full mail merge operation.
Input, required. The document generation template to use. Use an already-downloaded template. Set the parameter to an applicable object from the object list.
Input, required. The mail merge template to use. Set the parameter to an applicable object from the object list.
Input, required. The ID to assign to the resulting document. Set the parameter to an applicable object from the object list.
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
After designing it, use this system function to upload a mail merge template.
Input, required. The template to affect. Set the parameter to an applicable object from the object list.
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.
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.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.
After designing it, use this system function to upload a document generation template.
Input, required. The template to affect. Set the parameter to an applicable object from the object list.
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.
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.
Input, required. The version of the template to upload. Set the parameter to an applicable object from the object list.
This system function can return these values:
FAILED
Indicates the process was unsuccessful.
SUCCESS
Indicates the process completed normally.