EMC Documentum Forms Builder

Transcription

1 EMC Documentum Forms Builder Version 6 User Guide P/N EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published August 2007 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface... 9 Chapter 1 Overview Introduction to Forms Builder Understanding templates Understanding the data model Understanding shared data models Supported data types Understanding adaptors Using forms with process templates Form storage Chapter 2 Creating Templates Starting and logging in to Forms Builder Understanding template types Name and label constraints Creating a form template Creating a template for a search interface Selecting object types for a search template Selecting result set columns for a search template Specifying search criteria for a search template Specifying search restrictions for a search template Specifying a DQL query for a search template Completing the search template creation Modifying the query in a search template Modifying column settings for a search template Specifying the character formatting in a column Creating a template for a document view Selecting an object type for a document view template Completing the document view template creation Configuring the viewer in a document view template Creating a template for folder information Selecting an object type for a folder information template Completing the folder information template creation Configuring whether users can edit folder information Creating a template for folder contents Selecting object types for a folder contents template Selecting columns for a folder contents template Specifying filters for a folder contents template Specifying search criteria for a folder contents template Completing the folder contents template creation Modifying search criteria for a folder contents template Modifying column settings for a folder contents template EMC Documentum Forms Builder Version 6 User Guide 3

4 Table of Contents Managing filters for a folder contents template Creating or modifying a filter Selecting different document types for a folder contents template Overview of process initiation configuration Overview of configuring direct association of activity to template Overview of configuring association of activity to package and package to template Creating a template for initiating a process Selecting a process for an initiate process template Selecting process variables for an initiate process template Completing the initiate process template creation Creating a template for a task list Selecting an inbox type for a task list template Selecting processes for a task list template Selecting structured data types for a task list template Selecting columns for a task list template Specifying filters for a task list template Specifying search criteria for a task list template Completing the task list template creation Modifying process selection for a task list template Modifying search criteria for a task list template Modifying column selection for a task list template Modifying column settings for a task list template Managing filters for a task list template Selecting different structured data types for a task list template Creating a template for a task interface Selecting a process for a task template Selecting an activity for a task template Selecting process variables for a task template Selecting a document view for a task template Completing the task template creation Saving a template Validating and installing a template Changing the template state Opening an existing template Deleting templates Chapter 3 Editing Templates Understanding the Forms Builder user interface Data Model pane UI Model pane Design pane Preview pane Design Boxes pane Controls pane Properties pane Toolbar Adding and modifying UI objects Changing the template title Adding text Adding a link Adding an image Adding a text field Adding a rich text field EMC Documentum Forms Builder Version 6 User Guide

5 Table of Contents Adding a number field Adding a date field Adding a date time field Adding a single checkbox Adding a checkbox group Adding a radio button group Adding a list box Adding a drop-down list Adding a button Adding a print button Adding an attachment Adding a comment history Adding a table Adding a read-only table Adding a tab group Configuring the tabs in a tab group Adding a single tab to a tab group Adding a horizontal line Adding spaces around UI objects Adding a design box Adding Tab key navigation Adding a hot key Localizing hot keys Hiding a UI object Specifying an initializer Specifying a validator Specifying an external data source Specifying a SetValue adaptor Using a calculation formula Setting conditional properties Context-aware simulation Setting form properties Changing the UI layout of a template Deleting UI objects Configuring the display properties of UI objects Configuring the data and storage properties of UI objects Configuring the special properties of UI objects Configuring the style properties of UI objects Adding and modifying data objects Adding a data group Adding a data item Moving data objects Deleting data objects Configuring data storage properties Opening the View All Storage Mappings dialog box Storing data as an XML file Storing data as an XML file with repository attributes Storing data values in repository attributes Creating a new storage object type Managing object attributes Configuring storage mapping rules Chapter 4 Managing Adaptors Understanding adaptors Understanding the Adaptor Configuration Manager Opening the Adaptor Configuration Manager dialog box Using initializers EMC Documentum Forms Builder Version 6 User Guide 5

6 Table of Contents Using validators Using data source adaptors Using the properties file data source adaptor Using the repository data source adaptor Using the JDBC data source adaptor Data source adaptor examples Using document processors Creating a complex output type Removing an adaptor configuration Assigning adaptors to a template Chapter 5 Localizing Templates Understanding localization Marking a template for localization Exporting a template for localization Understanding the properties file Translating a properties file Importing a properties file Viewing the template in the new locale Merging properties files Configuring additional locales Appendix A Notes for the End User Locking a form instance AJAX support Glossary EMC Documentum Forms Builder Version 6 User Guide

7 Table of Contents List of Figures Figure 1. Shared data model Figure 2. Welcome to Forms Builder dialog box Figure 3. New Template wizard: Binding data Figure 4. New template wizard: Object type for a search template Figure 5. New template wizard: Result set columns for a search template Figure 6. New Template wizard: Search criteria for a search template Figure 7. New Template wizard: Search restrictions for a search template Figure 8. New Template wizard: DQL query for a search template Figure 9. Figure 10. Figure 11. New template wizard: Document object type for a document view template New template wizard: Folder object type for a folder information template New template wizard: Document object types for a folder contents template Figure 12. New template wizard: Columns for a folder contents template Figure 13. New template wizard: Filters for a folder contents template Figure 14. New template wizard: Search criteria for a folder contents template Figure 15. Filter dialog box Figure 16. Sample initiate process view Figure 17. New template wizard: Process for an initiate process template Figure 18. New template wizard: Process variables for an initiate process template Figure 19. New template wizard: Inbox type for a task list template Figure 20. New template wizard: Processes for a task list template Figure 21. New template wizard: Structured data types for a task list template Figure 22. New template wizard: Columns for a task list template Figure 23. New template wizard: Filters for a task list template Figure 24. New Template wizard: Search criteria for a task list template Figure 25. New template wizard: Process for a task template Figure 26. New template wizard: Activity for a task template Figure 27. New template wizard: Process variables for a task template Figure 28. New template wizard: Document view template for a task template Figure 29. Forms Builder user interface Figure 30. Condition dialog box for adding conditions Figure 31. Adaptor Configuration Manager Figure 32. Localization Process Figure 33. Localization - export: Export templates for localization EMC Documentum Forms Builder Version 6 User Guide 7

8 Table of Contents List of Tables Table 1. Forms Builder data types Table 2. Adaptor types Table 3. Template files Table 4. Template types Table 5. Form object name and label constraints Table 6. Search criteria conditions Table 7. Configurable items Table 8. Column settings Table 9. Column settings Table 10. Comparison of process initiation configuration methods Table 11. Reducing the task list Table 12. Column settings Table 13. Template states Table 14. Toolbar icons Table 15. UI objects Table 16. Formatting buttons in Rich Text field control Table 17. Design boxes and their limitations Table 18. Input binding and possible value list selection in Data & Storage tab Table 19. UI object display properties in the Display tab Table 20. Data properties in the Data & Storage tab Table 21. Additional UI properties in the Special tab Table 22. Style properties in the Style tab Table 23. Data group properties in the Data & Storage tab Table 24. Data item properties in the Data & Storage tab Table 25. Built-in adaptors Table 26. Adaptor Configuration Manager properties Table 27. Database table values Table 28. Checkbox group values EMC Documentum Forms Builder Version 6 User Guide

9 Preface This guide describes how to use the Forms Builder software to design templates and store them in a repository for later use. The templates are deployed using WDK-based client applications, such as Webtop and TaskSpace. The form-based templates can also be associated with other EMC Documentum products, such as Documentum Process Builder. Intended audience This guide is intended for form designers who need to create custom forms that capture information from end users. This guide assumes that the designer has a basic understanding of the EMC Documentum Content Server, repositories, workflows, and XML. Organization This guide contains the following chapters: Chapter 1, Overview This chapter provides an overview of Forms Builder and describes the underlying concepts, such as the data model used by Forms Builder, the supported data types, and form data storage. Chapter 2, Creating Templates This chapter describes how to log in to the Forms Builder software and create new templates. The different types of templates supported by the Forms Builder software are form, search, document view, folder information, folder contents, initiate process, task list, and task. Chapter 3, Editing Templates This chapter describes how to add or remove controls, objects, and properties on templates, such as UI controls, data objects, and data storage properties. Chapter 4, Managing Adaptors This chapter describes how to manage adaptors and associate them with a template. EMC Documentum Forms Builder Version 6 User Guide 9

10 Preface Chapter 5, Localizing Templates This chapter describes how to localize a form template to display form instances based on that template in different languages depending on the user s locale. Appendix A, Notes for the End User This appendix contains general notes for users. Information in this appendix pertain to the forms runtime environment. A glossary and an index are also included. Typographic conventions The following text conventions are used in this guide. Typographic conventions Convention bold Italic Courier Meaning Boldface type indicates graphical user interface elements associated with an action, key names, or terms defined in text or the glossary. Example: From the File menu, select Adaptors. Italic type indicates book titles, or emphasis in text. Example: More information on installation instructions is available in the Documentum Forms Builder Installation Guide. Courier type indicates commands within a paragraph, code in examples, syntax examples, system output, filenames and pathnames (if shown on separate line), or text that you enter. Example: public void destroy() throws AdaptorException; Courier Italic Courier bold italic type indicates user input variables for which you supply particular values, or variables in command strings. Example: All file names have the format <template_name>.xfm. 10 EMC Documentum Forms Builder Version 6 User Guide

11 Preface Support information EMC Documentum s technical support services and policies are available at the EMC Powerlink website ( To download the Customer Guide to EMC Software Support Services from Powerlink, select Support > About EMC Customer Service > Software Customer Guide. To order printed documentation or access support information in Powerlink, select Support > About EMC Customer Service > Software Support Offerings. Related documentation The following guides pertain to forms or to closely related subjects: Documentum Application Builder User Guide This guide describes the concepts and provides instructions for developing and deploying connection brokers in the EMC Documentum repository. Documentum Content Server DQL Reference Manual This manual is the reference manual for Document Query Language (DQL), supported by Documentum Content Server. Documentum Process Builder User Guide This guide explains how to create business process templates and workflows. Documentum XML Application Development Guide This guide describes the XML-related capabilities of the Documentum Content Server, and explains how to design applications that exploit those capabilities. Documentum Forms Builder Development Guide This guide explains how to create and deploy custom adaptors in forms. Documentum Forms Builder Installation Guide This guide explains how to install the Forms Builder software on your local machine. Documentum Forms Builder Release Notes The release notes describes the specific hardware and software versions that are required for the installation of the Forms Builder software. You can go to the Documentation area of the Powerlink website ( com) to download product documentation, white papers, or participate in the technical publications customer survey. To locate product documentation, select Support > Documentation and White Papers Library, and then select your product. You must register online at Powerlink before using it. EMC Documentum Forms Builder Version 6 User Guide 11

12 Preface Revision history The following changes have been made to this guide: Revision history Revision Date August, 2007 Description Initial Release 12 EMC Documentum Forms Builder Version 6 User Guide

13 Chapter 1 Overview This chapter provides an overview of the Forms Builder software and some of the basic underlying concepts. This chapter contains the following topics: Introduction to Forms Builder, page 13 Understanding templates, page 14 Understanding the data model, page 15 Supported data types, page 16 Understanding adaptors, page 18 Using forms with process templates, page 19 Form storage, page 19 Introduction to Forms Builder Forms Builder is an interactive tool that lets you create and modify form-based templates and store them in a repository. A template is the definition of a form. It specifies the data items and user interface elements associated with the form, default data values, the ways to validate user entries, and the format for transmitting the data to the program presenting the form. Once a template is installed in a repository, an administrator can use other Web Development Kit-based (WDK-based) applications, such as Webtop or TaskSpace, to access the template and create instances based on the template. These instances are then available for end users to view and modify repository data using a Web browser. Templates can also be associated with a package in Process Builder (formerly Business Process Manager) and launched from the Documentum Inbox or the Start Workflow page. Forms Builder uses the following World Wide Web Consortium (W3C) standards: EMC Documentum Forms Builder Version 6 User Guide 13

14 Overview XForms for defining forms in a device-independent way. An XForms model separates what a form does from the way it appears to end users. The EMC Documentum implementation of XForms is derived from the open source Chiba implementation. XML Schema for defining the XML structure that contains the data corresponding to form instance. XSL transformation and cascading style sheets (CSS) to render the form and data into HTML, so users can view and modify the form data in a Web browser. The W3C website, provides more information about these standards. Understanding templates On a program level, Forms Builder consists of a UI model and an underlying data model. The UI model specifies the user interface of the form, such as the arrangement of input fields, radio buttons, checkboxes, tables, tabs, and image viewers. The data model specifies the data types and data relationships of the form; for example, what kind of data a user can enter and how the data is stored in the repository. When you design a template, the Forms Builder software constructs the UI and the data model for the form based on the template. In the Forms Builder application, the UI model and the data model are displayed in a workspace. The Forms Builder software provides a multipart workspace that allows you to construct the UI and data models simultaneously. The workspace consists of the following parts: Data Model pane displaying a tree view of the data model. UI Model pane displaying a tree view of the UI model. Design pane displaying the workspace to design the form. Preview pane displaying a preview of the form. Design Boxes pane displaying a list of available design boxes; a design box lets you manipulate the behavior of UI objects in a template. Controls pane displaying the available UI objects; you can use the drag-and-drop feature to add these objects into the Design pane. Properties pane with tabs displaying the properties of UI objects, data items, and their relationship, as well as the different visual style enhancements available. Except for static items like display strings, each UI model item may have a corresponding item in the data model. The data item has a type and a collection of possible values. More information on how to create templates is available in Chapter 2, Creating Templates. 14 EMC Documentum Forms Builder Version 6 User Guide

15 Overview Understanding the data model When you design the UI model for a template, the Forms Builder software automatically creates the data model and the data binding by offering a default data item for each new UI item. You can edit some or all of a data model manually by adding, changing, or removing data items. The data model is stored as an XML schema. The process of mapping UI items to data items is called data binding. The data mapping must satisfy the following conditions: Each data item must have a type, and each UI item can map only to compatible data items. A UI item can map to only one data item, but multiple UI items can map to the same type of data item. Static controls like messages or links are not mapped to data items. You can optionally bind UI groups to data groups, so that the UI and data models have a parallel structure. When you create a form, you can create a new data model, or share or copy an existing data model from another form, as described in Understanding shared data models, page 15. Understanding shared data models When you create the UI model for a template, you have the choice of creating a new data model or using an existing data model. You can use an existing data model by either copying it from, or sharing it with, an existing template. When you copy a data model, the new template is completely independent from the original. Any changes you make to the copy does not affect the original. When you share a data model, any changes you make to the existing or the new template are reflected in both templates. A shared data model can be used in the following situations: Collecting data with one form and displaying it on another form. Combining input from different forms. When forms share a data model, you can bind data items or data groups to controls in one or both forms, as described in Adding and modifying UI objects, page 99. You can add, modify, or delete UI objects and add data objects. If you modify or delete a data object, however, you should make sure that the change does not affect other forms that are sharing that data model. Figure 1, page 16 illustrates a shared data model. EMC Documentum Forms Builder Version 6 User Guide 15

16 Overview Figure 1. Shared data model In the above figure, both Form A and Form B can alter the contents of Data Item 3. Supported data types When you add a UI object to a form template, the Forms Builder software automatically creates a default data item for that UI object and binds the data item to the matching data type. Data items and data types have the following dependencies: Only one data type can be bound to a specific data item at any given time. A data item that allows only one data type cannot be used with a UI object that allows selection of data types. A data item that allows multiple values can be combined with a UI object that accepts only a single value. Table 1, page 17 describes the data types that the Forms Builder software supports. 16 EMC Documentum Forms Builder Version 6 User Guide

17 Overview Table 1. Forms Builder data types Data type string Description Any UTF-8 character, such as characters, a mix of numbers, characters, symbols, and multibyte characters. byte Integers ranging from -128 to 127. int Integers ranging from to short Integers ranging from to long float double boolean date datetime anyuri Integers ranging from to Single-precision floating point (based on 32-bit IEEE 754). Double-precision floating point (based on 64-bit IEEE 754). The Boolean data type can have the value true or false. Date in a date format. Date in a date and time format (hours, minutes, seconds). Time is stored in 24-hour format. Any type of URI address; for example, an FTP, HTTP, gopher, mailto, or Telnet address. richtext attachment The anyuri data type only applies to the Link UI control. Text with HTML markup (used only by the rich text control). The ID for a repository object. The attachment data type only applies to the attachment UI object. EMC Documentum Forms Builder Version 6 User Guide 17

18 Overview Understanding adaptors Every form template specifies how to handle the data that is associated with the form, such as initial data values, instructions for validating data a user enters, and storing the data when the form is submitted. Adaptors consist of a Java class, service-based business object (SBO), or a JDBC connector class, that is linked to the form or to particular data items within the form. Internally, every adaptor is stored as a dmc_xfm_adaptor_config object derived from dm_sysobject. The Forms Builder software provides several built-in adaptors and you can also develop your own custom adaptors. The Documentum Forms Builder Development Guide contains additional information about developing custom adaptors. Once an adaptor is installed in the repository, designers can use the Adaptor Configuration Manager to configure and edit the adaptor. Depending on the template requirements, designers can specify default values for data items and perform basic pattern-based validation locally or use adaptors to link externally defined initialization or validation routines to the template. The Forms Builder software supports several types of adaptors, as described in Table 2, page 18. There are two adaptor categories, global adaptors and template adaptors. Global adaptors can be used for more than one template, while template adaptors only apply to one specific template. All global adaptors are stored in the /System/Forms/Adaptors folder in the repository. Template adaptors are stored with the associated template in the /System/Forms/<template-name>/Adaptors folder, where <template-name> is the name of the template folder. Table 2. Adaptor types Adaptor type Data source Item initializer Item validator Description Populates a data input control with a list of values retrieved from a database. This adaptor can only be used to populate individual data items. Sets the initial data values and can be used for an individual data item. Runs when the form instance is created. Validates the data items on the form using custom logic, returning true or false. Runs before the form is saved. 18 EMC Documentum Forms Builder Version 6 User Guide

19 Overview Adaptor type Document validator Document processor Description Validates the entire form using custom logic, returning true or false. Runs before the form is saved. Runs any required tasks before or after submitting the form. Chapter 4, Managing Adaptors describes how to configure and edit adaptors. The Documentum Forms Builder Development Guide contains detailed information about the XML schema for adaptors and the interfaces for the implementation classes, and how to create custom adaptors. Note: In the previous release, all adaptors were grouped in the adaptor_config.xml configuration file in the /System/Forms folder in the repository. Upgrading to the current release of the Forms Builder software does not remove the adaptor_config.xml file, so other applications can still access the file. However, you must run the migration tool to migrate the adaptor configuration information, as described in the Documentum Forms Builder Installation Guide. Using forms with process templates Documentum Process Builder is used to create process templates that model a real-world business process. Individual processes generated from a process template are called workflows. A process template consists of multiple activities linked together by flows. Activities represent the tasks needed to process the documents being routed through the workflow in a business process, such as reviewing a document, or approving a purchase order. Each package (that is, each document) passed from one activity to the next can have a form template associated with it. The form template defines the data entry fields that are displayed to the users performing the activity and specifies how the user-provided data is stored in the Documentum repository. You create forms using Documentum Forms Builder and associate them with packages using Documentum Process Builder. The Documentum Process Builder User Guide contains detailed information about designing process templates and associating forms. Form storage All templates and form instances reside in the /System/Forms folder in the repository, under a folder that has the same name as the template. All global adaptors are stored in EMC Documentum Forms Builder Version 6 User Guide 19

20 Overview the /System/Forms/Adaptors folder in the repository. Template adaptors are stored with the associated template in the /System/Forms/<template-name>/Adaptors folder, where <template-name> is the name of the template folder. All images in a template are stored in the /System/Forms/Images folder in the repository with the object type dm_xfm_image. The schema, default instance, template adaptors, and XML application can be shared among templates. However, templates and adaptors cannot be versioned. The default access control list (ACL) for template, schema, default instance, resource, XML application, adaptors, and images is Forms User Default ACL. The /System/Forms/<template-name> folder contains the files and folders shown in the following table. Table 3. Template les Filename Description Object type formname.xsd Form schema XML Schema (dm_xfm_schema) formname.xfm Form template XForms template (dm_xfm_form) formname.xml Form instance XML instance (dm_xfm_instance) formname.xml Form layout XML Document (dmc_xfm_layout) locale-file Locale file Resource property (dm_xfm_resource) Adaptors (folder) Adaptor configuration Adaptor Configuration (dmc_xfm_adaptor_config) XML Applications (folder) Form data storage configuration XML Document (dm_xml_config) To transfer a template to another EMC Documentum repository, add the /System/Forms/<template-name> folder to a DocApp using Documentum Application Builder. By adding the folder to the DocApp, you ensure that all of the files associated with the form are transferred to the new repository, including the necessary relationships. The Documentum Application Builder documentation provides more details. 20 EMC Documentum Forms Builder Version 6 User Guide

21 Chapter 2 Creating Templates This chapter describes how to log in to the Forms Builder software and create new forms. You can create new forms that are blank, new forms that are based on a custom layout, or new forms that are based on an existing form. Form templates can be used in Webtop, TaskSpace, or any other Web Development Kit (WDK) application. This chapter contains the following topics: Starting and logging in to Forms Builder, page 22 Understanding template types, page 23 Name and label constraints, page 24 Creating a form template, page 25 Creating a template for a search interface, page 27 Creating a template for a document view, page 39 Creating a template for folder information, page 45 Creating a template for folder contents, page 50 Overview of process initiation configuration, page 61 Creating a template for initiating a process, page 63 Creating a template for a task list, page 67 Creating a template for a task interface, page 81 Saving a template, page 88 Validating and installing a template, page 88 Changing the template state, page 89 Opening an existing template, page 90 Deleting templates, page 90 EMC Documentum Forms Builder Version 6 User Guide 21

22 Creating Templates Starting and logging in to Forms Builder This section describes how to log in to the Forms Builder software. To start the Forms Builder software: 1. From the Windows desktop, select Start > Programs > Documentum > Forms Builder. The login dialog box appears. You must be connected to a repository to run the Forms Builder software. Note: You must be a member of the form_designer role to log in. Contact your administrator if you receive a warning that you do not have permission to log in. 2. From the Repository list box, select the repository. 3. In the User name box, type your username. 4. In the Password box, type your password for the repository. 5. Click Login. The Welcome to Forms Builder dialog box appears. The dialog box lets you create a new template, or open an existing template. Figure 2. Welcome to Forms Builder dialog box 22 EMC Documentum Forms Builder Version 6 User Guide

23 Creating Templates Understanding template types When you start the process of creating a new form, the Forms Builder software prompts you to select a type for your template. Depending on the type of template you select, the Forms Builder software automatically generates the associated template as a starting point for your form design, for example, a blank template, or a custom template for an application. Table 4, page 23 describes the different types of templates available in the Forms Builder software. Table 4. Template types Templates category Description More information Form Search Document View Creates a blank form-based template as a starting point for your design. You can also use this template to copy an existing form template to a new form template, allowing you to modify existing entries rather than starting from a blank form template. Create a form that allows users to search a database. You can create a form that uses a simple search based on a single document type or a form that uses a custom query. Creates a template that can contain images, for example, scanned documents or photos. For this type of template, the Forms Builder software provides an image viewer, a control that you can insert into your form. More information about creating a form template is available in Creating a form template, page 25. More information about creating a search template is available in Creating a template for a search interface, page 27. More information about creating a document view template is available in Creating a template for a document view, page 39. EMC Documentum Forms Builder Version 6 User Guide 23

24 Creating Templates Templates category Description More information Folder Information Folder Contents Initiate Process Task List Task Create templates that display metadata information about folders. Create templates that display contents of folders. Creates a template that can be used to initiate a process within a form. Creates a template that displays tasks from one or more processes. Creates a basic template for a workflow that displays one or multiple packages. The package can contain images, for example, scanned documents or photos. More information about creating a folder information template is available in Creating a template for folder information, page 45. More information about creating a folder contents template is available in Creating a template for folder contents, page 50. More information about creating a initiate process template is available in Creating a template for initiating a process, page 63. More information about creating a task list template is available in Creating a template for a task list, page 67. More information about creating a task template is available in Creating a template for a task interface, page 81. Name and label constraints When you create a form, the constraints shown in the following table are applied. 24 EMC Documentum Forms Builder Version 6 User Guide

25 Creating Templates Table 5. Form object name and label constraints Type of form object Form name Data root, UI root UI and data objects, Name field UI objects, Label field Requirements/constraints Up to 255 characters, including multibyte characters and spaces, except for slash (/). Automatically created from form name, filtered to follow constraints for the Name field of UI and Data objects. Permissible characters: letters (a-z, A-Z), numbers (0-9), underscore (_), hyphen (-), colon (:), period (.). First character must be a letter. No multibyte characters or spaces. Limit of 128 characters. Follows W3C constraints on Xforms ID value. All characters allowed, including multibyte characters and spaces, except for backslash (\), limit of 255 characters. Creating a form template This section describes how to create a new template based on a form template type. Create a new form template for each form page that you want to generate. To create a new form template: 1. In the Forms Builder software, click the Create new form template icon on the toolbar or select File > New Template. The Welcome to Forms Builder dialog box appears. Note: The Welcome to Forms Builder dialog box also appears immediately after you log in to the Forms Builder software. 2. From the Create new template list box, select Electronic Form. 3. From the Template type list box, select Form. 4. In the Enter a name box, type a unique name for the template. The name can be up to 255 characters long, including multibyte characters and spaces, except for slash (/). The template is saved in the repository using this name. the Forms Builder software warns you if the name is not unique, and will not let you continue unless you provide a unique name. EMC Documentum Forms Builder Version 6 User Guide 25

26 Creating Templates 5. In the Description box, type a brief description (optional) for the template. This description does not appear in the user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. Figure 3. New Template wizard: Binding data 7. Select one of the following options to create the new form template: Create as new Select this option to create a new template consisting of a data root and a UI root with four standard form buttons (Submit, Save, Reset, and Cancel). By default, both the data root and the UI root have the same name as the template, with certain filtering (Table 5, page 25 provides more information on naming constraints). Create based on existing type Select this option to create a template based on a custom type, with the attributes already mapped. Select the existing type from the Existing type list box. The XML schema of the new template is based on the hierarchies of the existing type and its attributes. The available object types are dm_document or any subtype, and dm_sysobject or any custom subtype. 26 EMC Documentum Forms Builder Version 6 User Guide

27 Creating Templates Copy UI from existing form Select this option to copy an existing form template to the new form template name, allowing you to modify existing entries rather than starting from a blank form template. Select the form from the list of existing templates in the list box. If you select this option, you must also choose whether to share the data model used by the form you copied, or to make an independent copy of it. The following topics contain more information on data models: Understanding the data model, page 15 Understanding shared data models, page Click Finish to create the form. the Forms Builder software creates the new form template with a default button group containing four buttons, and displays the template in the Design pane and a close representation of what the form will actually look like in the Preview pane. You can customize the form template by adding more controls, or by modifying or removing the default controls, as described in Chapter 3, Editing Templates. Note: You cannot edit the Name fields of the UI root or data root. Creating a template for a search interface The Forms Builder software allows you to create and configure search templates. A search template allows users to retrieve and display documents, folders, or other objects. A TaskSpace search tab requires at least one search template. This section describes how to create a template for a search interface. Consider creating one search template for each object type. For example, you could create one search template for documents and one for folders. Template configuration is primarily an assembly of various items. Each search template is built on an object type. You can use one of the object types already available in the repository, or you can create your own. Instructions on creating an object type are available in the Documentum Application Builder User Guide. Note: Other templates use the same functionality as the search template with a narrower scope. A search template can be configured to search for any object type, anywhere in the repository. A folder contents template allows users to search for objects within a specific folder. A task list template allows users to search for tasks. Instructions on creating these templates are available in Creating a template for folder contents, page 50 and Creating a template for a task list, page 67. EMC Documentum Forms Builder Version 6 User Guide 27

28 Creating Templates To create a search template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Search. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select an object type for the template, as described in Selecting object types for a search template, page 28. Selecting object types for a search template The Step 2 page of the New Template wizard allows you to select an object type for the documents or folders on which you want users to search. You can create a search template based on a single object type or, if you are familiar with Document Query 28 EMC Documentum Forms Builder Version 6 User Guide

29 Creating Templates Language (DQL), based on multiple object types. More information on DQL is available in the Documentum Content Server DQL Reference Manual. Figure 4. New template wizard: Object type for a search template To continue with the template creation: 1. Choose the type of search template you want to create: To create a search template based on a single object type, select Simple search and select an object type. For example, to search for standard documents, select the Document (dm_document) object type. To create a search template based on multiple object types using DQL, select Advanced search. 2. Click Next. The page of the wizard that appears next depends on your selection: If you selected Simple search, the next page allows you to select columns for the result set. Further instructions are provided in Selecting result set columns for a search template, page 30. If you selected Advanced search, the next page allows you to complete the template creation using DQL. Further instructions are provided in Specifying a DQL query for a search template, page 33. EMC Documentum Forms Builder Version 6 User Guide 29

30 Creating Templates Selecting result set columns for a search template If you selected Simple search on the Step 2 page of the New Template wizard, the Step 3 page provides a list of attributes for the selected object type in the current repository. This page allows you to select from this list of attributes and specify columns for the result set. Figure 5. New template wizard: Result set columns for a search template To continue with the template creation: 1. Specify which columns to display on the result set: To display a column, select it from the Available attributes list and click. To remove a column, select it from the Search results columns list and click. By default, this list displays only custom attributes. To view all attributes, clear Only custom attributes. Some attributes are required for specific functionality: To include object type icons in the result set, include the Type (r_object_type) or Format (a_content_type) attribute as a column. The r_object_type attribute displays a generic icon based on the Documentum type, if available. The a_content_type attribute displays a more specific icon based on the file format (such as TIFF or PDF). To enable check in and check out functionality (including the lock icon) in the result set, include the Checked Out By (r_lock_owner) attribute as a column. You can hide these columns after you finish the wizard. The related functionality is retained. 30 EMC Documentum Forms Builder Version 6 User Guide

31 Creating Templates 2. Specify the order of columns. To move a column, select it from the Search results columns list and click or. 3. Click Next. You can now specify search criteria for the template, as described in Specifying search criteria for a search template, page 31. Specifying search criteria for a search template The Step 4 page of the New Template wizard allows you to specify search criteria for the template. Figure 6. New Template wizard: Search criteria for a search template The condition you select determines the syntax of the search criteria in the search query WHERE clause. The following table describes the conditions that may be available and indicates the resulting syntax for an example query: Table 6. Search criteria conditions Condition Description Example Equals Not equals Returns items that match the specified value exactly. Returns items that do not match the specified value exactly. object_name = $object_name$ object_name <> $object_name$ EMC Documentum Forms Builder Version 6 User Guide 31

32 Creating Templates Condition Description Example Like Not like Starts with Ends with Returns items that match a pattern with a wildcard. Returns items that do not match a pattern with a wildcard. Returns items in which the first part of the item matches the specified value. Returns items in which the last part of the item matches the specified value. object_name LIKE %$object_name$% object_name NOT LIKE $object_name$ object_name LIKE $object_name$% object_name LIKE %$object_name$ To continue with the template creation: 1. Specify search criteria: Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). For each search criterion, select an attribute from the Variable list box, select a condition from the Condition list box, and specify whether to get user input or use a default value. To add another criterion, click the plus sign. To delete a criterion, click the minus sign next to it. If a user leaves a field blank, the search finds only items with no value in this field. 2. Click Next. You can now specify search restrictions for the template, as described in Specifying search restrictions for a search template, page 32. Specifying search restrictions for a search template The Step 5 page of the New Template wizard allows you to specify search restrictions. 32 EMC Documentum Forms Builder Version 6 User Guide

33 Creating Templates Figure 7. New Template wizard: Search restrictions for a search template To continue with the template creation: 1. Set search restrictions to help prevent performance difficulties: To limit the number of objects returned, select Maximum number of results and specify the maximum number of objects. To restrict the search by date, select Time restriction. Then, in the adjacent box, type the numerical count of the time restriction, and from the adjacent list box, select the time restriction units (in days, weeks, months, and years). To specify a different attribute to be used for the date restriction, select an attribute from the Time attribute list box. 2. Click Finish. The Forms Builder software creates a template based on the object type, columns, criteria, and restrictions you selected, and adds default controls (such as a Search button) to the template. You can now finish creating the template, as described in Completing the search template creation, page 35. Specifying a DQL query for a search template If you selected Advanced search on the Step 2 page of the New Template wizard, the Step 3 page allows you to finish creating a search template based on multiple object types. This page requires familiarity with Document Query Language (DQL). More information on DQL is available in the Documentum Content Server DQL Reference Manual. EMC Documentum Forms Builder Version 6 User Guide 33

34 Creating Templates Figure 8. New Template wizard: DQL query for a search template To complete the template creation: 1. Under Please type a DQL query, type a DQL select statement with the necessary qualifications. To indicate the qualification variables, enclose each variable name in dollar signs ($). For example, consider the following query: SELECT account_number FROM customers WHERE first_name= $firstname$ and last_name= $lastname$ In this statement, first_name and last_name are the qualifications and firstname and lastname are the variable names. Make sure a data item exists with the same name as each variable name. In Webtop or TaskSpace, the forms engine substitutes the variable with the value of the data item. Information on creating a DQL statement is available in the Documentum Content Server DQL Reference Manual. Note: Search templates do not support Select * in the DQL query. 2. To test your query, click Test query. The Query Simulation dialog box appears. 34 EMC Documentum Forms Builder Version 6 User Guide

35 Creating Templates 3. Complete the dialog box as follows: a. If Terms boxes are available, enter values. b. Click Execute. Results appear in the bottom half of the dialog box. c. To show more results, select a different value from the Show more list box. d. If necessary, modify the query in the Query box. e. Click Sync terms. The Terms boxes are synchronized with the query. f. Repeat steps a-e until you are satisfied with the results (and no errors appear after you click Execute). g. Click Accept. The modified query appears in the New Template wizard. 4. Click Finish. The Forms Builder software creates a template based on the DQL query you specified, and adds default buttons (such as Search) to the template. You can now finish creating the template, as described in Completing the search template creation, page 35. Completing the search template creation After you have completed the New Template wizard, finish creating the search template. EMC Documentum Forms Builder Version 6 User Guide 35

36 Creating Templates To complete the template creation: 1. Use the Forms Builder software to configure the search criteria and result set. The following sections provide brief descriptions of what you can configure: Modifying the query in a search template, page 36 Modifying column settings for a search template, page 37 Detailed instructions are available in Chapter 3, Editing Templates. Note: If you need to hide controls, hide each control individually rather than hiding container controls. If you hide a container control (such as a horizontal or vertical box), text field child controls are not initialized. If one of these text fields is the search term associated with the TaskSpace global search feature, the value for that search term cannot be updated because the text box control is never initialized. If one of these text fields has a default value associated with it, the default value cannot be retrieved from that control because it is never initialized. 2. To increase usability, add instructions for the user about the search criteria, the result set columns, or your own configurations. For example, if the search criteria must be entered in a particular format, explain the required format. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 3. Select File > Save. 4. When the template is ready for end users to use, select Tools > Install. Modifying the query in a search template After you have created a search template using the New Template wizard, all of the settings that you had specified in the wizard are available for modification in a DQL query. If you are familiar with DQL, you can change these settings before using it in a user interface. More information on DQL is available in the Documentum Content Server DQL Reference Manual. To locate the DQL query in the search template: 1. Under UI Model, expand the Group0 node and select Search result. 2. Under Properties, click Special. The DQL query is displayed in the Query box. Table 7, page 37 lists each setting that may have been specified in the New Template wizard and describes where in the DQL query that setting may be found: 36 EMC Documentum Forms Builder Version 6 User Guide

37 Creating Templates Table 7. Con gurable items Configurable item Object type Attributes in the result set Search criteria (variable, condition, and whether to get user input or use a default value) Search restrictions (maximum number of results) Search restrictions (date restriction) Locating the item In the FROM clause In the SELECT clause In the WHERE clause In the ENABLE clause In the WHERE clause, after the search criteria Detailed instructions are available in Chapter 3, Editing Templates. Modifying column settings for a search template After you have created a template using the New Template wizard, you can make further adjustments to the columns in that template. To display the Columns table: 1. Under UI Model, expand the Group0 node and select Search result. 2. Under Properties, click Special. To modify columns: 1. In the Columns table, select the row representing the column to modify. 2. Click Modify. The Edit Column dialog box appears. EMC Documentum Forms Builder Version 6 User Guide 37

38 Creating Templates 3. Modify settings as needed for the selected column. The following table describes each setting: Table 8. Column settings Field Column label Column width Display Sortable Sorted by default Style Description Type a new label in the box or select an icon from the list box, or both. The text or icon appears in the column header. Select Automatic or Fixed. If you select Fixed, you must specify a length in the adjacent box. Select True (to make the column visible to the end users) or False (to hide the column from end users). For example, if you have included an attribute as a column to enable specific functionality in a search result set, you can hide the column here and still retain that functionality. Select True (to allow sorting on this column) or False (to prevent sorting on this column). Sorting may be convenient for the end user but may also be a performance consideration. Select None, Ascending (to specify that the values should increase in this column), or Descending (to specify that the values should decrease in this column). If a column is visible to end users, they can change the sort order on this column or sort another column instead. Note: Only one column can be sorted at a time. Select Default, Override with format, or Override with CSS. If you select Override with format, the Edit button becomes available. (Further instructions on specifying the character formatting in a column are provided in Specifying the character formatting in a column, page 38.) If you select Override with CSS, you must select a CSS class from the list box. 4. Click OK. Additional instructions are available in Chapter 3, Editing Templates. Specifying the character formatting in a column By default, all of the text in a list (the result set of a search template, the contents list of a folder contents template, or the task list of a task list template) has the same character formatting. The Format dialog box allows you to specify character formatting for text in a column. 38 EMC Documentum Forms Builder Version 6 User Guide

39 Creating Templates To specify character formatting: 1. In the Edit Column dialog box, next to Style, select Override with format and click Edit. The Format dialog box appears. 2. Modify the character formatting to suit your needs: To specify a different text color, click the browse button next to Font. A Choose Color dialog box appears. Select a color and click OK. To specify a different font, select it from the Font list box. To use bold or Italics, select the appropriate checkbox. 3. Click OK. Creating a template for a document view The Forms Builder software allows you to create and configure document view templates. A document view template can provide an integrated view of a document image and its associated metadata. Document view templates appear in a document view for display of documents or in a task view for display of documents associated with tasks. This section describes how to use the Forms Builder software to create a template for a document view. Template configuration is primarily an assembly of various items. Document view templates are built on the following items: At least one supported viewer installed. The TaskSpace documentation provides a list of supported viewers. The dm_document object type or one of its subtypes. You can use one of the object types already available in the repository, or you can create your own. Instructions on creating an object type are available in the Documentum Application Builder User Guide. To create a document view template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. EMC Documentum Forms Builder Version 6 User Guide 39

40 Creating Templates 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Document View. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select an object type for the template, as described in Selecting an object type for a document view template, page 40. Selecting an object type for a document view template The Step 2 page of the New Template wizard allows you to select an object type. 40 EMC Documentum Forms Builder Version 6 User Guide

41 Creating Templates Figure 9. New template wizard: Document object type for a document view template To continue with the template creation: 1. From the Select an object type list box, select an object type, such as Document (dm_document). 2. Click Finish. The Forms Builder software creates a template based on the template type and object type you selected and adds to the template several default controls associated with the object type. These default controls may include Rescan, OK, Save, and Cancel buttons. You can now finish creating the template, as described in Completing the document view template creation, page 41. Completing the document view template creation After you have completed the New Template wizard, finish creating the document view template. To complete the template creation: 1. Use the Forms Builder software to configure the viewer in the template, as described in Configuring the viewer in a document view template, page Use the Forms Builder software to configure all metadata. You can configure the template by adding more controls or by modifying or removing the default controls. Detailed instructions are available in Chapter 3, Editing Templates. Note: When the document view template is used in TaskSpace, it displays only existing objects. Default values apply only to new objects. EMC Documentum Forms Builder Version 6 User Guide 41

42 Creating Templates 3. Consider adding instructions for the user about the image viewer or your own configurations. For example, if you add boxes for document indexing and the index values must be entered in a particular format, explain the required format. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 4. Select File > Save. 5. When the template is ready for end users to use, select Tools > Install. Note: If you add a new image viewer provider (such as Daeja ViewOne Pro or IGC Brava) after the document view template has been created and saved, you must open and save the template again for the provider update to take effect. Con guring the viewer in a document view template The TaskSpace user interface supports multiple third-party viewers and each viewer has different capabilities. The TaskSpace documentation provides a list of supported viewers. You can specify where the viewer appears on the template and the size of the viewer in the template, and whether it appears inline or as a popup. Other options may be available depending on the viewer you select. To con gure the viewer: 1. Under UI Model, expand the Group0 and Group1 nodes. Select the Document Preview data item. 2. Under Properties, click Special. 3. In the Configure Viewers group, click Configure next to a viewer name. The Viewer Properties dialog box appears. The Provider Properties group varies depending on the viewer. The remaining display properties, in the top half of the dialog box, are the same for all viewers. 42 EMC Documentum Forms Builder Version 6 User Guide

43 Creating Templates 4. Modify the viewer properties to suit your needs: To specify the size of the viewer in the template, in the Width and Height boxes, enter values in pixels. To change the alignment of the viewer within the template, select Top, Middle, or Bottom from the Alignment list box. To further adjust the location of the popup window, enter values in the Horizontal spacing and Vertical spacing boxes. To display the viewer within the template, select Inline. To display the viewer in a separate window, select Popup. 5. If you chose to display the viewer as a popup, modify the pop-up settings to suit your needs: To specify the popup window location on the user s screen, select Center, Top left, Top right, Bottom left, Bottom right, or Exact position from the Placement list box. If you chose Exact position to further adjust the alignment of the viewer within the template, enter values in the X and Y boxes. EMC Documentum Forms Builder Version 6 User Guide 43

44 Creating Templates 6. Modify the viewer-specific settings to suit your needs. (The availability of these settings depends on the viewer. Daeja ViewOne Pro and IGC Brava are installed separately.) To specify a background color in a Daeja ViewOne Pro viewer, click the button next to the Background box. A Background Color dialog box appears. Select a color and click OK. To allow users to create annotations in a Daeja ViewOne Pro viewer, select Annotations. To allow users to edit annotations in a Daeja ViewOne Pro viewer, select Edit Annotations. To allow users to view thumbnails in a IGC Brava viewer, select Show Thumbnail. To allow users to view thumbnails in a Daeja ViewOne Pro viewer, select an option from the Thumbnail Display Mode list. 44 EMC Documentum Forms Builder Version 6 User Guide

45 Creating Templates 7. Click OK. Creating a template for folder information The Forms Builder software allows you to configure templates specific to the TaskSpace software, including templates for folders. Folder information and contents templates appear in a TaskSpace folder view or folder tab. A folder information template displays information about a folder. A folder contents template displays a list of the contents of a folder, which can include documents, subfolders, and other objects. Template configuration is primarily an assembly of various items. Folder information templates are built on a folder object type. You can use one of the object types already available in the repository, or you can create your own. Instructions on creating an object type are available in the Documentum Application Builder User Guide. To create a folder information template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. EMC Documentum Forms Builder Version 6 User Guide 45

46 Creating Templates 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Folder Information. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select an object type for the template, as described in Selecting an object type for a folder information template, page 46. Selecting an object type for a folder information template The Step 2 page of the New Template wizard allows you to select an object type. 46 EMC Documentum Forms Builder Version 6 User Guide

47 Creating Templates Figure 10. New template wizard: Folder object type for a folder information template To continue with the template creation: 1. From the Select an object type list box, select an object type, such as Folder (dm_folder). 2. Click Finish. The Forms Builder software creates a template based on the template type and object type you selected and adds several default controls associated with the object type to the template. These default controls may include a Folder Name box and a Save button. You can now finish creating the template, as described in Completing the folder information template creation, page 47. Completing the folder information template creation After you have completed the New Template wizard, finish creating the folder information template. To complete the template creation: 1. (Optional) Use the Forms Builder software to configure access to the folder information, as described in Configuring whether users can edit folder information, page Use the Forms Builder software to configure all metadata. You can configure the template by adding more controls or by modifying or removing the default controls. Detailed instructions are available in Chapter 3, Editing Templates. EMC Documentum Forms Builder Version 6 User Guide 47

48 Creating Templates 3. To increase usability, add instructions for the user about the default controls or your own configurations. For example, if you add boxes for folder indexing and the index values must be entered in a particular format, explain the required format. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 4. Select File > Save. 5. When the template is ready for end users to use, select Tools > Install. Con guring whether users can edit folder information When you create a folder information template, the Forms Builder software adds several default controls, including a Save button. If you selected the Folder (dm_folder) object type, the Forms Builder software also adds a Folder Name text box associated with the object name attribute for the folder type. When these controls are editable and visible to a role, a user with that role can change the folder information. You can control access to the folder information by configuring the editability and visibility of these controls. Repeat the following procedure for each control on the folder information template. To con gure the editability and visibility of each control: 1. Under UI Model, navigate to and select the control for which you want to configure access. 2. Under Properties, click General and then Rules. A list of rules for the selected control appears. 3. Click Add. The Condition dialog box appears. 4. Construct a conditional statement based on a specified role: a. From the first list box, select role. 48 EMC Documentum Forms Builder Version 6 User Guide

49 Creating Templates b. From the second list box, select is equal to or is not equal to. For example, to construct a statement that excludes a role, select is not equal to. c. From the third list box, select the role. d. To include more roles in the statement, click Add. e. If you have specified multiple roles, join them with or or and by selecting from the fourth list box. f. To remove a role from the statement, click the Delete button next to it. g. To make the control read-only for the specified roles, select Read-only. For example, if you make text box controls read-only for all roles except the ones you specify, members of the specified roles can change the values for the folder attributes. h. To hide the control from the specified roles, select Hidden. For example, if you hide the Save button control from all roles except the ones you specify, members of the specified roles can save any changes that they make to the folder attributes. i. Click OK. Your new conditional statement appears in the list of rules for this template. 5. To modify a statement, select it and click Modify. Revise the step as indicated in the previous step and click OK. (For the Else statement, you can change only the Read-only and Hidden settings.) 6. To remove a statement, select it and click Remove. 7. To move a statement up, select it and click Move up. 8. To move a statement down, select it and click Move down. (The Else statement does not move.) For each role that is specified in a folder information template rule, use the TaskSpace Configuration tab to configure it for access to this folder information template, either in a folder view or a folder tab. For instructions, refer to and. EMC Documentum Forms Builder Version 6 User Guide 49

50 Creating Templates Creating a template for folder contents The Forms Builder software allows you to configure templates specific to the TaskSpace software, including templates for folders. Folder information and contents templates appear in a TaskSpace folder view or folder tab. A folder information template displays information about a folder. A folder contents template displays a list of the contents of a folder, which can include documents, subfolders, and other objects. Template configuration is primarily an assembly of various items. Folder contents templates are built on at least one object type. You can use the object types already available in the repository, or you can create your own. Instructions on creating an object type are available in the Documentum Application Builder User Guide. To create a folder contents template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Folder Contents. 4. In the Enter a name box, type a unique name. 50 EMC Documentum Forms Builder Version 6 User Guide

51 Creating Templates 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select object types for the template, as described in Selecting object types for a folder contents template, page 51. Selecting object types for a folder contents template The Step 2 page of the New Template wizard allows you to select object types. The object types you select determine which attributes you can choose from on the next page of the wizard, for use as columns in the folder contents list. Figure 11. New template wizard: Document object types for a folder contents template To continue with the template creation: 1. Specify whether to include subtypes of dm_sysobject in the list of document types. 2. Specify which document types (such as Document (dm_document)) to use in this template: To display a column, select it from the Select one or more document types list and click. To remove a column, select it from the Document types selected list and click. EMC Documentum Forms Builder Version 6 User Guide 51

52 Creating Templates Consider including Folder (dm_folder) so that you can include a Folder Path column on the next page of the wizard. 3. Click Next. You can now select columns for the template, as described in Selecting columns for a folder contents template, page 52. Selecting columns for a folder contents template The Step 3 page of the New Template wizard provides a list of attributes for each selected object type in the current repository. This page allows you to select attributes as columns for the folder contents list. Figure 12. New template wizard: Columns for a folder contents template To continue with the template creation: 1. From the Select columns to be displayed list box, select an object type. This selection populates the Select one or more columns list. 2. Specify which columns you want to display on the list: To display a column, select it from the Select one or more columns list and click. To remove a column, select it from the Columns selected list and click. Some attributes are required for specific functionality: 52 EMC Documentum Forms Builder Version 6 User Guide

53 Creating Templates To include object type icons in the contents list, include the Type (r_object_type) or Format (a_content_type) attribute as a column. The r_object_type attribute displays a generic icon based on the Documentum type, if available. The a_content_type attribute displays a more specific icon based on the file format (such as TIFF or PDF). To enable check in and check out functionality (including the lock icon) in the contents list, include the Checked Out By (r_lock_owner) attribute as a column. You can hide these columns after you finish the wizard. The related functionality is retained. 3. Specify the order of columns. To move a column, select it from the Columns selected list and click or. 4. Click Next. You can now specify filters for the template, as described in Specifying filters for a folder contents template, page 53. Specifying lters for a folder contents template The Step 4 page of the New Template wizard allows you to create, modify, and delete filters, which use search criteria to reduce the folder contents list. Figure 13. New template wizard: Filters for a folder contents template EMC Documentum Forms Builder Version 6 User Guide 53

54 Creating Templates To continue with the template creation: 1. Add, modify, move, or remove filters as needed: To add a filter, click Add. Further instructions are provided in Creating or modifying a filter, page 59. To modify a filter, select it and click Modify. Further instructions are provided in Creating or modifying a filter, page 59. To move a filter, select it and click or. To remove a filter, select it and click Remove. 2. Click Next. You can now specify search criteria for the template, as described in Specifying search criteria for a folder contents template, page 54. Specifying search criteria for a folder contents template The Step 5 page of the New Template wizard allows you to specify search criteria for the template. Figure 14. New template wizard: Search criteria for a folder contents template To continue with the template creation: 1. Specify search criteria: 54 EMC Documentum Forms Builder Version 6 User Guide

55 Creating Templates Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). For each search criterion, select an attribute from the Variable list box, select a condition from the Condition list box, and specify whether to get user input or use a default value. To add another criterion, click the plus sign. To delete a criterion, click the minus sign next to it. If a user leaves a field blank, the search ignores the field. 2. Click Finish. The Forms Builder software creates a template based on the information you specified, and adds default controls to the template. These default controls may include a Go button and a Show list box. The Show list box can be used to show or hide subfolders of the selected folder and documents in those subfolders. Search terms are organized into two columns. (If you have only one search term, one column is empty.) You can now finish creating the template, as described in Completing the folder contents template creation, page 55. Completing the folder contents template creation After you have completed the New Template wizard, finish creating the folder contents template. To complete the template creation: 1. Use the Forms Builder software to configure the search criteria, filter, and contents list. The following sections provide brief descriptions of what you can configure: Modifying search criteria for a folder contents template, page 56 Modifying column settings for a folder contents template, page 57 Managing filters for a folder contents template, page 58 Creating or modifying a filter, page 59 Selecting different document types for a folder contents template, page 60 Detailed instructions are available in Chapter 3, Editing Templates. 2. To increase usability, add instructions for the user about the search criteria, the filter, contents list columns, or your own configurations. For example, if the search criteria must be entered in a particular format, explain the required format. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. EMC Documentum Forms Builder Version 6 User Guide 55

56 Creating Templates 3. Select File > Save. 4. When the template is ready for end users to use, select Tools > Install. Modifying search criteria for a folder contents template After you have created a folder contents template using the New Template wizard, you can change settings that you had specified in the wizard, including the search criteria (qualifications), before using the template in a user interface. To modify the search criteria for a folder contents template: 1. Under UI Model, expand the Group0 and folderlistgroup nodes. Select foldercontentlist. 2. Under Properties, click Special. Next to Document Search, click Modify Search. 3. To add document types, click Select more document types. Further instructions are provided in Selecting different document types for a folder contents template, page Create qualifications using search criteria, with or without user input: Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). For each search criterion, select a variable from the Variable list box, select a condition from the Condition list box, and specify whether to get user input or use a default value. 56 EMC Documentum Forms Builder Version 6 User Guide

57 Creating Templates To add another criterion, click the plus sign. To delete a criterion, click the minus sign next to it. If a user leaves a field blank, the search ignores the field. 5. Click OK. Modifying column settings for a folder contents template After you have created a folder contents template using the New Template wizard, you can make further adjustments to the columns in that template. To display the Columns table: 1. Under UI Model, expand the Group0 and folderlistgroup nodes, and select foldercontentlist. 2. Under Properties, click Special. To modify columns: 1. In the Columns table, select the row representing the column to modify. 2. Click Modify. The Edit Column dialog box appears. 3. Modify settings as needed for the selected column. The following table describes each setting: EMC Documentum Forms Builder Version 6 User Guide 57

58 Creating Templates Table 9. Column settings Field Column label Column width Display Sortable Sorted by default Style Description Type a new label in the box or select an icon from the list box, or both. The text or icon appears in the column header. Select Automatic or Fixed. If you select Fixed, you must specify a length in the adjacent box. Select True (to make the column visible to the end users) or False (to hide the column from end users). For example, if you have included an attribute as a column to enable specific functionality in a search result set, you can hide the column here and still retain that functionality. Select True (to allow sorting on this column) or False (to prevent sorting on this column). Sorting may be convenient for the end user but may also be a performance consideration. Select None, Ascending (to specify that the values should increase in this column), or Descending (to specify that the values should decrease in this column). If a column is visible to end users, they can change the sort order on this column or sort another column instead. Note: Only one column can be sorted at a time. Select Default, Override with format, or Override with CSS. If you select Override with format, the Edit button becomes available. (Further instructions on specifying the character formatting in a column are provided in Specifying the character formatting in a column, page 38.) If you select Override with CSS, you must select a CSS class from the list box. 4. Click OK. Additional instructions are available in Chapter 3, Editing Templates. Managing lters for a folder contents template After you have created a folder contents template using the New Template wizard, you can change settings that you had specified in the wizard, including the filters, before using the template in a user interface. 58 EMC Documentum Forms Builder Version 6 User Guide

59 Creating Templates To display lter settings for a folder contents template: 1. Under UI Model, expand the Group0, folderlistgroup, and FolderContentFilterGroup nodes. Select FolderContentsFilter or Show. 2. Under Properties, click Special. To modify lter settings: 1. Next to Filters, add, modify, move, or remove filters as needed: To add a filter, click Add. Further instructions are provided in Creating or modifying a filter, page 59. To modify a filter, select it and click Modify. Further instructions are provided in Creating or modifying a filter, page 59. To move a filter, select it and click the up or down arrow. To remove a filter, select it and click Remove. Creating or modifying a lter The Filter dialog box allows you to create or modify a filter for a folder contents template or a task list template. Figure 15. Filter dialog box EMC Documentum Forms Builder Version 6 User Guide 59

60 Creating Templates To create or modify a lter: 1. In the Label box, specify a label for the filter. This appears in the filter list box in the user interface. 2. If the Add Document Type button is available, you can add document types. (The Add Document Type button is available if you are configuring a filter for a folder contents template.) Further instructions are provided in Selecting different document types for a folder contents template, page If the Add Structured Data Type button is available, you can add structured data types. (The Add Structured Data Type button is available if you are configuring a filter for a task list template.) Further instructions are provided in Selecting different structured data types for a task list template, page Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). 5. For each search criterion, select a variable from the Variable list box, select a condition from the Condition list box, and select or specify a value. The search criteria that you can create depend on which template type you are configuring. For example: In a folder contents template, you could select Authors equals USER (the current user) as a criterion for the filter. In a task list template, you could select Due Date between Dec 24, 2006 and Dec 30, 2006 as a criterion for the filter. 6. To add another criterion, click the plus sign and repeat the previous step. 7. To delete a criterion, click the minus sign next to it. 8. When you have finished defining the filter, click OK. Selecting different document types for a folder contents template After you have created a folder contents template using the New Template wizard, you can change settings that you had specified in the wizard, including the list of document types, before using the template in a user interface. To select different document types for a folder contents template: 1. Display the Qualifications or Filters dialog box. The following sections provide instructions: Modifying search criteria for a folder contents template, page 56 Managing filters for a folder contents template, page Click Add Document Type. The Select Document Type dialog box appears. 60 EMC Documentum Forms Builder Version 6 User Guide

61 Creating Templates 3. If you have created any document types in Process Builder for the purpose of this folder contents, select them: To display an document type, select it from the Select one or more document types list and click. To remove an document type, select it from the Document types selected list and click. 4. Click OK. Overview of process initiation con guration This section provides an overview on configuring how users start processes (process initiation) in the TaskSpace user interface. Figure 16. Sample initiate process view You can configure how users start processes (process initiation) in two different ways. You can associate the Initiate activity of a process template directly with a Forms Builder template. Alternatively, you can associate the Initiate activity of a process template with EMC Documentum Forms Builder Version 6 User Guide 61

62 Creating Templates a package, and associate that package with a Forms Builder template. Of these two configuration methods, only the latter supports rescan functionality. The following table compares the two configuration methods in more detail: Table 10. Comparison of process initiation con guration methods Comparison Activity - template Activity - package - template Associations and number of packages What happens when a user starts the process? Configuration Can the process template be used for rescan functionality? The Initiate activity may have zero or more packages. The activity is associated with a Forms Builder template. The Forms Builder template that is associated with the Initiate activity appears as an item in the Open Items tab. The user may enter values and click on an action button, such as Submit. If there are no mandatory packages associated with the activity, depending on the actions, the task is processed further and the item is closed. If the activity has one or more mandatory packages, normal process container appears as another item in the Open Items tab. The Forms Builder template must be configured before the Process Builder template. For details, refer to Overview of configuring direct association of activity to template, page 63. No The Initiate activity may have one or more packages. At least one Initiate activity package must be mandatory and associated with a Forms Builder template. The Forms Builder template that is associated with the package in the Initiate activity appears as an item in the Open Items tab. The user may enter values and click on an action button, such as Submit. If there are no other mandatory packages associated with the activity, depending on the actions, the task is processed further and the Opened Item is closed. If the activity has one or more other mandatory packages, normal process container appears in an Open Item. The Process Builder template must be configured before the Forms Builder template. For details, refer to Overview of configuring association of activity to package and package to template, page 63. Yes (At least one mandatory package associated with the Initiate activity. This package must be named ImageDoc.) 62 EMC Documentum Forms Builder Version 6 User Guide

63 Creating Templates Overview of con guring direct association of activity to template You can associate the Initiate activity of a process template directly with a Forms Builder template. To con gure direct association of activity to template: 1. In the Process Builder software, create a process template. Detailed instructions are available in the Documentum Process Builder User Guide. 2. In the Forms Builder software, create a template using the Initiate Process template type and the prepared process template. Detailed instructions are available in Creating a template for initiating a process, page 63. Overview of con guring association of activity to package and package to template You can associate the Initiate activity of a process template with a package, and associate that package with a Forms Builder template. To con gure association of activity to package and package to template: 1. In the Forms Builder software, create a template using any template type. Detailed instructions are available in Chapter 3, Editing Templates. 2. In the Process Builder software, create a process template with at least one mandatory package. Associate the package with the prepared Forms Builder template. Configure the Initiate activity to auto-launch the package. Detailed instructions are available in the Documentum Process Builder User Guide. This process template can be used to configure the rescan feature. For details, refer to. Creating a template for initiating a process The Forms Builder software allows you to configure templates specific to the TaskSpace software, including process initiation templates. Process initiation templates allow users to initiate processes, including rescan processes. Template configuration is primarily an assembly of various items. A process initiation template is built on an installed process template. Process Builder allows you to create and install process templates. Information is provided in the following locations: EMC Documentum Forms Builder Version 6 User Guide 63

64 Creating Templates Overview of process initiation configuration, page 61 Documentum Process Builder User Guide To create a process initiation template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Initiate Process. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select a process for the template, as described in Selecting a process for an initiate process template, page EMC Documentum Forms Builder Version 6 User Guide

65 Creating Templates Selecting a process for an initiate process template The Step 2 page of the New Template wizard allows you to select a process for the initiate process template. This page of the wizard lists only installed process templates. Figure 17. New template wizard: Process for an initiate process template To continue with the template creation: 1. From the Select a process list, select a process. (If you have prepared process templates for rescan, select the parent process.) The process initiation template becomes associated with the Initiate activity of the process you select. 2. Click Next. You can now select process variables for the template, as described in Selecting process variables for an initiate process template, page 65. Selecting process variables for an initiate process template The Step 3 page of the New Template wizard allows you to select process variables for the initiate process template. This page of the wizard lists all available process variables. EMC Documentum Forms Builder Version 6 User Guide 65

66 Creating Templates Figure 18. New template wizard: Process variables for an initiate process template 1. Specify which process variables you want to display on the form: To display a process variable, select it from the Available process variables list and click. To remove a process variable, select it from the Selected process variables list and click. To move a process variable, select it from the Selected process variables list and click or. If you are configuring this template for rescan, select the page_no and reason_for_rescan process variables for display on the form. 2. Click Finish. The Forms Builder software creates a template based on the process and variables you selected, and adds default Submit and Cancel buttons to the template. You can now finish creating the template, as described in Completing the initiate process template creation, page 66. Completing the initiate process template creation After you have completed the New Template wizard, finish creating the initiate process template. 66 EMC Documentum Forms Builder Version 6 User Guide

67 Creating Templates To complete the template creation: 1. Use the Forms Builder software to further configure the template. You can configure the template by adding more controls or by modifying or removing the default controls. For example, if you selected process variables to be displayed on the template, you can modify the label for each. Detailed instructions are available in Chapter 3, Editing Templates. 2. To increase usability, add instructions for the user about the default controls or your own configurations. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 3. Select File > Save. 4. When the template is ready for end users to use, select Tools > Install. Creating a template for a task list The Forms Builder software allows you to configure templates specific to the TaskSpace software, including task list templates. Task list templates display tasks from one or more processes. A TaskSpace task list tab is based on a task list template. You can use filters to give the user varying control over the task list. Table 11, page 67 compares these filters, in order of increasing user control. Table 11. Reducing the task list Filter Standard filter Qualification with value specified in the template Qualification with value specified by the user Description Allows the user to reduce the list as defined by the filter. For example, if you create a filter displaying all tasks and a filter displaying only the current user s tasks, the user can switch between these filters at will. A default value specified in the template reduces the task list. The user can change the value. For example, if you create a qualification that reduces the list to only the current user s tasks, users see only their own tasks. However, the user can change the value to display a list of another user s tasks. Allows the user to reduce the list by specifying a value, as defined by the qualification. For example, if you create a qualification based on the priority of the tasks, the user can reduce the list of tasks by specifying a priority number. EMC Documentum Forms Builder Version 6 User Guide 67

68 Creating Templates Template configuration is primarily an assembly of various items. Task list templates are built on the following items: An object type. You can use one of the object types already available in the repository, or you can create your own. Instructions on creating an object type are available in the Documentum Application Builder User Guide. An installed process template. Process Builder allows you to create and install process templates. Your task list templates may also benefit from a structured data type. Process Builder allows you to create structured data types. The Documentum Process Builder User Guide provides detailed instructions. To create a task list template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Task List. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. 68 EMC Documentum Forms Builder Version 6 User Guide

69 Creating Templates The New Template wizard appears, starting with the Step 2 page. You can now select an inbox type for the template, as described in Selecting an inbox type for a task list template, page 69. Selecting an inbox type for a task list template The Step 2 page of the New Template wizard allows you to select an inbox type for the task list. Figure 19. New template wizard: Inbox type for a task list template To continue with the template creation: 1. Select an inbox type: For a task list that contains only the current user s tasks, select User Task List. For a task list that contains tasks for users in a work queue, select Work Queue Task List. 2. Click Next. You can now select processes for the template, as described in Selecting processes for a task list template, page 70. EMC Documentum Forms Builder Version 6 User Guide 69

70 Creating Templates Selecting processes for a task list template The Step 3 page of the New Template wizard allows you to select processes for the task list. Each process has associated tasks. By selecting processes, you specify which tasks you want to include in the task list. At least one process must be selected. Figure 20. New template wizard: Processes for a task list template To continue with the template creation: 1. Specify whether to include tasks from all processes in the repository or from selected processes. For example, you might want to create a template that includes all processes for users who assign tasks and templates that include individual processes for users who work on tasks. Note: If you select all processes, the list of possible columns (later in the wizard) does not include any process variables. 2. Click Next. You can now select structure data types for the template, as described in Selecting structured data types for a task list template, page EMC Documentum Forms Builder Version 6 User Guide

71 Creating Templates Selecting structured data types for a task list template A structured data type is a way to represent business data that pertains to the flow of your process and is generally comprised of the following data elements: Name, Type, [Default Value]. There are two kinds of structured data types: simple and complex. A simple data type is a single attribute such as a string or Boolean value. A complex data type is made up of several attributes. For example, elements of an appropriation request can be organized into the group Request with the attributes submitter_name, submitter_address, and equipment_type. Within each structured data type, you can also organize attributes into related groups that give visual structure to the data type. For example, within the customer structured data type, you can have an address group that contains the attributes for city and state. The Step 4 page of the New Template wizard displays a list of the structured data types associated with the selected process or processes, and allows you to select one or more structured data types for the task list. Structured data types provide more choices when specifying columns, filters, and qualifications for a task list template. Using the above example, the attributes for city and state can be selected as columns for the task list. Figure 21. New template wizard: Structured data types for a task list template To continue with the template creation: 1. If you have created any structured data types in Process Builder for the purpose of this task list, select them: EMC Documentum Forms Builder Version 6 User Guide 71

72 Creating Templates To display an structured data type, select it from the Available Structured Data Types list and click. To remove an structured data type, select it from the Selected Structured Data Types list and click. 2. Click Next. You can now select columns for the template, as described in Selecting columns for a task list template, page 72. Selecting columns for a task list template The Step 5 page of the New Template wizard displays a list of attributes, and allows you to select one or more attributes as columns for the task list. The list includes: A fixed list of available columns Process variables associated with selected processes (unless you selected all processes) Attributes of selected structured data types Figure 22. New template wizard: Columns for a task list template To continue with the template creation: 1. Specify which columns you want to display on the list: To display a column, select it from the Available columns list and click. To remove a column, select it from the Columns to search on list and click. 72 EMC Documentum Forms Builder Version 6 User Guide

73 Creating Templates To move a column, select it from the Columns to search on list and click or. 2. Click Next. You can now specify filters for the template, as described in Specifying filters for a task list template, page 73. Specifying lters for a task list template The Step 6 page of the New Template wizard allows you to create, modify, and delete filters, which use search criteria to reduce the task list. Figure 23. New template wizard: Filters for a task list template To continue with the template creation: 1. Add, modify, move, or remove filters as needed: To add a filter, click Add. Further instructions are provided in Creating or modifying a filter, page 59. To modify a filter, select it and click Modify. Further instructions are provided in Creating or modifying a filter, page 59. To move a filter, select it and click or. To remove a filter, select it and click Remove. 2. Click Next. EMC Documentum Forms Builder Version 6 User Guide 73

74 Creating Templates You can now specify search criteria for the template, as described in Specifying search criteria for a task list template, page 74. Specifying search criteria for a task list template The Step 7 page of the New Template wizard allows you to create, modify, and delete search criteria (qualifications), which reduce the task list. Figure 24. New Template wizard: Search criteria for a task list template To complete the template creation: 1. Create qualifications using search criteria, with or without user input: Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). For each search criterion, select a variable from the Variable list box, select a condition from the Condition list box, and specify whether to get user input or use a default value. To add another criterion, click the plus sign. To delete a criterion, click the minus sign next to it. If a user leaves a field blank, the search ignores the field. 2. Click Finish. The Forms Builder software creates a template based on the task list type, process, data types, columns, filters, and search criteria you selected, and adds a default Go 74 EMC Documentum Forms Builder Version 6 User Guide

75 Creating Templates button to the template. You can now finish creating the template, as described in Completing the task list template creation, page 75. Completing the task list template creation After you have completed the New Template wizard, finish creating the task list template. To complete the template creation: 1. Use the Forms Builder software to configure search criteria, filter, and task list columns. You can configure the template by adding more controls or by modifying or removing the default controls. The following sections provide brief descriptions of what you can configure: Modifying process selection for a task list template, page 75 Modifying search criteria for a task list template, page 76 Modifying column selection for a task list template, page 77 Modifying column settings for a task list template, page 78 Managing filters for a task list template, page 80 Selecting different structured data types for a task list template, page 80 Detailed instructions are available in Chapter 3, Editing Templates. 2. To increase usability, add instructions for the user about the search criteria, the filter, task list columns, or your own configurations. For example, if the search criteria must be entered in a particular format, explain the required format. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 3. Select File > Save. 4. When the template is ready for end users to use, select Tools > Install. Modifying process selection for a task list template After you have created a task list template using the New Template wizard, you can change settings that you had specified in the wizard, including the process selection, before using the template in a user interface. To modify the process selection for a task list template: 1. Under UI Model, expand the Group0 and tasklistgroup nodes. Select tasklist. EMC Documentum Forms Builder Version 6 User Guide 75

76 Creating Templates 2. Under Properties, click Special. Next to Task Search, click Select Process. The Task Search dialog box appears. 3. Specify whether to include tasks from all processes in the repository or from selected processes. 4. Click OK. Modifying search criteria for a task list template After you have created a task list template using the New Template wizard, you can change settings that you had specified in the wizard, including the search criteria, before using the template in a user interface. To modify the search criteria for a task list template: 1. Under UI Model, expand the Group0 and tasklistgroup nodes. Select tasklist. 2. Under Properties, click Special. Next to Task Search, click Modify Search. 76 EMC Documentum Forms Builder Version 6 User Guide

77 Creating Templates 3. To add structured data types, click Select more Structured Data Type. Further instructions are provided in Selecting different structured data types for a task list template, page Create qualifications using search criteria, with or without user input: Specify whether you want the results to match all criteria (an And search) or any criteria (an Or search). For each search criterion, select a variable from the Variable list box, select a condition from the Condition list box, and specify whether to get user input or use a default value. To add another criterion, click the plus sign. To delete a criterion, click the minus sign next to it. If a user leaves a field blank, the search ignores the field. 5. Click OK. Modifying column selection for a task list template After you have created a task list template using the New Template wizard, you can change settings that you had specified in the wizard, including the columns, before using the template in a user interface. To display the Columns table: 1. Under UI Model, expand the Group0 and tasklistgroup nodes. Select tasklist. 2. Under Properties, click Special. EMC Documentum Forms Builder Version 6 User Guide 77

78 Creating Templates To modify the column selection for a task list template: 1. Next to Columns, click Add/Remove. The Columns dialog box appears. 2. If necessary, select the column type. Standard columns are always available. However, if you have created an structured data type in Process Builder, it is also available in the list as a column type. 3. Specify which columns you want to display on the list: To display a column, select it from the Available columns list and click. To remove a column, select it from the Columns to search on list and click. 4. Specify the order of columns. To move a column, select it from the Columns to search on list and click or. 5. Click OK. Modifying column settings for a task list template After you have created a template using the New Template wizard, you can make further adjustments to the columns in that template. To display the Columns table: 1. Under UI Model, expand the Group0 and tasklistgroup nodes. Select tasklist. 2. Under Properties, click Special. To modify columns: 1. In the Columns table, select the row representing the column to modify. 2. Click Modify. The Edit Column dialog box appears. 78 EMC Documentum Forms Builder Version 6 User Guide

79 Creating Templates 3. Modify settings as needed for the selected column. The following table describes each setting: Table 12. Column settings Field Column label Column width Display Sortable Sorted by default Style Description Type a new label in the box or select an icon from the list box, or both. The text or icon appears in the column header. Select Automatic or Fixed. If you select Fixed, you must specify a length in the adjacent box. Select True (to make the column visible to the end users) or False (to hide the column from end users). For example, if you have included an attribute as a column to enable specific functionality in a search result set, you can hide the column here and still retain that functionality. Select True (to allow sorting on this column) or False (to prevent sorting on this column). Sorting may be convenient for the end user but may also be a performance consideration. Select None, Ascending (to specify that the values should increase in this column), or Descending (to specify that the values should decrease in this column). If a column is visible to end users, they can change the sort order on this column or sort another column instead. Note: Only one column can be sorted at a time. Select Default, Override with format, or Override with CSS. If you select Override with format, the Edit button becomes available. (Further instructions on specifying the character formatting in a column are provided in Specifying the character EMC Documentum Forms Builder Version 6 User Guide 79

80 Creating Templates Field Description formatting in a column, page 38.) If you select Override with CSS, you must select a CSS class from the list box. 4. Click OK. Additional instructions are available in Chapter 3, Editing Templates. Managing lters for a task list template After you have created a task list template using the New Template wizard, you can change settings that you had specified in the wizard, including the filters, before using the template in a user interface. To display lter settings for a task list template: 1. Under UI Model, expand the Group0 and tasklistgroup nodes. Select taskfilter. 2. Under Properties, click Special. To modify lter settings: 1. Next to Filters, add, modify, move, or remove filters as needed: To add a filter, click Add. Further instructions are provided in Creating or modifying a filter, page 59. To modify a filter, select it and click Modify. Further instructions are provided in Creating or modifying a filter, page 59. To move a filter, select it and click the up or down arrow. To remove a filter, select it and click Remove. Selecting different structured data types for a task list template After you have created a task list template using the New Template wizard, you can change settings that you had specified in the wizard, including the list of structured data types, before using the template in a user interface. To select different structured data types for a task list template: 1. Display the Qualifications or Filters dialog box. The following sections provide instructions: Modifying search criteria for a task list template, page 76 Managing filters for a task list template, page EMC Documentum Forms Builder Version 6 User Guide

81 Creating Templates 2. Click Add Structured Data Type. The Select Structured Data Type dialog box appears. 3. If you have created any structured data types in Process Builder for the purpose of this task list, select them: To display an structured data type, select it from the Available Structured Data Types list and click. To remove an structured data type, select it from the Selected Structured Data Types list and click. 4. Click OK. Creating a template for a task interface The Forms Builder software allows you to configure templates specific to the TaskSpace software, including task templates, which are used for processes. Task templates appear in a task view for display of tasks. You can specify whether the task template displays the standard task view or a task view with an embedded document view. This section describes how to create a template for a task interface. Template configuration is primarily an assembly of various items. Task templates are built on the following items: An installed process template. Process Builder allows you to create and install process templates. The Documentum Process Builder User Guide provides detailed instructions. EMC Documentum Forms Builder Version 6 User Guide 81

82 Creating Templates For the type of task template that displays a task view with an embedded document view, a document view template. Instructions are provided in Creating a template for a document view, page 39. Note: The document view template and the package in the process template must be based on the same object type. To create a task template: 1. In the Forms Builder software, select File > New Template. The Welcome to Forms Builder dialog box appears. 2. From the Create new template list box, select TaskSpace Component. 3. From the Template type list box, select Task. 4. In the Enter a name box, type a unique name. 5. (Optional) In the Description box, type a description. This description appears in the template s properties in the TaskSpace user interface. 6. Click OK. The New Template wizard appears, starting with the Step 2 page. You can now select a process for the template, as described in Selecting a process for a task template, page EMC Documentum Forms Builder Version 6 User Guide

83 Creating Templates Selecting a process for a task template The Step 2 page of the New Template wizard allows you to select a process for the task template. This page of the wizard lists only installed process templates. Figure 25. New template wizard: Process for a task template To continue with the template creation: 1. From the Select a process list, select a process. 2. Click Next. You can now select an activity for the template, as described in Selecting an activity for a task template, page 83. Selecting an activity for a task template Users process tasks for one activity in a process at a time, so each task template must be associated with a specific task. The Step 3 page of the New Template wizard allows you to select an activity for the task template. This page of the wizard lists all available manual activities. Each activity can be associated with only one template. Therefore, when you create a task template, the activity you select is no longer available for use with other templates. (Deleting a task template releases the activity for use with another template.) EMC Documentum Forms Builder Version 6 User Guide 83

84 Creating Templates Figure 26. New template wizard: Activity for a task template To continue with the template creation: 1. From the Select an activity list, select an activity. 2. If the selected process contains no packages, click Finish. 3. If the selected process contains packages, choose whether to explore more task template options (process variables and document view) through the wizard: To explore more options, click Next. The Step 4 page of the wizard appears. Further instructions are provided in Selecting process variables for a task template, page 85. To create the standard task view, click Finish. If you click Finish, the Forms Builder software creates a template based on the process and activity you selected, and adds several associated default controls to the template. The template includes designated space for task instructions, base form (in read-only mode), and designated space for a row of task-related buttons. The instructions and task-related buttons appear based on Process Builder logic. All buttons that potentially can be used in the selected activity are displayed, such as Finish, Delegate, Repeat, and Close. Further instructions are provided in Completing the task template creation, page 87. Note: To associate this task template with multiple activities, after you have completed the wizard, install the template and use Process Builder to select the template for each activity. The Documentum Process Builder User Guide provides detailed instructions. 84 EMC Documentum Forms Builder Version 6 User Guide

85 Creating Templates Selecting process variables for a task template The Step 4 page of the New Template wizard allows you to select process variables for the task template. This page of the wizard lists all available process variables. Figure 27. New template wizard: Process variables for a task template If the process you selected on the Step 2 page of the wizard contains no packages, the Next button is not available and the wizard creates the standard task view. If the selected process contains one or more packages, you can choose whether to use a document view in the task view. To continue with the template creation: 1. Specify which process variables you want to display on the form: To display a process variable, select it from the Available process variables list and click. To remove a process variable, select it from the Selected process variables list and click. To move a process variable, select it from the Selected process variables list and click or. 2. If the selected process contains no packages, click Finish. 3. If the selected process contains packages, choose whether to use a document view in the task view: To use a document view in the task view, click Next. The Step 5 page of the wizard appears. Further instructions are provided in Selecting a document view for a task template, page 86. EMC Documentum Forms Builder Version 6 User Guide 85

86 Creating Templates To create the standard task view, click Finish. If you click Finish, the Forms Builder software creates a template based on the process, activity, and process variables you selected, and adds several associated default controls to the template. The template includes designated space for task instructions, base form (in read-only mode), and designated space for a row of task-related buttons. The instructions and task-related buttons appear based on Process Builder logic. All buttons that potentially can be used in the selected activity are displayed, such as Finish, Delegate, Repeat, and Close. Further instructions are provided in Completing the task template creation, page 87. Selecting a document view for a task template The Step 5 page of the New Template wizard appears if the selected process contains any packages and you clicked Next on the previous page of the wizard. If this page appears, it allows you to select a document view template to use as a base for the task template. This page of the wizard lists only document view templates based on the same object type as the package in the selected process template. Figure 28. New template wizard: Document view template for a task template To continue with the template creation: 1. Choose whether to use a document view in the task view. 2. If you chose to use a document view, from the list, select a document view template. 3. Click Finish. 86 EMC Documentum Forms Builder Version 6 User Guide

87 Creating Templates The Forms Builder software creates a template based on the process, activity, process variables, and document view template you selected. The template includes designated space for task instructions, the document view, and designated space for a row of task-related buttons. The instructions and task-related buttons appear based on Process Builder logic. All buttons that potentially can be used in the selected activity are displayed, such as Rescan, Finish, Delegate, Repeat, and Close. The buttons that appear to the end user depend on whether the task was assigned to a user or a queue. (The document view item is a placeholder for the entire document view template within the task template. Individual controls associated with the document view template do not appear in the task template, although they should still appear in any task forms created from this task template.) You can now finish creating the template, as described in Completing the task template creation, page 87. Completing the task template creation After you have completed the New Template wizard, finish creating the task template. To complete the template creation: 1. Use the Forms Builder software to further configure the template. You can configure the template by adding more controls or by modifying or removing the default controls. For example, if you selected process variables to be displayed on the template, you can modify the label for each. Detailed instructions are available in Chapter 3, Editing Templates. Note: The task template may contain a document view template. You can change settings for the viewer in the document view template but not in the task template. Instructions are provided in Completing the document view template creation, page To increase usability, add instructions for the user about the default controls or your own configurations. For example, if you add a button, explain what action the button is designed to perform. These instructions may take the form of a Help link or text displayed adjacent to each control. If you add a Help link, create a helpful topic and make sure that the Help link displays it. Detailed instructions are available in Chapter 3, Editing Templates. 3. Select File > Save. 4. When the template is ready for end users to use, select Tools > Install. Note: To associate this task template with multiple activities, use Process Builder to select the template for each activity. The Documentum Process Builder User Guide provides detailed instructions. EMC Documentum Forms Builder Version 6 User Guide 87

88 Creating Templates Saving a template After you create a template or edit the template, as described in Chapter 3, Editing Templates, you must save the template. The template is saved in the repository with the same file name as the name of the template. To save a template: 1. Use one of the following methods to save the template: Select File > Save. Click Save on the toolbar. Press Ctrl+S. The template is saved in the repository. 2. To save the template using a different name, select File > Save As. The Save As dialog box appears displaying the current template name and description (if any). a. In the Form template name box, type a new name for the template. b. In the Description box, type a description for the template (optional). c. Click Save. Validating and installing a template While you are creating and editing the template, a draft copy of the template is stored in the repository. When you complete editing the template and want to make it available to WDK-based applications, you must validate and then install the template. Once the template is installed, WDK-based applications can use the template to create form instances. To validate and install a template: 1. To validate a template, select Tools > Validate. If the validation fails, correct the errors, and then validate the template again. 2. To install the template, select Tools > Install. Table 13, page 89 describes the different template states. 88 EMC Documentum Forms Builder Version 6 User Guide

89 Creating Templates Table 13. Template states State Draft Validated Installed Obsolete Description A template is in Draft state between the time it is created and the time it is validated. You can edit a template when it is in Draft state. A template is in the Validated state if it has passed validation checks. A Validated template returns to the Draft state automatically when you edit it. A template is in the Installed state if you have installed it. You can edit a template when it is in Installed state. An installed template is available to WDK-based applications to create form instances. A template is in the Obsolete state if you have specifically set its state to Obsolete. An obsolete template is no longer available to WDK-based applications. Changing the template state Templates can have four different states: Draft, Validated, Installed, and Obsolete. The current state of a template is indicated in the Forms Builder application s main window title. The state of a template is controlled by the definition_state attribute of the dm_xfm_form object, the object type that is used for templates in the repository. New forms, and forms that are updated, are in the Draft state. You can edit a template in the Installed state. However, when you save such a template after making changes, the Forms Builder software warns that the save operation will change the template to Draft state. You must confirm this action to save the template back to Draft state. To return a template from the Installed state back to the Draft state: 1. Open the template in the Forms Builder software, if you have not done so already. 2. Select Tools > Back to Draft. The state indicator in the Forms Builder main window title changes back to Draft. EMC Documentum Forms Builder Version 6 User Guide 89

90 Creating Templates Note: When you return an installed template back to the Draft state and make changes, you must install the template again to make the template available to WDK-based applications in order to make your changes take effect. However, form instances based on the previous version of the template are still valid. Opening an existing template If the repository you logged in to when you started the Forms Builder software already contains templates, you can open any of these templates for editing. To open an existing template: 1. Use one of the following methods to open an existing form template: On the Welcome to Forms Builder dialog box, select Open template... from the Open existing template section. Note: The Welcome to Forms Builder dialog box also appears immediately after you log in to the Forms Builder application. Select File > Open Template, or click the Open icon on the toolbar. The Open Template dialog box appears. 2. Select the template from the list box. 3. Click Open. Deleting templates You can delete any template that is no longer used. However, the template must be closed before deleting. To delete a template: 1. Select Tools > Delete Template. The Delete Template dialog box appears. 2. Select the template from the list box. 3. Click Delete. Click Yes in the warning dialog box that appears to confirm deleting the template. If the template you are deleting is an Installed template, a warning appears. Click Yes to delete the Installed template. If the Installed template has form instances associated with it, a warning appears to confirm the deletion of the template along 90 EMC Documentum Forms Builder Version 6 User Guide

91 Creating Templates with the associated form instances. Click Yes to delete the Installed template and its instances. The corresponding template folder under /Systems/Forms directory is also deleted. If the template you are deleting has a process associated with it, Forms Builder warns you if you want to delete the form that is being used by the process. Click Yes in the Delete Form Template dialog box to delete the template. EMC Documentum Forms Builder Version 6 User Guide 91

92 Creating Templates 92 EMC Documentum Forms Builder Version 6 User Guide

93 Chapter 3 Editing Templates This chapter describes how to add or remove controls, objects, and properties on templates, such as UI objects, data objects, and data storage properties. This chapter includes the following topics: Understanding the Forms Builder user interface, page 93 Adding and modifying UI objects, page 99 Adding and modifying data objects, page 176 Configuring data storage properties, page 181 Understanding the Forms Builder user interface The Forms Builder software s user interface is divided into seven principle sections, called Data Model pane, UI Model pane, Design and Preview pane, Design Boxes pane, Controls pane, and Properties pane. The interface also contains a menu bar and toolbar. Figure 29, page 94 shows the Forms Builder application user interface. EMC Documentum Forms Builder Version 6 User Guide 93

94 Editing Templates Figure 29. Forms Builder user interface The following sections describe each of the panes and the toolbar. Data Model pane, page 95 UI Model pane, page 95 Design pane, page 95 Preview pane, page 95 Design Boxes pane, page 96 Controls pane, page 96 Properties pane, page 96 Toolbar, page EMC Documentum Forms Builder Version 6 User Guide

95 Editing Templates Data Model pane The Data Model pane contains the names of the data model items and groups that are currently used in the template. When you double-click a data object in the Data Model pane, the object s properties are displayed in the Properties pane. UI Model pane The UI Model pane contains the UI root and the names of the UI items and groups that are currently used in the template. When you select an object in the UI Model pane, the associated UI control, such as a button, text field, or table is highlighted in the Preview pane. When you double-click a UI object in the UI Model pane, the object s properties are displayed in the Properties pane. Every form is created with a UI root. The name of this root as it appears in the UI comes from the Label field in the Properties pane. This name is automatically created from the form name at the time the form is created, after filtering to remove spaces and other characters that are not allowed. (More information on name and label constraints is available in Table 5, page 25.) When the form is created, the UI root is created with another UI group with four buttons. All form objects that you create must be placed in this UI root. The Label field of this UI root also controls the form title in the Preview pane. More information on how to change the title of the form in the Preview pane is available in Changing the template title, page 104. Design pane The Design pane displays a workspace to design the template. You can add or remove UI controls, such as text fields, list boxes, and design boxes in the template. When you select a control, for example, a button, text field, or a table in the Design pane, the associated UI object is highlighted in the UI Model pane. Preview pane The Preview pane shows the layout and formatting of the template as it would appear to the end user. You cannot edit UI controls in the Preview pane itself but only in the Properties pane. EMC Documentum Forms Builder Version 6 User Guide 95

96 Editing Templates Design Boxes pane The Design Boxes pane contains a list of design boxes that can be used to control the layout of the template. The layout of a template determines the alignment of UI objects within the template. UI objects may be placed vertically that is, one object below the other, or horizontally. The Forms Builder software supports the following design boxes: Horizontal Box, Vertical Box, Table Box, and Docking Box. A form can have only one Docking Box. Controls pane The Controls pane contains the UI objects that can be used to design the template. You can use the drag-and-drop feature to add UI objects to the template in the Design pane. Properties pane The Properties pane lets you edit the properties of UI and data objects. There are three tabs in the Properties pane, as follows: General tab The General tab displays the properties of the UI object, data group, or data item you selected in the UI Model or Data Model pane. The General tab has the following sub-tabs: Display The Display tab lets you set the properties of a UI object or data group, such as the label, display options, help text, tab navigation order, and so on. Data & Storage The Data & Storage tab lets you define the data attributes of UI objects, bind data groups or data items, specify constraints for UI objects, and configure data storage properties and adaptors. The Data & Storage tab also displays the name of the custom repository attribute that is populated with the value of that data object when data from a form instance is saved. More information on configuring data storage properties is available in Configuring data storage properties, page 181. For UI objects that have no data binding, the Data & Storage tab display is blank. 96 EMC Documentum Forms Builder Version 6 User Guide

97 Editing Templates Rules Special tab The Rules tab lets you define runtime conditions for UI objects, data groups, and data items. The editability, that is, editable versus read-only, and the visibility, that is, visible versus hidden, of a UI object may be made conditional. The conditions may be based on an end user s role or values of items in the data model. The default condition is editable and visible. More information on setting conditional properties is available in Setting conditional properties, page 141. The Special tab lets you include the default value, calculation formula for calculation fields, and values for list boxes. You can also add images, such as company logos, into the template, and specify the dimensions of the image in pixels or percentage values using this tab. Style tab The Style tab lets you define the style properties for UI objects, such as the background color, alignment, margin, font size, font color, border style, label styles, and so on. Margins represents the space around a UI object. Margin values are fixed amounts, and specified as Px (pixels). Label orientation represents the position of the label for a UI object. By default, labels are placed to the left of the UI object; however, labels can also be placed at the top of the UI object. If the Properties pane is closed, you can open it by double-clicking an object in the Data Model pane or UI Model pane. Toolbar The toolbar contains icons that you can use to perform a variety of operations. This includes creating new templates, opening and saving templates, copying, moving, or deleting UI controls on the Design pane, modifying label text (font, color, alignment), configuring form data storage, and context aware simulation. Table 14, page 98 describes the available toolbar icons. EMC Documentum Forms Builder Version 6 User Guide 97

98 Editing Templates Table 14. Toolbar icons Icon Description Create a new template. Open an existing template. Save a template in Draft state. icon Cut the selected object. This removes the object from the selected region and places it in a paste buffer. Copy the selected object. This places the copied object in a paste buffer. Inserts the content of the paste buffer at the cursor location. Delete the selected UI object. Moves the selected object one position up. Moves the selected object one position down. Displays the currently selected font family and allows the user to select another. Displays the currently selected font size and allows the suer to change it. Makes the selected label text bold. Italicizes the selected label text. If the text is already italic, removes the italic. Underlines the selected label text. If the text is already underlined, removes the underline. Select a label text color. Aligns the label text to the left margin. Centers the label text. 98 EMC Documentum Forms Builder Version 6 User Guide

99 Editing Templates Icon Description Aligns the label text to the right margin. Opens the View All Storage Mappings dialog box. You can define the way form instance data will be stored in the repository. Preview the form based on roles. Provides help on the Forms Builder work area. Adding and modifying UI objects After you have created a template, you can edit the template and add or remove UI objects. To add a new UI object: 1. Use one of the following methods to add a UI object: Select Insert > Widget, and then select the UI object you want to add. Right-click the root in the UI Model pane, select Insert, and then select the UI object. Select the UI object on the Controls pane and drag it into the template. Depending on the location of the mouse, a red line appears as an indication of the position where the new object would be added. If the mouse is at the edge of the Design pane, the window scrolls in the appropriate direction until it reaches the edge of the Design pane. If the drop operation is invalid, the cursor changes to indicate the invalid operation. Table 15, page 100 describes the UI objects you can add from the Insert menu or the shortcut menu. The type of UI objects that appear on the Insert menu depend on the template type you are designing. Some UI objects are not available in every template type. EMC Documentum Forms Builder Version 6 User Guide 99

100 Editing Templates Table 15. UI objects UI object Description Data type Text Link Image Text Field Number Field Adds text to the form. More information about adding text is available in Adding text, page 104. Adds a hyperlink to the form. More information about adding links is available in Adding a link, page 105. Adds an image to the form. More information about adding images is available in Adding an image, page 106. Adds a text field to your form that allows users to enter data. A text field can be a one-line input field or a multiline input field. More information about adding a text field is available in Adding a text field, page 107. Adds a one-line field that accepts numerical input. More information about adding a number field is available in Adding a number field, page 111. If Label and data bound text display is selected, the text that is displayed is based on the value of the data item to which it is bound, as long as the data type is not richtext or anyuri. If Label and data bound text display is selected, the URI that is displayed is the value of the data item to which it is bound, as long as the data type is anyuri. Not applicable string int, byte, short, long, float, double 100 EMC Documentum Forms Builder Version 6 User Guide

101 Editing Templates UI object Description Data type Date Field Date Time Field Rich Text CheckBox CheckBox Group Adds a one-line field that accepts a date format. More information about adding a date field is available in Adding a date field, page 112. Adds a one-line field that accepts a date and time format. More information about adding a date time field is available in Adding a date time field, page 113. Adds a multiline field that allows users to enter formatted text. The Forms Builder software stores the rich text input as HTML markup. More information about adding a rich text field is available in Adding a rich text field, page 108. Adds a single checkbox to the form. More information about adding checkbox is available in Adding a single checkbox, page 114. Adds two or more checkboxes as a group. More information about adding a checkbox group is available in Adding a checkbox group, page 116. date datetime richtext Boolean string EMC Documentum Forms Builder Version 6 User Guide 101

102 Editing Templates UI object Description Data type Radio Button Group ListBox Dropdown List Button Attachment Tab Group Adds a group of radio buttons. More information about adding a radio button group is available in Adding a radio button group, page 117. Adds a list box. More information about adding a list box is available in Adding a list box, page 118. Adds a drop-down list box. More information about adding a drop-down list box is available in Adding a drop-down list, page 119. Adds a button. More information about adding a button is available in Adding a button, page 120. Adds an attachment to the form. More information about adding an attachment is available in Adding an attachment, page 122. Adds a tab group with two default tabs. More information about adding a tab group is available in Adding a tab group, page 126. string string string Not applicable attachment Group 102 EMC Documentum Forms Builder Version 6 User Guide

103 Editing Templates UI object Description Data type Tab Table Readonly Table Comment History Spacer Line Adds additional tabs to a tab group. More information about adding a single tab is available in Adding a single tab to a tab group, page 128. Adds a table. More information about adding a table is available in Adding a table, page 124. Adds a read-only table to the form. More information about adding a read-only table is available in Adding a read-only table, page 125. Adds a text field to the form for users to enter comments. More information about adding a comment field is available in Adding a comment history, page 123. Adds a space of specific dimension. More information about adding space is available in Adding spaces around UI objects, page 130. Adds a horizontal line to the form. More information about adding horizontal lines is available in Adding a horizontal line, page 129. Tab Group string string Not applicable Not applicable EMC Documentum Forms Builder Version 6 User Guide 103

104 Editing Templates Changing the template title When you create a new template, by default, the Forms Builder software assigns the template name as the title of your template. You can change the title on your template by editing the Label field in the Display tab of the Properties pane. To change the title on your template: 1. Select the template name at the root of the UI Model pane. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the template name at the root of the UI Model pane to open the Properties pane. 3. In the Label field, type the new title for your template. 4. Press Tab, or click the Preview pane to view the new title. Adding text The text control lets users add text to a template and does not generate a text field for data input. This control does not require users to enter data. For example, you can use the text control to add a text introduction for your template. To add text to your template: 1. Use one of the following methods to create the text control: In the UI Model pane, select the UI element or group under which you want to insert the text control. Select Insert > Widget > Text. Right-click the object and select Insert > Text. Drag and drop the Text control from the Controls pane. A place holder for the text control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the text control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the text control you just added in the UI Model pane. 3. Configure the UI properties of the text control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

105 Editing Templates 4. In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the text control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the text control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the text control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a link Use a link control to add a hyperlink to the form. This control does not require users to enter data. If you have a shared data model, you can display a URI that was collected on another form. (More information on shared data models is available in Understanding shared data models, page 15.) The data type for the shared data item must be anyuri. To add a link to your template: 1. Use one of the following methods to create the link control: In the UI Model pane, select the UI element or group under which you want to insert the link control. Select Insert > Widget > Link. Right-click the object and select Insert > Link. Drag and drop the Link control from the Controls pane. A place holder for the link control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the link control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the link control you just added in the UI Model pane. 3. Configure the UI properties of the link control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the link control based on roles or data from other EMC Documentum Forms Builder Version 6 User Guide 105

106 Editing Templates controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the link control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the link control using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding an image The image link control lets users add an image, such as a company logo, to the form. An image can be shared by more than one form template. The Forms Builder software supports image files, such as.jpg,.jpeg,.gif, and.png. An image can be imported from either the local file system or network, or from the repository. If image files are imported from the repository, they are linked to the form as a reference. If images are imported from the local file system or network, they are copied into a predefined location in the repository, such as /System/Forms/Images/, and then linked to the form. To add an image: 1. Use one of the following methods to add the image control: In the UI Model pane, select the UI element or group under which you want to insert the image control. Select Insert > Widget > Image Right-click the object and select Insert > Image Drag and drop the Image control from the Controls pane The image control appears on the template. Note: Click the Move Up or Move Down icon in the toolbar to change the position of the image control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the image control you just added in the UI Model pane. 3. Configure the UI properties of the image control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page Configure additional properties for the image control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

107 Editing Templates 5. Configure the format and style of the image control using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a text eld A text field displays a text label with a one-line input box, into which users enter text. The text field must be bound to a string data type. You can also display a multiline text field by selecting the Multi-line property for the text field. Tip: If you want to allow users to format the text, use a rich text field. To add a text eld: 1. Use one of the following methods to create the text field: In the UI Model pane, select the UI element or group under which you want to insert the text field. Select Insert > Widget > Text Field. Right-click the object and select Insert > Text Field. Drag and drop the Text Field control from the Controls pane. The text field appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the text field. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the text control you just added in the UI Model pane. 3. Configure the UI properties of the text field control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Data & Storage to configure the data properties for the text field control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the text field control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the text field control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page 156. EMC Documentum Forms Builder Version 6 User Guide 107

108 Editing Templates 7. Configure the format and style of the text field using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a rich text eld A rich text field allows users to enter and format text with common formatting options, such as bold and italics, that are unavailable with plain text. The formatted text is stored as HTML markup. To add a rich text eld: 1. Use one of the following methods to create the rich text field: In the UI Model pane, select the UI element or group under which you want to insert the rich text field. Select Insert > Widget > Rich Text. Right-click the object and select Insert > Rich Text. Drag and drop the Rich Text control from the Controls pane. The rich text field and formatting toolbar appears in the Design pane. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the rich text field. Table 16, page 108 describes the available formatting options. Table 16. Formatting buttons in Rich Text eld control Option Description Displays heading styles that can be applied to a selected line of text. Displays the currently selected font family and allows users to select another. If the selected font is not installed on the form user s machine, the font defaults to a more common font within that family. Displays the currently selected font size and allows users to change it. 108 EMC Documentum Forms Builder Version 6 User Guide

109 Editing Templates Option Description Copies selected text to clipboard and deletes it from current location. This may not work for Mozilla and Netscape browsers because of the browser security setting. Use the standard key combination Ctrl+X instead. Copies selected text to clipboard and leaves a copy in current location. This may not work for Mozilla and Netscape browsers because of the browser security setting. Use the standard key combination Ctrl+C instead. Pastes text from the clipboard into the selected location. This may not work for Mozilla and Netscape browsers because of the browser security setting. Use the standard key combination Ctrl+V instead. Deletes the selected text, image, or hyperlink. Makes the selected text bold. If the text is already bold, removes the bold. Italicizes the selected text. If the text is already italic, removes the italic. Underlines the selected text. If the text is already underlined, removes the underline. Makes the selected text subscript (small text below the line). Makes the selected text superscript (small text above the line). Aligns each line in a block of text to the left margin. Centers each line in a block of text. Aligns each line in a block of text to the right margin. EMC Documentum Forms Builder Version 6 User Guide 109

110 Editing Templates Option Description Stretches each line in a block of text to meet the left and right margins. Creates a numbered list. Creates a bulleted list. Indents a block of text. Decreases the paragraph indentation. Selects a font color for the selected text. Highlights the background color of the selected text. Inserts a URL link to an image. Creates a hyperlink from selected text. Inserts a table into the rich text field frame from the clipboard. The table can be in Word, RTF, or HTML format. Checks the spelling of the text in the rich text frame. Reverses (undo) the previous action. Multiple undo is allowed. Note the following constraints on Undo/Redo: Undo/redo does not apply to actions that were invoked with the shortcut menu (the menu displayed by right-clicking an object). Undo/redo does not apply to table manipulations (creating tables, adding and deleting rows). Netscape and Mozilla browsers do not support undo/redo for adding background color. 110 EMC Documentum Forms Builder Version 6 User Guide

111 Editing Templates Option Description Restores the previous undo. Multiple redos are allowed. See previous description for a list of constraints. Displays the HTML markup of the formatted text. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the rich text field you just added in the UI Model pane. 3. Configure the UI properties of the rich text field using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Data & Storage to configure the data properties for the rich text field control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the rich text field based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the rich text field using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the rich text field using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a number eld A number field allows users to enter a number on the form. The number field is bound to a numeric data type. To add a number eld: 1. Use one of the following methods to create the number field: In the UI Model pane, select the UI element or group under which you want to insert the number field. Select Insert > Widget > Number Field. Right-click the object and select Insert > Number Field. Drag and drop the Number Field control from the Controls pane. The number field appears on the template. EMC Documentum Forms Builder Version 6 User Guide 111

112 Editing Templates Note: Click the Move Up or Move Down icon in the toolbar to change the position of the number field. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the number field control you just added in the UI Model pane. 3. Configure the UI properties of the number field using the fields in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Data & Storage to configure the data properties for the number field, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the number field control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the number field control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the number field using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a date eld A date field allows users to enter a date on the form. If you want users to be able to edit the hours, minutes, and seconds, use the date time field control instead. The Forms Builder software stores dates in yyyy/mm/dd format in the repository, but the display of the date on the form changes according to the login locale of the form user. The login locale is selected on the login screen of WDK-based applications. For example, if a user logs in to Webtop in the English locale, the date appears as Aug 12, If the login locale is Korean (ko), the date appears as Users can type a date or select a date from the date wizard. The Forms Builder software converts the date internally and saves it in the yyyy/mm/dd format. Note: Depending on a user s locale setting, the date format can appear in a different local format than the rest of the form. For example, if a user logs in to the English locale and accesses an Italian form, the form wording appears in Italian, but the date appears in English format. To add a date eld: 1. Use one of the following methods to create the date field: 112 EMC Documentum Forms Builder Version 6 User Guide

113 Editing Templates In the UI Model pane, select the UI element or group under which you want to insert the date field. Select Insert > Widget > Date Field. Right-click the object and select Insert > Date Field. Drag and drop the Date Field control from the Controls pane. The date field appears on the template. Note: Click the Move Up or Move Down icon in the toolbar to change the position of the date field control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the date field you just added in the UI Model pane. 3. Configure the UI properties for the date field control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click General, and then click Data & Storage in the Properties pane and configure the data properties for the date control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the date field control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the date field control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the date field control using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a date time eld A date time field allows users to enter a date as well as the hours, minutes, and seconds. The Forms Builder software stores dates in yyyy/mm/dd format in the repository, but the display of the date on the form changes according to the login locale of the form user. Hours, minutes, and seconds are displayed as hh:mm:ss in 24-hour format, regardless of locale. To add a date time eld: 1. Use one of the following methods to create the date time field: EMC Documentum Forms Builder Version 6 User Guide 113

114 Editing Templates In the UI Model pane, select the UI element or group under which you want to insert the date time field. Select Insert > Widget > Date Time Field. Right-click the object and select Insert > Date Time Field. Drag and drop the Date Time Field control from the Controls pane. The date time field appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the date time field. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the date time field you just added in the UI Model pane on the left side of the Forms Builder window. 3. Configure the UI properties of the date time field control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Data & Storage to configure the data properties for the date time field, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the date time field based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the date time field using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the date time field control using the attributes in the Style tab, such as the alignment, font, and margin values for this control. Adding a single checkbox The checkbox control adds a single checkbox that can have two possible values. By default, the data type for a checkbox is Boolean with the two values true and false. One value is assigned when the checkbox is selected, the other one when the checkbox is not selected. A single checkbox is functionally equivalent to a radio group control with two radio buttons. For example, you could have a checkbox labeled I want to subscribe to the newsletter; if you select the checkbox, the value true will be stored, false otherwise. Tip: If you need to display more than one checkbox, use a checkbox group control. 114 EMC Documentum Forms Builder Version 6 User Guide

115 Editing Templates You can change the data type of a checkbox on the Data & Storage tab in the Properties pane. With a non-boolean data type, you can enumerate two values, or you can enumerate more than two values, and then select two of them for the checkbox control. This provides compatibility in switching among controls. For example, you could easily change a list box control to a checkbox control, and then select which two values you want to use. To add a checkbox: 1. Use one of the following methods to create the checkbox: In the UI Model pane, select the UI element or group under which you want to insert the checkbox. Select Insert > Widget > Checkbox. Right-click the object and select Insert > Checkbox. Drag and drop the Checkbox control from the Controls pane. The checkbox appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the checkbox control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the checkbox control you just added in the UI Model pane. 3. Configure the UI properties of the checkbox control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click Data in the Properties pane and configure the data properties for the checkbox control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the checkbox control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the checkbox control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the checkbox control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. EMC Documentum Forms Builder Version 6 User Guide 115

116 Editing Templates Adding a checkbox group The checkbox group control adds two or more checkboxes at a time. Checkbox groups can have a value assigned only to the selected state, unlike the single checkbox option which accepts values for both, the selected and the cleared states of the checkbox. You cannot define a value for a cleared checkbox in a checkbox group. For example, you can use a checkbox group to offer customers the option to subscribe to any of three different newsletters. You would assign a different newsletter name to each of the checkboxes in the group. Customers can then check any combination of checkboxes to subscribe to the corresponding combination of newsletters. The corresponding data item would contain values for the checked newsletters. The data item for the checkbox group control must have enumerated values. You can choose which of the enumerated values of a data item you want to display to users. You can also allow users to enter values. If a user enters a value that is not one of the displayed values, there is no effect on the template. In particular, subsequent instances of the form do not display the new value as a choice. To add a checkbox group: 1. Use one of the following methods to create the checkbox group: In the UI Model pane, select the UI element or group under which you want to insert the checkbox group. Select Insert > Widget > CheckBox Group. Right-click the object and select Insert > CheckBox Group. Drag and drop the CheckBox Group control from the Controls pane. The checkbox group appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the checkbox group control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the checkbox group control you just added in the UI Model pane. 3. Configure the UI properties for the checkbox group control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click Data in the Properties pane and configure the data properties for the checkbox control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the checkbox group based on roles or data from 116 EMC Documentum Forms Builder Version 6 User Guide

117 Editing Templates other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the checkbox group using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the checkbox group using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a radio button group The radio button group control adds two or more radio buttons. Users can select only one of the radio buttons. If you want allow users to select more than one option, you must use a checkbox group control instead, as described in Adding a checkbox group, page 116. The data item for this control must have enumerated values. You can choose which of the enumerated values of a data item you want to display to users. You can also allow users to enter values. Note: If a user enters a value that is not one of the displayed values, there is no effect on the template. In particular, subsequent instances of the form do not display the new value as a choice. To add a radio button group: 1. Use one of the following methods to create the radio button group: In the UI Model pane, select the UI element or group under which you want to insert the radio button group. Select Insert > Widget > Radio Button Group. Right-click the object and select Insert > Radio Button Group. Drag and drop the Radio Button Group control from the Controls pane. The radio button group appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the radio button group control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the radio group control you just added in the UI Model pane. 3. Configure the UI properties of the radio group using the fields in the Display tab, as described in Configuring the display properties of UI objects, page 147. EMC Documentum Forms Builder Version 6 User Guide 117

118 Editing Templates 4. Click General, and then click Data & Storage in the Properties pane and configure the data properties for the radio group, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the radio group based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the radio group using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the radio group using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a list box The list box control adds a list box with one or more options. Depending on the configuration you choose, users are allowed to select only one item (which is equivalent to a radio group) or more than one item (which is equivalent to a checkbox group) from the list. The data item for this control must have enumerated values. You can choose which of the enumerated values of a data item you want to display to users. You can also allow users to enter open-ended values. Note: It has no effect on the template if a user enters a value that is not one of the displayed values. In particular, subsequent instances of the form do not display the new value as a choice. To add a list box: 1. Use one of the following methods to create the list box: In the UI Model pane, select the UI element or group under which you want to insert the list box. Select Insert > Widget > ListBox. Right-click the object and select Insert > ListBox. Drag and drop the ListBox control from the Controls pane. The list box appears on the template. Note: Click Move Up or Move Down icon on the toolbar to change the position of the list box control. 118 EMC Documentum Forms Builder Version 6 User Guide

119 Editing Templates 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the list box control you just added in the UI Model pane. 3. Configure the UI properties of the list box control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click Data & Storage in the Properties pane and configure the data properties for the list box control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the list box control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the list box using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the list box control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a drop-down list The drop-down list control adds a drop-down list. Users can select a single option from the list. It is a display variant of a radio group control. The data item for this control must have enumerated values. You can choose which of the enumerated values of a data item you want to display to users. You can also allow users to enter other values. Note: It has no effect on the template if a user enters a value that is not one of the displayed values. In particular, subsequent instances of the form do not display the new value as a choice. To add a drop-down list: 1. Use one of the following methods to add the drop-down list control: In the UI Model pane, select the UI element or group under which you want to insert the drop-down list control. Select Insert > Widget > Dropdown List. Right-click the object and select Insert > Dropdown List. Drag and drop the Dropdown List control from the Controls pane. EMC Documentum Forms Builder Version 6 User Guide 119

120 Editing Templates The drop-down list appears on the template. Note: Click Move Up or Move Down icon on the toolbar to change the position of the drop-down list control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the drop-down list control you just added in the UI Model pane on the left side of the Forms Builder window. 3. Configure the UI properties of the drop-down list control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click Data & Storage in the Properties pane and configure the data properties for the drop-down list control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the drop-down list control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the drop-down list control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the drop-down list control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a button The button control adds a single button to your form template. By default, a button group with several buttons is automatically added to the form when you create a new form template. The number and type of buttons depends on the template type. For example, if you create a form template, the Forms Builder software automatically adds a button group containing a Submit, Save, Reset, and Cancel button. If you do not want to use the default buttons, you can either delete them, or hide them. To add a button: 1. Use one of the following methods to create the button control: 120 EMC Documentum Forms Builder Version 6 User Guide

121 Editing Templates In the UI Model pane, select the UI element or group under which you want to insert the button control. Select Insert > Widget > Button. Right-click the object and select Insert > Button. Drag and drop the Button control from the Controls pane. A button appears on the template. Note: Click Move Up or Move Down icon on the toolbar to change the position of the button. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the button control you just added in the UI Model pane. 3. Configure the UI properties of the button control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the button control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the button control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the button control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a print button A print button lets users print the content of a form instance. When a user clicks the print button on a form, a separate browser window opens and displays the content of the form. The user can then choose a print option from a print dialog box inside the browser window. If the form contains tabs, only the current tab view is printed. To add a print button: 1. Add a button control to the template, as described in step 1 of the previous section. 2. Type a name and label for the print button in the Display tab, and then select Print from the Button type list box on the Special tab. EMC Documentum Forms Builder Version 6 User Guide 121

122 Editing Templates Adding an attachment The attachment control lets users attach one or more files or other repository objects to the form. The attachment control provides a link from the form instance to the repository objects selected as attachments. If files are attached from a local system, they are imported into the repository first, and then linked to the form instance. The list of attachments in the form instance can be displayed with the repository attributes that you select in the form template, and the object name contains a link that allows form users to view the attached files. To add an attachment control: 1. Use one of the following methods to add the attachment control: In the UI Model pane, select the UI element or group under which you want to insert the attachment control. Select Insert > Widget > Attachment. Right-click the object and select Insert > Attachment. Drag and drop the Attachment control from the Controls pane. The attachment control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the attachment control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the attachment control you just added in the UI Model pane. 3. Configure the UI properties of the attachment control using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Click General, and then click Data & Storage in the Properties pane and configure the data properties for the attachment control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the attachment control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the attachment control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

123 Editing Templates 7. Configure the format and style of the attachment control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a comment history The comment history control adds a comment log in the form of a text area. When a form designer creates or modifies a form in a WDK-based application, the designer can enter comments in the text area. The comments are saved with the form in read-only format, including the date and the name of the designer who entered the comment. Comments are arranged by date, displaying the most recent entry. To add a comment history control: 1. Use one of the following methods to create the comment history field: In the UI Model pane, select the UI element or group under which you want to insert the comment history field. Select Insert > Widget > Comment History. Right-click the object and select Insert > Comment History. Drag and drop the Comment History control from the Controls pane. The comment history control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the comment history control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the comment history control you just added in the UI Model pane. 3. Configure the UI properties of the comment history control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page Click General, and then click Data & Storage in the Properties pane and configure the data properties for the comment history control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the comment history control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page 141. EMC Documentum Forms Builder Version 6 User Guide 123

124 Editing Templates 6. Configure additional properties for the comment history control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the comment history control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a table The table feature adds a table group to the template. A table group contains a table and two buttons, Insert and Delete. Tables allow input of multiple values for one input control. For example, a purchase order form might ask for information about each item requested, such as item numbers, descriptions, prices, and vendors. Each item is assigned one row in the table, and data associated with the item is assigned one column. Each column in the table corresponds to a different input control. By default, the table columns are text input controls. You can change them to any other input control type. When users enter data for each item into the form, the Forms Builder software creates new rows. To add a table: 1. Use one of the following methods to create the table: In the UI Model pane, select the template root or the control under which you want to add the table. Select Insert > Widget > Table. Right-click the root or control under which you want to add the table and select Insert > Table. Drag and drop the Table control from the Controls pane into the Design pane. The table control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the table control. 2. In the Properties pane at the bottom of the template, click General,, and then click Display. If you do not see the Properties pane, double-click the table group you just added in the UI Model pane. 3. Configure the table group properties using the fields in the Display tab, as described in Configuring the display properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

125 Editing Templates 4. In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the table group based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure the properties of the table group using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the table group using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page Click the table icon in the UI Model pane, and then click General in the Properties pane, or select the repeat control in the Design pane. 8. Configure the UI properties of the table using the fields in the Display tab, as described in Configuring the display properties of UI objects, page Configure the data properties of the table using the fields in the Data & Storage tab, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the table based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the table using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page To configure the individual columns properties, click the icon for the column you want to configure in the UI Model pane. The column fields are text fields and can be configured the same way as a regular text field, as described in Adding a text field, page 107. Adding a read-only table The read-only table control adds a table to the form. The content of the read-only table is populated from an external data source. A read-only table lets users select one or more rows in a table on the form but the user cannot edit the content of the row. For example, consider a form containing a list box that shows all available domains. When you select a domain, the machine information on that domain is retrieved from an external data source. The result returned may contain the machine name, disk space available, CPU, memory capacity, and operating system. This information is then presented as a read-only table. You can select one or more rows of machine information. The values of the machine names are stored as a data item of the form. EMC Documentum Forms Builder Version 6 User Guide 125

126 Editing Templates To add a read-only table control: 1. Use one of the following methods to create the read-only table: In the UI Model pane, select the UI element or group under which you want to insert the read-only table. Select Insert > Widget > Readonly Table. Right-click the object and select Insert > Readonly Table. Drag and drop the Readonly Table control from the Controls pane. The read-only table appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the read-only table control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the read-only table control you just added in the UI Model pane. 3. Configure the UI properties of the read-only table control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page Click General, and then click Data & Storage in the Properties pane and configure the data properties for the read-only table control, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the read-only table control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the read-only table control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the read-only table using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a tab group The tab group control adds a group of tab buttons to the form. A tab group cannot be added under repeat controls. A form can have only one tab group. 126 EMC Documentum Forms Builder Version 6 User Guide

127 Editing Templates To add a tab group control: 1. Use one of the following methods to create the tab group: In the UI Model pane, select the template root. Select Insert > Widget > Tab Group. Right-click the template root and select Insert > Tab Group. Drag and drop the Tab Group control from the Controls pane. The tab group control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the tab group. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the tab group you just added in the UI Model pane. 3. Configure the UI properties of the tab group using the fields in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the tab group based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the tab group using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the tab group using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Con guring the tabs in a tab group After you have added a tab group to your template, you can configure the appearance of the individual tabs in the tab group. To con gure a tab within a tab group: 1. Select the tab you want to configure using one of the following methods: Click the tab name under the tab group in the UI Model pane Click the tab in the Design pane EMC Documentum Forms Builder Version 6 User Guide 127

128 Editing Templates 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the tab name in the UI Model pane. 3. Configure the UI properties of the tab using the fields in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the tab control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the tab control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the tab control using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a single tab to a tab group The tab feature adds a single tab to a tab group. Single tabs can only be added to an existing tab group. To add a tab to a tab group: 1. Use one of the following methods to create the tab: In the UI Model pane, select the tab group to which you want to add an additional tab. Select Insert > Widget > Tab. Right-click the tab group and select Insert > Tab. Drag and drop the Tab control from the Controls pane into the tab group in the Design pane. The new tab appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the tab control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the tab name in the UI Model pane. 3. Configure the UI properties of the tab using the fields in the Display tab, as described in Configuring the display properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

129 Editing Templates 4. In the Properties pane, click General, and then click Rules to add or modify the runtime display properties for the tab based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure additional properties for the tab using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the tab using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding a horizontal line A rule control lets users add a horizontal line to a template. Lines can be used to demarcate different parts of a template to increase the usability experience. To add a line to your template: 1. Use one of the following methods to add the horizontal line: In the UI Model pane, select the UI element or group under which you want to insert the line. Select Insert > Widget > Line. Right-click the object and select Insert > Line. Drag and drop the Line control from the Controls pane. A horizontal line appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the line. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the rule control you just added in the UI Model pane. 3. Configure the UI properties of the rule control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the rule control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure the properties of the text control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page 156. EMC Documentum Forms Builder Version 6 User Guide 129

130 Editing Templates 6. Configure the style properties of the horizontal line using the attributes in the Style tab, such as the color, and alignment, as described in Configuring the style properties of UI objects, page 168. Adding spaces around UI objects A spacer control lets users add spaces between UI objects on the template. This enhances the look and feel of the template. To add a space on your template: 1. Use one of the following methods to add the space: In the UI Model pane, select the UI element or group under (or between) which you want to insert the space. Select Insert > Widget > Spacer. Right-click the object and select Insert > Spacer. Drag and drop the Spacer control from the Controls pane. The spacer control appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the spacer control. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the spacer control you just added in the UI Model pane. 3. Configure the UI properties of the spacer control using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the spacer control based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page Configure the properties of the spacer control using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the style properties of the spacer control using the attributes in the Style tab, such as the background color, margins, and alignment, as described in Configuring the style properties of UI objects, page EMC Documentum Forms Builder Version 6 User Guide

131 Editing Templates Adding a design box The design box feature adds a design box to a template. Design boxes are useful for combining UI elements into conceptual units. For example, you might add two text fields to your form for users to enter their first name and their last name. From a design point of view, these two text fields form a conceptual unit representing the full name, and if you were to move the first name to another position on the form, you would probably move the last name too. A design box keeps these text boxes grouped together and enables you to arrange them horizontally or vertically. Design boxes can be nested, and are of the following types: Vertical, Horizontal, Table, Expandable/Collapsible, and Docking box. Table 17, page 131 describes the functions and limitations of each design box. Table 17. Design boxes and their limitations Design box Description Supported boxes Supported objects Box Horizontal Display UI objects side by side, in a relative position. Horizontal Box, Vertical Box, Table Box All UI objects At runtime, when a UI object is hidden, all objects beside it will move left one position. Vertical Box Display UI objects one below the other, in a relative position. Horizontal Box, Vertical Box, Table Box All UI objects At runtime, when a UI object is hidden, all objects below it will move up one position. EMC Documentum Forms Builder Version 6 User Guide 131

132 Editing Templates Design box Description Supported boxes Supported objects Table Box Docking Box Used to set a grid design on the template. Can contain multiple rows and columns; UI objects can be placed side by side. Display UI objects at the bottom edge of the browser window, irrespective of the height and width of the browser window; the Docking Box may also be displayed at the top of the window. Useful when a UI object or group of UI objects need to be always visible; for example, a control panel, a dashboard, action buttons, or branding items. A template can have only one Docking Box. Conditional properties cannot be set for a Docking Box. Horizontal Box, Vertical Box Horizontal Box, Vertical Box, Table Box All UI objects All UI objects To add a design box: 1. Use one of the following methods to add a design box: 132 EMC Documentum Forms Builder Version 6 User Guide

133 Editing Templates In the UI Model pane, select the UI object or group under, or within, which you want to add the design box. Select Insert > Horizontal Box or Vertical Box or Table Box or Docking Box. Right-click the template root and select Horizontal Box or Vertical Box or Table Box or Docking Box. Drag and drop a design box from the Design Boxes pane into the template. The design box appears on the template. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the design box. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the design box control you just added in the UI Model pane. 3. Configure the UI properties of the design box using the attributes in the Display tab, as described in Configuring the display properties of UI objects, page Click General, and then click Data & Storage in the Properties pane and configure the data properties for the design box, as described in Configuring the data and storage properties of UI objects, page In the Properties pane, click General, and then click Rules to add or modify the runtime UI display properties for the design box based on roles or data from other controls of the form. More information about setting conditional properties is available in Setting conditional properties, page 141. Note: You cannot configure conditional properties for the Docking Box control. 6. Configure additional properties for the design box using the attributes in the Special tab, as described in Configuring the special properties of UI objects, page Configure the format and style of the design box using the attributes in the Style tab, such as the alignment, font, and margin, as described in Configuring the style properties of UI objects, page 168. Adding Tab key navigation You can use the Tab key on your keyboard to navigate between the controls in a form instance. The tab navigation behavior depends on the tab index value or the type of form control. EMC Documentum Forms Builder Version 6 User Guide 133

134 Editing Templates If a form instance has two or more controls with the same tab index value, or the control is a composite control, such as a list box, the tab navigation path for those controls will be determined by the browser. The default tab navigation path of a browser is from left-to-right and top-to-bottom. If a form instance has controls with tab index values ranging from 0 to n, the tab navigation order will be a combination of the values set for the controls and the browser s default behavior. Any controls with a tab index value 0 will follow the browser s default behavior. For example, suppose a form has six controls with tab index values of 10, 0, 0, 30, 20, and 0. The tab navigation path will be 10, 20, 30, and the rest of the controls will follow the browser s default navigation path. If the form instance has an inner form control, the tab navigation path will be based on the tab order set for the inner and outer form controls. For example, if the outer form has three controls with tab index 1, 3, and 6, and the inner form has two controls with tab index 2 and 5, then the navigation path will be 1, 2, 3, 5, 6. If the form instance has a table control, the tab navigation order for the table control will be the same as that of the browser. For example, if the table has 3 columns and 2 rows, you can navigate between the columns in the first row from left to right, and then navigate between the columns in the second row of the table. That is, the navigation path is from left-to-right, and top-to-bottom. Note: You cannot set a tab order for a control that is within a table column; you can only set the tab order for the entire table control in the UI properties of the column. To enable Tab key navigation for form controls, you must specify the tab index value for the selected input controls in a form and its inner forms. To add a tab index value: 1. In the UI Model pane, select the UI element or group for which you want to set the tab index. You cannot set a tab index value for the following controls: Text (with or without binding) Readonly Table Task attachment control Task list control Task comment control Search result table Image 134 EMC Documentum Forms Builder Version 6 User Guide

135 Editing Templates 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the selected control in the UI Model pane. 3. Select one of the following from the Tab order section. Tab index - specifies the tab order number for an input control; the default tab index is set to 0. Initial focus - specifies if the input control will be the first active control when the form loads; the tab index for the control is automatically set to 1. Skip - specifies that the input control is not part of the tab navigation path; that is, you cannot tab into the control. Note: If you configure input controls to skip the tab order path, the controls are not skipped at runtime. That is, you can tab through the controls configured to skip the tab navigation path. This is an Internet Explorer issue. Adding a hot key You can use a hot key, which is a combination of keys used together, to directly access a button or tab control in a form instance. If a form instance has the same hot key defined for multiple button or tab controls, the WDK application will determine the order and priority of invoking the controls. A hot key can be any key combination on your keyboard, including the function keys. For example, Shift+F3, Ctrl+Shift+A, Shift+Alt+J, and so on. However, if you define a hot key that is part of the browser s reserved hot keys, the WDK application will override the user-defined hot key. That is, you cannot use any of the browser reserved hot keys as a user-defined hot key for a button or tab control. Note: You cannot use a single key as a hot key, such as C, F2, and so on. You can define hot keys for the following operating systems: Windows systems You must press the key combination on the keyboard. The Forms Builder software captures the key combination and stores it as the hot key for that control. Mac systems You must manually define the key combination for Mac systems. Note: You cannot use the same key combination for Windows and Mac systems. For example, if you use Ctrl+Alt+<n> in Windows systems, where n is any key from the keyboard, you cannot use this same key combination for Mac systems. EMC Documentum Forms Builder Version 6 User Guide 135

136 Editing Templates To de ne a hot key for a control: 1. In the UI Model pane, select the UI element or group for which you want to define the hot key. 2. In the Properties pane at the bottom of the template, click Special. If you do not see the Properties pane, double-click the selected control in the UI Model pane. 3. Set the hot key in the Hot key section. Windows - type, or press, the key combination for the control Mac - type the hot key combination for the control Localizing hot keys A template containing hot keys can be localized for systems using localization. The Forms Builder software stores the localized key combination in the.properties file. Exporting a template for localization, page 215 describes how to export a template for localization. Hiding a UI object You can hide a UI object on a form by setting the property of the UI object to Hidden at design time. If a UI object is part of another control, such as a Horizontal Box, and the parent control is set to Hidden, then at runtime the child control is not initialized to its default value. For example, consider a text control, TextBox1, that is within a horizontal box control, HorizontalBox1. The default value of TextBox1 is set to "myvalue" and HorizontalBox1 is set to Hidden state. At runtime, TextBox1 is not initialized to its default value. To hide a UI object: 1. In the UI Model pane, select the UI element or group that you want to hide. Alternatively, you can select the element or group in the Design pane. 2. In the Properties pane at the bottom of the template, click General, and then click Display. If you do not see the Properties pane, double-click the UI control in the UI Model pane. 3. Select Hidden. 136 EMC Documentum Forms Builder Version 6 User Guide

137 Editing Templates Specifying an initializer You can use an initializer to initialize a data item on the form to a specific value at runtime. Note: Before using an initializer, you must configure it using the Adaptor Configuration Manager, as described in Using initializers, page 197. To specify an initializer: 1. In the UI Model pane, select the UI element for which you want to configure an initializer. 2. On the Properties pane, click General, and then click Data & Storage. 3. Select Use initialization. A list box appears containing the list of configured initializers in the repository. Note: Global adaptors are marked with the 4. Select an initializer from the list box. icon. Specifying a validator You can use a validator to validate the form user s input for a data item on a form, or to validate the entire contents of a form before it is saved. For example, if a data item is an address, check that it contains exactly at least one dot after and a recognized domain after the final dot. Note: Before using a validator, you must configure it using the Adaptor Configuration Manager, as described in Using validators, page 198. To specify an item validator: 1. In the UI Model pane, select the UI element for which you want to configure a validator. 2. On the Properties pane, click General, and then click Data & Storage. 3. Select Use validation. A list box appears containing the list of configured validators in the repository. Note: Global adaptors are marked with the 4. Select a validator from the list box. icon. EMC Documentum Forms Builder Version 6 User Guide 137

138 Editing Templates Specifying an external data source You can obtain enumerated values and value labels at runtime from an external data source. If you specify an external data source, you lose any existing values. To specify an external data source: 1. On the Properties pane, click General, and then click Data & Storage. 2. Select Use external data source. The Data source list box appears. 3. Select the adaptor ID of the data source from the Data source list box. The Input binding and Possible value list selection sections expands below the Data source list box. 4. Configure the input binding and possible value list selections, as described in Table 18, page 139. For Populating a branch office dropdown control based on state, page 204, the input binding should look similar to the following: 138 EMC Documentum Forms Builder Version 6 User Guide

139 Editing Templates Table 18. Input binding and possible value list selection in Data & Storage tab Field Input binding Description The input fields for the SQL query. Select a data item from the list boxes. The input fields are provided while configuring the external data source. Select File > Adaptors to access the Adaptor Configuration Manager to configure or view the input fields of the data source. Output Schema Row Selection Value Display When you specify an input field, the adaptor returns only database table values associated with that input field value. Displays a graphical representation of the output schema data model. Click Output Schema to view the output schema defined for the adaptor. Select the repeating element that is the parent of the elements you select in the Value and the Display fields. If you are using the default <type> specification, the value is /data/item. Select the element that provides the data value. If you are using the default <type> specification, the value is /data/item/value. Select the element that provides the data label. If you are using the default <type> specification, the value is /data/item/label. Specifying a SetValue adaptor A SetValue adaptor is a type of data source adaptor that allows a UI object to determine the value of another UI object. This adaptor can only be used to populate an individual UI object, and runs after the value of another input control changes. The SetValue EMC Documentum Forms Builder Version 6 User Guide 139

140 Editing Templates adaptor returns a single value. The data may be retrieved from an external data source or a user-defined data source adaptor. For example, a SetValue adaptor can be used to populate an employee name field based on the employee ID value provided by the user. (More information on data source adaptors is available in Using data source adaptors, page 199.) You can specify the adaptor ID, input parameters, and output values for a SetValue adaptor. The adaptor ID can be a data source adaptor or a custom adaptor. The value of the data input control can be an xpath expression or static text. Note: User-defined data source adaptors must implement the ISetValueAdaptor interface. The Documentum Forms Builder Development Guide describes how to create custom adaptors. A SetValue adaptor can be used with the following UI controls: Text Field Number Field Date Field DateTime Field Radio Button Group CheckBox ListBox Dropdown List Note: Before using a SetValue adaptor, you must configure it using the Adaptor Configuration Manager, as described in Using data source adaptors, page 199. To specify a SetValue adaptor for a control on the form: 1. In the UI Model pane, select the UI element for which you want to configure a SetValue adaptor. 2. In the Properties pane at the bottom of the template, click Special. 3. Select Execute adaptor after the input value changes. a. From the Data source list box, select the data source. The data source listed in this box is the data source configured in the Adaptor Configuration Manager dialog box. The selected adaptor must be configured to accept an input value since the SetValue adaptor accepts a single value as input. Note: Global adaptors are marked with the icon. b. In the Input binding section, select the name of the input control from the list box. For example, if you want to populate a user name field on the form based on the value of the employee ID field, specify the employee ID field as the input 140 EMC Documentum Forms Builder Version 6 User Guide

141 Editing Templates key. The value of the input key can be either an xpath expression or text typed by the user. Using a calculation formula For all input controls, except the rich text field, you can set up a formula that calculates the value for the control. You enter the formula on the Display tab in the Properties pane. The calculation formula is an XML path language (XPath) expression. XPath is a W3C standard for identifying parts of an XML document and manipulating the resulting values. Location paths, which identify an item in the data model as in a control s Data binding field, are a special case of an XPath expression. An XPath expression can also consist of operators that transform the values of data items, such as performing numerical calculations, string manipulations, or testing Boolean conditions. Typically, a calculation formula determines the value of one control based on the value of one or more other controls on the form. For example, a form representing a purchase request might have a control for displaying the total amount of the request, with the value of this control determined by adding the values of the individual user-entered items. If the data item associated with the table cell where users enter the price of an item is /PurchaseRequest/ItemTable/itemprice, then the calculation formula for the sum is as follows: sum(/purchaserequest/itemtable/itemprice) Note: When entering a calculation formula in a table row to calculate a value based on other data items in the same row, use a relative XPath specification to identify the data items. For example, if a row contains columns for quantity, (unit) price, and total cost, refer to quantity and price by their relative paths (../quantity and../price). The Forms Builder software supports any valid XPath statement. The return value of the calculation must match the data type of the data item to which the control is bound; for example, the calculation formula for a checkbox control must return a Boolean value. When you specify a calculation formula for an input control, the result of the calculation appears as the value for that control. The forms runtime recalculates the value each time the form is opened, and the result overrides any default value specified for the control. If you find that the calculation is not performing properly at runtime, verify that the XPath expression is correct; users do not see an error when the expression is not valid. Setting conditional properties Conditional properties settings let you specify whether a UI object can be edited, is read-only, visible, or hidden, based on roles or input data on the form. A role is a type of EMC Documentum Forms Builder Version 6 User Guide 141

142 Editing Templates group containing a set of users, other groups, or both, that perform a defined set of tasks within a client application. Roles are created by the administrator of a Documentum repository. For example, an attachment control called Authorization can be made hidden and read-only for users belonging to a role called queue_admin. Note: You cannot set conditional properties for a Docking Box. To set role-based conditional properties for a UI object: 1. In the UI Model pane, click the UI object for which you want to set conditional properties. 2. In the Properties pane, click General, and then click Rules. A list of rules for this template appears. By default, all UI objects are editable and visible. 3. Click Add to add a condition. The Condition dialog box appears. Figure 30. Condition dialog box for adding conditions 4. Construct a conditional statement based on a specified role. a. From the first list box, select role. b. From the second list box, select the operator, such as is equal to or is not equal to. For example, to construct a statement that excludes a role, select is not equal to. c. From the third list box, select the role. The type of roles available in this list box depends on which roles have been configured in the repository to which Forms Builder is connected. d. To include more roles in the statement, click Add. e. If you have specified multiple roles, you can join them with or or and by selecting from the fourth list box. f. To remove a role from the statement, click the Delete button next to it. g. To make the UI object read-only for the specified roles, select Read-only. h. To hide the UI object from the specified roles, select Hidden. 142 EMC Documentum Forms Builder Version 6 User Guide

143 Editing Templates 5. Click OK to save your settings. Your new conditional statement appears in the list of rules for this template. A new condition is added to the If statement in the rules box, and the default condition moves to the Else statement. 6. To modify a condition, select it and click Modify. Revise the step as indicated in the previous step and click OK. (For the Else statement, you can change only the Read-only and Hidden settings.) 7. To remove a statement, select it and click Remove. 8. To move a statement up, select it and click Move up. 9. To move a statement down, select it and click Move down. (The Else statement does not move.) Context-aware simulation If you have set up the conditions to display a UI object as described in the previous section, then you can use the Context Aware Simulation dialog box to preview the way the form will appear to an end user belonging to a specified role. To enable context-aware simulation: 1. Click the Context Aware Simulation icon on the toolbar. The Context Aware Simulation dialog box appears. 2. From the list box provided, select the role for which you want to preview the role-based information on the form. 3. Click Simulate. The Context Aware Preview window for that role appears. For example, the Authorization field is hidden for the queue_admin role. 4. Click Close to return to the Forms Builder application. Setting form properties Template properties settings lets you mark a template for localization, or assign document adaptors to a template. Document adaptors are used to initialize a form, validate a form, or perform some routine before or after submitting a form, such as verifying the form data or updating data. The Forms Builder software has two built-in document post-processors, StartWorkflowPostProcessor and MoveOrLinkToLocationPostProcessor, EMC Documentum Forms Builder Version 6 User Guide 143

144 Editing Templates that runs after a form is submitted. More information on document processors is available in Understanding adaptors, page 189. Note: Before using the document adaptors, you must configure them using the Adaptor Configuration Manager, as described in Chapter 4, Managing Adaptors. To set template properties: 1. Open the template, as described in Opening an existing template, page Select File > Properties. The Form Template Properties dialog box appears, displaying the Basic tab. The Basic tab displays the name and description (if any) of the template. 3. In the Basic tab, do the following: a. Select Schema validation required upon form submission to validate the template schema when a form is submitted. The Forms Builder software validates the data model and data binding properties of the template. This option is selected by default. b. Select Ready for translation to mark a template for localization. More information on marking templates for localization is available in Marking a template for localization, page Click Advanced. The Advanced tab lets you define the document adaptors for a form. a. From the Initialization list box, select a document initializer. Document initializers always run immediately after a new form instance is created. b. From the Validation list box, select a document validator. A document validator runs if the form user makes any changes to the form, and before the form is saved. c. From the Pre-submission list box, select a document pre-processor adaptor. A document pre-submission adaptor is executed prior to form submission provided the validation succeeds, and the form is saved. d. From the Post-submission list box, select a document post-processor adaptor. 5. Click OK. A document post-submission adaptor runs after a form is submitted. For example, when the user clicks Submit, the form instance is linked to another cabinet in the repository. 144 EMC Documentum Forms Builder Version 6 User Guide

145 Editing Templates Changing the UI layout of a template You can change the UI layout of your template by moving UI objects within their respective group or by moving the object between different groups. You may also add or move UI objects using the drag-and-drop operation. The drag-and-drop feature has the following limitations: A tab control can be dropped inside a tab group; other UI controls cannot be dropped inside a tab group. A table control cannot be dropped inside a table column. A design box cannot be dropped inside a table column. A link or text control cannot be dropped inside a table column. A design box cannot be moved within a subtree of itself. This section contains the following topics: To move an object within its respective group:, page 145 To move an object between groups:, page 145 To copy a UI object:, page 146 To add a UI object or design box using the drag-and-drop operation:, page 146 To move a UI object or design box using the drag-and-drop operation:, page 146 To move an object within its respective group: 1. In the UI Model pane, select the UI object that you want to move up or down. 2. Use one of the following methods to move the object up or down at the same level in the tree: Select Edit > Move Up or Move Down. Right-click the object and select Move Up or Move Down. Click the Move Up or Move Down icon on the toolbar. To move an object between groups: 1. In the UI Model pane, select the UI object that you want to move. 2. Use one of the following methods to cut the object from its current location: Select Edit > Cut. Right-click the object and select Cut. Click the Cut icon on the toolbar. 3. Select the UI root or UI group in which you want to insert the object. 4. Use one of the following methods to paste the object: Select Edit > Paste. EMC Documentum Forms Builder Version 6 User Guide 145

146 Editing Templates Right-click the object and select Paste. Click the Paste icon on the toolbar. To copy a UI object: 1. In the UI Model pane, select the UI object that you want to copy. 2. Use one of the following methods to copy the object: Select Edit > Copy. Right-click the object and select Copy from the context menu. Click the Copy icon on the toolbar. 3. Select the UI root or UI group in which you want to insert the object. 4. Use one of the following methods to paste the object: Select Edit > Paste. Right-click the object and select Paste. Click the Paste icon on the toolbar. Note: Click the Move Up or Move Down icon on the toolbar to change the position of the new object. To add a UI object or design box using the drag-and-drop operation: 1. Select a UI object or design box from the Controls or Design Boxes pane. 2. Move the control to the Design pane by using the drag-and-drop operation. Depending on the location of the mouse, a red line appears as an indication of the position where the new control would be added. If the mouse is at the edge of the Design pane, the window scrolls in the appropriate direction until it reaches the edge of the Design pane. If the drop operation is invalid, the mouse cursor changes to indicate the invalid operation. To move a UI object or design box using the drag-and-drop operation: 1. Select the UI object or design box to move. A selection is shown by a yellow border around the selected control; in case of a UI control, such as text field, drop-down, and so on, a dotted line is displayed between the label and the control. 2. Position the cursor at the edge of the selected control, and click and drag the control to an appropriate location in the template. This will move the control to the new location. 146 EMC Documentum Forms Builder Version 6 User Guide

147 Editing Templates Deleting UI objects You can delete UI objects in the UI Model pane. However, deleting a UI object that is bound to a data group or data item does not delete the data object. Deleting a UI group also deletes all of the objects nested under it. To delete a UI object: 1. In the UI Model pane, select the object that you want to delete. 2. Use one of the following methods to delete the object. Select Edit > Delete. Right-click the object and select Delete. Click the Delete icon on the toolbar. Tip: If you try to delete a Save button, the Forms Builder software warns you that the button is essential for form functionality. Instead of deleting the standard buttons, hide them by selecting Hidden on the Display tab in the Properties pane. Con guring the display properties of UI objects The Display tab on the Properties pane lets users configure the display properties of UI objects. The display properties depend on the type of UI object. Table 19, page 147 describes the display properties you can define for UI objects. Table 19. UI object display properties in the Display tab Field Description Supported UI objects Error message The text that appears on the form when the data the user entered cannot be validated. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table (table group), Readonly Table, Tab Group, Tab (Tab Group), single Tab EMC Documentum Forms Builder Version 6 User Guide 147

148 Editing Templates Field Description Supported UI objects Hidden Specifies whether the control appears on the form. Select this option if you do not want the control to appear on the form. Note: If a UI control is part of another control, such as a Horizontal Box, and the parent control is set to Hidden, then at runtime the child control is not initialized to the default value set at design time. Text, Link, Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table (table group), Readonly Table, Tab Group, Tab (Tab Group), single Tab, Design Boxes (Vertical Box, Horizontal Box, Table Box) Label For example, consider a text control, TextBox1, that is within a horizontal box control, HorizontalBox1, and its default value set to "myvalue" and HorizontalBox1 set to Hidden state. At runtime, TextBox1 is not initialized to its default value. The text that appears next to the control. Leave the Label field blank if you do not want any text to appear next to the control on the form. If you do not want to display the label and the label space (that is, the space occupied by the label when you leave this field blank), clear Show label in the Styles tab. Text, Image, Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Attachment, Comment History, Table (table group), Readonly Table, Tab Group, Tab (Tab Group), single Tab, Line, Spacer, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) 148 EMC Documentum Forms Builder Version 6 User Guide

149 Editing Templates Field Description Supported UI objects Name Read-only Tab order The object name for this control. The Forms Builder software automatically enters a default name for the control. You can either accept the default name or enter a new name for the control. The name can be up to 128 characters long, must start with a letter, and cannot contain any multibyte characters or spaces. Select this option if you want the value of the control that appears on the form to be read-only, that is, users cannot change the value of the control on the form. In case of design boxes, all UI objects within the design box will be read-only objects. The tab order for this control. The tab order can be set using one of the following options: Tab index - Select this option and type a tab index value. Initial focus - Select this option if you want this text field to be the first active control when the form instance is created. Skip - Select this option if you do not want this control to be tabbed. Text, Link, Image, Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Attachment, Comment History, Table (table group, table), Readonly Table, Tab Group, Tab (in a tab group), single Tab, Line, Spacer, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table (table group), Readonly Table, Tab Group, Tab (Tab Group), single Tab, Design Boxes (Vertical Box, Horizontal Box, Table Box) Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Attachment, Comment History, Table (table group, table), Readonly Table, Tab (Tab Group) EMC Documentum Forms Builder Version 6 User Guide 149

150 Editing Templates Field Description Supported UI objects Tool tip More information on using tab order is available in Adding Tab key navigation, page 133. The text that appears on the form when users position the cursor over this control on the form. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Attachment, Comment History, Table (table group), Readonly Table, Tab Group, Tab (Tab Group), single Tab Con guring the data and storage properties of UI objects The Data & Storage tab on the Properties pane lets users configure the data and storage properties of UI objects. The data properties depend on the type of UI object. Table 20, page 150 describes the data properties you can define for UI objects. Table 20. Data properties in the Data & Storage tab Field Description Supported UI objects Data name The data object name for this control. The Forms Builder software automatically enters a default name for this control. You can either accept the default name or enter a new name for the control. The name can be up to 128 characters long, must start with a letter, and cannot contain any Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table, Readonly Table, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) 150 EMC Documentum Forms Builder Version 6 User Guide

151 Editing Templates Field Description Supported UI objects Data type multibyte characters or spaces. Select the data type for the control from the list box or accept the default type. The default data types for the UI objects are as follows: string - Text Field, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table richtext - RichText int - Number Field date - Date Field datetime - Date Time Field boolean - CheckBox attachment - Attachment Group - Table, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) If you want to change this control to a different control, select the data type from the list box. The new control appears in the Design pane. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table, Readonly Table, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) EMC Documentum Forms Builder Version 6 User Guide 151

152 Editing Templates Field Description Supported UI objects Description End date End date Hour Min. Sec. Number of possible values, or List of possible values Type a description for the data attribute of the control or leave this field blank. Select an end date for the date field, if required. If you do not need an end date, leave this field blank. Select an end date and time as hours, minutes, seconds for the date time field. If you do not need an end date or time, leave this field blank. Select this option if the control can have multiple data values. If you select this option, you must specify the minimum and maximum range of data values, as follows: Minimum - An integer equal to or greater than 0. Maximum - An integer greater than the Minimum value, or the value unbounded. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table, Readonly Table, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) Date Field Date Time Field Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table 152 EMC Documentum Forms Builder Version 6 User Guide

153 Editing Templates Field Description Supported UI objects Min Value, Max Value Pattern Start date Start date Hour Min. Sec. Type the minimum and maximum permissible values for the number field, for example, 0-9. Input mask, in the form of a regular expression; for example, [-+]?[0-9]*\?[0-9]*. The input mask specifies an exact format for the information to be entered into the control on the form. This ensures users enter data in a consistent way. Note: The regular expression must be a XML Schema level 1 regular expression. More information on the XML Schema standard is available at /WD-xmlschema /#dt-regex. Select a start date for the date field, if required. If you do not need a start date, leave this field blank. Select a start date and time as hours, minutes, seconds for the date time field. If you do not need a start date and time, leave this field blank. Number Field Text Field, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table Date Field Date Time Field EMC Documentum Forms Builder Version 6 User Guide 153

154 Editing Templates Field Description Supported UI objects Storage mapping String length This group is repeatable Specifies how the data created for this control by form instances is stored in the repository. Click Modify to configure the data storage properties for this control. You can configure data storage properties, as described in Configuring data storage properties, page 181. Specify the number of characters you can enter in this control on the form. Type the minimum and maximum string length in the Min. and Max. fields. For example, if the string length for a text field is set to 0-5, you can enter a value not more than 5 characters long in the text field on the form. Select this option if you want this control to occur more than once in your data model. Type the minimum and maximum number of times the control can occur in the Min. occurrence and Max occurrence boxes. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Readonly Table Text Field, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table Table, Design Boxes (Vertical Box, Horizontal Box, Table Box, Docking Box) 154 EMC Documentum Forms Builder Version 6 User Guide

155 Editing Templates Field Description Supported UI objects This is required Use external data source Use initialization Select this option if users are required to enter data, or select at least one value, in this control on the form. A red asterisk (*) appears next to this control to indicate that a user must enter information in the field, or select at least one value, on the form. Select this option to populate the values of this control from an external data source. Select the external data source from the Data source list box. More information about using external data sources is available in Specifying an external data source, page 138. Select this option if you want to associate this control with an adaptor that provides an initial value for the control. Specify an initializer for a UI control, as described in Specifying an initializer, page 137. Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Comment History, Readonly Table Use validation You must configure an initializer before using it, as described in Using initializers, page 197. Select this option to associate this control with an adaptor that validates the data a user enters or selects in the form. Specify a validator for a UI control, Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, EMC Documentum Forms Builder Version 6 User Guide 155

156 Editing Templates Field Description Supported UI objects as described in Specifying a validator, page 137. You must configure a validator before using it, as described in Using validators, page 198. Dropdown List, Comment History, Readonly Table Con guring the special properties of UI objects The Special tab on the Properties pane lets users configure additional properties for UI objects, such as data binding, default value, and calculation formula. The special properties depend on the type of UI object. Table 21, page 156 describes the special properties you can define for UI objects. Table 21. Additional UI properties in the Special tab Field Description Supported UI objects Alignment Allow user to write in an option Specifies the layout of the rich text frame on the form page. Select this option if you want to allow the user to enter a value for a checkbox, radio button, list box, or drop-down list. An additional checkbox or radio button with a blank field is added to the template to allow the user to type a value for the respective control. RichText CheckBox Group, Radio Button Group, ListBox, Dropdown List 156 EMC Documentum Forms Builder Version 6 User Guide

157 Editing Templates Field Description Supported UI objects Allow multi-selection Select this option if you want to allow users to select more than one item in the list. ListBox Allow multiple attachments Allow user to import from any local file If you select this option, the following two boxes appear on the Special tab, and an additional list box appears on the Design pane. Subtitle of the choices - Type a title for the list box on the left containing the values. Subtitle of the selection - Type a title for the list box on the right that will contain the selected values. Select this option if you want to allow the user to add more than one attachment. Select this option if you want to allow users to import the attachment from their local machine. To specify the repository folder into which the attachment is imported, click the button next to the [Import object to specified folder in repository] field. The Folder Location dialog box appears. Select the repository folder from the folder structure tree. Attachment Attachment EMC Documentum Forms Builder Version 6 User Guide 157

158 Editing Templates Field Description Supported UI objects Allow user to choose from repository generated by Select this option if you want to allow the user to choose an attachment from the repository. You can specify which folders the user can browse by using one of the following options: Folder navigation - To specify a starting folder, click the button next to the Start from location. The Folder Location dialog box appears. Select the starting folder from the folder structure tree. You can also specify one or more file formats that are displayed when the user browses the folders by typing the file format in the Narrow by format field. Restricting selection to flat list generated by DQL query - Lets you use a DQL query to generate a list of files that the user can choose from. The DQL query displays all dm_sysobject object and its subtypes. You can add restrictions to the query by entering the restriction in the Select * from dm_sysobject where field. Click Validate to validate the restriction. Attachment 158 EMC Documentum Forms Builder Version 6 User Guide

159 Editing Templates Field Description Supported UI objects Attribute to display The attribute of the attachment s object type that is displayed on the form. By default, the object_name attribute is displayed. To change the object type or attribute: 1. Click the button next to the Object type field. The Select Object Type and Attributes dialog box appears. 2. Select one or more attributes from the Attribute list box. If you selected more than one attribute, you can specify the order in which the attributes are displayed using the Up or Down button. Note: You can only select more than one attribute if you previously select the Allow multiple attachments option. Attachment EMC Documentum Forms Builder Version 6 User Guide 159

160 Editing Templates Field Description Supported UI objects Autofit Configures the size of the comment history area or read-only table. Comment History, Readonly Table Border Calculation formula Checked value Columns Data binding The form size expands depending on the number of comments for the comment history, or the number of rows and columns in the read-only table. Specifies whether there is a border around the text (yes, no). Type a formula if you want to display a calculated value in this control on the form. More information about calculation formulae is available in Using a calculation formula, page 141. Leave the field blank if the value for this field is not calculated. Specifies the value if the checkbox is selected. Type the number of columns for the Table Box. Contains the full path to the data item that is associated with this control. The Forms Builder software automatically enters the value you specified previously in the Data name field on the Data & Storage tab. You can select a different data binding from the list box if other data binding objects are available. RichText Text, Text Field, Number Field, Date Field, Date Time Field CheckBox Table Box Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Comment History, Table (group), Table, Raedonly Table, Design Boxes (Vertical Box, Horizontal Box, Docking Box) 160 EMC Documentum Forms Builder Version 6 User Guide

161 Editing Templates Field Description Supported UI objects Default state Default tab Default value Execute adaptor after input value changes File source Specifies a default setting for the checkbox on the form. By default, the checkbox is selected. Specifies which tab is selected by default. To change the default tab, select a different tab from the list box. A check mark next to the tab group in the UI Model pane indicates the default tab. Specifies a default value for this control on the form. You can leave this field blank, if you do not want to assign a default value. Triggers an adaptor if the value of a dependent control on the form changes. More information on data source adaptors is available in Using data source adaptors, page 199, and SetValue adaptors in Specifying a SetValue adaptor, page 139. Specifies the location and name of the image file. You can import the image file from the local file system or the repository. Click Browse. The Import File dialog box appears. Local hard drive / network - Navigate to the image folder in your local file system or network, and select the image file. The image CheckBox Tab Group Text, Text Field, Number Field, Date Field, Date Time Field Text, Text Field, RichText, Number Field, Date Field, Date Time Field, CheckBox, Radio Button Group, ListBox, Dropdown List, Comment History Image EMC Documentum Forms Builder Version 6 User Guide 161

162 Editing Templates Field Description Supported UI objects Formatting options Height Hot key file will first be copied to a predefined location in the repository, and then linked to the form Documentum repository - Navigate to the image files location in the repository and select the image file. This will create a link to the image file; that is, the image is imported as a reference object Specifies the formatting options available for this control. By default, all formatting options are selected and therefore available for the end user. The height of the image as pixels or percent of the original size, or the height in pixels of the rich text frame, readonly table, comment history window, horizontal line, or spacer control. The hot key you assign for the tab control. More information on defining hot keys is available in Adding a hot key, page 135. RichText Image, RichText, Readonly Table, Comment History, Line, Spacer Tab 162 EMC Documentum Forms Builder Version 6 User Guide

163 Editing Templates Field Description Supported UI objects Image dimensions Input height Input width Label and data bound text display Specifies whether the image will be resized using pixels or percent of the original size. Select Pixels to enter the Width and Height as pixel values. Select Percent to enter the Width and Height as a percent of the original image size. Select Preserve aspect ratio to constrain the new image dimensions to the image s current proportions. The aspect (width-to-height) ratio defaults to the ratio of the active image. Changing the aspect ratio distorts the image by stretching or contracting it in one dimension more than the other. The height of the text field in pixels (px). The width of the text field in pixels (px). Specifies whether a data item is assigned to this control. If you select this option, the Data binding field is enabled. Select a data item from the Data binding list box to bind the control. For text control, the Default value and Calculation formula fields, and the Execute adaptor after the input Image Text Field Text Field Text, Link EMC Documentum Forms Builder Version 6 User Guide 163

164 Editing Templates Field Description Supported UI objects value changes checkbox are enabled after you select a data item. For the link control, if you want to assign a URI that is already stored for a data item, select a data item from the Data binding list box. The value of this data item appears on the form and is displayed in the Default value field in the Special tab. Layout Link text Note: If you do not see the data item in the list box, ensure that the data type for that data item is set to anyuri. The layout options for this table. Select your layout from the following options: Horizontal, no header Horizontal, with header Vertical display Specifies the text that appears for this link on the form. This field is only displayed when the Text display option is selected. Type the text that would appear on the form for this link. Table Link 164 EMC Documentum Forms Builder Version 6 User Guide

165 Editing Templates Field Description Supported UI objects Link to Specifies the URL to which the link points. This field is only displayed when the Text display option is selected. Link Multi-line Multiple row select Object type Type the URL; the URL must have the format The default value is com/document.htm. Select this option if you want this field to be a multiline input field. Allows the end user to select more than one row in the table. A checkbox appears at the beginning of each row; by default, a radio button appears. The object type of the attachment. By default, the Forms Builder software assigns the dm_sysobject object type and the object_name attribute. To change the object type or attribute: 1. Click the button next to the Object type field. The Select Object Type and Attributes dialog box appears. 2. Select an object type from the Object type list box. 3. Select one or more attributes from the Attribute list box. Text Field Readonly Table Attachment EMC Documentum Forms Builder Version 6 User Guide 165

166 Editing Templates Field Description Supported UI objects Note: You can only select more than one attribute if you previously select the Allow multiple attachments option. Possible values Specify the values for this control. The value/display table lets you do the following: Add - Add a value to the checkbox group, radio button group, listbox, or drop-down list. Modify - Modify a value of the respective control. To modify a value, select the row associated with the control in the value/display table, and then click Modify. Remove - Remove a value from the list of values for the respective control. To remove a value, select the row associated with the control in the value/display table, and then click Remove. When you click the Add or Modify button, the Add Choice or Modify Choice dialog box appears: In the Value box, type a value. This value will be stored when you select the checkbox, radio button, or a value CheckBox Group, Radio Button Group, ListBox, Dropdown List 166 EMC Documentum Forms Builder Version 6 User Guide

167 Editing Templates Field Description Supported UI objects Revert to original size Rows Scrolling Tab placement Text display from the list box or drop-down list. In the Display box, type a label. Select Default value if you want the value for the control on the form to be selected by default. Click this button to restore the original image size after changing the image dimensions. Type the number of rows for the Table Box. Specifies whether the horizontal and vertical scroll bars appear when text exceeds the size of the input box. Specifies whether the tabs in the tab group appear on the top of the bottom of the tab group. By default, the tabs appear on the top. Specifies whether the control is displayed without any data binding. Select this option if you want to display the text you entered in the Label field on the Display tab. Image Design Box (Table Box) RichText Tab Group Text, Link Unchecked value If you select this option for link control, the Link text and Link to fields appears. Specifies the value if the checkbox is cleared. CheckBox EMC Documentum Forms Builder Version 6 User Guide 167

168 Editing Templates Field Description Supported UI objects Use adaptor Select an adaptor from the list box, and provide the input parameters. You can also modify the output data of the adaptor. To modify the output data, select a row in the value/display table and click Modify. Readonly Table Width More information on adaptors is available in Chapter 4, Managing Adaptors. The width of the image as pixels or percent of the original size, or the width in pixels of the rich text frame, readonly table, comment history window, horizontal line, or spacer control. Image, RichText, Readonly Table, Comment History, Line, Spacer Con guring the style properties of UI objects The Style tab on the Properties pane lets users configure the style level properties of UI objects. The style properties depend on the type of UI object. Table 22, page 168 describes the style properties you can define for UI objects. Table 22. Style properties in the Style tab Field Description Supported UI objects Background color The background color for this control. You can provide a color value, such as #FFFFFF (white), or click to open the Choose color dialog box. Select a color from the one of the tabs. Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab, Tab Group, Attachment, Table, 168 EMC Documentum Forms Builder Version 6 User Guide

169 Editing Templates Field Description Supported UI objects Border color Border style Swatches - A set of basic colors. HSB - A percentage of the Hue (H), Saturation (S), and Brightness (B) of the color. RGB - The Red (R), Green (G), and Blue (B) color combination. For example, if you want to select the white color, adjust the RGB level to Red=255, Green=255, Blue=255. The border color for this control. You must select a border style to see the effects of the border color you select. Select the border color, as described in Background color. Select the style of the control s border from the list box. The available border styles are as follows: none - No border, that is, the border width is equal to 0. solid - The border is a single line segment. dotted - The border is a series of dots. dashed - The border is a series of short line segments. double - The border is two solid lines. The sum of the two lines Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab, Tab Group, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab, Table, Attachment, Tab Group, Readonly Table, Comment History EMC Documentum Forms Builder Version 6 User Guide 169

170 Editing Templates Field Description Supported UI objects Border width Horizontal align Margin and the space between them equals the value of Border width. The width of the border in pixels. If you specify a value in this field, the Border style is automatically set to solid. The horizontal alignment of the control on the form. Possible values are Left, Center, and Right. Specify the width of the margin area for this control. The Margin property sets the margin for all four sides while the other margin properties only set their respective side. You must provide a positive value for the margin property. Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Tab Group, Attachment, Tab Group, Table, Readonly Table, Comment History, Line, Spacer Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History 170 EMC Documentum Forms Builder Version 6 User Guide

171 Editing Templates Field Description Supported UI objects Margin bottom Margin left Margin right Margin top Specify the bottom margin width for this control. You must provide a positive value for this property. Specify the left margin width for this control. You must provide a positive value for this property. Specify the right margin width for this control. You must provide a positive value for this property. Specify the top margin width for this control. You must provide a positive value for this property. Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Button, Tab Group, Tab, Attachment, Table, Readonly Table, Comment History EMC Documentum Forms Builder Version 6 User Guide 171

172 Editing Templates Field Description Supported UI objects Vertical align Text styles, Link text styles, Label styles, Spacer styles, Rule styles Background color The vertical alignment of the control on the form. Possible values are Top, Center, and Bottom. The background color for this control. Button Spacer, Line Bold You can provide a color value, such as #FFFFFF (white), or click to open the Choose color dialog box. Select a color from the one of the tabs. Swatches - A set of basic colors. HSB - A percentage of the Hue (H), Saturation (S), and Brightness (B) of the color. RGB - The Red (R), Green (G), and Blue (B) color combination. For example, if you want to select the white color, adjust the RGB level to Red=255, Green=255, Blue=255. Makes the text or label bold. You may also use the toolbar to do this task. Text, Link, Text Field, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History 172 EMC Documentum Forms Builder Version 6 User Guide

173 Editing Templates Field Description Supported UI objects Border color The border color for this control. You must select a border style to see the effects of the border color you select. Spacer, Line Border style Border width Select the border color, as described in Background color. Select the style of the control s border from the list box provided. The available border styles are as follows: none - No border, that is, the border width is equal to 0. solid - The border is a single line segment. dotted - The border is a series of dots. dashed - The border is a series of short line segments. double - The border is two solid lines. The sum of the two lines and the space between them equals the value of Border width. The width of the border in pixels. If you specify a value in this field, the Border style is automatically set to solid. Spacer, Line Spacer, Line EMC Documentum Forms Builder Version 6 User Guide 173

174 Editing Templates Field Description Supported UI objects Font Font color Font size Horizontal align Select the font for the text or label. The font change does not appear in the Design pane; however, it appears in the Preview pane. You may also use the toolbar to do this task. Select the font color for the text or label, as described in Background color. You may also use the toolbar to do this task. Select the font size for the text or label. You may also use the toolbar to do this task. The alignment of the text or label, such as Left, Center, or Right. You may also use the toolbar to do this task. Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History 174 EMC Documentum Forms Builder Version 6 User Guide

175 Editing Templates Field Description Supported UI objects Italic Label orientation Show label Underline Width Italicizes the text or label. You may also use the toolbar to do this task. The position of the label text. Select one of the label positions: Left - positions the label text to the left of the control. Top - positions the label text at the top of the control. Right - positions the label text at the right of the control. This position is available only for the checkbox control. Determines whether the label text for a control is displayed on the form. Clear this checkbox if you do not want the label text for this control to appear on the form. Underlines the text or label. You may also use the toolbar to do this task. The width of the text or label box. Text, Link, Text Field, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text Field, Image, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Attachment, Table, Readonly Table, Comment History, Button group Text, Link, Text Field, Number Field, RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Table, Readonly Table, Comment History Text, Link, Text Field, Image, Number Field, EMC Documentum Forms Builder Version 6 User Guide 175

176 Editing Templates Field Description Supported UI objects For image, text field, number field, rich text, date field: this property appears only when the Left label orientation is selected. RichText, Date, Date Time Field, CheckBox, CheckBox Group, Radio Button Group, ListBox, Dropdown List, Attachment, Readonly Table, Comment History Adding and modifying data objects Every UI object that requires users to input data on the form must be bound to an associated data item that stores the user s input in the database. There are two types of data objects: data groups and data items. Data groups have no effect on the UI model; they simply group individual data items into categories. You can choose to have data objects created at the same time you create the UI input controls, or you can create a data object first and bind the input controls to these data objects later. This section contains the following topics: Adding a data group, page 176 Adding a data item, page 177 Moving data objects, page 180 Deleting data objects, page 181 Adding a data group You can group data items into categories. For example, you might want to group first name, last name, Social Security number, and birth date into a group called Personal Information. Creating a data group has no effect on the UI model. When you create a data group, you must specify whether the data group is repeatable, in other words whether this data group can occur more than once in your data model. To add a data group: 1. In the Data Model pane, select the root or the data item under which you want to add the group. 2. Use one of the following methods to create the group: Select Insert > Data Group. 176 EMC Documentum Forms Builder Version 6 User Guide

177 Editing Templates Right-click the root or data item under which you want to add the data group and select Data Group. Click the Data Group icon on the toolbar of the Data Model pane. The new data group object is created in the Data Model pane, and the properties are displayed in the Properties pane. If you do not see the Properties pane, double-click the data group object you just added in the Data Model pane. 3. In the Properties pane, click General, and then click Data & Storage to configure the data group properties, as described in Table 23, page 177. Table 23. Data group properties in the Data & Storage tab Field Data name Description Data type This group is repeatable Description The data object name for this data group. The Forms Builder software automatically enters a default name for the group. You can either accept the default name or enter a new name for the group. The name can be up to 128 characters long, must start with a letter, and cannot contain any multibyte characters or spaces. Type a description for the group or leave this field blank. The data type for the group (Group). You cannot change the data type of a data group. Select this option if you want the group to occur more than once in your data model. Type the minimum and maximum number of times the group can occur in the Min. occurrence and Max. occurrence boxes. Adding a data item After you create a data group, you can add data items to the data group. EMC Documentum Forms Builder Version 6 User Guide 177

178 Editing Templates To add a data item: 1. In the Data Model pane, select the root or the data group to which you want to add the data item. 2. Use one of the following methods to create the data item: Select Insert > Data Item. Right-click the root or data group to which you want to add the data item and select Data Item. Click the Data Item icon on the toolbar of the Data Model pane. The new data item object is created in the Data Model pane, and the properties are displayed in the Properties pane. If you do not see the Properties pane, double-click the data item object you just added in the Data Model pane. 3. In the Properties pane, click General, and then click Data & Storage to configure the properties of the data item, as described in Table 24, page 178. Table 24. Data item properties in the Data & Storage tab Field Data name Description Data type Storage mapping Description The object name for this data item. The Forms Builder software automatically enters a default name for the object name. You can either accept the default name or enter a new name for the data item. The name can be up to 128 characters long, must start with a letter, and cannot contain any multibyte characters or spaces. Type a description for the data item or leave this field blank. Select the data type for the data item from the list box or accept the default type (string). Specifies how the data created for this control by form instances is stored in the repository. Click Modify to configure the data storage properties for this object. More information on configuring data storage properties is available in Configuring data storage properties, page EMC Documentum Forms Builder Version 6 User Guide

179 Editing Templates Field This is required Number of possible values Use external data source Use initialization Use validation Description Select this option if users are required to enter data for the data item on the form. Select this option if the data item should store multiple values. Do not select this option if you are binding the data item to a table column because there should be only one data entry per cell. If you select this option, you must specify the minimum and maximum number of data values in the Minimum and Maximum fields, as follows: Minimum - An integer greater than or equal to 0. Maximum - An integer greater than the Minimum value, or the value unbounded. Select this option to populate the values for the data item from an external data source. Select the external data source from the Data source list box. More information about external data sources is available in Specifying an external data source, page 138. Select this option if you want to associate the data item with an adaptor that provides an initial value for the field, and then select an initialization adaptor from the list box. Select this option to associate the data item with an adaptor that validates the data a user enters in the form, and then select the validation adaptor from the list box. EMC Documentum Forms Builder Version 6 User Guide 179

180 Editing Templates Field String length Pattern Description Type the minimum and maximum string lengths in the Min. and Max. boxes. Input mask, in the form of a regular expression. The regular expression must be a XML Schema level 1 regular expression. More information on the XML Schema standard is available at Moving data objects You can move a data item or group up or down within its data group by using the Move Up and Move Down commands, or by cutting and pasting. You can move a data item or data group within or between data groups by cutting and pasting. Moving a data item or data group in the Data Model pane does not affect the UI layout of your template. To move a data object: 1. In the Data Model pane, select the data item or data group that you want to move up or down. 2. Use one of the following methods to move the object up or down at the same level in the tree: Select Edit > Move Up or Move Down. Right-click the object and select Move Up or Move Down. Click the Move Up or Move Down icon on the toolbar. To move a data object using cut and paste: 1. In the Data Model pane, select the data item or data group that you want to move. 2. Use one of the following methods to cut the object from its current location: Select Edit > Cut. Right-click the object and select Cut. Click the Cut icon on the toolbar. 3. Select the data model root or data group in which you want to insert the object. 4. Use one of the following methods to paste the object: Select Edit > Paste. 180 EMC Documentum Forms Builder Version 6 User Guide

181 Editing Templates Right-click the object and select Paste. Click the Paste icon on the toolbar. Deleting data objects You can delete data objects in the Data Model pane. The following rules apply when deleting a data object: Deleting a data group also deletes all of its nested objects. Deleting a bound data group or data item sets the data binding for the associated UI control to None, possibly causing template validation to fail. Deleting a data object in a template that shares its data model with another template can cause the other template to fail validation. To delete a data object: 1. In the Data Model pane, select the data object that you want to delete. 2. Use one of the following methods to delete the object: Select Edit > Delete. Right-click the object and select Delete. Click the Delete icon on the toolbar. Con guring data storage properties When you create a template, you must specify how the data created by form instances of that template is stored in the repository. The data values can be stored using one of the following formats: XML content By default, all data values for a form instance are stored in the repository as an XML file of the dm_xfm_instance type. When the form is used in conjunction with a workflow package, the XML file becomes the content file for the package. EMC Documentum Forms Builder Version 6 User Guide 181

182 Editing Templates XML content with repository attributes Saving data as an XML content with repository attributes means that data values are stored in the repository both as an XML file and selected fields as attribute information associated with the object type. This makes the data available to other applications and to workflows that use attribute information in routing decisions. For example, the next activity in a workflow may differ depending on the value of an attribute. Repository attributes Saving data as repository attributes means that no XML file is created, but the selected object type determines the repository attributes of the object. This makes the data available to other processes that work with attribute values, such as workflow transition conditions. This section contains the following topics: Opening the View All Storage Mappings dialog box, page 182 Storing data as an XML file, page 183 Storing data as an XML file with repository attributes, page 183 Storing data values in repository attributes, page 184 Creating a new storage object type, page 184 Managing object attributes, page 185 Configuring storage mapping rules, page 186 Opening the View All Storage Mappings dialog box The View All Storage Mappings dialog box lets users define the way form instance data will be stored in the repository. It is also used to configure the storage mapping rules when data is stored as XML content with repository attributes. To open the View All Storage Mappings dialog box: 1. In the UI Model pane or Data Model pane, select the UI object or data object. 2. Open the View All Storage Mappings dialog box in one of the following ways: Select View > Storage. Click the Edit Data Storage icon on the toolbar. On the Properties pane, click General, and then click Data & Storage. Click Modify next to the Storage mapping field. The View All Storage Mappings dialog box appears. 182 EMC Documentum Forms Builder Version 6 User Guide

183 Editing Templates Storing data as an XML le By default, all data values for a form instance are stored in an XML file which is saved as an instance of the dm_xfm_instance object type. You can change the object type that is stored using the View All Storage Mappings dialog box. To change the object type that is used to store the XML le: 1. Open the View All Storage Mappings dialog box, as described in Opening the View All Storage Mappings dialog box, page Select Store as XML content. 3. Select a new object type from the Object type list box. 4. Click OK. The object type changes for every data item in the data model. Storing data as an XML le with repository attributes Storing data as an XML file with repository attributes makes the data available to other applications and for routing options, for example, in workflows. To store data as an XML le with repository attributes: 1. Open the View All Storage Mappings dialog box, as described in Opening the View All Storage Mappings dialog box, page Select Store as XML content with repository attributes. 3. Select an object type from the Object type list box. You can also create a new object type, as described in Creating a new storage object type, page 184. If you have superuser privileges, a Delete Type button appears on the View All Storage Mapping dialog box. 4. For each data item, select an attribute from the associated Attribute list box. You can add, rename, or remove attributes, as described in Managing object attributes, page Configure the storage mapping rules, as described in Configuring storage mapping rules, page Click OK. EMC Documentum Forms Builder Version 6 User Guide 183

184 Editing Templates Storing data values in repository attributes You can make a template s data model correspond to the attributes of a custom repository object type. Saving the data in attribute values makes it available to other processes that work with attribute values, such as workflow transition conditions. Note: You cannot map form data from a rich text field into a repository attribute. To store data values in repository attributes: 1. Open the View All Storage Mappings dialog box, as described in Opening the View All Storage Mappings dialog box, page Select Store in repository attributes. 3. Select an object type from the Object type list box. You can also create a new object type, as described in Creating a new storage object type, page 184. If you have superuser privileges, a Delete Type button appears on the View All Storage Mappings dialog box. 4. For each data item, select an attribute from the associated Attribute list box. You can add, rename, or remove attributes, as described in Managing object attributes, page Click OK. Creating a new storage object type An object type determines how form data would be stored in the repository. You can use the default objects available in the repository, or create a new object type to store form data. Every object contains attributes. Therefore, if you want to extend the attributes of an existing object, you must create a new object. Note: You must have superuser privileges to create or delete object types. To create a new object type: 1. Click New Type. The Create New Type dialog box appears. 2. In the New type name box, type an object type name. 3. In the New type label box, type a label for the new object type. 4. From the Super type list box, select a parent object type for the object you are creating. 5. Click OK. 184 EMC Documentum Forms Builder Version 6 User Guide

185 Editing Templates You can now create the attributes for the new object, as described in Managing object attributes, page To delete an object type that you created, select the object type from the Object type list box, and then click. To delete a custom object type: 1. From the Object type list box, select the user-defined object type to delete. Note: You cannot delete the built-in object types. 2. Click Delete Type. The Delete Type button appears only if you have superuser privileges. The Delete Type dialog box appears. 3. Click OK to delete the selected object. Managing object attributes Attributes define the characteristics of an object or data item. For each data item in a form, you can select an attribute from the View All Storage Mappings dialog box. You can also define the attributes of an object you create. You can manage attributes in one of the following ways: Create a new attribute Rename an attribute Delete an attribute To create a new attribute: 1. Click New Attribute. The Create New Attribute dialog box appears, displaying the object type and data type of the data item. 2. In the New attribute box, type a name for the new attribute. 3. In the Length box, type a length for a string data type attribute. The default string length is 32 characters. Note: The Length field is enabled only for data items of string data type. 4. Select Repeating to make this attribute a repeating attribute. 5. Click OK. The new attribute is listed in the Attribute list box. EMC Documentum Forms Builder Version 6 User Guide 185

186 Editing Templates To rename an attribute: 1. Select a data item from the list box. 2. Select the attribute from the Attribute list box. 3. Click Rename Attribute. The Rename Attribute dialog box appears. The selected attribute, object type, data type, length, and repeating properties of the attribute are displayed in this dialog box. These values cannot be changed. 4. In the New attribute name box, type a new name for the selected attribute. 5. Click OK. To remove an attribute: 1. Select a data item from the list box. 2. Select the attribute from the Attribute list box. 3. Click Delete Attribute. The Delete Attribute dialog box appears, displaying the information related to the selected attribute. 4. Click OK to delete the selected attribute. Con guring storage mapping rules When you choose to map form data to one or more repository attributes, the Forms Builder software creates an XML application to copy the form data into the attributes. The XML application has the same name as the template and is applied at runtime when a designer creates form instances based on the template. The XML application applies only to form instances created from this template. If you want to use the XML form data to specify other aspects of how the data file is stored in the repository, you can configure the XML application to process the form data files as they are imported into the repository. With an XML application, you can specify how to store the data in the repository. More information about XML applications is available in the Documentum XML Applications Development Guide, which is supplied as part of the Documentum Foundation Classes (DFC) documentation set. Note: The XML Configuration File Editor does not work synchronously with the Forms Builder software. Any changes you make in the XML Configuration File Editor are saved to the repository in an XML application configuration file. 186 EMC Documentum Forms Builder Version 6 User Guide

187 Editing Templates To open the XML con guration le editor: 1. After you have completed the steps mentioned in Storing data as an XML file with repository attributes, page 183, do the following to configure the storage mapping rules. 2. Select Advanced. 3. Click XML Application Editor. The XML Configuration File Editor dialog box appears. 4. Click General Settings and set global application settings. 5. Create rules for the XML content for handling any linked files or base-64-encoded data. 6. Save the XML configuration file. EMC Documentum Forms Builder Version 6 User Guide 187

188 Editing Templates 188 EMC Documentum Forms Builder Version 6 User Guide

189 Chapter 4 Managing Adaptors This chapter describes how to manage adaptors and associate them with a template. This chapter contains the following topics: Understanding adaptors, page 189 Understanding the Adaptor Configuration Manager, page 194 Using initializers, page 197 Using validators, page 198 Using data source adaptors, page 199 Using document processors, page 207 Creating a complex output type, page 209 Removing an adaptor configuration, page 209 Assigning adaptors to a template, page 210 Understanding adaptors An adaptor is a piece of business logic that consists of a Java class, service-based business object (SBO), or a JDBC connector class, and can be associated with a template. Adaptors define processing instructions for form instances and are executed during runtime, when a user interacts with the form. There are two adaptor categories, global adaptors and template adaptors. Global adaptors can be used for more than one template, while template adaptors only apply to one specific template. All global adaptors are stored in the /System/Forms/Adaptors folder in the repository. Template adaptors are stored with the associated template in the /System/Forms/<template-name>/Adaptors folder, where <template-name> is the name of the template folder. Adaptors can be assigned to individual controls or to an entire template. By default, the Forms Builder software comes with a series of built-in adaptors that are automatically installed in the repository. There are four adaptor types: data source, EMC Documentum Forms Builder Version 6 User Guide 189

190 Managing Adaptors initializer, validator, and document processor. Besides the built-in adaptors, you can also develop and use custom adaptors. These custom adaptors must be deployed in the repository before you can apply them to a template. Documentum Forms Builder Development Guide contains more information about developing custom adaptors. Table 25, page 190 describes the built-in adaptors. For each adaptor, the table lists the deployment method (Java class or SBO), and the name of the implementation class or the name of the SBO. The fully qualified name of each adaptor begins with the package name com.documentum.xforms.engine.adaptor. Table 25. Built-in adaptors Adaptor type Function Deployment Class name Data source Data source Populates a set of values, as key/value pair, from a properties file. Input parameter location - the location of the properties file. Output schema data/item/key data/item/value Populates a set of values by establishing a JDBC connection with an external data source, and running a SQL statement against the connected database. A properties file, containing the login credentials for the database, must be present in the classpath. The password is encrypted using Java class JDBC connector class datasource.prop. PropertiesData- SourceAdaptor datasource. jdbc.jdbcdatasourceadaptor 190 EMC Documentum Forms Builder Version 6 User Guide

191 Managing Adaptors Adaptor type Function Deployment Class name DFC encryption mechanism. The data source first searches for the jdbc_<adaptor_id>. properties file, and then searches for the jdbc.properties file. Input parameter sql - the SQL query to be executed against the connected database. Output schema free formed. The columns must match the output schema leave nodes. Data source Accesses the repository the user is connected to, and retrieves data based on a DQL query. SBO datasource. docbase.idocbase- DataSourceAdaptorService Input parameter dql - the DQL query to be executed against the connected repository. Output schema free formed. The columns must match the output EMC Documentum Forms Builder Version 6 User Guide 191

192 Managing Adaptors Adaptor type Function Deployment Class name Initializer Validator Document processor schema leave nodes. Initializes a date or datetime data item and sets it to the current date or time. Validates whether the value of a data item matches the value of the first column of the query result. Input parameter dql - the DQL query to be executed against the connected repository. Starts a workflow with the completed form as the initial package. Input parameter workflowtemplatename - the name of the workflow template. Java class Java class Java class initializer.current- DateTimeInitializer validator.queryresultvalidator workflowtemplatelocation - the location of the workflow template. This is required if you specify the work- processor.start- WorkflowPostProcessor 192 EMC Documentum Forms Builder Version 6 User Guide

193 Managing Adaptors Adaptor type Function Deployment Class name flowtemplatename. If you do not specify the workflowtemplateid, then you must specify both the workflowtemplatename and workflowtemplatelocation. workflowtemplateid - the workflow ID. If this is specified, then workflowtemplatename and workflowtemplatelocation are ignored. workflow- Package- Name (optional) - the name of the package that is being attached to the form instance. If this is not specified, the document processor searches for all visible packages EMC Documentum Forms Builder Version 6 User Guide 193

194 Managing Adaptors Adaptor type Function Deployment Class name Document processor whose object type and version label matches with the form instance. Moves or links a form instance to a location in the repository. Input parameter location - the target location where the form instance shall be moved or linked. It must be a valid repository path. moveor- Link - the permissible values are move or link. Java class processor.move- OrLinkToLocation- PostProcessor Understanding the Adaptor Con guration Manager The Adaptor Configuration Manager lets designers manage and configure instances of an adaptor. Adaptors are configured for a specific template (template adaptors) or for all templates in the repository (global adaptors). To open the Adaptor Configuration Manager, select File > Adaptors. The Adaptor Configuration Manager dialog box appears. 194 EMC Documentum Forms Builder Version 6 User Guide

195 Managing Adaptors Figure 31. Adaptor Con guration Manager Note: By default, the Global Adaptors tab is displayed in this dialog box. The Template Adaptors tab is displayed if a template is open. The Adaptor Configuration Manager dialog box lets you create and manage instances of an adaptor and assign them to a template. Table 26. Adaptor Con guration Manager properties Properties Installed adaptors Description The list of adaptors that are currently installed in the repository. The Global Adaptors tab displays the adaptors that apply to all templates; the Template Adaptors tab displays the adaptors that apply only to the template that is currently open. EMC Documentum Forms Builder Version 6 User Guide 195

196 Managing Adaptors Properties Adaptor type Name Description Class name Type Initial parameter Description The type of adaptor. The adaptor type can have one of the following values: Data Source Initializer Validator Document Validator Document Processor A detailed description of the different adaptor types is given in Table 25, page 190. A string that specifies the name of the adaptor configuration. A global adaptor name must be unique. A string that describes the adaptor. The class name of the adaptor. If the adaptor is a Java class, the name must be the fully qualified name of the Java class. If the adaptor is an SBO, the name must be the fully qualified name of the SBO. All built-in adaptor names start with the package name com. documentum.xforms.engine.adaptor. The implementation type of the adaptor. The implementation type can have one of the following values: Class - The adaptor is implemented as a Java class. SBO - The adaptor is implemented as a service-based business object (SBO). A name/value pair that is passed to the adaptor. 196 EMC Documentum Forms Builder Version 6 User Guide

197 Managing Adaptors Properties Input Output type Description The input type for the adaptor. The input type can be a string, an integer, or a boolean value. The input type only applies to data source adaptors. The output type of the adaptor. The output type can be a schema, a simple type, or a custom complex type. The output type only applies to data source adaptors. Opening the Adaptor Con guration Manager dialog box The Adaptor Configuration Manager dialog box lets users configure adaptors that will be stored in the repository. To open the Adaptor Con guration Manager dialog box: 1. Select File > Adaptors. The Adaptor Configuration Manager dialog box appears. 2. Click one of the following: Global Adaptors if you want to configure a global initializer that can be applied to any template in the repository. Template Adaptors if you want to apply the initializer to a specific template. Note: The Template Adaptors tab appears only if a template is open. 3. To add an adaptor configuration, click Add next to the Installed adaptors list box. 4. To delete an adaptor configuration, click Remove next to the Installed adaptors list box. 5. To copy an adaptor configuration, select an adaptor from the Installed adaptors list box, and then click Duplicate. Using initializers The Forms Builder software currently provides one built-in initializer, the CurrentDateTimeInitializer adaptor. It is part of the com.documentum.xforms.engine. EMC Documentum Forms Builder Version 6 User Guide 197

198 Managing Adaptors adaptor.initializer package. It determines the current date and time, and returns the date or time to serve as the initial value for a date or datetime item on a form instance. Note: You can create a custom initializer, as described in the Documentum Forms Builder Development Guide. To con gure a new instance of the CurrentDateTimeInitializer adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors list box. 3. In the General section, do the following: a. Select Initializer from the Adaptor type list box. b. In the Name box, type a name for your new initializer instance. For example, currentdateinitializer. c. In the Description box, type a brief description about the initializer. For example, Initialize control to the current date. 4. In the Implementation section, do the following: a. From the Class Name list box, select com.documentum.xforms.engine.adaptor. initializer.currentdatetimeinitializer. Note: If you created a custom initializer, select the name of the custom initializer from this list box. b. The implementation type Class is selected by default. 5. Click OK to save your configuration. The Forms Builder software stores the initializer adaptor in the repository. The adaptor can now be associated with a UI control, as described in Specifying an initializer, page 137. If you use a document initializer for a form, you must specify it, as described in Assigning adaptors to a template, page 210. Using validators The Forms Builder software currently provides one built-in validator, the QueryResultValidator adaptor, which is part of the com.documentum.xforms.engine. adaptor.validator package. The adaptor accesses the repository the user is connected to, and validates string inputs by searching for them in the list returned by a DQL query. 198 EMC Documentum Forms Builder Version 6 User Guide

199 Managing Adaptors To con gure a new instance of the QueryResultValidator adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: a. Select Validator from the Adaptor type list box. b. In the Name box, type a name for your new validator instance. c. In the Description box, type a brief description about the new validator instance. 4. Specify the implementation class and type in the Implementation section: a. In the Class Name list box, type com.documentum.xforms.engine.adaptor. validator.queryresultvalidator. Note: If you created a custom validator, select the name of the custom validator from this list box. b. The implementation type Class is selected by default. 5. Click Add next to the Initial Parameter field. The Add Initial Parameter dialog box appears. 6. Complete the Add Initial Parameter dialog box as follows: a. In the Name box, type dql as the name of the initial parameter. b. In the Value box, type a DQL query. c. Click OK. 7. Click OK to save your configuration. The Forms Builder software stores the validator adaptor in the repository. The adaptor can now be associated with a UI control, as described in Specifying a validator, page 137. If you use a document validator for a form, you must specify it, as described in Assigning adaptors to a template, page 210. Using data source adaptors The Forms Builder software currently provides three built-in data source adaptors, which are included in the com.documentum.xforms.engine.adaptor.datasource package: prop.propertiesdatasourceadaptor This adaptor accesses information from properties files. EMC Documentum Forms Builder Version 6 User Guide 199

200 Managing Adaptors docbase.idocbasedatasourceadaptorservice This adaptor accesses information from the repository that the forms user is currently logged into. jdbc.jdbcdatasourceadaptor This adaptor accesses any data source (typically, a database) that responds to the JDBC protocol. You can use each of these adaptors differently with different data controls by configuring the adaptor in the Adaptor Configuration Manager as many times as necessary, each time with different settings. Using the properties file data source adaptor, page 200 Using the repository data source adaptor, page 201 Using the JDBC data source adaptor, page 202 Using the properties le data source adaptor The properties file data source adaptor accesses information from properties files. It returns a set of name-value pairs from the properties file, formatted according to the schema definition. To con gure a new instance of a properties le data source adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: a. Select Data Source from the Adaptor type list box. b. In the Name box, type a name for your new data source adaptor configuration. For example, MyPropertiesDataSource. c. In the Description box, type a brief description for the adaptor. For example, Get information from properties file. 4. In the Implementation section, do the following: a. From the Class Name list box, select com.documentum.xforms.engine.adaptor. datasource.prop.propertiesdatasourceadaptor. b. The implementation type Class is selected by default. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. 200 EMC Documentum Forms Builder Version 6 User Guide

201 Managing Adaptors 6. Complete the Add Initial Parameter dialog box as follows: a. In the Name box, type location as the name for the initial parameter. b. In the Value box, type the name of the properties file that is on the classpath; for example, MyPropertiesFileName. c. Click OK. 7. In the Output type section, create a new complex output type, as described in Creating a complex output type, page Click OK to save your configuration. Using the repository data source adaptor The repository data source adaptor accesses information from the repository that the forms user is currently logged into. It returns a set of name-value pairs, formatted according to the schema definition. To con gure a new instance of a repository data source adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: a. Select Data Source from the Adaptor type list box. b. In the Name box, type a name for your new data source adaptor configuration. For example, MyRepositoryDataSource. c. In the Description box, type a brief description for the adaptor. For example, Get information from repository. 4. In the Implementation section, do the following: a. From the Class Name list box, select com.documentum.xforms.engine.adaptor. datasource.docbase.idocbasedatasourceadaptorservice. b. Select SBO as the implementation type. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. 6. Complete the Add Initial Parameter dialog box as follows: a. In the Name box, type dql as the name for the initial parameter. b. In the Value box, type a DQL query. EMC Documentum Forms Builder Version 6 User Guide 201

202 Managing Adaptors The DQL query should be similar to the following sample: select object_name, title from dm_document where folder( /Cabinet/Folder ) c. Click OK. 7. Select an output type from the Output type list box. Depending on the adaptor configuration, you can either select one of the simple output types or create a new complex output type, as described in Creating a complex output type, page Click OK to save your configuration. Using the JDBC data source adaptor The JDBC data source adaptor accesses any data source (typically, a database) that responds to the JDBC protocol. The JDBC data source adaptor configuration must include a unique adaptor name and a query (written in SQL) to retrieve the actual data from the database. You can configure different JDBC data source adaptors, each with a unique name, for different form items. For a JDBC adaptor, you can provide an initial parameter element with a name element, say Connection. Its value element can contain the connection information as a string, or it can point to a properties file containing connection information. If the adaptor does not find such an input argument, it looks for an appropriate properties file (for example, you may have included one in the JAR containing the implementation class). If the adaptor finds a file named jdbc_<id>.properties, where <id> is the name of the JDBC data source specified in the Adaptor Configuration Manager, the adaptor uses that file. Otherwise, it searches for a file named jdbc.properties. To con gure a new instance of a JDBC data source adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: a. Select Data Source from the Adaptor type list box. b. In the Name box, type a name for your new data source adaptor configuration. For example, MyJDBCDataSource. c. In the Description box, type a brief description for the adaptor. For example, Get information from JDBC source. 4. In the Implementation section, do the following: 202 EMC Documentum Forms Builder Version 6 User Guide

203 Managing Adaptors a. From the Class Name list box, select com.documentum.xforms.engine.adaptor. datasource.jdbc.jdbcdatasourceadaptor. b. The implementation type Class is selected by default. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. 6. Complete the Add Initial Parameter dialog box as follows: a. In the Name box, type sql as the name for the initial parameter. b. In the Value box, type a SQL query. The SQL query should look similar to the following: select l as LABEL, v as VALUE from test where i = ${key} c. Click OK. 7. Click Add next to the Input field. The Add Input dialog box appears. 8. Complete the Add Input dialog box as follows: a. In the Name box, type a name for the input parameter. For example, key. b. From the Type list box, select the data type of the parameter. For example, int. c. Select Required. d. Click OK. 9. Select an output type from the Output type list box. You can either select one of the simple output types or create a new complex output type, as described in Creating a complex output type, page Click OK to save your configuration. Note: After you configure the JDBC data source adaptor, specify the adaptor for a control on the form, as described in the Specifying an external data source, page 138. The adaptor name must correspond to a standard JDBC properties file on the application server. In this example, the name of the file must be jdbc_myjdbcdatasource.properties. If that file is not present, the forms runtime uses the file named jdbc.properties, which is installed with the application (for example, Webtop) that uses forms. Use the properties file to specify the location of the data source and other standard JDBC configuration parameters (for example, login credentials for the data source and the path to the JDBC driver). A JDBC properties file should be similar to the following sample: url=jdbc:microsoft:sqlserver://myservername:1433 pubs=mytestrepository EMC Documentum Forms Builder Version 6 User Guide 203

204 Managing Adaptors driver=com.microsoft.jdbc.sqlserver.sqlserverdriver user=administrator password=time4coffee The query retrieves the actual data from the data source. When the data to be retrieved depends on the output of another control in the form (as in Populating a branch office dropdown control based on state, page 204), define the key to be that output variable. For example, in the region/branch example, the key is the region, and the data to be selected is the branch data values and labels. When the data to retrieve does not depend on the output of another control (as in Populating an enumerated list from a database, page 206), do not specify the key. Modify the variables l, v, and i in the query to the appropriate field names in the data source. If you wish to use a different data source, such as an XML data file or a repository, you can create a new data source adaptor by extending JDBCDataSourceAdaptor. The Documentum Forms Builder Development Guide contains more information on developing custom adaptors. Data source adaptor examples The next two examples illustrate how to use data source adaptors to populate dropdown and checkbox controls. Populating a branch office dropdown control based on state, page 204 Populating an enumerated list from a database, page 206 Example 4-1. Populating a branch of ce dropdown control based on state Consider a vacation request form where you want users to enter information about the region and particular branch office in which they work. Once users select the region on the form, the choice of branch offices should be limited to those in the region selected, based on mapping information stored in a database that can be queried with a SQL statement. A custom adaptor, jdbc, is developed to retrieve the branch office information from a database. The database contains a table called locations, with the following field names and values: Table 27. Database table values region branch_label branch_value Western Pleasanton PLE Western Dublin DUBLIN Western Palo Alto PALOALTO 204 EMC Documentum Forms Builder Version 6 User Guide

205 Managing Adaptors region branch_label branch_value Eastern Hopkinton HOP Eastern Cambridge CAMB Configure the adaptor in the Adaptor Configuration Manager, using the following values. 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: Select Data Source from the Adaptor type list box. In the Name box, type jdbc. In the Description box, type Branch by region. 4. In the Implementation section, do the following: From the Class Name list box, select com.documentum.xforms.engine.adaptor. datasource.jdbc.jdbcdatasourceadaptor. The implementation type Class is selected by default. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. Complete the Add Initial Parameter dialog box as follows: In the Name box, type sql as the name for the initial parameter. In the Value box, type the following SQL query. select branch_label as label, branch_value as value from locations where region= ${key} Click OK. 6. Click Add next to the Input field. The Add Input dialog box appears. Complete the Add Input dialog box as follows: In the Name box, type key. From the Type list box. select string. Select Required. Click OK. EMC Documentum Forms Builder Version 6 User Guide 205

206 Managing Adaptors 7. From the Output type list box, select New..., and then click Edit. The Complex Output Type dialog box appears. Create a new complex output type, as described in Creating a complex output type, page 209. Create two elements, label and value, with data type as string. 8. Click OK to save your configuration. Example 4-2. Populating an enumerated list from a database Suppose that you want to populate a checkbox group with values from a database that contains a table called e_zine. The e_zine table has the following fields and values: Table 28. Checkbox group values e_zine_value paws dogs cats e_zine_display Paws for Reflection Dogs on the Couch Cats on the Table Configure the adaptor in the Adaptor Configuration Manager, using the following values. 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: Select Data Source from the Adaptor type list box. In the Name box, type jdbc1. In the Description box, type E-zine checkbox. 4. In the Implementation section, do the following: From the Class Name list box, select com.documentum.xforms.engine.adaptor. datasource.jdbc.jdbcdatasourceadaptor. The implementation type Class is selected by default. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. Complete the Add Initial Parameter dialog box as follows: In the Name box, type sql as the name for the initial parameter. In the Value box, type the following SQL query. 206 EMC Documentum Forms Builder Version 6 User Guide

207 Managing Adaptors select e_zine_display as label, e_zine_value as value from e_zine Click OK. 6. From the Output type list box, select New..., and then click Edit. The Complex Output Type dialog box appears. Create a new complex output type, as described in Creating a complex output type, page 209. Create two elements, label and value, with data type as string. 7. Click OK to save your configuration. Using document processors Document processors may be used for initialization, pre and post submission routines. The Forms Builder software currently provides two default document processor adaptors that are included in the com.documentum.xforms.engine.adaptor.processor package: MoveOrLinkToLocationPostProcessor This adaptor moves or links a form instance to a specified location in the repository. StartWorkflowPostProcessor This adaptor starts a workflow with the form instance as the initial package. To con gure a document processor adaptor: 1. Open the Adaptor Configuration Manager dialog box, as described in Opening the Adaptor Configuration Manager dialog box, page Click Add next to the Installed adaptors field. 3. In the General section, do the following: a. Select Document Processor from the Adaptor type list box. b. In the Name box, type a name for your new document processor adaptor configuration. For example, startworkflow. c. In the Description box, type a brief description for the document processor. For example, Start a workflow. 4. Specify the implementation class and type in the Implementation section. Do one of the following: Select com.documentum.xforms.engine.adaptor. processormoveorlinktolocationpostprocessor from the Class Name list box if you want to configure an adaptor that moves or links a form to a specific location. Then, select Class as the implementation type. EMC Documentum Forms Builder Version 6 User Guide 207

208 Managing Adaptors Select com.documentum.xforms.engine.adaptor.processor. StartWorkflowPostProcessor from the Class Name list box if you want to configure an adaptor that starts a workflow with the completed form as the initial package. Then, select Class as the implementation type. 5. Click Add next to the Initial parameter field. The Add Initial Parameter dialog box appears. 6. Complete the Add Initial Parameter dialog box as follows: a. In the Name box, type a name for the initial parameter. For example, workflowtemplateid. b. In the Value box, type a value for the parameter. For example, a workflow template ID, such as 4b02925a80025c77. c. Click OK. 7. Click OK to save your configuration. For a StartWorkflowProcessor adaptor, you can use the following alternate forms of the initial parameter element (if you do not configure the workflowtemplateid parameter): Initial parameter Name - workflowtemplatelocation Value - workflowtemplaterepositorypath (for example, /test user - tuser1/workflows) Name - workflowtemplatename Value - workflowtemplatename (for example, forminstanceworkflow) If you configure an adaptor as MoveOrLinkToLocationPostProcessor, you must provide the following initial parameter values: Initial parameter Name - location Value - Location where, Location is the repository path where the form instance will be moved or linked; for example, /test user - tuser1/workflows. Name - moveorlink Value - value where, value can be move or link. The Forms Builder software stores the document processor adaptor in the repository. The adaptor can now be associated with a form, as described in Assigning adaptors to a template, page EMC Documentum Forms Builder Version 6 User Guide

209 Managing Adaptors Creating a complex output type If you are configuring or editing a data source adaptor, you can create a new custom complex output type for the adaptor using the Adaptor Configuration Manager. For example, you can use the complex output type to create an output schema for a table. To create a custom complex output type: 1. Select File > Adaptors. The Adaptor Configuration Manager dialog box appears. 2. From the Output Type list box, select New..., and then click Edit. Note: The Output Type section is enabled only for data source adaptors. To modify an existing complex output type for an adaptor, select an existing complex output type from the list box, and click Edit. 3. The Complex Output Type dialog box appears. 4. In the Name box, type a name for the complex output type. 5. Click Add Group to create a group in the adaptor schema. a. In the Name box, type a group name. b. Select Repeating Item if you want the group to be a repeating group. Note: You cannot create a repeating group within a repeating group. This functionality is currently not supported in the adaptor framework. 6. Select the group you just created and click Add Item to add an element to the group. a. In the Name box, type a name for the item. b. From the Type list box, select the data type for the element. Repeat this step to add more elements to the group. 7. To change the position of an element in the group, select the element and click Move Up or Move Down. 8. To remove an element or group, select the element or group and click Remove. Removing an adaptor con guration You can remove existing global or template adaptors using the Remove button in the Adaptor Configuration Manager dialog box. EMC Documentum Forms Builder Version 6 User Guide 209

210 Managing Adaptors To remove an adaptor: 1. Select File > Adaptors. The Adaptor Configuration Manager dialog box appears. 2. Click Global Adaptors and select the adaptor you want to remove from the Installed adaptors list box. Note: You can select Template Adaptors if a template is open. 3. Click Remove. Click Yes in the Confirmation dialog box to remove the adaptor configuration. 4. Click OK to save your changes. After you click OK, the Forms Builder software removes the adaptor configuration using the following rules: If the adaptor you selected is a template adaptor, the Forms Builder software removes the adaptor configuration file from the repository. If the adaptor you selected is a global adaptor, the Forms Builder software removes the adaptor configuration file only if it is not used by any template. If the global adaptor is used by one or more templates, the Forms Builder software displays an error message and does not remove the adaptor configuration. Assigning adaptors to a template The Forms Builder software lets you assign adaptors to individual controls or to an entire template. Adaptors that are assigned to an entire template are generally used to initialize or validate a form instance or to process the form before and after submission. You can assign adaptors to a template using the Form Template Properties dialog box. To assign one or more adaptors to a template: 1. Open the template to which you want to assign the adaptors. 2. Select File > Properties. The Form Template Properties dialog box appears. 3. Click Advanced. 4. Select values from the Initialization, Validation, Pre-submission, and Post-submission list boxes. The list boxes show all global and template adaptors that are currently configured and available in the repository. Global adaptors are marked with the icon. For example, the list box displays all document validators, document initializers, and document processors. 210 EMC Documentum Forms Builder Version 6 User Guide

211 Managing Adaptors 5. Click OK to save your changes. EMC Documentum Forms Builder Version 6 User Guide 211

212 Managing Adaptors 212 EMC Documentum Forms Builder Version 6 User Guide

213 Chapter 5 Localizing Templates This chapter describes how to localize a template to display form instances based on that template in different languages depending on the user s locale. This chapter contains the following topics: Understanding localization, page 213 Marking a template for localization, page 215 Exporting a template for localization, page 215 Translating a properties file, page 218 Importing a properties file, page 219 Configuring additional locales, page 220 Understanding localization The Forms Builder software offers multilanguage support that lets designers create a single template for different languages. The template is exported to a properties file that contains the structure of the template in externalized strings. The externalized strings are translated into the desired language, and the translated properties file is then imported into the Forms Builder application. Figure 32, page 214 describes the localization process. EMC Documentum Forms Builder Version 6 User Guide 213

214 Localizing Templates Figure 32. Localization Process The import process stores the translated properties file in the repository. The new locale is available for the template and can be viewed by selecting the associated language; to view the associated language, select View > Language. If the user chooses a locale for which the properties file has not been localized, the Forms Builder software displays the form instance in English. Note: The available languages in the Forms Builder software are system supported languages, and custom languages that designers add in the custom_locale_config.xml file (Configuring additional locales, page 220 contains detailed information for adding custom locales). The system supported languages include Chinese, English, French, German, Italian, Japanese, Korean, Spanish, and Swedish. These languages are displayed in the View > Language menu of the Forms Builder software. When the template is installed and a user opens a form instance of the template in a WDK-based application, the form is displayed in the language associated with the locale the user selected when logging into the application. The WDK-based application searches for the localized form template using the following sequence: <form template>_language_country <form template>_language <form template> For example, if the user logs in to the WDK-based application using US English locale, and the associated form template name is "My_template", the WDK-based application first searches for "My_template_en_US". If no such template exists, it looks for "My_template_en". If this template does not exist, the WDK-based application uses the original form template. If the associated form template name is "My_template_en_US" or 214 EMC Documentum Forms Builder Version 6 User Guide

215 Localizing Templates "My_template_en," the WDK-based application first retrieves the form template name without the language information, and then tries to find the template with specified locale information. The localization affects the UI control fields of the template that determine the appearance of form instances based on the template. It affects the display information, such as label, tool tip, error message, and table header, of UI control fields, and also affects the format of Date, and Datetime field values. The externalized strings are stored in the content of the object in the repository. For languages with multibyte characters that cannot be represented in ASCII, such as most Asian languages, the translated strings must be converted into Unicode escape sequences (\uxxxxxx). Marking a template for localization You have the option to mark a template that is ready for translation in the Form Template Properties dialog box. However, this process is not required to export the template. Marking a template for translation serves two purposes. First, it helps quickly identify the templates that are ready for exporting to different locales; templates ready for translation are marked in green in the Localization - export dialog box. Second, it is useful when more than one designer works on the same template. To mark a template for localization: 1. Open the template you want to mark for localization. 2. Select File > Properties. The Form Template Properties dialog box appears. 3. Click Basic. 4. Select Ready for translation. 5. Click OK. Note: Marking the template for translation is not required to export the template. It is merely a visual aid to indicate that the design of the template has been finalized and is ready for localization. Exporting a template for localization Any template stored in the repository can be exported for localization. It does not matter whether the template is still in the draft stage or is already installed. EMC Documentum Forms Builder Version 6 User Guide 215

216 Localizing Templates To export a template for localization: 1. Select Tools > Localization > Export. The Localization - export dialog box appears. Figure 33. Localization - export: Export templates for localization 2. From the Template name column, select the template you want to export. A green icon indicates that a template is finalized and ready for translation. However, you can export any of the templates that are listed in the Template name column. 3. Select one or more locales for which you want to generate the properties file for translation. The Forms Builder software generates a properties file for each locale you select. By default, the Forms Builder software provides localization options for Chinese, English, French, German, Italian, Japanese, Korean, Spanish, and Swedish. You can add more locales by editing the custom_locale_config.xml file, as described in Configuring additional locales, page Click Export. The Save dialog box appears. 5. Select a network folder, local folder, or external media where you want the Forms Builder software to store the properties file. The Forms Builder software automatically generates the filename, so you only need to select the directory. 6. Click Save. If the template was exported successfully, Forms Builder displays a success message in the Information dialog box. 7. Click Details to view the path and the names of the files that were generated, or Close to close this dialog box. 216 EMC Documentum Forms Builder Version 6 User Guide