Input Form Builder

Input Form Builder

This builder creates an input page for a data service operation or a method. It is much like View & Form input page support, but the next action after submitting the input form is a user-specified action. This builder is suitable for operations that do not have result data to display. If you do want to display result data from the operation, consider using the View & Form builder instead, since that builder generates a results page.
The OrdersServiceConsumer model in samples/gettingstarted shows an example of how this builder is used in an application.

Specifying inputs

This builder takes the inputs described in the table below. For help on inputs common to many or all builders such as those in the Properties and HTML Attributes input groups, see Using the Builder Call Editor.

Input name Description
Name Enter a name for this builder call. The designer tool displays this name in the builder call list.
Input Submit Operation data service operation or method to create the input page for. If you select a method, you also need to specify an input variable.
Input Variable Specify the name of the variable to use to generate the input page fields. When the input page is submitted the given values will be placed into this variable before the builder invokes the specified method. This input is visible only if you select a method for the Input Submit Operation.
Input Next Action action to call after the input form is submitted and the operation or method specified by Input Submit Operation is called.
Input Page Options
Input Page HTML Select an HTML page to be used as the basis for the input page. This page must have several named elements that define where the builder is to place page items related to collecting the view method's inputs.
HTML Template File Select an HTML page automation template file to be used to generate the input page. For more information, see HTML Page Automation templates.
Note that When an HTML Template files is in use, a number of inputs related to HTML class name generation will not be displayed.
Enable Input Validation Enable to activate schema-based validation on input page. Schemas can contain details about field input requirements including data type restriction. For more details about how validation works, see Data page builder and Techniques for Data Entry Validation.
Input Submit Text Enter a text string for the submit button. If not specified, the input value from the imported HTML file ("Submit" by default).
Initial Data For Input Form source of the data to populate the input form.
Label Translation and Sample HTML
Resource Bundle Name Specify a Java resource bundle to use for all labels for form fields and view columns. This input supports the internationalization of a model and provides a way to generate user-friendly labels for displayed fields. Use the selector to select the fully-qualified name of the property file or Java class to serve as the Form Resource Bundle. Example:
com.example.FormResources
Create Sample Input Page Use this button to generate a sample HTML Input page based on the builder inputs that you have specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.
Advanced
Generate Main Check this option to allow the builder to automatically generate a "Main" action. This action kicks off the model's execution and causes the display of either the input page. Uncheck this option to use a custom "Main" action of your own creation.

Input name	Description
Name	Enter a name for this builder call. The designer tool displays this name in the builder call list.
Input Submit Operation	data service operation or method to create the input page for. If you select a method, you also need to specify an input variable.
Input Variable	Specify the name of the variable to use to generate the input page fields. When the input page is submitted the given values will be placed into this variable before the builder invokes the specified method. This input is visible only if you select a method for the Input Submit Operation.
Input Next Action	action to call after the input form is submitted and the operation or method specified by Input Submit Operation is called.
Input Page Options
Input Page HTML	Select an HTML page to be used as the basis for the input page. This page must have several named elements that define where the builder is to place page items related to collecting the view method's inputs.
HTML Template File	Select an HTML page automation template file to be used to generate the input page. For more information, see HTML Page Automation templates. Note that When an HTML Template files is in use, a number of inputs related to HTML class name generation will not be displayed.
Enable Input Validation	Enable to activate schema-based validation on input page. Schemas can contain details about field input requirements including data type restriction. For more details about how validation works, see Data page builder and Techniques for Data Entry Validation.
Input Submit Text	Enter a text string for the submit button. If not specified, the input value from the imported HTML file ("Submit" by default).
Initial Data For Input Form	source of the data to populate the input form.
Label Translation and Sample HTML
Resource Bundle Name	Specify a Java resource bundle to use for all labels for form fields and view columns. This input supports the internationalization of a model and provides a way to generate user-friendly labels for displayed fields. Use the selector to select the fully-qualified name of the property file or Java class to serve as the Form Resource Bundle. Example: com.example.FormResources
Create Sample Input Page	Use this button to generate a sample HTML Input page based on the builder inputs that you have specified. Generating sample HTML is a good practice and can serve as a starting point for using custom HTML.
Advanced
Generate Main	Check this option to allow the builder to automatically generate a "Main" action. This action kicks off the model's execution and causes the display of either the input page. Uncheck this option to use a custom "Main" action of your own creation.