Designing processes - EMC Community Network

Designing processes - EMC Community Network Designing processes - EMC Community Network

community.emc.com
from community.emc.com More from this publisher
30.01.2015 Views

Creating the User Interface Figure 12 Process and form template version links When a form template associated with a process is checked out and a new version created, Forms Builder automatically links the process to the latest version of the template. Conversely, if you delete the most recent form template version, the associated process automatically points to the previous version. You also cannot delete a task, initiate process, or process parameter template if the template and its associated process are both non-current versions. However, if either the process or the associated form template are the current version, you can delete the form template. Custom error messages The custom error message is important to the validation process and requires careful consideration. It is also an important element of the UI design as it provides useful feedback to the user when entering data. Error messages are created in Forms Builder by the template designer during template creation and are entered in the error message field for each control on the Display tab in the Properties pane. When writing custom error messages, you should give the user-specific information about the correct value to enter. Telling the user that the value entered is invalid does not provide much guidance. It is better to phrase the message in a positive manner and provide an example of a valid value to enter. A good example would be: Enter a valid date using the format MM/DD/YYYY. Another technique that is helpful to users is to provide default values for controls that use specific masks, such as dates, social security numbers, and phone numbers, so that the user has an example to follow before entering a new value. If a control does not have a custom error message defined in the template and the value entered is not valid, the system displays a default error message. The default error messages are generic and only provide guidance as to the data constraints for the control. An example of a default message for an invalid data type is: Value entered is not valid for the integer data type. An example of a default message for an invalid value for a specific data constraint is: Enter a valid value equal to or greater than %%" (where %% = the defined minimum 74 EMC Documentum xCelerated Composition Platform Version 1.6 Best Practices Guide

Creating the User Interface value). While these messages may be helpful to the user, they are not as helpful as messages created specifically for a template, tailored to the data requirement for that template. Data adaptors Some general guidelines for using adaptors are: • Do not use too many different adaptors as it can impede performance. You can use one data source adapter to populate multiple fields at once by populating off one database table with multiple columns. This way, the adaptor only runs once. • Keep adaptors simple and lightweight and keep the execution time of data source adaptors as short as possible. • Do not perform high latency calls within data source adaptors, such as long-running queries or slow web service invocations, as these calls can greatly impede performance of the UI. • If you plan to use more than one adaptor, concentrate on getting one adaptor to work before creating another. • When using a data source adaptor, make sure that the input is required and that the output is repeating. • When creating a custom data source adaptor, you have a choice of creating it as a class or service-based business object (SBO). If you create it as a class first it is much easier to validate and debug the adaptor. You can then convert the adaptor to an SBO if desired. The following table provides information on which templates or controls each adapter can be used with, guidelines for how best to use each type of adaptor, and important limitations. Table 4 Adaptor Types and Uses Adaptor Type Item Initializer Available Templates or Controls Not available on folder information, process parameter, or task templates Available on these controls: Text Field, RichText, Number Field, Date Field, DateTime Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Readonly Table, Bar Codes, Slider, Embedded Form, and Filter Best Uses/Limitations Use this adaptor if you want a value entered automatically in a field when the template instance is created. The out-of-the-box item initializer is configured to enter the current date/time in a date/time field. To use your own logic, create a custom initializer. When using an item initializer for an integer value in a number field, also specify a default value for the field. On a document view template, the initialization will only execute when the document view is used while importing documents in TaskSpace. EMC Documentum xCelerated Composition Platform Version 1.6 Best Practices Guide 75

Creating the User Interface<br />

Figure 12<br />

Process and form template version links<br />

When a form template associated with a process is checked out and a new version created, Forms<br />

Builder automatically links the process to the latest version of the template. Conversely, if you delete<br />

the most recent form template version, the associated process automatically points to the previous<br />

version. You also cannot delete a task, initiate process, or process parameter template if the template<br />

and its associated process are both non-current versions. However, if either the process or the<br />

associated form template are the current version, you can delete the form template.<br />

Custom error messages<br />

The custom error message is important to the validation process and requires careful consideration. It<br />

is also an important element of the UI design as it provides useful feedback to the user when entering<br />

data. Error messages are created in Forms Builder by the template designer during template creation<br />

and are entered in the error message field for each control on the Display tab in the Properties pane.<br />

When writing custom error messages, you should give the user-specific information about the correct<br />

value to enter. Telling the user that the value entered is invalid does not provide much guidance. It is<br />

better to phrase the message in a positive manner and provide an example of a valid value to enter.<br />

A good example would be: Enter a valid date using the format MM/DD/YYYY.<br />

Another technique that is helpful to users is to provide default values for controls that use specific<br />

masks, such as dates, social security numbers, and phone numbers, so that the user has an example to<br />

follow before entering a new value.<br />

If a control does not have a custom error message defined in the template and the value entered is not<br />

valid, the system displays a default error message. The default error messages are generic and only<br />

provide guidance as to the data constraints for the control. An example of a default message for an<br />

invalid data type is: Value entered is not valid for the integer data type. An<br />

example of a default message for an invalid value for a specific data constraint is: Enter a valid<br />

value equal to or greater than %%" (where %% = the defined minimum<br />

74 <strong>EMC</strong> Documentum xCelerated Composition Platform Version 1.6 Best Practices Guide

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!