9 Form Extensibility (Release 9.2.2.4)

This chapter contains the following topics:

9.1 Form Extensibility Overview

The JD Edwards EnterpriseOne form extensibility feature enables you to extend a JD Edwards EnterpriseOne form dynamically without customizations.

Form extensibility enables citizen developers to meet industry, regional, and wider business requirements without requiring deep technical knowledge at a low cost.

You can use form extensibility to:

  • Add available (unused) business view columns as additional form controls.

  • (Release 9.2.3.3) Add available (unused) table columns associated with a business view as additional form controls.

  • (Release 9.2.3.3) Associate orchestrations with events, thereby enabling the system to invoke orchestrations from form or control events.

(Release 9.2.3) Beginning with JD Edwards EnterpriseOne Tools Release 9.2.3, you can use the form extension feature on all edit forms, except the Power Edit form, in addition to query-only forms.

You can further personalize the form extensions by using them with existing personalization frameworks such as advanced queries, watchlists, personal forms, CafeOne layouts, and grid formats. (Release 9.2.3) You can also use the extended form controls on AIS service requests and orchestrations. For more information, see the JD Edwards EnterpriseOne Tools Orchestrator Guide. Additionally, you can use the extended form controls to create a form service request with the JD Edwards EnterpriseOne Orchestrator Process Recorder. The form extensions feature is supported on Orchestrator Studio 7.0.0.0.

For example, as an inventory manager, you would like to add lot retest date information on the Lot Master record so that you can track when your lot needs to be retested. By using form extensions, you can add the lot retest columns from the business view on the inquiry application and then use them to create watchlist alerts. This will enable you to easily find out the lots that require to be retested soon.

Important:

  • You can create only one form extension for a JD Edwards EnterpriseOne form. You can modify or delete the form extension.

  • Only one user can work on a form extension at any time. When you are working on a form extension, if another user clicks the Form Extension icon on the same form, the system will display a message for that user, indicating that the form extension has been reserved by you.

  • If you use a form extension on a personal form and share the personal form but not the form extension, the extended form controls will not be displayed for other users. To enable other users to access the extended form controls, you must share the form extension.

The form extension capability is available on the following forms:

  • Find/Browse

  • Search & Select

  • Parent/Child Browse

    Note:

    On the Parent/Child Browse form, if you add a business view column to the grid, you can only add the column to the detail area of the grid and you cannot add it to the header area.
  • (Release 9.2.3) Fix/Inspect

  • (Release 9.2.3) Header Detail

  • (Release 9.2.3) Headerless Detail

  • (Release 9.2.3) Power Browse

Note:

(Release 9.2.3) In the Header Detail and Power Browse forms, there are multiple business views associated with the form. After you add a column associated with one of the business views, if you select a different business view, then the X mark on the field that you had added previously will be grayed out and disabled. This is because the field that you had added previously does not belong to the business view that you newly selected.

Your EnterpriseOne administrator must enable the feature, action, and view security to authorize you and other users to work with and view form extensions. See "Managing Security for User Defined Objects" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

You can secure the columns on a form extension by applying column security. See "Managing Column Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

The icons in the Form Extension Manager design panel are available for all UDOs. The Save As icon is not available for form extensions because only one form extension can exist for an EnterpriseOne form at any time.

The following icons are available in the Form Extension Manager design panel:

If any of the icons are grayed out, the action is not available for the form or is not available until you select another action.

For more information about the icons, see UDO Life Cycle and Statuses.

Notes:

  • Accessibility for form extensions is available only at runtime and is not supported in design mode.

  • Form extensions do not support right to left (RTL) text direction in the design mode.

9.2 Extending EnterpriseOne Forms Using Business Views

You can extend a JD Edwards EnterpriseOne form by adding available (unused) business view columns from the business view that is associated with the form dynamically without customizations. Using the Form Extension Manager, you can add business view columns on the form header and the grid based on your requirements when you are working on the form.

You can create a form extension only if your administrator has enabled the Form Extensions feature in the Security Workbench application (P00950). If you do not see the Form Extensions icon in the UDO design panel, you do not have permissions to create a form extension.

Adding Available (Unused) Table Columns to a Form (Release 9.2.3.3)

Beginning with Tools Release 9.2.3.3, you can extend a form by adding available (unused) table columns associated with a business view as additional form controls.

9.2.1 Creating a Form Extension Using Business Views

To create a form extension using business views:

  1. Open the EnterpriseOne application form that you want to extend.

  2. Click the Form Extension icon.

  3. In the Form Extension Manager side panel, select the applicable business view from the Select Business View drop-down list.

    This is the business view that contains the columns that you want to add to the form header or grid.

  4. Select one of the following options:

    • Form: Select this option to add columns to the form header.

    • Grid: Select this option to add columns to the grid.

    Based on the option that you select, the system displays the columns that are available for use on the form header or the grid.

    Note:

    (Release 9.2.3) The Form or Grid option will be displayed based on the type of form or the business view selected.
    • In the Fix/Inspect form, only the Form option will be displayed.

    • In the Header Detail form, only the Form option or the Grid option will be displayed based on the business view that you select.

  5. Make changes to the form as described below:

    • Adding Business View Columns or Table Columns

      You can add available business view columns or table columns associated with a business view to the form header or grid. Use the Column Search field to search for specific columns.

      (Release 9.2.3.3) When you hover over a column in the list of available columns, a tooltip text is displayed, indicating whether the column is a business view column or a table column that is associated with the business view. For example, a tooltip text that has Table Column set to "true" indicates that the column is a table column associated with the business view, and Business View Column set to "true" indicates that the column is a business view column.

      To add a business view column or a table column, perform one of these actions:

      • Select the column in the design panel and then drag and drop it to the appropriate position in the form header or grid.

      • Click the Add icon, represented by a green square with a + icon, located next to the column that you want to add.

        If you are adding the column to the form header, the form control corresponding to the column appears at the default position (top left corner of the form). If you are adding the column to the grid, the new column is added as the last column in the grid.

        (Release 9.2.3) If you are adding the column to a Power Browse form and if the column belongs to a subform, the form control corresponding to the column appears at the top left corner of the subform.

        Select the newly added form control and then drag and drop it to the appropriate position on the form header or grid. When you drag and drop a form control, guidelines are displayed. You can use the guidelines to position or align the form control on the form header or grid.

      (Release 9.2.3) For a Power Browse form that has more than one business view, you can add the column only to the subform that is associated with the business view that you selected. When you drag the column, the corresponding subform is highlighted. You cannot add the column to any other subform.

      Any column that you add to the form or grid has a Remove Form Control icon in the design panel and on the form. This indicates that the column has been newly added from the Form Extension Manager design panel.

      Note:

      For query-only forms, if next numbering is set up for the newly added column, the system does not generate the next number for that column. This will enable you to define the values you want to use.
    • Removing Business View Columns or Table Columns

      You can remove a business view column or a table column associated with a business view that was added as part of a form extension if you do not need it any longer.

      To remove a column, click the Remove Form Control icon located next to the column in the form or the design panel.

    • Resizing Form Header and Grid Areas

      You can increase or decrease the size of the form header and grid areas. For example, if you want to add a column to the form, you may want to increase the size of the form header area to accommodate the column. Resize the form header or grid area by placing your cursor on the blue border of the form header or grid area and then dragging the border.

    • Resizing Business View Columns or Table Columns

      You can resize the business view or table columns by placing the cursor on the blue border in the form and dragging the border as required. You can resize either the existing columns or the newly added columns. For example, you can resize an existing column to provide space to accommodate new columns.

    • Repositioning Business View Columns or Table Columns

      You can reposition the business view columns or table columns within a form. You can select the column that you want to reposition and drag it to a different position on the form.

    • Setting Filter Criteria

      After adding a column to the form header, you can set the filter criteria for that column. By default, the filter criteria for the column is set to None.

      To set the filter criteria, right-click the column and select Properties from the context menu. In the Properties dialog box, select the applicable filter criteria and select or clear the Wildcard Display option as applicable.

      The filter criteria determines how the system filters the records from the database at runtime. For example, if you select greater than or equal to (>=) as the filter criteria for the Company form control in the Customer Service Inquiry form, when a user enters 200 in the Company field at runtime and clicks Find, the system retrieves only those records that have Company value greater than or equal to 200.

      Note:

      (Release 9.2.3) The filter criteria context menu is available on the following forms:
      • Find/Browse

      • Search & Select

      • Parent/Child Browse

      • Header Detail

      • Headerless Detail

      • Power Browse

    • Updating Tab Sequence (Release 9.2.3)

      When you add a column to the form header, the maximum tab sequence value is assigned to the extended form control by default. You can modify the tab sequence of the fields on the form by using the Edit Tab Sequence option. The tab sequencing functionality behaves the same way as it does in FDA.

      While changing the tab sequence, you can enter only positive integers in the fields. If you do not enter any value for a field, the current value for the tab sequence is retained.

      Note:

      If you update tab sequences using the Form Design Aid, Form Extension Manager, and Personal Form Manager, the Personal Form Manager tab sequences take precedence over the other two.
    • Configuring Display of Fields in Add Mode or Update Mode (Release 9.2.3)

      When adding a column to a Fix/Inspect, Header Detail, or Headerless Detail form, you can choose to display that column when the form is opened in the Add mode or Update mode by selecting the Add Mode or Update Mode option. By default, the Update Mode option is selected and disabled.

      Note:

      When updating an extended form control, if the primary key for the field is not available because of application Event Rule (ER) logic, the system displays a warning message when you click OK.

      If the primary key for an extended field is not available in the Add mode, citizen developers can choose to hide that field in the Add mode.

  6. Click Save.

    The form extension name is displayed in the Name drop-down menu under the Personal category.

    Note:

    You cannot edit the name of the form extension because you can create only one form extension for an EnterpriseOne form at any time.

    If you request the form extension to be published, it appears in the Name drop-down menu under the Pending Approval category. After the form extension is approved for publishing, it appears under the Shared category.

    See Common Tasks for User Defined Objects for more information.

  7. Click Close Side Panel.

9.3 Extending EnterpriseOne Forms by Associating Orchestrations with Events (Release 9.2.3.3)

Beginning with Release 9.2.3.3, you can use the form extensibility framework to associate orchestrations with the events on an EnterpriseOne form. (Release 9.2.3.4) Beginning with Release 9.2.3.4, you can also associate notifications with the events on a form, invoke orchestrations in the synchronous mode, and map orchestration outputs to the form controls if any output has been defined for the orchestration.

Note:

You cannot associate orchestrations with events for the following controls:
  • Parent child controls

  • Tree controls

  • Grid controls

  • Labels

You can associate orchestrations with events by using the Associate Orchestrations wizard that is available from the Form Extension Manager side panel. The Associate Orchestrations wizard displays a series of steps that you must complete in a sequential order as shown in the following image:

Figure 9-1 Associate Orchestrations Wizard

Description of Figure 9-1 follows
Description of ''Figure 9-1 Associate Orchestrations Wizard''

As you move through the steps, a check mark on a step indicates that the step is complete and you can proceed to the next step in the series. A red exclamation point indicates that the step is not complete. Click the Next button to proceed to the next step and the Back button to go back to a previous step.

Note:

If an orchestration fails to execute, the system displays an error message. This behavior is similar to the way users are notified of asynchronous business function errors.

9.3.1 Prerequisite

Before you can associate orchestrations with events, you must ensure that an AIS server has been configured with your EnterpriseOne system.

9.3.2 Associating Orchestrations with Events

To associate orchestrations with events:

  1. Open the EnterpriseOne application form that you want to extend.

  2. Click the Form Extension icon.

  3. In the Form Extension Manager side panel, click the Associate Orchestrations link to open the Associate Orchestrations wizard.

    Note:

    If the AIS server is down even though the JAS server is running, an error message will be displayed beside the Associate Orchestrations link.
  4. In the Associate Orchestrations wizard, in the Select Event step (Step 1), click in the Control field to select the control that you want to associate with an orchestration.

    The EnterpriseOne form is enabled for selecting the events.

  5. In the EnterpriseOne form, select the control and its associated event by performing one of the following actions:

    • To select a form-level event, click anywhere in the white space on the form, tab, or subform area and then select the event from the list of events.

    • To select a control event, click in the control and then select the event from the list of events.

    Alternatively, to select the event, you can use the Event drop-down list in the Associate Orchestrations wizard.

  6. Click Next.

  7. In the Select Orchestration step (Step 2), select the orchestration or notification from the Orchestration Name drop-down list.

    Note:

    Only one orchestration or notification can be associated with one event.
  8. Click Next.

    If you click Next without selecting an orchestration, a red exclamatory point is displayed on the Select Orchestration step. A message is also displayed, indicating that you must select a valid orchestration to proceed.

  9. In the Define Inputs step (Step 3), define the mapping inputs for each orchestration input:

    • Mapping Input

      Click in the Mapping Input field. The EnterpriseOne form controls are enabled for selection as mapping inputs. Click the control that you want to use as a mapping input.

      The control that you selected is populated in the Mapping Input field.

      Notes:

      • The system does not perform any validation for the values that you define for the Mapping Input fields.

      • You can use extended form controls as mapping inputs.

      • When grid columns are used as mapping inputs, the selected row at runtime is passed as the mapping input to the orchestration. For editable grids, the selected row is the row that the cursor points to.

    • Default Value

      Use this field to enter a default value for the mapping input. The default value that you enter in this field will override the default value that is defined for the orchestration in the Orchestrator Studio.

      Note:

      When the orchestration is executed, the system determines the mapping inputs to be passed to the orchestration based on the following order of precedence:
      1. The system first checks to determine if a control value is defined. If a control value is defined, the system passes the control value as the mapping input to the orchestration.

      2. If a control value is blank or not defined, the system checks to determine if a default value is defined in the Associate Orchestrations wizard. If a default value is defined, the system passes the default value as the mapping input to the orchestration.

      3. If a control value or a default value is not defined in the Associate Orchestrations wizard, the orchestration honors the default value defined for the orchestration input in the Orchestrator Studio.

    • Allow Empty

      Use the Allow Empty toggle button if you do not want any mapping inputs to be passed to the orchestration. For example, if you want the orchestration to be executed without a mapping input being defined for an orchestration input, you can slide the toggle button to the right.

  10. In the Execution step (Step 4), you can view the event and orchestration details that you have defined in the previous steps. Use this step to define how the orchestration should be executed.

    • Select the Execute Before Event or the Execute After Event option to execute the orchestration before or after the event.

    • Use the Run Synchronously toggle button to run the orchestration in the synchronous or asynchronous mode.

      If you turn on this toggle button, the Define Outputs step (Step 5) is enabled to allow you to map orchestration outputs to the form controls if there are any outputs defined.

    • Use the Hide Error toggle button to hide the orchestration errors or show them as in-your-face errors on the form.

      If you choose to show the error messages, the system displays an informative message if the orchestration fails because of one or more of the following reasons:

      • The orchestration is not submitted because of a system error such as an invalid AIS configuration.

      • The user does not have UDO security to run the orchestration at runtime.

      • The system failed to execute the orchestration at runtime.

      • The mapped orchestration output is invalid. For example, if a field that is mapped to an orchestration output has been removed from the form in the FDA, the user will see an informative message on the form when the orchestration is executed.

        Note:

        The error messages are informative and do not stop the execution of the application ERs (event rules).

        For more information, see "Informative Messages".

    • Use the Show Progress toggle button to show or hide the progress of the execution of the orchestration.

  11. Click Next.

    Note:

    The system displays the Next button only if you turn on the Run Synchronously toggle button to run the orchestration in the synchronous mode.
  12. In the Define Outputs step (Step 5), click in the Mapping Output field and then click the control that you want to use as a mapping output.

    Note:

    The system enables the Define Outputs step only if you turn on the Run Synchronously toggle button to run the orchestration in the synchronous mode.
  13. Click Save.

  14. Click Close.

  15. Click Save in the Form Extension Manager side panel.

  16. Click Close Side Panel.

9.3.2.1 Modifying Associated Orchestrations

To modify associated orchestrations:

  1. In the Form Extension Manager side panel, click the Associate Orchestrations link.

    In the Associate Orchestrations wizard, the Saved Orchestration section displays the orchestrations that are associated with events on the EnterpriseOne form.

  2. Click the Edit icon for the orchestration for which you want to modify the association with events.

  3. Navigate through the steps in the wizard by using the Next and Back buttons and update the details as necessary.

  4. Click Save to save your changes or click Cancel if you do not want to save your changes.

  5. Click Close.

  6. Click Save in the Form Extension Manager side panel.

9.3.2.2 Deleting Associated Orchestrations

To delete associated orchestrations:

  1. In the Form Extension Manager side panel, click the Associate Orchestrations link.

    In the Associate Orchestrations wizard, the Saved Orchestration section displays the orchestrations that are associated with events on the EnterpriseOne form.

  2. Click the Delete icon to delete the association of an orchestration with an event.

  3. Click OK in the Confirmation dialog box.

  4. Click Close.

  5. Click Save in the Form Extension Manager side panel.

9.3.2.3 Supported Events

The following table describes the events for each control type that are supported for association with orchestrations using the Associate Orchestrations wizard:

Control Type Events
Text Field
  • Control is Entered
  • Visual Assist Button Clicked

  • Post Visual Assistant Clicked

  • Control is Exited

  • Control is Exited/Changed-Inline

  • Control is Exited/Changed-Asynch

Checkbox, radio button, combo box Selection Changed
Button
  • Button Clicked
  • Post Button Clicked

  • Post Button Clicked-Asynch

Fix Inspect
  • Dialog is Initialized
  • Post Dialog is Initialized

  • Clear Screen Before Add

  • Add Record to DB - Before

  • Add Record to DB - After

  • Update Record to DB - Before

  • Update Record to DB - After

  • Post Commit

  • End Dialog

Find/Browse, Search & Select, Parent/Child Browse
  • Dialog is Initialized
  • Post Dialog is Initialized

  • Grid Record is Fetched

  • Write Grid Line-Before

  • Write Grid Line-After

  • Last Grid Record Has Been Fetched

  • End Dialog

Power Browse
  • Dialog is Initialized
  • Post Dialog is Initialized

  • Grid Record is Fetched

  • Write Grid Line-Before

  • Write Grid Line-After

  • Last Grid Record Has Been Fetched

  • Notified by Child

  • End Dialog

Subform
  • Notified by Child
  • Notified by Parent

  • Grid Record is Fetched

  • Write Grid Line-Before

  • Write Grid Line-After

  • Last Grid Record Has Been Read

  • Add Record to DB - Before

  • Add Record to DB - After

  • Update Record to DB - Before

  • Update Record to DB - After

  • Post Commit

Header Detail
  • Dialog is Initialized
  • Post Dialog is Initialized

  • Grid Record is Fetched

  • Last Grid Record Has Been Read

  • Clear Screen Before Add

  • Clear Screen After Add

  • Write Grid Line-Before

  • Write Grid Line-After

  • Add Record to DB - Before

  • Add Record to DB - After

  • Update Record to DB - Before

  • Update Record to DB - After

  • Post Commit

  • End Dialog

Headerless Detail
  • Dialog is Initialized
  • Post Dialog is Initialized

  • Grid Record is Fetched

  • Last Grid Record Has Been Read

  • Clear Screen Before Add

  • Clear Screen After Add

  • Write Grid Line-Before

  • Write Grid Line-After

  • Post Commit

  • End Dialog

Tree
  • Set Focus On Tree
  • Tree Node Selected

  • Tree Node Is Expanding

  • Tree Node Is Collapsing

  • Double Click on Leaf Node

  • Get Custom Tree Node

  • Tree Node Is Deleted

  • Kill Focus On Tree

Chart Chart is Clicked
Tab Page
  • Tab Page is Initialized
  • Tab Page is Initialized

Calendar
  • Load Calendar Activity
  • Drill Into Calendar Activity

  • Drill Into Time Span

  • Add Activity Button Clicked

  • Post Add Activity Button Clicked

Label, Associated Description, Media Object, Text Block, Text Search No events supported
Grid, Parent Child Grid No events supported

9.3.2.4 Troubleshooting

This section describes some of the issues that you might encounter and the possible resolutions.

  • AIS login failure

    If you receive an "AIS Login Failure" message when you open the Form Extension Manager side panel, verify your AIS configuration settings in the jas.ini file.

  • No orchestration found

    If you see a message that indicates that no orchestration has been found when you open the Form Extension Manager side panel, check the user's security settings for the shared orchestrations and ensure that the user has View security permissions for the orchestrations.

  • AIS session timeout

    If you get an AIS session timeout message, check your AIS and JAS server timeout settings.

Informative Messages

This section describes the errors that can occur during orchestration processing. These are informative messages and do not stop the execution of the application ERs. To troubleshoot these messages, you need to contact your system administrator.

  • Error submitting the orchestration

    This message indicates that a problem exists with the AIS configuration settings.

  • Problem submitting orchestration <orchestration name>

    This message indicates that you do not have access to the UDO (orchestration). This occurs because either you do not have View security set up for the UDO or the UDO does not exist in the EnterpriseOne path code.

  • Error mapping the orchestration output

    This message indicates that at least one of the mapped output fields is missing. One of the reasons why this occurs is that one or more of the fields that are mapped to an orchestration output have been removed from the form in the FDA.

  • Error executing orchestration <orchestration name>

    This message indicates that there was a system error while executing the orchestration. For more information, see "Troubleshooting" in the JD Edwards EnterpriseOne Tools Orchestrator Guide.

9.4 Adding a New Web Button (Release 9.2.3.3)

You can use the form extensibility framework to add a new web button to an EnterpriseOne form without customizations.

Note:

Currently, you can only use the newly added web button to associate orchestrations with the button events.

To add a web button:

  1. In the Form Extension Manager side panel, select the Add Button button and then drag and drop it to the appropriate position on the form.

    Alternatively, click the Add Form Control icon (represented by a green square with a + icon). The new button appears at the default position (top left corner of the form).

  2. To rename the button, double-click the button and enter a new name. Alternatively, right-click the button, select Rename Label from the context menu, and then enter a new name.

  3. Click Save in the Form Extension Manager side panel.

    You can associate orchestrations with the events of the newly added web button. Associating an orchestration with the web button events is similar to associating an orchestration with the events for any existing EnterpriseOne form control. For more information, see Associating Orchestrations with Events.

9.5 Saving a Form Extension

If you are creating a form extension or modifying an existing one, you can click the Save icon to save the form extension. You can create and save only one form extension for an EnterpriseOne form.

If you close the Form Extension Manager design panel without saving the form extension, the system displays a warning message. If you click OK, the system does not save any changes made to the form. Click Cancel to go back and save your changes.

After saving the form extension, if you have permission to publish it, you can click the Request to Publish icon to request that the form extension be published. This moves the form extension to Pending Approval status. After the form extension is approved for publishing, it appears under the Shared category.

9.6 Modifying, Publishing, and Deleting a Form Extension

For more information about these common UDO tasks, see the following topics: