Associating Orchestrations with Events
To associate orchestrations with events:
Open the EnterpriseOne application form that you want to extend.
Click the Form Extension icon.
In the Form Extension Manager side panel, click the Associate Orchestrations link to open the Associate Orchestrations wizard.
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.
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.
Select one of the Orchestration/Notification/Logic Extension tabs to associate so that the respective list of items will be listed in the next step.
Note:Depending on the tab selected in this step, you can see that all the labels will change correspondingly to orchestration/notification/logic extension.
If the AIS server is down even though the JAS server is running, an error message will be displayed in orchestration/notification tabs. This error message will not be displayed in logic extension tab, as logic extension is independent of AIS server.
Click Next.
In the Select orchestration/notification/logic extension step (Step 2), select the orchestration/notification/logic extension from the drop-down list. You can use the Search field to search for the orchestration/notification/logic extension.
Note: Only one orchestration/notification/logic extension can be associated with one event.Click Next.
If you click Next without selecting an item from the drop-down, a red exclamation point is displayed on the Select Orchestration step. A message is also displayed, indicating that you must select a valid orchestration to proceed.
In the Define Inputs step (Step 3), define the mapping inputs for each orchestration input:
Multi-Line Inputs
(Release 9.2.6.4 update) The Multi-Line Inputs toggle button has been added to enable array inputs. If you enable the toggle button, the grid values are consolidated in an array format, and you can enter multiple-line values. If the toggle button is not enabled, the system does not show the array input option.
(Optional) Name
(Tools Release 9.2.8.2) You can edit the input fields in the Name section to modify the name of the orchestration or notification or logic extension input according to your preference. To modify inputs field names, click the input field you want to edit and enter a new name to modify the existing name of the orchestration or notification or logic extension input. In case of multi-line inputs, you can modify the name of the multi-line input in the Associate Orchestration wizard, and to modify the individual grid inputs click the Array icon and enter a new name for the orchestration or notification or logic extension input you want to edit in the window that is displayed. If you modify the name of the input from a form extension, the system displays the renamed input only when you the orchestration is called from that form.
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.
Note: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.
you can not map the form controls to the array inputs when multi-line input toggle button is enabled.
(Release 9.2.7.3) For the string inputs in the orchestration or logic extension or notification, a drop-down with option SL version name is enabled. Use this drop-down option to map the application version from which it is launched. The SL version name option enables you to process the orchestration or logic extension or notification based on the application version from which it is launched.
When the SL version name is selected, the default value field is disabled. The corresponding Allow Empty and Allow Input toggle buttons are also disabled and turned off by default.
Default Value
Use this field to enter a default value for the mapping input. When you place the cursor in the Default Value field, you see a balloon that displays the input data type. 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: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.
If the control value is SL version name, then the system passes the application version from which it is launched.
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.
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.
-
You can provide multi-line input to an orchestration having array inputs. If the input type is array, then click the corresponding Array icon under Default Value in the Associate Orchestration wizard. A pop-up box is displayed that contains an array of inputs including the default values from the orchestration studio. You can modify, delete, or add new rows. Click Save to save your changes in the grid.
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.
Allow Input
Use the Allow Input toggle button if you want to override inputs before running the orchestration. When you slide the toggle button to the right in design time, a popup window displays all the inputs for which the Allow Input option is enabled in run time. You can update the inputs if required before running the orchestration.
Starting with Tools Release 9.2.7.3, you can design a logic extension with the ability to change the simple user interface on the form, for example, to show, hide, enable, disable, or change the colour of a control. When you associate a logic extension that contains form controls, the system displays the Map Form Controls tab next to the Define Inputs tab.
In the Map Form Control tab, click in the Mapping Control 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 system displays the Control ID automatically.
Note: You will see a List icon in the Mapping Control field if the input type is Form Control List the Logic Extension. Click the List icon and then in the control list window, click in the Mapping Control field and then click the fields in the form to map the controls. For more information, see Adding a Form Control Function (Release 9.2.7.3) in the JD Edwards EnterpriseOne Tools Orchestrator Guide.
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/notification in the synchronous or asynchronous mode. For orchestration configured with file as output in Orchestration studio and logic extension, this toggle button is turned on and disabled as its execution is always synchronous.
Note: 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 and Notification errors or show them as in-your-face errors on the form. For Logic Extension, if this toggle button is turned off, then errors will be displayed in a pop-up.
If you choose to show the error messages, the system displays an informative message if the orchestration/notification/logic extension fails because of one or more of the following reasons:
The orchestration/notification is not submitted because of a system error such as an invalid AIS configuration. Logic extension is independent of AIS server.
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/notification/logic extension 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 and Notification.
(Release 9.2.4) Use the Disable Form on Error toggle button to prevent the user from performing any transactions on the form. If you enable this toggle button, only the Close button is enabled and all other controls are disabled or hidden if the orchestration fails execution.
Note: The system enables the Disable Form on Error toggle button only if you turn on the Run Synchronously toggle button to run the orchestration in the synchronous mode.- (Release 9.2.6) Use the Show Message toggle button to show or hide the orchestration and notification success message that has been defined for the orchestration in the Orchestrator Studio. If you enable this toggle button, when you run the orchestration at runtime, if the orchestration runs successfully, the Orchestration Messages dialog box displays the custom orchestration success message defined for the orchestration.
-
Enable the Allow User to Cancel toggle button to cancel the orchestration/notification/logic extension in run time using close or cancel button. If the Allow User to cancel button is not enabled in design time, then the close or cancel the Orchestration option is disabled in run time. By default, this toggle button is turned on.
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.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.Click Save.
Click Close.
Click Save in the Form Extension Manager side panel.
Click Close Side Panel.
When you run the orchestration/notification/logic extension at runtime, the system displays the Enter Input pop-up box with Orchestration Inputs and File Inputs tab based on the below configuration:-
The system displays the Orchestration Inputs tab only if you turn on the Allow Input toggle button for any of the orchestration/notification/logic extension inputs in the Associate Orchestration wizard.
-
The system displays the File Inputs tab only if you select the orchestration which has file inputs enabled in the orchestrator studio.
If the input type is array, then click the corresponding Multiple Inputs button under Default Value in the Enter Input pop-up window. A pop-up box is displayed that contains an array of inputs with the default values. You can modify, delete, or add new rows. Click OK to save your changes in the grid.
You can resize the pop-up box by using the Resize icon in the bottom-right corner to accommodate the number of columns and rows that you want to display in the pop-up box.
In the File Inputs tab, you can upload file inputs for Orchestrations. When you select the File Inputs tab, the file upload option is displayed where you can select or drop the files for uploading. You can upload individual or multiple files, depending on the File Inputs configuration selected in the Orchestration Studio.
Note: The maximum file size depends on the MaxFileUploadSize configuration in Server Manager. If file size exceeds the configured maximum, an error message is displayed.In the Enter Input dialog box, enter new values for the inputs as applicable and upload the required files. Click Reset to clear the values or click OK to run the orchestration/notification/logic extension..
According to the output configuration in the associated orchestration, if the Files option is selected in the Orchestrator Studio, then you can download the file after the execution of the orchestration. A pop-up orchestration message is displayed with a download file button that allows you to download the response as a single file or a zip file, depending on the File Output configuration selected in the Orchestrator Studio.
By clicking the Download File button, the file is downloaded to the browser's default download directory.
> quick tour :Click here to view a recording of this feature.> tutorial :Click here to view a recording of this feature.> oracle by example:Click here to view an OBE of this feature.Note:An asterisk (*) displayed beside the Value field for an orchestration/notification/logic extension input indicates that the input is mandatory. If the Value field is blank for a required input, when you click OK, a message is displayed to indicate that you must enter a value in the field to proceed.
WebCenter Portal does not support File Selector for Orchestrations Launched from a Form Extension and Free-form Input for Orchestrations Launched from Form Extensions features.
-