Edit forms editing-forms

From the menu, choose Administration > Configuration > Input forms.

Click the New button at the top right of the list.

Specify the form properties:

• Specify the form name and the namespace.

  The form name and the namespace can match the related data schema. This example shows a form for the cus:order data schema:

  code language-xml
  <form entitySchema="xtk:form" img="xtk:form.png" label="Order" name="order" namespace="cus" type="iconbox" xtkschema="xtk:form"> […] </form>

  Alternatively, you can explicitly specify the data schema in the entity-schema attribute.

  code language-xml
  <form entity-schema="cus:stockLine" entitySchema="xtk:form" img="xtk:form.png" label="Stock order" name="stockOrder" namespace="cus" xtkschema="xtk:form"> […] </form>

• Specify the label to be displayed on the form.

• Optionally, specify the form type. If you do not specify a form type, the console screen type is used by default.

  

  If you are designing a multipage form, you can omit the form type in the <form> element and specify the type in a container.

Click Save.

Insert the form elements.

For example, to insert an input field, use the <input> element. Set the xpath attribute to the field reference as an XPath expression. Read more.

This example shows input fields based on the nms:recipient schema.

<input xpath="@firstName"/>
<input xpath="@lastName"/>

If the form is based on a specific schema type, you can look up the fields for this schema:

1. Click Insert > Document fields.

   

2. Select the field and click OK.

   

Optionally, specify the field editor.

A default field editor is associated with each data type:

• For a date-type field, the form shows an input calendar.
• For an enumeration-type field, the form shows a selection list.

You can use these field editor types:

Read more about memory list controls.

Optionally, define access to the fields:

Example:

<container type="enabledGroup" enabledIf="@gender=1">
  […]
</container>
<container type="enabledGroup" enabledIf="@gender=2">
  […]
</container>

Optionally, use containers to group fields into sections.

<container type="frame" label="Name">
   <input xpath="@firstName"/>
   <input xpath="@lastName"/>
</container>
<container type="frame" label="Contact details">
   <input xpath="@email"/>
   <input xpath="@phone"/>
</container>

Change the type attribute of the <form> element to iconbox:

<form […] type="iconbox">

Set a container for each form page:

1. Add a <container> element as a child of the <form> element.

2. To define a label and an image for the icon, use the label and img attributes.

   code language-xml
   <form entitySchema="xtk:form" name="Service provider" namespace="nms" type="iconbox" xtkschema="xtk:form"> <container img="xtk:properties.png" label="General"> <input xpath="@label"/> <input xpath="@name"/> […] </container> <container img="nms:msgfolder.png" label="Details"> <input xpath="@address"/> […] </container> <container img="nms:supplier.png" label="Services"> […] </container> </form>

Alternatively, remove the type="frame" attribute from the existing <container> elements.

Change the type attribute of the <form> element to notebook:

<form […] type="notebook">

Add a container for each form page:

1. Add a <container> element as a child of the <form> element.
2. To define the label and the image for the icon, use the label and img attributes.

  <form entitySchema="xtk:form" name="Service provider" namespace="nms" type="notebook" xtkschema="xtk:form">
      <container label="General">
          <input xpath="@label"/>
          <input xpath="@name"/>
          […]
      </container>
      <container label="Details">
          <input xpath="@address"/>
          […]
      </container>
      <container label="Services">
          […]
      </container>
  </form>

Alternatively, remove the type="frame" attribute from the existing <container> elements.

Modify the factory input form:

1. From the menu, choose Administration > Configuration > Input forms.
2. Select an input form and modify it.

You can extend factory data schemas, but you cannot extend factory input forms. We recommend that you modify factory input forms directly without recreating them. During software upgrades, your modifications in the factory input forms are merged with the upgrades. If the automatic merge fails, you can resolve the conflicts. Read more.

For example, if you extend a factory schema with an additional field, you can add this field to the related factory form.

Create a validation function in a JS file.

Example:

function nms_recipient_checkValue(value)
{
  logInfo("checking value " + value)
  if (…)
  {
    logError("Value " + value + " is not valid")
  }
  return 1
}

In this example, the function is named checkValue. This function is used to check the recipient data type in the nms namespace. The value that is being checked is logged. If the value is not valid, then an error message is logged. If the value is valid, then the value 1 is returned.

You can use the returned value to modify the form.

In the form, add the <soapCall> element to the <leave> element.

In this example, a SOAP call is used to validate the @valueToCheck string:

<form name="recipient" (…)>
(…)
  <leave>
    <soapCall name="checkValue" service="nms:recipient">
      <param exprIn="@valueToCheck" type="string"/>
    </soapCall>
  </leave>
</form>

In this example, the checkValue method and the nms:recipient service are used:

• The service is the namespace and the data type.
• The method is the function name. The name is case-sensitive.

The call is performed synchronously.

All exceptions are displayed. If you use the <leave> element, then users cannot save the form until the entered information is validated.